feat: do not thread cache server when registering routes

lindyhopchris · lindyhopchris · commit fa8b6b5d0dff · 2023-11-07T19:50:30.000Z
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -3,6 +3,15 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## Unreleased
+
+### Changed
+
+- Registering routes no longer results in the server instance being thread-cached. This more accurately reflects
+  production environments, where routes would be cached so there would be no thread-cached JSON:API server when handling
+  a HTTP request. This means tests (and development environments where routes are not cached) more accurately behave in
+  the same way as production environments.
+
 ## [3.1.0] - 2023-07-20
 
 ### Added
diff --git a/composer.json b/composer.json
@@ -25,8 +25,8 @@
     "require": {
         "php": "^8.1",
         "ext-json": "*",
-        "laravel-json-api/core": "^3.2",
-        "laravel-json-api/eloquent": "^3.0",
+        "laravel-json-api/core": "^3.3",
+        "laravel-json-api/eloquent": "^3.1",
         "laravel-json-api/encoder-neomerx": "^3.0",
         "laravel-json-api/exceptions": "^2.0",
         "laravel-json-api/spec": "^2.0",
@@ -65,7 +65,7 @@
             ]
         }
     },
-    "minimum-stability": "stable",
+    "minimum-stability": "dev",
     "prefer-stable": true,
     "config": {
         "sort-packages": true
diff --git a/src/Routing/Registrar.php b/src/Routing/Registrar.php
@@ -21,6 +21,7 @@
 
 use Illuminate\Contracts\Routing\Registrar as RegistrarContract;
 use LaravelJsonApi\Contracts\Server\Repository;
+use LaravelJsonApi\Core\Server\ServerRepository;
 
 class Registrar
 {
@@ -55,9 +56,15 @@ public function __construct(RegistrarContract $router, Repository $servers)
      */
     public function server(string $name): PendingServerRegistration
     {
+        // TODO add the `once` method to the server repository interface
+        $server = match(true) {
+            $this->servers instanceof ServerRepository => $this->servers->once($name),
+            default => $this->servers->server($name),
+        };
+
         return new PendingServerRegistration(
             $this->router,
-            $this->servers->server($name)
+            $server,
         );
     }
 }

Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@`
`21`	`21`
`22`	`22`	`use Illuminate\Contracts\Routing\Registrar as RegistrarContract;`
`23`	`23`	`use LaravelJsonApi\Contracts\Server\Repository;`
	`24`	`+use LaravelJsonApi\Core\Server\ServerRepository;`
`24`	`25`
`25`	`26`	`class Registrar`
`26`	`27`	`{`
`@@ -55,9 +56,15 @@ public function __construct(RegistrarContract $router, Repository $servers)`
`55`	`56`	`*/`
`56`	`57`	`public function server(string $name): PendingServerRegistration`
`57`	`58`	`{`
	`59`	+ // TODO add the `once` method to the server repository interface
	`60`	`+ $server = match(true) {`
	`61`	`+ $this->servers instanceof ServerRepository => $this->servers->once($name),`
	`62`	`+ default => $this->servers->server($name),`
	`63`	`+ };`
	`64`	`+`
`58`	`65`	`return new PendingServerRegistration(`
`59`	`66`	`$this->router,`
`60`		`- $this->servers->server($name)`
	`67`	`+ $server,`
`61`	`68`	`);`
`62`	`69`	`}`
`63`	`70`	`}`