refactor: the router is not a target, refactor this into the server d…

…irectory instead (jagregory#125)

integration-tests/aws-sdk/setup.ts

@@ -20,7 +20,7 @@ import { StormDBDataStoreFactory } from "../../src/services/dataStore/stormDb";
 import { otp } from "../../src/services/otp";
 import { JwtTokenGenerator } from "../../src/services/tokenGenerator";
 import { UserPoolServiceFactoryImpl } from "../../src/services/userPoolService";
-import { Router } from "../../src/targets/router";
+import { Router } from "../../src/server/Router";
 
 const mkdtemp = promisify(fs.mkdtemp);
 const rmdir = promisify(fs.rmdir);

src/targets/router.test.ts → src/server/Router.test.ts

@@ -1,7 +1,8 @@
 import { TestContext } from "../__tests__/testContext";
 import { UnsupportedError } from "../errors";
 import { Services } from "../services";
-import { Router, Targets } from "./router";
+import { Router } from "./Router";
+import { Targets } from "../targets/Target";
 
 describe("Router", () => {
   it("returns an error handler for an invalid target", async () => {

src/server/Router.ts

@@ -0,0 +1,38 @@
+import { Services } from "../services";
+import { UnsupportedError } from "../errors";
+import { Targets, isSupportedTarget } from "../targets/Target";
+import { Context } from "../services/context";
+
+// eslint-disable-next-line
+export type Route = (ctx: Context, req: any) => Promise<any>;
+export type Router = (target: string) => Route;
+
+export const Router =
+  (services: Services): Router =>
+  (target: string) => {
+    if (!isSupportedTarget(target)) {
+      return () =>
+        Promise.reject(
+          new UnsupportedError(`Unsupported x-amz-target header "${target}"`)
+        );
+    }
+
+    const t = Targets[target](services);
+
+    return async (ctx, req) => {
+      const targetLogger = ctx.logger.child({
+        target,
+      });
+
+      targetLogger.debug("start");
+      const res = await t(
+        {
+          ...ctx,
+          logger: targetLogger,
+        },
+        req
+      );
+      targetLogger.debug("end");
+      return res;
+    };
+  };

src/server/defaults.ts

@@ -14,7 +14,7 @@ import { MessageDeliveryService } from "../services/messageDelivery/messageDeliv
 import { otp } from "../services/otp";
 import { JwtTokenGenerator } from "../services/tokenGenerator";
 import { UserPoolServiceFactoryImpl } from "../services/userPoolService";
-import { Router } from "../targets/router";
+import { Router } from "./Router";
 import { loadConfig } from "./config";
 import { createServer, Server } from "./server";
 

src/server/server.ts

@@ -5,7 +5,7 @@ import * as http from "http";
 import type { Logger } from "pino";
 import * as uuid from "uuid";
 import { CognitoError, UnsupportedError } from "../errors";
-import { Router } from "../targets/router";
+import { Router } from "./Router";
 import PublicKey from "../keys/cognitoLocal.public.json";
 import Pino from "pino-http";
 

src/services/context.ts

@@ -1,5 +1,4 @@
 import { LogService } from "./LogService";
-
 export interface Context {
   readonly logger: LogService;
 }

src/targets/router.ts → src/targets/Target.ts

@@ -1,6 +1,5 @@
-import { LogService } from "../services/LogService";
-import { Services } from "../services";
-import { UnsupportedError } from "../errors";
+import { Context } from "../services/context";
+
 import { AdminDeleteUserAttributes } from "./adminDeleteUserAttributes";
 import { AdminSetUserPassword } from "./adminSetUserPassword";
 import { ConfirmForgotPassword } from "./confirmForgotPassword";
@@ -63,47 +62,13 @@ export const Targets = {
   VerifyUserAttribute,
 } as const;
 
-type TargetName = keyof typeof Targets;
+export type TargetName = keyof typeof Targets;
 
-export type Context = { readonly logger: LogService };
 export type Target<Req extends {}, Res extends {}> = (
   ctx: Context,
   req: Req
 ) => Promise<Res>;
 
+//export const registerTarget = (target: Target) => Targets
 export const isSupportedTarget = (name: string): name is TargetName =>
   Object.keys(Targets).includes(name);
-
-// eslint-disable-next-line
-export type Route = (ctx: Context, req: any) => Promise<any>;
-export type Router = (target: string) => Route;
-
-export const Router =
-  (services: Services): Router =>
-  (target: string) => {
-    if (!isSupportedTarget(target)) {
-      return () =>
-        Promise.reject(
-          new UnsupportedError(`Unsupported x-amz-target header "${target}"`)
-        );
-    }
-
-    const t = Targets[target](services);
-
-    return async (ctx, req) => {
-      const targetLogger = ctx.logger.child({
-        target,
-      });
-
-      targetLogger.debug("start");
-      const res = await t(
-        {
-          ...ctx,
-          logger: targetLogger,
-        },
-        req
-      );
-      targetLogger.debug("end");
-      return res;
-    };
-  };

src/targets/adminConfirmSignUp.ts

@@ -5,7 +5,7 @@ import {
 import { Services } from "../services";
 import { NotAuthorizedError } from "../errors";
 import { attribute, attributesAppend } from "../services/userPoolService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type AdminConfirmSignUpTarget = Target<
   AdminConfirmSignUpRequest,

src/targets/adminCreateUser.ts

@@ -17,7 +17,8 @@ import {
   attributeValue,
   User,
 } from "../services/userPoolService";
-import { Context, Target } from "./router";
+import { Context } from "../services/context";
+import { Target } from "./Target";
 
 const generator = shortUUID(
   "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz!"

src/targets/adminDeleteUser.ts

@@ -1,7 +1,7 @@
 import { AdminDeleteUserRequest } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { Services } from "../services";
 import { UserNotFoundError } from "../errors";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type AdminDeleteUserTarget = Target<AdminDeleteUserRequest, {}>;
 

src/targets/adminDeleteUserAttributes.ts

@@ -5,7 +5,7 @@ import {
 import { NotAuthorizedError } from "../errors";
 import { Services } from "../services";
 import { attributesRemove } from "../services/userPoolService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type AdminDeleteUserAttributesTarget = Target<
   AdminDeleteUserAttributesRequest,

src/targets/adminGetUser.ts

@@ -4,7 +4,7 @@ import {
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { Services } from "../services";
 import { UserNotFoundError } from "../errors";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type AdminGetUserTarget = Target<
   AdminGetUserRequest,

src/targets/adminInitiateAuth.ts

@@ -9,7 +9,8 @@ import {
   UnsupportedError,
 } from "../errors";
 import { Services } from "../services";
-import { Context, Target } from "./router";
+import { Target } from "./Target";
+import { Context } from "../services/context";
 
 export type AdminInitiateAuthTarget = Target<
   AdminInitiateAuthRequest,

src/targets/adminSetUserPassword.ts

@@ -4,7 +4,7 @@ import {
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { UserNotFoundError } from "../errors";
 import { Services } from "../services";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type AdminSetUserPasswordTarget = Target<
   AdminSetUserPasswordRequest,

src/targets/adminUpdateUserAttributes.ts

@@ -13,7 +13,8 @@ import {
   User,
   validatePermittedAttributeChanges,
 } from "../services/userPoolService";
-import { Context, Target } from "./router";
+import { Target } from "./Target";
+import { Context } from "../services/context";
 
 const sendAttributeVerificationCode = async (
   ctx: Context,

src/targets/changePassword.ts

@@ -10,7 +10,7 @@ import {
   NotAuthorizedError,
 } from "../errors";
 import { Token } from "../services/tokenGenerator";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type ChangePasswordTarget = Target<
   ChangePasswordRequest,

src/targets/confirmForgotPassword.ts

@@ -5,7 +5,7 @@ import {
 import { CodeMismatchError, UserNotFoundError } from "../errors";
 import { Services } from "../services";
 import { attribute, attributesAppend } from "../services/userPoolService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type ConfirmForgotPasswordTarget = Target<
   ConfirmForgotPasswordRequest,

src/targets/confirmSignUp.ts

@@ -5,7 +5,7 @@ import {
 import { CodeMismatchError, NotAuthorizedError } from "../errors";
 import { Services } from "../services";
 import { attribute, attributesAppend } from "../services/userPoolService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type ConfirmSignUpTarget = Target<
   ConfirmSignUpRequest,

src/targets/createGroup.ts

@@ -4,7 +4,7 @@ import {
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { Services } from "../services";
 import { Group } from "../services/userPoolService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type CreateGroupTarget = Target<CreateGroupRequest, CreateGroupResponse>;
 

src/targets/createUserPool.ts

@@ -6,7 +6,7 @@ import {
 import shortUUID from "short-uuid";
 import { Services } from "../services";
 import { USER_POOL_AWS_DEFAULTS } from "../services/cognitoService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 const REGION = "local";
 const ACCOUNT_ID = "local";

src/targets/createUserPoolClient.ts

@@ -3,7 +3,7 @@ import {
   CreateUserPoolClientResponse,
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { Services } from "../services";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type CreateUserPoolClientTarget = Target<
   CreateUserPoolClientRequest,

src/targets/deleteUser.ts

@@ -3,7 +3,7 @@ import jwt from "jsonwebtoken";
 import { InvalidParameterError, NotAuthorizedError } from "../errors";
 import { Services } from "../services";
 import { Token } from "../services/tokenGenerator";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type DeleteUserTarget = Target<DeleteUserRequest, {}>;
 

src/targets/deleteUserAttributes.ts

@@ -7,7 +7,7 @@ import { InvalidParameterError, NotAuthorizedError } from "../errors";
 import { Services } from "../services";
 import { Token } from "../services/tokenGenerator";
 import { attributesRemove } from "../services/userPoolService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type DeleteUserAttributesTarget = Target<
   DeleteUserAttributesRequest,

src/targets/describeUserPoolClient.ts

@@ -4,7 +4,7 @@ import {
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { ResourceNotFoundError } from "../errors";
 import { Services } from "../services";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type DescribeUserPoolClientTarget = Target<
   DescribeUserPoolClientRequest,

src/targets/forgotPassword.ts

@@ -6,7 +6,7 @@ import { UnsupportedError, UserNotFoundError } from "../errors";
 import { Services } from "../services";
 import { DeliveryDetails } from "../services/messageDelivery/messageDelivery";
 import { attributeValue } from "../services/userPoolService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type ForgotPasswordTarget = Target<
   ForgotPasswordRequest,

src/targets/getUser.ts

@@ -6,7 +6,7 @@ import jwt from "jsonwebtoken";
 import { InvalidParameterError, UserNotFoundError } from "../errors";
 import { Services } from "../services";
 import { Token } from "../services/tokenGenerator";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type GetUserTarget = Target<GetUserRequest, GetUserResponse>;
 

src/targets/getUserAttributeVerificationCode.ts

@@ -8,7 +8,8 @@ import { InvalidParameterError, UserNotFoundError } from "../errors";
 import { selectAppropriateDeliveryMethod } from "../services/messageDelivery/deliveryMethod";
 import { Token } from "../services/tokenGenerator";
 import { User } from "../services/userPoolService";
-import { Context, Target } from "./router";
+import { Target } from "./Target";
+import { Context } from "../services/context";
 
 const sendAttributeVerificationCode = async (
   ctx: Context,

src/targets/initiateAuth.ts

@@ -18,7 +18,8 @@ import {
   MFAOption,
   User,
 } from "../services/userPoolService";
-import { Context, Target } from "./router";
+import { Target } from "./Target";
+import { Context } from "../services/context";
 
 export type InitiateAuthTarget = Target<
   InitiateAuthRequest,

src/targets/listGroups.ts

@@ -3,7 +3,7 @@ import {
   ListGroupsResponse,
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { Services } from "../services";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type ListGroupsTarget = Target<ListGroupsRequest, ListGroupsResponse>;
 

src/targets/listUserPools.ts

@@ -4,7 +4,7 @@ import {
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { Services } from "../services";
 import { UserPool } from "../services/userPoolService";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type ListUserPoolsTarget = Target<
   ListUserPoolsRequest,

src/targets/listUsers.ts

@@ -3,7 +3,7 @@ import {
   ListUsersResponse,
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { Services } from "../services";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type ListUsersTarget = Target<ListUsersRequest, ListUsersResponse>;
 

src/targets/respondToAuthChallenge.ts

@@ -9,7 +9,7 @@ import {
   UnsupportedError,
 } from "../errors";
 import { Services } from "../services";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type RespondToAuthChallengeTarget = Target<
   RespondToAuthChallengeRequest,

src/targets/revokeToken.ts

@@ -4,7 +4,7 @@ import {
 } from "aws-sdk/clients/cognitoidentityserviceprovider";
 import { NotAuthorizedError } from "../errors";
 import { Services } from "../services";
-import { Target } from "./router";
+import { Target } from "./Target";
 
 export type RevokeTokenTarget = Target<RevokeTokenRequest, RevokeTokenResponse>;
 

src/targets/signUp.ts

@@ -15,7 +15,8 @@ import {
   attributeValue,
   User,
 } from "../services/userPoolService";
-import { Context, Target } from "./router";
+import { Target } from "./Target";
+import { Context } from "../services/context";
 
 export type SignUpTarget = Target<SignUpRequest, SignUpResponse>;
 

src/targets/updateUserAttributes.ts

@@ -15,7 +15,8 @@ import {
   User,
   validatePermittedAttributeChanges,
 } from "../services/userPoolService";
-import { Context, Target } from "./router";
+import { Target } from "./Target";
+import { Context } from "../services/context";
 
 const sendAttributeVerificationCode = async (
   ctx: Context,