lightstep-tracer - npm Package Compare versions

Comparing version 0.24.0 to 0.24.1

CHANGELOG.md

@@ -6,2 +6,9 @@ # CHANGELOG
 ## vNext
+
+## 0.24.1
+* Guard session storage access
+* update type of collector_encryption
+* Fix propagator typo
+* Update typing on inclusion/exclusion patterns to match docs
+
 ## 0.24.0
@@ -8,0 +15,0 @@ * Adds DataDog header support (#187)

index.d.ts

@@ -5,10 +5,10 @@
   import * as opentracing from 'opentracing';
-  
+
   export interface TracerOptions {
     /** the project access token. Access tokens are used by the LightStep tracer client libraries to identify the project the tracer is reporting for */
     access_token: string
-  
+
     /** the string identifier for the application, service, or process. A Component is a logical service (or client) in a distributed system. The component usually represents a particular process or script in the distributed system */
     component_name: string
-  
+
     /**
@@ -26,6 +26,6 @@ * controls the level of logging to the console
     verbosity?: number
-  
+
     /** custom collector hostname */
     collector_host?: string
-  
+
     /** custom collector port */
@@ -36,3 +36,3 @@ collector_port?: number
     collector_path?: string
-    
+
     /** optional, default='tls'
@@ -42,3 +42,3 @@ * `tls` - use HTTPS encrypted connections
     */
-    collector_encryption?: string     
+    collector_encryption?: "tls" | "none"
 
@@ -121,3 +121,3 @@ /**
     instrument_page_load?: boolean
-    
+
     /**
@@ -133,3 +133,3 @@ * optional. browser-only. if enabled, automatically instruments all XHR requests with context headers.
      */
-    xhr_url_inclusion_patterns?: any
+    xhr_url_inclusion_patterns?: RegExp[]
 
@@ -140,4 +140,4 @@ /**
      */
-    xhr_url_exclusion_patterns?: any
-    
+    xhr_url_exclusion_patterns?: RegExp[]
+
     /**
@@ -153,3 +153,3 @@ * optional. browser-only. if enabled, automatically instrument all window.fetch requests with context.headers.
      */
-    fetch_url_inclusion_patterns?: any
+    fetch_url_inclusion_patterns?: RegExp[]
 
@@ -160,3 +160,3 @@ /**
      */
-    fetch_url_exclusion_patterns?: any
+    fetch_url_exclusion_patterns?: RegExp[]
 
@@ -174,3 +174,3 @@ /**
      */
-    nodejs_inclusion_patterns?: any
+    nodejs_inclusion_patterns?: RegExp[]
 
@@ -182,3 +182,3 @@ /**
      */
-    nodejs_exclusion_patterns?: any
+    nodejs_exclusion_patterns?: RegExp[]
 
@@ -185,0 +185,0 @@ /**

lib/imp/platform/browser/platform_browser.js

@@ -125,3 +125,12 @@ 'use strict';
         value: function localStoreGet(key) {
-            if (!window.sessionStorage) {
+            try {
+                if (!window.sessionStorage) {
+                    return null;
+                }
+            } catch (_ignored) {
+                // Accessing `sessionStorage` or `localStorage` in an `<iframe>` in Chrome throws when
+                // the user setting "block third-party cookies and site data" is turned on.
+                //
+                // eslint-disable-next-line max-len
+                // https://www.chromium.org/for-testers/bug-reporting-guidelines/uncaught-securityerror-failed-to-read-the-localstorage-property-from-window-access-is-denied-for-this-document
                 return null;
@@ -138,3 +147,8 @@ }
         value: function localStoreSet(key, value) {
-            if (!window.sessionStorage) {
+            try {
+                if (!window.sessionStorage) {
+                    return;
+                }
+            } catch (_ignored) {
+                // (See comment above)
                 return;
@@ -141,0 +155,0 @@ }

lib/imp/propagator_dd.js

@@ -29,5 +29,5 @@ 'use strict';
 
-var DDProgagator = function () {
-    function DDProgagator(tracer) {
-        _classCallCheck(this, DDProgagator);
+var DDPropagator = function () {
+    function DDPropagator(tracer) {
+        _classCallCheck(this, DDPropagator);
 
@@ -39,3 +39,3 @@ this._tracer = tracer;
 
-    _createClass(DDProgagator, [{
+    _createClass(DDPropagator, [{
         key: 'inject',
@@ -137,8 +137,8 @@ value: function inject(spanContext, carrier) {
 
-    return DDProgagator;
+    return DDPropagator;
 }();
 
-exports.default = DDProgagator;
+exports.default = DDPropagator;
 module.exports = exports.default;
 
 //# sourceMappingURL=propagator_dd.js.map

package.json

 {
   "name": "lightstep-tracer",
-  "version": "0.24.0",
+  "version": "0.24.1",
   "main": "index.js",
@@ -5,0 +5,0 @@ "types": "index.d.ts",

README.md

@@ -124,3 +124,3 @@ # lightstep-tracer
 * `disable_meta_event_reporting` `bool` *optional*, *default=false* - when `disable_meta_event_reporting` is set to `true`, the tracer will disable meta event reporting even if requested by the Satellite.
-* `propagator` `dictionary` *optional*, *defaults=*`{opentracing.FORMAT_HTTP: LightStepPropagator, opentracing.FORMAT_TEXT_MAP: LightStepPropagator, opentracing.FORMAT_BINARY: UnsupportedPropagator}`: Allows inject/extract to use custom propagators for different formats. This package includes a `B3Propagator` that supports B3 headers on text maps and http headers. `DDPropagator` supports DataDog trace headers.
+* `propagator` `dictionary` *optional*, *defaults=*`{opentracing.FORMAT_HTTP_HEADERS: LightStepPropagator, opentracing.FORMAT_TEXT_MAP: LightStepPropagator, opentracing.FORMAT_BINARY: UnsupportedPropagator}`: Allows inject/extract to use custom propagators for different formats. This package includes a `B3Propagator` that supports B3 headers on text maps and http headers. `DDPropagator` supports DataDog trace headers.
 
@@ -127,0 +127,0 @@ ### SpanImp

src/imp/platform/browser/platform_browser.js

@@ -118,3 +118,12 @@ const optionsParser = require('./options_parser.js');
     localStoreGet(key) {
-        if (!window.sessionStorage) {
+        try {
+            if (!window.sessionStorage) {
+                return null;
+            }
+        } catch (_ignored) {
+            // Accessing `sessionStorage` or `localStorage` in an `<iframe>` in Chrome throws when
+            // the user setting "block third-party cookies and site data" is turned on.
+            //
+            // eslint-disable-next-line max-len
+            // https://www.chromium.org/for-testers/bug-reporting-guidelines/uncaught-securityerror-failed-to-read-the-localstorage-property-from-window-access-is-denied-for-this-document
             return null;
@@ -130,3 +139,8 @@ }
     localStoreSet(key, value) {
-        if (!window.sessionStorage) {
+        try {
+            if (!window.sessionStorage) {
+                return;
+            }
+        } catch (_ignored) {
+            // (See comment above)
             return;
@@ -133,0 +147,0 @@ }

src/imp/propagator_dd.js

@@ -7,3 +7,3 @@ import _each from '../_each';
 
-export default class DDProgagator {
+export default class DDPropagator {
     constructor(tracer) {
@@ -10,0 +10,0 @@ this._tracer = tracer;

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

5089898

increased by0.08%

Lines of code

67445

increased by0.06%

No dependency changes