Added Endpoint Discovery

Author: mgerzabek

doc/getting-started/endpoint.md

@@ -167,7 +167,7 @@ public function get(string $identifier): Response
         $formula = $mashupDoc->createElement('Formula');
         $formulaContent = $mashupDoc->createCDATASection(sprintf(
             'let Source = OData.Feed("%1$s", null, [Implementation="2.0"]), %2$s_table = Source{[Name="%2$s",Signature="table"]}[Data] in %2$s_table',
-            app(Endpoint::class)->endpoint(),
+            app()->make(Endpoint::class)->endpoint(),
             $resourceId,
         ));
         $formula->appendChild($formulaContent);

src/Controller/ODCFF.php

@@ -44,7 +44,7 @@ public function get(): Response
                     'details' => [
                         'protocol' => 'odata',
                         'address' => [
-                            'url' => app(Endpoint::class)->endpoint(),
+                            'url' => app()->make(Endpoint::class)->endpoint(),
                         ],
                     ],
                 ],

src/Controller/PBIDS.php

@@ -785,7 +785,7 @@ public function getPath(): string
      */
     public function getRequestPath(): string
     {
-        $route = app(Endpoint::class)->route();
+        $route = app()->make(Endpoint::class)->route();
         return Str::substr($this->request->path(), strlen($route));
     }
 
@@ -963,7 +963,7 @@ public function getContextUrl(): string
      */
     public static function getResourceUrl(): string
     {
-        return app(Endpoint::class)->endpoint();
+        return app()->make(Endpoint::class)->endpoint();
     }
 
     /**

src/Controller/Transaction.php

@@ -2,34 +2,39 @@
 
 namespace Flat3\Lodata;
 
-use Flat3\Lodata\Interfaces\ServiceEndpointInterface;
-
-class Endpoint implements ServiceEndpointInterface
+class Endpoint
 {
+    /**
+     * @var string $serviceUri the &lt;service-uri> of the <code>Flat3\Lodata\Model</code>.
+     */
     protected $serviceUri;
 
+    /**
+     * @var string $route the route prefix configured in <code>'lodata.prefix'</code>
+     */
     protected $route;
 
+    /**
+     * @var string $endpoint the full url to the ODataService endpoint
+     */
     protected $endpoint;
 
     public function __construct(string $serviceUri)
     {
-        $this->serviceUri = trim($serviceUri, '/');
+        $this->serviceUri = rtrim($serviceUri, '/');
 
         $prefix = rtrim(config('lodata.prefix'), '/');
-
-        $this->route = ('' === $this->serviceUri)
+        $this->route = ('' === $serviceUri)
             ? $prefix
             : $prefix . '/' . $this->serviceUri;
 
         $this->endpoint = url($this->route) . '/';
     }
 
-    public function serviceUri(): string
-    {
-        return $this->serviceUri;
-    }
-
+    /**
+     * @return string the path within the odata URI space, like in
+     * https://<server>:<port>/<config('lodata.prefix')>/<service-uri>/$metadata
+     */
     public function endpoint(): string
     {
         return $this->endpoint;
@@ -40,18 +45,13 @@ public function route(): string
         return $this->route;
     }
 
-    public function namespace(): string
-    {
-        return config('lodata.namespace');
-    }
-
-    public function cachedMetadataXMLPath(): ?string
-    {
-        return null;
-    }
-
+    /**
+     * Discovers Schema and Annotations of the `$metadata` file for
+     * the service.
+     */
     public function discover(Model $model): Model
     {
+        // override this function to register all of your $metadata capabilities
         return $model;
     }
 }

src/Endpoint.php

@@ -178,7 +178,7 @@ public static function pipe(
         }
 
         $entityId = $id->getValue();
-        $endpoint = app(Endpoint::class)->endpoint();
+        $endpoint = app()->make(Endpoint::class)->endpoint();
         if (Str::startsWith($entityId, $endpoint)) {
             $entityId = Str::substr($entityId, strlen($endpoint));
         }

src/Entity.php

