add user groups to outputs

.changeset/strange-eggs-lie.md

@@ -0,0 +1,9 @@
+---
+'@aws-amplify/backend-output-schemas': minor
+'@aws-amplify/client-config': minor
+'@aws-amplify/auth-construct': patch
+'@aws-amplify/backend': patch
+'@aws-amplify/backend-cli': patch
+---
+
+add user groups to outputs

packages/auth-construct/src/construct.test.ts

@@ -1098,6 +1098,7 @@ void describe('Auth construct', () => {
  'oauthRedirectSignOut',
  'oauthResponseType',
  'oauthClientId',
+ 'groups',
  ],
  },
  },
@@ -1480,6 +1481,30 @@ void describe('Auth construct', () => {
  const outputs = template.findOutputs('*');
  assert.equal(outputs['socialProviders']['Value'], `["GOOGLE"]`);
  });
+ void it('can override group precedence and correctly updates stored output', () => {
+ const app = new App();
+ const stack = new Stack(app);
+ const auth = new AmplifyAuth(stack, 'test', {
+ loginWith: { email: true },
+ groups: ['admins', 'managers'],
+ });
+ auth.resources.groups['admins'].cfnUserGroup.precedence = 2;
+ const expectedGroups = {
+ admins: {
+ precedence: 2,
+ },
+ managers: {
+ precedence: 1,
+ },
+ };
+ const template = Template.fromStack(stack);
+ template.hasResourceProperties('AWS::Cognito::UserPoolGroup', {
+ GroupName: 'admins',
+ Precedence: 2,
+ });
+ const outputs = template.findOutputs('*');
+ assert.equal(outputs['groups']['Value'], JSON.stringify(expectedGroups));
+ });
  });
 
  void describe('Auth external login', () => {

packages/auth-construct/src/construct.ts

@@ -1194,6 +1194,23 @@ export class AmplifyAuth
  },
  });
 
+ // user group precedence can be overwritten, so they are exposed via cdk LAZY
+ output.groups = Lazy.string({
+ produce: () => {
+ const groupsObj = Object.keys(this.resources.groups).reduce(
+ (result, key) => {
+ const precedence =
+ this.resources.groups[key].cfnUserGroup.precedence;
+ result[key] = { precedence };
+ return result;
+ },
+ {} as Record<string, { precedence?: number }>
+ );
+
+ return JSON.stringify(groupsObj);
+ },
+ });
+
  outputStorageStrategy.addBackendOutputEntry(authOutputKey, {
  version: '1',
  payload: output,

packages/backend-output-schemas/API.md

@@ -133,6 +133,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
  oauthRedirectSignOut: z.ZodOptional<z.ZodString>;
  oauthClientId: z.ZodOptional<z.ZodString>;
  oauthResponseType: z.ZodOptional<z.ZodString>;
+ groups: z.ZodOptional<z.ZodString>;
  }, "strip", z.ZodTypeAny, {
  authRegion: string;
  userPoolId: string;
@@ -153,6 +154,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  }, {
  authRegion: string;
  userPoolId: string;
@@ -173,6 +175,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  }>;
  }, "strip", z.ZodTypeAny, {
  version: "1";
@@ -196,6 +199,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  };
  }, {
  version: "1";
@@ -219,6 +223,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  };
  }>]>>;
  "AWS::Amplify::GraphQL": z.ZodOptional<z.ZodDiscriminatedUnion<"version", [z.ZodObject<{
@@ -402,6 +407,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  };
  } | undefined;
  "AWS::Amplify::GraphQL"?: {
@@ -473,6 +479,7 @@ export const unifiedBackendOutputSchema: z.ZodObject<{
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  };
  } | undefined;
  "AWS::Amplify::GraphQL"?: {
@@ -555,6 +562,7 @@ export const versionedAuthOutputSchema: z.ZodDiscriminatedUnion<"version", [z.Zo
  oauthRedirectSignOut: z.ZodOptional<z.ZodString>;
  oauthClientId: z.ZodOptional<z.ZodString>;
  oauthResponseType: z.ZodOptional<z.ZodString>;
+ groups: z.ZodOptional<z.ZodString>;
  }, "strip", z.ZodTypeAny, {
  authRegion: string;
  userPoolId: string;
@@ -575,6 +583,7 @@ export const versionedAuthOutputSchema: z.ZodDiscriminatedUnion<"version", [z.Zo
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  }, {
  authRegion: string;
  userPoolId: string;
@@ -595,6 +604,7 @@ export const versionedAuthOutputSchema: z.ZodDiscriminatedUnion<"version", [z.Zo
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  }>;
 }, "strip", z.ZodTypeAny, {
  version: "1";
@@ -618,6 +628,7 @@ export const versionedAuthOutputSchema: z.ZodDiscriminatedUnion<"version", [z.Zo
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  };
 }, {
  version: "1";
@@ -641,6 +652,7 @@ export const versionedAuthOutputSchema: z.ZodDiscriminatedUnion<"version", [z.Zo
  oauthRedirectSignOut?: string | undefined;
  oauthClientId?: string | undefined;
  oauthResponseType?: string | undefined;
+ groups?: string | undefined;
  };
 }>]>;
 

packages/backend-output-schemas/src/auth/v1.ts

@@ -27,5 +27,6 @@ export const authOutputSchema = z.object({
  oauthRedirectSignOut: z.string().optional(),
  oauthClientId: z.string().optional(),
  oauthResponseType: z.string().optional(),
+ groups: z.string().optional(), // JSON array as string
  }),
 });

packages/backend/src/backend_factory.test.ts

