fix(config): Making suppression notification work for PR and onboardi…

…ngPR for consistency (#22831)
renovatebot · Jun 21, 2023 · ae8bb71 · ae8bb71
1 parent 8fa7a9d
commit ae8bb71
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 20 deletions.
diff --git a/lib/workers/repository/errors-warnings.spec.ts b/lib/workers/repository/errors-warnings.spec.ts
@@ -51,6 +51,7 @@ describe('workers/repository/errors-warnings', () => {
     });
 
     it('returns 2 pr warnings text dependencyDashboard true', () => {
+      const config: RenovateConfig = {};
       const dependencyDashboard = true;
       const packageFiles: Record<string, PackageFile[]> = {
         npm: [
@@ -84,7 +85,7 @@ describe('workers/repository/errors-warnings', () => {
         ],
       };
 
-      const res = getDepWarningsPR(packageFiles, dependencyDashboard);
+      const res = getDepWarningsPR(packageFiles, config, dependencyDashboard);
       expect(res).toMatchInlineSnapshot(`
         "
         ---
@@ -98,6 +99,7 @@ describe('workers/repository/errors-warnings', () => {
     });
 
     it('returns 2 pr warnings text dependencyDashboard false', () => {
+      const config: RenovateConfig = {};
       const dependencyDashboard = false;
       const packageFiles: Record<string, PackageFile[]> = {
         npm: [
@@ -131,7 +133,7 @@ describe('workers/repository/errors-warnings', () => {
         ],
       };
 
-      const res = getDepWarningsPR(packageFiles, dependencyDashboard);
+      const res = getDepWarningsPR(packageFiles, config, dependencyDashboard);
       expect(res).toMatchInlineSnapshot(`
         "
         ---
@@ -145,8 +147,18 @@ describe('workers/repository/errors-warnings', () => {
     });
 
     it('PR warning returns empty string', () => {
+      const config: RenovateConfig = {};
+      const packageFiles: Record<string, PackageFile[]> = {};
+      const res = getDepWarningsPR(packageFiles, config);
+      expect(res).toBe('');
+    });
+
+    it('suppress notifications contains dependencyLookupWarnings flag then return empty string', () => {
+      const config: RenovateConfig = {
+        suppressNotifications: ['dependencyLookupWarnings'],
+      };
       const packageFiles: Record<string, PackageFile[]> = {};
-      const res = getDepWarningsPR(packageFiles);
+      const res = getDepWarningsPR(packageFiles, config);
       expect(res).toBe('');
     });
   });
@@ -261,6 +273,7 @@ describe('workers/repository/errors-warnings', () => {
 
   describe('getDepWarningsOnboardingPR()', () => {
     it('returns onboarding warning text', () => {
+      const config: RenovateConfig = {};
       const packageFiles: Record<string, PackageFile[]> = {
         npm: [
           {
@@ -292,7 +305,7 @@ describe('workers/repository/errors-warnings', () => {
           },
         ],
       };
-      const res = getDepWarningsOnboardingPR(packageFiles);
+      const res = getDepWarningsOnboardingPR(packageFiles, config);
       expect(res).toMatchInlineSnapshot(`
         "
         ---
@@ -309,5 +322,14 @@ describe('workers/repository/errors-warnings', () => {
         "
       `);
     });
+
+    it('suppress notifications contains dependencyLookupWarnings flag then return empty string', () => {
+      const config: RenovateConfig = {
+        suppressNotifications: ['dependencyLookupWarnings'],
+      };
+      const packageFiles: Record<string, PackageFile[]> = {};
+      const res = getDepWarningsOnboardingPR(packageFiles, config);
+      expect(res).toBe('');
+    });
   });
 });
diff --git a/lib/workers/repository/errors-warnings.ts b/lib/workers/repository/errors-warnings.ts
@@ -59,9 +59,13 @@ function getDepWarnings(
 }
 
 export function getDepWarningsOnboardingPR(
-  packageFiles: Record<string, PackageFile[]>
+  packageFiles: Record<string, PackageFile[]>,
+  config: RenovateConfig
 ): string {
   const { warnings, warningFiles } = getDepWarnings(packageFiles);
+  if (config.suppressNotifications?.includes('dependencyLookupWarnings')) {
+    return '';
+  }
   let warningText = '';
   if (!warnings.length) {
     return '';
@@ -83,9 +87,13 @@ export function getDepWarningsOnboardingPR(
 
 export function getDepWarningsPR(
   packageFiles: Record<string, PackageFile[]>,
+  config: RenovateConfig,
   dependencyDashboard?: boolean
 ): string {
   const { warnings, warningFiles } = getDepWarnings(packageFiles);
+  if (config.suppressNotifications?.includes('dependencyLookupWarnings')) {
+    return '';
+  }
   let warningText = '';
   if (!warnings.length) {
     return '';

diff --git a/lib/workers/repository/onboarding/pr/index.ts b/lib/workers/repository/onboarding/pr/index.ts
@@ -122,7 +122,7 @@ If you need any further assistance then you can also [request help here](${
   prBody = prBody.replace('{{CONFIG}}\n', configDesc);
   prBody = prBody.replace(
     '{{WARNINGS}}\n',
-    getWarnings(config) + getDepWarningsOnboardingPR(packageFiles!)
+    getWarnings(config) + getDepWarningsOnboardingPR(packageFiles!, config)
   );
   prBody = prBody.replace('{{ERRORS}}\n', getErrors(config));
   prBody = prBody.replace('{{BASEBRANCH}}\n', getBaseBranchDesc(config));

diff --git a/lib/workers/repository/update/pr/body/index.spec.ts b/lib/workers/repository/update/pr/body/index.spec.ts
@@ -64,7 +64,8 @@ describe('workers/repository/update/pr/body/index', () => {
             createdInVer: '1.2.3',
             targetBranch: 'base',
           },
-        }
+        },
+        {}
       );
       expect(res).toBeEmptyString();
     });
@@ -94,7 +95,8 @@ describe('workers/repository/update/pr/body/index', () => {
             createdInVer: '1.2.3',
             targetBranch: 'base',
           },
-        }
+        },
+        {}
       );
 
       expect(upgrade).toMatchObject({
@@ -132,7 +134,8 @@ describe('workers/repository/update/pr/body/index', () => {
             createdInVer: '1.2.3',
             targetBranch: 'base',
           },
-        }
+        },
+        {}
       );
 
       expect(upgrade).toMatchObject({
@@ -160,7 +163,8 @@ describe('workers/repository/update/pr/body/index', () => {
             createdInVer: '1.2.3',
             targetBranch: 'base',
           },
-        }
+        },
+        {}
       );
       expect(res).toContain('PR BODY');
       expect(res).toContain(`<!--renovate-debug`);
@@ -184,7 +188,8 @@ describe('workers/repository/update/pr/body/index', () => {
             createdInVer: '1.2.3',
             targetBranch: 'base',
           },
-        }
+        },
+        {}
       );
       expect(res).toContain(['aaa', '**Rebasing**: BAR', 'bbb'].join('\n'));
     });
@@ -206,7 +211,8 @@ describe('workers/repository/update/pr/body/index', () => {
             createdInVer: '1.2.3',
             targetBranch: 'base',
           },
-        }
+        },
+        {}
       );
 
       const match = prDebugDataRe.exec(res);
@@ -255,7 +261,8 @@ describe('workers/repository/update/pr/body/index', () => {
             createdInVer: '1.2.3',
             targetBranch: 'base',
           },
-        }
+        },
+        {}
       );
       const expected =
         '---\n\n### ⚠ Dependency Lookup Warnings ⚠' +

