fix naming

Author: adamfweidman

packages/synthetics-sdk-broken-links/src/broken_links.ts

@@ -138,8 +138,9 @@ export async function runBrokenLinks(
     const storageParams: StorageParameters = {
       storageClient: storageClient,
       bucket: bucket,
-          checkId: 'fake-check-id',
-            executionId: 'fake-execution-id',
+      checkId: 'fake-check-id',
+      executionId: 'fake-execution-id',
+      screenshotNumber: 1,
     };
 
     const followed_links: BrokenLinksResultV1_SyntheticLinkResult[] = [];

packages/synthetics-sdk-broken-links/src/link_utils.ts

@@ -331,7 +331,7 @@ export function sanitizeObjectName(
     .replace(/\s+/g, '_'); // Replace one or more spaces with underscores
 }
 
-export function getStoragePagetStoragePathToExecutionthToExecution(
+export function getStoragePathToExecution(
   storageParams: StorageParameters,
   options: BrokenLinksResultV1_BrokenLinkCheckerOptions
 ) {

packages/synthetics-sdk-broken-links/src/options_func.ts

@@ -290,7 +290,7 @@ export function setDefaultOptions(
       defaultOptions.screenshot_options!.capture_condition;
   }
 
-  if (outputOptions.screenshot_options?.storage_location) {
+  if (inputOptions.screenshot_options?.storage_location) {
     outputOptions.screenshot_options.storage_location =
       inputOptions.screenshot_options!.storage_location!;
   } else {

packages/synthetics-sdk-broken-links/src/storage_func.ts

@@ -35,10 +35,9 @@ export interface StorageParameters {
   bucket: Bucket | null;
   checkId: string;
   executionId: string;
+  screenshotNumber: number;
 }
 
-let SCREENSHOT_NUMBER = 1;
-
 /**
  * Attempts to get an existing storage bucket if provided by the user OR
  * create/use a dedicated synthetics bucket.
@@ -56,15 +55,13 @@ export async function getOrCreateStorageBucket(
   storageLocation: string,
   errors: BaseError[]
 ): Promise<Bucket | null> {
-  SCREENSHOT_NUMBER = 1;
   let bucketName = '';
 
   try {
     if (!storageClient) return null;
 
     const projectId = sanitizeObjectName(await resolveProjectId());
     const region = sanitizeObjectName(await getExecutionRegion());
-    // const region = "us-east4"
 
     // if the user chose to use/create the default bucket but we were not able
     // to resolve projectId or cloudRegion
@@ -159,8 +156,8 @@ export async function uploadScreenshotToGCS(
       return screenshot_output;
     }
 
-    const screenshot: Buffer = await page.screenshot({ encoding: 'binary' });
-    const filename = 'screenshot_' + SCREENSHOT_NUMBER + '.png';
+    const screenshot: Buffer = await page.screenshot({ fullPage: true, encoding: 'binary' });
+    const filename = 'screenshot_' + storageParams.screenshotNumber + '.png';
 
     const writeDestination = path.join(
       getStoragePathToExecution(storageParams, options),
@@ -172,7 +169,7 @@ export async function uploadScreenshotToGCS(
       contentType: 'image/png',
     });
 
-    SCREENSHOT_NUMBER += 1;
+    storageParams.screenshotNumber += 1;
     screenshot_output.screenshot_file = filename;
   } catch (err) {
     // Handle upload errors

packages/synthetics-sdk-broken-links/test/unit/link_utils.spec.ts

@@ -69,6 +69,7 @@ describe('GCM Synthetics Broken Links Utilies', async () => {
     bucket: {} as Bucket,
     checkId: 'uptime123',
     executionId: 'exec456',
+    screenshotNumber: 1,
   };
 
   it('checkStatusPassing returns correctly when passed a number as ResponseStatusCode', () => {
@@ -229,8 +230,8 @@ describe('GCM Synthetics Broken Links Utilies', async () => {
 
   describe('sanitizeObjectName', () => {
     it('should remove invalid characters', () => {
-      const input = "test/\@#$%^&*()/_+\-=[]{};':\"\|,.<>/?\r\n\t";
-      const expectedOutput = "test_@_$%^&_()__+-=__{};'__\_,.______";
+      const input = 'test/@#$%^&*()/_+-=[]{};\':"|,.<>/?\r\n\t';
+      const expectedOutput = "test_@_$%^&_()__+-=__{};'___,.______";
       expect(sanitizeObjectName(input)).to.equal(expectedOutput);
     });
 

packages/synthetics-sdk-broken-links/test/unit/navigation_func.spec.ts

@@ -80,6 +80,7 @@ describe('GCM Synthetics Broken Links Navigation Functionality', async () => {
     bucket: sinon.createStubInstance(Bucket),
     checkId: '',
     executionId: '',
+    screenshotNumber: 1,
   };
 
   // Use proxyquire to replace uploadScreenshotToGCS
@@ -339,7 +340,7 @@ describe('GCM Synthetics Broken Links Navigation Functionality', async () => {
   });
 });
 
-describe.only('retrieveLinksFromPage', async () => {
+describe('retrieveLinksFromPage', async () => {
   // Puppeteer constants
   let browser: Browser;
   let page: Page;

packages/synthetics-sdk-broken-links/test/unit/storage_func.spec.ts

@@ -184,6 +184,7 @@ describe('GCM Synthetics Broken Links storage_func suite testing', () => {
           bucket: bucketStub,
           checkId: 'uptime123',
           executionId: 'exec456',
+          screenshotNumber: 1,
         };
         const options = {
           screenshot_options: { storage_location: 'bucket/folder1/folder2' },
@@ -225,6 +226,7 @@ describe('GCM Synthetics Broken Links storage_func suite testing', () => {
           bucket: bucketStub,
           checkId: '',
           executionId: '',
+          screenshotNumber: 1,
         };
         const options = {
           screenshot_options: {},
@@ -267,6 +269,7 @@ describe('GCM Synthetics Broken Links storage_func suite testing', () => {
           bucket: bucketStub,
           checkId: '',
           executionId: '',
+          screenshotNumber: 1,
         };
 
         const result = await uploadScreenshotToGCS(
@@ -288,7 +291,8 @@ describe('GCM Synthetics Broken Links storage_func suite testing', () => {
           bucket: null,
           checkId: '',
           executionId: '',
-        };
+          screenshotNumber: 1,
+        } as StorageParameters;
 
         const result = await uploadScreenshotToGCS(
           pageStub,

samples/broken-links-ok/google-cloud-synthetics-sdk-broken-links-0.2.0.tgz

@@ -18,8 +18,8 @@ const functions = require('@google-cloud/functions-framework');
 const GcmSynthetics = require('@google-cloud/synthetics-sdk-broken-links');
 
 const options = {
-  origin_uri: "https://en.wikipedia.org/wiki/World_War_II",
-  link_limit: 50,
+  origin_uri: "https://example.com",
+  // link_limit: 10,
   // query_selector_all: "a", // https://developer.mozilla.org/en-US/docs/Web/API/Document/querySelectorAll
   // get_attributes: ['href'], // https://developer.mozilla.org/en-US/docs/Web/API/Element/getAttribute
   // link_order: "FIRST_N", // "FIRST_N" or "RANDOM"

samples/broken-links-ok/index.js

@@ -7,7 +7,7 @@
     "gcp-build": "node node_modules/puppeteer/install.mjs"
   },
   "dependencies": {
-    "@google-cloud/synthetics-sdk-broken-links": "google-cloud-synthetics-sdk-broken-links-0.2.0.tgz",
+    "@google-cloud/synthetics-sdk-broken-links": "^0.1.0",
     "@google-cloud/functions-framework": "^3.1.2"
   },
   "author": "Google Inc.",