test(realtime): add realtime integration tests (#333)

* Move to ObservationTokenTests

* test(realtime): add integration tests for realtime v2

* Rename schema to key_value_storage

* chore: move realtime integration tests to IntegrationTests target

* test: comment out failing test

* test: fix optional type for receivedMessage

* chore: fix dot-env target

* chore: fix load env script

* test: use mock web socket

* chore: swift format

Author: grdsdev

.env

@@ -0,0 +1,4 @@
+# Get these from your API settings: https://supabase.com/dashboard/project/_/settings/api
+
+SUPABASE_URL=https://mysupabasereference.supabase.co
+SUPABASE_ANON_KEY=my.supabase.anon.key

.env.example

@@ -97,6 +97,6 @@ iOSInjectionProject/
 
 
 # Environment
-.env.local
+.env
 Secrets.swift
-Tests/IntegrationTests/Environment.swift
+DotEnv.swift

.gitignore

@@ -7,10 +7,21 @@ PLATFORM_WATCHOS = watchOS Simulator,name=Apple Watch Series 9 (41mm)
 SCHEME ?= Supabase
 PLATFORM ?= iOS Simulator,name=iPhone 15 Pro
 
-set-env:
-	@source scripts/setenv.sh > Tests/IntegrationTests/Environment.swift
+export SECRETS
+define SECRETS
+enum DotEnv {
+  static let SUPABASE_URL = "$(SUPABASE_URL)"
+  static let SUPABASE_ANON_KEY = "$(SUPABASE_ANON_KEY)"
+}
+endef
 
-test-all: set-env
+load-env:
+	@. ./scripts/load_env.sh
+
+dot-env:
+	@echo "$$SECRETS" > Tests/IntegrationTests/DotEnv.swift
+
+test-all: dot-env
 	set -o pipefail && \
 			xcodebuild test \
 				-skipMacroValidation \
@@ -19,7 +30,7 @@ test-all: set-env
 				-testPlan AllTests \
 				-destination platform="$(PLATFORM)" | xcpretty
 
-test-library: set-env
+test-library: dot-env
 	set -o pipefail && \
 			xcodebuild test \
 				-skipMacroValidation \
@@ -28,8 +39,8 @@ test-library: set-env
 				-derivedDataPath /tmp/derived-data \
 				-destination platform="$(PLATFORM)" | xcpretty
 
-test-integration: set-env
-	@set -o pipefail && \
+test-integration: dot-env
+	set -o pipefail && \
 		xcodebuild test \
 			-skipMacroValidation \
 			-workspace supabase-swift.xcworkspace \

Makefile

@@ -79,6 +79,7 @@ let package = Package(
         "Auth",
         "TestHelpers",
         "PostgREST",
+        "Realtime",
       ]
     ),
     .target(
@@ -127,6 +128,7 @@ let package = Package(
       name: "RealtimeTests",
       dependencies: [
         "Realtime",
+        "PostgREST",
         "TestHelpers",
         .product(name: "CustomDump", package: "swift-custom-dump"),
       ]

Package.swift

@@ -3,6 +3,7 @@ import ConcurrencyExtras
 import Foundation
 
 public typealias PostgrestError = _Helpers.PostgrestError
+public typealias AnyJSON = _Helpers.AnyJSON
 
 #if canImport(FoundationNetworking)
   import FoundationNetworking

Sources/PostgREST/PostgrestClient.swift

@@ -15,6 +15,8 @@ import Foundation
   let NSEC_PER_SEC: UInt64 = 1000000000
 #endif
 
+public typealias JSONObject = _Helpers.JSONObject
+
 public actor RealtimeClientV2 {
   public struct Configuration: Sendable {
     var url: URL

Sources/Realtime/V2/RealtimeClientV2.swift

@@ -0,0 +1,14 @@
+//
+//  AsyncSequence.swift
+//
+//
+//  Created by Guilherme Souza on 04/04/24.
+//
+
+import Foundation
+
+extension AsyncSequence {
+  package func collect() async rethrows -> [Element] {
+    try await reduce(into: [Element]()) { $0.append($1) }
+  }
+}

Sources/TestHelpers/AsyncSequence.swift

@@ -14,9 +14,9 @@ import XCTest
 final class AuthClientIntegrationTests: XCTestCase {
   let authClient = AuthClient(
     configuration: AuthClient.Configuration(
-      url: URL(string: "\(Environment.SUPABASE_URL)/auth/v1")!,
+      url: URL(string: "\(DotEnv.SUPABASE_URL)/auth/v1")!,
       headers: [
-        "apikey": Environment.SUPABASE_ANON_KEY,
+        "apikey": DotEnv.SUPABASE_ANON_KEY,
       ],
       localStorage: InMemoryLocalStorage(),
       logger: nil

Tests/IntegrationTests/AuthClientIntegrationTests.swift

@@ -36,9 +36,9 @@ struct User: Codable, Hashable {
 @available(iOS 15.0.0, macOS 12.0.0, tvOS 13.0, *)
 final class IntegrationTests: XCTestCase {
   let client = PostgrestClient(
-    url: URL(string: "\(Environment.SUPABASE_URL)/rest/v1")!,
+    url: URL(string: "\(DotEnv.SUPABASE_URL)/rest/v1")!,
     headers: [
-      "Apikey": Environment.SUPABASE_ANON_KEY,
+      "Apikey": DotEnv.SUPABASE_ANON_KEY,
     ],
     logger: nil
   )