fix: download introspection schema when apiId is passed #684
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
commented
Sep 5, 2023
| @@ -38,9 +38,9 @@ async function add(context, apiId = null, region = 'us-east-1') { | |||
| } | |||
|
|
|||
| const schemaPath = ['schema.graphql', 'schema.json'].map(p => path.join(process.cwd(), p)).find(p => fs.existsSync(p)); | |||
| if (withoutInit && !schemaPath) { | |||
| if (withoutInit && !(apiId || schemaPath)) { | |||
There was a problem hiding this comment.
In the case that schema.json is already present when running amplify codegen add, the schema.json will be overwritten with no warning.
dpilch
commented
Sep 5, 2023
| @@ -123,6 +123,8 @@ async function add(context, apiId = null, region = 'us-east-1') { | |||
| } else { | |||
| schema = getSDLSchemaLocation(apiDetails.name); | |||
| } | |||
| } else if (apiDetails) { | |||
| schema = await downloadIntrospectionSchemaWithProgress(context, apiDetails.id, 'schema.json', region); | |||
There was a problem hiding this comment.
Using introspection schema because the utility function already exists, but we could change to sdl schema.
dpilch
force-pushed
the
codegen-add-region
branch
from
856d465 to
aff6b45
Compare
dpilch
force-pushed
the
codegen-apiid
branch
from
a25bac1 to
f6ce898
Compare
4 tasks
alharris-at
approved these changes
Sep 11, 2023
dpilch
force-pushed
the
codegen-apiid
branch
from
f6ce898 to
6424b01
Compare
AaronZyLee
approved these changes
Sep 13, 2023
alharris-at
pushed a commit
that referenced
this pull request
Sep 14, 2023
This was referenced Sep 18, 2023
alharris-at
added a commit
that referenced
this pull request
Sep 19, 2023
…set up locally. (#702) * feat: codegen add --region (#683) * fix: download introspection schema when apiId is passed (#684) * fix: codegen --apiId broken state (#689) * chore: get existing e2e tests passing (#704) * feat: add e2e tests for codegen add when in a non-amplify project (#705) * feat: add e2e tests for codegen add when in a non-amplify project * chore: add some additional test cases * noinit codegen from graphqlconfig (#706) * fix: add missing awaits * chore: fail typegen if no queries are found --------- Co-authored-by: Dane Pilcher <dppilche@amazon.com>
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
When
--apiIdis set, the CLI will attempt to download the introspection schema to./schema.json. When no--regionis suppliedus-east-1is used. If the api cannot be found the CLI will prompt the customer to try a different region.An additional change (#689) is needed after this PR. The customer can end in a broken state if:
amplify codegen add --apiId <api-id>rm -rf schema.jsonamplify codegenThere is no way the customer can use the codegen CLI to download the introspection schema.
Each of these commands need to initialize a download when outside an amplify project if
apiIdis set in.graphqconfig.yml.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.