|
| 1 | +/** |
| 2 | + * Copyright (c) 2025 Ping Identity Corporation. All rights reserved. |
| 3 | + * |
| 4 | + * This software may be modified and distributed under the terms |
| 5 | + * of the MIT license. See the LICENSE file for details. |
| 6 | + */ |
| 7 | +import { Effect, pipe } from 'effect'; |
| 8 | +import { MockApi } from '../spec.js'; |
| 9 | +import { |
| 10 | + HttpApiBuilder, |
| 11 | + HttpApiError, |
| 12 | + HttpBody, |
| 13 | + HttpServerRequest, |
| 14 | + HttpServerResponse, |
| 15 | +} from '@effect/platform'; |
| 16 | +import { responseMap } from '../responses/index.js'; |
| 17 | +import { validator } from '../helpers/match.js'; |
| 18 | +import { returnSuccessResponseRedirect } from '../responses/return-success-redirect.js'; |
| 19 | + |
| 20 | +const CapabilitiesHandlerMock = HttpApiBuilder.group(MockApi, 'Capabilities', (handlers) => |
| 21 | + handlers.handle('capabilities', ({ urlParams, payload }) => |
| 22 | + Effect.gen(function* () { |
| 23 | + /** |
| 24 | + * We expect an acr_value query parameter to be present in the request. |
| 25 | + * If it is not present, we return a 404 Not Found error. |
| 26 | + */ |
| 27 | + const acr_value = urlParams?.acr_values ?? ''; |
| 28 | + |
| 29 | + if (!acr_value) { |
| 30 | + return yield* Effect.fail(new HttpApiError.NotFound()); |
| 31 | + } |
| 32 | + |
| 33 | + /** |
| 34 | + * We need a step index cookie to determine which step of the authentication process we are on. |
| 35 | + * If the cookie is not present, we return a 404 Not Found error. |
| 36 | + */ |
| 37 | + |
| 38 | + const req = yield* HttpServerRequest.HttpServerRequest; |
| 39 | + |
| 40 | + const stepIndexCookie = req.cookies['stepIndex']; |
| 41 | + |
| 42 | + /** |
| 43 | + * If we are here with no step index that means we can't continue through a flow. |
| 44 | + * We should error |
| 45 | + */ |
| 46 | + if (!stepIndexCookie) { |
| 47 | + return yield* Effect.fail(new HttpApiError.NotFound()); |
| 48 | + } |
| 49 | + |
| 50 | + const stepIndex = parseInt(stepIndexCookie); |
| 51 | + |
| 52 | + /** |
| 53 | + * If we have no step index, we should error or if its an invalid number |
| 54 | + */ |
| 55 | + |
| 56 | + if (isNaN(stepIndex) || stepIndex < 0) { |
| 57 | + return yield* Effect.fail(new HttpApiError.NotFound()); |
| 58 | + } |
| 59 | + |
| 60 | + /** |
| 61 | + * Match the body against validators now |
| 62 | + * if the body has no match, we are defaulting to a successful response. |
| 63 | + */ |
| 64 | + const result = yield* validator(payload); |
| 65 | + |
| 66 | + if (result === false) { |
| 67 | + return yield* Effect.fail(new HttpApiError.Unauthorized()); |
| 68 | + } |
| 69 | + |
| 70 | + /** |
| 71 | + * We use the step index to find the next step in the response map. |
| 72 | + * If the step index is out of bounds, we return a 404 Not Found error. |
| 73 | + */ |
| 74 | + const steps = responseMap[acr_value]; |
| 75 | + |
| 76 | + /** |
| 77 | + * This may not be the best way to write this. |
| 78 | + * An alternative option would be for us to include the success response we want to return, |
| 79 | + * in the response map. |
| 80 | + * |
| 81 | + * then we can check if we are at the last step. if we are we write the cookie |
| 82 | + * and then we return the success response (last item in array) |
| 83 | + * |
| 84 | + * for now, this returns a default success response and writes cookies. |
| 85 | + */ |
| 86 | + if (stepIndex + 1 >= steps.length) { |
| 87 | + /** |
| 88 | + * we need to return a success because we have not failed yet, |
| 89 | + * and we have no more steps to process. |
| 90 | + */ |
| 91 | + const body = yield* HttpBody.json(returnSuccessResponseRedirect).pipe( |
| 92 | + /** |
| 93 | + * Decide on a better way to handle this error possibiltiy |
| 94 | + */ |
| 95 | + Effect.catchTag('HttpBodyError', () => |
| 96 | + Effect.fail( |
| 97 | + new HttpApiError.HttpApiDecodeError({ |
| 98 | + message: 'Failed to encode body', |
| 99 | + issues: [], |
| 100 | + }), |
| 101 | + ), |
| 102 | + ), |
| 103 | + ); |
| 104 | + return pipe( |
| 105 | + HttpServerResponse.json(body), |
| 106 | + HttpServerResponse.setCookie('ST', 'MockApiCookie123'), |
| 107 | + HttpServerResponse.setCookie( |
| 108 | + 'interactionId', |
| 109 | + returnSuccessResponseRedirect.interactionId, |
| 110 | + { |
| 111 | + httpOnly: true, |
| 112 | + secure: true, |
| 113 | + sameSite: 'strict', |
| 114 | + }, |
| 115 | + ), |
| 116 | + HttpServerResponse.setCookie( |
| 117 | + 'interactionToken', |
| 118 | + returnSuccessResponseRedirect.interactionToken, |
| 119 | + { |
| 120 | + httpOnly: true, |
| 121 | + secure: true, |
| 122 | + sameSite: 'strict', |
| 123 | + }, |
| 124 | + ), |
| 125 | + HttpServerResponse.removeCookie('stepIndex'), |
| 126 | + HttpServerResponse.setStatus(200), |
| 127 | + HttpServerResponse.setHeader('Content-Type', 'application/json'), |
| 128 | + ); |
| 129 | + } |
| 130 | + |
| 131 | + /** |
| 132 | + * The stepIndex middleware is used to auto-increment the step index |
| 133 | + * based on the request type. If the step index is out of bounds, |
| 134 | + * we return a 404 Not Found error. so we won't increment it, but we check for the next step |
| 135 | + * in the flow. |
| 136 | + */ |
| 137 | + const nextStep = steps[stepIndex + 1]; |
| 138 | + |
| 139 | + return nextStep; |
| 140 | + }).pipe(Effect.withSpan('Capabilities Handler Mock')), |
| 141 | + ), |
| 142 | +); |
| 143 | + |
| 144 | +export { CapabilitiesHandlerMock }; |
0 commit comments