Merge pull request #608 from aws-amplify/main

Release Amplify Codegen 4.1.2

Author: AaronZyLee

.github/CODEOWNERS

@@ -1 +1,5 @@
-* @aws-amplify/amplify-data
+# Data team has general approval permissions
+* @aws-amplify/amplify-data
+
+# API approval - public surface and dependencies.
+**/API.md @aws-amplify/amplify-data-admins

CONTRIBUTING.md

@@ -10,33 +10,50 @@ Our work is done directly on Github and PR's are sent to the GitHub repo by core
 
 This section should get you running with **Amplify Codegen**.
 
-### Setting up for local development
+### Local Development
+
+#### Environment Setup
 
 1. You will need the latest version of [nodejs](https://nodejs.org/en/) on your system and developing locally also requires `yarn` workspaces. You can install it [here](https://classic.yarnpkg.com/en/docs/install#mac-stable).
 
-2. Start by [Forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the main branch of [amplify-codegen](https://github.com/aws-amplify/amplify-codegen).
+1. Start by [Forking](https://help.github.com/en/github/getting-started-with-github/fork-a-repo) the main branch of [amplify-codegen](https://github.com/aws-amplify/amplify-codegen).
 
 ```sh
 $ git clone [email protected]:[username]/amplify-codegen.git
 ```
 
 > NOTE: Make sure to always [sync your fork](https://help.github.com/en/github/collaborating-with-issues-and-pull-requests/syncing-a-fork) with _main_ branch of amplify-codegen
 
-3. Move into your project folder
+1. Move into your project folder
 
 ```sh
 $ cd amplify-codegen
 ```
 
-4. Run `setup-dev` script to installs dependencies and perform initial configuration. This command will also link a `amplify-dev` binary for your local testing.
+#### Building and Running Tests
+
+1. To build local packages and verify your change is valid and doesn't break the build, you can run :
+
+   ```sh
+   yarn # Install all dependencies for the workspace
+   yarn build # Build all packages in the repo
+   yarn test # Run tests for all packages in the repo
+   ```
+
+1. Note: once you've run an initial `yarn` unless you're changing dependencies in a package, re-running should not be necessary.
+1. After an initial build, if you're testing changes to a single package, you can run `yarn build` and `yarn test` specifically from that directory (e.g. `/packages/appsync-modelgen-plugin`) in order to speed up your iteration cycle.
+
+#### Building the CLI Locally for functional testing
+
+1. Run `setup-dev` script to installs dependencies and perform initial configuration. This command will also link a `amplify-dev` binary for your local testing.
 
 ```sh
 $ yarn setup-dev
 ```
 
 > NOTE: The `amplify-dev` binary is built based on the latest amplify cli from npm registry and your local codegen packages. All your local changes from codegen can be reflected (typescript files need to be build by `tsc`). In addition, if you are a developer of cli repo, you can run the same command to override the `amplify-dev` binary.
 
-5. Ensure `amplify-dev` exists on your path.
+1. Ensure `amplify-dev` exists on your path.
 
 ```sh
 $ yarn global bin # retrieve yarn path

packages/amplify-codegen-e2e-core/src/categories/codegen.ts

@@ -147,3 +147,31 @@ export function generateModelIntrospection(cwd: string, settings: { outputDir?:
   });
 }
 
+// CLI workflow to add codegen to non-Amplify JS project
+export function addCodegenNonAmplifyJS(cwd: string): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const cmdOptions = ['codegen', 'add', '--apiId', 'mockapiid'];
+    const chain = spawn(getCLIPath(), cmdOptions, { cwd, stripColors: true });
+    chain
+      .wait("Choose the type of app that you're building")
+      .sendCarriageReturn()
+      .wait('What javascript framework are you using')
+      .sendCarriageReturn()
+      .wait('Choose the code generation language target').sendCarriageReturn()
+      .wait('Enter the file name pattern of graphql queries, mutations and subscriptions')
+      .sendCarriageReturn()
+      .wait('Do you want to generate/update all possible GraphQL operations')
+      .sendLine('y')
+      .wait('Enter maximum statement depth [increase from default if your schema is deeply')
+      .sendCarriageReturn();
+
+    chain.run((err: Error) => {
+      if (!err) {
+        resolve();
+      } else {
+        reject(err);
+      }
+    });
+  });
+}
+

packages/amplify-codegen-e2e-tests/src/__tests__/add-codegen-js.test.ts

@@ -5,9 +5,10 @@ import {
     DEFAULT_JS_CONFIG,
     createRandomName,
     addApiWithoutSchema,
-    updateApiSchema
+    updateApiSchema,
+    addCodegenNonAmplifyJS
 } from "@aws-amplify/amplify-codegen-e2e-core";
-import { existsSync } from "fs";
+import { existsSync, writeFileSync } from "fs";
 import path from 'path';
 import { isNotEmptyDir } from '../utils';
 import { deleteAmplifyProject, testAddCodegen, testSetupBeforeAddCodegen, 
@@ -72,4 +73,36 @@ describe('codegen add tests - JS', () => {
     it(`Adding codegen works as expected`, async () => {
         await testAddCodegen(config, projectRoot, schema);
     });
+
+    it(`Adding codegen outside of Amplify project`, async () => {
+        // init project and add API category
+        const testSchema = `
+        type Query {
+            echo: String
+        }
+
+        type Mutation {
+            mymutation: String
+        }
+
+        type Subscription {
+            mysub: String
+        }          
+        `;
+
+        // Setup the non-amplify project with schema and pre-existing files
+        const userSourceCodePath = testSetupBeforeAddCodegen(projectRoot, config);
+        const schemaPath = path.join(projectRoot, 'schema.graphql');
+        writeFileSync(schemaPath, testSchema);
+
+        // add codegen without init
+        await expect(addCodegenNonAmplifyJS(projectRoot)).resolves.not.toThrow();
+
+        // pre-existing file should still exist
+        expect(existsSync(userSourceCodePath)).toBe(true);
+        // GraphQL statements are generated
+        expect(isNotEmptyDir(path.join(projectRoot, config.graphqlCodegenDir))).toBe(true);
+        // graphql configuration should be added
+        expect(existsSync(getGraphQLConfigFilePath(projectRoot))).toBe(true);
+    });
 });

packages/amplify-codegen/src/codegen-config/AmplifyCodeGenConfig.js

@@ -7,18 +7,13 @@ const fs =  require('fs-extra');
 class AmplifyCodeGenConfig {
   static configFileName = '.graphqlconfig.yml';
 
-  constructor(projectPath, withoutInit = false) {
+  constructor(projectPath) {
     try {
       this.gqlConfig = graphQLConfig.getGraphQLConfig();
       this.fixOldConfig();
     } catch (e) {
       if (e instanceof graphQLConfig.ConfigNotFoundError) {
-        let projectRoot;
-        if (!withoutInit) {
-          projectRoot = projectPath || process.cwd();
-        } else {
-          projectRoot = process.cwd();
-        }
+        const projectRoot = projectPath || process.cwd();
         const configPath = join(projectRoot, '.graphqlconfig.yml');
         if(fs.existsSync(configPath)) {
           this.gqlConfig = graphQLConfig.getGraphQLConfig(projectRoot);

packages/amplify-codegen/src/codegen-config/index.js

@@ -6,8 +6,8 @@ let config = null;
 
 function loadConfig(context, withoutInit = false) {
   if (!config) {
-    const projectPath = context.amplify.getEnvInfo().projectPath;
-    config = new AmplifyCodeGenConfig(projectPath, withoutInit);
+    const projectPath = withoutInit ? undefined : context.amplify.getEnvInfo().projectPath;
+    config = new AmplifyCodeGenConfig(projectPath);
   }
   return config;
 }

packages/amplify-codegen/tests/codegen-config/index.test.js

@@ -13,7 +13,7 @@ const MOCK_CONTEXT = {
 describe('codegen-config', () => {
   it('is singleton', () => {
     loadConfig(MOCK_CONTEXT);
-    expect(AmplifyCodeGenConfig).toHaveBeenCalledWith(MOCK_PROJECT_ROOT, false);
+    expect(AmplifyCodeGenConfig).toHaveBeenCalledWith(MOCK_PROJECT_ROOT);
     loadConfig(MOCK_CONTEXT);
     expect(AmplifyCodeGenConfig).toHaveBeenCalledTimes(1);
   });