bugfix: handle timestamp with time zone in postgresql primary key #7908

lokidundun · 2025-12-29T14:08:28Z

I have read the CONTRIBUTING.md guidelines.
I have registered the PR changes.

Ⅰ. Describe what this PR did

handle timestamp with time zone in postgresql primary key

Ⅱ. Does this pull request fix one issue?

fixes #5624

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

codecov · 2025-12-29T14:33:29Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 71.26%. Comparing base (2897be9) to head (e8a26c5).
⚠️ Report is 1 commits behind head on 2.x.

Additional details and impacted files

@@            Coverage Diff            @@
##                2.x    #7908   +/-   ##
=========================================
  Coverage     71.26%   71.26%           
  Complexity      835      835           
=========================================
  Files          1294     1294           
  Lines         49550    49554    +4     
  Branches       5883     5884    +1     
=========================================
+ Hits          35311    35314    +3     
- Misses        11331    11333    +2     
+ Partials       2908     2907    -1

Files with missing lines	Coverage Δ
...e/seata/rm/datasource/sql/struct/TableRecords.java	`68.46% <100.00%> (+0.57%)`	⬆️
...m/datasource/undo/parser/JacksonUndoLogParser.java	`69.01% <100.00%> (+0.24%)`	⬆️

... and 7 files with indirect coverage changes

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Copilot

Pull request overview

This pull request adds support for handling PostgreSQL's TIMESTAMP WITH TIMEZONE data type in primary keys and other columns. The fix addresses issue #5624 by adding proper handling for the standard JDBC Types.TIMESTAMP_WITH_TIMEZONE constant (used by PostgreSQL) alongside the existing Oracle-specific timestamp types.

Key Changes:

Added handling for Types.TIMESTAMP_WITH_TIMEZONE in TableRecords.buildRecords() to properly read and convert PostgreSQL timestamp values using OffsetDateTime
Integrated Jackson's JavaTimeModule to support serialization/deserialization of OffsetDateTime and other Java 8 time types in undo logs
Added comprehensive test coverage for the new timestamp type handling

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
rm-datasource/src/main/java/org/apache/seata/rm/datasource/sql/struct/TableRecords.java	Added new condition to handle `Types.TIMESTAMP_WITH_TIMEZONE` by retrieving values as `OffsetDateTime` objects
rm-datasource/src/main/java/org/apache/seata/rm/datasource/undo/parser/JacksonUndoLogParser.java	Registered `JavaTimeModule` to enable proper JSON serialization/deserialization of `OffsetDateTime` for undo logs
rm-datasource/pom.xml	Added Jackson datatype dependencies (`jackson-datatype-jdk8` and `jackson-datatype-jsr310`) to support Java 8 time types
rm-datasource/src/test/java/org/apache/seata/rm/datasource/sql/struct/TableRecordsTest.java	Added test case `testBuildRecordsWithOffsetDateTime` to verify correct handling of timestamp with timezone fields
changes/en-us/2.x.md	Added changelog entry documenting the PostgreSQL timestamp fix
changes/zh-cn/2.x.md	Added Chinese changelog entry documenting the PostgreSQL timestamp fix

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-30T02:32:10Z

...atasource/src/main/java/org/apache/seata/rm/datasource/undo/parser/JacksonUndoLogParser.java

+        JavaTimeModule javaTimeModule = new JavaTimeModule();
+        mapper.registerModules(module, javaTimeModule);


The JavaTimeModule already provides serializers and deserializers for LocalDateTime and other Java 8 date/time types. Adding it alongside custom LocalDateTime serializers (localDateTimeSerializer and localDateTimeDeserializer) may cause conflicts or unexpected behavior. Consider removing the custom LocalDateTime serializer/deserializer registration on lines 184-185, or verify that the custom implementation is intentionally overriding the default JavaTimeModule behavior.

Copilot · 2025-12-30T02:32:11Z

rm-datasource/pom.xml

+            <artifactId>jackson-datatype-jdk8</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>com.fasterxml.jackson.datatype</groupId>


The jackson-datatype-jdk8 dependency appears to be unused in the codebase. This module provides support for JDK 8 features like Optional, OptionalInt, etc., but there's no code that explicitly uses these Jackson JDK 8 serializers. If this dependency is not needed, consider removing it to keep dependencies minimal. Only jackson-datatype-jsr310 is needed for OffsetDateTime and other java.time types.

Suggested change

<artifactId>jackson-datatype-jdk8</artifactId>

</dependency>

<dependency>

<groupId>com.fasterxml.jackson.datatype</groupId>

Copilot · 2025-12-30T02:32:11Z

