Enable direct response, stac-fastapi 5.2.0, deprecation warnings #359
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jonhealy1
requested review from
jamesfisher-geo,
rhysrevans3,
pedro-cf and
StijnCaerts
|
Hi. If you guys have time to look at this. I am thinking that it would be good to release v4.0.0 after this is merged. Let me know what you think. |
jamesfisher-geo
requested changes
Apr 21, 2025
rhysrevans3
approved these changes
Apr 22, 2025
jonhealy1
added a commit
that referenced
this pull request
Apr 24, 2025
**Description:** **Changes from 3.2.5:** #### Added - Added support for dynamically-generated queryables based on Elasticsearch/OpenSearch mappings, with extensible metadata augmentation [#351](#351) - Included default queryables configuration for seamless integration. [#351](#351) - Added support for high-performance direct response mode for both Elasticsearch and Opensearch backends, controlled by the `ENABLE_DIRECT_RESPONSE` environment variable. When enabled (`ENABLE_DIRECT_RESPONSE=true`), endpoints return Starlette Response objects directly, bypassing FastAPI's jsonable_encoder and Pydantic serialization for significantly improved performance on large search responses. **Note:** In this mode, all FastAPI dependencies (including authentication, custom status codes, and validation) are disabled for all routes. Default is `false` for safety. A warning is logged at startup if enabled. See [issue #347](#347) and [PR #359](#359). - Added robust tests for the `ENABLE_DIRECT_RESPONSE` environment variable, covering both Elasticsearch and OpenSearch backends. Tests gracefully handle missing backends by attempting to import both configs and skipping if neither is available. [#359](#359) #### Changed - Refactored database logic to reduce duplication [#351](#351) - Replaced `fastapi-slim` with `fastapi` dependency [#351](#351) - Changed minimum Python version to 3.9 [#354](#354) - Updated stac-fastapi api, types, and extensions libraries to 5.1.1 from 3.0.0 and made various associated changes [#354](#354) - Changed makefile commands from 'docker-compose' to 'docker compose' [#354](#354) - Updated package names in setup.py files to use underscores instead of periods for PEP 625 compliance [#358](#358) - Changed `stac_fastapi.opensearch` to `stac_fastapi_opensearch` - Changed `stac_fastapi.elasticsearch` to `stac_fastapi_elasticsearch` - Changed `stac_fastapi.core` to `stac_fastapi_core` - Updated all related dependencies to use the new naming convention - Renamed `docker-compose.yml` to `compose.yml` to align with Docker Compose V2 conventions [#358](#358) - Removed deprecated `version` field from all compose files [#358](#358) - Updated `STAC_FASTAPI_VERSION` environment variables to 4.0.0 in all compose files [#362](#362) - Bumped version from 4.0.0a2 to 4.0.0 for the PEP 625 compliant release [#362](#362) - Updated dependency requirements to use compatible release specifiers (~=) for more controlled updates while allowing for bug fixes and security patches [#358](#358) - Removed elasticsearch-dsl dependency as it's now part of the elasticsearch package since version 8.18.0 [#358](#358) - Updated test suite to use `httpx.ASGITransport(app=...)` for FastAPI app testing (removes deprecation warning). [#359](#359) - Updated stac-fastapi parent libraries to 5.2.0. [#359](#359) - Migrated Elasticsearch index template creation from legacy `put_template` to composable `put_index_template` API in `database_logic.py`. This resolves deprecation warnings and ensures compatibility with Elasticsearch 7.x and 8.x. [#359](#359) - Updated all Pydantic models to use `ConfigDict` instead of class-based `Config` for Pydantic v2 compatibility. This resolves deprecation warnings and prepares for Pydantic v3. [#359](#359) - Migrated all Pydantic `@root_validator` validators to `@model_validator` for Pydantic v2 compatibility. [#359](#359) - Migrated startup event handling from deprecated `@app.on_event("startup")` to FastAPI's recommended lifespan context manager. This removes deprecation warnings and ensures compatibility with future FastAPI versions. [#361](#361) - Refactored all boolean environment variable parsing in both Elasticsearch and OpenSearch backends to use the shared `get_bool_env` utility. This ensures robust and consistent handling of environment variables such as `ES_USE_SSL`, `ES_HTTP_COMPRESS`, and `ES_VERIFY_CERTS` across both backends. [#359](#359) #### Fixed - Improved performance of `mk_actions` and `filter-links` methods [#351](#351) - Fixed inheritance relating to BaseDatabaseSettings and ApiBaseSettings [#355](#355) - Fixed delete_item and delete_collection methods return types [#355](#355) - Fixed inheritance relating to DatabaseLogic and BaseDatabaseLogic, and ApiBaseSettings [#355](#355) **PR Checklist:** - [x] Code is formatted and linted (run `pre-commit run --all-files`) - [x] Tests pass (run `make test`) - [x] Documentation has been updated to reflect changes, if applicable - [x] Changes are added to the changelog
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Related Issue(s):
Description:
v4.0.0a2 release
Added
ENABLE_DIRECT_RESPONSEenvironment variable. When enabled (ENABLE_DIRECT_RESPONSE=true), endpoints return Starlette Response objects directly, bypassing FastAPI's jsonable_encoder and Pydantic serialization for significantly improved performance on large search responses. Note: In this mode, all FastAPI dependencies (including authentication, custom status codes, and validation) are disabled for all routes. Default isfalsefor safety. A warning is logged at startup if enabled. See issue #347Changed
httpx.ASGITransport(app=...)for FastAPI app testing (removes deprecation warning).put_templateto composableput_index_templateAPI indatabase_logic.py. This resolves deprecation warnings and ensures compatibility with Elasticsearch 7.x and 8.x.ConfigDictinstead of class-basedConfigfor Pydantic v2 compatibility. This resolves deprecation warnings and prepares for Pydantic v3.@root_validatorvalidators to@model_validatorfor Pydantic v2 compatibility.@app.on_event("startup")to FastAPI's recommended lifespan context manager. This removes deprecation warnings and ensures compatibility with future FastAPI versions.PR Checklist:
pre-commit run --all-files)make test)