xmpp_session_establishment

项目背景与战略目标

xmpp_session_establishment 是一个为 OpenHarmony 平台提供的 XMPP（Extensible Messaging and Presence Protocol）会话建立库，用于在客户端完成资源绑定后，根据服务器通告的流特性（stream features）动态决定是否发起会话初始化请求（如 RFC 3921 的 ）。该项目属于 XMPP 客户端协议栈的关键后端组件，是实现完整 IM 功能（如消息历史、在线状态同步）的前提。依托仓颉编程语言（Cangjie Language）1.0.0+ 的内存安全特性（杜绝因 XML 构造或状态管理引发的 CVE 漏洞）、强类型系统（确保流特性解析与会话状态机正确性）、轻量级异步模型（无缝集成至现有连接流水线）以及 CJNative 高性能 FFI 能力（高效对接 IQ 消息通道），本项目旨在打造一个精简、可靠、符合 RFC 标准的会话协商模块，为仓颉生态提供标准化的 XMPP 会话初始化能力，支撑高可用即时通信、物联网设备状态同步等后端服务场景。

核心功能需求与技术规格

2.1 功能模块分解

2.2 非功能性需求规范

• 性能指标：单次会话建立 P99 延迟 < 100ms（局域网），吞吐量 ≥5,000 会话/秒。

• 安全要求：所有 XML 构造使用强类型模板，杜绝注入风险；状态变更受所有权保护。

• 可靠性：会话失败路径全覆盖；异常不中断主连接，可继续收发消息。

• 可维护性：模块高度内聚，仅依赖标准接口（iqCaller, streamFeatures）；无全局状态。

2.3 核心接口设计示例 (伪代码)

// 主导出函数：创建会话建立中间件
fn sessionEstablishment(
    ctx: &StreamContext,
    iq_caller: &IqCaller,
    stream_features: &StreamFeatures
) -> Result<(), SessionError>;

// 可选：显式触发（用于调试）
async fn establishSession(iq_caller: &IqCaller) -> Result<(), SessionError>;

enum SessionError {
    SessionNotSupported,
    IqTimeout,
    ServerRefused,
    InvalidResponse(String),
}

// 中间件注册示例（由 client_core 调用）
impl XmppClient {
    fn withSession(self) -> Self {
        self.use(sessionEstablishment);
    }
}

项目交付物与实施路线图

3.1 阶段性交付物清单

• 第一阶段：核心会话协商逻辑 + 单元测试（覆盖率≥95%） + 接口文档

• 第二阶段：中间件自动集成 + 与 cj-xmpp-client_core 对接测试

• 第三阶段：降级策略完善 + 性能调优报告 + cjpm 发布包

3.2 项目实施路线图

技术实现规范与质量认证体系

4.1 仓颉语言专项质量规范

• 编码规范：100% 通过 cjfmt 格式校验；禁止字符串拼接构造 XML。

• 类型安全：流特性字段不可变；会话状态由 enum 显式建模。

• 错误处理：所有操作返回 Result<T, E>；错误类型覆盖 RFC 所有场景。

4.2 测试与验证标准

• 单元测试：覆盖 session 不支持、超时、拒绝等边界情况，行覆盖率 ≥95%。

• 互操作测试：与 ejabberd（支持 session）、Prosody（默认禁用）验证行为合规。

• 安全扫描：通过 cjpm lint --deny-unsafe 和静态分析工具。

4.3 文档与可维护性

• 所有 public 接口包含 Doc Comments，说明会话语义与降级行为。

• 记录流特性解析策略、中间件注册时机等关键决策（ADR）。

• 提供 .cjpmrc 与贡献指南，明确构建与测试流程。

4.4 持续集成质量门禁

# PR 自动化流水线
cjpm fmt --check
cjpm build --release
cjpm lint --deny-warnings --deny-unsafe
cjpm test --all-features --coverage
cjpm bench

技术栈与开发环境

• 核心语言：仓颉编程语言（Cangjie Language）1.0.0+

• 构建与包管理：CJPM (Cangjie Package Manager)

• 依赖组件：cj-xmpp-iq（IQ 通道）、cj-xmpp-stream-features（特性解析）

• 测试框架：@cangjie/test + mock XMPP 服务器

• 环境要求：仓颉 1.0.0+ 标准工具链；CI 使用 cangjie-lang/cj-builder:1.0 官方 Docker 镜像

交付件

验收标准

1.功能

1. 三方库必须有明确的功能；

2. 如果参考对标库移值开发，功能与参考三方库保持一致。

2.资料

1. Readme：包含简介，软件架构，目录结构，下载安装（编译构建），接口说明，使用示例，约束限制，开源协议，参与贡献等内容；

2. Changelog，三方库版本需包含基本的修改说明。

3.标准遵从性（可选），三方库实现需满足对应协议或行业标准，举例

1. appquth：支持对OAuth 的PKCE扩展；

2. icu4j：支持unicode标准库，通用字符集ISO/IEC 10646。

4.性能目标

1. 性能敏感三方库接口运行性能持平对标三方库

5.开源协议遵从，必须包含License文件

1. 放置合适的开源License协议，建议Apache License Version 2.0；

2. 引用或参考开源三方库，需遵从开源协议。

6.网络安全要求

1. 满足基础的网络安全红线及隐私要求，符合安全编码规范。

过程质量要求