Support adding custom attributes #1732

fangyuwu7 · 2024-07-10T23:48:29Z

Problem

userAttributes does not currently support adding custom attributes.

Issue number, if available:

Changes

Support adding custom attributes into userAttributes.

Corresponding docs PR, if applicable:

Validation

unit tests

Checklist

If this PR includes a functional change to the runtime behavior of the code, I have added or updated automated test coverage for this change.
If this PR requires a change to the Project Architecture README, I have included that update in this PR.
If this PR requires a docs update, I have linked to that docs PR above.
If this PR modifies E2E tests, makes changes to resource provisioning, or makes SDK calls, I have run the PR checks with the run-e2e label set.

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

changeset-bot · 2024-07-10T23:48:32Z

🦋 Changeset detected

Latest commit: 400d0bd

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@aws-amplify/auth-construct	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

0618 · 2024-07-11T04:09:58Z

.changeset/blue-turkeys-trade.md

+'@aws-amplify/auth-construct': minor
+---
+
+adding customAttributes into userAttributes


We prefer to use imperative verb form.

See https://www.gitkraken.com/learn/git/best-practices/git-commit-message#using-imperative-verb-form

0618 · 2024-07-11T04:29:01Z

packages/auth-construct/src/construct.ts

        phoneNumber: DEFAULTS.IS_REQUIRED_ATTRIBUTE.phoneNumber(phoneEnabled),
