feat(api): adminCreateUser delivers welcome message

- Invokes the CustomMessage lambda with CustomMessage_AdminCreateUser - Respects DesiredDeliveryMediums parameter
michaelruocco · Nov 27, 2021 · d49aa80 · d49aa80
1 parent 084c253
commit d49aa80
Show file tree

Hide file tree

Showing 14 changed files with 404 additions and 14 deletions.
diff --git a/README.md b/README.md
@@ -177,7 +177,7 @@ cognito-local how to connect to your local Lambda server:
 | --------------------------- | --------------------------------- | ------- |
 | CreateAuthChallenge         | \*                                | ❌      |
 | CustomEmailSender           | \*                                | ❌      |
-| CustomMessage               | AdminCreateUser                   | ❌      |
+| CustomMessage               | AdminCreateUser                   | ✅      |
 | CustomMessage               | Authentication                    | ✅      |
 | CustomMessage               | ForgotPassword                    | ✅      |
 | CustomMessage               | ResendCode                        | ❌      |

diff --git a/integration-tests/aws-sdk/adminCreateUser.test.ts b/integration-tests/aws-sdk/adminCreateUser.test.ts
@@ -17,6 +17,7 @@ describe(
 
         const createUserResult = await client
           .adminCreateUser({
+            UserAttributes: [{ Name: "phone_number", Value: "0400000000" }],
             Username: "abc",
             UserPoolId: "test",
 
@@ -32,6 +33,7 @@ describe(
                 Name: "sub",
                 Value: expect.stringMatching(UUID),
               },
+              { Name: "phone_number", Value: "0400000000" },
             ],
             Enabled: true,
             UserCreateDate: roundedDate,

diff --git a/integration-tests/aws-sdk/adminDeleteUser.test.ts b/integration-tests/aws-sdk/adminDeleteUser.test.ts
@@ -19,6 +19,7 @@ describe(
         // create the user
         const createUserResult = await client
           .adminCreateUser({
+            UserAttributes: [{ Name: "phone_number", Value: "0400000000" }],
             Username: "abc",
             UserPoolId: "test",
 

diff --git a/integration-tests/aws-sdk/adminGetUser.test.ts b/integration-tests/aws-sdk/adminGetUser.test.ts
@@ -17,6 +17,7 @@ describe(
         // create the user
         const createUserResult = await client
           .adminCreateUser({
+            UserAttributes: [{ Name: "phone_number", Value: "0400000000" }],
             Username: "abc",
             UserPoolId: "test",
 

diff --git a/integration-tests/aws-sdk/adminSetUserPassword.test.ts b/integration-tests/aws-sdk/adminSetUserPassword.test.ts
@@ -17,6 +17,7 @@ describe(
         // create the user
         const createUserResult = await client
           .adminCreateUser({
+            UserAttributes: [{ Name: "phone_number", Value: "0400000000" }],
             Username: "abc",
             UserPoolId: "test",
 

diff --git a/integration-tests/aws-sdk/deleteUser.test.ts b/integration-tests/aws-sdk/deleteUser.test.ts
@@ -1,6 +1,4 @@
-import { UUID } from "../../src/__tests__/patterns";
 import { UserNotFoundError } from "../../src/errors";
-import { attributeValue } from "../../src/services/userPoolService";
 import { withCognitoSdk } from "./setup";
 
 describe(
@@ -20,6 +18,7 @@ describe(
       // create a user
       await client
         .adminCreateUser({
+          DesiredDeliveryMediums: ["EMAIL"],
           TemporaryPassword: "def",
           UserAttributes: [{ Name: "email", Value: "[email protected]" }],
           Username: "abc",

diff --git a/integration-tests/aws-sdk/initiateAuth.test.ts b/integration-tests/aws-sdk/initiateAuth.test.ts
@@ -43,6 +43,7 @@ describe(
 
       const createUserResponse = await client
         .adminCreateUser({
+          DesiredDeliveryMediums: ["EMAIL"],
           TemporaryPassword: "def",
           UserAttributes: [{ Name: "email", Value: "[email protected]" }],
           Username: "abc",

diff --git a/integration-tests/aws-sdk/listUsers.test.ts b/integration-tests/aws-sdk/listUsers.test.ts
@@ -8,9 +8,12 @@ describe(
 
       const createUserResult = await client
         .adminCreateUser({
+          UserAttributes: [{ Name: "phone_number", Value: "0400000000" }],
           Username: "abc",
           UserPoolId: "test",
-          TemporaryPassword: "TemporaryPassword", // TODO: shouldn't need to supply this
+
+          // TODO: shouldn't need to supply this
+          TemporaryPassword: "TemporaryPassword",
         })
         .promise();
 

diff --git a/integration-tests/aws-sdk/respondToAuthChallenge.test.ts b/integration-tests/aws-sdk/respondToAuthChallenge.test.ts
@@ -15,6 +15,7 @@ describe(
 
       await client
         .adminCreateUser({
+          DesiredDeliveryMediums: ["EMAIL"],
           TemporaryPassword: "def",
           UserAttributes: [{ Name: "email", Value: "[email protected]" }],
           Username: "abc",

diff --git a/src/__tests__/mockMessages.ts b/src/__tests__/mockMessages.ts
@@ -1,6 +1,7 @@
 import { Messages } from "../services";
 
 export const newMockMessages = (): jest.Mocked<Messages> => ({
+  adminCreateUser: jest.fn(),
   authentication: jest.fn(),
   forgotPassword: jest.fn(),
   signUp: jest.fn(),

diff --git a/src/services/messages.ts b/src/services/messages.ts
@@ -1,6 +1,8 @@
 import { Triggers } from "./triggers";
 import { User } from "./userPoolService";
 
+const AWS_ADMIN_CLIENT_ID = "CLIENT_ID_NOT_APPLICABLE";
+
 export interface Message {
   __code?: string; // not really part of the message, but we pass it around for convenience logging to the console
   emailMessage?: string;
@@ -9,6 +11,11 @@ export interface Message {
 }
 
 export interface Messages {
+  adminCreateUser(
+    userPoolId: string,
+    user: User,
+    temporaryPassword: string
+  ): Promise<Message>;
   authentication(
     clientId: string,
     userPoolId: string,
@@ -36,6 +43,33 @@ export class MessagesService implements Messages {
     this.triggers = triggers;
   }
 
+  public async adminCreateUser(
+    userPoolId: string,
+    user: User,
+    temporaryPassword: string
+  ): Promise<Message> {
+    if (this.triggers.enabled("CustomMessage")) {
+      const message = await this.triggers.customMessage({
+        clientId: AWS_ADMIN_CLIENT_ID,
+        code: temporaryPassword,
+        source: "CustomMessage_AdminCreateUser",
+        userAttributes: user.Attributes,
+        username: user.Username,
+        userPoolId,
+      });
+
+      return {
+        __code: temporaryPassword,
+        ...message,
+      };
+    }
+
+    // TODO: What should the default message be?
+    return {
+      __code: temporaryPassword,
+    };
+  }
+
   public async authentication(
     clientId: string,
     userPoolId: string,