...atasource/src/main/java/org/apache/seata/rm/datasource/undo/parser/JacksonUndoLogParser.java

+        JavaTimeModule javaTimeModule = new JavaTimeModule();
+        mapper.registerModules(module, javaTimeModule);


Consider adding a test case in JacksonUndoLogParserTest to verify that OffsetDateTime values can be properly serialized and deserialized. While there's a test for LocalDateTime (lines 114-125), there's no test for OffsetDateTime which is now supported through the JavaTimeModule. This would ensure that undo logs containing PostgreSQL TIMESTAMP WITH TIMEZONE fields can be correctly persisted and restored.

Copilot · 2025-12-30T02:32:11Z

rm-datasource/src/test/java/org/apache/seata/rm/datasource/sql/struct/TableRecordsTest.java

+        new Object[] {1, OffsetDateTime.now()},
+    };


Using OffsetDateTime.now() creates a non-deterministic test value which can make test results harder to reproduce and debug. Consider using a fixed OffsetDateTime value instead, such as OffsetDateTime.of(2024, 1, 15, 10, 30, 45, 0, ZoneOffset.UTC) to ensure consistent and reproducible test behavior.

Copilot · 2025-12-30T02:32:11Z

rm-datasource/src/test/java/org/apache/seata/rm/datasource/sql/struct/TableRecordsTest.java

+        MockStatementBase mockStatement = new MockStatement(getPhysicsConnection(dataSource));
+        DataSourceProxy proxy = DataSourceProxyTest.getDataSourceProxy(dataSource);
+
+        TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)
+                .refresh(proxy.getPlainConnection(), proxy.getResourceId());
+
+        TableMeta tableMeta = TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)
+                .getTableMeta(proxy.getPlainConnection(), "table_records_test", proxy.getResourceId());
+
+        ResultSet originalResultSet = mockDriver.executeQuery(mockStatement, "select * from table_records_test");
+
+        ResultSet proxyResultSet = (ResultSet) java.lang.reflect.Proxy.newProxyInstance(
+                TableRecordsTest.class.getClassLoader(), new Class[] {ResultSet.class}, (p, method, args) -> {
+                    if ("getObject".equals(method.getName()) && args.length == 2 && args[1] == OffsetDateTime.class) {
+                        return originalResultSet.getObject((Integer) args[0]);
+                    }
+                    try {
+                        return method.invoke(originalResultSet, args);
+                    } catch (java.lang.reflect.InvocationTargetException e) {
+                        throw e.getTargetException();
+                    }
+                });
+
+        TableRecords tableRecords = TableRecords.buildRecords(tableMeta, proxyResultSet);
+
+        Assertions.assertNotNull(tableRecords);
+        Assertions.assertEquals(1, tableRecords.size());
+
+        Row row = tableRecords.getRows().get(0);
+        Field timeField = row.getFields().stream()
+                .filter(f -> "time_col".equalsIgnoreCase(f.getName()))
+                .findFirst()
+                .orElseThrow(() -> new RuntimeException("time_col not found"));
+
+        Assertions.assertEquals(Types.TIMESTAMP_WITH_TIMEZONE, timeField.getType());
+        Assertions.assertTrue(timeField.getValue() instanceof OffsetDateTime);


This MockStatement is not always closed on method exit.

Suggested change

MockStatementBase mockStatement = new MockStatement(getPhysicsConnection(dataSource));

DataSourceProxy proxy = DataSourceProxyTest.getDataSourceProxy(dataSource);

TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)

.refresh(proxy.getPlainConnection(), proxy.getResourceId());

TableMeta tableMeta = TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)

.getTableMeta(proxy.getPlainConnection(), "table_records_test", proxy.getResourceId());

ResultSet originalResultSet = mockDriver.executeQuery(mockStatement, "select * from table_records_test");

ResultSet proxyResultSet = (ResultSet) java.lang.reflect.Proxy.newProxyInstance(

TableRecordsTest.class.getClassLoader(), new Class[] {ResultSet.class}, (p, method, args) -> {

if ("getObject".equals(method.getName()) && args.length == 2 && args[1] == OffsetDateTime.class) {

return originalResultSet.getObject((Integer) args[0]);

}

try {

return method.invoke(originalResultSet, args);

} catch (java.lang.reflect.InvocationTargetException e) {

throw e.getTargetException();

}

});

TableRecords tableRecords = TableRecords.buildRecords(tableMeta, proxyResultSet);

Assertions.assertNotNull(tableRecords);

Assertions.assertEquals(1, tableRecords.size());

Row row = tableRecords.getRows().get(0);

Field timeField = row.getFields().stream()

