test: add integration tests for functions and fix bug with any function region

Author: grdsdev

Sources/Functions/FunctionsClient.swift

@@ -2,6 +2,7 @@ import ConcurrencyExtras
 import Foundation
 import HTTPTypes
 import HTTPTypesFoundation
+import Logging
 import OpenAPIURLSession
 
 #if canImport(FoundationNetworking)
@@ -45,6 +46,20 @@ struct FetchTransportAdapter: ClientTransport {
   }
 }
 
+extension URL {
+  /// Returns a new URL which contains only `{scheme}://{host}:{port}`.
+  fileprivate var baseURL: URL {
+    guard let components = URLComponents(string: self.absoluteString) else { return self }
+
+    var newComponents = URLComponents()
+    newComponents.scheme = components.scheme
+    newComponents.host = components.host
+    newComponents.port = components.port
+
+    return newComponents.url ?? self
+  }
+}
+
 /// An actor representing a client for invoking functions.
 public final class FunctionsClient: Sendable {
   /// Fetch handler used to make requests.
@@ -83,7 +98,11 @@ public final class FunctionsClient: Sendable {
   ///   - region: The Region to invoke the functions in.
   ///   - logger: SupabaseLogger instance to use.
   ///   - fetch: The fetch handler used to make requests. (Default: URLSession.shared.data(for:))
-  @available(*, deprecated, message: "Fetch handler is deprecated, use init with `transport` instead.")
+  @available(
+    *,
+    deprecated,
+    message: "Fetch handler is deprecated, use init with `transport` instead."
+  )
   @_disfavoredOverload
   public convenience init(
     url: URL,
@@ -114,7 +133,11 @@ public final class FunctionsClient: Sendable {
       headers: headers,
       region: region,
       logger: logger,
-      client: Client(serverURL: url, transport: transport ?? URLSessionTransport())
+      client: Client(
+        serverURL: url.baseURL,
+        transport: transport ?? URLSessionTransport(),
+        middlewares: [LoggingMiddleware(logger: Logger(label: "functions"))]
+      )
     )
   }
 
@@ -146,7 +169,11 @@ public final class FunctionsClient: Sendable {
   ///   - logger: SupabaseLogger instance to use.
   ///   - fetch: The fetch handler used to make requests. (Default: URLSession.shared.data(for:))
 
-  @available(*, deprecated, message: "Fetch handler is deprecated, use init with `transport` instead.")
+  @available(
+    *,
+    deprecated,
+    message: "Fetch handler is deprecated, use init with `transport` instead."
+  )
   public convenience init(
     url: URL,
     headers: [String: String] = [:],
@@ -292,18 +319,27 @@ public final class FunctionsClient: Sendable {
     functionName: String,
     options: FunctionInvokeOptions
   ) -> (HTTPTypes.HTTPRequest, HTTPBody?) {
-    var request = HTTPTypes.HTTPRequest(
-      method: FunctionInvokeOptions.httpMethod(options.method) ?? .post,
-      url: url.appendingPathComponent(functionName).appendingQueryItems(options.query),
-      headerFields: mutableState.headers.merging(with: options.headers)
-    )
+    var region = options.region
+    var queryItems = options.query
+    var headers = options.headers
 
     // TODO: Check how to assign FunctionsClient.requestIdleTimeout
 
-    if let region = options.region ?? region {
-      request.headerFields[.xRegion] = region
+    if region == nil {
+      region = self.region
+    }
+
+    if let region, region != "any" {
+      headers[.xRegion] = region
+      queryItems.append(URLQueryItem(name: "forceFunctionRegion", value: region))
     }
 
+    let request = HTTPTypes.HTTPRequest(
+      method: FunctionInvokeOptions.httpMethod(options.method) ?? .post,
+      url: url.appendingPathComponent(functionName).appendingQueryItems(queryItems),
+      headerFields: mutableState.headers.merging(with: headers)
+    )
+
     let body = options.body.map(HTTPBody.init)
 
     return (request, body)

Sources/Functions/Types.swift

@@ -131,6 +131,7 @@ public enum FunctionRegion: String, Sendable {
   case usEast1 = "us-east-1"
   case usWest1 = "us-west-1"
   case usWest2 = "us-west-2"
+  case any = "any"
 }
 
 extension FunctionInvokeOptions {

Sources/Helpers/HTTP/Exports.swift

@@ -1,3 +1,7 @@
 @_exported import HTTPTypes
-@_exported import protocol OpenAPIRuntime.ClientTransport
-@_exported import class OpenAPIRuntime.HTTPBody
+
+import protocol OpenAPIRuntime.ClientTransport
+import class OpenAPIRuntime.HTTPBody
+
+public typealias ClientTransport = OpenAPIRuntime.ClientTransport
+public typealias HTTPBody = OpenAPIRuntime.HTTPBody

Sources/Helpers/HTTP/LoggingMiddleware.swift

@@ -1,5 +1,6 @@
 import Logging
 import OpenAPIRuntime
+import HTTPTypesFoundation
 
 #if canImport(Darwin)
   import struct Foundation.URL
@@ -9,14 +10,14 @@ import OpenAPIRuntime
   @preconcurrency import struct Foundation.UUID
 #endif
 
-struct LoggingMiddleware: ClientMiddleware {
+package struct LoggingMiddleware: ClientMiddleware {
   let logger: Logger
 
-  init(logger: Logger) {
+  package init(logger: Logger) {
     self.logger = logger
   }
 
-  func intercept(
+  package func intercept(
     _ request: HTTPTypes.HTTPRequest,
     body: HTTPBody?,
     baseURL: URL,
@@ -46,7 +47,7 @@ extension HTTPFields {
 
 extension HTTPTypes.HTTPRequest {
   fileprivate var prettyDescription: String {
-    "\(method.rawValue) \(path ?? "<nil>") [\(headerFields.prettyDescription)]"
+    "\(method.rawValue) \(self.url?.absoluteString ?? "<nil>") [\(headerFields.prettyDescription)]"
   }
 }
 

Tests/IntegrationTests/DotEnv.swift

@@ -1,5 +1,5 @@
 enum DotEnv {
-  static let SUPABASE_URL = "http://localhost:54321"
+  static let SUPABASE_URL = "http://127.0.0.1:54321"
   static let SUPABASE_ANON_KEY =
     "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJzdXBhYmFzZS1kZW1vIiwicm9sZSI6ImFub24iLCJleHAiOjE5ODM4MTI5OTZ9.CRXP1A7WOeoJeXxjNni43kdQwgnWNReilDMblYTn_I0"
   static let SUPABASE_SERVICE_ROLE_KEY =

Tests/IntegrationTests/FunctionsIntegrationTests.swift

@@ -0,0 +1,165 @@
+//
+//  FunctionsIntegrationTests.swift
+//  Supabase
+//
+//  Created by Guilherme Souza on 04/08/25.
+//
+
+import Supabase
+import XCTest
+
+final class FunctionsIntegrationTests: XCTestCase {
+  let client = SupabaseClient(
+    supabaseURL: URL(string: DotEnv.SUPABASE_URL) ?? URL(string: "http://127.0.0.1:54321")!,
+    supabaseKey: DotEnv.SUPABASE_ANON_KEY
+  )
+
+  func testInvokeMirror() async throws {
+    let response: MirrorResponse = try await client.functions.invoke("mirror")
+    XCTAssertTrue(response.url.contains("/mirror"))
+    XCTAssertEqual(response.method, "POST")
+  }
+
+  func testInvokeMirrorWithClientHeader() async throws {
+    let client = FunctionsClient(
+      url: URL(string: "\(DotEnv.SUPABASE_URL)/functions/v1")!,
+      headers: [
+        "Authorization": "Bearer \(DotEnv.SUPABASE_ANON_KEY)",
+        "CustomHeader": "check me",
+      ]
+    )
+    let response: MirrorResponse = try await client.invoke("mirror")
+    XCTAssertEqual(response.headersDictionary["customheader"], "check me")
+  }
+
+  func testInvokeMirrorWithInvokeHeader() async throws {
+    let response: MirrorResponse = try await client.functions.invoke(
+      "mirror",
+      options: FunctionInvokeOptions(headers: ["Custom-Header": "check me"])
+    )
+    XCTAssertEqual(response.headersDictionary["custom-header"], "check me")
+  }
+
+  func testInvokeMirrorSetValidRegionOnRequest() async throws {
+    let response: MirrorResponse = try await client.functions.invoke(
+      "mirror",
+      options: FunctionInvokeOptions(region: .apNortheast1)
+    )
+    XCTAssertEqual(response.headersDictionary["x-region"], "ap-northeast-1")
+    XCTAssertTrue(response.url.contains("forceFunctionRegion=ap-northeast-1"))
+  }
+
+  func testInvokeWithRegionOverridesRegionInTheClinet() async throws {
+    let client = FunctionsClient(
+      url: URL(string: "\(DotEnv.SUPABASE_URL)/functions/v1")!,
+      headers: [
+        "Authorization": "Bearer \(DotEnv.SUPABASE_ANON_KEY)",
+        "CustomHeader": "check me",
+      ],
+      region: .apNortheast1
+    )
+    let response: MirrorResponse = try await client.invoke(
+      "mirror",
+      options: FunctionInvokeOptions(region: .apSoutheast1)
+    )
+    XCTAssertEqual(response.headersDictionary["x-region"], "ap-southeast-1")
+    XCTAssertTrue(response.url.contains("forceFunctionRegion=ap-southeast-1"))
+  }
+
+  func testStartClientWithDefaultRegionInvokeRevertsToAny() async throws {
+    let client = FunctionsClient(
+      url: URL(string: "\(DotEnv.SUPABASE_URL)/functions/v1")!,
+      headers: [
+        "Authorization": "Bearer \(DotEnv.SUPABASE_ANON_KEY)",
+        "CustomHeader": "check me",
+      ],
+      region: .apSoutheast1
+    )
+    let response: MirrorResponse = try await client.invoke(
+      "mirror",
+      options: FunctionInvokeOptions(region: .any)
+    )
+    XCTAssertNil(response.headersDictionary["x-region"])
+  }
+
+  func testInvokeRegionSetOnlyOnTheConstructor() async throws {
+    let client = FunctionsClient(
+      url: URL(string: "\(DotEnv.SUPABASE_URL)/functions/v1")!,
+      headers: [
+        "Authorization": "Bearer \(DotEnv.SUPABASE_ANON_KEY)",
+        "CustomHeader": "check me",
+      ],
+      region: .apSoutheast1
+    )
+    let response: MirrorResponse = try await client.invoke("mirror")
+    XCTAssertEqual(response.headersDictionary["x-region"], "ap-southeast-1")
+  }
+
+  func testInvokeMirrorWithBodyFormData() async throws {
+    throw XCTSkip("Unsupported body type.")
+  }
+
+  func testInvokeMirrowWithEncodableBody() async throws {
+    let body = Body(one: "one", two: "two", three: "three", num: 11, flag: false)
+    let response: MirrorResponse = try await client.functions.invoke(
+      "mirror",
+      options: FunctionInvokeOptions(
+        headers: [
+          "response-type": "json"
+        ],
+        body: body
+      )
+    )
+    let responseBody = try response.body.decode(as: Body.self, decoder: JSONDecoder())
+    XCTAssertEqual(responseBody, body)
+
+    XCTAssertEqual(response.headersDictionary["content-type"], "application/json")
+    XCTAssertEqual(response.headersDictionary["response-type"], "json")
+  }
+
+  func testInvokeMirrowWithDataBody() async throws {
+    let body = Body(one: "one", two: "two", three: "three", num: 11, flag: false)
+
+    let response: MirrorResponse = try await client.functions.invoke(
+      "mirror",
+      options: FunctionInvokeOptions(
+        headers: [
+          "response-type": "blob"
+        ],
+        body: try JSONEncoder().encode(body)
+      )
+    )
+
+    guard let responseBodyData = response.body.stringValue?.data(using: .utf8),
+      let responseBody = try? JSONDecoder().decode(Body.self, from: responseBodyData)
+    else {
+      XCTFail("Expected to receive body response as JSON string.")
+      return
+    }
+
+    XCTAssertEqual(responseBody, body)
+
+    XCTAssertEqual(response.headersDictionary["content-type"], "application/octet-stream")
+    XCTAssertEqual(response.headersDictionary["response-type"], "blob")
+  }
+}
+
+struct MirrorResponse: Decodable {
+  let url: String
+  let method: String
+  let headers: AnyJSON
+  let body: AnyJSON
+
+  var headersDictionary: [String: String] {
+    Dictionary(
+      uniqueKeysWithValues: headers.arrayValue?.compactMap {
+        $0.arrayValue?.compactMap(\.stringValue) ?? []
+      }.map { ($0[0], $0[1]) } ?? []
+    )
+  }
+}
+struct Body: Codable, Equatable {
+  let one, two, three: String
+  let num: Int
+  let flag: Bool
+}

Tests/IntegrationTests/supabase/.temp/cli-latest

@@ -1 +1 @@
-v2.22.12
+v2.33.9

Tests/IntegrationTests/supabase/config.toml

@@ -306,3 +306,14 @@ s3_region = "env(S3_REGION)"
 s3_access_key = "env(S3_ACCESS_KEY)"
 # Configures AWS_SECRET_ACCESS_KEY for S3 bucket
 s3_secret_key = "env(S3_SECRET_KEY)"
+
+[functions.mirror]
+enabled = true
+verify_jwt = true
+import_map = "./functions/mirror/deno.json"
+# Uncomment to specify a custom file path to the entrypoint.
+# Supported file extensions are: .ts, .js, .mjs, .jsx, .tsx
+entrypoint = "./functions/mirror/index.ts"
+# Specifies static files to be bundled with the function. Supports glob patterns.
+# For example, if you want to serve static HTML pages in your function:
+# static_files = [ "./functions/mirror/*.html" ]

Tests/IntegrationTests/supabase/functions/mirror/.npmrc

@@ -0,0 +1,3 @@
+# Configuration for private npm package dependencies
+# For more information on using private registries with Edge Functions, see:
+# https://supabase.com/docs/guides/functions/import-maps#importing-from-private-registries

Tests/IntegrationTests/supabase/functions/mirror/deno.json

@@ -0,0 +1,3 @@
+{
+  "imports": {}
+}