fix: implement CompressorSevenz and add missing compressor unit tests by Jitmisra · Pull Request #1050 · apache/incubator-seata-go

Jitmisra · 2026-03-01T08:31:51Z

What this PR does

Fixes #1049 — CompressorSevenz type was registered in compressor_type.go but never implemented, causing users who configure "Sevenz" compression to silently receive no compression at all.

This PR:

Implements the Sevenz compressor in 7z_compress.go using LZMA (the core algorithm behind 7-Zip)
Adds the missing switch case CompressorSevenz in GetCompressor()
Adds unit tests for 7z_compress.go, none_compressor.go, and a table-driven test for compressor_type.go

Which issue(s) this PR fixes

Fixes #1049

This is the same class of bug as #1012 (fixed in #1013), where Zip.GetCompressorType() returned CompressorZstd instead of CompressorZip.

Bug Explained (Before → After)

Before (Broken)

flowchart LR
    A["User configures\ncompressor: Sevenz"] --> B["GetCompressor()\ncalled"]
    B --> C{"switch on\nCompressorType"}
    C -->|"No matching case"| D["default:\nreturn NoneCompressor"]
    D --> E["❌ Data sent\nUNCOMPRESSED"]

    style A fill:#ff6b6b,color:#fff
    style D fill:#ff6b6b,color:#fff
    style E fill:#ff6b6b,color:#fff

After (Fixed)

flowchart LR
    A["User configures\ncompressor: Sevenz"] --> B["GetCompressor()\ncalled"]
    B --> C{"switch on\nCompressorType"}
    C -->|"case CompressorSevenz"| D["return &Sevenz{}"]
    D --> E["✅ Data compressed\nusing LZMA"]

    style A fill:#51cf66,color:#fff
    style D fill:#51cf66,color:#fff
    style E fill:#51cf66,color:#fff

Compressor Architecture

All compressors implement the same Compressor interface:

classDiagram
    class Compressor {
        <<interface>>
        +Compress([]byte) ([]byte, error)
        +Decompress([]byte) ([]byte, error)
        +GetCompressorType() CompressorType
    }

    Compressor <|.. NoneCompressor
    Compressor <|.. Gzip
    Compressor <|.. Zip
    Compressor <|.. Sevenz : 🆕 NEW
    Compressor <|.. Bzip2
    Compressor <|.. Lz4
    Compressor <|.. Zstd
    Compressor <|.. Snappy
    Compressor <|.. DeflateCompress

    class Sevenz {
        +Compress(data []byte) ([]byte, error)
        +Decompress(data []byte) ([]byte, error)
        +GetCompressorType() CompressorType
    }

    note for Sevenz "Uses github.com/ulikunitz/xz/lzma\n(LZMA algorithm — core of 7-Zip)"

Changed Files

File	Type	Change
`pkg/compressor/7z_compress.go`	Modified	Implemented `Sevenz` struct with LZMA `Compress`/`Decompress` methods
`pkg/compressor/compressor_type.go`	Modified	Added `case CompressorSevenz: return &Sevenz{}` to `GetCompressor()`
`pkg/compressor/7z_compress_test.go`	New	Roundtrip compress/decompress test + type assertion
`pkg/compressor/none_compressor_test.go`	New	Pass-through verification + type assertion
`pkg/compressor/compressor_type_test.go`	New	Table-driven test for all 9 `CompressorType` values + unknown fallback
`go.mod`	Modified	Promoted `github.com/ulikunitz/xz` to direct dependency
`go.sum`	Modified	Updated checksums
`changes/dev.md`	Modified	Added changelog entry for #1049

Key Code Changes

1. `7z_compress.go` — Sevenz Implementation

type Sevenz struct{}

// Compress using LZMA algorithm (core of 7-Zip)
func (s *Sevenz) Compress(data []byte) ([]byte, error) {
    var buffer bytes.Buffer
    writer, err := lzma.NewWriter(&buffer)
    if err != nil {
        return nil, err
    }
    if _, err := writer.Write(data); err != nil {
        return nil, err
    }
    if err := writer.Close(); err != nil {
        return nil, err
    }
    return buffer.Bytes(), nil
}

