Artifact e28aad16c4043b45519229e72dcb13317c82eadc89b5fb1e0aefa7792227e638:
- File
internal/blob/compress.go
— part of check-in
[6273a0750d]
at
2026-07-22 23:03:24
on branch trunk
— fix: correct go.mod module path to go-libfossil (#76) (#117)
* fix: correct go.mod module path to go-libfossil (#76)
The module directive still declared github.com/danmestas/libfossil after the repository was renamed to go-libfossil. pkg.go.dev/godoc scraping matches the declared module path against its hosting path, so the stale path broke SDK doc generation.
Rename the module path across all four in-repo modules (root, the two db/driver submodules, observer/otel, and docs/site) and every internal import, plus the release workflow, the doc-generation script, and the docs.
No tag has been published under the go-libfossil path yet, so the cross-module requires cannot resolve from the proxy. Add replace directives pointing the in-repo requires at their local directories so GOWORK=off builds and the CI matrix resolve without a published version. These replaces are ignored by downstream consumers and can be dropped once new-path tags are cut.
* Guard releases against replace directives; regenerate SDK docs
The go-libfossil rename bridges the in-repo modules with `replace` directives. Go refuses a main module that carries them, so a tag cut while they are present breaks `go install .../cmd/libfossil@<tag>` and every `@version` fetch of the driver submodules. Add a Release workflow step that fails the job before anything is published if any tracked go.mod still contains a replace directive, so the bridge is a CI-enforced TODO rather than a silent landmine. The step comment records what unblocks a release: re-tag the submodules with the corrected module paths, bump the root requires, then drop the replace blocks.
Regenerate the SDK reference docs. The previous pass only substituted URLs over the pre-existing generated files, leaving stale signatures (Repo.Timeline was still documented as taking LogOpts rather than TimelineOpts). Note that gomarkdoc must be run outside a git worktree — inside one it silently strips every source link.
Also reword the README rename note, which read as though the import path had not changed, and re-sort the ncruces require block. (user: [email protected], size: 2033) [annotate] [blame] [check-ins using]
package blob import ( "bytes" "compress/zlib" "encoding/binary" "fmt" "io" "github.com/danmestas/go-libfossil/simio" ) // Compress produces Fossil-compatible compressed blob content: // [4-byte big-endian uncompressed size][zlib-compressed data]. // This matches Fossil's blob_compress() in src/blob.c. func Compress(data []byte) (result []byte, err error) { if data == nil { panic("blob.Compress: data must not be nil") } defer func() { if err == nil && len(result) == 0 { panic("blob.Compress: postcondition violated: result is empty with no error") } }() var buf bytes.Buffer // 4-byte big-endian uncompressed size prefix. if err := binary.Write(&buf, binary.BigEndian, uint32(len(data))); err != nil { return nil, fmt.Errorf("write size prefix: %w", err) } w := zlib.NewWriter(&buf) if _, err := w.Write(data); err != nil { return nil, fmt.Errorf("zlib compress: %w", err) } if err := w.Close(); err != nil { return nil, fmt.Errorf("zlib close: %w", err) } return buf.Bytes(), nil } // Decompress handles Fossil's compressed blob format: // [4-byte big-endian uncompressed size][zlib-compressed data]. // The 4-byte prefix is skipped before decompressing. func Decompress(data []byte) (result []byte, err error) { if data == nil { panic("blob.Decompress: data must not be nil") } defer func() { if err == nil && result == nil { panic("blob.Decompress: postcondition violated: result is nil with no error") } }() if len(data) < 5 { return nil, fmt.Errorf("zlib decompress: data too short (%d bytes)", len(data)) } // Skip the 4-byte size prefix. zlibData := data[4:] r, err := zlib.NewReader(bytes.NewReader(zlibData)) if err != nil { return nil, fmt.Errorf("zlib decompress: %w", err) } defer r.Close() out, err := io.ReadAll(r) if err != nil { return nil, fmt.Errorf("zlib read: %w", err) } // BUGGIFY: truncate decompressed output to exercise partial-read handling. if simio.Buggify(0.02) && len(out) > 1 { out = out[:len(out)/2] } return out, nil }