chore: replace swift-log with oslog (#850)

Author: VladislavFitz

.github/workflows/tests.yml

@@ -1,27 +1,35 @@
 name: Tests
-
-on: [push]
-
+on:
+  push:
+    branches:
+      - master
+  pull_request:
 jobs:
-  test:
-    runs-on: macos-12
+  build:
+    name: Swift ${{ matrix.swift }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
     env:
       ALGOLIA_APPLICATION_ID_1: ${{ secrets.ALGOLIA_APPLICATION_ID_1 }}
       ALGOLIA_ADMIN_KEY_1: ${{ secrets.ALGOLIA_ADMIN_KEY_1 }}
       ALGOLIA_SEARCH_KEY_1: ${{ secrets.ALGOLIA_SEARCH_KEY_1 }}
       ALGOLIA_APPLICATION_ID_2: ${{ secrets.ALGOLIA_APPLICATION_ID_2 }}
       ALGOLIA_ADMIN_KEY_2: ${{ secrets.ALGOLIA_ADMIN_KEY_2 }}
-      ALGOLIA_PLACES_APPLICATION_ID: ${{ secrets.ALGOLIA_PLACES_APPLICATION_ID }}
-      ALGOLIA_PLACES_API_KEY: ${{ secrets.ALGOLIA_PLACES_API_KEY }}
       ALGOLIA_APPLICATION_ID_MCM: ${{ secrets.ALGOLIA_APPLICATION_ID_MCM }}
       ALGOLIA_ADMIN_KEY_MCM: ${{ secrets.ALGOLIA_ADMIN_KEY_MCM }}
-      ALGOLIA_ANSWERS_APPLICATION_ID: ${{ secrets.ALGOLIA_ANSWERS_APPLICATION_ID }}
-      ALGOLIA_ANSWERS_API_KEY: ${{ secrets.ALGOLIA_ANSWERS_API_KEY }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, macos-latest]
+        swift: ["5.8"]
+
     steps:
-      - uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4
-      - name: Select Xcode version
-        run: sudo xcode-select -s '/Applications/Xcode_13.4.app/Contents/Developer'
-      - name: Build project
-        run: swift build
-      - name: Run tests
-        run: swift test
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - uses: swift-actions/setup-swift@v1
+        with:
+          swift-version: ${{ matrix.swift }}
+
+      - name: Build and test
+        run: |
+          swift build
+          swift test --enable-test-discovery

AlgoliaSearchClient.podspec

@@ -7,9 +7,8 @@ Pod::Spec.new do |spec|
   spec.license      = { :type => "MIT", :file => "LICENSE" }
   spec.author       = { 'Algolia' => '[email protected]'  }
   spec.documentation_url = "https://www.algolia.com/doc/api-client/getting-started/what-is-the-api-client/swift/"
-  spec.platforms = { :ios => "9.0", :osx => "10.10", :watchos => "2.0", :tvos => "9.0" }
+  spec.platforms = { :ios => "14.0", :osx => "11.0", :watchos => "7.0", :tvos => "14.0" }
   spec.swift_version = "5.1"
   spec.source = { :git => "https://github.com/algolia/algoliasearch-client-swift.git", :tag => spec.version }
   spec.source_files  = "Sources/AlgoliaSearchClient/**/*.swift"
-  spec.dependency 'Logging'
 end

Cartfile

@@ -1 +1 @@
-github "apple/swift-log" ~> 1.4
+

Dockerfile

@@ -1,11 +1,14 @@
-# You can set the Swift version to what you need for your app. 
-# Versions can be found here: https://hub.docker.com/_/swift
-FROM swift as builder
+# Use an official Swift runtime as a parent image
+FROM swift:latest
 
-WORKDIR /app
+# Set the working directory in the container
+WORKDIR /usr/src/app
 
-COPY ./Package.* ./
+# Copy the current directory contents into the container at /usr/src/app
+COPY . .
 
+# Download Swift package dependencies
 RUN swift package resolve
 
-COPY . .
+# Command to run tests
+CMD ["swift", "test", "--enable-test-discovery"]

Package.swift

@@ -1,25 +1,27 @@
-// swift-tools-version:5.1
+// swift-tools-version:5.8
 // The swift-tools-version declares the minimum version of Swift required to build this package.
 
 import PackageDescription
 
 #if os(Linux)
 let macOSVersion: SupportedPlatform.MacOSVersion = .v10_15
 #else
-let macOSVersion: SupportedPlatform.MacOSVersion = .v10_10
+let macOSVersion: SupportedPlatform.MacOSVersion = .v11
 #endif
 
 #if os(Linux)
 let extraPackageDependencies: [Package.Dependency] = [
-  .package(url: "https://github.com/apple/swift-crypto.git", from: "1.1.2")
+  .package(url: "https://github.com/apple/swift-crypto.git", from: "1.1.2"),
+  .package(url: "https://github.com/apple/swift-log.git", from: "1.5.4")
 ]
 #else
 let extraPackageDependencies: [Package.Dependency] = []
 #endif
 
 #if os(Linux)
 let extraTargetDependencies: [Target.Dependency] = [
-  .product(name: "Crypto", package: "swift-crypto")
+  .product(name: "Crypto", package: "swift-crypto"),
+  .product(name: "Logging", package: "swift-log")
 ]
 #else
 let extraTargetDependencies: [Target.Dependency] = []
@@ -28,30 +30,27 @@ let extraTargetDependencies: [Target.Dependency] = []
 let package = Package(
   name: "AlgoliaSearchClient",
   platforms: [
-    .iOS(.v9),
+    .iOS(.v14),
     .macOS(macOSVersion),
-    .watchOS(.v2),
-    .tvOS(.v9)
+    .watchOS(.v7),
+    .tvOS(.v14)
   ],
   products: [
     .library(
       name: "AlgoliaSearchClient",
       targets: ["AlgoliaSearchClient"])
   ],
   dependencies: [
-    .package(url: "https://github.com/apple/swift-log.git", from: "1.4.0")
   ] + extraPackageDependencies,
   targets: [
     .target(
       name: "AlgoliaSearchClient",
       dependencies: [
-        .product(name: "Logging", package: "swift-log")
       ] + extraTargetDependencies),
     .testTarget(
       name: "AlgoliaSearchClientTests",
       dependencies: [
-        .target(name: "AlgoliaSearchClient"),
-        .product(name: "Logging", package: "swift-log")
+        .target(name: "AlgoliaSearchClient")
       ] + extraTargetDependencies)
   ]
 )

Sources/AlgoliaSearchClient/Helpers/Logging.swift

@@ -6,19 +6,27 @@
 //
 
 import Foundation
+#if os(Linux)
 import Logging
-
 typealias SwiftLog = Logging.Logger
+#else
+import OSLog
+typealias SwiftLog = os.Logger
+#endif
 
 public struct Logger {
 
   static var loggingService: Loggable = {
-    var swiftLog = SwiftLog(label: "com.algolia.searchClientSwift")
-    print("Algolia Search Client Swift: Default minimal log severity level is info. Change Logger.minLogServerityLevel value if you want to change it.")
-    swiftLog.logLevel = .info
-    return swiftLog
+    var logger: Loggable
+    #if os(Linux)
+    logger = SwiftLog(label: "com.algolia.searchClientSwift")
+    #else
+    logger = SwiftLog(subsystem: "com.algolia", category: "searchClientSwift")
+    #endif
+    return logger
   }()
 
+  @available(*, deprecated, message: "minSeverityLevel is deprecated")
   public static var minSeverityLevel: LogLevel {
     get {
       return loggingService.minSeverityLevel
@@ -79,6 +87,7 @@ extension Logger {
 
 }
 
+#if os(Linux)
 extension LogLevel {
 
   init(swiftLogLevel: SwiftLog.Level) {
@@ -107,27 +116,81 @@ extension LogLevel {
 
 }
 
-protocol Loggable {
+extension SwiftLog: Loggable {
 
-  var minSeverityLevel: LogLevel { get set }
+  var minSeverityLevel: LogLevel {
+    get {
+      return LogLevel(swiftLogLevel: logLevel)
+    }
+    set {
+      self.logLevel = newValue.swiftLogLevel
+    }
+  }
 
-  func log(level: LogLevel, message: String)
+  func log(level: LogLevel, message: String) {
+    self.log(level: level.swiftLogLevel, SwiftLog.Message(stringLiteral: message), metadata: .none)
+  }
+
+}
+
+#else
+
+extension LogLevel {
+
+  init(_ type: OSLogType) {
+    switch type {
+    case .debug:
+      self = .debug
+    case .info:
+      self = .info
+    case .error:
+      self = .error
+    case .fault:
+      self = .critical
+    default:
+      self = .info
+    }
+  }
+
+  var type: OSLogType {
+    switch self {
+    case .trace: return .info
+    case .debug: return .debug
+    case .info: return .info
+    case .notice: return .info
+    case .warning: return .info
+    case .error: return .error
+    case .critical: return .fault
+    }
+  }
 
 }
 
 extension SwiftLog: Loggable {
 
   var minSeverityLevel: LogLevel {
     get {
-      return LogLevel(swiftLogLevel: logLevel)
+      .init(.default)
     }
+    // swiftlint:disable:next unused_setter_value
     set {
-      self.logLevel = newValue.swiftLogLevel
+      log(level: .info, "minSeverityLevel is deprecated")
     }
   }
 
   func log(level: LogLevel, message: String) {
-    self.log(level: level.swiftLogLevel, SwiftLog.Message(stringLiteral: message), metadata: .none)
+    log(level: level.type, "\(message)")
   }
 
 }
+
+#endif
+
+protocol Loggable {
+
+  @available(*, deprecated, message: "minSeverityLevel is deprecated")
+  var minSeverityLevel: LogLevel { get set }
+
+  func log(level: LogLevel, message: String)
+
+}

Sources/AlgoliaSearchClient/Models/Common/RequestOptions.swift

@@ -108,7 +108,7 @@ extension HTTPHeaderKey {
   static let algoliaUserID: HTTPHeaderKey = "X-Algolia-User-ID"
   static let forwardedFor: HTTPHeaderKey = "X-Forwarded-For"
   static let applicationID: HTTPHeaderKey = "X-Algolia-Application-Id"
-  static let apiKey: HTTPHeaderKey = "X-Algolia-API-Key"
+  static let apiKey: HTTPHeaderKey = "X-Algolia-Api-Key"
   static let userAgent: HTTPHeaderKey = "User-Agent"
 
 }

Tests/AlgoliaSearchClientTests/Helper/XCTest+Codable.swift

@@ -81,3 +81,41 @@ func AssertEquallyEncoded<A: Encodable, B: Encodable>(_ l: A, _ r: B, file: Stat
   try XCTAssertEqual(decoder.decode(JSON.self, from: lData), decoder.decode(JSON.self, from: rData))
 }
 
+func AssertJSONEqual(_ data1: Data?,
+                     _ data2: Data?,
+                     message: String = "JSON objects are not equal",
+                     file: StaticString = #file,
+                     line: UInt = #line) {
+  guard let data1, let data2 else {
+    XCTAssertEqual(data1,
+                   data2,
+                   file: file,
+                   line: line)
+    return
+  }
+  
+  do {
+    let json1 = try JSONSerialization.jsonObject(with: data1, options: [])
+    let json2 = try JSONSerialization.jsonObject(with: data2, options: [])
+    
+    // Convert NSDictionary to [AnyHashable: Any]
+    if let dict1 = json1 as? [AnyHashable: Any], let dict2 = json2 as? [AnyHashable: Any] {
+      if NSDictionary(dictionary: dict1).isEqual(to: dict2) {
+        // JSON objects are equal
+      } else {
+        XCTFail(message, file: file, line: line)
+      }
+    } else if let array1 = json1 as? [Any], let array2 = json2 as? [Any] {
+      if NSArray(array: array1).isEqual(to: array2) {
+        // JSON objects (arrays) are equal
+      } else {
+          XCTFail(message, file: file, line: line)
+      }
+    } else {
+      XCTFail("JSON objects are not dictionaries", file: file, line: line)
+    }
+  } catch {
+    XCTFail("JSON conversion failed: \(error)", file: file, line: line)
+  }
+}
+

Tests/AlgoliaSearchClientTests/Integration/InsightsIntegrationTests.swift

@@ -19,9 +19,7 @@ class InsightsIntegrationTests: IntegrationTestCase {
     [insights]
   }
 
-  func insights() throws {
-    Logger.minSeverityLevel = .trace
-    
+  func insights() throws {    
     let insightsClient = InsightsClient(appID: client.applicationID, apiKey: client.apiKey)
 
     let records: [JSON] = [

Tests/AlgoliaSearchClientTests/Integration/QueryRulesIntegrationTests.swift

@@ -18,9 +18,7 @@ class QueryRulesIntegrationTests: IntegrationTestCase {
   }
 
   func queryRules() throws {
-    
-    Logger.minSeverityLevel = .warning
-    
+  
     let index = client.index(withName: "rules")
 
     let records: [JSON] = [