Merge pull request #23 from valen90/feature/report-only-if-in-notifyR…

…eleaseStages

Only report when current stage is in notifyReleaseStages

Sources/Bugsnag/Configuration.swift

@@ -4,7 +4,7 @@ import HTTP
 
 public protocol ConfigurationType {
     var apiKey: String { get }
-    var notifyReleaseStages: [String] { get }
+    var notifyReleaseStages: [String]? { get }
     var endpoint: String { get }
     var filters: [String] { get }
 
@@ -28,7 +28,7 @@ public struct Configuration: ConfigurationType {
     }
 
     public let apiKey: String
-    public let notifyReleaseStages: [String]
+    public let notifyReleaseStages: [String]?
     public let endpoint: String
     public let filters: [String]
 

Sources/Bugsnag/PayloadTransformer.swift

@@ -3,6 +3,9 @@ import Stacked
 import HTTP
 
 public protocol PayloadTransformerType {
+    var environment: Environment { get }
+    var apiKey: String { get }
+
     func payloadFor(
         message: String,
         metadata: Node?,
@@ -13,14 +16,9 @@ public protocol PayloadTransformerType {
 }
 
 internal struct PayloadTransformer: PayloadTransformerType {
-    let drop: Droplet
-    let config: ConfigurationType
+    let environment: Environment
+    let apiKey: String
 
-    init(drop: Droplet, config: ConfigurationType) {
-        self.drop = drop
-        self.config = config
-    }
-
     internal func payloadFor(
         message: String,
         metadata: Node?,
@@ -48,7 +46,7 @@ internal struct PayloadTransformer: PayloadTransformerType {
         ])
 
         let app: Node = Node([
-            "releaseStage": Node(drop.environment.description),
+            "releaseStage": Node(environment.description),
             "type": "Vapor"
         ])
 
@@ -91,7 +89,7 @@ internal struct PayloadTransformer: PayloadTransformerType {
         ])
 
         return try JSON(node: [
-            "apiKey": self.config.apiKey,
+            "apiKey": apiKey,
             "notifier": Node([
                 "name": "Bugsnag Vapor",
                 "version": "1.0.11",

Sources/Bugsnag/Reporter.swift

@@ -38,8 +38,8 @@ public final class Reporter: ReporterType {
             config: config
         )
         self.payloadTransformer = transformer ?? PayloadTransformer(
-            drop: drop,
-            config: config
+            environment: drop.environment,
+            apiKey: config.apiKey
         )
     }
 
@@ -54,7 +54,10 @@ public final class Reporter: ReporterType {
         completion complete: (() -> ())?
     ) throws {
         if let error = error as? AbortError {
-            guard error.metadata?["report"]?.bool ?? true else {
+            guard
+                error.metadata?["report"]?.bool ?? true,
+                shouldNotifyForReleaseStage()
+            else {
                 return
             }
             try self.report(
@@ -100,4 +103,11 @@ public final class Reporter: ReporterType {
             if let complete = complete { complete() }
         }
     }
+
+    private func shouldNotifyForReleaseStage() -> Bool {
+        guard let notifyReleaseStages = config.notifyReleaseStages else {
+            return true
+        }
+        return notifyReleaseStages.contains(drop.environment.description)
+    }
 }

Tests/BugsnagTests/Mocks/ConfigurationMock.swift

@@ -3,10 +3,15 @@ import Bugsnag
 
 internal class ConfigurationMock: ConfigurationType {
     let apiKey = "1337"
-    let notifyReleaseStages: [String] = []
+    let notifyReleaseStages: [String]?
     let endpoint = "some-endpoint"
     let filters: [String] = ["someFilter"]
 
-    required init(drop: Droplet) throws {}
-    init() {}
+    required convenience init(drop: Droplet) throws {
+        self.init()
+    }
+
+    init(releaseStages: [String]? = ["mock-environment"]) {
+        notifyReleaseStages = releaseStages
+    }
 }

Tests/BugsnagTests/Mocks/PayloadTransformerMock.swift

@@ -3,14 +3,14 @@ import Bugsnag
 import HTTP
 
 internal class PayloadTransformerMock: PayloadTransformerType {
-    let drop: Droplet
-    let config: ConfigurationType
-    var lastPayloadData: (message: String, metadata: Node?, request: Request?, severity: Severity, filters: [String])? = nil
+    let environment: Environment
+    let apiKey: String
 
+    var lastPayloadData: (message: String, metadata: Node?, request: Request?, severity: Severity, filters: [String])? = nil
 
-    required init(drop: Droplet, config: ConfigurationType) {
-        self.drop = drop
-        self.config = config
+    init(environment: Environment, apiKey: String) {
+        self.environment = environment
+        self.apiKey = apiKey
     }
 
     internal func payloadFor(

Tests/BugsnagTests/PayloadTransformerTests.swift

@@ -22,16 +22,7 @@ class PayloadTransformerTests: XCTestCase {
     ]
 
     override func setUp() {
-        let drop = Droplet(
-            arguments: nil,
-            workDir: nil,
-            environment: Environment.custom("mock-environment"),
-            config: nil,
-            localization: nil,
-            log: nil
-        )
-        let config = ConfigurationMock()
-        self.payloadTransformer = PayloadTransformer(drop: drop, config: config)
+        self.payloadTransformer = PayloadTransformer(environment: .custom("mock-environment"), apiKey: "1337")
         let req = try! Request(method: .get, uri: "http://some-random-url.com/payload-test")
         req.parameters = ["url": "value"]
         req.query = ["query": "value"]

Tests/BugsnagTests/ReporterTests.swift

@@ -17,15 +17,28 @@ class ReporterTests: XCTestCase {
         ("testThatThePayloadGetsSubmitted", testThatThePayloadGetsSubmitted),
         ("testThatFiltersComeFromConfig", testThatFiltersComeFromConfig),
         ("testSeverityGetsDefaultValue", testSeverityGetsDefaultValue),
-        ("testSeverityGetsGivenValue", testSeverityGetsGivenValue)
+        ("testSeverityGetsGivenValue", testSeverityGetsGivenValue),
+        ("testErrorNotReportedWhenEnvironmentNotInNotifyReleaseStages", testErrorNotReportedWhenEnvironmentNotInNotifyReleaseStages),
+        ("testErrorReportedWhenEnvironmentInNotifyReleaseStages", testErrorReportedWhenEnvironmentInNotifyReleaseStages),
+        ("testErrorNotBeingReportedWhenEmptyReleaseStages", testErrorNotBeingReportedWhenEmptyReleaseStages),
+        ("testErrorBeingReportedWhenNilReleaseStages", testErrorBeingReportedWhenNilReleaseStages)
     ]
 
-
     override func setUp() {
-        let drop = Droplet()
+        let drop = Droplet(
+            arguments: nil,
+            workDir: nil,
+            environment: .custom("mock-environment"),
+            config: nil,
+            localization: nil,
+            log: nil
+        )
         let config = ConfigurationMock()
         self.connectionManager = ConnectionManagerMock(drop: drop, config: config)
-        self.payloadTransformer = PayloadTransformerMock(drop: drop, config: config)
+        self.payloadTransformer = PayloadTransformerMock(
+            environment: drop.environment,
+            apiKey: "1337"
+        )
         self.reporter = Reporter(
             drop: drop,
             config: config,
@@ -167,7 +180,6 @@ class ReporterTests: XCTestCase {
         waitForExpectations(timeout: 1)
     }
 
-
     func testThatFiltersComeFromConfig() {
         let req = try! Request(method: .get, uri: "some-random-uri")
 
@@ -192,6 +204,90 @@ class ReporterTests: XCTestCase {
         XCTAssertEqual(self.payloadTransformer.lastPayloadData?.3, Severity.info)
     }
 
+    func testErrorNotReportedWhenEnvironmentNotInNotifyReleaseStages() {
+        let drop = Droplet(
+            arguments: nil,
+            workDir: nil,
+            environment: .development, //currentEnvironment = "development"
+            config: nil,
+            localization: nil,
+            log: nil
+        )
+        let conf = ConfigurationMock() //notifyReleaseStages = ["mock-environment"]
+        let repo = Reporter(
+            drop: drop,
+            config: conf,
+            connectionManager: self.connectionManager,
+            transformer: self.payloadTransformer
+        )
+        try! repo.report(error: Abort.badRequest, request: nil)
+        XCTAssertNil(self.payloadTransformer.lastPayloadData)
+
+    }
+
+    func testErrorReportedWhenEnvironmentInNotifyReleaseStages() {
+        let drop = Droplet(
+            arguments: nil,
+            workDir: nil,
+            environment: .custom("mock-environment"), //currentEnvironment = "mock-environment"
+            config: nil,
+            localization: nil,
+            log: nil
+        )
+        let conf = ConfigurationMock() //notifyReleaseStages = ["mock-environment"]
+        let repo = Reporter(
+            drop: drop,
+            config: conf,
+            connectionManager: self.connectionManager,
+            transformer: self.payloadTransformer
+        )
+        try! repo.report(error: Abort.badRequest, request: nil)
+        XCTAssertNotNil(self.payloadTransformer.lastPayloadData)
+
+    }
+
+    func testErrorNotBeingReportedWhenEmptyReleaseStages() {
+        let drop = Droplet(
+            arguments: nil,
+            workDir: nil,
+            environment: .custom("mock-environment"), //currentEnvironment = "mock-environment"
+            config: nil,
+            localization: nil,
+            log: nil
+        )
+        let conf = ConfigurationMock(releaseStages: []) //notifyReleaseStages = []
+        let repo = Reporter(
+            drop: drop,
+            config: conf,
+            connectionManager: self.connectionManager,
+            transformer: self.payloadTransformer
+        )
+        try! repo.report(error: Abort.badRequest, request: nil)
+        XCTAssertNil(self.payloadTransformer.lastPayloadData)
+
+    }
+
+    func testErrorBeingReportedWhenNilReleaseStages() {
+        let drop = Droplet(
+            arguments: nil,
+            workDir: nil,
+            environment: .custom("mock-environment"), //currentEnvironment = "mock-environment"
+            config: nil,
+            localization: nil,
+            log: nil
+        )
+        let conf = ConfigurationMock(releaseStages: nil) //notifyReleaseStages = nil
+        let repo = Reporter(
+            drop: drop,
+            config: conf,
+            connectionManager: self.connectionManager,
+            transformer: self.payloadTransformer
+        )
+        try! repo.report(error: Abort.badRequest, request: nil)
+        XCTAssertNotNil(self.payloadTransformer.lastPayloadData)
+
+    }
+
     // MARK: - Submission
 
     func testThatThePayloadGetsSubmitted() {