fix: BaseRequest now has headers getter instead of headerValuesAsList.

llfbandit · llfbandit · commit c5463a2f4d42 · 2025-04-02T12:08:57.000+02:00
diff --git a/dio_cache_interceptor/CHANGELOG.md b/dio_cache_interceptor/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 4.0.3
+- fix: BaseRequest now has `headers` getter instead of `headerValuesAsList`.
+- chore: Updated dependencies.
+
 ## 4.0.2
 - fix: Missing exports to handle client only caching.
 
diff --git a/dio_cache_interceptor/lib/src/extension/request_extension.dart b/dio_cache_interceptor/lib/src/extension/request_extension.dart
@@ -3,17 +3,6 @@ import 'package:dio_cache_interceptor/src/extension/cache_option_extension.dart'
 import 'package:http_cache_core/http_cache_core.dart';
 
 extension RequestExtension on RequestOptions {
-  // Request headers are not of type Headers...
-  // This method helps to wrap it to correct list for iteration
-  List<String>? headerValuesAsList(String headerKey) {
-    final value = headers[headerKey];
-
-    if (value is Iterable<String>) return value.toList();
-    if (value is String) return value.split(',').map((h) => h.trim()).toList();
-
-    return value;
-  }
-
   CacheOptions? getCacheOptions() {
     return extra[extraKey];
   }
@@ -24,7 +13,7 @@ extension RequestExtension on RequestOptions {
 
     for (var header in headers.entries) {
       if (header.value is Iterable) {
-        h[header.key] = header.value.join(',');
+        h[header.key] = header.value.join(', ');
       } else if (header.value != null) {
         h[header.key] = header.value.toString();
       }
diff --git a/dio_cache_interceptor/lib/src/model/dio_base_request.dart b/dio_cache_interceptor/lib/src/model/dio_base_request.dart
@@ -5,12 +5,10 @@ import 'package:http_cache_core/http_cache_core.dart';
 /// Wrapper on [BaseRequest] to deal with [RequestOptions]
 class DioBaseRequest extends BaseRequest {
   final RequestOptions request;
+  final Map<String, String> _headers;
 
-  DioBaseRequest(this.request);
-
-  @override
-  List<String>? headerValuesAsList(String header) {
-    return request.headerValuesAsList(header);
+  DioBaseRequest(this.request) : _headers = request.getFlattenHeaders() {
+    request.headers = _headers;
   }
 
   @override
@@ -21,4 +19,7 @@ class DioBaseRequest extends BaseRequest {
       request.headers[header] = value;
     }
   }
+
+  @override
+  Map<String, String> get headers => _headers;
 }
diff --git a/dio_cache_interceptor/pubspec.yaml b/dio_cache_interceptor/pubspec.yaml
@@ -3,7 +3,7 @@ description: Dio HTTP cache interceptor with multiple stores respecting HTTP dir
 repository: https://github.com/llfbandit/dart_http_cache
 issue_tracker: https://github.com/llfbandit/dart_http_cache/issues
 
-version: 4.0.2
+version: 4.0.3
 
 environment:
   sdk: ^3.0.0
diff --git a/dio_cache_interceptor/test/request_extension_test.dart b/dio_cache_interceptor/test/request_extension_test.dart
@@ -4,47 +4,40 @@ import 'package:http_cache_core/http_cache_core.dart';
 import 'package:test/test.dart';
 
 void main() {
-  test('request cache control from String', () {
+  test('getFlattenHeaders returns correct header', () {
     final cacheControlReference = [
       'max-age=1',
       'no-store',
-      'no-cache',
+      'no-cache="set-cookie"',
       'public',
       'max-stale=2',
       'min-fresh=3',
       'must-revalidate',
     ];
 
-    // Correctly formatted
+    // Correctly formatted from list
     var rq = RequestOptions(
       path: 'https://foo.com',
-      headers: {
-        cacheControlHeader:
-            'max-age=1, no-store, no-cache, public, max-stale=2, min-fresh=3, must-revalidate'
-      },
+      headers: {cacheControlHeader: cacheControlReference},
     );
 
     expect(
-      cacheControlReference,
-      rq.headerValuesAsList(cacheControlHeader),
+      rq.getFlattenHeaders()[cacheControlHeader],
+      cacheControlReference.join(', '),
     );
 
-    // Without spaces
+    // Without spaces from String
+    final values =
+        'max-age=1,no-store,no-cache,public,max-stale=2,min-fresh=3,must-revalidate';
     rq = RequestOptions(
       path: 'https://foo.com',
-      headers: {
-        cacheControlHeader:
-            'max-age=1,no-store,no-cache,public,max-stale=2,min-fresh=3,must-revalidate'
-      },
+      headers: {cacheControlHeader: values},
     );
 
-    expect(
-      cacheControlReference,
-      rq.headerValuesAsList(cacheControlHeader),
-    );
+    expect(rq.getFlattenHeaders()[cacheControlHeader], values);
   });
 
-  test('cache control with field name', () {
+  test('getFlattenHeaders cache control with field name', () {
     final cacheControlReference = [
       'max-age=1',
       'no-store',
@@ -55,18 +48,14 @@ void main() {
       'must-revalidate',
     ];
 
-    // Correctly formatted
     var rq = RequestOptions(
       path: 'https://foo.com',
-      headers: {
-        cacheControlHeader:
-            'max-age=1, no-store, no-cache="set-cookie", public, max-stale=2, min-fresh=3, must-revalidate'
-      },
+      headers: {cacheControlHeader: cacheControlReference},
     );
 
     expect(
-      cacheControlReference,
-      rq.headerValuesAsList(cacheControlHeader),
+      rq.getFlattenHeaders()[cacheControlHeader],
+      cacheControlReference.join(', '),
     );
   });
 }
diff --git a/http_cache_client/CHANGELOG.md b/http_cache_client/CHANGELOG.md
@@ -1,3 +1,7 @@
+## 1.0.2
+- fix: BaseRequest now has `headers` getter instead of `headerValuesAsList`.
+- chore: Updated dependencies.
+
 ## 1.0.1
 - fix: Improve cache save time.
 - fix: Improve request date assignment.
diff --git a/http_cache_client/lib/src/model/http_base_request.dart b/http_cache_client/lib/src/model/http_base_request.dart
@@ -15,27 +15,7 @@ class HttpBaseRequest extends BaseRequest {
   HttpBaseRequest(this.inner, this.options, this._date);
 
   @override
-  List<String>? headerValuesAsList(String header) {
-    final value = inner.headers[header];
-
-    if (value != null) {
-      final values = <String>[];
-
-      if (!value.contains(',')) {
-        values.add(value);
-      } else {
-        if (header == 'set-cookie') {
-          return value.split(setCookieSplitter);
-        } else {
-          return value.split(headerSplitter);
-        }
-      }
-
-      return values;
-    }
-
-    return null;
-  }
+  Map<String, String> get headers => inner.headers;
 
   @override
   void setHeader(String header, String? value) {
diff --git a/http_cache_client/pubspec.yaml b/http_cache_client/pubspec.yaml
@@ -1,6 +1,6 @@
 name: http_cache_client
 description: HTTP cache client with multiple stores respecting HTTP directives (or not).
-version: 1.0.1
+version: 1.0.2
 repository: https://github.com/llfbandit/dart_http_cache
 issue_tracker: https://github.com/llfbandit/dart_http_cache/issues
 
diff --git a/http_cache_client/test/http_base_request_test.dart b/http_cache_client/test/http_base_request_test.dart
@@ -13,7 +13,7 @@ void main() {
       DateTime.now(),
     );
 
-    expect(request.headerValuesAsList(cacheControlHeader), isNull);
+    expect(request.headers[cacheControlHeader], isNull);
   });
 
   test('headerValuesAsList simple', () {
@@ -26,9 +26,8 @@ void main() {
       DateTime.now(),
     );
 
-    final values = request.headerValuesAsList(cacheControlHeader);
-    expect(values, isNotNull);
-    expect(values?.first, equals('no-store'));
+    final values = request.headers[cacheControlHeader];
+    expect(values, equals('no-store'));
   });
 
   test('headerValuesAsList set-cookie', () {
@@ -44,14 +43,14 @@ void main() {
       DateTime.now(),
     );
 
-    final values = request.headerValuesAsList('set-cookie');
+    final values = request.headers['set-cookie'];
     expect(values, isNotNull);
     expect(
-        values?.first,
+        values,
         equals(
             'id=a3fWa; Max-Age=2592000; Expires=Wed, 21 Oct 2015 07:28:00 GMT'));
     expect(
-        values?.last,
+        values,
         equals(
             'id=a3fWa; Max-Age=2592000; Expires=Wed, 21 Oct 2015 07:28:00 GMT'));
   });
@@ -68,11 +67,8 @@ void main() {
       DateTime.now(),
     );
 
-    final values = request.headerValuesAsList(cacheControlHeader);
-    expect(values, isNotNull);
-    expect(values?.first, equals('no-cache'));
-    expect(values![1], equals('private'));
-    expect(values.last, equals('max-age=3600'));
+    final values = request.headers[cacheControlHeader];
+    expect(values, equals('no-cache, private,max-age=3600'));
   });
 
   test('setHeader null value', () {
@@ -87,11 +83,11 @@ void main() {
       DateTime.now(),
     );
 
-    var values = request.headerValuesAsList(cacheControlHeader);
+    var values = request.headers[cacheControlHeader];
     expect(values, isNotNull);
 
     request.setHeader(cacheControlHeader, null);
-    values = request.headerValuesAsList(cacheControlHeader);
+    values = request.headers[cacheControlHeader];
     expect(values, isNull);
   });
 
@@ -107,12 +103,12 @@ void main() {
       DateTime.now(),
     );
 
-    var values = request.headerValuesAsList(cacheControlHeader);
-    expect(values?.length, 3);
+    var values = request.headers[cacheControlHeader];
+    expect(values, equals('no-cache, private,max-age=3600'));
 
     request.setHeader(cacheControlHeader, 'no-store');
-    values = request.headerValuesAsList(cacheControlHeader);
-    expect(values?.first, equals('no-store'));
+    values = request.headers[cacheControlHeader];
+    expect(values, equals('no-store'));
   });
 
   test('requestDate returns given date', () {
diff --git a/http_cache_core/CHANGELOG.md b/http_cache_core/CHANGELOG.md
@@ -1,5 +1,6 @@
 ## 1.1.1
 - fix: Send only one condition on request cache validation.
+- fix: BaseRequest now has `headers` getter instead of `headerValuesAsList`.
 
 ## 1.1.0
 - feat: Early skip strategy calculation when request has already cache check conditions.
diff --git a/http_cache_core/lib/src/model/cache/cache_control.dart b/http_cache_core/lib/src/model/cache/cache_control.dart
@@ -75,6 +75,13 @@ class CacheControl {
     this.other = const [],
   });
 
+  /// Builds Cache Control from header values
+  factory CacheControl.fromString(String? headerValues) {
+    return CacheControl.fromHeader(
+      headerValues != null ? [headerValues] : null,
+    );
+  }
+
   /// Builds Cache Control from header values
   factory CacheControl.fromHeader(List<String>? headerValues) {
     // Parses single header value
diff --git a/http_cache_core/lib/src/model/cache/cache_strategy.dart b/http_cache_core/lib/src/model/cache/cache_strategy.dart
@@ -73,8 +73,8 @@ class CacheStrategyFactory {
     final resp = response;
     var cache = cacheResponse;
 
-    final rqCacheCtrl = CacheControl.fromHeader(
-      request.headerValuesAsList(cacheControlHeader),
+    final rqCacheCtrl = CacheControl.fromString(
+      request.headers[cacheControlHeader],
     );
 
     if (cacheResponseBuilder != null && resp != null && cache == null) {
@@ -177,12 +177,12 @@ class CacheStrategyFactory {
   /// Returns true if the request already contains conditions that save
   /// the server from sending a response that the client has locally.
   bool _hasConditions(BaseRequest request, CacheControl rqCacheCtrl) {
-    final ifNoneMatch = request.headerValuesAsList(ifNoneMatchHeader);
+    final ifNoneMatch = request.headers[ifNoneMatchHeader];
     if (ifNoneMatch != null) {
       request.setHeader(ifModifiedSinceHeader, null);
     }
 
     return rqCacheCtrl.noCache ||
-        request.headerValuesAsList(ifModifiedSinceHeader) != null;
+        request.headers[ifModifiedSinceHeader] != null;
   }
 }
diff --git a/http_cache_core/lib/src/model/core/base_request.dart b/http_cache_core/lib/src/model/core/base_request.dart
@@ -1,7 +1,7 @@
 /// Abtract request adapter
 abstract class BaseRequest {
-  /// Header values as list for a given header key.
-  List<String>? headerValuesAsList(String header);
+  /// Headers.
+  Map<String, String> get headers;
 
   /// Applies a [value] if not null to the request's header or remove it otherwise.
   void setHeader(String header, String? value);
diff --git a/http_cache_core/lib/src/model/utils/contants.dart b/http_cache_core/lib/src/model/utils/contants.dart
@@ -20,33 +20,3 @@ final _lws = RegExp(r'(?:\r\n)?[ \t]+');
 
 /// A regular expression matching any number of [_lws] productions in a row.
 final whitespace = RegExp('(?:${_lws.pattern})*');
-
-/// "token" as defined in RFC 2616, 2.2
-/// See https://datatracker.ietf.org/doc/html/rfc2616#section-2.2
-const tokenChars = r"!#$%&'*+\-.0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ^_`"
-    'abcdefghijklmnopqrstuvwxyz|~';
-
-/// Splits comma-seperated header values.
-final headerSplitter = RegExp(r'[ \t]*,[ \t]*');
-
-/// Splits comma-seperated "Set-Cookie" header values.
-///
-/// Set-Cookie strings can contain commas. In particular, the following
-/// productions defined in RFC-6265, section 4.1.1:
-/// - `<sane-cookie-date>` e.g. "Expires=Sun, 06 Nov 1994 08:49:37 GMT"
-/// - `<path-value>` e.g. "Path=somepath,"
-/// - `<extension-av>` e.g. "AnyString,Really,"
-///
-/// Some values are ambiguous e.g.
-/// "Set-Cookie: lang=en; Path=/foo/"
-/// "Set-Cookie: SID=x23"
-/// and:
-/// "Set-Cookie: lang=en; Path=/foo/,SID=x23"
-/// would both be result in `response.headers` => "lang=en; Path=/foo/,SID=x23"
-///
-/// The idea behind this regex is that `,<valid token>=` is more likely to
-/// start a new `<cookie-pair>` than be part of `<path-value>` or
-/// `<extension-av>`.
-///
-/// See https://datatracker.ietf.org/doc/html/rfc6265#section-4.1.1
-final setCookieSplitter = RegExp(r'[ \t]*,[ \t]*(?=[' + tokenChars + r']+=)');
diff --git a/http_cache_core/pubspec.yaml b/http_cache_core/pubspec.yaml
@@ -12,7 +12,7 @@ dependencies:
   # https://pub.dev/packages/collection
   collection: ^1.17.2
   # https://pub.dev/packages/string_scanner
-  string_scanner: ^1.1.0
+  string_scanner: ^1.2.0
   # https://pub.dev/packages/uuid
   uuid: ^4.5.0
 
diff --git a/http_cache_core/test/cache_control_test.dart b/http_cache_core/test/cache_control_test.dart
diff --git a/http_cache_core/test/cache_strategy_test.dart b/http_cache_core/test/cache_strategy_test.dart
diff --git a/http_cache_drift_store/lib/src/store/database.dart b/http_cache_drift_store/lib/src/store/database.dart
diff --git a/http_cache_file_store/lib/src/store/http_cache_file_store_io.dart b/http_cache_file_store/lib/src/store/http_cache_file_store_io.dart
diff --git a/http_cache_isar_store/lib/src/store/http_cache_isar_store.dart b/http_cache_isar_store/lib/src/store/http_cache_isar_store.dart

Original file line number	Diff line number	Diff line change
`@@ -5,12 +5,10 @@ import 'package:http_cache_core/http_cache_core.dart';`
`5`	`5`	`/// Wrapper on [BaseRequest] to deal with [RequestOptions]`
`6`	`6`	`class DioBaseRequest extends BaseRequest {`
`7`	`7`	`final RequestOptions request;`
	`8`	`+ final Map<String, String> _headers;`
`8`	`9`
`9`		`- DioBaseRequest(this.request);`
`10`		`-`
`11`		`- @override`
`12`		`- List<String>? headerValuesAsList(String header) {`
`13`		`- return request.headerValuesAsList(header);`
	`10`	`+ DioBaseRequest(this.request) : _headers = request.getFlattenHeaders() {`
	`11`	`+ request.headers = _headers;`
`14`	`12`	`}`
`15`	`13`
`16`	`14`	`@override`
`@@ -21,4 +19,7 @@ class DioBaseRequest extends BaseRequest {`
`21`	`19`	`request.headers[header] = value;`
`22`	`20`	`}`
`23`	`21`	`}`
	`22`	`+`
	`23`	`+ @override`
	`24`	`+ Map<String, String> get headers => _headers;`
`24`	`25`	`}`