import type { Provider } from 'oidc-provider'; import type { ProviderFactory } from '../../../src/identity/configuration/ProviderFactory'; import { InteractionRoute, IdentityProviderHttpHandler } from '../../../src/identity/IdentityProviderHttpHandler'; import type { InteractionHandler } from '../../../src/identity/interaction/email-password/handler/InteractionHandler'; import { IdpInteractionError } from '../../../src/identity/interaction/util/IdpInteractionError'; import type { InteractionCompleter } from '../../../src/identity/interaction/util/InteractionCompleter'; import type { ErrorHandler } from '../../../src/ldp/http/ErrorHandler'; import type { ResponseWriter } from '../../../src/ldp/http/ResponseWriter'; import type { HttpRequest } from '../../../src/server/HttpRequest'; import type { HttpResponse } from '../../../src/server/HttpResponse'; import type { TemplateHandler } from '../../../src/server/util/TemplateHandler'; import { BadRequestHttpError } from '../../../src/util/errors/BadRequestHttpError'; import { InternalServerError } from '../../../src/util/errors/InternalServerError'; describe('An IdentityProviderHttpHandler', (): void => { const idpPath = '/idp'; let request: HttpRequest; const response: HttpResponse = {} as any; let providerFactory: jest.Mocked; let routes: { response: InteractionRoute; complete: InteractionRoute }; let interactionCompleter: jest.Mocked; let templateHandler: jest.Mocked; let errorHandler: jest.Mocked; let responseWriter: jest.Mocked; let provider: jest.Mocked; let handler: IdentityProviderHttpHandler; beforeEach(async(): Promise => { request = { url: '/idp', method: 'GET' } as any; provider = { callback: jest.fn(), interactionDetails: jest.fn(), } as any; providerFactory = { getProvider: jest.fn().mockResolvedValue(provider), }; const handlers: InteractionHandler[] = [ { handleSafe: jest.fn().mockResolvedValue({ type: 'response', details: { key: 'val' }}) } as any, { handleSafe: jest.fn().mockResolvedValue({ type: 'complete', details: { webId: 'webId' }}) } as any, ]; routes = { response: new InteractionRoute('/routeResponse', '/view1', handlers[0], 'default', '/response1'), complete: new InteractionRoute('/routeComplete', '/view2', handlers[1], 'other', '/response2'), }; templateHandler = { handleSafe: jest.fn() } as any; interactionCompleter = { handleSafe: jest.fn() } as any; errorHandler = { handleSafe: jest.fn() } as any; responseWriter = { handleSafe: jest.fn() } as any; handler = new IdentityProviderHttpHandler( idpPath, providerFactory, Object.values(routes), templateHandler, interactionCompleter, errorHandler, responseWriter, ); }); it('errors if the idpPath does not start with a slash.', async(): Promise => { expect((): any => new IdentityProviderHttpHandler( 'idp', providerFactory, [], templateHandler, interactionCompleter, errorHandler, responseWriter, )).toThrow('idpPath needs to start with a /'); }); it('calls the provider if there is no matching route.', async(): Promise => { request.url = 'invalid'; await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(provider.callback).toHaveBeenCalledTimes(1); expect(provider.callback).toHaveBeenLastCalledWith(request, response); }); it('calls the templateHandler for matching GET requests.', async(): Promise => { request.url = '/idp/routeResponse'; await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(templateHandler.handleSafe).toHaveBeenCalledTimes(1); expect(templateHandler.handleSafe).toHaveBeenLastCalledWith( { response, templateFile: routes.response.viewTemplate, contents: { errorMessage: '', prefilled: {}}}, ); }); it('calls the templateHandler for InteractionResponseResults.', async(): Promise => { request.url = '/idp/routeResponse'; request.method = 'POST'; await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(routes.response.handler.handleSafe).toHaveBeenCalledTimes(1); expect(routes.response.handler.handleSafe).toHaveBeenLastCalledWith({ request, response }); expect(templateHandler.handleSafe).toHaveBeenCalledTimes(1); expect(templateHandler.handleSafe).toHaveBeenLastCalledWith( { response, templateFile: routes.response.responseTemplate, contents: { key: 'val' }}, ); }); it('calls the interactionCompleter for InteractionCompleteResults.', async(): Promise => { request.url = '/idp/routeComplete'; request.method = 'POST'; await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(routes.complete.handler.handleSafe).toHaveBeenCalledTimes(1); expect(routes.complete.handler.handleSafe).toHaveBeenLastCalledWith({ request, response }); expect(interactionCompleter.handleSafe).toHaveBeenCalledTimes(1); expect(interactionCompleter.handleSafe).toHaveBeenLastCalledWith({ request, response, webId: 'webId' }); }); it('matches paths based on prompt for requests to the root IDP.', async(): Promise => { request.url = '/idp'; request.method = 'POST'; provider.interactionDetails.mockResolvedValueOnce({ prompt: { name: 'other' }} as any); await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(routes.response.handler.handleSafe).toHaveBeenCalledTimes(0); expect(routes.complete.handler.handleSafe).toHaveBeenCalledTimes(1); }); it('uses the default route for requests to the root IDP without (matching) prompt.', async(): Promise => { request.url = '/idp'; request.method = 'POST'; provider.interactionDetails.mockResolvedValueOnce({ prompt: { name: 'notSupported' }} as any); await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(routes.response.handler.handleSafe).toHaveBeenCalledTimes(1); expect(routes.complete.handler.handleSafe).toHaveBeenCalledTimes(0); }); it('displays the viewTemplate again in case of POST errors.', async(): Promise => { request.url = '/idp/routeResponse'; request.method = 'POST'; (routes.response.handler.handleSafe as any) .mockRejectedValueOnce(new IdpInteractionError(500, 'handle error', { name: 'name' })); await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(templateHandler.handleSafe).toHaveBeenCalledTimes(1); expect(templateHandler.handleSafe).toHaveBeenLastCalledWith({ response, templateFile: routes.response.viewTemplate, contents: { errorMessage: 'handle error', prefilled: { name: 'name' }}, }); }); it('defaults to an empty prefilled object in case of POST errors.', async(): Promise => { request.url = '/idp/routeResponse'; request.method = 'POST'; (routes.response.handler.handleSafe as any).mockRejectedValueOnce(new Error('handle error')); await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(templateHandler.handleSafe).toHaveBeenCalledTimes(1); expect(templateHandler.handleSafe).toHaveBeenLastCalledWith({ response, templateFile: routes.response.viewTemplate, contents: { errorMessage: 'handle error', prefilled: { }}, }); }); it('calls the errorHandler if there is a problem resolving the request.', async(): Promise => { request.url = '/idp/routeResponse'; request.method = 'GET'; const error = new Error('bad template'); templateHandler.handleSafe.mockRejectedValueOnce(error); errorHandler.handleSafe.mockResolvedValueOnce({ statusCode: 500 }); await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(errorHandler.handleSafe).toHaveBeenCalledTimes(1); expect(errorHandler.handleSafe).toHaveBeenLastCalledWith({ error, preferences: { type: { 'text/plain': 1 }}}); expect(responseWriter.handleSafe).toHaveBeenCalledTimes(1); expect(responseWriter.handleSafe).toHaveBeenLastCalledWith({ response, result: { statusCode: 500 }}); }); it('can only resolve GET/POST requests.', async(): Promise => { request.url = '/idp/routeResponse'; request.method = 'DELETE'; const error = new BadRequestHttpError('Unsupported request: DELETE /idp/routeResponse'); errorHandler.handleSafe.mockResolvedValueOnce({ statusCode: 500 }); await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(errorHandler.handleSafe).toHaveBeenCalledTimes(1); expect(errorHandler.handleSafe).toHaveBeenLastCalledWith({ error, preferences: { type: { 'text/plain': 1 }}}); expect(responseWriter.handleSafe).toHaveBeenCalledTimes(1); expect(responseWriter.handleSafe).toHaveBeenLastCalledWith({ response, result: { statusCode: 500 }}); }); it('can only resolve InteractionResponseResult responses if a responseTemplate is set.', async(): Promise => { request.url = '/idp/routeResponse'; request.method = 'POST'; (routes.response as any).responseTemplate = undefined; const error = new BadRequestHttpError('Unsupported request: POST /idp/routeResponse'); errorHandler.handleSafe.mockResolvedValueOnce({ statusCode: 500 }); await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(errorHandler.handleSafe).toHaveBeenCalledTimes(1); expect(errorHandler.handleSafe).toHaveBeenLastCalledWith({ error, preferences: { type: { 'text/plain': 1 }}}); expect(responseWriter.handleSafe).toHaveBeenCalledTimes(1); expect(responseWriter.handleSafe).toHaveBeenLastCalledWith({ response, result: { statusCode: 500 }}); }); it('errors if no route is configured for the default prompt.', async(): Promise => { handler = new IdentityProviderHttpHandler( idpPath, providerFactory, [], templateHandler, interactionCompleter, errorHandler, responseWriter, ); request.url = '/idp'; provider.interactionDetails.mockResolvedValueOnce({ prompt: { name: 'other' }} as any); const error = new InternalServerError('No handler for the default session prompt has been configured.'); errorHandler.handleSafe.mockResolvedValueOnce({ statusCode: 500 }); await expect(handler.handle({ request, response })).resolves.toBeUndefined(); expect(errorHandler.handleSafe).toHaveBeenCalledTimes(1); expect(errorHandler.handleSafe).toHaveBeenLastCalledWith({ error, preferences: { type: { 'text/plain': 1 }}}); expect(responseWriter.handleSafe).toHaveBeenCalledTimes(1); expect(responseWriter.handleSafe).toHaveBeenLastCalledWith({ response, result: { statusCode: 500 }}); }); });