Prepare 8.0.0 release

Collect the change log for the 8.0.0 release and update the shared Ruff configuration file.
lsst-sqre · Nov 26, 2024 · 20bce3e · 20bce3e
1 parent 7866516
commit 20bce3e
Show file tree

Hide file tree

Showing 11 changed files with 40 additions and 43 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,35 @@ Changes for the upcoming release can be found in [changelog.d](https://github.co
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-8.0.0'></a>
+## 8.0.0 (2024-11-26)
+
+### Backwards-incompatible changes
+
+- Add serializers to `HumanTimedelta` and `SecondsTimedelta` that serialize those Pydantic fields to a float number of seconds instead of ISO 8601 durations. This means those data types now can be round-tripped (serialized and then deserialized to the original value), whereas before they could not be.
+- `parse_isodatetime` and `normalize_isodatetime` now accept exactly the date formats accepted by the IVOA DALI standard. This means seconds are now required, the trailing `Z` is now optional (times are always interpreted as UTC regardless), and the time is optional and interpreted as 00:00:00 if missing.
+
+### New features
+
+- Add new `safir.pydantic.UtcDatetime` type that is equivalent to `datetime` but coerces all incoming times to timezone-aware UTC. This type should be used instead of using `normalize_datetime` as a validator.
+- Add new `safir.pydantic.IvoaIsoDatetime` type that accepts any ISO 8601 date and time that matches the IVOA DALI standard for timestamps. This follows the same rules as `parse_isodatetime` now follows. This type should be used instead of using `normalize_isodatetime` as a validator.
+- Add new `safir.database.PaginatedLinkData` model that parses the contents of an HTTP `Link` header and extracts pagination information.
+- Add `safir.database.drop_database` utility function to drop all database tables mentioned in a SQLAlchemy ORM schema and delete the Alembic version information if it is present. This is primarily useful for tests.
+- Publishing a metrics event no longer waits on confirmation of message delivery to Kafka. This makes publishing much more performant. All events will still be delivered as long as an app awaits `EventManager.aclose` in its lifecycle.
+- `safir.kafka.PydanticSchemaManager` takes an optional structlog `BoundLogger`. If not provided, the default logger is a `BoundLogger`, rather than a `logging.Logger`.
+- Pass the `logger` parameter to `safir.metrics.KafkaMetricsConfiguration.make_manager` to the `PydanticSchemaManager` instance that it creates.
+- Add `CaseInsensitiveFormMiddleware` to lower-case the keys of form `POST` parameters. This can be used to support the case-insensitive keys requirement of IVOA standards.
+
+### Bug fixes
+
+- Correctly validate stringified floating-point numbers of seconds as inputs to the `SecondsTimedelta` type instead of truncating it to an integer.
+- Allow `timedelta` as a member of a union field in a `safir.metrics.EventPayload`.
+- Add missing dependency on alembic to the `safir[uws]` extra.
+
+### Other changes
+
+- Document how to test an application's database schema against its Alembic migrations to ensure that the schema hasn't been modified without adding a corresponding migration.
+
 <a id='changelog-7.0.0'></a>
 ## 7.0.0 (2024-11-08)
 

diff --git a/changelog.d/20241112_163814_rra_DM_47262.md b/changelog.d/20241112_163814_rra_DM_47262.md
diff --git a/changelog.d/20241113_152723_rra_DM_47262a.md b/changelog.d/20241113_152723_rra_DM_47262a.md
diff --git a/changelog.d/20241113_165421_rra_DM_47262b.md b/changelog.d/20241113_165421_rra_DM_47262b.md
diff --git a/changelog.d/20241119_132629_danfuchs_fix_metrics_timedelta.md b/changelog.d/20241119_132629_danfuchs_fix_metrics_timedelta.md
diff --git a/changelog.d/20241120_161839_danfuchs_event_manager_test_failures.md b/changelog.d/20241120_161839_danfuchs_event_manager_test_failures.md
diff --git a/changelog.d/20241122_150037_rra_DM_47769a.md b/changelog.d/20241122_150037_rra_DM_47769a.md
diff --git a/changelog.d/20241122_164744_danfuchs_metrics_publishing_is_slow.md b/changelog.d/20241122_164744_danfuchs_metrics_publishing_is_slow.md
diff --git a/changelog.d/20241125_140320_rra_DM_47796.md b/changelog.d/20241125_140320_rra_DM_47796.md
diff --git a/changelog.d/20241126_175555_steliosvoutsinas_DM_47459.md b/changelog.d/20241126_175555_steliosvoutsinas_DM_47459.md
diff --git a/ruff-shared.toml b/ruff-shared.toml
@@ -87,6 +87,11 @@ ignore = [
 select = ["ALL"]
 
 [lint.per-file-ignores]
+"alembic/**" = [
+    "INP001",  # Alembic files are magical
+    "D103",    # Alembic methods do not need docstrings
+    "D400",    # Alembic migrations have their own docstring format
+]
 "noxfile.py" = [
     "T201",    # print makes sense as output from nox rules
 ]
@@ -118,6 +123,12 @@ select = ["ALL"]
     "S301",    # allow tests for whether code can be pickled
     "SLF001",  # tests are allowed to access private members
 ]
+"tests/schema_test.py" = [
+    "ASYNC221", # useful to run subprocess in async tests for Alembic
+]
+"*/tests/schema_test.py" = [
+    "ASYNC221", # useful to run subprocess in async tests for Alembic
+]
 
 # These are too useful as attributes or methods to allow the conflict with the
 # built-in to rule out their use.