Skip to content
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ Until `1.0.0`, breaking changes may appear in any release and are flagged with *

## [Unreleased]

## [2.0.0] — 2026-11-10

First major release since 1.0.0. It fixes bugs whose fixes could not ship without breaking
compatibility: database schema migrations for MySQL (#138) and PostgreSQL (#135), exponential retry
backoff (#131), listener events after commit (#137) and backlog draining within a scheduler tick (#132).
Read [UPGRADING.md](UPGRADING.md#from-1x-to-200) before upgrading.

### Added

- **`x-outbox-id` header on every delivery.** Both `KafkaMessageDeliverer` and `HttpMessageDeliverer`
Expand Down Expand Up @@ -386,7 +393,8 @@ Initial public release.
- `okapi-exposed` integration (transaction runner, connection provider, validator).
- Concurrent processing via `FOR UPDATE SKIP LOCKED`.

[Unreleased]: https://github.com/softwaremill/okapi/compare/v1.0.0...HEAD
[Unreleased]: https://github.com/softwaremill/okapi/compare/v2.0.0...HEAD
[2.0.0]: https://github.com/softwaremill/okapi/compare/v1.0.0...v2.0.0
[1.0.0]: https://github.com/softwaremill/okapi/compare/v0.3.0...v1.0.0
[0.3.0]: https://github.com/softwaremill/okapi/compare/v0.2.0...v0.3.0
[0.2.0]: https://github.com/softwaremill/okapi/compare/v0.1.0...v0.2.0
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ This example assumes an existing Spring Boot application connected to PostgreSQL

```kotlin
dependencies {
implementation(platform("com.softwaremill.okapi:okapi-bom:1.0.0"))
implementation(platform("com.softwaremill.okapi:okapi-bom:2.0.0"))
implementation("com.softwaremill.okapi:okapi-core")
implementation("com.softwaremill.okapi:okapi-postgres")
implementation("com.softwaremill.okapi:okapi-http")
Expand Down
28 changes: 28 additions & 0 deletions UPGRADING.md
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,34 @@ batch per worker per tick, as in 1.x.
calls `copy(...)` or a constructor relying on default arguments must be recompiled, or it fails
with `NoSuchMethodError`.

### Route-aware claiming: `RouteAwareOutboxStore` and migration `002` (#120)

The processor now claims only the delivery types it has a deliverer for.

- **Schema.** Changeset `002__route_aware_claim_index` adds a claim index. The bundled Liquibase
changelogs apply it automatically. If you manage the schema yourself, apply it before starting
2.0.0 workers: the MySQL claim uses `FORCE INDEX` and fails without it, and the PostgreSQL script
(`CREATE INDEX CONCURRENTLY`) must run outside a transaction.
- **Custom stores.** `OutboxProcessor` requires a `RouteAwareOutboxStore`. A custom `OutboxStore`,
or a hand-written wrapper around a built-in store, must implement it, or `processNext` throws and
Spring autoconfiguration fails at startup while the processor is enabled.
- **Unknown delivery types.** `OutboxEntryProcessor.process`/`processBatch` throw
`IllegalStateException` for an entry with no registered deliverer instead of marking it `FAILED`.
Under `OutboxProcessor` the transaction rolls back and the row stays `PENDING`; direct callers must
handle the exception.

### `ExposedConnectionProvider` takes a `Database` (#96)

Pass the `Database` the outbox lives in: `ExposedConnectionProvider(database)`, one instance per
`Database`, as with `ExposedTransactionRunner` and `ExposedTransactionContextValidator`. It now
reads that database's transaction instead of whichever one is innermost on the thread.

### `OutboxProcessorProperties.transportDispatch` (#113)

`OutboxProcessorProperties` gained a `transportDispatch` parameter. Java callers and
`application.yml` binding are unaffected; compiled Kotlin code that calls `copy(...)` or a
constructor relying on default arguments must be recompiled, or it fails with `NoSuchMethodError`.

## From 0.2.x to 1.0.0

Releases up to 0.2.x used the domain table `outbox` and the shared Liquibase tracking
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,4 @@ org.gradle.caching=true
org.gradle.configuration-cache=true

GROUP=com.softwaremill.okapi
VERSION_NAME=1.0.0
VERSION_NAME=2.0.0