akka/akka-core

Custom manifest naming for persistence with Jackson

Open

#30,483 opened on Aug 5, 2021

View on GitHub
 (5 comments) (0 reactions) (0 assignees)Scala (3,547 forks)batch import
1 - triagedhelp wantedt:serialization

Repository metrics

Stars
 (13,277 stars)
PR merge metrics
 (Avg merge 8d 19h) (10 merged PRs in 30d)

Description

Full class names as manifests lead to lot of unnecessary storage overhead and leads to problems if event classes are being refactored into different packages.

It would be very helpful to be able to define custom manifest names like e.g. this:

case class @PersistenceManifest("AbcActor.Name") NameEvent(id: UUID, name: string) extends Event

Ideally, it should be checked on startup if persistence manifest names are unique within the running application.

Contributor guide

Research direction
Investigate Akka Persistence serialization code to understand how manifests are currently generated. Implement a custom annotation (e.g., @PersistenceManifest) that allows users to specify a custom name, and add a validation check at startup to ensure uniqueness across the application.
Tech stack
scala
Domain
backend
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Mostly clear
Prerequisites
ScalaAkka PersistenceJackson
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30