@@ -196,7 +196,7 @@ void describe('Backend', () => {
  const backend = new BackendFactory({}, rootStack);
  const clientConfigPartial: DeepPartialAmplifyGeneratedConfigs<ClientConfig> =
  {
- version: '1.2',
+ version: '1.3',
  custom: {
  someCustomOutput: 'someCustomOutputValue',
  },

packages/backend/src/backend_factory.ts

@@ -33,7 +33,7 @@ const rootStackTypeIdentifier = 'root';
 
 // Client config version that is used by `backend.addOutput()`
 const DEFAULT_CLIENT_CONFIG_VERSION_FOR_BACKEND_ADD_OUTPUT =
- ClientConfigVersionOption.V1_2;
+ ClientConfigVersionOption.V1_3;
 
 /**
  * Factory that collects and instantiates all the Amplify backend constructs

packages/backend/src/engine/custom_outputs_accumulator.test.ts

@@ -59,11 +59,11 @@ void describe('Custom outputs accumulator', () => {
  );
 
  const configPart1: DeepPartialAmplifyGeneratedConfigs<ClientConfig> = {
- version: '1.2',
+ version: '1.3',
  custom: { output1: 'val1' },
  };
  const configPart2: DeepPartialAmplifyGeneratedConfigs<ClientConfig> = {
- version: '1.2',
+ version: '1.3',
  custom: { output2: 'val2' },
  };
  accumulator.addOutput(configPart1);
@@ -115,7 +115,7 @@ void describe('Custom outputs accumulator', () => {
 
  assert.throws(
  () =>
- accumulator.addOutput({ version: '1.2', custom: { output1: 'val1' } }),
+ accumulator.addOutput({ version: '1.3', custom: { output1: 'val1' } }),
  (error: AmplifyUserError) => {
  assert.strictEqual(
  error.message,

packages/cli/src/commands/generate/outputs/generate_outputs_command.test.ts

@@ -74,7 +74,7 @@ void describe('generate outputs command', () => {
  assert.equal(generateClientConfigMock.mock.callCount(), 1);
  assert.deepEqual(
  generateClientConfigMock.mock.calls[0].arguments[1],
- '1.2' // default version
+ '1.3' // default version
  );
  assert.deepEqual(
  generateClientConfigMock.mock.calls[0].arguments[2],
@@ -97,7 +97,7 @@ void describe('generate outputs command', () => {
  assert.equal(generateClientConfigMock.mock.callCount(), 1);
  assert.deepEqual(
  generateClientConfigMock.mock.calls[0].arguments[1],
- '1.2' // default version
+ '1.3' // default version
  );
  assert.deepStrictEqual(
  generateClientConfigMock.mock.calls[0].arguments[2],
@@ -118,7 +118,7 @@ void describe('generate outputs command', () => {
  namespace: 'app_id',
  type: 'branch',
  },
- '1.2',
+ '1.3',
  '/foo/bar',
  undefined,
  ]
@@ -136,7 +136,7 @@ void describe('generate outputs command', () => {
  {
  stackName: 'stack_name',
  },
- '1.2',
+ '1.3',
  '/foo/bar',
  undefined,
  ]
@@ -154,7 +154,7 @@ void describe('generate outputs command', () => {
  {
  stackName: 'stack_name',
  },
- '1.2',
+ '1.3',
  'foo/bar',
  undefined,
  ]
@@ -172,7 +172,7 @@ void describe('generate outputs command', () => {
  {
  stackName: 'stack_name',
  },
- '1.2',
+ '1.3',
  'foo/bar',
  ClientConfigFormat.DART,
  ]

packages/cli/src/commands/sandbox/sandbox_command.test.ts

@@ -427,15 +427,15 @@ void describe('sandbox command', () => {
  );
  });
 
- void it('sandbox creates an empty client config file if one does not already exist for version 1.2', async (contextual) => {
+ void it('sandbox creates an empty client config file if one does not already exist for version 1.3', async (contextual) => {
  contextual.mock.method(fs, 'existsSync', () => false);
  const writeFileMock = contextual.mock.method(fsp, 'writeFile', () => true);
- await commandRunner.runCommand('sandbox --outputs-version 1.2');
+ await commandRunner.runCommand('sandbox --outputs-version 1.3');
  assert.equal(sandboxStartMock.mock.callCount(), 1);
  assert.equal(writeFileMock.mock.callCount(), 1);
  assert.deepStrictEqual(
  writeFileMock.mock.calls[0].arguments[1],
- `{\n "version": "1.2"\n}`
+ `{\n "version": "1.3"\n}`
  );
  assert.deepStrictEqual(
  writeFileMock.mock.calls[0].arguments[0],

packages/cli/src/commands/sandbox/sandbox_event_handler_factory.test.ts

@@ -23,7 +23,7 @@ void describe('sandbox_event_handler_factory', () => {
  } as unknown as ClientConfigGeneratorAdapter;
  const clientConfigLifecycleHandler = new ClientConfigLifecycleHandler(
  clientConfigGeneratorAdapterMock,
- '1.2',
+ '1.3',
  'test-out',
  ClientConfigFormat.JSON
  );
@@ -73,7 +73,7 @@ void describe('sandbox_event_handler_factory', () => {
  namespace: 'test',
  name: 'name',
  },
- '1.2',
+ '1.3',
  'test-out',
  'json',
  ]);
@@ -185,7 +185,7 @@ void describe('sandbox_event_handler_factory', () => {
  namespace: 'test',
  name: 'name',
  },
- '1.2',
+ '1.3',
  'test-out',
  'json',
  ]);