// Decompress using LZMA algorithm
func (s *Sevenz) Decompress(data []byte) ([]byte, error) {
    reader, err := lzma.NewReader(bytes.NewReader(data))
    if err != nil {
        return nil, err
    }
    return ioutil.ReadAll(reader)
}

func (s *Sevenz) GetCompressorType() CompressorType {
    return CompressorSevenz
}

2. `compressor_type.go` — Switch Case Addition

  case CompressorZip:
      return &Zip{}
+ case CompressorSevenz:
+     return &Sevenz{}
  case CompressorBzip2:
      return &Bzip2{}

3. `compressor_type_test.go` — Table-Driven Test (Prevents Future Regressions)

func TestGetCompressor(t *testing.T) {
    tests := []struct {
        name           string
        compressorType CompressorType
        wantType       CompressorType
    }{
        {"None compressor",    CompressorNone,    CompressorNone},
        {"Gzip compressor",    CompressorGzip,    CompressorGzip},
        {"Zip compressor",     CompressorZip,     CompressorZip},
        {"Sevenz compressor",  CompressorSevenz,  CompressorSevenz},   // ← catches this bug
        {"Bzip2 compressor",   CompressorBzip2,   CompressorBzip2},
        {"Lz4 compressor",     CompressorLz4,     CompressorLz4},
        {"Deflate compressor", CompressorDeflate, CompressorDeflate},
        {"Zstd compressor",    CompressorZstd,    CompressorZstd},
        {"Snappy compressor",  CompressorSnappy,  CompressorSnappy},
        {"Unknown falls back", CompressorType("Unknown"), CompressorNone},
    }
    for _, tt := range tests {
        t.Run(tt.name, func(t *testing.T) {
            compressor := tt.compressorType.GetCompressor()
            assert.NotNil(t, compressor)
            assert.EqualValues(t, tt.wantType, compressor.GetCompressorType())
        })
    }
}

Verification Results

Unit Tests — 10/10 PASS ✅

=== RUN   TestSevenzCompress
--- PASS: TestSevenzCompress (0.00s)
=== RUN   TestGetCompressor
    --- PASS: TestGetCompressor/None_compressor (0.00s)
    --- PASS: TestGetCompressor/Gzip_compressor (0.00s)
    --- PASS: TestGetCompressor/Zip_compressor (0.00s)
    --- PASS: TestGetCompressor/Sevenz_compressor (0.00s)
    --- PASS: TestGetCompressor/Bzip2_compressor (0.00s)
    --- PASS: TestGetCompressor/Lz4_compressor (0.00s)
    --- PASS: TestGetCompressor/Deflate_compressor (0.00s)
    --- PASS: TestGetCompressor/Zstd_compressor (0.00s)
    --- PASS: TestGetCompressor/Snappy_compressor (0.00s)
    --- PASS: TestGetCompressor/Unknown_compressor_falls_back_to_None (0.00s)
--- PASS: TestGetCompressor (0.00s)
=== RUN   TestNoneCompressorCompress
--- PASS: TestNoneCompressorCompress (0.00s)
PASS
ok  seata.apache.org/seata-go/v2/pkg/compressor  0.681s

Additional Checks

Check	Result
`go vet`	✅ Clean
Race detector (`go test -race`)	✅ Clean
Code coverage	77.2% of statements
License headers (ASF 2.0)	✅ Present on all files
Pattern consistency	✅ Matches Bzip2/Gzip style

codecov-commenter · 2026-03-01T15:26:29Z

Codecov Report

❌ Patch coverage is 56.52174% with 10 lines in your changes missing coverage. Please review.
✅ Project coverage is 57.36%. Comparing base (9a11740) to head (a7e4cb6).

Files with missing lines	Patch %	Lines
pkg/compressor/7z_compress.go	52.38%	5 Missing and 5 partials ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1050      +/-   ##
==========================================
+ Coverage   57.18%   57.36%   +0.18%     
==========================================
  Files         267      268       +1     
  Lines       17526    17549      +23     
==========================================
+ Hits        10022    10067      +45     
+ Misses       6680     6653      -27     
- Partials      824      829       +5

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

thunguo · 2026-03-01T15:41:56Z

+		return nil, err
+	}
+
+	decompressed, err := ioutil.ReadAll(reader)


ioutil is deprecated. Wouldn't it be better to use io.ReadAll(reader) instead?

