Skip to content

fix(models)!: deserialize model objects reflectively with gson #473

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dargmuesli merged 9 commits into from
Sep 1, 2026
Merged

fix(models)!: deserialize model objects reflectively with gson #473

Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f0bdd3a
fix(models): deserialize model objects reflectively with gson
dargmuesli Sep 1, 2026
57e64e3
refactor!: drop the unused jackson dependency
dargmuesli Sep 1, 2026
00469fd
docs(models): drop javadoc that only restates the signature
dargmuesli Sep 1, 2026
57f3837
docs: correct stale facts in AGENTS.md
dargmuesli Sep 1, 2026
58ecfc8
test(models): pin the parsers that must not be deleted
dargmuesli Sep 1, 2026
7e77dbd
Merge branch 'beta' into refactor/models/gson-reflection
dargmuesli Sep 1, 2026
f497281
docs(models): drop the remaining builder setter javadoc
dargmuesli Sep 1, 2026
8083622
refactor!: delete unreferenced public API
dargmuesli Sep 1, 2026
2d12536
docs: record this branch's breaking changes in the migration guide
dargmuesli Sep 1, 2026
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
Prev Previous commit
Next Next commit
docs: correct stale facts in AGENTS.md 
The Java version claimed 17+ while every profile compiles with --release 9, the
pinned version had drifted four release candidates behind, and the request
recipe still told agents to add a @JsonDeserialize annotation.

Adds a note on how model objects are deserialized now, since that changes what
adding a field to one costs.
  • Loading branch information
@dargmuesli
dargmuesli committed Sep 1, 2026
commit 57f383711c3ca68b89b9b9be1c284c7c22e2da2c
8 changes: 5 additions & 3 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,8 @@ This file provides context for AI coding agents working in this repository.

- **Group ID:** `se.michaelthelin.spotify`
- **Artifact ID:** `spotify-web-api-java`
- **Current Version:** `10.0.0-RC1`
- **Build Tool:** Maven (`pom.xml`)
- **Java Version:** 17+
- **Java Version:** compiled with `--release 9`; CI builds on JDK 17 and 25

## Repository Structure

Expand Down Expand Up @@ -49,7 +48,6 @@ Create `src/main/java/se/michaelthelin/spotify/requests/data/<category>/<Endpoin

Key patterns:
- Extend `AbstractDataRequest<ReturnType>` (or `AbstractDataPagingRequest` for paginated results).
- Annotate with `@JsonDeserialize(builder = <ClassName>.Builder.class)`.
- Implement `execute()` which calls `getJson()`, `postJson()`, `putJson()`, or `deleteJson()` as appropriate.
- Add a `static final class Builder` with:
- Path parameters set via `setPathParameter("key", value)`
Expand Down Expand Up @@ -104,6 +102,10 @@ mvn test -Dtest="*Playlist*"

## Key Conventions

- **Model objects are deserialized reflectively** by the shared Gson in
`model_objects/ModelObjectGson.java`, so a new field needs no parsing code.
Add `@SerializedName` only when the wire name is not the snake_case form of the field,
and add a type adapter only for a shape reflection cannot express.
- **Trailing underscores** on Java-reserved words: e.g., `public_` for the `public` field.
- **Assertions** in tests are imported from both JUnit 5 (`org.junit.jupiter.api.Assertions`) and the project's own `se.michaelthelin.spotify.Assertions`.
- **Nullable fields** from the API should be tested with `assertNull(...)` when the fixture returns `null`.
Expand Down