Minor updates after review

ci: update optimade-validator-action

Revert "ci: update optimade-validator-action"

This reverts commit 92fd22d.

Unpin validator-action

Promote pyyaml back to core dep

Update optimade/server/config.py

Co-authored-by: Matthew Evans <git@ml-evs.science>

Update optimade/server/create_app.py

Co-authored-by: Matthew Evans <git@ml-evs.science>

Update optimade/server/create_app.py

Co-authored-by: Matthew Evans <git@ml-evs.science>

dont import elasticsearch; tiny fix

rm unused variable

store base_resource_mapper in app.state

restore CONFIG.validate_api_response

restore config.debug tests

Author: eimrek

.github/workflows/ci.yml

@@ -94,8 +94,7 @@ jobs:
         sleep 15
 
     - name: Test server, including OPTIONAL base URLs
-      # Pin validator action until merge of Materials-Consortia/optimade-validator-action#175
-      uses: Materials-Consortia/optimade-validator-action@dc4a7b6a83da42e5341a1a401e36d83375550fb7
+      uses: Materials-Consortia/optimade-validator-action@v2
       with:
         port: 3213
         path: /
@@ -109,8 +108,7 @@ jobs:
         sleep 15
 
     - name: Test index server, including OPTIONAL base URLs
-      # Pin validator action until merge of Materials-Consortia/optimade-validator-action#175
-      uses: Materials-Consortia/optimade-validator-action@dc4a7b6a83da42e5341a1a401e36d83375550fb7
+      uses: Materials-Consortia/optimade-validator-action@v2
       with:
         port: 3214
         path: /

optimade/server/config.py

@@ -597,10 +597,3 @@ def settings_customise_sources(
             ConfigFileSettingsSource(settings_cls),
             file_secret_settings,
         )
-
-
-# CONFIG: ServerConfig = ServerConfig()
-"""This singleton loads the config from a hierarchy of sources (see
-[`customise_sources`][optimade.server.config.ServerConfig.settings_customise_sources])
-and makes it importable in the server code.
-"""

optimade/server/create_app.py

@@ -1,11 +1,3 @@
-"""The OPTIMADE server
-
-The server is based on MongoDB, using either `pymongo` or `mongomock`.
-
-This is an example implementation with example data.
-To implement your own server see the documentation at https://optimade.org/optimade-python-tools.
-"""
-
 import json
 import os
 import warnings
@@ -24,6 +16,7 @@
 from optimade.server.entry_collections import EntryCollection, create_entry_collections
 from optimade.server.exception_handlers import OPTIMADE_EXCEPTIONS
 from optimade.server.logger import LOGGER