.filter(f -> "time_col".equalsIgnoreCase(f.getName()))

.findFirst()

.orElseThrow(() -> new RuntimeException("time_col not found"));

Assertions.assertEquals(Types.TIMESTAMP_WITH_TIMEZONE, timeField.getType());

Assertions.assertTrue(timeField.getValue() instanceof OffsetDateTime);

try (MockStatementBase mockStatement = new MockStatement(getPhysicsConnection(dataSource))) {

DataSourceProxy proxy = DataSourceProxyTest.getDataSourceProxy(dataSource);

TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)

.refresh(proxy.getPlainConnection(), proxy.getResourceId());

TableMeta tableMeta = TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)

.getTableMeta(proxy.getPlainConnection(), "table_records_test", proxy.getResourceId());

ResultSet originalResultSet = mockDriver.executeQuery(mockStatement, "select * from table_records_test");

ResultSet proxyResultSet = (ResultSet) java.lang.reflect.Proxy.newProxyInstance(

TableRecordsTest.class.getClassLoader(), new Class[] {ResultSet.class}, (p, method, args) -> {

if ("getObject".equals(method.getName()) && args.length == 2 && args[1] == OffsetDateTime.class) {

return originalResultSet.getObject((Integer) args[0]);

}

try {

return method.invoke(originalResultSet, args);

} catch (java.lang.reflect.InvocationTargetException e) {

throw e.getTargetException();

}

});

TableRecords tableRecords = TableRecords.buildRecords(tableMeta, proxyResultSet);

Assertions.assertNotNull(tableRecords);

Assertions.assertEquals(1, tableRecords.size());

Row row = tableRecords.getRows().get(0);

Field timeField = row.getFields().stream()

.filter(f -> "time_col".equalsIgnoreCase(f.getName()))

.findFirst()

.orElseThrow(() -> new RuntimeException("time_col not found"));

Assertions.assertEquals(Types.TIMESTAMP_WITH_TIMEZONE, timeField.getType());

Assertions.assertTrue(timeField.getValue() instanceof OffsetDateTime);

}

…into pgbug

Copilot

Pull request overview

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2025-12-31T03:21:10Z

rm-datasource/src/test/java/org/apache/seata/rm/datasource/sql/struct/TableRecordsTest.java

+            TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)
+                    .refresh(proxy.getPlainConnection(), proxy.getResourceId());
+            TableMeta tableMeta = TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)


The test is using JdbcConstants.MYSQL for a test that is specifically designed to test PostgreSQL's TIMESTAMP_WITH_TIMEZONE handling. This is misleading and could lead to incorrect test behavior. The test should use JdbcConstants.POSTGRESQL instead to properly reflect the database being tested.

Suggested change

TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)

.refresh(proxy.getPlainConnection(), proxy.getResourceId());

TableMeta tableMeta = TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)

TableMetaCacheFactory.getTableMetaCache(JdbcConstants.POSTGRESQL)

.refresh(proxy.getPlainConnection(), proxy.getResourceId());

TableMeta tableMeta = TableMetaCacheFactory.getTableMetaCache(JdbcConstants.POSTGRESQL)

Copilot · 2025-12-31T03:21:10Z

rm-datasource/src/test/java/org/apache/seata/rm/datasource/sql/struct/TableRecordsTest.java

+    @Test
+    public void testBuildRecordsWithOffsetDateTime() throws SQLException {
+        MockDriver mockDriver = new MockDriver(
+                returnValueColumnLabelsOffsetDateTime,
+                returnValueOffsetDateTime,
+                columnMetasOffsetDateTime,
+                indexMetas);
+
+        DruidDataSource dataSource = new DruidDataSource();
+        dataSource.setUrl("jdbc:mock:offset");
+        dataSource.setDriver(mockDriver);
+
+        try (MockStatementBase mockStatement = new MockStatement(getPhysicsConnection(dataSource))) {
+            DataSourceProxy proxy = DataSourceProxyTest.getDataSourceProxy(dataSource);
+            TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)
+                    .refresh(proxy.getPlainConnection(), proxy.getResourceId());
+            TableMeta tableMeta = TableMetaCacheFactory.getTableMetaCache(JdbcConstants.MYSQL)
+                    .getTableMeta(proxy.getPlainConnection(), "table_records_test", proxy.getResourceId());
+            ResultSet originalResultSet = mockDriver.executeQuery(mockStatement, "select * from table_records_test");
+            ResultSet proxyResultSet = (ResultSet) java.lang.reflect.Proxy.newProxyInstance(
+                    TableRecordsTest.class.getClassLoader(), new Class[] {ResultSet.class}, (p, method, args) -> {
+                        if ("getObject".equals(method.getName())
+                                && args.length == 2
+                                && args[1] == OffsetDateTime.class) {
+                            return originalResultSet.getObject((Integer) args[0]);
+                        }
+                        try {
+                            return method.invoke(originalResultSet, args);
+                        } catch (java.lang.reflect.InvocationTargetException e) {
+                            throw e.getTargetException();
+                        }
+                    });
+            TableRecords tableRecords = TableRecords.buildRecords(tableMeta, proxyResultSet);
+            Assertions.assertNotNull(tableRecords);
+            Assertions.assertEquals(1, tableRecords.size());
+            Row row = tableRecords.getRows().get(0);
+            Field timeField = row.getFields().stream()
+                    .filter(f -> "time_col".equalsIgnoreCase(f.getName()))
+                    .findFirst()
+                    .orElseThrow(() -> new RuntimeException("time_col not found"));
+            Assertions.assertEquals(Types.TIMESTAMP_WITH_TIMEZONE, timeField.getType());
+            Assertions.assertTrue(timeField.getValue() instanceof OffsetDateTime);
+        }
+    }


