split OGC Features and Tiles endpoints factories #32

vincentsarago · 2023-02-28T08:44:16Z

closes #6

This PR split the endpoint factory in two: OGCFeaturesFactory and OGCTilesFactory which should enable user to build either the tiles service or features service individually.

The main issue is for creating the OGC features landing and conformances endpoints. I've added two ways:

within the OGCFeaturesFactory, by using the full=True option, this will add the / (landing) and /conformance endpoints but only referencing the features endpoint (no links to the Tiles endpoints).

from tipg.factory import OGCFeaturesFactory
from fastapi import FastAPI

app = FastAPI(
    openapi_url="/api",
    docs_url="/api.html",
)
features = OGCFeaturesFactory(full=True)
app.include_router(features, tags=["OGC Features API"])

in main.py, to have both tiles and features endpoints conformances and links. It is likely that a user who will want to add both / (landing), /conformance with tiles and features endpoints in it's own application will have to re-write both endpoints in its code 🤷‍♂️

IMO it's really annoying that both / and /conformance are part of the features specification 😬

vincentsarago · 2023-02-28T08:44:51Z

tipg/factory.py

+            "urlpath": str(request.url.path),
+            "urlparams": str(request.url.query),
+        },
+    )


we create a simple function that can be used outside the factories

vincentsarago · 2023-02-28T08:45:49Z

tipg/factory.py

+    @abc.abstractmethod
+    def conforms_to(self) -> List[str]:
+        """Endpoints conformances."""
+        ...


each Factory should explicitly tell what they are conform to

tipg/factory.py

vincentsarago · 2023-03-01T10:09:13Z

@bitner any of this make sense? 😄

vincentsarago · 2023-03-01T10:09:54Z

tipg/main.py

+app.include_router(ogc_features.router, tags=["OGC Features API"])
+
+ogc_tiles = OGCTilesFactory(templates=templates)
+app.include_router(ogc_tiles.router, tags=["OGC Tiles API"])


We create the endpoints using the 2 factories

tipg/main.py

vincentsarago · 2023-03-14T09:31:58Z

latest version of FastAPI/starlette changed something in url_for encode/starlette#2050 which breaks tipg (and other project where I use url_path_for 😬 ) 🤷

vincentsarago · 2023-03-15T08:57:23Z

tipg/factory.py

+    supported_tms: TileMatrixSets = default_tms
+
+    ogc_features: OGCFeaturesFactory = field(init=False)
+    ogc_tiles: OGCTilesFactory = field(init=False)


This factory combines both OGCFeaturesFactory and OGCTilesFactory factories.

tipg/factory.py

vincentsarago · 2023-03-15T18:19:36Z

tipg/factory.py

+        """Register factory Routes."""
+        ...
+
+    def register_common_routes(self):


this can will be reused in the 3 factories if with_common=True is set

vincentsarago · 2023-03-15T18:20:43Z

tipg/factory.py

-                )
-
-            return data
+        self.router.include_router(self.ogc_features.router, tags=["OGC Features API"])


we now use include_router method (without the prefix)

vincentsarago · 2023-03-15T18:21:17Z

tipg/factory.py

-                )
-
-            return data
+        self.router.include_router(self.ogc_tiles.router, tags=["OGC Tiles API"])


-160 lines 💥

vincentsarago · 2023-03-15T18:22:33Z

last commit refactored a bit how we add the OGC common endpoints. It's now defined at the base class level.

To Do

add tests for each Factory

vincentsarago · 2023-03-16T12:49:34Z

@bitner this is ready 🙏

bitner · 2023-03-16T14:12:42Z

tipg/factory.py

+        ]
+
+    def register_routes(self):  # noqa: C901
+        """Register OGC Features endpoints."""


"""Register OGC Tiles endpoints.""" ???

tipg/factory.py

split OGC Features and Tiles endpoints factories

c8aea34

vincentsarago commented Feb 28, 2023

View reviewed changes

tipg/factory.py Show resolved Hide resolved

vincentsarago commented Mar 1, 2023

View reviewed changes

tipg/main.py Outdated Show resolved Hide resolved

update isort

92139ca

This comment was marked as resolved.

Sign in to view

bitner self-requested a review March 14, 2023 13:20

vincentsarago added 3 commits March 15, 2023 09:19

fix URL type after starlette update

990c40e

add Main Factory

966e1b3

name -> title

571130f

vincentsarago commented Mar 15, 2023

View reviewed changes

tipg/factory.py Outdated Show resolved Hide resolved

vincentsarago commented Mar 15, 2023

View reviewed changes

tipg/factory.py Outdated Show resolved Hide resolved

add full OGC tiles options + docs

cd5ef52

vincentsarago commented Mar 15, 2023

View reviewed changes

tipg/factory.py Outdated Show resolved Hide resolved

vincentsarago added 2 commits March 15, 2023 17:19

Merge branch 'main' into splitEndpointFactories

f071e09

davids comments

98316f0

vincentsarago commented Mar 15, 2023

View reviewed changes

vincentsarago added 3 commits March 16, 2023 10:22

add factories tests

6992ca0

fix docs

c03d045

docs

fca4d92

bitner reviewed Mar 16, 2023

View reviewed changes

vincentsarago commented Mar 16, 2023

View reviewed changes

tipg/factory.py Outdated Show resolved Hide resolved

Update tipg/factory.py

9599bd5

bitner approved these changes Mar 16, 2023

View reviewed changes

vincentsarago merged commit 69cd3d3 into main Mar 16, 2023

vincentsarago deleted the splitEndpointFactories branch March 16, 2023 14:19

vincentsarago mentioned this pull request Mar 22, 2023

Links inference #45

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

split OGC Features and Tiles endpoints factories #32

split OGC Features and Tiles endpoints factories #32

vincentsarago commented Feb 28, 2023 •

edited

Loading

vincentsarago Feb 28, 2023

vincentsarago Feb 28, 2023

vincentsarago commented Mar 1, 2023

vincentsarago Mar 1, 2023

vincentsarago commented Mar 14, 2023 •

edited

Loading

This comment was marked as resolved.

vincentsarago Mar 15, 2023

vincentsarago Mar 15, 2023

vincentsarago Mar 15, 2023

vincentsarago Mar 15, 2023

vincentsarago commented Mar 15, 2023 •

edited

Loading

vincentsarago commented Mar 16, 2023

bitner Mar 16, 2023

vincentsarago Mar 16, 2023

split OGC Features and Tiles endpoints factories #32

split OGC Features and Tiles endpoints factories #32

Conversation

vincentsarago commented Feb 28, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vincentsarago commented Mar 1, 2023

Choose a reason for hiding this comment

vincentsarago commented Mar 14, 2023 • edited Loading

This comment was marked as resolved.

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vincentsarago commented Mar 15, 2023 • edited Loading

To Do

vincentsarago commented Mar 16, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

vincentsarago commented Feb 28, 2023 •

edited

Loading

vincentsarago commented Mar 14, 2023 •

edited

Loading

vincentsarago commented Mar 15, 2023 •

edited

Loading