feat(functions): invoke function with custom query params

supabase · May 13, 2024 · f303320 · f303320
1 parent 0a3b73e
commit f303320
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
diff --git a/packages/functions_client/lib/src/functions_client.dart b/packages/functions_client/lib/src/functions_client.dart
@@ -71,11 +71,13 @@ class FunctionsClient {
     String functionName, {
     Map<String, String>? headers,
     Map<String, dynamic>? body,
+    Map<String, String>? queryParameters,
     HttpMethod method = HttpMethod.post,
   }) async {
     final bodyStr = body == null ? null : await _isolate.encode(body);
 
-    final uri = Uri.parse('$_url/$functionName');
+    final uri = Uri.parse('$_url/$functionName')
+        .replace(queryParameters: queryParameters);
 
     final finalHeaders = <String, String>{
       ..._headers,

diff --git a/packages/functions_client/test/custom_http_client.dart b/packages/functions_client/test/custom_http_client.dart
@@ -3,8 +3,17 @@ import 'dart:convert';
 import 'package:http/http.dart';
 
 class CustomHttpClient extends BaseClient {
+  /// List of received requests by the client.
+  ///
+  /// Usefull for testing purposes, to check the request was constructed
+  /// correctly.
+  List<BaseRequest> receivedRequests = <BaseRequest>[];
+
   @override
   Future<StreamedResponse> send(BaseRequest request) async {
+    // Add request to receivedRequests list.
+    receivedRequests = receivedRequests..add(request);
+
     if (request.url.path.endsWith("function")) {
       //Return custom status code to check for usage of this client.
       return StreamedResponse(

diff --git a/packages/functions_client/test/functions_dart_test.dart b/packages/functions_client/test/functions_dart_test.dart
@@ -9,11 +9,13 @@ import 'custom_http_client.dart';
 
 void main() {
   late FunctionsClient functionsCustomHttpClient;
+  late CustomHttpClient customHttpClient;
 
   group("Custom http client", () {
     setUp(() {
+      customHttpClient = CustomHttpClient();
       functionsCustomHttpClient =
-          FunctionsClient("", {}, httpClient: CustomHttpClient());
+          FunctionsClient("", {}, httpClient: customHttpClient);
     });
     test('function throws', () async {
       try {
@@ -30,6 +32,17 @@ void main() {
       expect(res.status, 200);
     });
 
+    test('function call with query parameters', () async {
+      final res = await functionsCustomHttpClient
+          .invoke('function1', queryParameters: {'key': 'value'});
+
+      final request = customHttpClient.receivedRequests.last;
+
+      expect(request.url.queryParameters, {'key': 'value'});
+      expect(res.data, {'key': 'Hello World'});
+      expect(res.status, 200);
+    });
+
     test('dispose isolate', () async {
       await functionsCustomHttpClient.dispose();
       expect(functionsCustomHttpClient.invoke('function'), throwsStateError);