feat(dashboard): on demand config migration

lib/workers/repository/config-migration/branch/index.spec.ts

@@ -37,24 +37,127 @@ describe('workers/repository/config-migration/branch/index', () => {
       config.branchPrefix = 'some/';
     });
 
-    it('Exits when Migration is not needed', async () => {
+    // exists when migration not needed
+    it('exits when migration is not needed', async () => {
       await expect(
         checkConfigMigrationBranch(config, null),
-      ).resolves.toBeNull();
+      ).resolves.toBeEmptyObject();
       expect(logger.debug).toHaveBeenCalledWith(
         'checkConfigMigrationBranch() Config does not need migration',
       );
     });
 
-    it('Updates migration branch & refresh PR', async () => {
+    it('returns add checkbox message when migration disabled and checkbox unchecked', async () => {
+      await expect(
+        checkConfigMigrationBranch(
+          {
+            ...config,
+            configMigration: false,
+            dependencyDashboardChecks: { configMigrationInfo: 'unchecked' },
+          },
+          migratedData,
+        ),
+      ).resolves.toMatchObject({ result: 'add-checkbox' });
+      expect(logger.debug).toHaveBeenCalledWith(
+        'Config migration needed but config migration is disabled and checkbox not ticked or not present.',
+      );
+    });
+
+    it('creates migration branch when migration disabled but checkbox checked', async () => {
+      mockedFunction(createConfigMigrationBranch).mockResolvedValueOnce(
+        'committed',
+      );
+      await expect(
+        checkConfigMigrationBranch(
+          {
+            ...config,
+            configMigration: false,
+            dependencyDashboardChecks: { configMigrationInfo: 'checked' },
+          },
+          migratedData,
+        ),
+      ).resolves.toMatchObject({
+        result: 'pr-exists',
+        migrationBranch: `${config.branchPrefix!}migrate-config`,
+      });
+      expect(logger.debug).toHaveBeenCalledWith('Need to create migration PR');
+    });
+
+    it('updates migration branch & refreshes pr when migration disabled but open pr exists', async () => {
+      platform.getBranchPr.mockResolvedValue(
+        mock<Pr>({
+          number: 1,
+        }),
+      );
+      platform.refreshPr = jest.fn().mockResolvedValueOnce(null);
+      mockedFunction(rebaseMigrationBranch).mockResolvedValueOnce('committed');
+      const res = await checkConfigMigrationBranch(
+        {
+          ...config,
+          configMigration: false,
+          dependencyDashboardChecks: {
+            configMigrationInfo: 'migration-pr-exists',
+          },
+        },
+        migratedData,
+      );
+      // TODO: types (#22198)
+      expect(res).toMatchObject({
+        result: 'pr-exists',
+        migrationBranch: `${config.branchPrefix!}migrate-config`,
+        prNumber: 1,
+      });
+      expect(scm.checkoutBranch).toHaveBeenCalledTimes(1);
+      expect(git.commitFiles).toHaveBeenCalledTimes(0);
+      expect(platform.refreshPr).toHaveBeenCalledTimes(1);
+      expect(logger.debug).toHaveBeenCalledWith(
+        'Config Migration PR already exists',
+      );
+    });
+
+    it('creates migration branch when migration enabled but no pr exists', async () => {
+      mockedFunction(createConfigMigrationBranch).mockResolvedValueOnce(
+        'committed',
+      );
+      const res = await checkConfigMigrationBranch(
+        {
+          ...config,
+          configMigration: true,
+          dependencyDashboardChecks: {
+            configMigrationInfo: 'no-checkbox',
+          },
+        },
+        migratedData,
+      );
+      // TODO: types (#22198)
+      expect(res).toMatchObject({
+        result: 'pr-exists',
+        migrationBranch: `${config.branchPrefix!}migrate-config`,
+      });
+      expect(scm.checkoutBranch).toHaveBeenCalledTimes(1);
+      expect(git.commitFiles).toHaveBeenCalledTimes(0);
+      expect(logger.debug).toHaveBeenCalledWith('Need to create migration PR');
+    });
+
+    it('updates migration branch & refresh PR when migration enabled and open pr exists', async () => {
       platform.getBranchPr.mockResolvedValue(mock<Pr>());
-      // platform.refreshPr is undefined as it is an optional function
-      // declared as: refreshPr?(number: number): Promise<void>;
       platform.refreshPr = jest.fn().mockResolvedValueOnce(null);
       mockedFunction(rebaseMigrationBranch).mockResolvedValueOnce('committed');
-      const res = await checkConfigMigrationBranch(config, migratedData);
+      const res = await checkConfigMigrationBranch(
+        {
+          ...config,
+          configMigration: true,
+          dependencyDashboardChecks: {
+            configMigrationInfo: 'migration-pr-exists',
+          },
+        },
+        migratedData,
+      );
       // TODO: types (#22198)
-      expect(res).toBe(`${config.branchPrefix!}migrate-config`);
+      expect(res).toMatchObject({
+        result: 'pr-exists',
+        migrationBranch: `${config.branchPrefix!}migrate-config`,
+      });
       expect(scm.checkoutBranch).toHaveBeenCalledTimes(1);
       expect(git.commitFiles).toHaveBeenCalledTimes(0);
       expect(logger.debug).toHaveBeenCalledWith(
@@ -68,23 +171,23 @@ describe('workers/repository/config-migration/branch/index', () => {
       });
       platform.getBranchPr.mockResolvedValueOnce(mock<Pr>());
       mockedFunction(rebaseMigrationBranch).mockResolvedValueOnce('committed');
-      const res = await checkConfigMigrationBranch(config, migratedData);
-      // TODO: types (#22198)
-      expect(res).toBe(`${config.branchPrefix!}migrate-config`);
-      expect(scm.checkoutBranch).toHaveBeenCalledTimes(0);
-      expect(git.commitFiles).toHaveBeenCalledTimes(0);
-    });
-
-    it('Creates migration PR', async () => {
-      mockedFunction(createConfigMigrationBranch).mockResolvedValueOnce(
-        'committed',
+      const res = await checkConfigMigrationBranch(
+        {
+          ...config,
+          configMigration: true,
+          dependencyDashboardChecks: {
+            configMigrationInfo: 'migration-pr-exists',
+          },
+        },
+        migratedData,
       );
-      const res = await checkConfigMigrationBranch(config, migratedData);
       // TODO: types (#22198)
-      expect(res).toBe(`${config.branchPrefix!}migrate-config`);
-      expect(scm.checkoutBranch).toHaveBeenCalledTimes(1);
+      expect(res).toMatchObject({
+        result: 'pr-exists',
+        migrationBranch: `${config.branchPrefix!}migrate-config`,
+      });
+      expect(scm.checkoutBranch).toHaveBeenCalledTimes(0);
       expect(git.commitFiles).toHaveBeenCalledTimes(0);
-      expect(logger.debug).toHaveBeenCalledWith('Need to create migration PR');
     });
 
     it('Dry runs create migration PR', async () => {
@@ -94,9 +197,20 @@ describe('workers/repository/config-migration/branch/index', () => {
       mockedFunction(createConfigMigrationBranch).mockResolvedValueOnce(
         'committed',
       );
-      const res = await checkConfigMigrationBranch(config, migratedData);
+      const res = await checkConfigMigrationBranch(
+        {
+          ...config,
+          dependencyDashboardChecks: {
+            configMigrationInfo: 'checked',
+          },
+        },
+        migratedData,
+      );
       // TODO: types (#22198)
-      expect(res).toBe(`${config.branchPrefix!}migrate-config`);
+      expect(res).toMatchObject({
+        result: 'pr-exists',
+        migrationBranch: `${config.branchPrefix!}migrate-config`,
+      });
       expect(scm.checkoutBranch).toHaveBeenCalledTimes(0);
       expect(git.commitFiles).toHaveBeenCalledTimes(0);
     });
@@ -105,46 +219,87 @@ describe('workers/repository/config-migration/branch/index', () => {
       const title = 'PR title';
       const pr = partial<Pr>({ title, state: 'closed', number: 1 });
 
-      it('skips branch when there is a closed one delete it and add an ignore PR message', async () => {
+      it('adds a checkbox when migration is disabled but needed and a closed pr exists', async () => {
         platform.findPr.mockResolvedValueOnce(pr);
         platform.getBranchPr.mockResolvedValue(null);
         scm.branchExists.mockResolvedValueOnce(true);
-        const res = await checkConfigMigrationBranch(config, migratedData);
-        expect(res).toBeNull();
-        expect(scm.checkoutBranch).toHaveBeenCalledTimes(0);
-        expect(scm.commitAndPush).toHaveBeenCalledTimes(0);
-        expect(scm.deleteBranch).toHaveBeenCalledTimes(1);
-        expect(logger.debug).toHaveBeenCalledWith(
-          { prTitle: title },
-          'Closed PR already exists. Skipping branch.',
+        const res = await checkConfigMigrationBranch(
+          {
+            ...config,
+            configMigration: false,
+            dependencyDashboardChecks: { configMigrationInfo: 'no-checkbox' },
+          },
+          migratedData,
         );
-        expect(platform.ensureComment).toHaveBeenCalledTimes(1);
-        expect(platform.ensureComment).toHaveBeenCalledWith({
-          content:
-            '\n\nIf you accidentally closed this PR, or if you changed your mind: rename this PR to get a fresh replacement PR.',
-          topic: 'Renovate Ignore Notification',
-          number: 1,
+        expect(res).toMatchObject({
+          result: 'add-checkbox',
         });
       });
 
-      it('dryrun: skips branch when there is a closed one and add an ignore PR message', async () => {
-        GlobalConfig.set({ dryRun: 'full' });
+      it('deletes old branch and creates new migration branch when migration is disabled but needed, a closed pr exists and checkbox is checked', async () => {
         platform.findPr.mockResolvedValueOnce(pr);
         platform.getBranchPr.mockResolvedValue(null);
         scm.branchExists.mockResolvedValueOnce(true);
-        const res = await checkConfigMigrationBranch(config, migratedData);
-        expect(res).toBeNull();
-        expect(logger.info).toHaveBeenCalledWith(
-          `DRY-RUN: Would ensure closed PR comment in PR #${pr.number}`,
+        mockedFunction(createConfigMigrationBranch).mockResolvedValueOnce(
+          'committed',
         );
-        expect(logger.info).toHaveBeenCalledWith(
-          'DRY-RUN: Would delete branch ' + pr.sourceBranch,
+        const res = await checkConfigMigrationBranch(
+          {
+            ...config,
+            configMigration: false,
+            dependencyDashboardChecks: { configMigrationInfo: 'checked' },
+          },
+          migratedData,
         );
-        expect(logger.debug).toHaveBeenCalledWith(
-          { prTitle: title },
-          'Closed PR already exists. Skipping branch.',
+        expect(scm.deleteBranch).toHaveBeenCalledTimes(1);
+        expect(res).toMatchObject({
+          result: 'pr-exists',
+          migrationBranch: `${config.branchPrefix!}migrate-config`,
+        });
+        expect(scm.checkoutBranch).toHaveBeenCalledTimes(1);
+      });
+
+      it('adds a checkbox when migration is enabled and a closed pr exists', async () => {
+        platform.findPr.mockResolvedValueOnce(pr);
+        platform.getBranchPr.mockResolvedValue(null);
+        scm.branchExists.mockResolvedValueOnce(true);
+        const res = await checkConfigMigrationBranch(
+          {
+            ...config,
+            configMigration: true,
+            dependencyDashboardChecks: { configMigrationInfo: 'no-checkbox' },
+          },
+          migratedData,
+        );
+        expect(res).toMatchObject({
+          result: 'add-checkbox',
+        });
+      });
+
+      it('dry run:deletes old branch and creates new migration branch when migration is disabled but needed, a closed pr exists and checkbox is checked', async () => {
+        GlobalConfig.set({
+          dryRun: 'full',
+        });
+        platform.findPr.mockResolvedValueOnce(pr);
+        platform.getBranchPr.mockResolvedValue(null);
+        scm.branchExists.mockResolvedValueOnce(true);
+        mockedFunction(createConfigMigrationBranch).mockResolvedValueOnce(
+          'committed',
+        );
+        const res = await checkConfigMigrationBranch(
+          {
+            ...config,
+            configMigration: false,
+            dependencyDashboardChecks: { configMigrationInfo: 'checked' },
+          },
+          migratedData,
         );
-        expect(platform.ensureComment).toHaveBeenCalledTimes(0);
+        expect(scm.deleteBranch).toHaveBeenCalledTimes(0);
+        expect(res).toMatchObject({
+          result: 'pr-exists',
+          migrationBranch: `${config.branchPrefix!}migrate-config`,
+        });
+        expect(scm.checkoutBranch).toHaveBeenCalledTimes(0);
       });
     });
   });