Skip to content
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.

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

Update PropertiesModel's deserialization of tags to not use Model.initializeFromJson #1884

Conversation

brismithers
Copy link
Contributor

@brismithers brismithers commented Oct 27, 2023

Description

One Line Summary

This updates the tag deserialization logic in PropertyModel.createModelForProperty to no longer use Model.initializeFromJson, which relies on reflection to determine the expected data type. Using reflection is useful when the data model being deserialized is represented by a statically defined class.

The problem with using reflections for tags is tag names are dynamic and might be the same as MapModel (the statically defined class that holds the tags). Examples: value, isEmpty, size.

Since tags must be flat, I updated PropertyModel.createModelForProperty to iterate through the JSONObject key value pairs directly.

Additionally, I noticed the reflection logic does not check for a String return value. For completeness, I added that additional case to ensure string properties get string values from the JSON object.

Details

Motivation

#1874

Scope

The intent of this fix is to allow the model deserialization code, which is primarily used during initialization, to successfully deserialize user state.

Testing

Unit testing

Added a new PropertiesModelTests to drive and verify deserialization of a PropertiesModel works as expected regarding tags.

Manual testing

Replicated the problem described in this issue by adding a tag named value with a non-boolean value. Once added, restart the app and verify proper deserialization.

Affected code checklist

  • Notifications
    • Display
    • Open
    • Push Processing
    • Confirm Deliveries
  • Outcomes
  • Sessions
  • In-App Messaging
  • REST API requests
  • Public API changes

Checklist

Overview

  • I have filled out all REQUIRED sections above
  • PR does one thing
    • If it is hard to explain how any codes changes are related to each other then it most likely needs to be more than one PR
  • Any Public API changes are explained in the PR details and conform to existing APIs

Testing

  • I have included test coverage for these changes, or explained why they are not needed
  • All automated tests pass, or I explained why that is not possible
  • I have personally tested this on my device, or explained why that is not possible

Final pass

  • Code is as readable as possible.
    • Simplify with less code, followed by splitting up code into well named functions and variables, followed by adding comments to the code.
  • I have reviewed this PR myself, ensuring it meets each checklist item
    • WIP (Work In Progress) is ok, but explain what is still in progress and what you would like feedback on. Start the PR title with "WIP" to indicate this.

This change is Reviewable

@brismithers brismithers merged commit 1ec2723 into user-model/main Nov 1, 2023
1 of 2 checks passed
@brismithers brismithers deleted the issues/1874-deserialize-tag-with-identical-method-name branch November 1, 2023 11:32
jinliu9508 pushed a commit that referenced this pull request Jan 31, 2024
…ical-method-name

Update PropertiesModel's deserialization of tags to not use `Model.initializeFromJson`
jinliu9508 pushed a commit that referenced this pull request Jan 31, 2024
…ical-method-name

Update PropertiesModel's deserialization of tags to not use `Model.initializeFromJson`
jinliu9508 pushed a commit that referenced this pull request Feb 6, 2024
…ical-method-name

Update PropertiesModel's deserialization of tags to not use `Model.initializeFromJson`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants