isaric opened a new pull request, #4011: URL: https://github.com/apache/solr/pull/4011
https://issues.apache.org/jira/browse/SOLR-17600 <!-- _(If you are a project committer then you may remove some/all of the following template.)_ Before creating a pull request, please file an issue in the ASF Jira system for Solr: * https://issues.apache.org/jira/projects/SOLR For something minor (i.e. that wouldn't be worth putting in release notes), you can skip JIRA. To create a Jira issue, you will need to create an account there first. The title of the PR should reference the Jira issue number in the form: * SOLR-####: <short description of problem or changes> SOLR must be fully capitalized. A short description helps people scanning pull requests for items they can work on. Properly referencing the issue in the title ensures that Jira is correctly updated with code review comments and commits. --> ### Description This pull request replaces the deprecated `MapSerializable` interface with `MapWriter` across the Solr codebase. `MapSerializable` relied on the `toMap(Map)` pattern, which often led to unnecessary object allocations and inconsistent serialization behavior. By migrating to `MapWriter` and its `writeMap(EntryWriter)` pattern, we improve memory efficiency and ensure more consistent serialization across different formats like JavaBin and JSON. ### Solution The migration involved several key steps: 1. **Interface Removal**: Deleted the `MapSerializable` interface and removed its usage from the `MapWriter` interface. `MapWriter` now serves as the primary interface for object-to-map serialization. 2. **Refactoring Components**: Updated numerous classes across the codebase to implement `MapWriter` instead of `MapSerializable`. Key areas include: * **Core Configuration**: `SolrConfig`, `PluginInfo`, `SolrIndexConfig`, `CacheConfig`, `ConfigOverlay`, `RequestParams`, `IndexSchema`. * **Cloud & Admin APIs**: Many V2 API response classes such as `CreateCore`, `InstallShardData`, `MigrateDocsAPI`, `ModifyCollectionAPI`, `MoveReplicaAPI`, `SplitShardAPI`, and more. * **Internal State**: `ZkNodeProps`, `IndexFingerprint`. 3. **Method Migration**: Converted `toMap(Map<String, Object> map)` implementations to `writeMap(EntryWriter ew)`. This allows for direct writing to the underlying data structure (like `JavaBinCodec`'s output stream) without necessarily creating intermediate `Map` objects. 4. **Utility Updates**: Updated `Utils.convertToMap`, `Utils.reflectToMap`, and other utility methods to support the new pattern. `Utils.makeDeepCopy` now uses `SimpleOrderedMap` with `MapWriter` for better efficiency. 5. **Clean up**: Removed redundant `toMap` calls and simplified serialization logic in several handlers and components. Updated `JavaBinCodec`, `TextWriter`, and `JSONWriter` to optimize for `MapWriter`. ### Tests Existing tests were updated to accommodate the change in serialization: * Updated `TestConfig`, `SolrIndexConfigTest`, `CacheConfigTest`, and `NodeConfigClusterPluginsSourceTest` to verify that the configuration objects are still correctly serialized. * Updated `TestSchemaDesignerAPI` and `SolrExampleCborTest` to ensure API and serialization consistency. * Verified that `JavaBinCodec` and `JSONWriter` correctly handle the new `MapWriter` implementations. * Ran core Solr tests to ensure no regressions in response formatting or internal state representation. # Checklist Please review the following and check all that apply: - [ ] I have reviewed the guidelines for [How to Contribute](https://github.com/apache/solr/blob/main/CONTRIBUTING.md) and my code conforms to the standards described there to the best of my ability. - [ ] I have created a Jira issue and added the issue ID to my pull request title. - [ ] I have given Solr maintainers [access](https://help.github.com/en/articles/allowing-changes-to-a-pull-request-branch-created-from-a-fork) to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation) - [ ] I have developed this patch against the `main` branch. - [ ] I have run `./gradlew check`. - [ ] I have added tests for my changes. - [ ] I have added documentation for the [Reference Guide](https://github.com/apache/solr/tree/main/solr/solr-ref-guide) - [ ] I have added a [changelog entry](https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc) for my change -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
