feat: adding OpenTelemetry option

Author: kazagz

__tests__/dsl/journey.test.ts

@@ -23,7 +23,12 @@
  *
  */
 
+import { trace } from '@opentelemetry/api';
 import { Journey, Step } from '../../src/dsl';
+import { addMonitorConfigAttributesToSpan } from '../../src/otel';
+
+jest.mock('../../src/otel');
+jest.spyOn(trace, 'getActiveSpan').mockImplementation(() => 'span' as any);
 
 const noop = () => {};
 describe('Journey', () => {
@@ -44,4 +49,14 @@ describe('Journey', () => {
     expect(s2).toBeInstanceOf(Step);
     expect(journey.steps.length).toBe(2);
   });
+
+  it('updates span when otel enabled and monitor config is added', () => {
+    const journey = new Journey({ name: 'j1' }, noop);
+    journey._updateMonitor('config' as any);
+    expect(trace.getActiveSpan).toHaveBeenCalled();
+    expect(addMonitorConfigAttributesToSpan).toHaveBeenCalledWith(
+      'span',
+      'config'
+    );
+  });
 });

__tests__/helper.test.ts

@@ -34,6 +34,7 @@ import {
   microSecsToSeconds,
   wrapFnWithLocation,
   isMatch,
+  maskCredentialsInURL,
 } from '../src/helpers';
 
 it('indent message with seperator', () => {
@@ -146,3 +147,12 @@ it('match tags and names', () => {
   expect(isMatch(['bar'], 'foo', undefined, 'ba*')).toBe(true);
   expect(isMatch(['bar'], 'foo', undefined, 'test*')).toBe(false);
 });
+
+it('mask credentials in URL', () => {
+  expect(maskCredentialsInURL('https://user:password@example.com')).toBe(
+    'https://***:***@example.com/'
+  );
+  expect(maskCredentialsInURL('https://example.com')).toBe(
+    'https://example.com/'
+  );
+});

__tests__/options.test.ts

@@ -44,6 +44,7 @@ describe('options', () => {
       sandbox: false,
       screenshots: 'on',
       dryRun: true,
+      otel: true,
       match: 'check*',
       pauseOnError: true,
       config: join(__dirname, 'fixtures', 'synthetics.config.ts'),
@@ -52,9 +53,11 @@ describe('options', () => {
       environment: 'test',
       params: {},
       screenshots: 'on',
+      otel: false,
     });
     expect(await normalizeOptions(cliArgs)).toMatchObject({
       dryRun: true,
+      otel: true,
       environment: 'test',
       grepOpts: { match: 'check*' },
       params: {

__tests__/otel/otel-traceable.test.ts

@@ -0,0 +1,48 @@
+/**
+ * MIT License
+ *
+ * Copyright (c) 2020-present, Elastic NV
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ *
+ */
+
+import { OtelTraceable } from '../../src/otel';
+
+describe('OtelTraceable', () => {
+  it('has no span and context after init', () => {
+    const traceable = new OtelTraceable();
+    expect(traceable._getSpan()).toBeUndefined();
+    expect(traceable._getContext()).toBeUndefined();
+  });
+
+  it('sets and clears span and context', () => {
+    const traceable = new OtelTraceable();
+
+    traceable._setSpan('span' as any);
+    traceable._setContext('context' as any);
+    expect(traceable._getSpan()).toBe('span');
+    expect(traceable._getContext()).toBe('context');
+
+    traceable._setSpan();
+    traceable._setContext();
+    expect(traceable._getSpan()).toBeUndefined();
+    expect(traceable._getContext()).toBeUndefined();
+  });
+});

__tests__/plugins/browser-console.test.ts

@@ -31,7 +31,11 @@ import { wsEndpoint } from '../utils/test-config';
 
 describe('BrowserConsole', () => {
   let server: Server;
-  const currentStep = { name: 'test-step', index: 0 };
+  const currentStep = {
+    name: 'test-step',
+    index: 0,
+    _getSpan: () => undefined,
+  };
   beforeAll(async () => {
     server = await Server.create();
   });