Merge pull request #366 from aws-amplify/master

Release Amplify Codegen V2.26.24

Author: AaronZyLee

packages/amplify-codegen/package.json

@@ -56,4 +56,4 @@
   "devDependencies": {
     "mock-fs": "^4.13.0"
   }
-}
+}

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

@@ -6,6 +6,7 @@ const { FeatureFlags, pathManager } = require('amplify-cli-core');
 const gqlCodeGen = require('@graphql-codegen/core');
 const { getModelgenPackage } = require('../utils/getModelgenPackage');
 const { validateDartSDK } = require('../utils/validateDartSDK');
+const { validateAmplifyFlutterCapableZeroThreeFeatures } = require('../utils/validateAmplifyFlutterCapableZeroThreeFeatures');
 
 const platformToLanguageMap = {
   android: 'java',
@@ -81,14 +82,14 @@ async function generateModels(context) {
   const modelgenPackageMigrationflag = 'codegen.useAppSyncModelgenPlugin';
   const appSyncDataStoreCodeGen = getModelgenPackage(FeatureFlags.getBoolean(modelgenPackageMigrationflag));
 
-  const isTimestampFieldsAdded = readFeatureFlag('codegen.addTimestampFields');
-
   const generateIndexRules = readFeatureFlag('codegen.generateIndexRules');
   const emitAuthProvider = readFeatureFlag('codegen.emitAuthProvider');
   const usePipelinedTransformer = readFeatureFlag('graphQLTransformer.useExperimentalPipelinedTransformer')
   const transformerVersion = readNumericFeatureFlag('graphQLTransformer.transformerVersion');
 
+  let isTimestampFieldsAdded = readFeatureFlag('codegen.addTimestampFields');
   let enableDartNullSafety = readFeatureFlag('codegen.enableDartNullSafety');
+  let enableDartZeroThreeFeatures = false;
 
   if (projectConfig.frontend === 'flutter') {
     const isMinimumDartVersionSatisfied = validateDartSDK(context, projectRoot);
@@ -103,9 +104,12 @@ async function generateModels(context) {
         'Generating Dart Models without null safety. To generate null safe data models, turn on the “enableDartNullSafety” feature flag and set your Dart SDK version to “>= 2.12.0”. Learn more: https://docs.amplify.aws/lib/project-setup/null-safety/q/platform/flutter',
       );
     }
+    // override isTimestampFieldsAdded to true when using amplify-flutter > 0.3.0 || > 0.3.0-rc.2
+    isTimestampFieldsAdded = validateAmplifyFlutterCapableZeroThreeFeatures(projectRoot);
+    enableDartZeroThreeFeatures = validateAmplifyFlutterCapableZeroThreeFeatures(projectRoot);
   }
-  const handleListNullabilityTransparently = readFeatureFlag('codegen.handleListNullabilityTransparently');
 
+  const handleListNullabilityTransparently = readFeatureFlag('codegen.handleListNullabilityTransparently');
   const appsyncLocalConfig = await appSyncDataStoreCodeGen.preset.buildGeneratesSection({
     baseOutputDir: outputPath,
     schema,
@@ -118,6 +122,7 @@ async function generateModels(context) {
       enableDartNullSafety,
       handleListNullabilityTransparently,
       usePipelinedTransformer,
+      enableDartZeroThreeFeatures,
       transformerVersion,
     },
   });

packages/amplify-codegen/src/utils/validateAmplifyFlutterCapableZeroThreeFeatures.js

@@ -0,0 +1,33 @@
+const yaml = require('js-yaml');
+const path = require('path');
+const fs = require('fs-extra');
+const semver = require('semver');
+const { printer } = require('amplify-prompts');
+
+const PUBSPEC_LOCK_FILE_NAME = 'pubspec.lock';
+const MINIMUM_VERSION_CONSTRAIN = '>= 0.3.0 || >= 0.3.0-rc.2';
+
+function validateAmplifyFlutterCapableZeroThreeFeatures(projectRoot) {
+  try {
+    const lockFile = yaml.load(fs.readFileSync(path.join(projectRoot, PUBSPEC_LOCK_FILE_NAME), 'utf8'));
+    // check resolved dependency version written pubspec.lock file
+    const { version } = lockFile.packages.amplify_flutter || {};
+    // For this util function it check only if the amplify_flutter version is great than the minimum version
+    // and it's not concerned with prerelease range, hence including prerelease to ensure
+    // 0.4.0-rc.2 > 0.3.0-rc.2 is true
+    if (semver.satisfies(version, MINIMUM_VERSION_CONSTRAIN, { includePrerelease: true })) {
+      return true;
+    }
+    return false;
+  } catch (e) {
+    if (e.stack) {
+      printer.error(e.stack);
+      printer.error(e.message);
+    }
+
+    printer.error('An error occurred while parsing ' + PUBSPEC_LOCK_FILE_NAME + '.');
+    return false;
+  }
+}
+
+module.exports = { validateAmplifyFlutterCapableZeroThreeFeatures, PUBSPEC_LOCK_FILE_NAME, MINIMUM_VERSION_CONSTRAIN };

packages/amplify-codegen/tests/utils/validateAmplifyFlutterCapableForNonModel.test.js

@@ -0,0 +1,87 @@
+const {
+  validateAmplifyFlutterCapableZeroThreeFeatures,
+  PUBSPEC_LOCK_FILE_NAME,
+  MINIMUM_VERSION_CONSTRAIN,
+} = require('../../src/utils/validateAmplifyFlutterCapableZeroThreeFeatures');
+const mockFs = require('mock-fs');
+const { join } = require('path');
+const yaml = require('js-yaml');
+const { printer } = require('amplify-prompts');
+
+jest.mock('amplify-prompts', () => ({
+  printer: {
+    error: jest.fn()
+  },
+}));
+
+const MOCK_PROJECT_ROOT = 'project';
+const MOCK_PUBSPEC_FILE_PATH = join(MOCK_PROJECT_ROOT, PUBSPEC_LOCK_FILE_NAME);
+const mockErrorPrinter = printer.error;
+
+describe('Validate amplify flutter version tests', () => {
+  afterEach(() => {
+    mockFs.restore();
+  });
+
+  describe(`should return true if the resolved version meets the version constrain: ${MINIMUM_VERSION_CONSTRAIN}`, () => {
+    ['0.3.0', '0.3.1', '1.0.0', '0.3.0-rc.2', '0.4.0', '0.4.0-rc.2'].forEach(version => {
+      test(`when the resolved version is ${version}`, () => {
+        const lockFile = {
+        packages: {
+          amplify_flutter: {
+            version,
+          },
+        },
+      };
+      mockFs({ [MOCK_PUBSPEC_FILE_PATH]: yaml.dump(lockFile) });
+      expect(validateAmplifyFlutterCapableZeroThreeFeatures(MOCK_PROJECT_ROOT)).toBe(true);
+      })
+    });
+  });
+
+  describe(`should return false if the resolved version does NOT meet the version constrain: ${MINIMUM_VERSION_CONSTRAIN}`, () => {
+    ['0.2.0', '0.2.9', '0.3.0-rc.1'].forEach(version => {
+      test(`when the resolved version is ${version}`, () => {
+        const lockFile = {
+          packages: {
+            amplify_flutter: {
+              version,
+            },
+          },
+        };
+        mockFs({ [MOCK_PUBSPEC_FILE_PATH]: yaml.dump(lockFile) });
+        expect(validateAmplifyFlutterCapableZeroThreeFeatures(MOCK_PROJECT_ROOT)).toBe(false);
+      });
+    });
+  });
+
+  it('should return false if the sdk version cannot be found', () => {
+    const lockFile = {};
+    mockFs({ [MOCK_PUBSPEC_FILE_PATH]: yaml.dump(lockFile) });
+    expect(validateAmplifyFlutterCapableZeroThreeFeatures(MOCK_PROJECT_ROOT)).toBe(false);
+  });
+
+  describe('when yaml file cannot be correctly loaded', () => {
+    let loadSpy;
+    beforeAll(() => {
+      mockErrorPrinter.mockClear();
+      loadSpy = jest.spyOn(yaml, 'load');
+      loadSpy.mockImplementation(() => {
+        throw Error("Cannot read yaml file.");
+      });
+    });
+
+    afterAll(() => {
+      loadSpy.mockClear();
+      mockErrorPrinter.mockClear();
+    })
+
+    it('should print error when error is thrown while loading yaml file', () => {
+      const lockFile = {};
+      mockFs({ [MOCK_PUBSPEC_FILE_PATH]: yaml.dump(lockFile) });
+
+      expect(validateAmplifyFlutterCapableZeroThreeFeatures(MOCK_PROJECT_ROOT)).toBe(false);
+      expect(mockErrorPrinter).toHaveBeenCalledTimes(3);
+    });
+  });
+});