Merge pull request #527 from GSA/1828-feedback

1828: add prototype feedback link scan

Author: akuny

entities/core-result.entity.ts

@@ -380,6 +380,18 @@ export class CoreResult {
   })
   requiredLinksText?: string;
 
+  @Column({ nullable: true })
+  @Expose({ name: 'feedback_links_text' })
+  @Exclude()
+  @Transform(({ value }: { value: string }) => {
+    if (value) {
+      return value.split(',');
+    } else {
+      return null;
+    }
+  })
+  feedbackLinksText?: string;
+
   @Column({ nullable: true })
   @Expose({ name: 'login_provider' })
   loginProvider?: string;

entities/scan-data.entity.ts

@@ -121,6 +121,10 @@ export type RequiredLinksScan = {
   requiredLinksText: string;
 };
 
+export type FeedbackLinksScan = {
+  feedbackLinksText: string;
+};
+
 export type SearchScan = {
   searchDetected: boolean;
   searchgov: boolean;

entities/scan-page.entity.ts

@@ -25,6 +25,7 @@ export type PrimaryScans = {
   loginScan: ScanData.LoginScan;
   cmsScan: ScanData.CmsScan;
   requiredLinksScan: ScanData.RequiredLinksScan;
+  feedbackLinksScan: ScanData.FeedbackLinksScan;
   searchScan: ScanData.SearchScan;
   mobileScan: ScanData.MobileScan;
   toolingScan: ScanData.ToolingScan;

libs/core-scanner/src/core-scanner.service.ts

@@ -120,6 +120,7 @@ export class CoreScannerService implements Scanner<
     pageLogger.warn(
       `Page '${page}' does not include page filter '${input.page}'; skipping page.`,
     );
+    return false;
   }
 
   private createSkippedResult(): PageScanFailure {

libs/core-scanner/src/pages/primary.ts

@@ -15,6 +15,7 @@ import {
   createOutboundRequestsExtractor,
 } from './extractors';
 import { buildRequiredLinksResult } from '../scans/required-links';
+import { buildFeedbackLinksResult } from '../scans/feedback-links';
 import { buildCookieResult } from '../scans/cookies';
 import { buildSearchResult } from '../scans/search';
 import { buildMobileResult } from '../scans/mobile';
@@ -97,7 +98,14 @@ const primaryScan = async (
     input,
     pageLogger,
     buildRequiredLinksResult,
-    'Required LinksScan',
+    'RequiredLinksScan',
+    url,
+  );
+  const wrappedFeedbackLinksResult = runScan(
+    input,
+    pageLogger,
+    buildFeedbackLinksResult,
+    'FeedbackLinksScan',
     url,
   );
   const wrappedSearchResult = runScan(
@@ -132,6 +140,7 @@ const primaryScan = async (
     loginScan,
     cmsScan,
     requiredLinksScan,
+    feedbackLinksScan,
     searchScan,
     mobileScan,
     toolingScan,
@@ -145,6 +154,7 @@ const primaryScan = async (
     wrappedLoginResult(response),
     wrappedCmsResult(response),
     wrappedRequiredLinksResult(page),
+    wrappedFeedbackLinksResult(page),
     wrappedSearchResult(page),
     wrappedMobileResult(page),
     wrappedToolingResult(page),
@@ -160,6 +170,7 @@ const primaryScan = async (
     loginScan,
     cmsScan,
     requiredLinksScan,
+    feedbackLinksScan,
     searchScan,
     mobileScan,
     toolingScan,
@@ -233,5 +244,6 @@ const primaryScan = async (
     pageLogger.warn(
       `Scan '${scanName}' does not include scan filter '${input.scan}'; skipping scan.`,
     );
+    return false;
   }
 };

libs/core-scanner/src/scans/feedback-links.spec.ts

@@ -0,0 +1,21 @@
+import { browserInstance, newTestPage } from '../test-helper';
+import { buildFeedbackLinksResult } from './feedback-links';
+import pino from 'pino';
+
+const mockLogger = pino();
+
+describe('feedback links scan', () => {
+  it('detects feedback links strings in href attribute and a element text', async () => {
+    await newTestPage(async ({ page }) => {
+      expect(await buildFeedbackLinksResult(mockLogger, page)).toEqual({
+        feedbackLinksText: '',
+      });
+    });
+  });
+
+  afterAll(async () => {
+    if (browserInstance) {
+      await browserInstance.close();
+    }
+  });
+});

libs/core-scanner/src/scans/feedback-links.ts

@@ -0,0 +1,40 @@
+import { Page } from 'puppeteer';
+import { FeedbackLinksScan } from 'entities/scan-data.entity';
+import { Logger } from 'pino';
+
+export async function buildFeedbackLinksResult(
+  parentLogger: Logger,
+  page: Page,
+): Promise<FeedbackLinksScan> {
+  const feedbackLinksResults = await page.evaluate(() => {
+    const feedbackLinksTextContents = [
+      'feedback',
+      'contact',
+      'support',
+      'help',
+      'suggestion',
+      'customer-service',
+      'tell us what you think',
+      'let us know',
+      'survey',
+    ];
+
+    const feedbackLinksText = feedbackLinksTextContents
+      .filter((string) => {
+        let stringDetected = false;
+
+        document.querySelectorAll('a').forEach((el) => {
+          if (el.textContent.toLowerCase() === string) {
+            stringDetected = true;
+          }
+        });
+
+        return stringDetected;
+      })
+      .join(',');
+
+    return { feedbackLinksText };
+  });
+
+  return feedbackLinksResults;
+}

libs/database/src/core-results/core-result.service.spec.ts

@@ -166,6 +166,9 @@ describe('CoreResultService', () => {
             requiredLinksUrl: null,
             requiredLinksText: null,
           },
+          feedbackLinksScan: {
+            feedbackLinksText: null,
+          },
           searchScan: {
             searchDetected: null,
             searchgov: null,
@@ -374,6 +377,9 @@ describe('CoreResultService', () => {
             requiredLinksUrl: null,
             requiredLinksText: null,
           },
+          feedbackLinksScan: {
+            feedbackLinksText: null,
+          },
           searchScan: { searchDetected: null, searchgov: null },
           mobileScan: { viewportMetaTag: false },
           toolingScan: { tooling: null },

libs/database/src/core-results/core-result.service.ts

@@ -213,6 +213,9 @@ export class CoreResultService {
       coreResult.requiredLinksUrl = result.requiredLinksScan.requiredLinksUrl;
       coreResult.requiredLinksText = result.requiredLinksScan.requiredLinksText;
 
+      // Feedback links scan
+      coreResult.feedbackLinksText = result.feedbackLinksScan.feedbackLinksText;
+
       // Search scan
       coreResult.searchDetected = result.searchScan.searchDetected;
       coreResult.searchgov = result.searchScan.searchgov;
@@ -283,6 +286,7 @@ export class CoreResultService {
       coreResult.cms = null;
       coreResult.requiredLinksUrl = null;
       coreResult.requiredLinksText = null;
+      coreResult.feedbackLinksText = null;
       coreResult.searchDetected = null;
       coreResult.searchgov = null;
       coreResult.viewportMetaTag = null;