You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@fesod.apache.org by ps...@apache.org on 2026/07/30 13:14:13 UTC
(fesod) branch main updated: fix: clone DataFormatData in WriteCellStyle.merge to avoid mutating cached annotation style (#957)
This is an automated email from the ASF dual-hosted git repository.
psxjoy pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/fesod.git
The following commit(s) were added to refs/heads/main by this push:
new c7993d53 fix: clone DataFormatData in WriteCellStyle.merge to avoid mutating cached annotation style (#957)
c7993d53 is described below
commit c7993d53959d02417f23ae12f09626ca279d2450
Author: Nikita Kuprins <61...@users.noreply.github.com>
AuthorDate: Thu Jul 30 16:14:08 2026 +0300
fix: clone DataFormatData in WriteCellStyle.merge to avoid mutating cached annotation style (#957)
* fix: clone DataFormatData in WriteCellStyle.merge to avoid mutating cached annotation style
A registered cell style strategy could permanently change the cached
@ContentStyle(dataFormat) of a field, because WriteCellStyle.merge copied
the source DataFormatData by reference and a later merge then wrote into
the shared object. Clone it like writeFont on the line below.
Closes #956
* test: tag test for filtering
Co-authored-by: Copilot Autofix powered by AI <17...@users.noreply.github.com>
---------
Co-authored-by: Bengbengbalabalabeng <70...@users.noreply.github.com>
Co-authored-by: Copilot Autofix powered by AI <17...@users.noreply.github.com>
---
.../sheet/write/metadata/style/WriteCellStyle.java | 2 +-
.../style/ContentStyleDataFormatPollutionTest.java | 150 +++++++++++++++++++++
2 files changed, 151 insertions(+), 1 deletion(-)
diff --git a/fesod-sheet/src/main/java/org/apache/fesod/sheet/write/metadata/style/WriteCellStyle.java b/fesod-sheet/src/main/java/org/apache/fesod/sheet/write/metadata/style/WriteCellStyle.java
index 2dc52ba7..31d1683e 100644
--- a/fesod-sheet/src/main/java/org/apache/fesod/sheet/write/metadata/style/WriteCellStyle.java
+++ b/fesod-sheet/src/main/java/org/apache/fesod/sheet/write/metadata/style/WriteCellStyle.java
@@ -179,7 +179,7 @@ public class WriteCellStyle {
}
if (source.getDataFormatData() != null) {
if (target.getDataFormatData() == null) {
- target.setDataFormatData(source.getDataFormatData());
+ target.setDataFormatData(source.getDataFormatData().clone());
} else {
DataFormatData.merge(source.getDataFormatData(), target.getDataFormatData());
}
diff --git a/fesod-sheet/src/test/java/org/apache/fesod/sheet/style/ContentStyleDataFormatPollutionTest.java b/fesod-sheet/src/test/java/org/apache/fesod/sheet/style/ContentStyleDataFormatPollutionTest.java
new file mode 100644
index 00000000..516beac7
--- /dev/null
+++ b/fesod-sheet/src/test/java/org/apache/fesod/sheet/style/ContentStyleDataFormatPollutionTest.java
@@ -0,0 +1,150 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+
+package org.apache.fesod.sheet.style;
+
+import java.io.File;
+import java.util.Arrays;
+import java.util.List;
+import lombok.AllArgsConstructor;
+import lombok.Data;
+import lombok.NoArgsConstructor;
+import org.apache.fesod.sheet.FesodSheet;
+import org.apache.fesod.sheet.annotation.ExcelProperty;
+import org.apache.fesod.sheet.annotation.write.style.ContentStyle;
+import org.apache.fesod.sheet.enums.CacheLocationEnum;
+import org.apache.fesod.sheet.metadata.data.DataFormatData;
+import org.apache.fesod.sheet.testkit.Tags;
+import org.apache.fesod.sheet.testkit.assertions.ExcelAssertions;
+import org.apache.fesod.sheet.testkit.base.AbstractExcelTest;
+import org.apache.fesod.sheet.testkit.enums.ExcelFormat;
+import org.apache.fesod.sheet.write.metadata.style.WriteCellStyle;
+import org.apache.fesod.sheet.write.style.HorizontalCellStyleStrategy;
+import org.junit.jupiter.api.Tag;
+import org.junit.jupiter.api.Test;
+
+/**
+ * A registered cell style strategy must not overwrite the cached {@link ContentStyle#dataFormat()}
+ * of a field. Before the fix, {@code WriteCellStyle.merge} aliased the annotation's shared
+ * {@link DataFormatData} into the per-cell style without cloning, so a later merge from another
+ * style source mutated the cached annotation format in place and subsequent cells (or, with
+ * {@link CacheLocationEnum#MEMORY}, subsequent writes) silently lost the annotation's number format.
+ */
+@Tag(Tags.ROUND_TRIP)
+public class ContentStyleDataFormatPollutionTest extends AbstractExcelTest {
+
+ private static final short STRATEGY_FORMAT = 2; // "0.00"
+ private static final String ANNOTATION_FORMAT = "#,##0.00"; // builtin index 4
+
+ @Data
+ @NoArgsConstructor
+ @AllArgsConstructor
+ public static class AnnotationFormatData {
+ @ExcelProperty("value")
+ @ContentStyle(dataFormat = 4)
+ private Double value;
+ }
+
+ /** Separate bean class so the static MEMORY cache of the other test cannot interfere. */
+ @Data
+ @NoArgsConstructor
+ @AllArgsConstructor
+ public static class AnnotationFormatMemoryData {
+ @ExcelProperty("value")
+ @ContentStyle(dataFormat = 4)
+ private Double value;
+ }
+
+ /**
+ * Content style list alternating between a style that defines a data format and one that does
+ * not, so odd data rows must fall back to the annotation's format.
+ */
+ private static HorizontalCellStyleStrategy alternatingStrategy() {
+ WriteCellStyle withFormat = new WriteCellStyle();
+ DataFormatData dataFormatData = new DataFormatData();
+ dataFormatData.setIndex(STRATEGY_FORMAT);
+ withFormat.setDataFormatData(dataFormatData);
+ WriteCellStyle withoutFormat = new WriteCellStyle();
+ return new HorizontalCellStyleStrategy(null, Arrays.asList(withFormat, withoutFormat));
+ }
+
+ @Test
+ void annotationFormatSurvivesStyleStrategyInSameWrite() throws Exception {
+ File file = createTempFile("dataFormatPollution", ExcelFormat.XLSX);
+ List<AnnotationFormatData> rows = Arrays.asList(
+ new AnnotationFormatData(1111.5), new AnnotationFormatData(2222.5), new AnnotationFormatData(3333.5));
+
+ FesodSheet.write(file, AnnotationFormatData.class)
+ .registerWriteHandler(alternatingStrategy())
+ .sheet()
+ .doWrite(rows);
+
+ try (ExcelAssertions ea = ExcelAssertions.assertThat(file)) {
+ ea.sheet(0)
+ .row(1)
+ .cell(0)
+ .hasDataFormat(STRATEGY_FORMAT)
+ .and()
+ .and()
+ // The strategy style for this row defines no format, so the
+ // @ContentStyle(dataFormat = 4) annotation must win.
+ .row(2)
+ .cell(0)
+ .hasDataFormatString(ANNOTATION_FORMAT)
+ .and()
+ .and()
+ .row(3)
+ .cell(0)
+ .hasDataFormat(STRATEGY_FORMAT);
+ }
+ }
+
+ @Test
+ void annotationFormatSurvivesAcrossWritesWithMemoryCache() throws Exception {
+ List<AnnotationFormatMemoryData> rows =
+ Arrays.asList(new AnnotationFormatMemoryData(1111.5), new AnnotationFormatMemoryData(2222.5));
+
+ File first = createTempFile("dataFormatPollutionMemA", ExcelFormat.XLSX);
+ FesodSheet.write(first, AnnotationFormatMemoryData.class)
+ .filedCacheLocation(CacheLocationEnum.MEMORY)
+ .registerWriteHandler(alternatingStrategy())
+ .sheet()
+ .doWrite(rows);
+
+ // A completely separate write without any custom handler: every data row
+ // must show the annotation's format.
+ File second = createTempFile("dataFormatPollutionMemB", ExcelFormat.XLSX);
+ FesodSheet.write(second, AnnotationFormatMemoryData.class)
+ .filedCacheLocation(CacheLocationEnum.MEMORY)
+ .sheet()
+ .doWrite(rows);
+
+ try (ExcelAssertions ea = ExcelAssertions.assertThat(second)) {
+ ea.sheet(0)
+ .row(1)
+ .cell(0)
+ .hasDataFormatString(ANNOTATION_FORMAT)
+ .and()
+ .and()
+ .row(2)
+ .cell(0)
+ .hasDataFormatString(ANNOTATION_FORMAT);
+ }
+ }
+}
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@fesod.apache.org
For additional commands, e-mail: commits-help@fesod.apache.org