Revert "Enable async context manager by default (#539)" (#575)

t2t2 · mhennoch · web-flow · commit 5da4cf5ecb3a · 2023-05-10T11:01:31.000+03:00
Co-authored-by: mhennoch &lt;mhennoch@splunk.com&gt;
diff --git a/docs/Configuration.md b/docs/Configuration.md
@@ -18,7 +18,7 @@ Below are the different initialization options available for the Agent:
 |`debug`|`boolean`|`false`|Enables debug logging in developer console|
 |`ignoreUrls`|`(string\|regex)[]`|`[]`|Sets a list of URLs to be ignored. Any URLs that XHR/Fetch or websocket connect that match the rules will not produce a span. Two different rules can be provided: equals match to a specified string or a regex match.|
 |`cookieDomain`|`string`|`(none)`|Configures the domain used for [session tracking](Cookies.md). For example, if you have sites `foo.example.com` and `bar.example.com`, setting `cookieDomain` to `example.com` allows both sites to use the same session identifier.|
-|`context.async`|`boolean`|`true`|Enables [asyncronous context manager](Async-Traces.md)|
+|`context.async`|`boolean`|`false`|Enables [asyncronous context manager](Async-Traces.md)|
 |`exporter.onAttributesSerializing`|`(a: SpanAttributes, s?: Span) => SpanAttributes`|`(attrs) => attrs`|Provides a callback for modifying span attributes before exporting. An example use case of the serializer is to filter out PII.|
 |`instrumentations`|`object`|See the following chapter|Enables or disables specific instrumentations. More details how to enable or disable the instrumentations in the next chapter.|
 |`tracer`|`object`|[`TracerConfig`](https://github.com/open-telemetry/opentelemetry-js/blob/main/packages/opentelemetry-sdk-trace-base/src/types.ts)|Configuration options passed to WebTracerProvider. Can be used [to configure sampling](./Sampling.md)|
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/web/integration-tests/tests/context/fetch-then.ejs b/packages/web/integration-tests/tests/context/fetch-then.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>Fetch - then</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>Fetch - then</h1>
diff --git a/packages/web/integration-tests/tests/context/location-hash.ejs b/packages/web/integration-tests/tests/context/location-hash.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>location.hash</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>location.hash</h1>
diff --git a/packages/web/integration-tests/tests/context/messageport-addeventlistener.ejs b/packages/web/integration-tests/tests/context/messageport-addeventlistener.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>MessagePort - addEventListener</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>MessagePort - addEventListener</h1>
diff --git a/packages/web/integration-tests/tests/context/messageport-cors-inner.ejs b/packages/web/integration-tests/tests/context/messageport-cors-inner.ejs
@@ -4,7 +4,11 @@
 	<meta charset="UTF-8">
 	<title>Iframe</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
 	<h1>Inner frame</h1>
diff --git a/packages/web/integration-tests/tests/context/messageport-cors.ejs b/packages/web/integration-tests/tests/context/messageport-cors.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>MessagePort Iframe</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>MessagePort Iframe</h1>
diff --git a/packages/web/integration-tests/tests/context/messageport-onmessage.ejs b/packages/web/integration-tests/tests/context/messageport-onmessage.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>MessagePort - onmessage</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>MessagePort - onmessage</h1>
diff --git a/packages/web/integration-tests/tests/context/mutation-observer-textnode.ejs b/packages/web/integration-tests/tests/context/mutation-observer-textnode.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>Mutation Observer - textNode</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>Mutation Observer - textNode</h1>
diff --git a/packages/web/integration-tests/tests/context/promise.ejs b/packages/web/integration-tests/tests/context/promise.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>Promise</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>Promise</h1>
diff --git a/packages/web/integration-tests/tests/context/set-immediate.ejs b/packages/web/integration-tests/tests/context/set-immediate.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>setImmediate</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>setImmediate</h1>
diff --git a/packages/web/integration-tests/tests/context/set-timeout.ejs b/packages/web/integration-tests/tests/context/set-timeout.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>setTimeout</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>setTimeout</h1>
diff --git a/packages/web/integration-tests/tests/context/xhr-events-removed.ejs b/packages/web/integration-tests/tests/context/xhr-events-removed.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>XHR - events</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>XHR - events</h1>
diff --git a/packages/web/integration-tests/tests/context/xhr-events.ejs b/packages/web/integration-tests/tests/context/xhr-events.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>XHR - events</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>XHR - events</h1>
diff --git a/packages/web/integration-tests/tests/context/xhr-onload.ejs b/packages/web/integration-tests/tests/context/xhr-onload.ejs
@@ -4,7 +4,11 @@
   <meta charset="UTF-8">
   <title>XHR - events</title>
 
-  <%- renderAgent() %>
+  <%- renderAgent({
+    context: {
+      async: true
+    }
+  }) %>
 </head>
 <body>
   <h1>XHR - events</h1>
diff --git a/packages/web/integration-tests/tests/user-interaction/causality.ejs b/packages/web/integration-tests/tests/user-interaction/causality.ejs
@@ -3,8 +3,12 @@
 <head>
 	<meta charset="UTF-8">
 	<title>Mouse events test</title>
-  <%- renderAgent() %>
-  
+  <!-- Webvitals has an extra click event listener that confuses the tests -->
+  <%- renderAgent({
+    instrumentations: {
+      webvitals: false
+    }
+  }) %>
 </head>
 <body>
   <h1>Mouse events test</h1>
diff --git a/packages/web/package.json b/packages/web/package.json
@@ -79,7 +79,7 @@
     "browserstack-local": "^1.4.8",
     "chai": "^4.3.4",
     "chrome-launcher": "^0.15.1",
-    "chromedriver": "^111.0.0",
+    "chromedriver": "^112.0.0",
     "codecov": "^3.8.2",
     "compression": "^1.7.4",
     "cors": "^2.8.5",
diff --git a/packages/web/src/SplunkContextManager.ts b/packages/web/src/SplunkContextManager.ts
@@ -46,11 +46,10 @@ export class SplunkContextManager implements ContextManager {
 
   protected _hashChangeContext: Context = null;
 
-  protected _config: ContextManagerConfig;
   // eslint-disable-next-line no-useless-constructor
-  constructor(config: ContextManagerConfig = {}) {
-    this._config = Object.assign({ async: true }, config);
-  }
+  constructor(
+    protected _config: ContextManagerConfig = {}
+  ) {}
 
   /**
    *
