Feature/Jackson clean up #1550

meladRaouf · 2026-01-21T23:07:10Z

JIRA ticket
Will be released in: 2026.1.0

Notable changes

There were several ways to centralize the Kotlin JSON serialization configuration. I chose to make it a global lazy variable to minimize refactoring.

val SimJson: Json by lazy {
    Json {
        ignoreUnknownKeys = true
        explicitNulls = false
        encodeDefaults = true
        coerceInputValues = true
    }
}

The ideal approach would be to inject it using Hilt. However, it is mainly used in data-class converters and extension functions, and introducing DI would require threading the Json instance through all converters.

For example:

internal fun DbEvent.fromDbToDomain(): Event

would need to become:

internal fun DbEvent.fromDbToDomain(json: Json): Event

Given the scope and risk of such changes, a global instance is the more pragmatic choice here.

Testing guidance

Create multiple session types, upload them to the backend, and verify that all are processed correctly.

Additional work checklist

Effect on other features and security has been considered
Design document marked as "In development" (if applicable)
External (Gitbook) and internal (Confluence) Documentation is up to date (or ticket created)
Test cases in Testiny are up to date (or ticket created)
Other teams notified about the changes (if applicable)

Copilot

Pull request overview

This pull request migrates the codebase from Jackson to Kotlin Serialization by introducing a new :infra:serialization module with a global SimJson instance. The PR removes Jackson dependencies, deletes Jackson-specific code, and updates all usages throughout the codebase to use the new SimJson object.

Changes:

Creates new :infra:serialization module with SimJson configuration
Removes Jackson library dependencies from gradle files and proguard rules
Migrates all Jackson serialization calls to use SimJson with Kotlin Serialization
Deletes Jackson-specific serialization classes and updates related tests

Reviewed changes

Copilot reviewed 81 out of 81 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
infra/serialization/*	New module with SimJson configuration for Kotlin Serialization
settings.gradle.kts	Adds new serialization module to project structure
infra/*/build.gradle.kts	Removes Jackson dependencies from multiple modules
infra/network/src/main/java/com/simprints/infra/network/json/JsonHelper.kt	Deleted internal JsonHelper that used Jackson
infra/core/src/main/java/com/simprints/core/domain/tokenization/serialization/EventDatabaseSerialization.kt	Deleted Jackson serializers for TokenizableString
infra/events/src/main/java/com/simprints/infra/events/event/domain/models/EnrolmentRecordEvent.kt	Removed Jackson annotations
infra//src/main/java//.kt	Updated imports and usages from JsonHelper to SimJson across ~40+ files
infra//src/test/java//.kt	Updated test files to use SimJson and removed JsonHelper mocks
infra/core/src/main/java/com/simprints/core/CoreModule.kt	Removed JsonHelper from dependency injection
feature/orchestrator/src/main/java/com/simprints/feature/orchestrator/tools/OrchestrationJsonHelper.kt	Updated to extend SimJson configuration
gradle/libs.versions.toml	Removed Jackson version and library references
id/proguard-rules.pro	Removed Jackson-specific proguard rules

Comments suppressed due to low confidence (1)

infra/core/src/main/java/com/simprints/core/tools/json/JsonHelper.kt:22

The JsonHelper object is still present in the codebase with duplicate configuration to SimJson. This creates inconsistency and confusion. Consider either removing this entirely or having it delegate to SimJson to maintain a single source of truth for JSON configuration.

    val json: Json by lazy {
        Json {
            ignoreUnknownKeys = true
            explicitNulls = false
            encodeDefaults = true
            coerceInputValues = true
        }
    }
}

Copilot · 2026-01-21T23:54:33Z

infra/serialization/src/main/java/com/simprints/infra/serialization/DefaultJson.kt

+ * Global Json instance.
+ * Defined as a top-level variable to allow "One Dot" usage: SimJson.encodeToString(...)
+ *
+ * TODO: Should me moved to a Hilt DI module and inject it into classes


There is a typo in the TODO comment: "Should me moved" should be "Should be moved".

Any reason not do it in this PR?

I found it very complex

infra/core/src/main/java/com/simprints/core/tools/json/JsonHelper.kt

Copilot · 2026-01-21T23:54:33Z