@@ -199,7 +199,7 @@ public function getTypeDefinition(string $name): ?Type
      */
     public static function getNamespace(): string
     {
-        return app(Endpoint::class)->namespace();
+        return config('lodata.namespace');
     }
 
     /**
@@ -344,7 +344,7 @@ public function discover($discoverable): self
      */
     public function getEndpoint(): string
     {
-        return app(Endpoint::class)->endpoint();
+        return app()->make(Endpoint::class)->endpoint();
     }
 
     /**

src/Model.php

@@ -59,7 +59,7 @@ public function emitJson(Transaction $transaction): void
 
             $requestURI = $requestData['url'];
 
-            $endpoint = app(Endpoint::class)->endpoint();
+            $endpoint = app()->make(Endpoint::class)->endpoint();
             switch (true) {
                 case Str::startsWith($requestURI, '/'):
                     $uri = Url::http_build_url(

src/PathSegment/Batch/JSON.php

@@ -409,7 +409,7 @@ public function emitJson(Transaction $transaction): void
 
         $queryObject->tags = [__('lodata::Batch requests')];
 
-        $route = app(Endpoint::class)->route();
+        $route = app()->make(Endpoint::class)->route();
 
         $requestBody = [
             'required' => true,

src/PathSegment/OpenAPI.php

@@ -21,29 +21,14 @@
 
 /**
  * Service Provider
+ *
+ * https://<server>:<port>/<prefix>/<service-uri>/$metadata
+ *
  * @link https://laravel.com/docs/8.x/providers
  * @package Flat3\Lodata
  */
 class ServiceProvider extends \Illuminate\Support\ServiceProvider
 {
-    /**
-     * Get the endpoint of the OData service document
-     * @return string
-     */
-    public static function endpoint(): string
-    {
-        return url(self::route()).'/';
-    }
-
-    /**
-     * Get the configured route prefix
-     * @return string
-     */
-    public static function route(): string
-    {
-        return rtrim(config('lodata.prefix'), '/');
-    }
-
     /**
      * Service provider registration method
      */
@@ -59,14 +44,61 @@ public function boot()
     {
         if ($this->app->runningInConsole()) {
             $this->publishes([__DIR__.'/../config.php' => config_path('lodata.php')], 'config');
+            $this->bootServices(new Endpoint(''));
         }
+        else {
+            // Let’s examine the request path
+            $segments = explode('/', request()->path());
+
+            // we only kick off operation when path prefix is configured in lodata.php
+            // as all requests share the same root configuration
+            if ($segments[0] === config('lodata.prefix')) {
+
+                // next look up the configured service endpoints
+                $serviceUris = config('lodata.endpoints', []);
+
+                $service = null;
+                if (0 === sizeof($serviceUris)) {
+                    // when no locators are defined, fallback to global mode; this will
+                    // ensure compatibility with prior versions of this package
+                    $service = new Endpoint('');
+                }
+                else if (array_key_exists($segments[1], $serviceUris)) {
+                    $clazz = $serviceUris[$segments[1]];
+                    $service = new $clazz($segments[1]);
+                }
+                else {
+                    // when no service definition is configured for the path segment,
+                    // we abort with an error condition; typically a dev working on
+                    // setting up his project
+                    abort('No odata service endpoint defined for path ' . $segments[1]);
+                }
+
+                $this->bootServices($service);
+            }
+        }
+    }
+
+    private function bootServices($service): void
+    {
+        // register the $service, which is a singleton, with the container; this allows us
+        // to fulfill all old ServiceProvider::route() and ServiceProvider::endpoint()
+        // calls with app()->make(ODataService::class)->route() or
+        // app()->make(ODataService::class)->endpoint()
+        $this->app->instance(Endpoint::class, $service);
 
         $this->loadJsonTranslationsFrom(__DIR__.'/../lang');
 
-        $this->app->singleton(Model::class, function () {
-            return new Model();
-        });
+        // next instantiate and discover the global Model
+        $model = $service->discover(new Model());
+        assert($model instanceof Model);
+
+        // and register it with the container
+        $this->app->instance(Model::class, $model);
 
+        // I don't get why you are doing this twice? You never load the model
+        // via app()->make('lodata.model') or app()->make(Model::class). What
+        // am I missing here?
         $this->app->bind('lodata.model', function ($app) {
             return $app->make(Model::class);
         });
@@ -83,7 +115,7 @@ public function boot()
             return version_compare(InstalledVersions::getVersion('doctrine/dbal'), '4.0.0', '>=') ? new DBAL\DBAL4($args['connection']) : new DBAL\DBAL3($args['connection']);
         });
 
-        $route = self::route();
+        $route = $service->route();
         $middleware = config('lodata.middleware', []);
 
         Route::get("{$route}/_lodata/odata.pbids", [PBIDS::class, 'get']);