feat(sdk-trace-web): web worker support (#2719)

Co-authored-by: Valentin Marchaud <contact@vmarchaud.fr>

.github/workflows/unit-test.yml

@@ -81,6 +81,41 @@ jobs:
         run: npm run test:browser
       - name: Report Coverage
         run: npm run codecov:browser
+  webworker-tests-stable:
+    runs-on: ubuntu-latest
+    container:
+      image: circleci/node:14-browsers
+    env:
+      NPM_CONFIG_UNSAFE_PERM: true
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Permission Setup
+        run: sudo chmod -R 777 /github /__w
+
+      - name: restore lerna
+        uses: actions/cache@v2
+        id: cache
+        with:
+          path: |
+            node_modules
+            */*/node_modules
+          key: browser-tests-stable-${{ runner.os }}-${{ matrix.node_version }}-${{ hashFiles('**/package.json') }}
+
+      - name: Bootstrap
+        if: steps.cache.outputs.cache-hit != 'true'
+        run: |
+          npm install --ignore-scripts
+          npx lerna bootstrap --no-ci --hoist --nohoist='zone.js'
+
+      - name: Build 🔧
+        run: |
+          npm run compile
+
+      - name: Unit tests
+        run: npm run test:webworker
+      - name: Report Coverage
+        run: npm run codecov:webworker
   node-tests-experimental:
     strategy:
       fail-fast: false
@@ -164,3 +199,42 @@ jobs:
       - name: Report Coverage
         working-directory: experimental
         run: npm run codecov:browser
+  webworker-tests-experimental:
+    runs-on: ubuntu-latest
+    container:
+      image: circleci/node:14-browsers
+    env:
+      NPM_CONFIG_UNSAFE_PERM: true
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v1
+      - name: Permission Setup
+        run: sudo chmod -R 777 /github /__w
+
+      - name: restore lerna
+        uses: actions/cache@v2
+        id: cache
+        with:
+          path: |
+            experimental/node_modules
+            experimental/*/*/node_modules
+          key: browser-tests-experimental-${{ runner.os }}-${{ matrix.node_version }}-${{ hashFiles('**/package.json') }}
+
+      - name: Bootstrap
+        if: steps.cache.outputs.cache-hit != 'true'
+        working-directory: experimental
+        run: |
+          npm install --ignore-scripts
+          npx lerna bootstrap --no-ci --hoist --nohoist='zone.js'
+
+      - name: Build 🔧
+        working-directory: experimental
+        run: |
+          npm run compile
+
+      - name: Unit tests
+        working-directory: experimental
+        run: npm run test:webworker
+      - name: Report Coverage
+        working-directory: experimental
+        run: npm run codecov:webworker

doc/web-api.md

@@ -0,0 +1,21 @@
+# Web API Usages Guidance
+
+The packages of OpenTelemetry that targeting web platforms should be compatible
+with the following web environments:
+
+- [Browsing Context](https://developer.mozilla.org/en-US/docs/Glossary/Browsing_context),
+- [Web Worker](https://developer.mozilla.org/en-US/docs/Web/API/Web_Workers_API/Functions_and_classes_available_to_workers).
+
+As such, the usage of Web API that depends on APIs like [`window`],
+[`document`] and [`navigator`] is discouraged.
+
+If the use of the browsing context API is necessary, like adding `onload`
+listeners, an alternative code path for Web Worker environment should also be
+supported.
+
+It is an exception to above guidance if the package is instrumenting the
+browsing context only.
+
+[`window`]: https://developer.mozilla.org/en-US/docs/Web/API/window
+[`document`]: https://developer.mozilla.org/en-US/docs/Web/API/Document
+[`navigator]: https://developer.mozilla.org/en-US/docs/Web/API/Navigator

experimental/packages/opentelemetry-instrumentation-xml-http-request/.eslintrc.js

@@ -1,9 +1,7 @@
 module.exports = {
     "env": {
         "mocha": true,
-        "commonjs": true,
         "browser": true,
-        "jquery": true
     },
     ...require('../../../eslint.config.js')
 }

karma.base.js

@@ -26,6 +26,8 @@ module.exports = {
   },
   reporters: ['spec', 'coverage-istanbul'],
   files: ['test/index-webpack.ts'],
-  preprocessors: { 'test/index-webpack.ts': ['webpack'] },
+  preprocessors: {
+    'test/index-webpack*.ts': ['webpack']
+  },
   webpackMiddleware: { noInfo: true }
 };

karma.worker.js

@@ -0,0 +1,27 @@
+/*!
+ * Copyright The OpenTelemetry Authors
+ *
+ * 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
+ *
+ *      http://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.
+ */
+
+const baseConfig = require('./karma.base');
+
+module.exports = {
+  ...baseConfig,
+  frameworks: ['mocha-webworker'],
+
+  files: [{
+    pattern: 'test/index-webpack.worker.ts',
+    included: false,
+  }],
+};

package.json

@@ -16,11 +16,13 @@
     "version:update": "lerna run version:update",
     "test": "lerna run test",
     "test:browser": "lerna run test:browser",
+    "test:webworker": "lerna run test:webworker",
     "test:backcompat": "lerna run test:backcompat",
     "bootstrap": "lerna bootstrap --hoist --nohoist='zone.js'",
     "changelog": "lerna-changelog",
     "codecov": "lerna run codecov",
     "codecov:browser": "lerna run codecov:browser",
+    "codecov:webworker": "lerna run codecov:webworker",
     "predocs-test": "npm run docs",
     "docs": "typedoc && touch docs/.nojekyll",
     "docs-deploy": "gh-pages --dotfiles --dist docs",

packages/opentelemetry-sdk-trace-web/.eslintrc.js

@@ -1,9 +1,7 @@
 module.exports = {
     "env": {
         "mocha": true,
-        "commonjs": true,
         "browser": true,
-        "jquery": true
     },
     ...require('../../eslint.config.js')
 }

packages/opentelemetry-sdk-trace-web/karma.worker.js

@@ -0,0 +1,24 @@
+/*!
+ * Copyright The OpenTelemetry Authors
+ *
+ * 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
+ *
+ *      http://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.
+ */
+
+const karmaWebpackConfig = require('../../karma.webpack');
+const karmaBaseConfig = require('../../karma.worker');
+
+module.exports = (config) => {
+  config.set(Object.assign({}, karmaBaseConfig, {
+    webpack: karmaWebpackConfig
+  }))
+};

packages/opentelemetry-sdk-trace-web/package.json

@@ -13,9 +13,11 @@
     "lint": "eslint . --ext .ts",
     "lint:fix": "eslint . --ext .ts --fix",
     "codecov:browser": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
+    "codecov:webworker": "nyc report --reporter=json && codecov -f coverage/*.json -p ../../",
     "version": "node ../../scripts/version-update.js",
     "tdd": "karma start",
     "test:browser": "nyc karma start --single-run",
+    "test:webworker": "nyc karma start karma.worker.js --single-run",
     "watch": "tsc --build --watch tsconfig.all.json",
     "precompile": "lerna run version --scope $(npm pkg get name) --include-dependencies",
     "prewatch": "npm run precompile"
@@ -69,6 +71,7 @@
     "karma-coverage-istanbul-reporter": "3.0.3",
     "karma-jquery": "0.2.4",
     "karma-mocha": "2.0.1",
+    "karma-mocha-webworker": "1.3.0",
     "karma-spec-reporter": "0.0.32",
     "karma-webpack": "4.0.2",
     "mocha": "7.2.0",

packages/opentelemetry-sdk-trace-web/src/utils.ts

@@ -164,7 +164,7 @@ export function getResource(
   }
   const sorted = sortResources(filteredResources);
 
-  if (parsedSpanUrl.origin !== window.location.origin && sorted.length > 1) {
+  if (parsedSpanUrl.origin !== location.origin && sorted.length > 1) {
     let corsPreFlightRequest: PerformanceResourceTiming | undefined = sorted[0];
     let mainRequest: PerformanceResourceTiming = findMainRequest(
       sorted,
@@ -421,7 +421,7 @@ export function shouldPropagateTraceHeaders(
   }
   const parsedSpanUrl = parseUrl(spanUrl);
 
-  if (parsedSpanUrl.origin === window.location.origin) {
+  if (parsedSpanUrl.origin === location.origin) {
     return true;
   } else {
     return propagateTraceHeaderUrls.some(propagateTraceHeaderUrl =>

packages/opentelemetry-sdk-trace-web/test/StackContextManager.test.ts

@@ -111,7 +111,7 @@ describe('StackContextManager', () => {
         assert.strictEqual(contextManager.active(), ctx1);
         return done();
       });
-      assert.strictEqual(contextManager.active(), window);
+      assert.strictEqual(contextManager.active(), globalThis);
     });
 
     it('should finally restore an old context when context is an object', done => {
@@ -130,7 +130,7 @@ describe('StackContextManager', () => {
         assert.strictEqual(contextManager.active(), ctx1);
         return done();
       });
-      assert.strictEqual(contextManager.active(), window);
+      assert.strictEqual(contextManager.active(), globalThis);
     });
 
     it('should forward this, arguments and return value', () => {

packages/opentelemetry-sdk-trace-web/test/index-webpack.ts

@@ -13,8 +13,13 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-const testsContext = require.context('.', true, /test$/);
-testsContext.keys().forEach(testsContext);
 
-const srcContext = require.context('.', true, /src$/);
-srcContext.keys().forEach(srcContext);
+{
+  const testsContext = require.context('./', false, /test$/);
+  testsContext.keys().forEach(testsContext);
+}
+
+{
+  const testsContext = require.context('./window', false, /test$/);
+  testsContext.keys().forEach(testsContext);
+}

packages/opentelemetry-sdk-trace-web/test/index-webpack.worker.ts

@@ -0,0 +1,18 @@
+/*
+ * Copyright The OpenTelemetry Authors
+ *
+ * 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.
+ */
+
+const testsContext = require.context('./', false, /test$/);
+testsContext.keys().forEach(testsContext);