+from optimade.server.mappers.entries import BaseResourceMapper
 from optimade.server.middleware import OPTIMADE_MIDDLEWARE
 from optimade.server.routers import (
     index_info,
@@ -179,13 +172,6 @@ def insert_index_data(
         )
 
 
-DESCRIPTION_TEMPLATE = """
-The [Open Databases Integration for Materials Design (OPTIMADE) consortium](https://www.optimade.org/) aims to make materials databases interoperational by developing a common REST API.
-{index_meta_text}
-This specification is generated using [`optimade-python-tools`](https://github.com/Materials-Consortia/optimade-python-tools/tree/v{version}) v{version}.
-"""
-
-
 def create_app(config: ServerConfig | None = None, index: bool = False) -> FastAPI:
     if config_warnings:
         LOGGER.warning(
@@ -231,6 +217,9 @@ def create_app(config: ServerConfig | None = None, index: bool = False) -> FastA
     entry_collections = create_entry_collections(config)
     app.state.entry_collections = entry_collections
 
+    # store also the BaseResourceMapper
+    app.state.base_resource_mapper = BaseResourceMapper()
+
     if not index:
         if config.insert_test_data or config.insert_from_jsonl:
             insert_main_data(config, entry_collections)

optimade/server/entry_collections/elasticsearch.py

@@ -1,9 +1,10 @@
 import json
 from collections.abc import Iterable
 from pathlib import Path
-from typing import Any, Optional
+from typing import TYPE_CHECKING, Any, Optional
 
-from elasticsearch import Elasticsearch
+if TYPE_CHECKING:
+    from elasticsearch import Elasticsearch
 
 from optimade.filtertransformers.elasticsearch import ElasticTransformer
 from optimade.models import EntryResource
@@ -14,6 +15,8 @@
 
 
 def get_elastic_client(config: ServerConfig) -> Optional["Elasticsearch"]:
+    from elasticsearch import Elasticsearch
+
     if config.database_backend.value == "elastic":
         LOGGER.info("Using: Elasticsearch backend at %s", config.elastic_hosts)
         return Elasticsearch(hosts=config.elastic_hosts)

optimade/server/mappers/entries.py

@@ -6,12 +6,6 @@
 from optimade.models.entries import EntryResource
 from optimade.server.config import ServerConfig
 
-# A number that approximately tracks the number of types with mappers
-# so that the global caches can be set to the correct size.
-# See https://github.com/Materials-Consortia/optimade-python-tools/issues/1434
-# for the details.
-NUM_ENTRY_TYPES = 4
-
 __all__ = ("BaseResourceMapper",)
 
 

optimade/server/query_params.py

@@ -23,7 +23,9 @@ class BaseQueryParams(ABC):
 
     unsupported_params: list[str] = []
 
-    def check_params(self, query_params: Iterable[str]) -> None:
+    def check_params(
+        self, query_params: Iterable[str], base_resource_mapper: BaseResourceMapper
+    ) -> None:
         """This method checks whether all the query parameters that are specified
         in the URL string are implemented in the relevant `*QueryParams` class.
 
@@ -57,9 +59,9 @@ def check_params(self, query_params: Iterable[str]) -> None:
                 split_param = param.split("_")
                 if param.startswith("_") and len(split_param) > 2:
                     prefix = split_param[1]
-                    if prefix in BaseResourceMapper().SUPPORTED_PREFIXES:
+                    if prefix in base_resource_mapper.SUPPORTED_PREFIXES:
                         errors.append(param)
-                    elif prefix not in BaseResourceMapper().KNOWN_PROVIDER_PREFIXES:
+                    elif prefix not in base_resource_mapper.KNOWN_PROVIDER_PREFIXES:
                         warnings.append(param)
                 else:
                     errors.append(param)

optimade/server/routers/links.py

@@ -3,26 +3,26 @@
 from fastapi import APIRouter, Depends, Request
 
 from optimade.models import LinksResponse
+from optimade.server.config import ServerConfig
 from optimade.server.query_params import EntryListingQueryParams
 from optimade.server.routers.utils import get_entries
 from optimade.server.schemas import ERROR_RESPONSES
 
 router = APIRouter(redirect_slashes=True)
 
+CONFIG = ServerConfig()
+
 
 @router.get(
     "/links",
-    response_model=LinksResponse,
+    response_model=LinksResponse if CONFIG.validate_api_response else dict,
     response_model_exclude_unset=True,
     tags=["Links"],
     responses=ERROR_RESPONSES,
 )
 def get_links(
     request: Request, params: Annotated[EntryListingQueryParams, Depends()]
 ) -> dict[str, Any]:
-    config = request.app.state.config
     links_coll = request.app.state.entry_collections.get("links")
 
-    return get_entries(
-        config=config, collection=links_coll, request=request, params=params
-    )
+    return get_entries(collection=links_coll, request=request, params=params)

optimade/server/routers/references.py

@@ -6,27 +6,30 @@
     ReferenceResponseMany,
     ReferenceResponseOne,
 )
+from optimade.server.config import ServerConfig
 from optimade.server.query_params import EntryListingQueryParams, SingleEntryQueryParams
 from optimade.server.routers.utils import get_entries, get_single_entry
 from optimade.server.schemas import ERROR_RESPONSES
 
 router = APIRouter(redirect_slashes=True)
 
+CONFIG = ServerConfig()
+
 
 @router.get(
     "/references",
-    response_model=ReferenceResponseMany,
+    response_model=ReferenceResponseMany
+    if CONFIG.validate_api_response
+    else dict[str, Any],
     response_model_exclude_unset=True,
     tags=["References"],
     responses=ERROR_RESPONSES,
 )
 def get_references(
     request: Request, params: Annotated[EntryListingQueryParams, Depends()]
 ) -> dict[str, Any]:
-    config = request.app.state.config
     references_coll = request.app.state.entry_collections.get("references")
     return get_entries(
-        config=config,
         collection=references_coll,
         request=request,
         params=params,
@@ -35,7 +38,9 @@ def get_references(
 
 @router.get(
     "/references/{entry_id:path}",
-    response_model=ReferenceResponseOne,
+    response_model=ReferenceResponseOne
+    if CONFIG.validate_api_response
+    else dict[str, Any],
     response_model_exclude_unset=True,
     tags=["References"],
     responses=ERROR_RESPONSES,
@@ -45,10 +50,8 @@ def get_single_reference(
     entry_id: str,
     params: Annotated[SingleEntryQueryParams, Depends()],
 ) -> dict[str, Any]:
-    config = request.app.state.config
     references_coll = request.app.state.entry_collections.get("references")
     return get_single_entry(
-        config=config,
         collection=references_coll,
         entry_id=entry_id,
         request=request,

optimade/server/routers/structures.py

@@ -6,27 +6,30 @@
     StructureResponseMany,
     StructureResponseOne,
 )
+from optimade.server.config import ServerConfig
 from optimade.server.query_params import EntryListingQueryParams, SingleEntryQueryParams
 from optimade.server.routers.utils import get_entries, get_single_entry
 from optimade.server.schemas import ERROR_RESPONSES
 
 router = APIRouter(redirect_slashes=True)
 
+CONFIG = ServerConfig()
+
 
 @router.get(
     "/structures",
-    response_model=StructureResponseMany,
+    response_model=StructureResponseMany
+    if CONFIG.validate_api_response
+    else dict[str, Any],
     response_model_exclude_unset=True,
     tags=["Structures"],
     responses=ERROR_RESPONSES,
 )
 def get_structures(
     request: Request, params: Annotated[EntryListingQueryParams, Depends()]
 ) -> dict[str, Any]:
-    config = request.app.state.config
     structures_coll = request.app.state.entry_collections.get("structures")
     return get_entries(
-        config=config,
         collection=structures_coll,
         request=request,
         params=params,
@@ -35,7 +38,9 @@ def get_structures(
 
 @router.get(
     "/structures/{entry_id:path}",
-    response_model=StructureResponseOne,
+    response_model=StructureResponseOne
+    if CONFIG.validate_api_response
+    else dict[str, Any],
     response_model_exclude_unset=True,
     tags=["Structures"],
     responses=ERROR_RESPONSES,
@@ -45,10 +50,8 @@ def get_single_structure(
     entry_id: str,
     params: Annotated[SingleEntryQueryParams, Depends()],
 ) -> dict[str, Any]:
-    config = request.app.state.config
     structures_coll = request.app.state.entry_collections.get("structures")
     return get_single_entry(
-        config=config,
         collection=structures_coll,
         entry_id=entry_id,
         request=request,

optimade/server/routers/utils.py

@@ -249,16 +249,17 @@ def get_base_url(
 
 
 def get_entries(
-    config: ServerConfig,
     collection: EntryCollection,
     request: Request,
     params: EntryListingQueryParams,
 ) -> dict[str, Any]:
     """Generalized /{entry} endpoint getter"""
 
+    config = request.app.state.config
     entry_collections = request.app.state.entry_collections
+    base_resource_mapper = request.app.state.base_resource_mapper
 
-    params.check_params(request.query_params)
+    params.check_params(request.query_params, base_resource_mapper)
     (
         results,
         data_returned,
@@ -313,15 +314,16 @@ def get_entries(
 
 
 def get_single_entry(
-    config: ServerConfig,
     collection: EntryCollection,
     entry_id: str,
     request: Request,
     params: SingleEntryQueryParams,
 ) -> dict[str, Any]:
+    config = request.app.state.config
     entry_collections = request.app.state.entry_collections
+    base_resource_mapper = request.app.state.base_resource_mapper
 
-    params.check_params(request.query_params)
+    params.check_params(request.query_params, base_resource_mapper)
     params.filter = f'id="{entry_id}"'  # type: ignore[attr-defined]
     (
         results,