feat: Add support through package to support users providing a total_synthetic_timeout_millis option (#91)

Author: adamfweidman

package-lock.json

@@ -40,7 +40,7 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@google-cloud/synthetics-sdk-api": "^0.5.0",
+    "@google-cloud/synthetics-sdk-api": "^0.5.1",
     "puppeteer": "21.3.6"
   }
 }

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

@@ -47,6 +47,7 @@ export interface BrokenLinkCheckerOptions {
   max_retries?: number | undefined;
   wait_for_selector?: string;
   per_link_options?: { [key: string]: PerLinkOption };
+  total_synthetic_timeout_millis?: number;
 }
 
 export interface PerLinkOption {
@@ -78,8 +79,7 @@ try {
 instantiateMetadata(synthetics_sdk_broken_links_package);
 
 export async function runBrokenLinks(
-  inputOptions: BrokenLinkCheckerOptions,
-  total_timeout_millis = 50000
+  inputOptions: BrokenLinkCheckerOptions
 ): Promise<SyntheticResult> {
   // init
   const startTime = new Date().toISOString();
@@ -88,11 +88,13 @@ export async function runBrokenLinks(
   let browser: Browser;
   try {
     const options = processOptions(inputOptions);
+    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 `total_timeout_millis`
+    // imposed by `adjusted_synthetic_timeout`
     const [timeLimitPromise, timeLimitTimeout, timeLimitresolver] =
-      getTimeLimitPromise(startTime, total_timeout_millis);
+      getTimeLimitPromise(startTime, adjusted_synthetic_timeout_millis);
 
     const followed_links: BrokenLinksResultV1_SyntheticLinkResult[] = [];
 
@@ -107,7 +109,7 @@ export async function runBrokenLinks(
           originPage,
           options,
           startTime,
-          total_timeout_millis
+          adjusted_synthetic_timeout_millis
         )
       );
 
@@ -129,7 +131,7 @@ export async function runBrokenLinks(
           linksToFollow,
           options,
           startTime,
-          total_timeout_millis
+          adjusted_synthetic_timeout_millis
         ))
       );
       return true;
@@ -174,15 +176,15 @@ async function checkOriginLink(
   originPage: Page,
   options: BrokenLinksResultV1_BrokenLinkCheckerOptions,
   startTime: string,
-  total_timeout_millis: number
+  adjusted_synthetic_timeout_millis: number
 ): Promise<BrokenLinksResultV1_SyntheticLinkResult> {
   let originLinkResult: BrokenLinksResultV1_SyntheticLinkResult;
 
   // Create Promise and variables used to set and resolve the time limit
   const [timeLimitPromise, timeLimitTimeout, timeLimitresolver] =
     getTimeLimitPromise(
       startTime,
-      total_timeout_millis,
+      adjusted_synthetic_timeout_millis,
       /*extraOffsetMillis=*/ 500
     );
 
@@ -221,7 +223,7 @@ async function checkOriginLink(
       if (!finished && originLinkResult) {
         originLinkResult.link_passed = false;
         originLinkResult.error_type = 'TimeoutError';
-        originLinkResult.error_message = `Global Timeout of 60 secs hit while waiting for selector '${options.wait_for_selector}'`;
+        originLinkResult.error_message = `Total Synthetic Timeout of ${options.total_synthetic_timeout_millis} milliseconds hit while waiting for selector '${options.wait_for_selector}'`;
         process.stderr.write(originLinkResult.error_message);
       }
 

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

@@ -32,7 +32,9 @@ import {
  * @returns The sanitized input options if validation passes.
  * @throws {Error} If any of the input options fail validation.
  */
-export function validateInputOptions(inputOptions: BrokenLinkCheckerOptions) {
+export function validateInputOptions(
+  inputOptions: BrokenLinkCheckerOptions
+): BrokenLinkCheckerOptions {
   if (!inputOptions.origin_uri) {
     throw new Error('Missing origin_uri in options');
   } else if (
@@ -116,6 +118,18 @@ export function validateInputOptions(inputOptions: BrokenLinkCheckerOptions) {
     throw new Error('Invalid wait_for_selector value, must be a string');
   }
 
+  // Check total_synthetic_timeout_millis
+  if (
+    inputOptions.total_synthetic_timeout_millis !== undefined &&
+    (typeof inputOptions.total_synthetic_timeout_millis !== 'number' ||
+      inputOptions.total_synthetic_timeout_millis < 30000 ||
+      inputOptions.total_synthetic_timeout_millis > 60000)
+  ) {
+    throw new Error(
+      'Invalid total_synthetic_timeout_millis value, must be a number between 30000 and 60000 inclusive'
+    );
+  }
+
   // per_link_options
   for (const [key, value] of Object.entries(
     inputOptions.per_link_options || {}
@@ -165,6 +179,7 @@ export function validateInputOptions(inputOptions: BrokenLinkCheckerOptions) {
     max_retries: inputOptions.max_retries,
     wait_for_selector: inputOptions.wait_for_selector,
     per_link_options: inputOptions.per_link_options,
+    total_synthetic_timeout_millis: inputOptions.total_synthetic_timeout_millis,
   };
 }
 
@@ -187,6 +202,7 @@ export function setDefaultOptions(
     max_retries: 0,
     wait_for_selector: '',
     per_link_options: {},
+    total_synthetic_timeout_millis: 60000,
   };
 
   const outputOptions: BrokenLinksResultV1_BrokenLinkCheckerOptions =

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

@@ -136,6 +136,7 @@ describe('CloudFunctionV2 Running Broken Link Synthetics', async () => {
       max_retries: 0,
       wait_for_selector: '',
       per_link_options: {},
+      total_synthetic_timeout_millis: 60000,
     });
 
     expect(origin_link)
@@ -242,6 +243,7 @@ describe('CloudFunctionV2 Running Broken Link Synthetics', async () => {
       max_retries: 0,
       wait_for_selector: '',
       per_link_options: {},
+      total_synthetic_timeout_millis: 60000,
     });
 
     expect(origin_link)
@@ -364,6 +366,7 @@ describe('CloudFunctionV2 Running Broken Link Synthetics', async () => {
       max_retries: 0,
       wait_for_selector: '',
       per_link_options: {},
+      total_synthetic_timeout_millis: 60000,
     });
 
     expect(origin_link)

packages/synthetics-sdk-broken-links/test/integration/integration.spec.ts

@@ -84,9 +84,10 @@ describe('runBrokenLinks', async () => {
       query_selector_all: 'a[src], img[href]',
       get_attributes: ['href', 'src'],
       wait_for_selector: 'none existent',
-      link_timeout_millis: 5000,
+      link_timeout_millis: 35000,
+      total_synthetic_timeout_millis: 31000,
     };
-    const result = await runBrokenLinks(inputOptions, 3000);
+    const result = await runBrokenLinks(inputOptions);
     const broken_links_result = result.synthetic_broken_links_result_v1;
 
     const expectedOriginLinkResult: BrokenLinksResultV1_SyntheticLinkResult = {
@@ -99,7 +100,7 @@ describe('runBrokenLinks', async () => {
       status_code: 200,
       error_type: 'TimeoutError',
       error_message:
-        "Global Timeout of 60 secs hit while waiting for selector 'none existent'",
+        "Total Synthetic Timeout of 31000 milliseconds hit while waiting for selector 'none existent'",
       link_start_time: 'NA',
       link_end_time: 'NA',
       is_origin: true,
@@ -109,7 +110,7 @@ describe('runBrokenLinks', async () => {
       .excluding(['link_start_time', 'link_end_time'])
       .to.deep.equal(expectedOriginLinkResult);
     expect(broken_links_result?.followed_link_results.length).to.equal(0);
-  }).timeout(5000);
+  }).timeout(40000);
 
   it('successful execution with 1 failing link', async () => {
     const origin_uri = `file:${path.join(
@@ -136,6 +137,7 @@ describe('runBrokenLinks', async () => {
       max_retries: 0,
       wait_for_selector: '',
       per_link_options: {},
+      total_synthetic_timeout_millis: 60000,
     };
 
     const expectedOriginLinkResult: BrokenLinksResultV1_SyntheticLinkResult = {

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

@@ -267,6 +267,30 @@ describe('GCM Synthetics Broken Links  options_func suite testing', () => {
         validateInputOptions(options);
       }).not.to.throw();
     });
+    it('throws error if total_synthetic_timeout_millis is less than 30000', () => {
+      const options = {
+        origin_uri: 'http://example.com',
+        total_synthetic_timeout_millis: 29000,
+      } as BrokenLinkCheckerOptions;
+      expect(() => {
+        validateInputOptions(options);
+      }).to.throw(
+        Error,
+        'Invalid total_synthetic_timeout_millis value, must be a number between 30000 and 60000 inclusive'
+      );
+    });
+    it('throws error if total_synthetic_timeout_millis is more than 60000', () => {
+      const options = {
+        origin_uri: 'http://example.com',
+        total_synthetic_timeout_millis: 61000,
+      } as BrokenLinkCheckerOptions;
+      expect(() => {
+        validateInputOptions(options);
+      }).to.throw(
+        Error,
+        'Invalid total_synthetic_timeout_millis value, must be a number between 30000 and 60000 inclusive'
+      );
+    });
     it('throws error if per_link_options contains an invalid uri', () => {
       const options = {
         origin_uri: 'http://example.com',
@@ -382,6 +406,7 @@ describe('GCM Synthetics Broken Links  options_func suite testing', () => {
         max_retries: undefined,
         wait_for_selector: undefined,
         per_link_options: undefined,
+        total_synthetic_timeout_millis: undefined
       } as BrokenLinkCheckerOptions;
 
       expect(() => {