pass-args

Author: adamfweidman

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

@@ -101,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();
@@ -138,9 +142,9 @@ export async function runBrokenLinks(
     const storageParams: StorageParameters = {
       storageClient: storageClient,
       bucket: bucket,
-          checkId: 'fake-check-id',
-            executionId: 'fake-execution-id',
-      screenshotNumber: 1,
+      checkId: args.checkId || '_',
+      executionId: args.executionId || '_',
+      screenshotNumber: 1
     };
 
     const followed_links: BrokenLinksResultV1_SyntheticLinkResult[] = [];

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

@@ -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/test/unit/broken_links.spec.ts

@@ -60,6 +60,7 @@ describe('runBrokenLinks', async () => {
     screenshot_file: 'bucket/folder/file.png',
     screenshot_error: {} as BaseError,
   };
+  const args = { checkId: 'test-check-id', executionId: 'test-execution-id' };
 
   const mockedstorageFunc = proxyquire('../../src/storage_func', {
     '@google-cloud/synthetics-sdk-api': {
@@ -103,7 +104,7 @@ describe('runBrokenLinks', async () => {
       origin_uri: 'uri-does-not-start-with-http',
     };
 
-    const result = await runBrokenLinks(inputOptions);
+    const result = await runBrokenLinks(inputOptions, args);
 
     const genericResult = result.synthetic_generic_result_v1;
 
@@ -137,7 +138,7 @@ describe('runBrokenLinks', async () => {
       screenshot_options: { capture_condition: CaptureCondition.NONE },
     };
 
-    const result = await mockedBlc.runBrokenLinks(inputOptions);
+    const result = await mockedBlc.runBrokenLinks(inputOptions, args);
 
     const broken_links_result = result?.synthetic_broken_links_result_v1;
     const origin_link = broken_links_result?.origin_link_result;
@@ -174,7 +175,7 @@ describe('runBrokenLinks', async () => {
       total_synthetic_timeout_millis: 31000,
       screenshot_options: { capture_condition: CaptureCondition.NONE },
     };
-    const result = await mockedBlc.runBrokenLinks(inputOptions);
+    const result = await mockedBlc.runBrokenLinks(inputOptions, args);
     const broken_links_result = result.synthetic_broken_links_result_v1;
 
     const expectedOriginLinkResult: BrokenLinksResultV1_SyntheticLinkResult = {
@@ -210,7 +211,7 @@ describe('runBrokenLinks', async () => {
       screenshot_options: { capture_condition: CaptureCondition.NONE },
     };
 
-    const result = await runBrokenLinks(inputOptions);
+    const result = await runBrokenLinks(inputOptions, args);
 
     const broken_links_result = result?.synthetic_broken_links_result_v1;
     const origin_link = broken_links_result?.origin_link_result;
@@ -274,7 +275,7 @@ describe('runBrokenLinks', async () => {
       },
     };
 
-    const result = await mockedBlc.runBrokenLinks(inputOptions);
+    const result = await mockedBlc.runBrokenLinks(inputOptions, args);
 
     const broken_links_result = result?.synthetic_broken_links_result_v1;
     const options = broken_links_result?.options;

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

@@ -0,0 +1,60 @@
+// Copyright 2023 Google LLC
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//      https://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+// Standard Libraries
+import { expect } from 'chai';
+import sinon from 'sinon';
+
+// External Dependency
+import httpMocks from 'node-mocks-http';
+const proxyquire = require('proxyquire');
+
+import { runBrokenLinksHandler } from '../../src/handlers';
+import { BrokenLinkCheckerOptions } from '../../src/broken_links';
+
+describe.only('Broken Links Synthetic Handler', async () => {
+  it('has check id and execution id available', async () => {
+    // Stub the runBrokenLinks function using Sinon
+    const mockRunBrokenLinks = sinon.stub().callsFake(async (opts, args) => {
+      return Promise.resolve({ mocked_response: 'is unimportant' });
+    });
+    const mockedBrokenLinks = proxyquire('../../src/handlers', {
+      './broken_links': { runBrokenLinks: mockRunBrokenLinks },
+    });
+
+    // Options for the runBrokenLinksHandler
+    const options: BrokenLinkCheckerOptions = {
+      origin_uri: 'https://example.com',
+    };
+
+    // Create mock request and response
+    const req = httpMocks.createRequest({
+      headers: {
+        ['Synthetic-Execution-Id']: 'test-execution-id',
+        ['Check-Id']: 'test-check-id',
+      },
+    });
+    const res = httpMocks.createResponse();
+
+    // Call the middleware
+    await mockedBrokenLinks.runBrokenLinksHandler(options)(req, res);
+
+    // Assertions with Sinon and Chai
+    sinon.assert.calledWith(mockRunBrokenLinks, options, {
+      executionId: 'test-execution-id',
+      checkId: 'test-check-id',
+    });
+    expect(res.statusCode).to.equal(200);
+  }).timeout(5000);
+});