alpha.4

Author: f3ath

CHANGELOG.md

@@ -9,6 +9,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - URL Design matching now respects the base URL
 - Allo null to be returned by error interceptors
 
+### Fixed
+- StandardUriDesign working incosistently depending on the trailing slash in the path
+
 ## [8.0.0] - 2024-07-01
 ### Added
 - CORS middleware

lib/src/routing/standard_uri_design.dart

@@ -5,7 +5,10 @@ import 'package:json_api/routing.dart';
 class StandardUriDesign implements UriDesign {
   /// Creates an instance of [UriDesign] recommended by JSON:API standard.
   /// The [base] URI will be used as a prefix for the generated URIs.
-  const StandardUriDesign(this.base);
+  StandardUriDesign(Uri base)
+      : base = base.path.endsWith('/')
+            ? base
+            : base.replace(path: '${base.path}/');
 
   /// A "path only" version of the recommended URL design, e.g.
   /// `/books`, `/books/42`, `/books/42/authors`
@@ -17,7 +20,8 @@ class StandardUriDesign implements UriDesign {
           (base.host.isNotEmpty && uri.host != base.host) ||
           (base.port != 0 && uri.port != base.port)
       ? null
-      : switch (uri.pathSegments.sublist(base.pathSegments.length)) {
+      : switch (uri.pathSegments
+          .sublist(base.pathSegments.where((it) => it.isNotEmpty).length)) {
           [var type] => Target(type),
           [var type, var id] => ResourceTarget(type, id),
           [var type, var id, var rel] => RelatedTarget(type, id, rel),

pubspec.yaml

@@ -1,5 +1,5 @@
 name: json_api
-version: 9.0.0-alpha.3
+version: 9.0.0-alpha.4
 homepage: https://github.com/f3ath/json-api-dart
 description: A framework-agnostic implementations of JSON:API Client and Server. Supports JSON:API v1.0 (https://jsonapi.org)
 environment:

test/unit/routing/url_test.dart

@@ -4,13 +4,38 @@ import 'package:test/test.dart';
 void main() {
   test('uri generation', () {
     final d = StandardUriDesign.pathOnly;
+    expect(d.base.path, equals('/'));
     expect(d.collection('books').toString(), '/books');
     expect(d.resource('books', '42').toString(), '/books/42');
     expect(d.related('books', '42', 'author').toString(), '/books/42/author');
     expect(d.relationship('books', '42', 'author').toString(),
         '/books/42/relationships/author');
   });
 
+  test('uri generation with base, trailing slash', () {
+    final d = StandardUriDesign(Uri.parse('https://example.com/api/'));
+    expect(d.base.path, equals('/api/'));
+    expect(d.collection('books').toString(), 'https://example.com/api/books');
+    expect(d.resource('books', '42').toString(),
+        'https://example.com/api/books/42');
+    expect(d.related('books', '42', 'author').toString(),
+        'https://example.com/api/books/42/author');
+    expect(d.relationship('books', '42', 'author').toString(),
+        'https://example.com/api/books/42/relationships/author');
+  });
+
+  test('uri generation with base, no trailing slash', () {
+    final d = StandardUriDesign(Uri.parse('https://example.com/api'));
+    expect(d.base.path, equals('/api/'));
+    expect(d.collection('books').toString(), 'https://example.com/api/books');
+    expect(d.resource('books', '42').toString(),
+        'https://example.com/api/books/42');
+    expect(d.related('books', '42', 'author').toString(),
+        'https://example.com/api/books/42/author');
+    expect(d.relationship('books', '42', 'author').toString(),
+        'https://example.com/api/books/42/relationships/author');
+  });
+
   test('Authority is retained if exists in base', () {
     final d = StandardUriDesign(Uri.parse('https://example.com:8080'));
     expect(d.collection('books').toString(), 'https://example.com:8080/books');
@@ -110,5 +135,39 @@ void main() {
       expect(d.matchTarget(Uri.parse('https://example.com:8080/foo/books')),
           isNull);
     });
+
+    test('Authority and path, trailing slash', () {
+      final d = StandardUriDesign(Uri.parse('https://example.com:8080/api/'));
+      expect(d.matchTarget(Uri.parse('https://example.com:8080/api/books')),
+          isA<Target>().having((it) => it.type, 'type', equals('books')));
+      expect(
+          d.matchTarget(Uri.parse('https://example.com:8080/api/books/42')),
+          isA<ResourceTarget>()
+              .having((it) => it.type, 'type', equals('books'))
+              .having((it) => it.id, 'id', equals('42')));
+      expect(
+          d.matchTarget(
+              Uri.parse('https://example.com:8080/api/books/42/authors')),
+          isA<RelatedTarget>()
+              .having((it) => it.type, 'type', equals('books'))
+              .having((it) => it.id, 'id', equals('42'))
+              .having(
+                  (it) => it.relationship, 'relationship', equals('authors')));
+      expect(
+          d.matchTarget(Uri.parse(
+              'https://example.com:8080/api/books/42/relationships/authors')),
+          isA<RelationshipTarget>()
+              .having((it) => it.type, 'type', equals('books'))
+              .having((it) => it.id, 'id', equals('42'))
+              .having(
+                  (it) => it.relationship, 'relationship', equals('authors')));
+
+      expect(
+          d.matchTarget(Uri.parse('https://example.com:8080/a/b/c/d')), isNull);
+      expect(d.matchTarget(Uri.parse('http://example.com:8080/books')), isNull);
+      expect(d.matchTarget(Uri.parse('https://foo.net:8080/books')), isNull);
+      expect(d.matchTarget(Uri.parse('https://example.com:8080/foo/books')),
+          isNull);
+    });
   });
 }