Skip to content

Restore neocache benchmark, dep, and docs#8

Merged
sam-obeid merged 1 commit intomainfrom
restore/neocache
May 4, 2026
Merged

Restore neocache benchmark, dep, and docs#8
sam-obeid merged 1 commit intomainfrom
restore/neocache

Conversation

@sam-obeid
Copy link
Copy Markdown
Collaborator

Restores the neocache benchmark module, git dependency, lockfile entries, ALL_CACHES/dispatch entries, README table row, and help/info text that were removed during the public-release prep.

Shopify/neocache is being made public soon — once that happens, the auth failure that originally motivated removing this dep will resolve itself and CI on main will go green again.

Known: CI will fail on this PR until Shopify/neocache is public

The exact error from the original CI run will recur:

failed to authenticate when downloading repository
* attempted to find username/password via git's credential.helper support, but failed

This is expected and acknowledged by the merger. Bypassing required workflow check via admin merge.

Local verification (with Shopify git credentials)

  • cargo fmt --check
  • cargo clippy --all-targets --locked -- -D warnings
  • cargo build --locked
  • cargo test --locked ✅ (20 passed)
  • cargo run -- --help and --info show neocache in the cache list ✅

Files changed

  • Cargo.toml — restore neocache git dep
  • Cargo.lock — restore neocache package stanza + cache-bench dep entry (no other pin moved)
  • src/caches/neocache.rs — restored (new file, S3-FIFO + DashMap benchmark)
  • src/caches/mod.rs — restore pub mod neocache;
  • src/main.rs — restore ALL_CACHES entry, dispatch arm, help/info text
  • README.md — restore comparison-table row and example; remove "Note on neocache" explainer block

The previous public-release prep removed neocache because the upstream
crate at github.com/Shopify/neocache was still a private repository,
which broke `cargo build` and `cargo clippy --locked` on any clone
without Shopify git credentials (including public CI runners).

Shopify/neocache is now scheduled to be made public, so restore:
  - The git dependency in Cargo.toml (pinned to commit
    3c87b8fde4fab6eb3e9285c05df5ab8ae0cf498c, with the same
    "bump deliberately when re-baselining" comment as before).
  - The matching package stanza and cache-bench dep entry in
    Cargo.lock (no other pin moved).
  - src/caches/neocache.rs (S3-FIFO + DashMap benchmark, with the
    same warmup/measurement structure as the other cache modules).
  - The `pub mod neocache;` declaration in src/caches/mod.rs.
  - The "neocache" entry in ALL_CACHES and the corresponding
    dispatch arm in src/main.rs.
  - The neocache mentions in --help and --info output (AVAILABLE
    CACHES list and the `-c moka,neocache` example).
  - The \[neocache\] row in the README comparison table and the
    `--caches moka,quick_cache,neocache` example. Removed the
    "Note on neocache" explainer block that documented the
    temporary absence.

CI on this branch will fail with `failed to authenticate when
downloading repository` until Shopify/neocache is actually public;
merge after that flip.

Local verification (with credentials):
  - cargo fmt --check
  - cargo clippy --all-targets --locked -- -D warnings
  - cargo build --locked
  - cargo test --locked  (20 passed)
  - --help and --info output show neocache in the cache list
@sam-obeid sam-obeid merged commit eb3df28 into main May 4, 2026
2 of 4 checks passed
@sam-obeid sam-obeid deleted the restore/neocache branch May 4, 2026 16:10
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.

1 participant