...test/java/com/simprints/core/domain/tokenization/serialization/TokenizationSerializerTest.kt

    @Test
    fun `serialize Raw produces className Raw and value`() {
        val raw = TokenizableString.Raw("person")

-        val result = json.parseToJsonElement(
-            json.encodeToString(raw),
+        val result = SimJson.parseToJsonElement(
+            SimJson.encodeToString(raw),
        )

        val expected = JsonObject(


The removed test validates Jackson-specific class name serialization behavior which is no longer relevant. However, this test removal appears intentional as part of the Jackson cleanup. Ensure equivalent behavior is tested with the new Kotlin Serialization implementation if this serialization format is still being used.

...chestrator/src/main/java/com/simprints/feature/orchestrator/tools/OrchestrationJsonHelper.kt

…ferences

sonarqubecloud · 2026-01-22T11:47:50Z

Quality Gate passed

Issues
6 New issues
0 Accepted issues

Measures
0 Security Hotspots
81.2% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

luhmirin-s · 2026-01-22T12:09:03Z

...va/com/simprints/feature/clientapi/usecases/GetEnrolmentCreationEventForRecordUseCaseTest.kt


    @Test
    fun `returns event if biometrics coSync enabled`() = runTest {
+        mockkObject(SimJson)


Can we do 2-way approach with the helper being injected where possible and a fallback with the direct object access?

Would this be for the sole purpose of injecting mocks in those classes instead of mocking objects?

More for the purpose of maintaining the inversion of control whereever possible.

Then I don't really see the benefit if it's hardcoded in half of the classes - it's highly unlikely we decide to use one lib for the injection and another for the hardcoded cases.

luhmirin-s · 2026-01-22T12:13:06Z

infra/serialization/src/main/java/com/simprints/infra/serialization/DefaultJson.kt

+ * Global Json instance.
+ * Defined as a top-level variable to allow "One Dot" usage: SimJson.encodeToString(...)
+ *
+ * TODO: Should me moved to a Hilt DI module and inject it into classes


Any reason not do it in this PR?

luhmirin-s · 2026-01-22T12:15:45Z

infra/serialization/src/main/java/com/simprints/infra/serialization/DefaultJson.kt

+ * TODO: Should me moved to a Hilt DI module and inject it into classes
+ *
+ */
+val SimJson: Json by lazy {


Does this really warrant a full module? Do you plan to move any additional stuff in here?

I wanted this in a separate module because it is needed by every other modules.

My first thought was to add this utility class to infra/core. However, infra/network also requires it, and it can't depend on core.
The second option was infra/logging, but that is not a good fit conceptually.

For that reason, I chose to place the SimJson in a new module: infra/serialization.

BurningAXE · 2026-01-22T14:21:06Z

infra/core/src/main/java/com/simprints/core/CoreModule.kt


-    @Provides
-    @Singleton
-    fun provideJsonHelper(): JsonHelper = JsonHelper


We cannot do the same for the new "helper"?

BurningAXE · 2026-01-22T14:22:32Z

...test/java/com/simprints/core/domain/tokenization/serialization/TokenizationSerializerTest.kt

 class TokenizationSerializerTest {
-    // Todo remove this test once removing all the jackson code
-    @Test
-    fun `class name tokenization serialization and deserialization should produce same result`() {


While the implementation details were Jackson specific, the test purpose seems still valid?

meladRaouf added 2 commits January 21, 2026 20:09

[MS-1305] Remove Jackson dependencies and related code

04b23a5

[MS-1305] add infra/serialization module and use it in the infra/network

5ceb330

cla-bot bot added the ... label Jan 21, 2026

meladRaouf changed the title ~~[WIP]Feature/jackson clean up~~ [WIP] Feature/Jackson clean up Jan 21, 2026

meladRaouf force-pushed the feature/jackson-clean-up branch from 4236c79 to 5a3b442 Compare January 21, 2026 23:35

meladRaouf requested a review from Copilot January 21, 2026 23:51

Copilot started reviewing on behalf of meladRaouf January 21, 2026 23:51 View session

Copilot AI reviewed Jan 21, 2026

View reviewed changes

meladRaouf force-pushed the feature/jackson-clean-up branch from 5a3b442 to d17df3e Compare January 22, 2026 00:42

[MS-1305] add SimJson serialization utility and replace JsonHelper re…

176750a

…ferences

meladRaouf force-pushed the feature/jackson-clean-up branch from d17df3e to 176750a Compare January 22, 2026 09:12

meladRaouf changed the title ~~[WIP] Feature/Jackson clean up~~ Feature/Jackson clean up Jan 22, 2026

meladRaouf requested review from a team, BurningAXE, TristramN, alex-vt, alexandr-simprints, luhmirin-s and ybourgery and removed request for a team January 22, 2026 11:35

meladRaouf marked this pull request as ready for review January 22, 2026 11:35

luhmirin-s approved these changes Jan 22, 2026

View reviewed changes

alex-vt approved these changes Jan 22, 2026

View reviewed changes

BurningAXE reviewed Jan 22, 2026

View reviewed changes

BurningAXE approved these changes Jan 22, 2026

View reviewed changes

Feature/Jackson clean up #1550

Are you sure you want to change the base?

Feature/Jackson clean up #1550

Uh oh!

Conversation

meladRaouf commented Jan 21, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notable changes

Testing guidance

Additional work checklist

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Copilot AI Jan 21, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

sonarqubecloud bot commented Jan 22, 2026

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

meladRaouf commented Jan 21, 2026 •

edited

Loading