feat: skip regenerating lock file maintenance if branch exists (#956)

lib/workers/branch/lock-files.js

@@ -197,6 +197,12 @@ async function getUpdatedLockFiles(config) {
   let lockFileError = false;
   const updatedLockFiles = [];
   try {
+    if (
+      config.type === 'lockFileMaintenance' &&
+      (await config.api.branchExists(config.branchName))
+    ) {
+      return { lockFileError, updatedLockFiles };
+    }
     const dirs = module.exports.determineLockFileDirs(config);
     logger.debug({ dirs }, 'lock file dirs');
     await module.exports.writeExistingFiles(config);

test/workers/branch/__snapshots__/lock-files.spec.js.snap

@@ -47,6 +47,13 @@ Object {
 }
 `;
 
+exports[`workers/branch/lock-files getUpdatedLockFiles returns no error and empty lockfiles if lock file maintenance exists 1`] = `
+Object {
+  "lockFileError": false,
+  "updatedLockFiles": Array [],
+}
+`;
+
 exports[`workers/branch/lock-files getUpdatedLockFiles returns no error and empty lockfiles if none updated 1`] = `
 Object {
   "lockFileError": false,

test/workers/branch/lock-files.spec.js

@@ -276,7 +276,10 @@ describe('workers/branch/lock-files', () => {
     beforeEach(() => {
       config = {
         ...defaultConfig,
-        api: { getFileContent: jest.fn(() => 'some lock file contents') },
+        api: {
+          branchExists: jest.fn(),
+          getFileContent: jest.fn(() => 'some lock file contents'),
+        },
         logger,
         tmpDir: { name: 'some-tmp-dir' },
       };
@@ -286,6 +289,14 @@ describe('workers/branch/lock-files', () => {
       yarn.generateLockFile.mockReturnValue('some lock file contents');
       lockFiles.determineLockFileDirs = jest.fn();
     });
+    it('returns no error and empty lockfiles if lock file maintenance exists', async () => {
+      config.type = 'lockFileMaintenance';
+      config.api.branchExists.mockReturnValueOnce(true);
+      const res = await getUpdatedLockFiles(config);
+      expect(res).toMatchSnapshot();
+      expect(res.lockFileError).toBe(false);
+      expect(res.updatedLockFiles).toHaveLength(0);
+    });
     it('returns no error and empty lockfiles if none updated', async () => {
       lockFiles.determineLockFileDirs.mockReturnValueOnce({
         packageLockFileDirs: [],