[RFC #0006] Introduction of component-base Repository

[cubxxw]

RFC #0006 Introduction of component-base Repository

Meta

• Name: Introduction of component-base Repository
• Start Date: 2023-08-25
• Author(s): @cubxxw
• Status: achieve
• RFC Pull Request: https://github.com/OpenIMSDK/community/edit/main/RFC/0006-openim-component-base.md
• OpenIMSDK Pull Request: feat: Refactoring component base openim-sigs/component-base#2
• OpenIMSDK Issue: [RFC #0006] Introduction of component-base Repository #955
• Supersedes: N/A

📇Topics

• Meta
• Summary
• Motivation
• What it is
• How it Works
• Migration
• Drawbacks
• Alternatives
• Prior Art
• Unresolved Questions
• Spec. Changes (OPTIONAL)
• History

Summary

• openim-sigs/component-base

Proposal to introduce the component-base repository, a centralized hub to house common tools and shared code, aimed to enhance code reusability and component coherence, inspired by Kubernetes's component-base.

Motivation

• Current repositories like chat, core, and server share multiple common tools, but dependencies aren't clearly isolated.
• A clear, independent repository helps external contributors or platforms to leverage OpenIMSDK's tools effortlessly.
• Achieve similar component structure like Kubernetes to maintain a modular and scalable codebase.

What it is

component-base is a repository designed to contain shared tools and utilities used across OpenIMSDK projects. This will include, but isn't limited to:

• ComponentConfig implementations
• Flag and command handling
• HTTPS serving
• Delegated authn/z
• Logging.

Comparing Repositories: openim-sigs/component-base vs OpenIMSDK/tools

Overview

The openim-sigs/component-base repository stands distinct from the OpenIMSDK/tools repository. Each serves a unique purpose in the ecosystem and caters to different consumers.

Primary Consumers of OpenIMSDK/tools

The main consumers for the OpenIMSDK/tools repository are:

• OpenIMSDK/Open-IM-Server/
• OpenIMSDK/chat
• OpenIMSDK/Openim-sdk-core

These entities leverage the utilities and tools offered by this repository for their functioning and enhancements.

Purpose of openim-sigs/component-base

In contrast, the openim-sigs/component-base repository houses core foundational components. These are designed to be used externally, offering a broad spectrum of utilities and functions. Its scope of influence and application, thus, tends to be more expansive than that of the OpenIMSDK/tools.

Migration

Transition involves:

1. Identifying common tools/code from the respective repositories.
2. Refactoring and migrating them to component-base.
3. Adjusting dependencies in the original repositories to now point to component-base.

Drawbacks

• Initial overhead due to refactoring.
• Potential for issues during the migration phase.

Alternatives

• Maintain the current structure but ensure stricter guidelines for code sharing.
• Create separate utility repositories for each original repository instead of a single shared one.

Prior Art

Kubernetes's component-base repository serves a similar purpose. They created it to have a unified, consistent base for components, promoting shared utilities and configurations.

Unresolved Questions

• What might be the challenges in the migration phase?
• How do we ensure minimal disruption during the transition?

Spec. Changes (OPTIONAL)

No specification changes as of now.

History

• 2023-08-25: Initial draft proposed by @cubxxw