Skip to content

fix(readme): describe the aarch64 Crypto Extension probe (LAB-4654) - #267

Merged
27b-merge-warden[bot] merged 1 commit into
mainfrom
lab-4654-readme-aarch64-probe
Oct 28, 2026
Merged

27b-merge-warden[bot] merged 1 commit into
mainfrom
lab-4654-readme-aarch64-probe

Conversation

@27Bslash6

Copy link
Copy Markdown
Contributor

The "Is AES hardware-accelerated on this host?" paragraph of packages/cachekit/README.md still described cachekit-core 0.6: true on every aarch64 build, from a NEON check. cachekit-core 0.7.0 replaced that with a runtime probe for the Armv8 Crypto Extension's AES instructions (cachekit-io/cachekit-core#77), and the published binding now embeds it. This PR rewrites the aarch64 clause to match, in the same words as the cachekit-rs README. The x86/x86_64 AES-NI clause and the wasm32 false clause keep their meaning.

Binding evidence (inspected 2026-10-28):

  • npm serves @cachekit-io/cachekit-core-ts 0.2.1 as latest, published 2026-10-28T05:20:11Z.
  • npm pack of @cachekit-io/cachekit-core-ts-linux-arm64-gnu@0.2.1 and @cachekit-io/cachekit-core-ts-darwin-arm64@0.2.1, then strings on each native addon binary: both show cachekit-core-0.7.2, and neither shows cachekit-core-0.6..
  • On main @ f8f9806, packages/cachekit-core-ts/package.json reads "version": "0.2.1".

@cachekit-io/cachekit depends on the binding as workspace:*, so the next cachekit release pins core-ts 0.2.1. The README ships inside that package, so this fix(readme) change should land before it, so that the release carries the corrected text. The wasm binding is not a condition: it reports false on wasm32 whatever core it embeds.

grep -n -E 'NEON|every aarch64|cachekit-core 0\.6' packages/cachekit/README.md prints nothing on this head. Prettier passes.

cachekit-core 0.7.0 replaced the aarch64 NEON check with a runtime
probe for the Armv8 Crypto Extension AES instructions, and the
core-ts 0.2.1 binding embeds it. The README still described the
cachekit-core 0.6 behaviour (true on every aarch64 build).
@kodus-27b

kodus-27b Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Code Review Completed! 🔥

The code review was successfully completed based on your current configurations.

Kody Guide: Usage and Configuration
Interacting with Kody
  • Request a Review: Ask Kody to review your PR manually by adding a comment with the `@kody start-review` command at the root of your PR.

  • Provide Feedback: Help Kody learn and improve by reacting to its comments with a 👍 for helpful suggestions or a 👎 if improvements are needed.

Providing Context (Files & MCPs)

Add these hints in your PR description (or a comment) to unlock deeper checks:

  • Ticket / Acceptance Criteria: `Refs: ABC-123` (Linear/Jira/Asana/ClickUp/Trello) or a direct ticket link.
  • Bugfix Validation: a Sentry/Datadog/Bugsnag event link (or paste the stack trace/error message).
  • Endpoint Risk: mention the route (e.g., `POST /api/payments`) or controller/action name.
  • Attach a repo file as context: use an explicit marker like `@file:docs/guide.mdx#L10-L50` (replace with your real path).
  • API Contract Docs: include `@file:openapi.yaml` or `@file:swagger.json` when changing routes/schemas.
  • Definition of Done / Standards: include `@file:DOD.md` or `@file:CONTRIBUTING.md` if your repo has them.
  • Design System Source of Truth: include `@file:ui/index.ts` (replace with your DS entrypoint path).
  • Feature Flags: include the flag key/name and `@file:flags.ts` / `@file:config.json` (and optionally the PostHog flag name).
  • Edge/CDN Rules: link the Cloudflare rule/zone or describe the intended redirect/header behavior.
  • Attach an MCP tool output: use `@mcp<provider|tool>` (replace with an installed MCP provider + tool, e.g., `@mcp<sentry|events.search>`).
Current Kody Configuration
Review Options

The following review options are enabled or disabled:

Options Enabled
Bug ✅
Performance ✅
Security ✅
Business Logic ✅

Access your configuration settings here.

@coderabbitai

coderabbitai Bot commented Oct 28, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review.

Recent review info
Run configuration
Commits

Reviewing files that changed from the base of the PR and between f8f9806 and 822c771.

Files selected for processing: 1
  • packages/cachekit/README.md

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

Summary by CodeRabbit

  • Documentation
    • Clarified that hardware acceleration is detected at runtime on x86/x86_64 using AES-NI, and on aarch64 using Armv8 AES instructions.
    • Updated the aarch64 description to distinguish this detection from the previous NEON-based claim.
    • Confirmed that hardware acceleration remains unavailable on Cloudflare Workers.

Walkthrough

The README now documents that cachekit-core 0.7.0 probes for AES instructions at runtime on aarch64. It retains the documented x86/x86_64 probe and the false result on Cloudflare Workers.

Changes

AES capability documentation

Layer / File(s) Summary
Hardware acceleration probe documentation
packages/cachekit/README.md
The aarch64 description now specifies a runtime probe for AES instructions and a false result when the Crypto Extension is absent. The documentation identifies cachekit-core 0.7.0. The x86/x86_64 probe and Cloudflare Workers result remain unchanged.

Priority: Low

Estimated code review effort: 1 (Trivial) | ~3 minutes

Change: Other

Possibly related PRs

Suggested reviewers: kodus-27b

Merge Risk: Minimal · up to 822c7

The documentation update is consistent with the stated runtime probe behavior and is ready to merge.

Pre-merge checks: Passed 5
Check name Status Explanation
Title check Passed The title clearly and concisely describes the README correction for the aarch64 Crypto Extension probe.
Description check Passed The description directly explains the README change, its technical basis, and the preserved platform-specific behaviour.
Docstring Coverage Passed No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentat…
Linked Issues check Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check Passed Check skipped because no linked issues were found for this pull request.
Full details: Docstring Coverage

Explanation

No eligible functions found in the changed files. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff with cyclomatic complexity of at least 2. Documentation-only edits and deletions within surviving functions are included; unchanged diff context and fully deleted functions are excluded. Analyzed 0 functions across 0 files. (1 skipped: 1 unsupported.)

Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@codecov

codecov Bot commented Oct 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

@27b-merge-warden
27b-merge-warden Bot merged commit 25eef74 into main Oct 28, 2026
17 checks passed
@27b-merge-warden
27b-merge-warden Bot deleted the lab-4654-readme-aarch64-probe branch October 28, 2026 09:47
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