Rename addError helpers to setError

In order to comply with AppSignal naming rules, we rename the addError helper to setError
appsignal · Sep 23, 2021 · 723b98d · 723b98d
1 parent 590f190
commit 723b98d
Show file tree

Hide file tree

Showing 21 changed files with 66 additions and 66 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -12,7 +12,7 @@
     "packages/*"
   ],
   "devDependencies": {
-    "@appsignal/types": "^2.1.1",
+    "@appsignal/types": "^2.1.2",
     "@types/jest": "^26.0.19",
     "husky": "^4.3.6",
     "jest": "^26.6.3",

diff --git a/packages/apollo-server/package.json b/packages/apollo-server/package.json
@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.1",
+    "@appsignal/types": "^2.1.2",
     "apollo-server-plugin-base": "^0.10.3",
     "tslib": "^2.0.3"
   },

diff --git a/packages/apollo-server/src/index.ts b/packages/apollo-server/src/index.ts
@@ -25,7 +25,7 @@ export const createApolloPlugin = (appsignal: NodeClient, _options = {}) => {
 
           return {
             executionDidEnd: err => {
-              if (err) tracer.addError(err)
+              if (err) tracer.setError(err)
               execSpan.close()
             }
           }
@@ -34,7 +34,7 @@ export const createApolloPlugin = (appsignal: NodeClient, _options = {}) => {
           const parseSpan = rootSpan.child().setCategory("parse.graphql")
 
           return err => {
-            if (err) tracer.addError(err)
+            if (err) tracer.setError(err)
             parseSpan.close()
           }
         },
@@ -43,7 +43,7 @@ export const createApolloPlugin = (appsignal: NodeClient, _options = {}) => {
 
           return err => {
             // take only the first error
-            if (err) tracer.addError(err[0])
+            if (err) tracer.setError(err[0])
             validateSpan.close()
           }
         }

diff --git a/packages/express/package.json b/packages/express/package.json
@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.1",
+    "@appsignal/types": "^2.1.2",
     "tslib": "^2.0.3"
   },
   "peerDependencies": {

diff --git a/packages/express/src/middleware/index.ts b/packages/express/src/middleware/index.ts
@@ -76,7 +76,7 @@ export function expressErrorHandler(
     // if there's no `status` property, forward the error
     // we also ignore client errors here
     if (err && (!err.status || (err.status && err.status >= 500))) {
-      tracer.addError(err)
+      tracer.setError(err)
     }
 
     return next(err)

diff --git a/packages/koa/README.md b/packages/koa/README.md
@@ -44,9 +44,7 @@ const Router = require("@koa/router"); // @koa/router is also supported out of t
 app.on("error", (error) => {
   appsignal
     .tracer()
-    .currentSpan()
-    .addError(error)
-    .close()
+    .setError(error)
 });
 
 const app = new Koa();

diff --git a/packages/koa/package.json b/packages/koa/package.json
@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.1",
+    "@appsignal/types": "^2.1.2",
     "shimmer": "^1.2.1",
     "tslib": "^2.0.3"
   },

diff --git a/packages/nextjs/package.json b/packages/nextjs/package.json
@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.1",
+    "@appsignal/types": "^2.1.2",
     "tslib": "^2.0.3"
   },
   "peerDependencies": {

diff --git a/packages/nodejs/.changesets/add-root-span-and-add-error-helpers.md b/packages/nodejs/.changesets/add-root-span-and-add-error-helpers.md
@@ -2,9 +2,9 @@
 bump: "minor"
 ---
 
-Add rootSpan and addError helpers.
+Add rootSpan and setError helpers.
 
 Errors added to child spans are ignored by the agent. Now the rootSpan is
-always accessible from the tracer object as well as addError. The addError
+always accessible from the tracer object as well as setError. The setError
 function allows to track errors on demand and they will be always attached
 to the main current span, so they don't get ignored by the agent.
diff --git a/packages/nodejs/package.json b/packages/nodejs/package.json
@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@appsignal/core": "^1.1.4",
-    "@appsignal/types": "^2.1.1",
+    "@appsignal/types": "^2.1.2",
     "require-in-the-middle": "^5.1.0",
     "semver": "^7.3.4",
     "shimmer": "^1.2.1",

diff --git a/packages/nodejs/src/demo.ts b/packages/nodejs/src/demo.ts
@@ -30,14 +30,12 @@ export function demo(tracer: Tracer) {
 
   // error sample
   tracer.withSpan(tracer.createSpan(), span => {
-    span
-      .setName("GET /demo")
-      .setCategory("process_request.http")
-      .addError(
-        new Error(
-          "Hello world! This is an error used for demonstration purposes."
-        )
+    tracer.setError(
+      new Error(
+        "Hello world! This is an error used for demonstration purposes."
       )
-      .close()
+    )
+
+    span.setName("GET /demo").setCategory("process_request.http").close()
   })
 }
diff --git a/packages/nodejs/src/instrumentation/http/lifecycle/outgoing.ts b/packages/nodejs/src/instrumentation/http/lifecycle/outgoing.ts
@@ -109,7 +109,8 @@ function outgoingRequestFunction(
       try {
         req = original.apply(this, [urlOrOptions, ...args])
       } catch (err) {
-        span.addError(err).close()
+        tracer.setError(err)
+        span.close()
         throw err
       }
 
@@ -128,7 +129,8 @@ function outgoingRequestFunction(
       })
 
       req.on("error", (error: Error) => {
-        span.addError(error).close()
+        tracer.setError(error)
+        span.close()
       })
 
       return req

diff --git a/packages/nodejs/src/instrumentation/pg/index.ts b/packages/nodejs/src/instrumentation/pg/index.ts
@@ -61,7 +61,7 @@ export const instrument = (
           if (returned instanceof EventEmitter) {
             tracer.wrapEmitter(returned)
           } else if (typeof returned.then === "function") {
-            returned = patchPromise(span, returned)
+            returned = patchPromise(tracer, span, returned)
           }
         }
 

diff --git a/packages/nodejs/src/instrumentation/pg/patches/index.ts b/packages/nodejs/src/instrumentation/pg/patches/index.ts
@@ -13,7 +13,7 @@ export function patchCallback(
   callback: Function
 ) {
   return tracer.wrap((err: Error | null, res?) => {
-    if (err) span.addError(err)
+    if (err) tracer.setError(err)
     span.close()
     return callback(err, res)
   })
@@ -31,7 +31,8 @@ export function patchSubmittable(
       return tracer.wrap(function (this: Submittable, ...args: any[]): void {
         if (!spanEnded) {
           const err: Error = args[0]
-          span.addError(err).close()
+          tracer.setError(err)
+          span.close()
           spanEnded = true
         }
 
@@ -60,14 +61,19 @@ export function patchSubmittable(
   return submittable
 }
 
-export function patchPromise<T>(span: NodeSpan, promise: Promise<T>) {
+export function patchPromise<T>(
+  tracer: Tracer,
+  span: NodeSpan,
+  promise: Promise<T>
+) {
   return promise.then(
     res => {
       span.close()
       return res
     },
     err => {
-      span.addError(err).close()
+      tracer.setError(err)
+      span.close()
       throw err
     }
   )

diff --git a/packages/nodejs/src/instrumentation/redis/index.ts b/packages/nodejs/src/instrumentation/redis/index.ts
@@ -12,7 +12,7 @@ type RedisCallback = <T>(err: Error | null, reply: T) => void
 function wrapCallback(tracer: Tracer, span: NodeSpan, done: RedisCallback) {
   // @TODO: add results to span here?
   const fn = function <T>(err: Error | null, res: T) {
-    if (err) span.addError(err)
+    if (err) tracer.setError(err)
 
     span.close()
 

diff --git a/packages/nodejs/src/noops/span.ts b/packages/nodejs/src/noops/span.ts
@@ -17,7 +17,7 @@ export class NoopSpan implements NodeSpan {
     return new NoopSpan()
   }
 
-  public addError(error: Error): this {
+  public setError(error: Error): this {
     return this
   }
 

diff --git a/packages/nodejs/src/noops/tracer.ts b/packages/nodejs/src/noops/tracer.ts
@@ -25,7 +25,7 @@ export class NoopTracer implements Tracer {
     return new NoopSpan()
   }
 
-  public addError(error: Error): NodeSpan {
+  public setError(error: Error): NodeSpan {
     return new NoopSpan()
   }
 

diff --git a/packages/nodejs/src/scope.ts b/packages/nodejs/src/scope.ts
@@ -50,6 +50,7 @@ export class ScopeManager {
 
         if (this.#scopes.get(currentId)) {
           this.#scopes.set(id, this.#scopes.get(currentId))
+          this.#roots.set(id, this.#roots.get(currentId))
         }
       } else {
         /**
@@ -62,6 +63,7 @@ export class ScopeManager {
          */
         if (this.#scopes.get(triggerId)) {
           this.#scopes.set(id, this.#scopes.get(triggerId))
+          this.#roots.set(id, this.#roots.get(triggerId))
         }
       }
     }
@@ -137,7 +139,7 @@ export class ScopeManager {
     try {
       return fn(span)
     } catch (err) {
-      rootSpan?.addError(err)
+      rootSpan?.setError(err)
       throw err
     } finally {
       // revert to the previous span
@@ -146,6 +148,7 @@ export class ScopeManager {
         this.#roots.delete(uid)
       } else {
         this.#scopes.set(uid, oldScope)
+        this.#roots.set(uid, rootSpan)
       }
     }
   }