fix: updating a user pool updates cached options

.gitignore

@@ -1,4 +1,5 @@
 .cognito
+.eslintcache
 .idea
 lib
 node_modules

integration-tests/cognitoService.test.ts

@@ -85,11 +85,11 @@ describe("Cognito Service", () => {
     expect(fs.existsSync(`${dataDirectory}/test-pool-1.json`)).toBe(true);
     expect(fs.existsSync(`${dataDirectory}/test-pool-2.json`)).toBe(true);
 
-    await cognitoService.deleteUserPool(TestContext, up1.config);
+    await cognitoService.deleteUserPool(TestContext, up1.options);
 
     expect(fs.existsSync(`${dataDirectory}/test-pool-1.json`)).not.toBe(true);
 
-    await cognitoService.deleteUserPool(TestContext, up2.config);
+    await cognitoService.deleteUserPool(TestContext, up2.options);
 
     expect(fs.existsSync(`${dataDirectory}/test-pool-2.json`)).not.toBe(true);
   });

package.json

@@ -13,7 +13,7 @@
     "format": "prettier --write src/**/*.ts integration-tests/**/*.ts",
     "integration-test": "jest --config integration-tests/jest.config.js",
     "integration-test:watch": "jest --config integration-tests/jest.config.js --watch",
-    "lint": "eslint src/**/*.ts && tsc --noEmit",
+    "lint": "eslint --cache src/**/*.ts && tsc --noEmit",
     "start": "COGNITO_LOCAL_DEVMODE=1 ts-node src/bin/start.ts",
     "start:debug": "COGNITO_LOCAL_DEVMODE=1 DEBUG=1 node -r ts-node/register --inspect=9230 --enable-source-maps src/bin/start.ts",
     "start:watch": "nodemon",
@@ -87,8 +87,8 @@
   },
   "lint-staged": {
     "*.ts": [
-      "eslint --fix",
-      "tsc --esModuleInterop --resolveJsonModule --noEmit ./setupTests.ts",
+      "eslint --fix --cache",
+      "tsc --target es2019 --moduleResolution node --esModuleInterop --resolveJsonModule --noEmit ./setupTests.ts",
       "prettier --write"
     ],
     "README.md": "markdown-toc -i --bullets=- --maxdepth=3"

src/__tests__/mockUserPoolService.ts

@@ -6,7 +6,7 @@ export const newMockUserPoolService = (
     Id: "test",
   }
 ): jest.Mocked<UserPoolService> => ({
-  config,
+  options: config,
   deleteAppClient: jest.fn(),
   deleteGroup: jest.fn(),
   deleteUser: jest.fn(),
@@ -20,7 +20,7 @@ export const newMockUserPoolService = (
   saveGroup: jest.fn(),
   saveUser: jest.fn(),
   storeRefreshToken: jest.fn(),
-  update: jest.fn(),
+  updateOptions: jest.fn(),
 });
 
 export const newMockUserPoolServiceFactory = (

src/services/cognitoService.ts

@@ -320,7 +320,7 @@ export class CognitoServiceImpl implements CognitoService {
       )
     );
 
-    return service.config;
+    return service.options;
   }
 
   public async deleteUserPool(ctx: Context, userPool: UserPool): Promise<void> {
@@ -403,7 +403,7 @@ export class CognitoServiceImpl implements CognitoService {
             path.basename(x.name, path.extname(x.name))
           );
 
-          return userPool.config;
+          return userPool.options;
         })
     );
   }

src/services/userPoolService.test.ts

@@ -650,4 +650,47 @@ describe("User Pool Service", () => {
       expect(groups[0].GroupName).toEqual("theGroupName");
     });
   });