-        ...(props.userAttributes ? props.userAttributes : {}),
+        ...(props.userAttributes
+          ? Object.entries(props.userAttributes).reduce(


Instead of looping Object.entries(props.userAttributes) twice on line 462 and line 475, we can loop it once and get two arrays.
Something like `{ userAttributes, customAttibutes } = Object.entries(props.userAttributes).reduce(...)

rtpascual

Looks like this PR is missing changes to auth-construct/API.md, don't forget to run npm run update:api to fix the failing check_api_changes and check_api_extract checks.

edwardfoyle · 2024-07-11T17:43:48Z

packages/auth-construct/src/construct.ts

+  /**
+   * Define bindCustomAttribute to meet requirements of the Cognito API to call the bind method
+   */
+  public bindCustomAttribute = (


seems like this method should be private. We should test this functionality via constructor inputs. I see there already are some unit tests exercising this; maybe that is sufficient and we don't need the unit tests that are directly calling this method?

edwardfoyle · 2024-07-11T17:45:12Z

packages/auth-construct/src/types.ts

+/**
+ * CustomAttributes is a union type that represents all the different types of custom attributes.
+ */
+export type CustomAttributes =


Suggested change

export type CustomAttributes =

export type CustomAttribute =

0618 · 2024-07-11T23:19:06Z

packages/auth-construct/src/construct.ts

+    const config: CustomAttributeConfig = {
+      dataType: attribute.dataType,
+      mutable: attribute.mutable ?? true,
+      stringConstraints:


if attribute.dataType === 'Number', do we still want the undefined stringConstraints to be there?

If not, we should conditionally add stringConstraints and numberConstraints

…butes unit test

Amplifiyer · 2024-07-12T09:15:05Z

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

+        'custom:display_name': {
+          dataType: 'String',
+          mutable: true,
+          maxLen: 100,
+          minLen: 0,
+        },
+        'custom:tenant_id': {
+          dataType: 'Number',
+          mutable: false,
+          max: 66,
+          min: 1,
+        },
+        'custom:member_year': {
+          dataType: 'Number',
+          max: 90,
+          min: 0,
+        },
+        'custom:favorite_song': {
+          dataType: 'String',
+          mutable: true,
+        },


Add unit tests for boolean and dateTime as well.

Amplifiyer · 2024-07-12T09:15:59Z

packages/auth-construct/src/construct.ts

+    // Conditionally add constraint properties based on dataType.
+    if (attribute.dataType === 'String') {
+      constraints = {
+        ...constraints,


Does this serve any purpose if constraints was empty to begin with?

Amplifiyer · 2024-07-12T09:16:08Z

packages/auth-construct/src/construct.ts

+      };
+    } else if (attribute.dataType === 'Number') {
+      constraints = {
+        ...constraints,


Does this serve any purpose if constraints was empty to begin with?

Amplifiyer · 2024-07-12T09:17:11Z

packages/auth-construct/src/construct.ts

+        [key, value]
+      ) => {
+        if (key.startsWith('custom:')) {
+          const attributeKey = key.replace(/^(custom:|User\.?)/i, '');


Why do we need User. match as well? I don't see corresponding unit tests either.

After testing, actually we don't need User. match.

* refactor top level cli error handling * PR updates * Add cause * update api after clean build

fangyuwu7 added 3 commits July 10, 2024 16:18

update package-lock.json

4c7efb2

Prettier code style

02dbdba

add changeset

df34524

fangyuwu7 requested a review from a team as a code owner July 10, 2024 23:48

0618 reviewed Jul 11, 2024

View reviewed changes

rtpascual reviewed Jul 11, 2024

View reviewed changes

edwardfoyle reviewed Jul 11, 2024

View reviewed changes

fangyuwu7 added 8 commits July 11, 2024 11:47

update construct

847b4bd

update API.md

d7b9546

export CustomAttributes in index.ts

d727d15

update API.MD

9c30b9f

export CustomAttributesString

8c69e22

update API.md

1ae3aca

export CustomAttributeBase in index.ts

4bf657c

update API.md

6a8621a

fangyuwu7 requested a review from a team as a code owner July 11, 2024 19:49

fangyuwu7 added 2 commits July 11, 2024 16:13

updated CustomAttribute type name

5bd714e

updated bindbindCustomAttribute method

b241964

0618 reviewed Jul 11, 2024

View reviewed changes

fangyuwu7 and others added 10 commits July 11, 2024 16:47

removed bindCustomAttributes unit test and updated creates user attri…

a09c518

…butes unit test

updated index export

3b7cf75

updated API.md

35503b8

updated bindCustomAttribute method

4de16d7

Update blue-turkeys-trade.md

e00f6a4

Update blue-turkeys-trade.md

458be4e

update type CustomAttributeBoolean

de683c1

update /API.md

f728168

update type CustomAttributesBoolean

74f3952

update API.md

2e871d8

Amplifiyer reviewed Jul 12, 2024

View reviewed changes

Amplifiyer and others added 8 commits July 14, 2024 17:37

refactor top level cli error handling (aws-amplify#1730)

afd8f91

* refactor top level cli error handling * PR updates * Add cause * update api after clean build

update construct.ts

3ef167e

update construct.ts

54089c7

remove prefix custom:

e20ed2f

Delete .changeset/empty-cameras-smile.md

8c770f1

Delete packages/cli/src/ampx.ts

e8c6d16

Delete packages/sandbox/src/file_watching_sandbox.ts

df6d008

update unit test and bind function

dae422a

fangyuwu7 closed this Jul 15, 2024

fangyuwu7 reopened this Jul 15, 2024

fangyuwu7 closed this Jul 15, 2024

fangyuwu7 reopened this Jul 15, 2024

fangyuwu7 added 2 commits July 14, 2024 22:40

merge main

568b644

update

400d0bd

Amplifiyer approved these changes Jul 16, 2024

View reviewed changes

0618 approved these changes Jul 16, 2024

View reviewed changes

rtpascual approved these changes Jul 16, 2024

View reviewed changes

edwardfoyle approved these changes Jul 16, 2024

View reviewed changes

fangyuwu7 merged commit 10955d9 into aws-amplify:main Jul 17, 2024

josefaidt mentioned this pull request Jul 22, 2024

add docs for auth custom attribute support aws-amplify/docs#7846

Merged

15 tasks

josefaidt linked an issue Jul 22, 2024 that may be closed by this pull request

native support for custom attributes on auth #1541

Closed

Support adding custom attributes #1732

Support adding custom attributes #1732

Uh oh!

Conversation

fangyuwu7 commented Jul 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Problem

Changes

Validation

Checklist

Uh oh!

changeset-bot bot commented Jul 10, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

rtpascual left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fangyuwu7 Jul 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

fangyuwu7 Jul 15, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

fangyuwu7 commented Jul 10, 2024 •

edited

Loading

changeset-bot bot commented Jul 10, 2024 •

edited

Loading

rtpascual left a comment •

edited

Loading

fangyuwu7 Jul 15, 2024 •

edited

Loading

fangyuwu7 Jul 15, 2024 •

edited

Loading