oxidecomputer / oxidecomputer/omicron

[support-bundle] be explicit about zip compression level

Open
#9,166 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

support-bundles
Dominant language
Rust
Stars
572
Forks
97
Avg merge
2d 12h
Merged PRs (30d)
96

Description

When #8771 integrates we will be setting the compression algorithm but we should also set the compression level.

@smklein comment:

Here's what I would do:

Based on our current set of features, specify the compression level explicitly
Perhaps add a test that "for some arbitrary data, the compression level we picked matches the default"
Then:

If our feature set changes and tweaks the default, the test will fail, and can hopefully identify "what happened".
If the default gets changed, the test will fail, and hopefully identify "what happened".
At that point, we can make the choice of "change our compression level to match the default", or "leave it as-is, to stay stable"

But regardless, I don't think this need to block this PR.

Link to comment: https://github.com/oxidecomputer/omicron/pull/8771#discussion_r2325649693

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing PR #8771 and the support-bundle code that selects the zip compression algorithm. Identify where the compression level should be made explicit, add a test using arbitrary data to compare the selected level with the default, and confirm the test documents the intended behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
backend
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.