Add filter extension #165

rsmith013 · 2021-06-30T09:04:27Z

Adding filter extension. Also making changes to other extensions to make it easier to dynamically build the conformance classes from the implemented extensions.

…t they can be picked up dynamically in the core client for exposing the server conformance classes.

…o modified to use a string to avoid having to import the Extension classes.

…nto add-filter-extension

stac_fastapi/extensions/stac_fastapi/extensions/core/filter.py

geospatial-jeff · 2021-07-03T20:05:48Z

stac_fastapi/extensions/stac_fastapi/extensions/core/fields.py

@@ -37,6 +38,10 @@ class FieldsExtension(ApiExtension):
        )
    )

+    conformance_classes: List[str] = attr.ib(


These should be class variables, as they won't change between instances of the class.

While that is true in most cases, it is not in all. The filter extension is a good example. As the filter extension is complex, there are varying degrees of implementation. There is a base level to be compliant but then there are other conformance classes that are optional and implementation-specific. Having these as instance variables allows the implementor to specify which classes their implementation conforms to.

https://github.com/radiantearth/stac-api-spec/tree/master/fragments/filter#conformance-classes

geospatial-jeff · 2021-07-03T20:06:29Z

stac_fastapi/sqlalchemy/stac_fastapi/sqlalchemy/core.py

@@ -89,7 +88,7 @@ def item_collection(
                .order_by(self.item_table.datetime.desc(), self.item_table.id)
            )
            count = None
-            if self.extension_is_enabled(ContextExtension):
+            if self.extension_is_enabled("ContextExtension"):


What's the reasoning behind this change?

This change links somewhat to the thinking which spawned #178. It would be really good to try and un-bake the extensions from the core client. The reasoning behind this change is to remove the need to import the Extension classes to check if the extension is active. The client instance has the Extension instances passed to it at runtime so I changed the is_extension_enabled method to enable simple name checking https://github.com/rsmith013/stac-fastapi/blob/247098fbb28345096080ea161158ce4461868abb/stac_fastapi/types/stac_fastapi/types/core.py#L127

geospatial-jeff · 2021-07-03T20:07:58Z

stac_fastapi/types/stac_fastapi/types/core.py

+
+    def list_conformance_classes(self):
+        """Return a list of conformance classes, including implemented extensions."""
+        base_conformance = [


I believe this is the set of conformance classes we want to use #159

yes, these are the old conformance classes here. #159 has the most up to date ones.

presumably we are on beta2 now.

e.g. https://api.stacspec.org/v1.0.0-beta.2/core

Correct, beta.2

geospatial-jeff · 2021-07-03T20:09:01Z

This also closes #159 by adding conformance classes to the landing page.

philvarner · 2021-07-05T20:27:17Z

stac_fastapi/extensions/stac_fastapi/extensions/core/filter.py

+    conformance_classes: List[str] = attr.ib(
+        default=[
+            "https://api.stacspec.org/v1.0.0-beta.2/item-search#filter",
+            "https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:simple-cql",


FYI, these are about to change. radiantearth/stac-api-spec#163

Have changed the conformance classes to:

default=[ "https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:basic-cql", "https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:item-search-filter", "https://api.stacspec.org/v1.0.0-beta.2/item-search#filter:cql-text", ]

this was my interpretation of the PR where the basic spatial and temporal operators were recommended. I added cql-text as default, as item-search must implement GET search. It would follow that the base implementation of the filters extension would also be a GET operation using cql-text

Sorry, I was actually just trying to let you know that they were going to change for beta.3. For beta.2, it should still use simple-cql

oh, ok. will revert.

…tac-fastapi into add-filter-extension

philvarner · 2021-07-06T20:25:42Z

stac_fastapi/types/stac_fastapi/types/core.py

@@ -141,6 +157,7 @@ def landing_page(self, **kwargs) -> LandingPage:
            id=self.landing_page_id,
            title=self.title,
            description=self.description,
+            conformsTo=self.list_conformance_classes(),


This looks like it will fix #169

@rsmith013 I thought this would fix #169, but when I ran this using docker-compose from your branch, the landing page conformsTo is still empty. maybe i'm not running it right? This is a pretty major bug in stac-fastapi, so I just wanted to make sure it gets fixed. Do you see conformsTo in the landing page when you run it locally?

philvarner · 2021-07-08T14:15:46Z

Thanks for checking! I realized later that my venv somehow had the stac-fastapi packages installed in it, so I think those were being used instead of the source.

…

On Thu, Jul 8, 2021 at 4:03 AM Richard Smith ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In stac_fastapi/types/stac_fastapi/types/core.py <#165 (comment)> : > @@ -141,6 +157,7 @@ def landing_page(self, **kwargs) -> LandingPage: id=self.landing_page_id, title=self.title, description=self.description, + conformsTo=self.list_conformance_classes(), yes: [image: image] <https://user-images.githubusercontent.com/22395703/124885448-2c542800-dfcb-11eb-87d7-9f463f056c1d.png> — You are receiving this because you commented. Reply to this email directly, view it on GitHub <#165 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAA6QRFVJYK6TG4DHZFV2P3TWVLT7ANCNFSM47R4KB5Q> .

lossyrob · 2021-07-25T15:35:58Z

Making sure I understand - this PR adds a filter extension that implements the queryables routes, but does not implement any of CQL "filter" property on the Search object, correct? So it's up to backends to implement the actual CQL filtering, but this PR adds the necessary top level routes that are added by the extension? If I'm getting that correct, this seems like a good change that will set up the next stage of work which is to add CQL support to the pgstac and sqlalchemy backends.

@rsmith013 Can you merge in the latest master, and I'll take a closer look next week? Thanks!

…ork. Modified async classes to use name based extension matching. Matching base core client.

rsmith013 · 2021-07-26T11:38:52Z

@lossyrob Yes, that was the plan.

lossyrob · 2021-07-26T21:36:16Z

Looking good; going to leave this off of the 2.0.0 release because there's a TODO around implementing the Async core client.

…nto add-filter-extension

rsmith013 · 2021-07-27T13:55:39Z

@lossyrob I didn't realise you were that close to a release. Added the Async base and merged master. Should be good to go

lossyrob · 2021-07-27T14:07:58Z

Thanks! We decided to pop one off since it had been so long. Let use kick the tires for the CI-based publishing as well. There's a few issues so I'm sure we're going to have to fix up soon so I'm expecting a 2.1 release in the next week or so

moradology · 2021-08-10T15:20:25Z

PR #214 ought to address conformance (issue #169) if you want to pull that behavior from here as mentioned in #207

…ilter-extension

rsmith013 added 6 commits June 29, 2021 15:32

first pass at adding filter extension

324c115

Fixing implementation. Added conformance classes to extensions so tha…

3b21ee7

…t they can be picked up dynamically in the core client for exposing the server conformance classes.

implemented queryables endpoints in collections and landing page. Als…

f38360e

…o modified to use a string to avoid having to import the Extension classes.

Merge branch 'master' of https://github.com/stac-utils/stac-fastapi i…

399fc02

…nto add-filter-extension

removing unused import and fixing pre-commit errors

9b8478d

fixing pre-commit errors

3af8d20

matprov reviewed Jun 30, 2021

View reviewed changes

stac_fastapi/extensions/stac_fastapi/extensions/core/filter.py Outdated Show resolved Hide resolved

Richard Smith added 2 commits July 1, 2021 10:15

Update filter.py

1645307

Merge branch 'master' into add-filter-extension

247098f

geospatial-jeff reviewed Jul 3, 2021

View reviewed changes

philvarner reviewed Jul 5, 2021

View reviewed changes

rsmith013 added 2 commits July 6, 2021 09:23

updated base conformance classes

212781f

Merge branch 'add-filter-extension' of https://github.com/rsmith013/s…

1f31da2

…tac-fastapi into add-filter-extension

rsmith013 force-pushed the add-filter-extension branch from 89052c7 to 1f31da2 Compare July 6, 2021 16:47

Merge branch 'master' into add-filter-extension

a3324d3

philvarner reviewed Jul 6, 2021

View reviewed changes

Merge branch 'master' into add-filter-extension

6f1a995

rsmith013 added 2 commits July 26, 2021 12:06

merging master

3989ce0

refactoring structure of filter extension to make use of async framew…

eec6e90

…ork. Modified async classes to use name based extension matching. Matching base core client.

rsmith013 added 2 commits July 27, 2021 14:49

added async BaseFiltersClient

def82b1

Merge branch 'master' of https://github.com/stac-utils/stac-fastapi i…

4f1bdb6

…nto add-filter-extension

geospatial-jeff mentioned this pull request Aug 7, 2021

Enable context extension for Search operations - search support for common STAC clients #207

Closed

Merge branch 'master' into add-filter-extension

0095fd9

lossyrob mentioned this pull request Aug 12, 2021

Enable conformance class configuration #214

Merged

lossyrob added 6 commits August 18, 2021 17:15

Merge remote-tracking branch 'origin/master' into add-filter-extension

e2d49c5

Merge branch 'master' into add-filter-extension

cbcf04a

Merge remote-tracking branch 'origin/master' into add-filter-extension

6dea64c

Merge remote-tracking branch 'rsmith/add-filter-extension' into add-f…

8fe1283

…ilter-extension

client is union of async and base client; add default value

025b31f

Uncomment async endpoint logic

ddc7cb1

lossyrob approved these changes Aug 18, 2021

View reviewed changes

lossyrob merged commit e590e75 into stac-utils:master Aug 18, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add filter extension #165

Add filter extension #165

rsmith013 commented Jun 30, 2021 •

edited

Loading

geospatial-jeff Jul 3, 2021

rsmith013 Jul 6, 2021

geospatial-jeff Jul 3, 2021

rsmith013 Jul 5, 2021

geospatial-jeff Jul 3, 2021

philvarner Jul 5, 2021

rsmith013 Jul 6, 2021 •

edited

Loading

philvarner Jul 6, 2021 •

edited

Loading

geospatial-jeff commented Jul 3, 2021

philvarner Jul 5, 2021

rsmith013 Jul 6, 2021

philvarner Jul 6, 2021

rsmith013 Jul 6, 2021

philvarner Jul 6, 2021

philvarner Jul 7, 2021

rsmith013 Jul 8, 2021

philvarner commented Jul 8, 2021 via email

lossyrob commented Jul 25, 2021

rsmith013 commented Jul 26, 2021

lossyrob commented Jul 26, 2021

rsmith013 commented Jul 27, 2021

lossyrob commented Jul 27, 2021

moradology commented Aug 10, 2021

Add filter extension #165

Add filter extension #165

Conversation

rsmith013 commented Jun 30, 2021 • edited Loading

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rsmith013 Jul 6, 2021 • edited Loading

Choose a reason for hiding this comment

philvarner Jul 6, 2021 • edited Loading

Choose a reason for hiding this comment

geospatial-jeff commented Jul 3, 2021

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

philvarner commented Jul 8, 2021 via email

lossyrob commented Jul 25, 2021

rsmith013 commented Jul 26, 2021

lossyrob commented Jul 26, 2021

rsmith013 commented Jul 27, 2021

lossyrob commented Jul 27, 2021

moradology commented Aug 10, 2021

rsmith013 commented Jun 30, 2021 •

edited

Loading

rsmith013 Jul 6, 2021 •

edited

Loading

philvarner Jul 6, 2021 •

edited

Loading