Registration routes

Adding implementation routes

A Route is bound to a queue and operates on a particular data-type (such as STAC Item, Collection, paths, arbitrary JSON structures).

Backends are also now generic according to its datatype and are now part of the route.

Each route also encapsulates the pre, post, and error handlers.

Example configuration:

routes:
  items:
    path: registrar.route.stac.ItemRoute
    queue: register
    output_queue: next_queue
    backends:
      - path: registrar.backend.eoxserver.ItemBackend
        kwargs:
          instance_base_path: /some/dir
          instance_name: name

    handlers:
      pre:
        - path: some.pre.handler
      post:
        - path: some.post.handler
      error:
        - path: some.error.handler

  collections:
    path: registrar.route.stac.CollectionRoute
    queue: register-collections
    backends:
      - path: registrar.backend.eoxserver.CollectionBackend

  path:
    path: registrar.route.path.PathRoute
    queue: register-paths
    backends:
      - path: some.path.backend

sources: [...]

This is how a STAC Item route can be implemented:

import json
import pystac

class ItemRoute(Route[pystac.Item]):
    """A route implementation for STAC Items"""

    def parse(self, raw: str) -> pystac.Item:
        return pystac.Item.from_dict(json.loads(raw))

    def get_source(
        self, source_cfgs: List[SourceConfig], item: pystac.Item
    ) -> Optional[Source]:
        return get_source(
            source_cfgs, [asset.href for asset in item.assets.values()]
        )

This is how the Backend interface can be satisfied:

from pystac import Item

# ...

class MyItemBackend(Backend[Item]):
    def exists(self, source: Optional[Source], item: Item) -> bool:
        ...

    def register(self, source: Optional[Source], item: Item, replace: bool):
        ...

    def deregister(self, source: Optional[Source], item: Item):
        ...

    def deregister_identifier(self, identifier: str):
        ...

Method implementation does not check the Source, just existence of Product. Maybe not directly connected to the behavior that the PR introduced, but function description/input parameters are misleading against what it does.

There is an abstract base class protocol to be satisfied here. We need the Source as input in registration, and I included it here for vague reasons to mirror the register/deregister API. Probably unnecessary.

None of the methods of this file is used anywhere in the registrar. Maybe it can be also deleted or is this used downstream?

Right, this file is pretty much unused, I think.

added 15 commits

• 4ec3921a...fa3ec505 - 13 commits from branch main
• 09ca05e4 - Merge branch 'main' into routes
• 72b44ea0 - Fixing command context instance

Compare with previous version

added 1 commit

• 255278c3 - Fixing registrar CLI

Compare with previous version

added 1 commit

• 16168737 - Fixing deregister invocation

Compare with previous version

Consider: #19 (closed)

mentioned in issue #20 (moved)

added 2 commits

• 0346d6fc - Adding `error_queue`
• 0186e0d3 - Make EOxServer ItemBackend conformant to the new ABC

Compare with previous version

added 1 commit

• d47f4a3c - Updating registrar chart for new schema

Compare with previous version

added 1 commit

• b43ebe7c - Adding configuration example

Compare with previous version

added 1 commit

• 09dbe62b - Updating config schema and sample config

Compare with previous version

marked this merge request as ready

mentioned in commit 6cf3821f

merged