docs(development): eql_v2↔eql_v3 comparison + v3 implementation audit#319
Draft
tobyhede wants to merge 2 commits into
Draft
docs(development): eql_v2↔eql_v3 comparison + v3 implementation audit#319tobyhede wants to merge 2 commits into
tobyhede wants to merge 2 commits into
Conversation
|
Important Review skippedDraft detected. Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
✨ Finishing Touches🧪 Generate unit tests (beta)
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. Comment |
264f3e7 to
09a2674
Compare
…udit Add two internal engineering reference documents under docs/development/ (an excluded subtree of the docs_v3_grep gate, since both legitimately discuss the removed eql_v2 surface): - eql-v2-vs-v3-comparison.md — comparative audit of the removed eql_v2 surface against eql_v3. Since eql_v2 no longer exists in the tree, its file:line citations are verified against git history (SQL surface at 462b020^, test files at 40d35e8^); v3 citations against the current tree. Claims re-verified 2026-06-24. - eql-v3-implementation-audit.md — v3-only deep dive companion. Test counts use the authoritative harness-listed figure (2,547 runnable tests via `cargo test -- --list`, no DB) alongside fork-reproducible source-grep counts, and cite committed codegen goldens / templates rather than the gitignored generated scalar SQL.
09a2674 to
5bea816
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds two internal engineering reference documents under
docs/development/:eql-v2-vs-v3-comparison.md— comparative audit / gap analysis of the (now-removed)eql_v2surface vs theeql_v3encrypted-domain surface.eql-v3-implementation-audit.md— v3-only deep-dive companion.Placed under
docs/development/(notdocs/reference/) because both legitimately discuss the removedeql_v2surface, which thedocs_v3_grepCI gate forbids in user-facing docs —docs/development/is an excluded internal-docs subtree.Verification notes
eql_v2was removed from the tree in 3.0.0, so itsfile:linecitations are no longer resolvable against the working tree. The comparison doc verifies them against git history instead:462b020c^(parent of "feat!: remove eql_v2 SQL surface")40d35e8c^(deleted in a separate commit)eql_v3citations → current treeAll claims were re-verified 2026-06-24 via parallel sub-audits. Notable corrections folded in:
cargo test -- --list(compiled + macro-expanded, no DB) → 2,547 runnable tests (2,256 in theencrypted_domainbinary). v2 baseline ≈ 407 hand-written#[sqlx::test]cases at40d35e8c^. The doc distinguishes harness-listed vs fork-reproducible source-grep counts.*_types.sql) repointed to the committed codegen goldens (tests/codegen/reference/…) and templates (crates/eql-codegen/templates/…) so every claim is checkable.eql_v3.version()now ships, corrected line numbers for the ORE<= 16guard and the v3 pin-search-path structural rule.Type
Docs-only. No code or behaviour change; no CHANGELOG entry required. Base:
eql_v3.Draft for review.