Refactor @bugsnag/plugin-client-ip (#2260)

* refactor @bugsnag/plugin-client-ip

* fix rollup config

* update with internal client

* update extended plugin interface

* fix value type to unknown

Author: AnastasiiaSvietlova

packages/plugin-client-ip/client-ip.js

@@ -1,7 +1,15 @@
 {
   "name": "@bugsnag/plugin-client-ip",
   "version": "8.1.1",
-  "main": "client-ip.js",
+  "main": "dist/client-ip.js",
+  "types": "dist/types/client-ip.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/types/client-ip.d.ts",
+      "default": "./dist/client-ip.js",
+      "import": "./dist/client-ip.mjs"
+    }
+  },
   "description": "@bugsnag/js plugin to disable client IP from error reports",
   "homepage": "https://www.bugsnag.com/",
   "repository": {
@@ -12,7 +20,7 @@
     "access": "public"
   },
   "files": [
-    "*.js"
+    "dist"
   ],
   "author": "Bugsnag",
   "license": "MIT",
@@ -21,5 +29,10 @@
   },
   "peerDependencies": {
     "@bugsnag/core": "^8.0.0"
+  },
+  "scripts": {
+    "build": "npm run build:npm",
+    "build:npm": "rollup --config rollup.config.npm.mjs",
+    "clean": "rm -rf dist/*"
   }
 }

packages/plugin-client-ip/package.json

@@ -0,0 +1,6 @@
+import createRollupConfig from "../../.rollup/index.mjs";
+
+export default createRollupConfig({
+  input: "src/client-ip.ts",
+  external: ["@bugsnag/core/lib/es-utils/assign"]
+});

packages/plugin-client-ip/rollup.config.npm.mjs

@@ -0,0 +1,46 @@
+import { Client, Plugin } from 'packages/core/types'
+import assign from '@bugsnag/core/lib/es-utils/assign'
+
+interface InternalClient extends Client {
+  _config: {
+    collectUserIp: boolean
+  }
+}
+
+interface ExtendedPlugin extends Plugin {
+  configSchema: Record<string, ValidationOption>
+}
+
+interface ValidationOption {
+  validate: (value: unknown) => boolean
+  defaultValue: () => unknown
+  message: string
+}
+
+/*
+ * Prevent collection of user IPs
+ */
+const plugin: ExtendedPlugin = {
+  load: client => {
+    if ((client as InternalClient)._config.collectUserIp) return
+
+    client.addOnError(event => {
+      // If user.id is explicitly undefined, it will be missing from the payload. It needs
+      // removing so that the following line replaces it
+      if (event.getUser() && typeof event.getUser().id === 'undefined') {
+        const _user = event.getUser()
+        event.setUser('[REDACTED]', _user.email, _user.name)
+      }
+      event.request = assign({ clientIp: '[REDACTED]' }, event.request)
+    })
+  },
+  configSchema: {
+    collectUserIp: {
+      defaultValue: () => true,
+      message: 'should be true|false',
+      validate: (value: unknown) => value === true || value === false
+    }
+  }
+}
+
+export default plugin

packages/plugin-client-ip/src/client-ip.ts

@@ -0,0 +1,4 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*.ts"]
+}

packages/plugin-client-ip/tsconfig.json

@@ -74,7 +74,6 @@
     "packages/plugin-koa",
     "packages/plugin-restify",
     "packages/node",
-    "packages/plugin-client-ip",
     "packages/plugin-strip-query-string",
     "packages/plugin-strip-project-root",
     "packages/plugin-interaction-breadcrumbs",