refactor(code_push_client): create http wrapper to standardize headers (

#648)
shorebirdtech · Jun 14, 2023 · 1450ae2 · 1450ae2
1 parent 5baa22c
commit 1450ae2
Show file tree

Hide file tree

Showing 2 changed files with 688 additions and 565 deletions.
diff --git a/packages/shorebird_code_push_client/lib/src/code_push_client.dart b/packages/shorebird_code_push_client/lib/src/code_push_client.dart
@@ -38,6 +38,26 @@ class CodePushNotFoundException extends CodePushException {
   CodePushNotFoundException({required super.message, super.details});
 }
 
+/// A wrapper around [http.Client] that ensures all outbound requests
+/// are consistent.
+/// For example, all requests include the standard `x-version` header.
+class _CodePushHttpClient extends http.BaseClient {
+  _CodePushHttpClient(this._client);
+
+  final http.Client _client;
+
+  @override
+  Future<http.StreamedResponse> send(http.BaseRequest request) {
+    return _client.send(request..headers.addAll(CodePushClient.headers));
+  }
+
+  @override
+  void close() {
+    _client.close();
+    super.close();
+  }
+}
+
 /// {@template code_push_client}
 /// Dart client for the Shorebird CodePush API.
 /// {@endtemplate}
@@ -46,7 +66,7 @@ class CodePushClient {
   CodePushClient({
     http.Client? httpClient,
     Uri? hostedUri,
-  })  : _httpClient = httpClient ?? http.Client(),
+  })  : _httpClient = _CodePushHttpClient(httpClient ?? http.Client()),
         hostedUri = hostedUri ?? Uri.https('api.shorebird.dev');
 
   /// The standard headers applied to all requests.
@@ -70,7 +90,6 @@ class CodePushClient {
   }) async {
     final response = await _httpClient.post(
       Uri.parse('$_v1/apps/$appId/collaborators'),
-      headers: headers,
       body: json.encode(CreateAppCollaboratorRequest(email: email).toJson()),
     );
 
@@ -107,7 +126,6 @@ class CodePushClient {
       Uri.parse('$_v1/patches/$patchId/artifacts'),
     );
     final file = await http.MultipartFile.fromPath('file', artifactPath);
-    request.headers.addAll(headers);
     request.fields.addAll({
       'arch': arch,
       'platform': platform,
@@ -141,7 +159,6 @@ class CodePushClient {
   Future<Uri> createPaymentLink() async {
     final response = await _httpClient.post(
       Uri.parse('$_v1/subscriptions/payment_link'),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.ok) {
@@ -166,7 +183,6 @@ class CodePushClient {
       Uri.parse('$_v1/releases/$releaseId/artifacts'),
     );
     final file = await http.MultipartFile.fromPath('file', artifactPath);
-    request.headers.addAll(headers);
     request.fields.addAll({
       'arch': arch,
       'platform': platform,
@@ -201,7 +217,6 @@ class CodePushClient {
   Future<App> createApp({required String displayName}) async {
     final response = await _httpClient.post(
       Uri.parse('$_v1/apps'),
-      headers: headers,
       body: json.encode({'display_name': displayName}),
     );
 
@@ -219,7 +234,6 @@ class CodePushClient {
   }) async {
     final response = await _httpClient.post(
       Uri.parse('$_v1/channels'),
-      headers: headers,
       body: json.encode({'app_id': appId, 'channel': channel}),
     );
 
@@ -234,7 +248,6 @@ class CodePushClient {
   Future<Patch> createPatch({required int releaseId}) async {
     final response = await _httpClient.post(
       Uri.parse('$_v1/patches'),
-      headers: headers,
       body: json.encode({'release_id': releaseId}),
     );
 
@@ -255,7 +268,6 @@ class CodePushClient {
   }) async {
     final response = await _httpClient.post(
       Uri.parse('$_v1/releases'),
-      headers: headers,
       body: json.encode({
         'app_id': appId,
         'version': version,
@@ -278,7 +290,6 @@ class CodePushClient {
   }) async {
     final response = await _httpClient.delete(
       Uri.parse('$_v1/apps/$appId/collaborators/$userId'),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.noContent) {
@@ -290,7 +301,6 @@ class CodePushClient {
   Future<void> deleteRelease({required int releaseId}) async {
     final response = await _httpClient.delete(
       Uri.parse('$_v1/releases/$releaseId'),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.noContent) {
@@ -306,7 +316,6 @@ class CodePushClient {
   }) async {
     final response = await _httpClient.post(
       Uri.parse('$_v1/users'),
-      headers: headers,
       body: jsonEncode(CreateUserRequest(name: name).toJson()),
     );
 
@@ -322,7 +331,6 @@ class CodePushClient {
   Future<void> deleteApp({required String appId}) async {
     final response = await _httpClient.delete(
       Uri.parse('$_v1/apps/$appId'),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.noContent) {
@@ -334,7 +342,6 @@ class CodePushClient {
   Future<List<AppMetadata>> getApps() async {
     final response = await _httpClient.get(
       Uri.parse('$_v1/apps'),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.ok) {
@@ -353,7 +360,6 @@ class CodePushClient {
       Uri.parse('$_v1/channels').replace(
         queryParameters: {'appId': appId},
       ),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.ok) {
@@ -370,7 +376,6 @@ class CodePushClient {
   Future<List<Collaborator>> getCollaborators({required String appId}) async {
     final response = await _httpClient.get(
       Uri.parse('$_v1/apps/$appId/collaborators'),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.ok) {
@@ -391,7 +396,6 @@ class CodePushClient {
       Uri.parse('$_v1/releases').replace(
         queryParameters: {'appId': appId},
       ),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.ok) {
@@ -417,7 +421,6 @@ class CodePushClient {
           'platform': platform,
         },
       ),
-      headers: headers,
     );
 
     if (response.statusCode != HttpStatus.ok) {
@@ -435,7 +438,6 @@ class CodePushClient {
   }) async {
     final response = await _httpClient.post(
       Uri.parse('$_v1/patches/promote'),
-      headers: headers,
       body: json.encode({'patch_id': patchId, 'channel_id': channelId}),
     );
 
@@ -446,10 +448,7 @@ class CodePushClient {
 
   /// Cancels the current user's subscription.
   Future<DateTime> cancelSubscription() async {
-    final response = await _httpClient.delete(
-      Uri.parse('$_v1/subscriptions'),
-      headers: headers,
-    );
+    final response = await _httpClient.delete(Uri.parse('$_v1/subscriptions'));
 
     if (response.statusCode != HttpStatus.ok) {
       throw _parseErrorResponse(response.statusCode, response.body);