[FEATURE REQUEST] Proposal for Integration of FerretDB as an Alternative Database Backend for OpenIM

[cubxxw]

Why this feature?

OpenIM currently relies on MongoDB for data storage. While MongoDB has served us well, its SSPL license poses potential restrictions and lacks flexibility in certain configurations compared to emerging open-source databases. This proposal aims to integrate FerretDB, a MongoDB-compatible open-source database that avoids licensing constraints and offers more backend storage options, enhancing OpenIM's adaptability and performance.

Suggested Solution

OpenIM's current implementation fully supports MongoDB for all data operations and transactional processes.

Identified Shortcomings

• Licensing Restrictions: MongoDB's SSPL license can be restrictive for some businesses.
• Configuration Rigidity: Limited flexibility in scaling and custom configurations with MongoDB.

Proposed Improvements

• Database Flexibility: Integrating FerretDB to provide more backend choices.
• Enhanced Adaptability: Improving the system's configurability for different operational environments.

Project Goals

• Achieve seamless integration of FerretDB with OpenIM.
• Maintain or enhance performance and compatibility with existing systems.
• Provide comprehensive documentation and developer support to facilitate adoption.

Technical Plan

1. Driver and Library Adjustments

   • Modify or replace the MongoDB data driver to ensure compatibility with FerretDB.
   • Update connection handling and database interaction codes as necessary.

2. Configuration and Deployment

   • Revise configuration management in OpenIM to support FerretDB deployment and operations.
   • Update environment variables and dependency management setups.

3. Performance Optimization

   • Conduct performance testing and tuning to ensure optimal operations with FerretDB.

4. Testing and Validation

   • Implement detailed functional testing to verify that all existing features work correctly with FerretDB.
   • Address any emerging issues during the integration process.

5. Documentation and Support

   • Update developer documentation and user manuals with new installation steps, configuration options, and troubleshooting guides.

Additional Resources

• OpenIM GitHub Repository: OpenIM GitHub
• FerretDB Official Website: FerretDB
• MongoDB SSPL Information: MongoDB SSPL

Call to Action

We invite contributors to discuss this proposal in our Slack channel and contribute to refining this integration approach. Join us at: OpenIM Slack

Additional Information

No response