+
+  describe("updateOptions", () => {
+    it("updates the options in the datastore", async () => {
+      const ds = newMockDataStore();
+      const userPool = new UserPoolServiceImpl(
+        mockClientsDataStore,
+        clock,
+        ds,
+        {
+          Id: "test",
+        }
+      );
+
+      await userPool.updateOptions(TestContext, {
+        Id: "test",
+        MfaConfiguration: "ON",
+      });
+
+      expect(ds.set).toHaveBeenCalledWith(TestContext, "Options", {
+        Id: "test",
+        MfaConfiguration: "ON",
+      });
+    });
+
+    it("updates the cached options", async () => {
+      const ds = newMockDataStore();
+      const userPool = new UserPoolServiceImpl(
+        mockClientsDataStore,
+        clock,
+        ds,
+        {
+          Id: "test",
+        }
+      );
+
+      await userPool.updateOptions(TestContext, {
+        Id: "test",
+        MfaConfiguration: "ON",
+      });
+
+      expect(userPool.options.MfaConfiguration).toEqual("ON");
+    });
+  });
 });

src/services/userPoolService.ts

@@ -136,7 +136,7 @@ export type UserPool = UserPoolType & {
 };
 
 export interface UserPoolService {
-  readonly config: UserPool;
+  readonly options: UserPool;
 
   saveAppClient(ctx: Context, appClient: AppClient): Promise<void>;
   deleteAppClient(ctx: Context, appClient: AppClient): Promise<void>;
@@ -150,7 +150,7 @@ export interface UserPoolService {
   ): Promise<User | null>;
   listGroups(ctx: Context): Promise<readonly Group[]>;
   listUsers(ctx: Context): Promise<readonly User[]>;
-  update(ctx: Context, userPool: UserPool): Promise<void>;
+  updateOptions(ctx: Context, userPool: UserPool): Promise<void>;
   removeUserFromGroup(ctx: Context, group: Group, user: User): Promise<void>;
   saveGroup(ctx: Context, group: Group): Promise<void>;
   saveUser(ctx: Context, user: User): Promise<void>;
@@ -174,7 +174,11 @@ export class UserPoolServiceImpl implements UserPoolService {
   private readonly clock: Clock;
   private readonly dataStore: DataStore;
 
-  public readonly config: UserPool;
+  private _options: UserPool;
+
+  public get options(): UserPool {
+    return this._options;
+  }
 
   public constructor(
     clientsDataStore: DataStore,
@@ -183,7 +187,7 @@ export class UserPoolServiceImpl implements UserPoolService {
     config: UserPool
   ) {
     this.clientsDataStore = clientsDataStore;
-    this.config = config;
+    this._options = config;
     this.clock = clock;
     this.dataStore = dataStore;
   }
@@ -245,9 +249,10 @@ export class UserPoolServiceImpl implements UserPoolService {
   ): Promise<User | null> {
     ctx.logger.debug({ username }, "UserPoolServiceImpl.getUserByUsername");
 
-    const aliasEmailEnabled = this.config.UsernameAttributes?.includes("email");
+    const aliasEmailEnabled =
+      this.options.UsernameAttributes?.includes("email");
     const aliasPhoneNumberEnabled =
-      this.config.UsernameAttributes?.includes("phone_number");
+      this.options.UsernameAttributes?.includes("phone_number");
 
     const userByUsername = await this.dataStore.get<User>(ctx, [
       "Users",
@@ -315,9 +320,13 @@ export class UserPoolServiceImpl implements UserPoolService {
     return Object.values(users);
   }
 
-  public async update(ctx: Context, userPool: UserPool): Promise<void> {
-    ctx.logger.debug({ userPoolId: userPool.Id }, "UserPoolServiceImpl.update");
+  public async updateOptions(ctx: Context, userPool: UserPool): Promise<void> {
+    ctx.logger.debug(
+      { userPoolId: userPool.Id },
+      "UserPoolServiceImpl.updateOptions"
+    );
     await this.dataStore.set(ctx, "Options", userPool);
+    this._options = userPool;
   }
 
   public async saveUser(ctx: Context, user: User): Promise<void> {

src/targets/adminCreateUser.ts

@@ -84,7 +84,7 @@ const deliverWelcomeMessage = async (
     ctx,
     "AdminCreateUser",
     null,
-    userPool.config.Id,
+    userPool.options.Id,
     user,
     temporaryPassword,
     req.ClientMetadata,

src/targets/adminInitiateAuth.ts

@@ -54,7 +54,7 @@ const adminUserPasswordAuthFlow = async (
     user = await services.triggers.userMigration(ctx, {
       clientMetadata: {},
       validationData: {},
-      userPoolId: userPool.config.Id,
+      userPoolId: userPool.options.Id,
       clientId: req.ClientId,
       username: req.AuthParameters.USERNAME,
       password: req.AuthParameters.PASSWORD,
@@ -74,7 +74,7 @@ const adminUserPasswordAuthFlow = async (
     ctx,
     user,
     req.ClientId,
-    userPool.config.Id,
+    userPool.options.Id,
     req.ClientMetadata,
     "Authentication"
   );
@@ -127,7 +127,7 @@ const refreshTokenAuthFlow = async (
     ctx,
     user,
     req.ClientId,
-    userPool.config.Id,
+    userPool.options.Id,
     req.ClientMetadata,
     "RefreshTokens"
   );

src/targets/adminUpdateUserAttributes.test.ts

@@ -51,7 +51,7 @@ describe("AdminUpdateUserAttributes target", () => {
     const user = TDB.user();
 
     mockUserPoolService.getUserByUsername.mockResolvedValue(user);
-    mockUserPoolService.config.SchemaAttributes = [
+    mockUserPoolService.options.SchemaAttributes = [
       {
         Name: "custom:example",
         Mutable: true,
@@ -85,7 +85,7 @@ describe("AdminUpdateUserAttributes target", () => {
     ${"phone_number_verified without an phone_number attribute"} | ${"phone_number_verified"} | ${"Phone Number is required to verify/un-verify a phone number"}
   `("req.UserAttributes contains $desc", ({ attribute, expectedError }) => {
     beforeEach(() => {
-      mockUserPoolService.config.SchemaAttributes = [
+      mockUserPoolService.options.SchemaAttributes = [
         {
           Name: "email_verified",
           Mutable: true,
@@ -149,7 +149,7 @@ describe("AdminUpdateUserAttributes target", () => {
 
   describe("user pool has auto verified attributes enabled", () => {
     beforeEach(() => {
-      mockUserPoolService.config.AutoVerifiedAttributes = ["email"];
+      mockUserPoolService.options.AutoVerifiedAttributes = ["email"];
     });
 
     describe.each`
@@ -167,7 +167,7 @@ describe("AdminUpdateUserAttributes target", () => {
           });
 
           mockUserPoolService.getUserByUsername.mockResolvedValue(user);
-          mockUserPoolService.config.SchemaAttributes = [
+          mockUserPoolService.options.SchemaAttributes = [
             { Name: "example", Mutable: true },
           ];
 
@@ -254,7 +254,7 @@ describe("AdminUpdateUserAttributes target", () => {
 
   describe("user pool does not have auto verified attributes", () => {
     beforeEach(() => {
-      mockUserPoolService.config.AutoVerifiedAttributes = [];
+      mockUserPoolService.options.AutoVerifiedAttributes = [];
     });
 
     describe.each`
@@ -272,7 +272,7 @@ describe("AdminUpdateUserAttributes target", () => {
           });
 
           mockUserPoolService.getUserByUsername.mockResolvedValue(user);
-          mockUserPoolService.config.SchemaAttributes = [
+          mockUserPoolService.options.SchemaAttributes = [
             { Name: "example", Mutable: true },
           ];
 

src/targets/adminUpdateUserAttributes.ts

@@ -25,7 +25,7 @@ const sendAttributeVerificationCode = async (
   code: string
 ) => {
   const deliveryDetails = selectAppropriateDeliveryMethod(
-    userPool.config.AutoVerifiedAttributes ?? [],
+    userPool.options.AutoVerifiedAttributes ?? [],
     user
   );
   if (!deliveryDetails) {
@@ -39,7 +39,7 @@ const sendAttributeVerificationCode = async (
     ctx,
     "UpdateUserAttribute",
     null,
-    userPool.config.Id,
+    userPool.options.Id,
     user,
     code,
     req.ClientMetadata,
@@ -78,7 +78,7 @@ export const AdminUpdateUserAttributes =
         // or before we started explicitly saving the defaults. Fallback on the AWS defaults in
         // this case, otherwise checks against the schema for default attributes like email will
         // fail.
-        userPool.config.SchemaAttributes ??
+        userPool.options.SchemaAttributes ??
           USER_POOL_AWS_DEFAULTS.SchemaAttributes ??
           []
       )
@@ -95,7 +95,7 @@ export const AdminUpdateUserAttributes =
     // deliberately only check the affected user attributes, not the combined attributes
     // e.g. a user with email_verified=false that you don't touch the email attributes won't get notified
     if (
-      userPool.config.AutoVerifiedAttributes?.length &&
+      userPool.options.AutoVerifiedAttributes?.length &&
       hasUnverifiedContactAttributes(userAttributesToSet)
     ) {
       const code = otp();

src/targets/confirmForgotPassword.ts

@@ -50,7 +50,7 @@ export const ConfirmForgotPassword =
         clientMetadata: req.ClientMetadata,
         source: "PostConfirmation_ConfirmForgotPassword",
         username: updatedUser.Username,
-        userPoolId: userPool.config.Id,
+        userPoolId: userPool.options.Id,
 
         // not sure whether this is a one off for PostConfirmation, or whether we should be adding cognito:user_status
         // into every place we send attributes to lambdas

src/targets/confirmSignUp.ts

@@ -44,7 +44,7 @@ export const ConfirmSignUp =
         clientMetadata: req.ClientMetadata,
         source: "PostConfirmation_ConfirmSignUp",
         username: updatedUser.Username,
-        userPoolId: userPool.config.Id,
+        userPoolId: userPool.options.Id,
 
         // not sure whether this is a one off for PostConfirmation, or whether we should be adding cognito:user_status
         // into every place we send attributes to lambdas

src/targets/createUserPoolClient.test.ts

@@ -3,7 +3,6 @@ import { newMockCognitoService } from "../__tests__/mockCognitoService";
 import { newMockUserPoolService } from "../__tests__/mockUserPoolService";
 import { TestContext } from "../__tests__/testContext";
 import { UserPoolService } from "../services";
-import { AppClient } from "../services/appClient";
 import {
   CreateUserPoolClient,
   CreateUserPoolClientTarget,

src/targets/deleteUserPool.ts

@@ -16,7 +16,7 @@ export const DeleteUserPool =
       throw new ResourceNotFoundError();
     }
 
-    await cognito.deleteUserPool(ctx, userPool.config);
+    await cognito.deleteUserPool(ctx, userPool.options);
 
     return {};
   };

src/targets/describeUserPool.ts

@@ -21,6 +21,6 @@ export const DescribeUserPool =
     }
 
     return {
-      UserPool: userPoolToResponseObject(userPool.config),
+      UserPool: userPoolToResponseObject(userPool.options),
     };
   };

src/targets/forgotPassword.ts

@@ -50,7 +50,7 @@ export const ForgotPassword =
       ctx,
       "ForgotPassword",
       req.ClientId,
-      userPool.config.Id,
+      userPool.options.Id,
       user,
       code,
       req.ClientMetadata,

src/targets/getUserAttributeVerificationCode.ts

@@ -20,7 +20,7 @@ const sendAttributeVerificationCode = async (
   code: string
 ) => {
   const deliveryDetails = selectAppropriateDeliveryMethod(
-    userPool.config.AutoVerifiedAttributes ?? [],
+    userPool.options.AutoVerifiedAttributes ?? [],
     user
   );
   if (!deliveryDetails) {
@@ -34,7 +34,7 @@ const sendAttributeVerificationCode = async (
     ctx,
     "VerifyUserAttribute",
     null,
-    userPool.config.Id,
+    userPool.options.Id,
     user,
     code,
     req.ClientMetadata,