feat: Server side swift (#680)

* Add linux target specific import of FoundationNetworking.
* Add Dockerfile for building the library in a container.
* Add SwiftCrypto as dependency for the Linux target.
* Operation related fixes for Linux.
* Import FoundationNetworking for the Linux target
* Add optional SwiftCrypto dependency for Linux targets to keep the compatibility with older macOS versions
* Implement integration tests skipping in case of missing environment variables
Co-authored-by: Vladislav Fitc <[email protected]>

Author: Adam Eri

.dockerignore

@@ -0,0 +1,2 @@
+.build
+.swiftpm

Dockerfile

@@ -0,0 +1,19 @@
+# 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
+
+WORKDIR /app
+
+COPY ./Package.* ./
+
+RUN swift package resolve
+
+COPY . .
+
+RUN swift build \
+    --enable-test-discovery \
+    -c release \
+    -Xswiftc -g \
+    -j 4
+
+# RUN swift test --enable-test-discovery

Package.swift

@@ -3,28 +3,55 @@
 
 import PackageDescription
 
+#if os(Linux)
+let macOSVersion: SupportedPlatform.MacOSVersion = .v10_15
+#else
+let macOSVersion: SupportedPlatform.MacOSVersion = .v10_10
+#endif
+
+#if os(Linux)
+let extraPackageDependencies: [Package.Dependency] = [
+  .package(url: "https://github.com/apple/swift-crypto.git", from: "1.1.2"),
+]
+#else
+let extraPackageDependencies: [Package.Dependency] = []
+#endif
+
+#if os(Linux)
+let extraTargetDependencies: [Target.Dependency] = [
+  .product(name: "Crypto", package: "swift-crypto")
+]
+#else
+let extraTargetDependencies: [Target.Dependency] = []
+#endif
+
 let package = Package(
-    name: "AlgoliaSearchClient",
-    platforms: [
-        .iOS(.v9),
-        .macOS(.v10_10),
-        .watchOS(.v2),
-        .tvOS(.v9)
-    ],
-    products: [
-        .library(
-            name: "AlgoliaSearchClient",
-            targets: ["AlgoliaSearchClient"])
-    ],
-    dependencies: [
-        .package(url:"https://github.com/apple/swift-log.git", from: "1.4.0")
-    ],
-    targets: [
-        .target(
-            name: "AlgoliaSearchClient",
-            dependencies: ["Logging"]),
-        .testTarget(
-            name: "AlgoliaSearchClientTests",
-            dependencies: ["AlgoliaSearchClient", "Logging"])
-    ]
+  name: "AlgoliaSearchClient",
+  platforms: [
+    .iOS(.v9),
+    .macOS(macOSVersion),
+    .watchOS(.v2),
+    .tvOS(.v9)
+  ],
+  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"),
+      ] + extraTargetDependencies)
+  ]
 )

Sources/AlgoliaSearchClient/Async/AsyncOperation.swift

@@ -28,9 +28,6 @@ open class AsyncOperation: Operation {
     }
   }
 
-}
-
-extension AsyncOperation {
   // NSOperation Overrides
   override open var isReady: Bool {
     return super.isReady && state == .ready

Sources/AlgoliaSearchClient/Client/AnalyticsClient.swift

@@ -6,6 +6,9 @@
 //
 
 import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
 
 public struct AnalyticsClient: Credentials {
 

Sources/AlgoliaSearchClient/Client/InsightsClient.swift

@@ -6,6 +6,9 @@
 //
 
 import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
 
 public struct InsightsClient: Credentials {
 

Sources/AlgoliaSearchClient/Client/PlacesClient.swift

@@ -6,6 +6,9 @@
 //
 
 import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
 
 public struct PlacesClient: Credentials {
 

Sources/AlgoliaSearchClient/Client/RecommendationClient.swift

@@ -6,6 +6,9 @@
 //
 
 import Foundation
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
 
 public struct RecommendationClient: Credentials {
 

Sources/AlgoliaSearchClient/Client/Search/SearchClient+SecuredAPIKey.swift

@@ -12,7 +12,7 @@ public extension SearchClient {
   func generateSecuredApiKey(parentApiKey: APIKey,
                              with restriction: SecuredAPIKeyRestriction) -> APIKey {
     let queryParams = restriction.urlEncodedString
-    let hash = queryParams.hmac(algorithm: .sha256, key: parentApiKey.rawValue)
+    let hash = queryParams.hmac256(withKey: parentApiKey.rawValue)
     return APIKey(rawValue: "\(hash)\(queryParams)".toBase64())
   }
 
@@ -25,5 +25,4 @@ public extension SearchClient {
     let timestampDate = Date(timeIntervalSince1970: timestamp)
     return timestampDate.timeIntervalSince1970 - Date().timeIntervalSince1970
   }
-
 }

Sources/AlgoliaSearchClient/Client/Search/SearchClient.swift

@@ -7,6 +7,10 @@
 
 import Foundation
 
+#if canImport(FoundationNetworking)
+import FoundationNetworking
+#endif
+
 typealias Client = SearchClient
 
 /// Client to perform operations on indices.