Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat(functions_client): Add SSE support to invoke method #905

Merged
merged 4 commits into from
Apr 27, 2024
Merged

feat(functions_client): Add SSE support to invoke method #905

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
20db792
feat: Add SSE support to invoke method
dshukertjr Apr 26, 2024
980d882
Add code sample in the comment docs
dshukertjr Apr 26, 2024
e9f2217
Add test
dshukertjr Apr 26, 2024
96c31dc
Update the comment on data of FunctionResponse and export ByteStream
dshukertjr Apr 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 35 additions & 47 deletions packages/functions_client/lib/src/functions_client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@ import 'dart:convert';
import 'package:functions_client/src/constants.dart';
import 'package:functions_client/src/types.dart';
import 'package:http/http.dart' as http;
import 'package:http/http.dart';
import 'package:yet_another_json_isolate/yet_another_json_isolate.dart';

class FunctionsClient {
Expand Down Expand Up @@ -44,6 +43,20 @@ class FunctionsClient {
/// [headers]: object representing the headers to send with the request
///
/// [body]: the body of the request
///
/// ```dart
/// // Call a standard function
/// final response = await supabase.functions.invoke('hello-world');
/// print(response.data);
///
/// // Listen to Server Sent Events
/// final response = await supabase.functions.invoke('sse-function');
/// response.data
/// .transform(const Utf8Decoder())
/// .listen((val) {
/// print(val);
/// });
/// ```
Future<FunctionResponse> invoke(
String functionName, {
Map<String, String>? headers,
Expand All @@ -52,67 +65,42 @@ class FunctionsClient {
}) async {
final bodyStr = body == null ? null : await _isolate.encode(body);

late final Response response;
final uri = Uri.parse('$_url/$functionName');

final finalHeaders = <String, String>{
..._headers,
if (headers != null) ...headers
};

switch (method) {
case HttpMethod.post:
response = await (_httpClient?.post ?? http.post)(
uri,
headers: finalHeaders,
body: bodyStr,
);
break;

case HttpMethod.get:
response = await (_httpClient?.get ?? http.get)(
uri,
headers: finalHeaders,
);
break;

case HttpMethod.put:
response = await (_httpClient?.put ?? http.put)(
uri,
headers: finalHeaders,
body: bodyStr,
);
break;

case HttpMethod.delete:
response = await (_httpClient?.delete ?? http.delete)(
uri,
headers: finalHeaders,
);
break;

case HttpMethod.patch:
response = await (_httpClient?.patch ?? http.patch)(
uri,
headers: finalHeaders,
body: bodyStr,
);
break;
}
final request = http.Request(method.name, uri);

finalHeaders.forEach((key, value) {
request.headers[key] = value;
});
if (bodyStr != null) request.body = bodyStr;
final response = await (_httpClient?.send(request) ?? request.send());
final responseType = (response.headers['Content-Type'] ??
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

From the documentation it says, that all headers are converted to lowercase. So the first check should never succeed.

Copy link
Member Author

@dshukertjr dshukertjr Apr 26, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hmm, I deleted the response.headers['Content-Type'] ?? and ran the test, but it seems like the tests are failing when the mock server returns Content-Type header in upper case, which suggests that the header keys are preserved the way it was sent from the server.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I still think the documentation is correct, but we just skip the translation when mocking the response object directly. So just keep it.

response.headers['content-type'] ??
'text/plain')
.split(';')[0]
.trim();

final data = switch (responseType) {
'application/json' => response.bodyBytes.isEmpty
final dynamic data;

if (responseType == 'application/json') {
final bodyBytes = await response.stream.toBytes();
data = bodyBytes.isEmpty
? ""
: await _isolate.decode(utf8.decode(response.bodyBytes)),
'application/octet-stream' => response.bodyBytes,
_ => utf8.decode(response.bodyBytes),
};
: await _isolate.decode(utf8.decode(bodyBytes));
} else if (responseType == 'application/octet-stream') {
data = await response.stream.toBytes();
} else if (responseType == 'text/event-stream') {
data = response.stream;
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here, I thought about adding .transform(const Utf8Decoder()) so that the developers don't have to add them by themselves, but Utf8Decoder() has a allowMalformed option, and I wanted to give the developers full control of what to do with the option, so I'm just returning raw ByteStream.

      data = response.stream.transform(const Utf8Decoder());

} else {
final bodyBytes = await response.stream.toBytes();
data = utf8.decode(bodyBytes);
}

if (200 <= response.statusCode && response.statusCode < 300) {
return FunctionResponse(data: data, status: response.statusCode);
} else {
Expand Down
7 changes: 7 additions & 0 deletions packages/functions_client/test/custom_http_client.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,13 @@ class CustomHttpClient extends BaseClient {
"Content-Type": "application/json",
},
);
} else if (request.url.path.endsWith('sse')) {
return StreamedResponse(
Stream.fromIterable(['a', 'b', 'c'].map((e) => utf8.encode(e))), 200,
request: request,
headers: {
"Content-Type": "text/event-stream",
});
} else {
return StreamedResponse(
Stream.value(utf8.encode(jsonEncode({"key": "Hello World"}))),
Expand Down
11 changes: 11 additions & 0 deletions packages/functions_client/test/functions_dart_test.dart
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
import 'dart:convert';

import 'package:functions_client/src/functions_client.dart';
import 'package:functions_client/src/types.dart';
import 'package:test/test.dart';
Expand Down Expand Up @@ -45,5 +47,14 @@ void main() {
final res = await client.invoke('function1');
expect(res.data, {'key': 'Hello World'});
});

test('Listen to SSE event', () async {
final res = await functionsCustomHttpClient.invoke('sse');
expect(
res.data.transform(const Utf8Decoder()),
emitsInOrder(
['a', 'b', 'c'],
));
});
});
}
Loading