refactor: move directive definitions to a single source of truth #2342
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dpilch
force-pushed
the
directive-definitions
branch
from
40e9298 to
13383ed
Compare
dpilch
changed the title
dpilch
force-pushed
the
directive-definitions
branch
from
43b57f5 to
282c07d
Compare
dpilch
commented
Mar 14, 2024
| @@ -64,7 +64,7 @@ export interface AuthDirective { | |||
| } | |||
|
|
|||
| // @public (undocumented) | |||
| export const authDirectiveDefinition = "\n directive @auth(rules: [AuthRule!]!) on OBJECT | FIELD_DEFINITION\n input AuthRule {\n allow: AuthStrategy!\n provider: AuthProvider\n identityClaim: String\n groupClaim: String\n ownerField: String\n groupsField: String\n groups: [String]\n operations: [ModelOperation]\n }\n enum AuthStrategy {\n owner\n groups\n private\n public\n custom\n }\n enum AuthProvider {\n apiKey\n iam\n oidc\n userPools\n function\n }\n enum ModelOperation {\n create\n update\n delete\n read\n list\n get\n sync\n listen\n search\n }\n"; | |||
| export const authDirectiveDefinition: string; | |||
There was a problem hiding this comment.
The type is changing to string here, but the value is still the same.
dpilch
force-pushed
the
directive-definitions
branch
from
6b9c874 to
e9b7109
Compare
dpilch
force-pushed
the
directive-definitions
branch
from
75613ac to
04d2aa7
Compare
dpilch
force-pushed
the
directive-definitions
branch
from
943ea0c to
4d9b06c
Compare
Merged
3 tasks
4 tasks
atierian
previously approved these changes
Mar 22, 2024
palpatim
reviewed
Mar 25, 2024
packages/amplify-graphql-directives/src/directives/app-sync/aws-api-key.ts
Outdated
Show resolved
Hide resolved
packages/amplify-graphql-directives/src/directives/v1/connection.ts
Outdated
Show resolved
Hide resolved
packages/amplify-graphql-directives/src/directives/v1/versioned.ts
Outdated
Show resolved
Hide resolved
packages/amplify-graphql-name-mapping-transformer/src/graphql-refers-to-transformer.ts
Outdated
Show resolved
Hide resolved
| # Allows transformer libraries to deprecate directive arguments. | ||
| directive @deprecated(reason: String) on FIELD_DEFINITION | INPUT_FIELD_DEFINITION | ENUM | ENUM_VALUE | ||
| `); | ||
| export const EXTRA_DIRECTIVES_DOCUMENT = parse( |
There was a problem hiding this comment.
Good find! I didn't see this when I was looking for definitions!
| @@ -61,6 +61,7 @@ export const constructTransformerChain = (options?: TransformerFactoryArgs): Tra | |||
| const indexTransformer = new IndexTransformer(); | |||
| const hasOneTransformer = new HasOneTransformer(); | |||
|
|
|||
| // The default list of transformers should match DefaultDirectives in packages/amplify-graphql-directives/src/index.ts | |||
There was a problem hiding this comment.
I know what you're getting at, but this list doesn't match because we don't have transformers for the AppSync directives. A couple of things I can think of:
- Create new structures to house AppSync directives and Amplify directives, and compose
DefaultDirectivesfrom it and the list of Amplify directives - Include the list of supported AppSync directives in a comment so at least the number of directive definitions matches the number of transformer definitions
I slightly favor 1, but not enough to fight about it since we don't yet have any validation beyond somebody eyeballing it.
dpilch
force-pushed
the
directive-definitions
branch
from
5be7b90 to
d9a2b41
Compare
palpatim
approved these changes
Mar 26, 2024
atierian
approved these changes
Mar 27, 2024
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description of changes
Move directive definitions to a single source of truth. Transform logic will still be contained in the transformers. This change will allow codegen to depend the
@aws-amplify/graphql-directivespackage and use the definitions as the default definitions of model generation.PR to use new package in codegen: aws-amplify/amplify-codegen#796
CDK / CloudFormation Parameters Changed
N/A
Issue #, if available
N/A
Description of how you validated changes
Checklist
yarn testpassesBy submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.