crud-grpc

name: crud-grpc description: 基于内嵌规则 的 CRUD over gRPC 规范。用于校对 gRPC 依赖 SDK、反射调试、拦截器链与服务复用。

CRUD over gRPC

步骤

1. 打开 本文件内嵌规则。
2. 按 ruleset 的 requires 联动检查 transport/service/test/sdk。

核对点

• 仓库不携带业务 .proto（testdata 例外）。
• 使用 PowerX Go SDK 作为唯一协议来源。
• reflection 仅在 debug 模式启用，且绑定 loopback。
• gRPC handler 复用 Service，禁 DB 直连。
• 拦截器链含 auth/tenant/logging/recovery 与错误码映射。

指南

CRUD over gRPC — Plugin Guide

面向插件侧 gRPC 传输层的人读说明。
目标：统一 proto 命名/拦截器/metadata/错误映射/生成路径；与 HTTP 共用 Service（PG-SVC-001）。

1. 合约来源与依赖

• 权威协议：复用宿主提供的 Go SDK github.com/ArtisanCloud/PowerX/api/grpc/gen/go，仓库内不维护业务 .proto。
• 升级方式：通过 go get -u 同步 SDK 版本；禁止手动改写生成文件。
• 命名空间：以 SDK 内约定（powerx.plugin.base.v1 等）为准，与 HTTP DTO 字段保持语义一致。

2. Service / Message 设计

• Service（TemplateService）：
  • CreateTemplate(CreateTemplateRequest) returns (TemplateResponse)
  • UpdateTemplate(UpdateTemplateRequest) returns (TemplateResponse)
  • DeleteTemplate(DeleteTemplateRequest) returns (google.protobuf.Empty)
  • GetTemplate(GetTemplateRequest) returns (TemplateResponse)
  • ListTemplates(ListTemplateRequest) returns (ListTemplateResponse)
• 消息命名尽量与 HTTP DTO 对齐（字段一致，语义一致）。

3. Metadata 与多租户

• 入站拦截器从 metadata 读取并验证：authorization（JWT/HMAC）、tenant_uuid、x-request-id 等
• 通过拦截器把 tenant_uuid 注入 DB 会话（RLS）：SET LOCAL app.tenant_uuid = ?
• 与 HTTP 一致（PG-CTX-001）

4. 拦截器链（服务端）

• auth（验签/上下文注入）
• tenant（RLS/会话变量）
• logging（结构化日志，含 request_id/tenant_uuid）
• recovery（panic 捕获，统一错误）

所有业务实现均复用同一 Service（PG-SVC-001），禁止把业务写在 gRPC handler 中。

5. 错误映射

• 使用 google.rpc.Status 或自定义错误码与 HTTP 对齐：
• 权限：PERMISSION_DENIED ↔ 403
• 未认证：UNAUTHENTICATED ↔ 401
• 资源不存在：NOT_FOUND ↔ 404
• 参数错误：INVALID_ARGUMENT ↔ 400
• 冲突：ALREADY_EXISTS ↔ 409
• 服务错误：INTERNAL ↔ 500

6. 装配与依赖注入

• 服务装配：统一在 internal/grpc/server/*.go 注册 Register*ServiceServer(...)。
• 依赖注入：通过构造函数把领域 Service 注入到 gRPC 层；禁止直接依赖仓储。
• SDK 绑定：Handler 使用 SDK 里的 pb 包类型，避免本地自定义结构。

7. 测试策略

• Contract Test：对 SDK pb 类型进行编解码与字段断言，确保版本升级不破坏语义。
• Server Test：拦截器链验证（auth/tenant/logging/recovery）。
• E2E：与 HTTP 的行为保持一致（单一 Service 源），尤其在多租户读写上。

8. 合规清单（Checklist）

• SDK 版本固定且与宿主协议保持一致
• metadata 注入/校验（JWT/HMAC + tenant_uuid + request_id）
• 拦截器链完整
• 与 HTTP 复用同一 Service
• 错误码映射一致
• 有合同/拦截器/行为一致性测试

（相关 Gates：PG-CTX-001 / PG-SVC-001）

规则（内嵌）

crud_grpc.yaml

# CRUD over gRPC — 按「调试 vs 启动(生产/预发)」两种模式约束
# 调试：开启 gRPC Server Reflection，便于 grpcurl / evans 本地调试
# 启动：以 PowerX 提供的 Go SDK (api/grpc/gen/go) 为唯一协议来源，不在仓库内存放 .proto
kind: ruleset
id: crud_grpc
version: 1.1.0
summary: "gRPC 传输层契约（无本地 proto；依赖 PowerX Go SDK；调试可启用 reflection）"
params:
  sdk_module: "github.com/ArtisanCloud/PowerX/api/grpc/gen/go"  # 如你有自定义 module 路径，可在项目 rules.yaml 覆盖
requires:
  - rulesets/crud/transport_grpc.yaml
  - rulesets/crud/service.yaml
  - rulesets/crud/test.yaml
  - rulesets/crud/sdk_go.yaml
checks:
  # 0) 禁止在仓库携带业务 .proto（测试夹带例外）
  - id: grpc-no-local-proto
    desc: 仓库不应包含 .proto（除 testdata/**）
    assert:
      type: fileban
      target: backend/**
      pattern:
        - "*.proto"
      allow:
        - backend/testdata/**

  # 1) 依赖 PowerX Go SDK（而非本地生成）
  - id: grpc-use-powerx-sdk
    desc: go.mod 中必须依赖 PowerX gRPC SDK；代码中引用 SDK 里的 pb 包
    assert:
      any:
        - type: grep
          target: go.mod
          pattern:
            - "{{sdk_module}}"
        - type: grep
          target: backend/**/*.go
          pattern:
            - "{{sdk_module}}"

  # 2) 反射仅在 debug 模式启用，且仅绑定到本地回环地址
  - id: grpc-reflection-debug-only
    desc: config.yaml 中 reflection 开关仅在 debug=true 时生效，地址限制 127.0.0.1/::1
    assert:
      all:
        - type: grep
          target: backend/config/config.yaml
          pattern:
            - "grpc:" 
            - "  reflection:"
            - "    enabled: true|false"
            - "  bind:"
        - type: grep
          target: backend/internal/grpc/server/**
          pattern:
            - "if cfg.Debug && cfg.GRPC.Reflection.Enabled {"
            - "reflection.Register("
            - "isLoopback(cfg.GRPC.Bind)"

  # 3) 服务注册依旧复用 Service 层（禁止在 gRPC 层落业务）
  - id: grpc-reuse-service
    desc: gRPC handler 调用 Service；禁直接 DB/事务
    assert:
      type: ban-symbol
      target: backend/internal/grpc/**
      symbols:
        - direct_db_access
        - BeginTx(

  # 4) 错误码映射与拦截器链
  - id: grpc-interceptors
    desc: 必含 auth/tenant/logging/recovery，错误码映射 UNAUTHENTICATED/…
    assert:
      all:
        - type: grep
          target: backend/internal/grpc/server/**
          pattern:
            - interceptor:auth
            - interceptor:tenant
            - interceptor:logging
            - interceptor:recovery
        - type: grep
          target: backend/internal/grpc/**
          pattern:
            - UNAUTHENTICATED
            - PERMISSION_DENIED
            - NOT_FOUND
            - INVALID_ARGUMENT