pingcap/tiflow

Refine code generator for canal protocol

Open

#1,107 opened on Nov 20, 2020

View on GitHubContributor guide
 (1 comment) (0 reactions) (0 assignees)Go (310 forks)auto 404
help wantedpriority/P2subject/new-feature

Repository metrics

Stars
 (461 stars)
PR merge metrics
 (PR metrics pending)

Description

Feature Request

Is your feature request related to a problem? Please describe:

Currently TiCDC maintains a simple canal protocol code generator script, but it lacks version management for protoc, and has one enum name conflict issue (ref: https://github.com/pingcap/ticdc/issues/1071)

Describe the feature you'd like:

  • Separate EntryProtocol and CanalProtocol into two packages to avoid name conflicts.
  • Add version management for protoc

Contributor guide

Research direction
Examine the current canal protocol code generator script, identify the enum name conflict, and implement separate packages for EntryProtocol and CanalProtocol. Also add protoc version management.
Tech stack
go
Domain
backenddatabase
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
GoProtobufGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70