Re-enabling SwiftLint plugin

.swiftlint.yml

@@ -3,6 +3,7 @@ disabled_rules: # rule identifiers turned on by default to exclude from running
   - function_parameter_count
   - notification_center_detachment
   - compiler_protocol_init
+  - for_where
 
 opt_in_rules:
   - conditional_returns_on_newline

Package.resolved

@@ -153,6 +153,15 @@
         "version" : "1.3.1"
       }
     },
+    {
+      "identity" : "swiftlintplugins",
+      "kind" : "remoteSourceControl",
+      "location" : "https://github.com/SimplyDanny/SwiftLintPlugins",
+      "state" : {
+        "revision" : "7a3d77f3dd9f91d5cea138e52c20cfceabf352de",
+        "version" : "0.58.2"
+      }
+    },
     {
       "identity" : "thrift-swift",
       "kind" : "remoteSourceControl",

Package.swift

@@ -292,3 +292,15 @@ let package = Package(
         )
     ]
 )
+
+if ProcessInfo.processInfo.environment["EMBRACE_ENABLE_SWIFTLINT"] != nil {
+  package.dependencies.append(contentsOf: [
+    .package(url: "https://github.com/SimplyDanny/SwiftLintPlugins", from: "0.58.2")
+  ])
+
+  for target in package.targets {
+    target.plugins = [
+      .plugin(name: "SwiftLintBuildToolPlugin", package: "SwiftLintPlugins"),
+    ]
+  }
+}

README.md

@@ -175,6 +175,12 @@ swiftlint --fix
 
 ### Using SwiftLint
 
+The SwiftLint Xcode plugin can be optionally enabled during development by using an environmental variable when opening the project from the commandline. 
+```
+EMBRACE_ENABLE_SWIFTLINT=1 open Package.swift
+```
+Note: Xcode must be completely closed before running the above command, close Xcode using `⌘Q` or running `killall xcode` in the commandline. 
+
 Aside from the warnings and errors that will appear directly in Xcode, you can use SwiftLint to automatically correct some issues.
 For this first you'll need to install SwiftLint in your local environment. Follow [SwiftLint's GitHub page](https://github.com/realm/SwiftLint) to see all available options.
 

Sources/EmbraceCommonInternal/Models/EmbraceStackTrace.swift

@@ -80,4 +80,3 @@ public struct EmbraceStackTrace: Equatable {
         return frame.range(of: pattern, options: .regularExpression) != nil
     }
 }
-

Sources/EmbraceCore/Capture/CaptureServices.swift

