Removed request info service into plugin

niemyjski · niemyjski · commit 9cf3afda16cd · 2021-06-22T08:28:33.000-05:00
diff --git a/packages/browser/src/BrowserExceptionlessClient.ts b/packages/browser/src/BrowserExceptionlessClient.ts
@@ -5,10 +5,10 @@ import {
 
 import { BrowserGlobalHandlerPlugin } from "./plugins/BrowserGlobalHandlerPlugin.js";
 import { BrowserLifeCyclePlugin } from "./plugins/BrowserLifeCyclePlugin.js";
-import { BrowserWrapFunctions } from "./plugins/BrowserWrapFunctions.js";
 import { BrowserModuleInfoPlugin } from "./plugins/BrowserModuleInfoPlugin.js";
+import { BrowserRequestInfoPlugin } from "./plugins/BrowserRequestInfoPlugin.js";
+import { BrowserWrapFunctions } from "./plugins/BrowserWrapFunctions.js";
 import { BrowserErrorParser } from "./services/BrowserErrorParser.js";
-import { BrowserRequestInfoCollector } from "./services/BrowserRequestInfoCollector.js";
 import { BrowserLocalStorage } from "./storage/BrowserLocalStorage.js";
 import { BrowserFetchSubmissionClient } from "./submission/BrowserFetchSubmissionClient.js";
 
@@ -18,13 +18,13 @@ export class BrowserExceptionlessClient extends ExceptionlessClient {
     if (configurationOrApiKey) {
       config.services.storage = new BrowserLocalStorage();
       config.services.errorParser = new BrowserErrorParser();
-      config.services.requestInfoCollector = new BrowserRequestInfoCollector();
       config.services.submissionClient = new BrowserFetchSubmissionClient(config);
 
       config.addPlugin(new BrowserGlobalHandlerPlugin());
       config.addPlugin(new BrowserLifeCyclePlugin());
-      config.addPlugin(new BrowserWrapFunctions());
       config.addPlugin(new BrowserModuleInfoPlugin());
+      config.addPlugin(new BrowserRequestInfoPlugin());
+      config.addPlugin(new BrowserWrapFunctions());
     }
 
     await super.startup(configurationOrApiKey);
diff --git a/packages/browser/src/index.ts b/packages/browser/src/index.ts
@@ -1,9 +1,9 @@
 export { BrowserGlobalHandlerPlugin } from "./plugins/BrowserGlobalHandlerPlugin.js";
 export { BrowserLifeCyclePlugin } from "./plugins/BrowserLifeCyclePlugin.js";
-export { BrowserWrapFunctions } from "./plugins/BrowserWrapFunctions.js";
 export { BrowserModuleInfoPlugin } from "./plugins/BrowserModuleInfoPlugin.js";
+export { BrowserRequestInfoPlugin } from "./plugins/BrowserRequestInfoPlugin.js";
+export { BrowserWrapFunctions } from "./plugins/BrowserWrapFunctions.js";
 export { BrowserErrorParser } from "./services/BrowserErrorParser.js";
-export { BrowserRequestInfoCollector } from "./services/BrowserRequestInfoCollector.js";
 export { BrowserLocalStorage } from "./storage/BrowserLocalStorage.js";
 export { BrowserFetchSubmissionClient } from "./submission/BrowserFetchSubmissionClient.js";
 export { BrowserExceptionlessClient } from "./BrowserExceptionlessClient.js";
diff --git a/packages/browser/src/plugins/BrowserRequestInfoPlugin.ts b/packages/browser/src/plugins/BrowserRequestInfoPlugin.ts
@@ -1,13 +1,34 @@
 import {
   EventPluginContext,
   getCookies,
-  IRequestInfoCollector,
+  IEventPlugin,
+  isMatch,
+  KnownEventDataKeys,
   parseQueryString,
   RequestInfo,
 } from "@exceptionless/core";
 
-export class BrowserRequestInfoCollector implements IRequestInfoCollector {
-  public getRequestInfo(context: EventPluginContext): RequestInfo {
+export class BrowserRequestInfoPlugin implements IEventPlugin {
+  public priority: number = 70;
+  public name: string = "BrowserRequestInfoPlugin";
+
+  public run(context: EventPluginContext): Promise<void> {
+    if (!context.event.data[KnownEventDataKeys.RequestInfo]) {
+      const requestInfo: RequestInfo = this.getRequestInfo(context);
+      if (requestInfo) {
+        if (isMatch(requestInfo.user_agent, context.client.config.userAgentBotPatterns)) {
+          context.log.info("Cancelling event as the request user agent matches a known bot pattern");
+          context.cancelled = true;
+        } else {
+          context.event.data[KnownEventDataKeys.RequestInfo] = requestInfo;
+        }
+      }
+    }
+
+    return Promise.resolve();
+  }
+
+  private getRequestInfo(context: EventPluginContext): RequestInfo {
     if (!document || !navigator || !location) {
       return null;
     }
diff --git a/packages/core/src/configuration/Configuration.ts b/packages/core/src/configuration/Configuration.ts
@@ -12,7 +12,6 @@ import { DefaultEventQueue } from "../queue/DefaultEventQueue.js";
 import { IEventQueue } from "../queue/IEventQueue.js";
 import { IEnvironmentInfoCollector } from "../services/IEnvironmentInfoCollector.js";
 import { IErrorParser } from "../services/IErrorParser.js";
-import { IRequestInfoCollector } from "../services/IRequestInfoCollector.js";
 import { ISubmissionClient } from "../submission/ISubmissionClient.js";
 import { guid } from "../Utils.js";
 import { KnownEventDataKeys } from "../models/Event.js";
@@ -63,7 +62,6 @@ export class Configuration {
     errorParser?: IErrorParser,
     lastReferenceIdManager: ILastReferenceIdManager,
     log: ILog,
-    requestInfoCollector?: IRequestInfoCollector,
     submissionClient?: ISubmissionClient,
     storage: IStorage,
     queue: IEventQueue
diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -32,7 +32,6 @@ export { ErrorPlugin } from "./plugins/default/ErrorPlugin.js";
 export { EventExclusionPlugin } from "./plugins/default/EventExclusionPlugin.js";
 export { HeartbeatPlugin } from "./plugins/default/HeartbeatPlugin.js";
 export { ReferenceIdPlugin } from "./plugins/default/ReferenceIdPlugin.js";
-export { RequestInfoPlugin } from "./plugins/default/RequestInfoPlugin.js";
 export { SubmissionMethodPlugin } from "./plugins/default/SubmissionMethodPlugin.js";
 export { ContextData } from "./plugins/ContextData.js";
 export { PluginContext } from "./plugins/PluginContext.js";
@@ -45,7 +44,6 @@ export type { IEventQueue } from "./queue/IEventQueue.js";
 
 export type { IEnvironmentInfoCollector } from "./services/IEnvironmentInfoCollector.js";
 export type { IErrorParser } from "./services/IErrorParser.js";
-export type { IRequestInfoCollector } from "./services/IRequestInfoCollector.js";
 
 export { InMemoryStorage } from "./storage/InMemoryStorage.js";
 export type { IStorage } from "./storage/IStorage.js";
diff --git a/packages/core/src/plugins/EventPluginManager.ts b/packages/core/src/plugins/EventPluginManager.ts
@@ -4,7 +4,6 @@ import { DuplicateCheckerPlugin } from "./default/DuplicateCheckerPlugin.js";
 import { EnvironmentInfoPlugin } from "./default/EnvironmentInfoPlugin.js";
 import { ErrorPlugin } from "./default/ErrorPlugin.js";
 import { EventExclusionPlugin } from "./default/EventExclusionPlugin.js";
-import { RequestInfoPlugin } from "./default/RequestInfoPlugin.js";
 import { SubmissionMethodPlugin } from "./default/SubmissionMethodPlugin.js";
 import { EventPluginContext } from "./EventPluginContext.js";
 import { PluginContext } from "./PluginContext.js";
@@ -62,7 +61,6 @@ export class EventPluginManager {
     config.addPlugin(new ErrorPlugin());
     config.addPlugin(new DuplicateCheckerPlugin());
     config.addPlugin(new EventExclusionPlugin());
-    config.addPlugin(new RequestInfoPlugin());
     config.addPlugin(new EnvironmentInfoPlugin());
     config.addPlugin(new SubmissionMethodPlugin());
   }
diff --git a/packages/core/src/plugins/default/RequestInfoPlugin.ts b/packages/core/src/plugins/default/RequestInfoPlugin.ts
diff --git a/packages/core/src/services/IRequestInfoCollector.ts b/packages/core/src/services/IRequestInfoCollector.ts
diff --git a/packages/node/src/NodeExceptionlessClient.ts b/packages/node/src/NodeExceptionlessClient.ts
@@ -5,10 +5,10 @@ import {
 
 import { NodeGlobalHandlerPlugin } from "./plugins/NodeGlobalHandlerPlugin.js";
 import { NodeLifeCyclePlugin } from "./plugins/NodeLifeCyclePlugin.js";
+import { NodeRequestInfoPlugin } from "./plugins/NodeRequestInfoPlugin.js";
 import { NodeWrapFunctions } from "./plugins/NodeWrapFunctions.js";
 import { NodeEnvironmentInfoCollector } from "./services/NodeEnvironmentInfoCollector.js";
 import { NodeErrorParser } from "./services/NodeErrorParser.js";
-import { NodeRequestInfoCollector } from "./services/NodeRequestInfoCollector.js";
 import { NodeFileStorage } from "./storage/NodeFileStorage.js";
 import { NodeFetchSubmissionClient } from "./submission/NodeFetchSubmissionClient.js";
 
@@ -20,11 +20,11 @@ export class NodeExceptionlessClient extends ExceptionlessClient {
       config.services.storage = new NodeFileStorage();
       config.services.environmentInfoCollector = new NodeEnvironmentInfoCollector();
       config.services.errorParser = new NodeErrorParser();
-      config.services.requestInfoCollector = new NodeRequestInfoCollector();
       config.services.submissionClient = new NodeFetchSubmissionClient(config);
 
       config.addPlugin(new NodeGlobalHandlerPlugin());
       config.addPlugin(new NodeLifeCyclePlugin());
+      config.addPlugin(new NodeRequestInfoPlugin());
       config.addPlugin(new NodeWrapFunctions());
     }
 
diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -1,9 +1,9 @@
 export { NodeGlobalHandlerPlugin } from "./plugins/NodeGlobalHandlerPlugin.js";
 export { NodeLifeCyclePlugin } from "./plugins/NodeLifeCyclePlugin.js";
+export { NodeRequestInfoPlugin } from "./plugins/NodeRequestInfoPlugin.js";
 export { NodeWrapFunctions } from "./plugins/NodeWrapFunctions.js";
 export { NodeEnvironmentInfoCollector } from "./services/NodeEnvironmentInfoCollector.js";
 export { NodeErrorParser } from "./services/NodeErrorParser.js";
-export { NodeRequestInfoCollector } from "./services/NodeRequestInfoCollector.js";
 export { NodeFileStorage } from "./storage/NodeFileStorage.js";
 export { NodeFetchSubmissionClient } from "./submission/NodeFetchSubmissionClient.js";
 export { NodeExceptionlessClient } from "./NodeExceptionlessClient.js";
diff --git a/packages/node/src/plugins/NodeRequestInfoPlugin.ts b/packages/node/src/plugins/NodeRequestInfoPlugin.ts
@@ -1,13 +1,34 @@
 import {
   EventPluginContext,
   getCookies,
-  IRequestInfoCollector,
+  IEventPlugin,
+  isMatch,
+  KnownEventDataKeys,
   RequestInfo,
   stringify,
 } from "@exceptionless/core";
 
-export class NodeRequestInfoCollector implements IRequestInfoCollector {
-  public getRequestInfo(context: EventPluginContext): RequestInfo {
+export class NodeRequestInfoPlugin implements IEventPlugin {
+  public priority: number = 70;
+  public name: string = "NodeRequestInfoPlugin";
+
+  public run(context: EventPluginContext): Promise<void> {
+    if (!context.event.data[KnownEventDataKeys.RequestInfo]) {
+      const requestInfo: RequestInfo = this.getRequestInfo(context);
+      if (requestInfo) {
+        if (isMatch(requestInfo.user_agent, context.client.config.userAgentBotPatterns)) {
+          context.log.info("Cancelling event as the request user agent matches a known bot pattern");
+          context.cancelled = true;
+        } else {
+          context.event.data[KnownEventDataKeys.RequestInfo] = requestInfo;
+        }
+      }
+    }
+
+    return Promise.resolve();
+  }
+
+  private getRequestInfo(context: EventPluginContext): RequestInfo {
     // TODO: Move this into a known keys.
     const REQUEST_KEY: string = "@request"; // optimization for minifier.
     if (!context.contextData[REQUEST_KEY]) {
