Release: Add codegen version metadata to generate file headers, and updating package dependency versions (#340)

* build: update packages (#325)

* build: update packages

* build: update @graphql-codegen/core

* fix(amplify-codegen): Add Amplify CLI version as a comment for the Modelgen output files (#133)

* feat(amplify-codegen): Add Amplify CLI version as a comment for the Modelgen output files

* fix(amplify-codegen): rephrase the amplify version comment

* fix(amplify-codegen): add amplify-codegen version to version metadata comment

* fix(amplify-codegen): minor changes to use lambda functions

* fix(amplify-codegen): remove commented test

* fix(amplify-codegen): remove optional chaining for backwards compatibility

* fix(amplify-codegen): refactor the if conditional

* test: add warning in context

Co-authored-by: Zeyu Li <[email protected]>

Co-authored-by: Yathi <[email protected]>
Co-authored-by: Phani Srikar Edupuganti <[email protected]>
Co-authored-by: Zeyu Li <[email protected]>

Author: 4 people

package.json

@@ -58,9 +58,9 @@
     "packages/*"
   ],
   "devDependencies": {
-    "@commitlint/cli": "^8.1.0",
-    "@commitlint/config-conventional": "^8.1.0",
-    "@commitlint/config-lerna-scopes": "^8.1.0",
+    "@commitlint/cli": "^15.0.0",
+    "@commitlint/config-conventional": "^15.0.0",
+    "@commitlint/config-lerna-scopes": "^15.0.0",
     "@types/jest": "^25.2.1",
     "@types/js-yaml": "^3.12.3",
     "@typescript-eslint/eslint-plugin": "^2.16.0",

packages/amplify-codegen-e2e-tests/package.json

@@ -23,7 +23,7 @@
   },
   "dependencies": {
     "amplify-codegen-e2e-core": "1.1.5",
-    "aws-amplify": "^3.0.8",
+    "aws-amplify": "^4.3.10",
     "aws-appsync": "^4.0.3",
     "aws-sdk": "^2.845.0",
     "circleci-api": "^4.1.3",

packages/amplify-codegen/package.json

@@ -23,7 +23,7 @@
     "@aws-amplify/appsync-modelgen-plugin": "1.29.10",
     "@aws-amplify/graphql-docs-generator": "2.4.2",
     "@aws-amplify/graphql-types-generator": "2.8.6",
-    "@graphql-codegen/core": "1.8.3",
+    "@graphql-codegen/core": "2.3.0",
     "amplify-codegen-appsync-model-plugin": "^1.22.3",
     "amplify-graphql-docs-generator": "^2.2.1",
     "amplify-graphql-types-generator": "^2.7.0",

packages/amplify-codegen/src/commands/models.js

@@ -141,7 +141,9 @@ async function generateModels(context) {
   appsyncLocalConfig.forEach((cfg, idx) => {
     const outPutPath = cfg.filename;
     fs.ensureFileSync(outPutPath);
-    fs.writeFileSync(outPutPath, generatedCode[idx]);
+    const contentsToWrite = [getVersionsMetadataComment(context), generatedCode[idx]].filter(content => content);
+    const contentToWrite = contentsToWrite.join('\n\n');
+    fs.writeFileSync(outPutPath, contentToWrite);
   });
 
   generateEslintIgnore(context);
@@ -197,6 +199,29 @@ function getModelOutputPath(context) {
   }
 }
 
+// Generate a Comment string with Amplify CLI and Amplify Codegen version metadata
+function getVersionsMetadataComment(context) {
+  const versionMetadata = [];
+  if (context.usageData && context.usageData.version) {
+    versionMetadata.push('amplify-cli-version: ' + context.usageData.version);
+  }
+
+  if (context.pluginPlatform && context.pluginPlatform.plugins) {
+    const codegenPluginsInfo = context.pluginPlatform.plugins.codegen;
+    if (codegenPluginsInfo && codegenPluginsInfo.length > 0) {
+      const amplifyCodegenPluginInfo =  codegenPluginsInfo.filter(plugin => plugin.packageName == 'amplify-codegen');
+      if (amplifyCodegenPluginInfo && amplifyCodegenPluginInfo.length > 0 && amplifyCodegenPluginInfo[0].packageVersion) {
+        versionMetadata.push('amplify-codegen-version: ' + amplifyCodegenPluginInfo[0].packageVersion);
+      }
+    }
+  }
+
+  if (versionMetadata.length > 0) {
+    return '// Generated using ' + versionMetadata.join(', ');
+  }
+  return null;
+}
+
 function generateEslintIgnore(context) {
   const projectConfig = context.amplify.getProjectConfig();