rebase-capture-condition

Author: adamfweidman

package-lock.json

@@ -79,10 +79,10 @@ export enum StatusClass {
 
 export interface ScreenshotOptions {
   storage_location?: string;
-  screenshot_condition?: ScreenshotCondition;
+  capture_condition?: CaptureCondition;
 }
 
-export enum ScreenshotCondition {
+export enum CaptureCondition {
   NONE = 'NONE',
   FAILING = 'FAILING',
   ALL = 'ALL',
@@ -112,10 +112,10 @@ export async function runBrokenLinks(
     const errors: BaseError[] = [];
 
     // Initialize Storage Client with Error Handling. Set to `null` if
-    // screenshot_condition is 'None'
+    // capture_condition is 'None'
     const storageClient = createStorageClientIfStorageSelected(
       errors,
-      options.screenshot_options!.screenshot_condition
+      options.screenshot_options!.capture_condition
     );
 
     // TODO. Just to show where this will be called. uncommented in next PR

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

@@ -17,15 +17,15 @@ import {
   BrokenLinksResultV1_BrokenLinkCheckerOptions_LinkOrder,
   BrokenLinksResultV1_BrokenLinkCheckerOptions_PerLinkOption,
   BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions,
-  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition,
+  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_CaptureCondition as ApiCaptureCondition,
   ResponseStatusCode,
   ResponseStatusCode_StatusClass,
 } from '@google-cloud/synthetics-sdk-api';
 import {
   BrokenLinkCheckerOptions,
   LinkOrder,
   StatusClass,
-  ScreenshotCondition,
+  CaptureCondition,
 } from './broken_links';
 
 /**
@@ -156,13 +156,13 @@ export function validateInputOptions(
 
   // check storage_condition
   if (
-    inputOptions.screenshot_options?.screenshot_condition !== undefined &&
-    !Object.values(ScreenshotCondition).includes(
-      inputOptions.screenshot_options?.screenshot_condition
+    inputOptions.screenshot_options?.capture_condition !== undefined &&
+    !Object.values(CaptureCondition).includes(
+      inputOptions.screenshot_options?.capture_condition
     )
   ) {
     throw new Error(
-      'Invalid screenshot_condition value, must be `ALL`, `FAILING`, OR `NONE`'
+      'Invalid capture_condition value, must be `ALL`, `FAILING`, OR `NONE`'
     );
   }
 
@@ -217,8 +217,8 @@ export function validateInputOptions(
     per_link_options: inputOptions.per_link_options,
     total_synthetic_timeout_millis: inputOptions.total_synthetic_timeout_millis,
     screenshot_options: {
-      screenshot_condition:
-        inputOptions.screenshot_options?.screenshot_condition,
+      capture_condition:
+        inputOptions.screenshot_options?.capture_condition,
       storage_location: inputOptions.screenshot_options?.storage_location,
     },
   };
@@ -245,8 +245,8 @@ export function setDefaultOptions(
     per_link_options: {},
     total_synthetic_timeout_millis: 60000,
     screenshot_options: {
-      screenshot_condition:
-        BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition.FAILING,
+      capture_condition:
+      ApiCaptureCondition.FAILING,
       storage_location: '',
     },
   };
@@ -283,14 +283,14 @@ export function setDefaultOptions(
   // BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions
   outputOptions.screenshot_options =
     {} as BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions;
-  if (inputOptions.screenshot_options?.screenshot_condition) {
-    outputOptions.screenshot_options!.screenshot_condition =
-      BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition[
-        inputOptions.screenshot_options.screenshot_condition
+  if (inputOptions.screenshot_options?.capture_condition) {
+    outputOptions.screenshot_options!.capture_condition =
+    ApiCaptureCondition[
+        inputOptions.screenshot_options.capture_condition
       ];
   } else {
-    outputOptions.screenshot_options!.screenshot_condition =
-      defaultOptions.screenshot_options!.screenshot_condition;
+    outputOptions.screenshot_options!.capture_condition =
+      defaultOptions.screenshot_options!.capture_condition;
   }
 
   if (outputOptions.screenshot_options?.storage_location) {

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

@@ -17,7 +17,7 @@ import { Storage, Bucket } from '@google-cloud/storage';
 import {
   BaseError,
   BrokenLinksResultV1_BrokenLinkCheckerOptions,
-  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition as ApiScreenshotCondition,
+  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_CaptureCondition as ApiCaptureCondition,
   resolveProjectId,
   getExecutionRegion,
   BrokenLinksResultV1_SyntheticLinkResult_ScreenshotOutput as ApiScreenshotOutput,
@@ -107,9 +107,9 @@ export async function getOrCreateStorageBucket(
  */
 export function createStorageClientIfStorageSelected(
   errors: BaseError[],
-  storageCondition: ApiScreenshotCondition
+  captureCondition: ApiCaptureCondition
 ): Storage | null {
-  if (storageCondition === ApiScreenshotCondition.NONE) return null;
+  if (captureCondition === ApiCaptureCondition.NONE) return null;
 
   try {
     return new Storage();

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

@@ -16,7 +16,7 @@ import {
   BaseError,
   BrokenLinksResultV1_BrokenLinkCheckerOptions_LinkOrder,
   BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions,
-  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition,
+  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_CaptureCondition as ApiCaptureCondition,
   BrokenLinksResultV1_SyntheticLinkResult_ScreenshotOutput,
   ResponseStatusCode_StatusClass,
   SyntheticResult,
@@ -35,8 +35,8 @@ describe('CloudFunctionV2 Running Broken Link Synthetics', async () => {
   };
   const default_screenshot_options: BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions =
     {
-      screenshot_condition:
-        BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition.FAILING,
+      capture_condition:
+      ApiCaptureCondition.FAILING,
       storage_location: '',
     };
 

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

@@ -19,7 +19,7 @@ import {
   BrokenLinksResultV1_BrokenLinkCheckerOptions,
   BrokenLinksResultV1_BrokenLinkCheckerOptions_LinkOrder,
   BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions,
-  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition,
+  BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_CaptureCondition as ApiCaptureCondition,
   BrokenLinksResultV1_SyntheticLinkResult,
   ResponseStatusCode,
   BaseError,
@@ -37,8 +37,8 @@ describe('runBrokenLinks', async () => {
   };
   const default_screenshot_options: BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions =
     {
-      screenshot_condition:
-        BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition.FAILING,
+      capture_condition:
+      ApiCaptureCondition.FAILING,
       storage_location: '',
     };
 

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

@@ -371,19 +371,19 @@ describe('GCM Synthetics Broken Links options_func suite testing', () => {
     it('throws error if storage_condition is not a valid StorageCondition value', () => {
       const options = {
         origin_uri: 'http://example.com',
-        screenshot_options: { screenshot_condition: 'invalid' },
+        screenshot_options: { capture_condition: 'invalid' },
       } as any as BrokenLinkCheckerOptions;
       expect(() => {
         validateInputOptions(options);
       }).to.throw(
         Error,
-        'Invalid screenshot_condition value, must be `ALL`, `FAILING`, OR `NONE`'
+        'Invalid capture_condition value, must be `ALL`, `FAILING`, OR `NONE`'
       );
     });
     it('storage_condition accepts string', () => {
       const options = {
         origin_uri: 'http://example.com',
-        screenshot_options: { screenshot_condition: 'FAILING' },
+        screenshot_options: { capture_condition: 'FAILING' },
       } as any as BrokenLinkCheckerOptions;
       expect(() => {
         validateInputOptions(options);
@@ -425,7 +425,7 @@ describe('GCM Synthetics Broken Links options_func suite testing', () => {
         },
         screenshot_options: {
           storage_location: '',
-          screenshot_condition: 'FAILING',
+          capture_condition: 'FAILING',
         },
       } as BrokenLinkCheckerOptions;
 
@@ -452,7 +452,7 @@ describe('GCM Synthetics Broken Links options_func suite testing', () => {
         total_synthetic_timeout_millis: undefined,
         screenshot_options: {
           storage_location: undefined,
-          screenshot_condition: undefined,
+          capture_condition: undefined,
         },
       } as BrokenLinkCheckerOptions;
 

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

@@ -43,11 +43,11 @@ describe('GCM Synthetics Broken Links storage_func suite testing', () => {
 
   const storage_condition_failing_links =
     sdkApi
-      .BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition
+      .BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_CaptureCondition
       .FAILING;
   const storage_condition_none =
     sdkApi
-      .BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_ScreenshotCondition
+      .BrokenLinksResultV1_BrokenLinkCheckerOptions_ScreenshotOptions_CaptureCondition
       .NONE;
 
   beforeEach(() => {