Deprecate addError functions (#447)

In PR #446 we removed the `addError` helper and renamed it `setError`
without leaving in place a placeholder function for `addError` that
prints a deprecation warning. Without this placeholder function users
could run into an error when calling a function that does not exist.

I've readded the `addError` function and made it print a deprecation
warning. I've updated the `setError` function to print the same
deprecation warning.

The types package has been updated to include the `addError` function
again on the Span interface.

Author: tombruijn

package-lock.json

@@ -12,7 +12,7 @@
     "packages/*"
   ],
   "devDependencies": {
-    "@appsignal/types": "^2.1.2",
+    "@appsignal/types": "^2.1.3",
     "@types/jest": "^26.0.19",
     "husky": "^4.3.6",
     "jest": "^26.6.3",

package.json

@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.2",
+    "@appsignal/types": "^2.1.3",
     "apollo-server-plugin-base": "^0.10.3",
     "tslib": "^2.0.3"
   },

packages/apollo-server/package.json

@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.2",
+    "@appsignal/types": "^2.1.3",
     "tslib": "^2.0.3"
   },
   "peerDependencies": {

packages/express/package.json

@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.2",
+    "@appsignal/types": "^2.1.3",
     "shimmer": "^1.2.1",
     "tslib": "^2.0.3"
   },

packages/koa/package.json

@@ -5,7 +5,7 @@
   "types": "dist/index",
   "license": "MIT",
   "dependencies": {
-    "@appsignal/types": "^2.1.2",
+    "@appsignal/types": "^2.1.3",
     "tslib": "^2.0.3"
   },
   "peerDependencies": {

packages/nextjs/package.json

@@ -0,0 +1,5 @@
+---
+bump: "patch"
+---
+
+Deprecate the addError function on the Span interface. Instead use the Tracer's `setError` function to set the error on the root span.

packages/nodejs/.changesets/deprecate-adderror-function.md

@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "@appsignal/core": "^1.1.4",
-    "@appsignal/types": "^2.1.2",
+    "@appsignal/types": "^2.1.3",
     "require-in-the-middle": "^5.1.0",
     "semver": "^7.3.4",
     "shimmer": "^1.2.1",

packages/nodejs/package.json

@@ -17,6 +17,13 @@ export class NoopSpan implements NodeSpan {
     return new NoopSpan()
   }
 
+  public addError(error: Error): this {
+    console.warn(
+      "DEPRECATED: Please use the `tracer.setError` helper instead to set the error on the root span."
+    )
+    return this
+  }
+
   public setError(error: Error): this {
     return this
   }

packages/nodejs/src/noops/span.ts

@@ -143,12 +143,30 @@ export class BaseSpan implements NodeSpan {
     return this
   }
 
+  /**
+   * Add a given `Error` object to the current `Span`.
+   * Use `tracer.setError()` instead.
+   *
+   * @deprecated since Node.js version 2.1.0
+   */
+  public addError(error: Error): this {
+    console.warn(
+      "DEPRECATED: Please use the `tracer.setError` helper instead to set the error on the root span."
+    )
+
+    return this
+  }
+
   /**
    * Set a given `Error` object to the current `Span`.
-   * Use tracer.setError() instead.
+   * Use `tracer.setError()` instead.
+   *
+   * @deprecated since Node.js version 2.1.0
    */
   public setError(error: Error): this {
-    console.warn("setError() can only be called from a RootSpan object")
+    console.warn(
+      "DEPRECATED: Please use the `tracer.setError` helper instead to set the error on the root span."
+    )
 
     return this
   }