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]>

Author: phani-srikar

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();