[2.3.0] More identification middleware (#323)

* Added request data identification middleware (#207)

* Added request data identification middleware

* Fixed styling

* Changed to Illuminate request instead of helper

* Enabled header and querystring customisation

Co-authored-by: Jesper Jacobsen <joj@webshipper.com>

* Apply fixes from StyleCI

* Use constructor parameter instead of config

* Add tests

* Apply fixes from StyleCI

Co-authored-by: JapSeyz <JapSeyz@JapSeyz.com>
Co-authored-by: Jesper Jacobsen <joj@webshipper.com>

src/Middleware/InitializeTenancyByRequestData.php

@@ -0,0 +1,70 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Middleware;
+
+use Closure;
+use Illuminate\Http\Request;
+use Stancl\Tenancy\Exceptions\TenantCouldNotBeIdentifiedException;
+
+class InitializeTenancyByRequestData
+{
+    /** @var string|null */
+    protected $header;
+
+    /** @var string|null */
+    protected $queryParameter;
+
+    /** @var callable */
+    protected $onFail;
+
+    public function __construct(?string $header = 'X-Tenant', ?string $queryParameter = 'tenant', callable $onFail = null)
+    {
+        $this->header = $header;
+        $this->queryParameter = $queryParameter;
+        $this->onFail = $onFail ?? function ($e) {
+            throw $e;
+        };
+    }
+
+    /**
+     * Handle an incoming request.
+     *
+     * @param  \Illuminate\Http\Request  $request
+     * @param  \Closure  $next
+     * @return mixed
+     */
+    public function handle($request, Closure $next)
+    {
+        if ($request->method() !== 'OPTIONS') {
+            try {
+                $this->initializeTenancy($request);
+            } catch (TenantCouldNotBeIdentifiedException $e) {
+                ($this->onFail)($e);
+            }
+        }
+
+        return $next($request);
+    }
+
+    protected function initializeTenancy(Request $request)
+    {
+        if (tenancy()->initialized) {
+            return;
+        }
+
+        $tenant = null;
+        if ($this->header && $request->hasHeader($this->header)) {
+            $tenant = $request->header($this->header);
+        } elseif ($this->queryParameter && $request->has($this->queryParameter)) {
+            $tenant = $request->get($this->queryParameter);
+        }
+
+        if (! $tenant) {
+            throw new TenantCouldNotBeIdentifiedException($request->getHost());
+        }
+
+        tenancy()->initialize(tenancy()->find($tenant));
+    }
+}

tests/RequestDataIdentificationTest.php

@@ -0,0 +1,62 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Stancl\Tenancy\Tests;
+
+use Illuminate\Support\Facades\Route;
+use Stancl\Tenancy\Middleware\InitializeTenancyByRequestData;
+use Stancl\Tenancy\Tenant;
+
+class RequestDataIdentificationTest extends TestCase
+{
+    public $autoCreateTenant = false;
+    public $autoInitTenancy = false;
+
+    public function setUp(): void
+    {
+        parent::setUp();
+
+        config([
+            'tenancy.exempt_domains' => [
+                'localhost',
+            ],
+        ]);
+
+        Route::middleware(InitializeTenancyByRequestData::class)->get('/test', function () {
+            return 'Tenant id: ' . tenant('id');
+        });
+    }
+
+    /** @test */
+    public function header_identification_works()
+    {
+        $this->app->bind(InitializeTenancyByRequestData::class, function () {
+            return new InitializeTenancyByRequestData('X-Tenant');
+        });
+        $tenant = Tenant::new()->save();
+        $tenant2 = Tenant::new()->save();
+
+        $this
+            ->withoutExceptionHandling()
+            ->get('test', [
+                'X-Tenant' => $tenant->id,
+            ])
+            ->assertSee($tenant->id);
+    }
+
+    /** @test */
+    public function query_parameter_identification_works()
+    {
+        $this->app->bind(InitializeTenancyByRequestData::class, function () {
+            return new InitializeTenancyByRequestData(null, 'tenant');
+        });
+        $tenant = Tenant::new()->save();
+        $tenant2 = Tenant::new()->save();
+
+        $this
+            ->withoutExceptionHandling()
+            ->get('test?tenant=' . $tenant->id)
+            ->assertSee($tenant->id);
+    }
+}