The test lacks coverage for the serialization and deserialization of OffsetDateTime through the JacksonUndoLogParser. While the test verifies that OffsetDateTime can be retrieved from the ResultSet and stored in a Field, it doesn't test the critical path of serializing/deserializing this data through the undo log, which is the primary use case affected by the JavaTimeModule registration in JacksonUndoLogParser.

funky-eyes

LGTM

lokidundun added 2 commits December 29, 2025 22:02

fix:handle timestamp with time zone in postgresql primary key

03ae247

log change

970e344

lokidundun and others added 2 commits December 30, 2025 00:55

test:add test

c695599

Merge branch '2.x' into pgbug

735e9f8

funky-eyes requested a review from Copilot December 30, 2025 02:24

Copilot started reviewing on behalf of funky-eyes December 30, 2025 02:25 View session

Copilot AI reviewed Dec 30, 2025

View reviewed changes

lokidundun and others added 4 commits December 30, 2025 15:48

optimize the logic

0534508

Merge branch 'pgbug' of https://github.com/lokidundun/incubator-seata …

d364b88

…into pgbug

run mvn spotless

1c6a145

Merge branch '2.x' into pgbug

e42382f

funky-eyes requested a review from Copilot December 31, 2025 03:14

Copilot started reviewing on behalf of funky-eyes December 31, 2025 03:14 View session

Copilot AI reviewed Dec 31, 2025

View reviewed changes

funky-eyes added this to the 2.6.0 milestone Dec 31, 2025

funky-eyes added type: bug Category issues or prs related to bug. module/rm-datasource rm-datasource module mode: AT AT transaction mode multilingual labels Dec 31, 2025

lokidundun and others added 3 commits December 31, 2025 20:26

add test for the serialization and deserialization

bbc7d02

Merge branch '2.x' into pgbug

44044cf

Merge branch '2.x' into pgbug

e8a26c5

funky-eyes approved these changes Jan 4, 2026

View reviewed changes

funky-eyes merged commit 5923c62 into apache:2.x Jan 4, 2026
11 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

bugfix: handle timestamp with time zone in postgresql primary key #7908

bugfix: handle timestamp with time zone in postgresql primary key #7908

Uh oh!

lokidundun commented Dec 29, 2025 •

edited

Loading

Uh oh!

codecov bot commented Dec 29, 2025 •

edited

Loading

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 30, 2025

Uh oh!

Copilot AI Dec 30, 2025

Uh oh!

Copilot AI Dec 30, 2025

Uh oh!

Copilot AI Dec 30, 2025

Uh oh!

Copilot AI Dec 30, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

Copilot AI Dec 31, 2025

Uh oh!

funky-eyes left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		JavaTimeModule javaTimeModule = new JavaTimeModule();
		mapper.registerModules(module, javaTimeModule);

bugfix: handle timestamp with time zone in postgresql primary key #7908

bugfix: handle timestamp with time zone in postgresql primary key #7908

Uh oh!

Conversation

lokidundun commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Ⅰ. Describe what this PR did

Ⅱ. Does this pull request fix one issue?

Ⅲ. Why don't you add test cases (unit test/integration test)?

Ⅳ. Describe how to verify it

Ⅴ. Special notes for reviews

Uh oh!

codecov bot commented Dec 29, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 30, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Dec 31, 2025

Choose a reason for hiding this comment

Uh oh!

funky-eyes left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

lokidundun commented Dec 29, 2025 •

edited

Loading

codecov bot commented Dec 29, 2025 •

edited

Loading