fix: skip crawlable audit when running onSuccess against deploy url

Author: aitchiss

src/lib/get-settings/get-settings.test.js

@@ -34,6 +34,11 @@ describe('replacements', () => {
     expect(derivedSettings.settings.locale).toEqual('es');
   });
 
+  it('should add skipAudits if using a deployUrl', () => {
+    const derivedSettings = getSettings({ preset: 'desktop' }, true);
+    expect(derivedSettings.settings.skipAudits).toEqual(['seo/is-crawlable']);
+  });
+
   it('should error with incorrect syntax for process.env.SETTINGS', () => {
     process.env.SETTINGS = 'not json';
     expect(getSettings).toThrow(/Invalid JSON/);

src/lib/get-settings/index.js

@@ -20,7 +20,7 @@ const mergeSettingsSources = (inputSettings = {}) => {
   return Object.assign({}, envSettings, inputSettings);
 };
 
-const getSettings = (inputSettings) => {
+const getSettings = (inputSettings, isUsingDeployUrl) => {
   const settings = mergeSettingsSources(inputSettings);
   if (Object.keys(settings).length === 0) return;
 
@@ -35,6 +35,12 @@ const getSettings = (inputSettings) => {
     derivedSettings.settings.locale = settings.locale;
   }
 
+  // If we are running against the Netlify deploy URL, the injected x-robots-tag will always cause the audit to fail,
+  // likely producing a false positive, so we skip in this case
+  if (isUsingDeployUrl) {
+    derivedSettings.settings.skipAudits = ['seo/is-crawlable'];
+  }
+
   return derivedSettings;
 };
 

src/lib/run-event/index.js

@@ -47,7 +47,7 @@ const runEvent = async ({
   let errorMetadata = [];
 
   try {
-    const settings = getSettings(inputs?.settings);
+    const settings = getSettings(inputs?.settings, isOnSuccess);
 
     const allErrors = [];
     const data = [];