Rename matchBacktracePaths option

Rename the `matchPath` config option to a more explicit
`matchBacktracePaths`.

Author: unflxw

packages/javascript/.changesets/custom-backtrace-sanitization.md

@@ -5,15 +5,15 @@ type: add
 
 Allow custom backtrace sanitization.
 
-> **Warning:** This is an advanced feature meant for specific use cases. For most use cases, you should not need this functionality. If in doubt, leave `matchPath` unset.
+> **Warning:** This is an advanced feature meant for specific use cases. For most use cases, you should not need this functionality. If in doubt, leave `matchBacktracePaths` unset.
 > 
-> **Using `matchPath` will cause public sourcemap detection to fail.** If using `matchPath`, use our private sourcemap API to upload sourcemaps to AppSignal.
+> **Using `matchBacktracePaths` will cause public sourcemap detection to fail.** If using `matchBacktracePaths`, use our private sourcemap API to upload sourcemaps to AppSignal.
 
 Some applications, such as those running on Electron or React Native environments, emit backtrace lines containing paths relative to the device in which the application is running.
 
 The unpredictability of these backtrace line paths interferes with the correct functioning of backtrace error grouping, and makes it impossible to upload sourcemaps for these files using our private sourcemap API, as it is not possible to know the expected path beforehand.
 
-You can set the `matchPath` configuration to a list of one or more regexes, which will be used to attempt to match the relevant section of the backtrace line path.
+You can set the `matchBacktracePaths` configuration to a list of one or more regexes, which will be used to attempt to match the relevant section of the backtrace line path.
 
 For example, suppose you have an Electron application, which your users install at unpredictable locations. Your backtrace line paths may look something like this, with the username changing for each installation:
 
@@ -25,13 +25,13 @@ To ignore these parts of the path that are not predictable, you can configure Ap
 
 ```js
 const appsignal = new AppSignal({
-  matchPath: [
+  matchBacktracePaths: [
     new RegExp("CoolBeans\\.app/Contents/Resources/(.*)$")
   ]
 })
 ```
 
-If set, the `matchPath` configuration option must contain a regular expression, or an array of one or more regular expressions, which attempt to match the whole backtrace line path. These regular expressions must have one or more match groups, such as `(.*)` in the example above, which attempt to match against the relevant segments of the backtrace line path.
+If set, the `matchBacktracePaths` configuration option must contain a regular expression, or an array of one or more regular expressions, which attempt to match the whole backtrace line path. These regular expressions must have one or more match groups, such as `(.*)` in the example above, which attempt to match against the relevant segments of the backtrace line path.
 
 AppSignal will attempt to match the whole backtrace line path against these regular expressions in order. If any of the regular expression matches and produces a match group, AppSignal will replace the path in the backtrace line with the matched segment.
 

packages/javascript/src/__tests__/index.test.ts

@@ -79,11 +79,11 @@ describe("Appsignal", () => {
       console.warn = original
     })
 
-    it("cleans the backtrace path if `matchPath` is set", () => {
+    it("cleans the backtrace path if `matchBacktracePaths` is set", () => {
       appsignal = new Appsignal({
         key: "TESTKEY",
         namespace: "test",
-        matchPath: [/here(.*)/]
+        matchBacktracePaths: [/here(.*)/]
       })
 
       const error = new Error("test error")

packages/javascript/src/index.ts

@@ -207,8 +207,8 @@ export default class Appsignal implements JSClient {
       compose(...this._hooks.overrides)(span)
     }
 
-    if (this._options.matchPath) {
-      span.cleanBacktracePath(this._options.matchPath)
+    if (this._options.matchBacktracePaths) {
+      span.cleanBacktracePath(this._options.matchBacktracePaths)
     }
 
     if (Environment.supportsPromises()) {

packages/javascript/src/interfaces/options.ts

@@ -7,7 +7,7 @@ export interface AppsignalOptions extends BaseOptions {
   namespace?: string
   revision?: string
   ignoreErrors?: RegExp[]
-  matchPath?: RegExp | RegExp[]
+  matchBacktracePaths?: RegExp | RegExp[]
 }
 
 export interface PushApiOptions extends BaseOptions {

packages/javascript/src/span.ts

@@ -71,14 +71,14 @@ export class Span extends Serializable<JSSpanData> {
   }
 
   // @private
-  // Do not use this function directly. Instead, set the `matchPath`
+  // Do not use this function directly. Instead, set the `matchBacktracePaths`
   // configuration option when initializing AppSignal.
-  public cleanBacktracePath(matchPath: RegExp | RegExp[]): this {
-    if (matchPath instanceof RegExp) {
-      matchPath = [matchPath]
+  public cleanBacktracePath(matchBacktracePaths: RegExp | RegExp[]): this {
+    if (matchBacktracePaths instanceof RegExp) {
+      matchBacktracePaths = [matchBacktracePaths]
     }
 
-    if (!Array.isArray(matchPath)) {
+    if (!Array.isArray(matchBacktracePaths)) {
       return this
     }
 
@@ -92,7 +92,7 @@ export class Span extends Serializable<JSSpanData> {
         return line
       }
 
-      for (const matcher of matchPath as RegExp[]) {
+      for (const matcher of matchBacktracePaths as RegExp[]) {
         if (!(matcher instanceof RegExp)) {
           continue
         }