Skip to content

fix: make benchmark page-cache clearing opt-in, never prompt for sudo - #4200

Merged
d-v-b merged 7 commits into
zarr-developers:mainfrom
d-v-b:claude/zarr-4199-audit-b52b46
Jul 29, 2026
Merged

fix: make benchmark page-cache clearing opt-in, never prompt for sudo#4200
d-v-b merged 7 commits into
zarr-developers:mainfrom
d-v-b:claude/zarr-4199-audit-b52b46

Conversation

@d-v-b

@d-v-b d-v-b commented Jul 29, 2026

Copy link
Copy Markdown
Contributor

Summary

closes #4199

We make page-cache-clearing for benchmarks conditioned on the use of an environment variable flag: ZARR_BENCHMARK_CLEAR_CACHE. This is a no-op when unset. It is set in CI.

We also use passwordless sudo when that flag is used, so no password prompts should appear.

For reviewers

[What would you most value a second look at? What are you already confident in? For a refactor, say whether behavior is meant to be unchanged.]

Author attestation

  • I am a human, these are my changes, and I have reviewed and understood every change and can explain why each is correct.

TODO

  • Add unit tests and/or doctests in docstrings
  • Add docstrings and API docs for any new/modified user-facing classes and functions
  • New/modified features documented in docs/user-guide/*.md
  • Changes documented as a new file in changes/
  • GitHub Actions have all passed
  • Test coverage is 100% (Codecov passes)

d-v-b added 7 commits July 14, 2026 13:25
* fix: byte-order handling for structured dtypes in the bytes codec

The bytes codec neither byte-swapped structured-dtype fields to its
configured endian on encode (numpy reports byteorder '|' for void
dtypes, so the top-level byteorder comparison never detected a
mismatch) nor honored its endian when decoding, silently corrupting
any structured data whose field byte order differed from the stored
one (e.g. virtual references to external big-endian data).

Encode now detects byte-order mismatches by comparing full dtypes via
newbyteorder, and decode reinterprets raw bytes in the stored byte
order before converting to the data type's declared byte order, so the
stored layout (codec state) and the in-memory layout (array data type)
are independent.

Closes zarr-developers#4141

Assisted-by: ClaudeCode:claude-fable-5

* test: fold structured byte-order cases into existing bytes codec tests

Extend test_endian's parametrization with structured dtypes and
test_bytes_codec_sync_roundtrip with endian/dtype parametrization plus
stored-layout and decoded-dtype assertions, instead of adding parallel
test functions for the same properties.

Assisted-by: ClaudeCode:claude-fable-5

* refactor: rename stored_dtype to view_dtype in BytesCodec decode

The variable is the dtype used to view the raw chunk bytes (byte order
from the codec's endian configuration), not a property of the stored
data or of the returned buffer, which always carries the array's
declared dtype.

Assisted-by: ClaudeCode:claude-fable-5

* docs: note that the decode-side byte-order conversion copies the chunk

Assisted-by: ClaudeCode:claude-fable-5
clear_cache() in tests/benchmarks/test_e2e.py ran sudo unconditionally in
every benchmark's setup, so a plain `pytest` run blocked on a password
prompt (zarr-developers#4199). It is now a no-op unless ZARR_BENCHMARK_CLEAR_CACHE is
set, uses `sudo -n` so it can never block interactively, and the broken
Darwin invocation ("&&" passed as an argument to sync) is fixed. The
benchmark CI jobs set the variable to keep clearing caches.

Closes zarr-developers#4199

Assisted-by: ClaudeCode:claude-fable-5
@d-v-b
d-v-b force-pushed the claude/zarr-4199-audit-b52b46 branch from c3bd2e4 to 6fc35d1 Compare July 29, 2026 11:25
@d-v-b
d-v-b marked this pull request as ready for review July 29, 2026 11:32
@d-v-b

d-v-b commented Jul 29, 2026

Copy link
Copy Markdown
Contributor Author

without this change it's not practical to run benchmarks on platforms where sudo is not available and it has no other impact on runtime. so I'm going to self-merge as soon as tests pass.

@d-v-b
d-v-b merged commit b213b54 into zarr-developers:main Jul 29, 2026
32 checks passed
@d-v-b
d-v-b deleted the claude/zarr-4199-audit-b52b46 branch July 29, 2026 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

tests/benchmarks/test_e2e.py requires sudo

1 participant