diff --git a/lib/workers/repository/update/pr/body/index.ts b/lib/workers/repository/update/pr/body/index.ts
@@ -1,3 +1,4 @@
+import type { RenovateConfig } from '../../../../../config/types';
 import { PrDebugData, platform } from '../../../../../modules/platform';
 import { regEx } from '../../../../../util/regex';
 import { toBase64 } from '../../../../../util/string';
@@ -67,14 +68,16 @@ const rebasingRegex = regEx(/\*\*Rebasing\*\*: .*/);
 
 export function getPrBody(
   branchConfig: BranchConfig,
-  prBodyConfig: PrBodyConfig
+  prBodyConfig: PrBodyConfig,
+  config: RenovateConfig
 ): string {
   massageUpdateMetadata(branchConfig);
   let warnings = '';
   warnings += getWarnings(branchConfig);
   if (branchConfig.packageFiles) {
     warnings += getDepWarningsPR(
       branchConfig.packageFiles,
+      config,
       branchConfig.dependencyDashboard
     );
   }

diff --git a/lib/workers/repository/update/pr/index.ts b/lib/workers/repository/update/pr/index.ts
@@ -315,12 +315,16 @@ export async function ensurePr(
     }
   }
 
-  const prBody = getPrBody(config, {
-    debugData: updatePrDebugData(
-      config.baseBranch,
-      existingPr?.bodyStruct?.debugData
-    ),
-  });
+  const prBody = getPrBody(
+    config,
+    {
+      debugData: updatePrDebugData(
+        config.baseBranch,
+        existingPr?.bodyStruct?.debugData
+      ),
+    },
+    config
+  );
 
   try {
     if (existingPr) {