@@ -19,7 +19,12 @@ final class CaptureServices {
 
     weak var config: EmbraceConfigurable?
 
-    init(options: Embrace.Options, config: EmbraceConfigurable?, storage: EmbraceStorage?, upload: EmbraceUpload?) throws {
+    init(
+        options: Embrace.Options,
+        config: EmbraceConfigurable?,
+        storage: EmbraceStorage?,
+        upload: EmbraceUpload?
+    ) throws {
         self.config = config
 
         // add required capture services

Sources/EmbraceCore/Capture/Network/URLSessionCaptureService+Options.swift

@@ -19,7 +19,11 @@ extension URLSessionCaptureService {
         /// Any request's url that contains any of these strings will not be captured.
         @objc public let ignoredURLs: [String]
 
-        @objc public init(injectTracingHeader: Bool, requestsDataSource: URLSessionRequestsDataSource?, ignoredURLs: [String]) {
+        @objc public init(
+            injectTracingHeader: Bool,
+            requestsDataSource: URLSessionRequestsDataSource?,
+            ignoredURLs: [String]
+        ) {
             self.injectTracingHeader = injectTracingHeader
             self.requestsDataSource = requestsDataSource
             self.ignoredURLs = ignoredURLs

Sources/EmbraceCore/Capture/UX/Tap/TapCaptureService.swift

@@ -134,7 +134,7 @@ class UIWindowSendEventSwizzler: Swizzlable {
     var onEvent: ((UIEvent) -> Void)?
 
     func install() throws {
-        try swizzleInstanceMethod { originalImplementation in { [weak self] uiWindow, uiEvent -> Void in
+        try swizzleInstanceMethod { originalImplementation in { [weak self] uiWindow, uiEvent in
                 self?.onEvent?(uiEvent)
                 originalImplementation(uiWindow, UIWindowSendEventSwizzler.selector, uiEvent)
             }

Sources/EmbraceCore/Capture/UX/View/UIViewControllerHandler.swift

@@ -108,7 +108,6 @@ class UIViewControllerHandler {
         queue.async {
             // generate parent span
 
-
             let spanName = nameFormat.replacingOccurrences(of: "NAME", with: className)
 
             let parentSpan = self.createSpan(

Sources/EmbraceCore/Capture/WebView/WKWebView+Embrace.swift

@@ -14,7 +14,8 @@ extension WKWebView {
 
     var emb_proxy: EMBWKNavigationDelegateProxy? {
         get {
-            if let value = objc_getAssociatedObject(self, &AssociatedKeys.embraceProxy) as? EMBWKNavigationDelegateProxy {
+            if let value = objc_getAssociatedObject(self, &AssociatedKeys.embraceProxy)
+                as? EMBWKNavigationDelegateProxy {
                 return value as EMBWKNavigationDelegateProxy
             }
 

Sources/EmbraceCore/Internal/Embrace+Config.swift

@@ -39,6 +39,11 @@ extension Embrace {
             return DefaultConfig()
         }
 
+        let cacheLocation = EmbraceFileSystem.configDirectoryURL(
+            partitionIdentifier: appId,
+            appGroupId: options.appGroupId
+        )
+
         let options = RemoteConfig.Options(
             apiBaseUrl: configBaseURL,
             queue: DispatchQueue(label: "com.embrace.config"),
@@ -48,7 +53,7 @@ extension Embrace {
             sdkVersion: EmbraceMeta.sdkVersion,
             appVersion: EMBDevice.operatingSystemVersion,
             userAgent: EmbraceMeta.userAgent,
-            cacheLocation: EmbraceFileSystem.configDirectoryURL(partitionIdentifier: appId, appGroupId: options.appGroupId)
+            cacheLocation: cacheLocation
         )
 
         return RemoteConfig(

Sources/EmbraceCore/Internal/Tracing/StorageSpanExporter.swift

@@ -48,7 +48,6 @@ class StorageSpanExporter: SpanExporter {
     }
 
     public func flush(explicitTimeout: TimeInterval?) -> SpanExporterResultCode {
-        // TODO: do we need to make sure storage writes are finished?
         return .success
     }
 

Sources/EmbraceCore/Options/Embrace+Endpoints.swift

@@ -17,7 +17,7 @@ extension Embrace {
         @objc public let configBaseURL: String
 
         @available(*, deprecated, message: "Development base URL is not used anymore.")
-        @objc public let developmentBaseURL: String = ""
+        @objc public let developmentBaseURL: String = "" // TODO: Remove in next major version
 
         /// Initializer that allows for custom endpoints.
         /// - Note: If you wish to use the default endpoints please refer to the convenience initializer: `init(appId: String)`.
@@ -37,6 +37,7 @@ extension Embrace {
         ///   - configBaseURL: Endpoint to fetch the remote config
         @available(*, deprecated, message: "Use `init(baseURL:configBaseURL)` instead.")
         @objc public init(baseURL: String, developmentBaseURL: String, configBaseURL: String) {
+            // TODO: Remove in next major version
             self.baseURL = baseURL
             self.configBaseURL = configBaseURL
         }

Sources/EmbraceCore/Public/Metadata/MetadataRecordTmp.swift

@@ -80,7 +80,15 @@ extension MetadataRecordTmp {
         dateAttribute.name = "collectedAt"
         dateAttribute.attributeType = .dateAttributeType
 
-        entity.properties = [keyAttribute, valueAttribute, typeAttribute, lifespanAttribute, lifespanIdAttribute, dateAttribute]
+        entity.properties = [
+            keyAttribute,
+            valueAttribute,
+            typeAttribute,
+            lifespanAttribute,
+            lifespanIdAttribute,
+            dateAttribute
+        ]
+
         return entity
     }
 }

Sources/EmbraceStorageInternal/EmbraceStorageError.swift

@@ -7,7 +7,6 @@ import GRDB
 
 public enum EmbraceStorageError: Error, Equatable {
     case cannotUpsertSpan(spanName: String, message: String)
-    // TODO: Add missing errors in here
 }
 
 extension EmbraceStorageError: LocalizedError, CustomNSError {

Sources/EmbraceStorageInternal/Queries/SpanRecord+SessionQuery.swift

@@ -28,7 +28,7 @@ extension SpanRecord {
 
         } else {
             return SpanRecord.filter(
-                matchingSessionId(session.id) || 
+                matchingSessionId(session.id) ||
                 overlappingStart(startTime: session.startTime) ||
                 entirelyWithin(startTime: session.startTime, endTime: sessionEndTime) ||
                 overlappingEnd(endTime: sessionEndTime) ||

Sources/EmbraceUploadInternal/EmbraceUpload.swift

@@ -64,25 +64,28 @@ public class EmbraceUpload: EmbraceLogUploader {
     /// Attempts to upload all the available cached data.
     public func retryCachedData() {
         queue.async { [weak self] in
-            guard let self = self else { return }
+            guard let strongSelf = self else {
+                return
+            }
+
             do {
                 // in place mechanism to not retry sending cache data at the same time
-                guard !self.isRetryingCache else {
+                guard !strongSelf.isRetryingCache else {
                     return
                 }
 
-                self.isRetryingCache = true
+                strongSelf.isRetryingCache = true
 
                 defer {
                     // on finishing everything, allow to retry cache (i.e. reconnection)
-                    self.isRetryingCache = false
+                    strongSelf.isRetryingCache = false
                 }
 
                 // clear data from cache that shouldn't be retried as it's stale
-                self.clearCacheFromStaleData()
+                strongSelf.clearCacheFromStaleData()
 
                 // get all the data cached first, is the only thing that could throw
-                let cachedObjects = try self.cache.fetchAllUploadData()
+                let cachedObjects = try strongSelf.cache.fetchAllUploadData()
 
                 // create a sempahore to allow only to send two request at a time so we don't
                 // get throttled by the backend on cases where cache has many failed requests.
@@ -91,19 +94,19 @@ public class EmbraceUpload: EmbraceLogUploader {
                     guard let type = EmbraceUploadType(rawValue: uploadData.type) else {
                         continue
                     }
-                    self.semaphore.wait()
+                    strongSelf.semaphore.wait()
 
-                    self.reUploadData(
+                    strongSelf.reUploadData(
                         id: uploadData.id,
                         data: uploadData.data,
                         type: type,
                         attemptCount: uploadData.attemptCount
                     ) {
-                        self.semaphore.signal()
+                        strongSelf.semaphore.signal()
                     }
                 }
             } catch {
-                self.logger.debug("Error retrying cached upload data: \(error.localizedDescription)")
+                strongSelf.logger.debug("Error retrying cached upload data: \(error.localizedDescription)")
             }
         }
     }

Sources/EmbraceUploadInternal/Options/EmbraceUpload+ExponentialBackoff.swift

@@ -14,7 +14,9 @@ public extension EmbraceUpload {
             maxDelay: Double = 32.0
         ) {
             self.baseDelay = baseDelay
-            self.maxDelay = max(maxDelay, baseDelay) // prevent somebody from adding a baseDelay larger than the maxDelay
+
+            // prevent somebody from adding a baseDelay larger than the maxDelay
+            self.maxDelay = max(maxDelay, baseDelay)
         }
 
         /// Calculates the exponential backoff delay based on the given `retryNumber`.