Merge pull request #130 from justeat/internal-changes

Bring internal changes to public origin

.github/workflows/pull-request-workflow.yml

@@ -5,32 +5,14 @@ jobs:
     runs-on: macOS-latest
     timeout-minutes: 15
     steps:
-    - name: Cancel previous jobs
-      uses: styfle/[email protected]
-      with:
-        access_token: ${{ github.token }}
     - name: Git checkout
       uses: actions/[email protected]
       with:
-        fetch-depth: 0
         ref: ${{ github.ref }}
     - name: Setup Xcode
       uses: maxim-lobanov/setup-xcode@v1
       with:
         xcode-version: latest-stable
-    - name: Setup ruby and bundler dependencies
-      uses: ruby/[email protected]
-      with:
-        bundler-cache: true
-    - name: Run pod install
-      run: |
-        set -eo pipefail
-        export LIB_VERSION=$(git describe --tags `git rev-list --tags --max-count=1`)
-        bundle exec pod install --project-directory=Example
     - name: Run tests
-      run: bundle exec fastlane unit_tests device:'iPhone 11'
-    - name: Validate lib
-      run: |
-        set -eo pipefail
-        export LIB_VERSION=$(git describe --tags `git rev-list --tags --max-count=1`)
-        bundle exec pod lib lint --allow-warnings
+      run: swift test
+

.gitignore

@@ -53,3 +53,4 @@ default.profraw
 fastlane/test_output/
 fastlane/report.xml
 derived_data/
+.build/

Example/JustLog.xcodeproj/xcshareddata/xcschemes/JustLog-Example.xcscheme

@@ -15,7 +15,7 @@
             <BuildableReference
                BuildableIdentifier = "primary"
                BlueprintIdentifier = "607FACCF1AFB9204008FA782"
-               BuildableName = "JustLog_Example.app"
+               BuildableName = "JustLog.app"
                BlueprintName = "JustLog_Example"
                ReferencedContainer = "container:JustLog.xcodeproj">
             </BuildableReference>
@@ -46,7 +46,7 @@
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "607FACCF1AFB9204008FA782"
-            BuildableName = "JustLog_Example.app"
+            BuildableName = "JustLog.app"
             BlueprintName = "JustLog_Example"
             ReferencedContainer = "container:JustLog.xcodeproj">
          </BuildableReference>
@@ -85,7 +85,7 @@
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "607FACCF1AFB9204008FA782"
-            BuildableName = "JustLog_Example.app"
+            BuildableName = "JustLog.app"
             BlueprintName = "JustLog_Example"
             ReferencedContainer = "container:JustLog.xcodeproj">
          </BuildableReference>
@@ -102,7 +102,7 @@
          <BuildableReference
             BuildableIdentifier = "primary"
             BlueprintIdentifier = "607FACCF1AFB9204008FA782"
-            BuildableName = "JustLog_Example.app"
+            BuildableName = "JustLog.app"
             BlueprintName = "JustLog_Example"
             ReferencedContainer = "container:JustLog.xcodeproj">
          </BuildableReference>

Example/JustLog.xcworkspace/xcshareddata/swiftpm/Package.resolved

@@ -0,0 +1,14 @@
+{
+  "pins" : [
+    {
+      "identity" : "swiftybeaver",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/SwiftyBeaver/SwiftyBeaver",
+      "state" : {
+        "revision" : "12b5acf96d98f91d50de447369bd18df74600f1a",
+        "version" : "1.9.6"
+      }
+    }
+  ],
+  "version" : 2
+}

Example/JustLog/AppDelegate.swift

@@ -37,6 +37,8 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
         forceSendLogs(application)
     }
 
+    private var logger: Logger!
+
     func redactValues(message: String, loggerExeptionList: [ExceptionListResponse], matches: [NSTextCheckingResult]) -> String {
 
         var redactedLogMessage = message
@@ -81,51 +83,47 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
             identifier = UIBackgroundTaskIdentifier.invalid
         })
 
