Skip to content

docs(test): describe recorded queries and appCache keys accurately in docblocks - #4453

Merged
bpamiri merged 1 commit into
developfrom
peter/docblock-wording
Oct 6, 2026
Merged

bpamiri merged 1 commit into
developfrom
peter/docblock-wording

Conversation

@bpamiri

@bpamiri bpamiri commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator

Summary

Comments only. Three docblocks now match the behaviour and the docs:

  • WheelsTest.recordQueries() and Base.$recordQuery() said values are "never recorded". Bound values become ?, but a value written into the SQL itself (parameterize=false) appears as written. This matches the testing guide and .ai/testing.md since feat(test): assert how many SQL statements a spec's call sends #4357.

  • appCacheFetch() and appCacheRead() now say:

    • keys are shared by every user, session, tenant and host, so per-user, per-role or per-tenant data needs that identity in the key ("digest-" & userId);
    • when the cache is full, appCacheFetch() returns the computed value without caching it.

    This matches the caching guide and .ai/caching.md since feat: add appCacheFetch() and friends for caching your own data #4388.

Tests

No code changed (the diff touches only * comment lines). Compile check on Lucee 7 + SQLite:

Specs Pass Fail Error
caching 50 0 0
wheelstest 277 0 0
global 338 0 0

🤖 Generated with Claude Code

… docblocks

- recordQueries() / $recordQuery(): bound values become ?, and a value written
  into the SQL itself (parameterize=false) appears as written; they said values
  are never recorded.
- appCacheFetch() / appCacheRead(): keys are shared by every user, session,
  tenant and host, and a full cache returns the computed value uncached.

Comments only.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Signed-off-by: Peter Amiri <peter@alurium.com>
@bpamiri bpamiri added this to the v4.2.0 milestone Oct 6, 2026
@bpamiri

bpamiri commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator Author

Review: head f9159e9. APPROVE (comment-only).

  • All 16 changed lines in WheelsTest.cfc, databaseAdapters/Base.cfc and global/cache.cfm are docblock lines (*-prefixed), so no executable line changed.
  • recordQueries() / $recordQuery(): "bound values become ?; a value written into the SQL with parameterize=false appears as written" is accurate, and says more precisely what "values are never recorded" meant.
  • appCacheFetch() / appCacheRead(): the full-cache behaviour and the key-scope sentence match the shipped feat: add appCacheFetch() and friends for caching your own data #4388 guide and .ai text.

The gate is PR CI (7 pass, 14 pending at review time). The final follows once it's green.

@bpamiri

bpamiri commented Oct 6, 2026

Copy link
Copy Markdown
Collaborator Author

FINAL: APPROVE. Head f9159e9.

  • Comment-only: all 16 changed lines are docblock lines in WheelsTest.cfc, databaseAdapters/Base.cfc and global/cache.cfm, so no executable code changed and no compat matrix is needed.
  • PR CI: 21 pass, 0 fail, 0 pending, 3 skipping.

@bpamiri
bpamiri merged commit b4b611b into develop Oct 6, 2026
27 of 28 checks passed
@bpamiri
bpamiri deleted the peter/docblock-wording branch October 6, 2026 01:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant