Modernize and optimize serialization #398

jodastephen · 2024-10-30T16:31:03Z

Update to Java 21
Adjust code with minor optimizations
No externally observable changes

Summary by CodeRabbit

New Features
- Enhanced error handling for binary data processing.
- Introduced a new method for parsing properties in JodaBeanSimpleMapReader.
Improvements
- Refactored methods for better readability and maintainability across multiple classes.
- Updated control flow structures to use modern syntax, improving clarity.
- Streamlined variable declarations using type inference.
Documentation
- Updated method documentation to reflect changes in terminology.

* Update to Java 21 * Adjust code with minor optimizations * No externally observable changes

coderabbitai · 2024-10-30T16:31:10Z

📝 Walkthrough

Walkthrough

The pull request includes extensive refactoring across several classes in the org.joda.beans.ser.bin package, focusing on enhancing code clarity, maintainability, and error handling. Key modifications involve replacing explicit type declarations with the var keyword, restructuring control flows using switch-case statements, and refining method signatures. Notable changes include the introduction of new methods for parsing and error handling, as well as the removal of redundant checks. Overall, these changes aim to streamline the code without altering its core functionality.

Changes

File Path	Change Summary
`src/main/java/org/joda/beans/ser/bin/AbstractBinReader.java`	- Replaced explicit type declarations with `var` for local variables. - Refactored `parseBean` to `parseObjectAsBean` with updated signature. - Centralised error handling into `invalidBinaryData` method. - Streamlined control flow in `parseObject`.
`src/main/java/org/joda/beans/ser/bin/AbstractBinWriter.java`	- Refactored conditional statements in `writeElements` and `writeSimple` to use switch-case structures. - Streamlined handling of effective types in `getAndSerializeEffectiveTypeIfRequired`.
`src/main/java/org/joda/beans/ser/bin/BeanReferences.java`	- Added static final variable `NON_REFERENCED` for primitive types. - Updated `findReferences` to use a stream for sorting. - Replaced conditional checks with a switch statement in `findReferencesIterable`.
`src/main/java/org/joda/beans/ser/bin/JodaBeanReferencingBinReader.java`	- Updated variable types to `var` in `parseClassInfo` and `parseBean` methods. - Refactored `acceptIntExtension` to use a switch expression. - Simplified iteration over `metaBean.metaPropertyIterable()`.
`src/main/java/org/joda/beans/ser/bin/MsgPackInput.java`	- Updated `readObject` method to use switch expression syntax. - Modified handling of `UINT_32` to use `Integer.toUnsignedLong(val)`.
`src/main/java/org/joda/beans/ser/bin/MsgPackOutput.java`	- Updated documentation for `writeExtensionByte` method to reflect semantic changes in terminology.
`src/main/java/org/joda/beans/ser/bin/MsgPackVisualizer.java`	- Refactored `handleExtension` method to use enhanced switch expression syntax.
`src/main/java/org/joda/beans/ser/map/JodaBeanSimpleMapReader.java`	- Removed `throws Exception` from `parseRoot` and other methods. - Introduced `var` for local variable declarations. - Split `parseObject` into `parseProperty` and `parseObjectAsBean`.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

coderabbitai

Actionable comments posted: 1

🧹 Outside diff range and nitpick comments (1)

src/main/java/org/joda/beans/ser/bin/BeanReferences.java (1)

Line range hint 147-157: Consider extracting nested logic into separate methods

While the code is functionally correct, the nested conditional logic could be more maintainable if extracted into well-named methods. This would improve readability and make the code easier to test.

Consider refactoring like this:

- for (var prop : bean.metaBean().metaPropertyIterable()) {
-     if (settings.isSerialized(prop)) {
-         var value = prop.get(bean);
-         var type = SerOptional.extractType(prop, base.getClass());
-         if (value != null) {
-             var itemIterator = settings.getIteratorFactory().create(value, prop, bean.getClass());
-             if (itemIterator != null) {
-                 if (itemIterator.metaTypeRequired()) {
-                     objects.compute(itemIterator.metaTypeName(), BeanReferences::incrementOrOne);
-                 }
-                 findReferencesIterable(itemIterator, objects);
-             } else {
-                 findReferencesBean(value, type, objects, null);
-             }
-         }
-     }
- }
+ for (var prop : bean.metaBean().metaPropertyIterable()) {
+     processPropertyIfSerialisable(prop, bean, base, objects);
+ }

+ private void processPropertyIfSerialisable(MetaProperty<?> prop, Bean bean, Object base, Map<Object, Integer> objects) {
+     if (!settings.isSerialized(prop)) {
+         return;
+     }
+     var value = prop.get(bean);
+     if (value == null) {
+         return;
+     }
+     processPropertyValue(value, prop, bean, base, objects);
+ }

+ private void processPropertyValue(Object value, MetaProperty<?> prop, Bean bean, Object base, Map<Object, Integer> objects) {
+     var type = SerOptional.extractType(prop, base.getClass());
+     var itemIterator = settings.getIteratorFactory().create(value, prop, bean.getClass());
+     if (itemIterator == null) {
+         findReferencesBean(value, type, objects, null);
+         return;
+     }
+     processIterator(itemIterator, objects);
+ }

+ private void processIterator(SerIterator itemIterator, Map<Object, Integer> objects) {
+     if (itemIterator.metaTypeRequired()) {
+         objects.compute(itemIterator.metaTypeName(), BeanReferences::incrementOrOne);
+     }
+     findReferencesIterable(itemIterator, objects);
+ }

📜 Review details

Configuration used: .coderabbit.yaml
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between fe17436 and b2a1546.

📒 Files selected for processing (8)

src/main/java/org/joda/beans/ser/bin/AbstractBinReader.java (10 hunks)
src/main/java/org/joda/beans/ser/bin/AbstractBinWriter.java (3 hunks)
src/main/java/org/joda/beans/ser/bin/BeanReferences.java (6 hunks)
src/main/java/org/joda/beans/ser/bin/JodaBeanReferencingBinReader.java (4 hunks)
src/main/java/org/joda/beans/ser/bin/MsgPackInput.java (1 hunks)
src/main/java/org/joda/beans/ser/bin/MsgPackOutput.java (1 hunks)
src/main/java/org/joda/beans/ser/bin/MsgPackVisualizer.java (1 hunks)
src/main/java/org/joda/beans/ser/map/JodaBeanSimpleMapReader.java (3 hunks)

✅ Files skipped from review due to trivial changes (1)

src/main/java/org/joda/beans/ser/bin/MsgPackOutput.java

🧰 Additional context used

📓 Path-based instructions (7)

src/main/java/org/joda/beans/ser/bin/AbstractBinReader.java (2)