feat(postgres-cdc): support replicating Postgres schema change

[StrikeW]

I hereby agree to the terms of the RisingWave Labs, Inc. Contributor License Agreement.

What's changed and what's your intention?

• Copy and patched the Debezium postgres conenctor (v2.6.2) to our project (patched code enclosing with /* patched */)

  • PgOutputMessageDecoder: dispatch schema change event when handling R message
  • Make PostgresSchema act as HistorizedDatabaseSchema which is a prerequisite to emit schema change event
  • Extends the ReplicationStream.ReplicationMessageProcessor to provide interfaces to emit schema change event

• Modify the jar loading order to ensure risingwave-source-cdc to be the first jar in the classpath so that the jvm can load those patched .class instead of the original classes

• The schema change event will not be emitted until new data events come in, so if DDL has been executed on upstream but there is no IUD on upstream, the schema change event will not be emitted

• Add auto.schema.change option to postgres source

Test Coverage:

• Added a new end-to-end test script auto_schema_change_pg.slt to verify the handling of automatic schema changes in PostgreSQL CDC sources. (e2e_test/source/cdc_inline/auto_schema_change_pg.slt)

Logging Enhancements:

• Updated logging statements in DbzChangeEventConsumer to include schema and data context in log messages. (java/connector-node/risingwave-connector-service/src/main/java/com/risingwave/connector/source/core/DbzChangeEventConsumer.java) [1] [2]

Configuration Updates:

• Added a new configuration property include.schema.changes to postgres.properties to control whether schema changes are included. (java/connector-node/risingwave-connector-service/src/main/resources/postgres.properties)

Miscellaneous:

• Updated .typos.toml to exclude certain Java files from typo checks. (.typos.toml)

Checklist

• I have written necessary rustdoc comments
• I have added necessary unit tests and integration tests
• I have added test labels as necessary. See details.
• I have added fuzzing tests or opened an issue to track them. (Optional, recommended for new SQL features Sqlsmith: Sql feature generation #7934).
• My PR contains breaking changes. (If it deprecates some features, please create a tracking issue to remove them in the future).
• All checks passed in ./risedev check (or alias, ./risedev c)
• My PR changes performance-critical code. (Please run macro/micro-benchmarks and show the results.)

• My PR contains critical fixes that are necessary to be merged into the latest release. (Please check out the details)

Documentation

• My PR needs documentation updates. (Please use the Release note section below to summarize the impact on users)

Release note

• Add auto.schema.change option to allow replicating Postgres table schema change

[github-actions]

license-eye has totally checked 5420 files.

Valid	Invalid	Ignored	Fixed
2306	5	3109	0

Click to see the invalid file list

• java/connector-node/risingwave-source-cdc/src/main/java/io/debezium/connector/postgresql/PostgresConnectorConfig.java
• java/connector-node/risingwave-source-cdc/src/main/java/io/debezium/connector/postgresql/PostgresSchema.java
• java/connector-node/risingwave-source-cdc/src/main/java/io/debezium/connector/postgresql/PostgresStreamingChangeEventSource.java
• java/connector-node/risingwave-source-cdc/src/main/java/io/debezium/connector/postgresql/connection/ReplicationStream.java
• java/connector-node/risingwave-source-cdc/src/main/java/io/debezium/connector/postgresql/connection/pgoutput/PgOutputMessageDecoder.java

[wenym1]

It's somehow hacky to do it in this way, because this depends on the behavior of the default class loader of specific jvm implementation. Not sure whether or not all class loaders always take the first seen class in the jar list.

Maybe we can try using the maven shade plugin to include all classes in the original jar and exclude the specific classes patched in this PR, and then we can explicitly exclude the some dbz artifacts in the pom file. The way to use shade plugin can be found in this example

[StrikeW]

It's somehow hacky to do it in this way, because this depends on the behavior of the default class loader of specific jvm implementation. Not sure whether or not all class loaders always take the first seen class in the jar list.

This concern can be eliminated by testing. Since we use same docker image in our ci pipeline and the cloud deployment, the behavior of jvm should be deterministic across our ci and cloud.

Maybe we can try using the maven shade plugin to include all classes in the original jar and exclude the specific classes patched in this PR, and then we can explicitly exclude the some dbz artifacts in the pom file. The way to use shade plugin can be found in this example

I think it is possible shadow original classes with the shade plugin, but we can do it in future pr if it is really needed.

[hzxa21]

Generally LGTM

[gitguardian]

⚠️ GitGuardian has uncovered 1 secret following the scan of your pull request.

Please consider investigating the findings and remediating the incidents. Failure to do so may lead to compromising the associated services or software components.

🔎 Detected hardcoded secret in your pull request

GitGuardian id	GitGuardian status	Secret	Commit	Filename
9425213	Triggered	Generic Password	e3e14f3	ci/scripts/e2e-source-test.sh	View secret

🛠 Guidelines to remediate hardcoded secrets

1. Understand the implications of revoking this secret by investigating where it is used in your code.
2. Replace and store your secret safely. Learn here the best practices.
3. Revoke and rotate this secret.
4. If possible, rewrite git history. Rewriting git history is not a trivial act. You might completely break other contributing developers' workflow and you risk accidentally deleting legitimate data.

To avoid such incidents in the future consider

• following these best practices for managing and storing secrets including API keys and other credentials
• install secret detection on pre-commit to catch secret before it leaves your machine and ease remediation.

---

^{🦉 GitGuardian detects secrets in your source code to help developers and security teams secure the modern development process. You are seeing this because you or someone else with access to this repository has authorized GitGuardian to scan your pull request.}