fix(offline_first_with_rest): restore RestRequest url #553 (#567)

Author: tshedor

packages/brick_offline_first_with_rest/CHANGELOG.md

@@ -1,3 +1,7 @@
+## 4.0.1
+
+- Fixes a bug where `get` with `.awaitRemote` and a non-empty `Query` overrides the initial query and disregards the URL when being passed to the remote provider via `RestRequest`. Hat tip to @hortigado and @devj3ns #553
+
 ## 4.0.0
 
 - **BREAKING CHANGE** `Query(providerArgs:)` is no longer supported. See #510 for migration steps.

packages/brick_offline_first_with_rest/lib/src/offline_first_with_rest_repository.dart

@@ -84,25 +84,23 @@ abstract class OfflineFirstWithRestRepository<TRepositoryModel extends OfflineFi
     OfflineFirstUpsertPolicy? upsert,
   }) {
     // The header value must be stringified because of how `http.Client` accepts the `headers` Map
-    final headerValue = delete?.toString().split('.').last ??
-        get?.toString().split('.').last ??
-        upsert?.toString().split('.').last;
-    final existingProviderQuery =
-        query?.providerQueries[RestProvider] as RestProviderQuery? ?? const RestProviderQuery();
-    final existingProviderQueryRequest = existingProviderQuery.request ?? const RestRequest();
+    final headerValue = delete?.name ?? get?.name ?? upsert?.name;
+    final existingProviderQuery = query?.providerQueries[RestProvider] as RestProviderQuery?;
+    final existingProviderQueryRequest = existingProviderQuery?.request;
 
     return query?.copyWith(
       forProviders: [
         ...query.forProviders,
-        existingProviderQuery.copyWith(
-          request: existingProviderQueryRequest.copyWith(
-            headers: {
-              // This header is removed by the [RestOfflineQueueClient]
-              if (headerValue != null) RestOfflineQueueClient.policyHeader: headerValue,
-              ...?existingProviderQueryRequest.headers,
-            },
+        if (existingProviderQuery != null)
+          existingProviderQuery.copyWith(
+            request: existingProviderQueryRequest?.copyWith(
+              headers: {
+                // This header is removed by the [RestOfflineQueueClient]
+                if (headerValue != null) RestOfflineQueueClient.policyHeader: headerValue,
+                ...?existingProviderQueryRequest.headers,
+              },
+            ),
           ),
-        ),
       ],
     );
   }

packages/brick_offline_first_with_rest/pubspec.yaml

@@ -5,7 +5,7 @@ homepage: https://github.com/GetDutchie/brick/tree/main/packages/brick_offline_f
 issue_tracker: https://github.com/GetDutchie/brick/issues
 repository: https://github.com/GetDutchie/brick
 
-version: 4.0.0
+version: 4.0.1
 
 environment:
   sdk: ">=3.4.0 <4.0.0"

packages/brick_offline_first_with_rest/test/helpers/__mocks__.dart

@@ -79,7 +79,7 @@ class TestRepository extends OfflineFirstWithRestRepository {
         client: client,
       ),
       SqliteProvider(
-        '$inMemoryDatabasePath/repository',
+        '$inMemoryDatabasePath/repository${DateTime.now().microsecondsSinceEpoch}',
         databaseFactory: databaseFactoryFfi,
         modelDictionary: sqliteDictionary,
       ),

packages/brick_offline_first_with_rest/test/offline_first_with_rest_repository_test.dart

@@ -1,5 +1,7 @@
 import 'package:brick_offline_first/brick_offline_first.dart';
 import 'package:brick_offline_first_with_rest/testing.dart';
+import 'package:http/http.dart' as http;
+import 'package:http/testing.dart';
 import 'package:sqflite_common_ffi/sqflite_ffi.dart';
 import 'package:test/test.dart';
 
@@ -11,7 +13,7 @@ void main() {
   group('OfflineFirstRepository', () {
     const baseUrl = 'http://0.0.0.0:3000';
 
-    setUpAll(() async {
+    setUp(() async {
       TestRepository.configure(
         baseUrl: baseUrl,
         restDictionary: restModelDictionary,
@@ -63,6 +65,70 @@ void main() {
 
         expect(findByName.first.name, horse.name);
       });
+
+      test('delivers data from HTTP when using awaitRemote policy', () async {
+        // Configure test repository with a client that returns a specific response
+        const customResponse = '[{"name": "RemoteName"}]';
+        final client = StubOfflineFirstWithRest(
+          baseEndpoint: baseUrl,
+          responses: [
+            StubOfflineFirstRestResponse(
+              customResponse,
+              endpoint: 'mounties',
+              method: StubHttpMethod.get,
+            ),
+          ],
+        ).client;
+
+        TestRepository.configure(
+          baseUrl: baseUrl,
+          restDictionary: restModelDictionary,
+          sqliteDictionary: sqliteModelDictionary,
+          client: client,
+        );
+        await TestRepository().initialize();
+
+        // Get data with awaitRemote policy
+        final results = await TestRepository().get<Mounty>(
+          query: Query(
+            where: [
+              const Where('name').isExactly('RemoteName'),
+            ],
+          ),
+          policy: OfflineFirstGetPolicy.awaitRemote,
+        );
+
+        // Verify data came from HTTP
+        expect(results, hasLength(1));
+        expect(results.first.name, 'RemoteName');
+      });
+
+      test('handles tunnel not found response with non-awaitRemote policy', () async {
+        // Configure test repository with a client that returns a tunnel not found response
+        const tunnelNotFoundResponse = 'Tunnel 12345 not found';
+        final client = MockClient((req) async {
+          if (req.url.toString().contains('mounties')) {
+            return http.Response(tunnelNotFoundResponse, 404);
+          }
+          return http.Response('Not found', 404);
+        });
+
+        TestRepository.configure(
+          baseUrl: baseUrl,
+          restDictionary: restModelDictionary,
+          sqliteDictionary: sqliteModelDictionary,
+          client: client,
+        );
+        await TestRepository().initialize();
+
+        // Get data with non-awaitRemote policy
+        final results = await TestRepository().get<Mounty>(
+          policy: OfflineFirstGetPolicy.localOnly,
+        );
+
+        // Should return empty list without throwing
+        expect(results, isEmpty);
+      });
     });
 
     test('#getBatched', () async {