Take and populate screenshot (#114)

* screenshots-prop

* broken_links.spec working

* fix naming

* pass-args

* response to comments

Author: adamfweidman

package-lock.json

@@ -27,12 +27,14 @@
     "@types/chai": "^4.3.4",
     "@types/express": "^4.17.17",
     "@types/node": "^18.15.10",
+    "@types/proxyquire": "^1.3.31",
     "@types/sinon": "^10.0.16",
     "@types/supertest": "^2.0.12",
     "chai": "^4.3.7",
     "chai-exclude": "^2.1.0",
     "express": "^4.18.2",
     "proxyquire": "^2.1.3",
+    "node-mocks-http": "^1.13.0",
     "sinon": "^16.1.1",
     "supertest": "^6.3.3",
     "synthetics-sdk-broken-links": "file:./"

packages/synthetics-sdk-broken-links/google-cloud-synthetics-sdk-api-0.5.1.tgz

@@ -40,6 +40,7 @@ import { processOptions } from './options_func';
 import {
   createStorageClientIfStorageSelected,
   getOrCreateStorageBucket,
+  StorageParameters,
 } from './storage_func';
 
 // External Dependencies
@@ -100,7 +101,11 @@ try {
 instantiateMetadata(synthetics_sdk_broken_links_package);
 
 export async function runBrokenLinks(
-  inputOptions: BrokenLinkCheckerOptions
+  inputOptions: BrokenLinkCheckerOptions,
+  args: {
+    executionId: string | undefined;
+    checkId: string | undefined;
+  }
 ): Promise<SyntheticResult> {
   // init
   const startTime = new Date().toISOString();
@@ -112,6 +117,11 @@ export async function runBrokenLinks(
     const adjusted_synthetic_timeout_millis =
       options.total_synthetic_timeout_millis! - 7000;
 
+    // Create Promise and variables used to set and resolve the time limit
+    // imposed by `adjusted_synthetic_timeout`
+    const [timeLimitPromise, timeLimitTimeout, timeLimitresolver] =
+      getTimeLimitPromise(startTime, adjusted_synthetic_timeout_millis);
+
     const errors: BaseError[] = [];
 
     // Initialize Storage Client with Error Handling. Set to `null` if
@@ -121,18 +131,20 @@ export async function runBrokenLinks(
       options.screenshot_options!.capture_condition
     );
 
-    // TODO. Just to show where this will be called. uncommented in next PR
-    // Bucket Validation
-    // const bucket: Bucket | null = await getOrCreateStorageBucket(
-    //   storageClient,
-    //   options.screenshot_options!.storage_location,
-    //   errors
-    // );
+    // // Bucket Validation
+    const bucket: Bucket | null = await getOrCreateStorageBucket(
+      storageClient,
+      options.screenshot_options!.storage_location,
+      errors
+    );
 
-    // Create Promise and variables used to set and resolve the time limit
-    // imposed by `adjusted_synthetic_timeout`
-    const [timeLimitPromise, timeLimitTimeout, timeLimitresolver] =
-      getTimeLimitPromise(startTime, adjusted_synthetic_timeout_millis);
+    const storageParams: StorageParameters = {
+      storageClient: storageClient,
+      bucket: bucket,
+      checkId: args.checkId || '_',
+      executionId: args.executionId || '_',
+      screenshotNumber: 1,
+    };
 
     const followed_links: BrokenLinksResultV1_SyntheticLinkResult[] = [];
 
@@ -147,7 +159,8 @@ export async function runBrokenLinks(
           originPage,
           options,
           startTime,
-          adjusted_synthetic_timeout_millis
+          adjusted_synthetic_timeout_millis,
+          storageParams
         )
       );
 
@@ -169,7 +182,8 @@ export async function runBrokenLinks(
           linksToFollow,
           options,
           startTime,
-          adjusted_synthetic_timeout_millis
+          adjusted_synthetic_timeout_millis,
+          storageParams
         ))
       );
       return true;
@@ -188,6 +202,7 @@ export async function runBrokenLinks(
       runtime_metadata,
       options,
       followed_links,
+      storageParams,
       errors
     );
   } catch (err) {
@@ -215,7 +230,8 @@ async function checkOriginLink(
   originPage: Page,
   options: BrokenLinksResultV1_BrokenLinkCheckerOptions,
   startTime: string,
-  adjusted_synthetic_timeout_millis: number
+  adjusted_synthetic_timeout_millis: number,
+  storageParams: StorageParameters
 ): Promise<BrokenLinksResultV1_SyntheticLinkResult> {
   let originLinkResult: BrokenLinksResultV1_SyntheticLinkResult;
 
@@ -232,6 +248,7 @@ async function checkOriginLink(
       originPage,
       { target_uri: options.origin_uri, anchor_text: '', html_element: '' },
       options,
+      storageParams,
       true
     );
 

packages/synthetics-sdk-broken-links/package.json

@@ -18,6 +18,9 @@ import { Request, Response } from 'express';
 // Internal Project Files
 import { runBrokenLinks, BrokenLinkCheckerOptions } from './broken_links';
 
+const syntheticExecutionIdHeader = 'Synthetic-Execution-Id';
+const checkIdHeader = 'Check-Id';
+
 /**
  * Middleware for easy invocation of SyntheticSDK broken links, and may be used to
  * register a GoogleCloudFunction http function, or express js compatible handler.
@@ -29,5 +32,10 @@ import { runBrokenLinks, BrokenLinkCheckerOptions } from './broken_links';
 export function runBrokenLinksHandler(options: BrokenLinkCheckerOptions) {
   // eslint-disable-next-line  @typescript-eslint/no-explicit-any
   return async (req: Request, res: Response): Promise<any> =>
-    res.send(await runBrokenLinks(options));
+    res.send(
+      await runBrokenLinks(options, {
+        executionId: req.get(syntheticExecutionIdHeader),
+        checkId: req.get(checkIdHeader),
+      })
+    );
 }

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

@@ -12,12 +12,16 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
+// Standard Libraries
+import * as path from 'path';
+
 // Internal Project Files
 import {
   BaseError,
   BrokenLinksResultV1,
   BrokenLinksResultV1_BrokenLinkCheckerOptions,
   BrokenLinksResultV1_BrokenLinkCheckerOptions_LinkOrder,
+  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_CaptureCondition as ApiCaptureCondition,
   BrokenLinksResultV1_SyntheticLinkResult,
   GenericResultV1,
   getRuntimeMetadata,
@@ -28,6 +32,7 @@ import {
 
 // External Dependencies
 import { HTTPResponse } from 'puppeteer';
+import { StorageParameters } from './storage_func';
 
 /**
  * Represents an intermediate link with its properties.
@@ -157,7 +162,7 @@ function parseFollowedLinks(
     options: {} as BrokenLinksResultV1_BrokenLinkCheckerOptions,
     origin_link_result: {} as BrokenLinksResultV1_SyntheticLinkResult,
     followed_link_results: [],
-    execution_data_storage_path: '', // TODO: make sure that when this is set it begins with gs://
+    execution_data_storage_path: '',
     errors: [],
   };
 
@@ -223,13 +228,20 @@ export function createSyntheticResult(
   runtime_metadata: { [key: string]: string },
   options: BrokenLinksResultV1_BrokenLinkCheckerOptions,
   followed_links: BrokenLinksResultV1_SyntheticLinkResult[],
+  storageParams: StorageParameters,
   errors: BaseError[]
 ): SyntheticResult {
   // Create BrokenLinksResultV1 by parsing followed links and setting options
   const broken_links_result: BrokenLinksResultV1 =
     parseFollowedLinks(followed_links);
   broken_links_result.options = options;
   broken_links_result.errors = errors;
+  broken_links_result.execution_data_storage_path = storageParams.bucket
+    ? 'gs://' +
+      storageParams.bucket.name +
+      '/' +
+      getStoragePathToExecution(storageParams, options)
+    : '';
 
   // Create SyntheticResult object
   const synthetic_result: SyntheticResult = {
@@ -273,6 +285,26 @@ export function shuffleAndTruncate(
 }
 
 /**
+ * Determines whether a screenshot should be taken based on screenshot options and link result.
+ *
+ * @param options - BrokenLinksResultV1_BrokenLinkCheckerOptions
+ * @param passed -  boolean indicating whether the link navigation succeeded
+ * @returns true if a screenshot should be taken, false otherwise
+ */
+export function shouldTakeScreenshot(
+  options: BrokenLinksResultV1_BrokenLinkCheckerOptions,
+  passed: boolean
+): boolean {
+  return (
+    options.screenshot_options!.capture_condition === ApiCaptureCondition.ALL ||
+    (options.screenshot_options!.capture_condition ===
+      ApiCaptureCondition.FAILING &&
+      !passed)
+  );
+}
+
+/**
+
  * Sanitizes an object name string for safe use, ensuring compliance with
  * naming restrictions.
  *
@@ -303,6 +335,38 @@ export function sanitizeObjectName(
     .replace(/\s+/g, '_'); // Replace one or more spaces with underscores
 }
 
+export function getStoragePathToExecution(
+  storageParams: StorageParameters,
+  options: BrokenLinksResultV1_BrokenLinkCheckerOptions
+) {
+  try {
+    const storageLocation = options.screenshot_options!.storage_location;
+    let writeDestination = '';
+
+    // extract folder name for a given storage location. If there is no '/'
+    // present then the storageLocation is just a folder
+    const firstSlashIndex = storageLocation.indexOf('/');
+    if (firstSlashIndex !== -1) {
+      writeDestination = storageLocation.substring(firstSlashIndex + 1);
+    }
+
+    // Ensure writeDestination ends with a slash for proper path joining
+    if (writeDestination && !writeDestination.endsWith('/')) {
+      writeDestination += '/';
+    }
+
+    writeDestination = path.join(
+      writeDestination,
+      storageParams.checkId,
+      storageParams.executionId
+    );
+
+    return writeDestination;
+  } catch (err) {
+    return '';
+  }
+}
+
 export function getTimeLimitPromise(
   startTime: string,
   totalTimeoutMillis: number,