@aws-amplify/backend should inherit version bump of same kind from dependencies (#2042)

* refactor check_changeset_completeness with functions

* check backend version bump attempt 1 with temp workaround

* testing

* Revert "testing"

This reverts commit 65c6794.

* attempt 2 at checking changesets

* testing new attempt

* removed testing changesets

* testing

* testing changes

* testing

* removed unnecessary comments

* explictly add return type to modifiedPackages function

* added changeset types to dev dep

* altered logic of checkBackendDepVersion

* altered naming

* moved missing changesets check to function

---------

Co-authored-by: Vieltojarvi <[email protected]>

Author: ShadowCat567

package-lock.json

@@ -64,6 +64,7 @@
     "@aws-sdk/client-ssm": "^3.624.0",
     "@changesets/cli": "^2.26.1",
     "@changesets/get-release-plan": "^4.0.0",
+    "@changesets/types": "^6.0.0",
     "@microsoft/api-extractor": "7.43.8",
     "@octokit/webhooks-types": "^7.5.1",
     "@shopify/eslint-plugin": "^43.0.0",

package.json

@@ -2,51 +2,136 @@ import getReleasePlan from '@changesets/get-release-plan';
 import { GitClient } from './components/git_client.js';
 import { readPackageJson } from './components/package-json/package_json.js';
 import { EOL } from 'os';
+import { ReleasePlan, VersionType } from '@changesets/types';
 
-const gitClient = new GitClient();
-
-const baseRef = process.argv[2];
-if (baseRef === undefined) {
-  throw new Error('No base ref specified for changeset completeness check');
+enum VersionTypeEnum {
+  'NONE' = 0,
+  'PATCH' = 1,
+  'MINOR' = 2,
+  'MAJOR' = 3,
 }
 
-const releasePlan = await getReleasePlan(process.cwd());
+const checkForMissingChangesets = async (
+  releasePlan: ReleasePlan,
+  gitClient: GitClient,
+  baseRef: string
+) => {
+  const packagesWithChangeset = new Set(
+    releasePlan.releases.map((release) => release.name)
+  );
 
-const packagesWithChangeset = new Set(
-  releasePlan.releases.map((release) => release.name)
-);
+  const changedFiles = await gitClient.getChangedFiles(baseRef);
+  const modifiedPackageDirs = new Set<string>();
 
-const changedFiles = await gitClient.getChangedFiles(baseRef);
+  changedFiles
+    .filter(
+      (changedFile) =>
+        changedFile.startsWith('packages/') && !changedFile.endsWith('test.ts')
+    )
+    .forEach((changedPackageFile) => {
+      modifiedPackageDirs.add(
+        changedPackageFile.split('/').slice(0, 2).join('/')
+      );
+    });
 
-const modifiedPackageDirs = new Set<string>();
+  const packagesMissingChangesets = [];
+  for (const modifiedPackageDir of modifiedPackageDirs) {
+    const { name: modifiedPackageName, private: isPrivate } =
+      await readPackageJson(modifiedPackageDir);
+    if (isPrivate) {
+      continue;
+    }
+    if (!packagesWithChangeset.has(modifiedPackageName)) {
+      packagesMissingChangesets.push(modifiedPackageName);
+    }
+  }
 
-changedFiles
-  .filter(
-    (changedFile) =>
-      changedFile.startsWith('packages/') && !changedFile.endsWith('test.ts')
-  )
-  .forEach((changedPackageFile) => {
-    modifiedPackageDirs.add(
-      changedPackageFile.split('/').slice(0, 2).join('/')
+  if (packagesMissingChangesets.length > 0) {
+    throw new Error(
+      `The following packages have changes but are not included in any changeset:${EOL}${EOL}${packagesMissingChangesets.join(
+        EOL
+      )}${EOL}${EOL}Add a changeset using 'npx changeset add'.`
     );
-  });
-
-const packagesMissingChangesets = [];
-for (const modifiedPackageDir of modifiedPackageDirs) {
-  const { name: modifiedPackageName, private: isPrivate } =
-    await readPackageJson(modifiedPackageDir);
-  if (isPrivate) {
-    continue;
   }
-  if (!packagesWithChangeset.has(modifiedPackageName)) {
-    packagesMissingChangesets.push(modifiedPackageName);
+};
+
+const convertVersionType = (version: VersionType): VersionTypeEnum => {
+  switch (version) {
+    case 'major':
+      return VersionTypeEnum.MAJOR;
+    case 'minor':
+      return VersionTypeEnum.MINOR;
+    case 'patch':
+      return VersionTypeEnum.PATCH;
+    case 'none':
+      return VersionTypeEnum.NONE;
   }
-}
+};
 
-if (packagesMissingChangesets.length > 0) {
-  throw new Error(
-    `The following packages have changes but are not included in any changeset:${EOL}${EOL}${packagesMissingChangesets.join(
-      EOL
-    )}${EOL}${EOL}Add a changeset using 'npx changeset add'.`
+const findEffectiveVersion = (
+  releasePlan: ReleasePlan,
+  packageName: string
+): VersionTypeEnum => {
+  let effectiveVersion: VersionTypeEnum = VersionTypeEnum.NONE;
+
+  for (const changeset of releasePlan.changesets) {
+    for (const release of changeset.releases) {
+      if (release.name === packageName) {
+        const releaseVersionType = convertVersionType(release.type);
+        if (releaseVersionType > effectiveVersion) {
+          effectiveVersion = releaseVersionType;
+        }
+      }
+    }
+  }
+  return effectiveVersion;
+};
+
+const checkBackendDependenciesVersion = (releasePlan: ReleasePlan) => {
+  const backendVersion: VersionTypeEnum = findEffectiveVersion(
+    releasePlan,
+    '@aws-amplify/backend'
+  );
+  const backendAuthVersion: VersionTypeEnum = findEffectiveVersion(
+    releasePlan,
+    '@aws-amplify/backend-auth'
+  );
+  const backendDataVersion: VersionTypeEnum = findEffectiveVersion(
+    releasePlan,
+    '@aws-amplify/backend-data'
   );
+  const backendFunctionVersion: VersionTypeEnum = findEffectiveVersion(
+    releasePlan,
+    '@aws-amplify/backend-function'
+  );
+  const backendStorageVersion: VersionTypeEnum = findEffectiveVersion(
+    releasePlan,
+    '@aws-amplify/backend-storage'
+  );
+
+  if (
+    backendVersion <
+    Math.max(
+      backendAuthVersion,
+      backendDataVersion,
+      backendFunctionVersion,
+      backendStorageVersion
+    )
+  ) {
+    throw new Error(
+      `@aws-amplify/backend has a version bump of a different kind from its dependencies (@aws-amplify/backend-auth, @aws-amplify/backend-data, @aws-amplify/backend-function, or @aws-amplify/backend-storage) but is expected to have a version bump of the same kind.${EOL}`
+    );
+  }
+};
+
+const gitClient = new GitClient();
+
+const baseRef = process.argv[2];
+if (baseRef === undefined) {
+  throw new Error('No base ref specified for changeset completeness check');
 }
+
+const releasePlan = await getReleasePlan(process.cwd());
+
+await checkForMissingChangesets(releasePlan, gitClient, baseRef);
+checkBackendDependenciesVersion(releasePlan);