feat(shorebird_code_push_client): add deleteRelease (#430)

shorebirdtech · May 3, 2023 · 9ae64e9 · 9ae64e9
1 parent 1cb8154
commit 9ae64e9
Show file tree

Hide file tree

Showing 2 changed files with 81 additions and 0 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
@@ -195,6 +195,17 @@ class CodePushClient {
     return Release.fromJson(body);
   }
 
+  /// Delete the release with the provided [releaseId].
+  Future<void> deleteRelease({required int releaseId}) async {
+    final response = await _httpClient.delete(
+      Uri.parse('$hostedUri/api/v1/releases/$releaseId'),
+    );
+
+    if (response.statusCode != HttpStatus.noContent) {
+      throw _parseErrorResponse(response.body);
+    }
+  }
+
   /// Create a new Shorebird user with the provided [name].
   ///
   /// The email associated with the user's JWT will be used as the user's email.

diff --git a/packages/shorebird_code_push_client/test/src/code_push_client_test.dart b/packages/shorebird_code_push_client/test/src/code_push_client_test.dart
@@ -777,6 +777,76 @@ void main() {
       });
     });
 
+    group('deleteRelease', () {
+      const releaseId = 42;
+
+      test('throws an exception if the http request fails (unknown)', () async {
+        when(
+          () => httpClient.delete(any(), headers: any(named: 'headers')),
+        ).thenAnswer(
+          (_) async => http.Response('', HttpStatus.failedDependency),
+        );
+
+        expect(
+          codePushClient.deleteRelease(releaseId: releaseId),
+          throwsA(
+            isA<CodePushException>().having(
+              (e) => e.message,
+              'message',
+              CodePushClient.unknownErrorMessage,
+            ),
+          ),
+        );
+      });
+
+      test('throws an exception if the http request fails', () async {
+        when(
+          () => httpClient.delete(any(), headers: any(named: 'headers')),
+        ).thenAnswer(
+          (_) async => http.Response(
+            json.encode(errorResponse.toJson()),
+            HttpStatus.failedDependency,
+          ),
+        );
+
+        expect(
+          codePushClient.deleteRelease(releaseId: releaseId),
+          throwsA(
+            isA<CodePushException>().having(
+              (e) => e.message,
+              'message',
+              errorResponse.message,
+            ),
+          ),
+        );
+      });
+
+      test('completes when request succeeds', () async {
+        when(
+          () => httpClient.delete(
+            any(),
+            headers: any(named: 'headers'),
+          ),
+        ).thenAnswer((_) async => http.Response('', HttpStatus.noContent));
+
+        await codePushClient.deleteRelease(releaseId: releaseId);
+
+        final uri = verify(
+          () => httpClient.delete(
+            captureAny(),
+            headers: any(named: 'headers'),
+          ),
+        ).captured.single as Uri;
+
+        expect(
+          uri,
+          codePushClient.hostedUri.replace(
+            path: '/api/v1/releases/$releaseId',
+          ),
+        );
+      });
+    });
+
     group('createUser', () {
       const userName = 'Jane Doe';
       final user = User(