ioutil is deprecated. Wouldn't it be better to use io.ReadAll(reader) instead?

sure thanks

thunguo · 2026-03-01T15:46:57Z

+		return nil, err
+	}
+
+	if err := writer.Close(); err != nil {


The write operation here throws an error, causing the Close operation to fail. Would defer be better?

sure thanks

thunguo · 2026-03-01T15:56:33Z

If you are interested in SeataGo or would like to continue contributing, you can add me on WeChat FinnTew

Jitmisra · 2026-03-01T16:34:51Z

If you are interested in SeataGo or would like to continue contributing, you can add me on WeChat FinnTew

Hi thunguo,

Thank you for offering to connect on WeChat. Unfortunately, WeChat isn’t available in my region, so I’m unable to use it.

Would it be possible to continue the discussion via email or any other platform you prefer?

I’m very interested in continuing to contribute to Seata-Go, and I’m especially keen on working on the GSoC multi-database AT support idea this year. I’d really appreciate the opportunity to discuss how I can prepare and contribute effectively.

Thank you again!

…apache#1049)

thunguo · 2026-03-01T16:44:18Z

If you are interested in SeataGo or would like to continue contributing, you can add me on WeChat FinnTew

Hi Feng,

Thank you for offering to connect on WeChat. Unfortunately, WeChat isn’t available in my region, so I’m unable to use it.

Would it be possible to continue the discussion via email or any other platform you prefer?

I’m very interested in continuing to contribute to Seata-Go, and I’m especially keen on working on the GSoC multi-database AT support idea this year. I’d really appreciate the opportunity to discuss how I can prepare and contribute effectively.

Thank you again!

Okay, the community is very welcoming to new contributors, you can join through tew@apache.org Contact me via email or through zfeng@apache.org Contact Feng, the mentor of the multi-database project, via email.

Jitmisra · 2026-03-01T16:52:00Z

If you are interested in SeataGo or would like to continue contributing, you can add me on WeChat FinnTew

Hi Feng,
Thank you for offering to connect on WeChat. Unfortunately, WeChat isn’t available in my region, so I’m unable to use it.
Would it be possible to continue the discussion via email or any other platform you prefer?
I’m very interested in continuing to contribute to Seata-Go, and I’m especially keen on working on the GSoC multi-database AT support idea this year. I’d really appreciate the opportunity to discuss how I can prepare and contribute effectively.
Thank you again!

Okay, the community is very welcoming to new contributors, you can join through tew@apache.org Contact me via email or through zfeng@apache.org Contact Feng, the mentor of the multi-database project, via email.

Thank you very much for the guidance and for sharing the contact details.

I’ll reach out via email to continue the discussion and start contributing more actively to SeataGo.

I truly appreciate the welcoming environment of the community and look forward to contributing further.

AlexStocks

Code Review: fix: implement CompressorSevenz and add missing compressor unit tests

评价

问题修复正确，实现了缺失的 CompressorSevenz，并添加了完整的单元测试。测试覆盖率达到 77.2%。

[P1] 规范级问题

1. pkg/compressor/7z_compress.go - 命名混淆

文件名为 7z_compress.go，但实际使用的是 LZMA 算法（来自 github.com/ulikunitz/xz/lzma）：

import "github.com/ulikunitz/xz/lzma"

func (s *Sevenz) Compress(data []byte) ([]byte, error) {
    writer, err := lzma.NewWriter(&buffer)
    // ...
}

7z 格式支持多种算法（LZMA, LZMA2, PPMd 等），当前实现仅支持 LZMA。

建议：

重命名为 lzma_compress.go 并将 CompressorSevenz 改为 CompressorLzma
或在注释中明确说明使用 LZMA 算法的原因

// Sevenz implements compression using LZMA algorithm.
// Note: This implementation uses the LZMA codec from xz library,
// which is the core algorithm used in 7-Zip. It does not produce
// actual .7z container format.
type Sevenz struct{}

2. 边界测试缺失

测试用例缺少：

空数据压缩/解压
超大数据（>1MB）压缩
损坏数据解压错误处理

建议补充：

func TestSevenzCompress_EmptyData(t *testing.T) {
    s := &Sevenz{}
    compressed, err := s.Compress([]byte{})
    assert.NoError(t, err)
    decompressed, err := s.Decompress(compressed)
    assert.NoError(t, err)
    assert.Empty(t, decompressed)
}

func TestSevenzDecompress_InvalidData(t *testing.T) {
    s := &Sevenz{}
    _, err := s.Decompress([]byte{0x00, 0x01, 0x02})
    assert.Error(t, err)
}

3. changes/dev.md 格式问题

修改后的文件格式不一致：

-  [[#130](...)] getty session auto close bug
+ - [[#130](...)] getty session auto close bug

总体评价：修复正确有效，建议明确命名与实际实现的关系。

thunguo self-requested a review March 1, 2026 15:22

thunguo reviewed Mar 1, 2026

View reviewed changes

Jitmisra force-pushed the fix/compressor-sevenz-1049 branch from 9013a65 to d015bab Compare March 1, 2026 16:26

github-actions Bot added bug Something isn't working documentation Improvements or additions to documentation enhancement New feature or request labels Mar 1, 2026

fix: implement CompressorSevenz and add missing compressor unit tests (…

e07f5ac

…apache#1049)

Jitmisra force-pushed the fix/compressor-sevenz-1049 branch from d015bab to e07f5ac Compare March 1, 2026 16:39

thunguo and others added 3 commits March 10, 2026 17:37

Merge branch 'master' into fix/compressor-sevenz-1049

3029229

Merge branch 'master' into fix/compressor-sevenz-1049

3dd7e56

Merge branch 'master' into fix/compressor-sevenz-1049

b4666a8

AlexStocks reviewed Mar 29, 2026

View reviewed changes

Ethan-Xingyue and others added 2 commits April 11, 2026 19:46

Merge branch 'master' into fix/compressor-sevenz-1049

a7e4cb6

Merge branch 'master' into fix/compressor-sevenz-1049

813bbca

thunguo closed this Apr 22, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: implement CompressorSevenz and add missing compressor unit tests#1050

fix: implement CompressorSevenz and add missing compressor unit tests#1050
Jitmisra wants to merge 6 commits intoapache:masterfrom
Jitmisra:fix/compressor-sevenz-1049

Jitmisra commented Mar 1, 2026

Uh oh!

codecov-commenter commented Mar 1, 2026 •

edited

Loading

Uh oh!

thunguo Mar 1, 2026

Uh oh!

Jitmisra Mar 1, 2026

Uh oh!

thunguo Mar 1, 2026

Uh oh!

Jitmisra Mar 1, 2026

Uh oh!

thunguo commented Mar 1, 2026

Uh oh!

Jitmisra commented Mar 1, 2026 •

edited

Loading

Uh oh!

thunguo commented Mar 1, 2026

Uh oh!

Jitmisra commented Mar 1, 2026

Uh oh!

AlexStocks left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

Jitmisra commented Mar 1, 2026

What this PR does

Which issue(s) this PR fixes

Bug Explained (Before → After)

Before (Broken)

After (Fixed)

Compressor Architecture

Changed Files

Key Code Changes

1. 7z_compress.go — Sevenz Implementation

2. compressor_type.go — Switch Case Addition

3. compressor_type_test.go — Table-Driven Test (Prevents Future Regressions)

Verification Results

Unit Tests — 10/10 PASS ✅

Additional Checks

Uh oh!

codecov-commenter commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

thunguo Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Jitmisra Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

thunguo Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

Jitmisra Mar 1, 2026

Choose a reason for hiding this comment

Uh oh!

thunguo commented Mar 1, 2026

Uh oh!

Jitmisra commented Mar 1, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

thunguo commented Mar 1, 2026

Uh oh!

Jitmisra commented Mar 1, 2026

Uh oh!

AlexStocks left a comment

Choose a reason for hiding this comment

Code Review: fix: implement CompressorSevenz and add missing compressor unit tests

评价

[P1] 规范级问题

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

1. `7z_compress.go` — Sevenz Implementation

2. `compressor_type.go` — Switch Case Addition

3. `compressor_type_test.go` — Table-Driven Test (Prevents Future Regressions)

codecov-commenter commented Mar 1, 2026 •

edited

Loading

Jitmisra commented Mar 1, 2026 •

edited

Loading