Automate updating create amplify dependencies for dependabot (#2843)

* add update create amplify deps to dependabot update workflow

* add linting and unit test

Author: rtpascual

.changeset/cold-bats-live.md

@@ -0,0 +1,2 @@
+---
+---

.github/workflows/health_checks.yml

@@ -275,7 +275,7 @@ jobs:
     if: github.event_name == 'pull_request' && github.event.pull_request.user.login == 'dependabot[bot]'
     runs-on: ubuntu-latest
     needs:
-      - install
+      - build
       - resolve_inputs
     permissions:
       # This is required so that this job can add the 'run-e2e' label and push to the pull request
@@ -288,12 +288,15 @@ jobs:
       - uses: ./.github/actions/setup_node
         with:
           node-version: 18
-      - uses: ./.github/actions/restore_install_cache
+      - uses: ./.github/actions/restore_build_cache
         with:
           node-version: 18
           cdk-lib-version: ${{ needs.resolve_inputs.outputs.cdk_lib_version }}
       - name: Handle Dependabot version update pull request
-        run: npx tsx scripts/dependabot_handle_version_update.ts "$BASE_SHA"
+        run: |
+          npm run update:create-amplify-deps
+          npm run lint:fix
+          npx tsx scripts/dependabot_handle_version_update.ts "$BASE_SHA"
         env:
           BASE_SHA: ${{ github.event.pull_request.base.sha }}
           # The dependabot_handler_version_update script needs to add the 'run-e2e' pull request label

scripts/components/create_amplify_dep_updater.test.ts

@@ -2,6 +2,7 @@ import assert from 'assert';
 import fsp from 'fs/promises';
 import { beforeEach, describe, it, mock } from 'node:test';
 import { createAmplifyDepUpdater } from './create_amplify_dep_updater.js';
+import { EOL } from 'os';
 
 void describe('createAmplifyDepUpdater', () => {
   const mockedFsReadFile = mock.method(fsp, 'readFile', () =>
@@ -19,14 +20,43 @@ void describe('createAmplifyDepUpdater', () => {
     }),
   );
   const mockedFsWriteFile = mock.method(fsp, 'writeFile', mock.fn());
+  const ghContextMocked = {
+    eventName: '',
+    sha: '',
+    ref: '',
+    workflow: '',
+    action: '',
+    actor: '',
+    job: '',
+    runAttempt: 0,
+    runNumber: 0,
+    runId: 0,
+    apiUrl: '',
+    serverUrl: '',
+    graphqlUrl: '',
+    payload: {},
+    issue: {
+      owner: '',
+      repo: '',
+      number: 0,
+    },
+    repo: {
+      owner: '',
+      repo: '',
+    },
+  };
 
   beforeEach(() => {
     mockedFsReadFile.mock.resetCalls();
     mockedFsWriteFile.mock.resetCalls();
   });
 
   void it('successfully pins new dev version', async () => {
-    await createAmplifyDepUpdater([{ name: 'aws-cdk-lib', version: '2.1.0' }]);
+    await createAmplifyDepUpdater(
+      [{ name: 'aws-cdk-lib', version: '2.1.0' }],
+      undefined,
+      ghContextMocked,
+    );
     assert.strictEqual(mockedFsReadFile.mock.callCount(), 1);
     assert.strictEqual(mockedFsWriteFile.mock.callCount(), 1);
     assert.deepStrictEqual(
@@ -54,6 +84,7 @@ void describe('createAmplifyDepUpdater', () => {
     await createAmplifyDepUpdater(
       [{ name: 'test-prod-package', version: '1.1.0' }],
       ['test-prod-package'],
+      ghContextMocked,
     );
     assert.strictEqual(mockedFsReadFile.mock.callCount(), 1);
     assert.strictEqual(mockedFsWriteFile.mock.callCount(), 1);
@@ -88,6 +119,7 @@ void describe('createAmplifyDepUpdater', () => {
         { name: 'test-prod-package', version: '1.1.0' },
       ],
       ['aws-cdk', 'aws-cdk-lib', 'test-prod-package'],
+      ghContextMocked,
     );
     assert.strictEqual(mockedFsReadFile.mock.callCount(), 1);
     assert.strictEqual(mockedFsWriteFile.mock.callCount(), 1);
@@ -115,6 +147,54 @@ void describe('createAmplifyDepUpdater', () => {
     );
   });
 
+  void it('creates changeset file for dependabot pull request', async () => {
+    const dependabotPRContext = {
+      ...ghContextMocked,
+      payload: {
+        pull_request: {
+          number: 1,
+          body: 'Bumps aws-cdk-lib from 2.0.0 to 2.1.0',
+          head: {
+            ref: 'dependabot/test_version_update_branch',
+            // eslint-disable-next-line spellcheck/spell-checker
+            sha: 'abcd1234', // used for naming the changeset file
+          },
+        },
+      },
+    };
+    const expectedChangesetContent = `---${EOL}'create-amplify': patch${EOL}---${EOL + EOL}bump create amplify dependencies${EOL}`;
+    await createAmplifyDepUpdater(
+      [{ name: 'aws-cdk-lib', version: '2.1.0' }],
+      undefined,
+      dependabotPRContext,
+    );
+    assert.strictEqual(mockedFsReadFile.mock.callCount(), 1);
+    assert.strictEqual(mockedFsWriteFile.mock.callCount(), 2);
+    assert.deepStrictEqual(
+      mockedFsWriteFile.mock.calls[0].arguments[1],
+      JSON.stringify(
+        {
+          defaultDevPackages: [
+            '@aws-amplify/backend',
+            '@aws-amplify/backend-cli',
+            'aws-cdk-lib@2.1.0', // updated
+            'constructs@^10.0.0',
+            'typescript@^5.0.0',
+            'tsx',
+            'esbuild',
+          ],
+          defaultProdPackages: ['aws-amplify', 'test-prod-package@1.0.0'],
+        },
+        null,
+        2,
+      ),
+    );
+    assert.deepStrictEqual(
+      mockedFsWriteFile.mock.calls[1].arguments[1],
+      expectedChangesetContent,
+    );
+  });
+
   void it('does nothing if there are no provided dependencies', async () => {
     await createAmplifyDepUpdater([]);
     assert.strictEqual(mockedFsReadFile.mock.callCount(), 0);

scripts/components/create_amplify_dep_updater.ts

@@ -1,13 +1,21 @@
 import fsp from 'fs/promises';
+import { context } from '@actions/github';
+import { Context } from '@actions/github/lib/context.js';
 import path from 'path';
 import { Dependency } from './get_dependencies_from_package_lock.js';
+import {
+  BumpType,
+  ChangesetFrontMatterContent,
+  createChangesetFile,
+} from './create_changeset_file.js';
 
 /**
  * Modifies target dependencies used for create amplify
  */
 export const createAmplifyDepUpdater = async (
   dependencies: Dependency[],
   createAmplifyDepsToFilter: string[] = ['aws-cdk-lib'],
+  ghContext: Context = context,
 ) => {
   const targetDependencies: Dependency[] = dependencies.filter((dependency) =>
     createAmplifyDepsToFilter.includes(dependency.name),
@@ -72,5 +80,24 @@ export const createAmplifyDepUpdater = async (
         2,
       ),
     );
+    // create changeset if event is a dependabot pull request
+    if (
+      ghContext.payload.pull_request &&
+      ghContext.payload.pull_request.head.ref.startsWith('dependabot/')
+    ) {
+      const fileName = path.join(
+        process.cwd(),
+        `.changeset/dependabot-create-amplify-${ghContext.payload.pull_request.head.sha}.md`,
+      );
+      const frontMatterContent: ChangesetFrontMatterContent = {
+        packageName: 'create-amplify',
+        bumpType: BumpType.PATCH,
+      };
+      await createChangesetFile(
+        fileName,
+        [frontMatterContent],
+        'bump create amplify dependencies',
+      );
+    }
   }
 };