-        Logger.shared.forceSend { completionHandler in
+        logger.forceSend { completionHandler in
             application.endBackgroundTask(identifier)
             identifier = UIBackgroundTaskIdentifier.invalid
         }
     }
 
     private func setupLogger() {
-        let logger = Logger.shared
         let decoder = JSONDecoder()
-
-        // custom keys
-        logger.logTypeKey = "logtype"
-        logger.appVersionKey = "app_version"
-        logger.iosVersionKey = "ios_version"
-        logger.deviceTypeKey = "ios_device"
-
-        // file destination
-        logger.logFilename = "justeat-demo.log"
-
-        // logstash destination
-        logger.logstashHost = "listener.logz.io"
-        logger.logstashPort = 5052
-        logger.logstashTimeout = 5
-        logger.logLogstashSocketActivity = true
-
-
-         let regexRuleList = "[{\"pattern\": \"(name) = \\\\\\\\*\\\"(.*?[^\\\\\\\\]+)\", \"minimumLogLevel\": \"warning\"}, {\"pattern\": \"(token) = \\\\\\\\*\\\"(.*?[^\\\\\\\\]+)\", \"minimumLogLevel\": \"warning\"}]".data(using: .utf8)
-         let sanitizationExeceptionList = "[{\"value\": \"Dan Jones\"}, {\"value\": \"Jack Jones\"}]".data(using: .utf8)
-
+
+        let configuration = Configuration(
+            logFilename: "justeat-demo.log",
+            logstashHost: "listener.logz.io",
+            logstashPort: 5052,
+            logstashTimeout: 5,
+            logLogstashSocketActivity: true
+        )
+
+        logger = Logger(
+            configuration: configuration,
+            logMessageFormatter: JSONStringLogMessageFormatter(keys: FormatterKeys())
+        )
+
+        let regexRuleList = "[{\"pattern\": \"(name) = \\\\\\\\*\\\"(.*?[^\\\\\\\\]+)\", \"minimumLogLevel\": \"warning\"}, {\"pattern\": \"(token) = \\\\\\\\*\\\"(.*?[^\\\\\\\\]+)\", \"minimumLogLevel\": \"warning\"}]".data(using: .utf8)
+        let sanitizationExeceptionList = "[{\"value\": \"Dan Jones\"}, {\"value\": \"Jack Jones\"}]".data(using: .utf8)
+
         logger.sanitize = { message, type in
             var sanitizedMessage = message
-            
+
             guard let ruleList = try? decoder.decode([RegexListReponse].self, from: regexRuleList!) else { return "sanitizedMessage" }
             guard let exceptionList = try? decoder.decode([ExceptionListResponse].self, from: sanitizationExeceptionList!) else { return "sanitizedMessage" }
-
-                for value in ruleList {
-                    if (value.minimumLogLevel >= type.rawValue) {
-                        if let regex = try? NSRegularExpression(pattern: value.pattern , options: NSRegularExpression.Options.caseInsensitive) {
-
-                            let range = NSRange(sanitizedMessage.startIndex..<sanitizedMessage.endIndex, in: sanitizedMessage)
-                            let matches = regex.matches(in: sanitizedMessage, options: [], range: range)
-
-                            sanitizedMessage = self.redactValues(message: sanitizedMessage, loggerExeptionList: exceptionList, matches: matches)
-                        }
+
+            for value in ruleList {
+                if (value.minimumLogLevel >= type.rawValue) {
+                    if let regex = try? NSRegularExpression(pattern: value.pattern , options: NSRegularExpression.Options.caseInsensitive) {
+
+                        let range = NSRange(sanitizedMessage.startIndex..<sanitizedMessage.endIndex, in: sanitizedMessage)
+                        let matches = regex.matches(in: sanitizedMessage, options: [], range: range)
+
+                        sanitizedMessage = self.redactValues(message: sanitizedMessage, loggerExeptionList: exceptionList, matches: matches)
                     }
+                }
             }
             return sanitizedMessage
         }
@@ -135,12 +133,6 @@ class AppDelegate: UIResponder, UIApplicationDelegate {
 
         // untrusted (self-signed) logstash server support
         //logger.allowUntrustedServer = <Bool>
-
-        // default info
-        logger.defaultUserInfo = ["application": "JustLog iOS Demo",
-                                  "environment": "development",
-                                  "session": sessionID]
-        logger.setup()
     }
 
 

Example/JustLog/ViewController.swift

@@ -12,31 +12,41 @@ import JustLog
 class ViewController: UIViewController {
 
     private var logNumber = 0
-
+
+    private var logger: Logger = Logger(
+        configuration: Configuration(),
+        logMessageFormatter: JSONStringLogMessageFormatter(keys: FormatterKeys())
+    )
+
     @IBAction func verbose() {
-        Logger.shared.verbose("[\(logNumber)] not so important", userInfo: ["userInfo key": "userInfo value"])
+        let log = Log(type: .verbose, message: "[\(logNumber)] not so important", customData: ["userInfo key": "userInfo value"])
+        logger.send(log)
         logNumber += 1
     }
 
     @IBAction func debug() {
-        Logger.shared.debug("[\(logNumber)] something to debug", userInfo: ["userInfo key": "userInfo value"])
+        let log = Log(type: .debug, message: "[\(logNumber)] not so debug", customData: ["userInfo key": "userInfo value"])
+        logger.send(log)
         logNumber += 1
     }
 
     @IBAction func info() {
-        Logger.shared.info("[\(logNumber)] a nice information", userInfo: ["userInfo key": "userInfo value"])
+        let log = Log(type: .info, message: "[\(logNumber)] a nice information", customData: ["userInfo key": "userInfo value"])
+        logger.send(log)
         logNumber += 1
     }
 
     @IBAction func warning() {
-        Logger.shared.warning("[\(logNumber)] oh no, that won’t be good", userInfo: ["userInfo key": "userInfo value"])
+        let log = Log(type: .warning, message: "[\(logNumber)] oh no, that won’t be good", customData: ["userInfo key": "userInfo value"])
+        logger.send(log)
         logNumber += 1
     }
 
     @IBAction func warningSanitized() {
         let messageToSanitize = "conversation ={\\n id = \\\"123455\\\";\\n};\\n from = {\\n id = 123456;\\n name = \\\"John Smith\\\";\\n; \\n token = \\\"123456\\\";\\n"
-        let sanitizedMessage = Logger.shared.sanitize(messageToSanitize, Logger.LogType.warning)
-        Logger.shared.warning(sanitizedMessage, userInfo: ["userInfo key": "userInfo value"])
+        let sanitizedMessage = logger.sanitize(messageToSanitize, LogType.warning)
+        let log = Log(type: .warning, message: sanitizedMessage, customData: ["userInfo key": "userInfo value"])
+        logger.send(log)
         logNumber += 1
     }
 
@@ -57,16 +67,17 @@ class ViewController: UIViewController {
 
         let unreadableError = NSError(domain: "com.just-eat.test", code: 1234, userInfo: unreadableUserInfos)
 
-        Logger.shared.error("[\(logNumber)] ouch, an error did occur!", error: unreadableError, userInfo: ["userInfo key": "userInfo value"])
+        let log = Log(type: .error, message: "[\(logNumber)] ouch, an error did occur!", error: unreadableError, customData: ["userInfo key": "userInfo value"])
+        logger.send(log)
         logNumber += 1
     }
 
     @IBAction func forceSend() {
-        Logger.shared.forceSend()
+        logger.forceSend()
     }
 
     @IBAction func cancel(_ sender: Any) {
-        Logger.shared.cancelSending()
+        logger.cancelSending()
     }
 }