feat(sdk): a typed decision, and characteristics for who the caller is - #28

Merged
cport1 merged 1 commit into
mainfrom
feat/typed-decision
Aug 22, 2026
Merged

feat(sdk): a typed decision, and characteristics for who the caller is#28
cport1 merged 1 commit into
mainfrom
feat/typed-decision

Conversation

@cport1

Copy link
Copy Markdown
Contributor

Closes #730 and #731. First of the milestone-26 batch, and the foundational one — #734 (testing utilities) and the any burndown both build on it.

#730 — the decision

protect() returned { allowed, detection }, and all three adapters typed the value they hand to onBlocked as any. Integrating meant destructuring a blob and string-matching to find out which rule fired. Three things the SDK already knew had nowhere to go:

Which rules ran. The engine collapsed to one deciding rule plus a violations array. A filter() rule that never ran for want of IP enrichment and one that ran and passed both reported ALLOW — indistinguishable, and the first reads as "checked, and this IP is fine". Every rule now appears in results[]:

stateMeaning
RUNEvaluated, conclusion counts
DRY_RUNEvaluated, conclusion recorded but not enforced
NOT_RUNCould not evaluate — a needed signal was absent
CACHEDNot evaluated; a prior decision was reused

A dry-run rule that matched reports conclusion: 'DENY' with state: 'DRY_RUN'. Reading its action verbatim would show it as ALLOW, which is the opposite of what the operator turned it on to see.

"Challenge this one." We ship a proof-of-work captcha in @webdecoy/client and the decision type could not express a challenge, so it was reachable only by wiring it up by hand. CHALLENGE is now a conclusion, produced when the server says challenge and the score cleared the threshold.

A stable id.'rule_' + Date.now() is not unique under concurrency and correlates with nothing. Now a random dec_…, also stamped on detection.detection_id so the two join. Random rather than sequential because ids leave the process, and a counter leaks request volume to anyone who sees two.

Plus deniedBy('tripwire'), and ERROR as a distinct conclusion from DENY — both serve the request, but only one of them means "we never decided".

Compatibility.allowed is unchanged, including failing open on ERROR. onBlocked gets the decision as a trailing argument, so existing handlers are untouched; detection is now typed SDKDetectionResponse instead of any.

One trap worth noting: protect() used to do { ...result, edge }, which would silently strip the methods off a class. It now calls decision.withEdge(edge), and there's a test that would have caught the spread.

#731 — characteristics

rateLimit({ keyBy }) was the only way to change what a rule keyed on, and it was per-rule. Everything else was IP-only — the wrong subject for an authenticated API, and the wrong subject for us specifically, since the actor model exists precisely because IP is not identity.

constwd=newWebDecoy({characteristics: [(ctx)=>ctx.headers['x-api-key']],rules: [rateLimit({max: 100,window: 60})],});

A rule's own keyBy still wins. An absent characteristic falls back to the IP, not to an empty component — otherwise every unauthenticated request shares one bucket, so a limit meant for one tenant takes out anonymous traffic site-wide, and it's invisible until it happens. A characteristic that throws is treated the same way.

Decision caching

Deliberately narrow — server-derived DENY and CHALLENGE only:

  • ALLOW is never cached. That's how a client that has since started misbehaving keeps sailing through, and it saves the cheap request — a low-risk one already returns without calling out.
  • Rule outcomes are never cached. A rate limiter has to see every request to advance its window, and a cached tripwire hit would stop the violation being reported.

Bounded at 10k entries, oldest-first eviction, refreshed on overwrite so a repeatedly-denied key isn't evicted ahead of one nothing has touched.

Verification

21 new tests, 327 total, all passing. no-explicit-any budgets drop: express 14→12, nextjs 5→3, fastify 2→0. Build, lint and check:edge green.

protect() returned { allowed, detection } and the adapters typed the value
they handed to onBlocked as `any`, so integrating meant destructuring a
blob and string-matching to find out which rule fired. Three things the
SDK already knew had nowhere to go:
- Which rules ran. The engine collapsed to one deciding rule plus a
violations array, so a filter rule that never ran for want of enrichment
was indistinguishable from one that ran and passed. Both reported ALLOW.
Every rule now appears in results[] with RUN / DRY_RUN / NOT_RUN /
CACHED, and a dry-run rule that matched reports DENY -- what it WOULD
have done is the reason you turned it on.
- "Challenge this one." We ship a proof-of-work captcha and the decision
type could not express it, so it was reachable only by hand.
- A stable id. 'rule_' + Date.now() is not unique under concurrency and
correlates with nothing.
characteristics answers a separate question the SDK had also hard-coded:
rate limits keyed on IP, which is the wrong subject for an authenticated
API and the wrong subject for us specifically, since the actor model
exists because IP is not identity. An absent characteristic falls back to
the IP rather than keying under empty -- otherwise one tenant's limit
takes out all anonymous traffic, invisibly.
Decision caching is deliberately narrow: server-derived DENY and CHALLENGE
only. Caching ALLOW is how a client that has since started misbehaving
keeps sailing through, and rule outcomes must not be cached because a rate
limiter has to see every request.
allowed is unchanged, including failing open on error. 327 tests pass, and
the any budgets drop (fastify to zero).
ClosesWebDecoy/app#730ClosesWebDecoy/app#731
@cport1
cport1 merged commit 63b2f97 into mainAug 22, 2026
2 checks passed
Sign up for freeto 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

@cport1
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content

feat(sdk): a typed decision, and characteristics for who the caller is - #28

Merged
cport1 merged 1 commit into
mainfrom
feat/typed-decision
Aug 22, 2026
Merged

feat(sdk): a typed decision, and characteristics for who the caller is#28
cport1 merged 1 commit into
mainfrom
feat/typed-decision

Conversation

@cport1

Copy link
Copy Markdown
Contributor

Closes #730 and #731. First of the milestone-26 batch, and the foundational one — #734 (testing utilities) and the any burndown both build on it.

#730 — the decision

protect() returned { allowed, detection }, and all three adapters typed the value they hand to onBlocked as any. Integrating meant destructuring a blob and string-matching to find out which rule fired. Three things the SDK already knew had nowhere to go:

Which rules ran. The engine collapsed to one deciding rule plus a violations array. A filter() rule that never ran for want of IP enrichment and one that ran and passed both reported ALLOW — indistinguishable, and the first reads as "checked, and this IP is fine". Every rule now appears in results[]:

stateMeaning
RUNEvaluated, conclusion counts
DRY_RUNEvaluated, conclusion recorded but not enforced
NOT_RUNCould not evaluate — a needed signal was absent
CACHEDNot evaluated; a prior decision was reused

A dry-run rule that matched reports conclusion: 'DENY' with state: 'DRY_RUN'. Reading its action verbatim would show it as ALLOW, which is the opposite of what the operator turned it on to see.

"Challenge this one." We ship a proof-of-work captcha in @webdecoy/client and the decision type could not express a challenge, so it was reachable only by wiring it up by hand. CHALLENGE is now a conclusion, produced when the server says challenge and the score cleared the threshold.

A stable id.'rule_' + Date.now() is not unique under concurrency and correlates with nothing. Now a random dec_…, also stamped on detection.detection_id so the two join. Random rather than sequential because ids leave the process, and a counter leaks request volume to anyone who sees two.

Plus deniedBy('tripwire'), and ERROR as a distinct conclusion from DENY — both serve the request, but only one of them means "we never decided".

Compatibility.allowed is unchanged, including failing open on ERROR. onBlocked gets the decision as a trailing argument, so existing handlers are untouched; detection is now typed SDKDetectionResponse instead of any.

One trap worth noting: protect() used to do { ...result, edge }, which would silently strip the methods off a class. It now calls decision.withEdge(edge), and there's a test that would have caught the spread.

#731 — characteristics

rateLimit({ keyBy }) was the only way to change what a rule keyed on, and it was per-rule. Everything else was IP-only — the wrong subject for an authenticated API, and the wrong subject for us specifically, since the actor model exists precisely because IP is not identity.

constwd=newWebDecoy({characteristics: [(ctx)=>ctx.headers['x-api-key']],rules: [rateLimit({max: 100,window: 60})],});

A rule's own keyBy still wins. An absent characteristic falls back to the IP, not to an empty component — otherwise every unauthenticated request shares one bucket, so a limit meant for one tenant takes out anonymous traffic site-wide, and it's invisible until it happens. A characteristic that throws is treated the same way.

Decision caching

Deliberately narrow — server-derived DENY and CHALLENGE only:

  • ALLOW is never cached. That's how a client that has since started misbehaving keeps sailing through, and it saves the cheap request — a low-risk one already returns without calling out.
  • Rule outcomes are never cached. A rate limiter has to see every request to advance its window, and a cached tripwire hit would stop the violation being reported.

Bounded at 10k entries, oldest-first eviction, refreshed on overwrite so a repeatedly-denied key isn't evicted ahead of one nothing has touched.

Verification

21 new tests, 327 total, all passing. no-explicit-any budgets drop: express 14→12, nextjs 5→3, fastify 2→0. Build, lint and check:edge green.

protect() returned { allowed, detection } and the adapters typed the value
they handed to onBlocked as `any`, so integrating meant destructuring a
blob and string-matching to find out which rule fired. Three things the
SDK already knew had nowhere to go:
- Which rules ran. The engine collapsed to one deciding rule plus a
violations array, so a filter rule that never ran for want of enrichment
was indistinguishable from one that ran and passed. Both reported ALLOW.
Every rule now appears in results[] with RUN / DRY_RUN / NOT_RUN /
CACHED, and a dry-run rule that matched reports DENY -- what it WOULD
have done is the reason you turned it on.
- "Challenge this one." We ship a proof-of-work captcha and the decision
type could not express it, so it was reachable only by hand.
- A stable id. 'rule_' + Date.now() is not unique under concurrency and
correlates with nothing.
characteristics answers a separate question the SDK had also hard-coded:
rate limits keyed on IP, which is the wrong subject for an authenticated
API and the wrong subject for us specifically, since the actor model
exists because IP is not identity. An absent characteristic falls back to
the IP rather than keying under empty -- otherwise one tenant's limit
takes out all anonymous traffic, invisibly.
Decision caching is deliberately narrow: server-derived DENY and CHALLENGE
only. Caching ALLOW is how a client that has since started misbehaving
keeps sailing through, and rule outcomes must not be cached because a rate
limiter has to see every request.
allowed is unchanged, including failing open on error. 327 tests pass, and
the any budgets drop (fastify to zero).
ClosesWebDecoy/app#730ClosesWebDecoy/app#731
@cport1
cport1 merged commit 63b2f97 into mainAug 22, 2026
2 checks passed
Sign up for freeto 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

@cport1
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(sdk): a typed decision, and characteristics for who the caller is - #28

Merged
cport1 merged 1 commit into
mainfrom
feat/typed-decision
Aug 22, 2026
Merged

feat(sdk): a typed decision, and characteristics for who the caller is#28
cport1 merged 1 commit into
mainfrom
feat/typed-decision

Conversation

@cport1

Copy link
Copy Markdown
Contributor

Closes #730 and #731. First of the milestone-26 batch, and the foundational one — #734 (testing utilities) and the any burndown both build on it.

#730 — the decision

protect() returned { allowed, detection }, and all three adapters typed the value they hand to onBlocked as any. Integrating meant destructuring a blob and string-matching to find out which rule fired. Three things the SDK already knew had nowhere to go:

Which rules ran. The engine collapsed to one deciding rule plus a violations array. A filter() rule that never ran for want of IP enrichment and one that ran and passed both reported ALLOW — indistinguishable, and the first reads as "checked, and this IP is fine". Every rule now appears in results[]:

stateMeaning
RUNEvaluated, conclusion counts
DRY_RUNEvaluated, conclusion recorded but not enforced
NOT_RUNCould not evaluate — a needed signal was absent
CACHEDNot evaluated; a prior decision was reused

A dry-run rule that matched reports conclusion: 'DENY' with state: 'DRY_RUN'. Reading its action verbatim would show it as ALLOW, which is the opposite of what the operator turned it on to see.

"Challenge this one." We ship a proof-of-work captcha in @webdecoy/client and the decision type could not express a challenge, so it was reachable only by wiring it up by hand. CHALLENGE is now a conclusion, produced when the server says challenge and the score cleared the threshold.

A stable id.'rule_' + Date.now() is not unique under concurrency and correlates with nothing. Now a random dec_…, also stamped on detection.detection_id so the two join. Random rather than sequential because ids leave the process, and a counter leaks request volume to anyone who sees two.

Plus deniedBy('tripwire'), and ERROR as a distinct conclusion from DENY — both serve the request, but only one of them means "we never decided".

Compatibility.allowed is unchanged, including failing open on ERROR. onBlocked gets the decision as a trailing argument, so existing handlers are untouched; detection is now typed SDKDetectionResponse instead of any.

One trap worth noting: protect() used to do { ...result, edge }, which would silently strip the methods off a class. It now calls decision.withEdge(edge), and there's a test that would have caught the spread.

#731 — characteristics

rateLimit({ keyBy }) was the only way to change what a rule keyed on, and it was per-rule. Everything else was IP-only — the wrong subject for an authenticated API, and the wrong subject for us specifically, since the actor model exists precisely because IP is not identity.

constwd=newWebDecoy({characteristics: [(ctx)=>ctx.headers['x-api-key']],rules: [rateLimit({max: 100,window: 60})],});

A rule's own keyBy still wins. An absent characteristic falls back to the IP, not to an empty component — otherwise every unauthenticated request shares one bucket, so a limit meant for one tenant takes out anonymous traffic site-wide, and it's invisible until it happens. A characteristic that throws is treated the same way.

Decision caching

Deliberately narrow — server-derived DENY and CHALLENGE only:

  • ALLOW is never cached. That's how a client that has since started misbehaving keeps sailing through, and it saves the cheap request — a low-risk one already returns without calling out.
  • Rule outcomes are never cached. A rate limiter has to see every request to advance its window, and a cached tripwire hit would stop the violation being reported.

Bounded at 10k entries, oldest-first eviction, refreshed on overwrite so a repeatedly-denied key isn't evicted ahead of one nothing has touched.

Verification

21 new tests, 327 total, all passing. no-explicit-any budgets drop: express 14→12, nextjs 5→3, fastify 2→0. Build, lint and check:edge green.

protect() returned { allowed, detection } and the adapters typed the value
they handed to onBlocked as `any`, so integrating meant destructuring a
blob and string-matching to find out which rule fired. Three things the
SDK already knew had nowhere to go:
- Which rules ran. The engine collapsed to one deciding rule plus a
violations array, so a filter rule that never ran for want of enrichment
was indistinguishable from one that ran and passed. Both reported ALLOW.
Every rule now appears in results[] with RUN / DRY_RUN / NOT_RUN /
CACHED, and a dry-run rule that matched reports DENY -- what it WOULD
have done is the reason you turned it on.
- "Challenge this one." We ship a proof-of-work captcha and the decision
type could not express it, so it was reachable only by hand.
- A stable id. 'rule_' + Date.now() is not unique under concurrency and
correlates with nothing.
characteristics answers a separate question the SDK had also hard-coded:
rate limits keyed on IP, which is the wrong subject for an authenticated
API and the wrong subject for us specifically, since the actor model
exists because IP is not identity. An absent characteristic falls back to
the IP rather than keying under empty -- otherwise one tenant's limit
takes out all anonymous traffic, invisibly.
Decision caching is deliberately narrow: server-derived DENY and CHALLENGE
only. Caching ALLOW is how a client that has since started misbehaving
keeps sailing through, and rule outcomes must not be cached because a rate
limiter has to see every request.
allowed is unchanged, including failing open on error. 327 tests pass, and
the any budgets drop (fastify to zero).
ClosesWebDecoy/app#730ClosesWebDecoy/app#731
@cport1
cport1 merged commit 63b2f97 into mainAug 22, 2026
2 checks passed
Sign up for freeto 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

@cport1
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(sdk): a typed decision, and characteristics for who the caller is - #28

Merged
cport1 merged 1 commit into
mainfrom
feat/typed-decision
Aug 22, 2026
Merged

feat(sdk): a typed decision, and characteristics for who the caller is#28
cport1 merged 1 commit into
mainfrom
feat/typed-decision

Conversation

@cport1

Copy link
Copy Markdown
Contributor

Closes #730 and #731. First of the milestone-26 batch, and the foundational one — #734 (testing utilities) and the any burndown both build on it.

#730 — the decision

protect() returned { allowed, detection }, and all three adapters typed the value they hand to onBlocked as any. Integrating meant destructuring a blob and string-matching to find out which rule fired. Three things the SDK already knew had nowhere to go:

Which rules ran. The engine collapsed to one deciding rule plus a violations array. A filter() rule that never ran for want of IP enrichment and one that ran and passed both reported ALLOW — indistinguishable, and the first reads as "checked, and this IP is fine". Every rule now appears in results[]:

stateMeaning
RUNEvaluated, conclusion counts
DRY_RUNEvaluated, conclusion recorded but not enforced
NOT_RUNCould not evaluate — a needed signal was absent
CACHEDNot evaluated; a prior decision was reused

A dry-run rule that matched reports conclusion: 'DENY' with state: 'DRY_RUN'. Reading its action verbatim would show it as ALLOW, which is the opposite of what the operator turned it on to see.

"Challenge this one." We ship a proof-of-work captcha in @webdecoy/client and the decision type could not express a challenge, so it was reachable only by wiring it up by hand. CHALLENGE is now a conclusion, produced when the server says challenge and the score cleared the threshold.

A stable id.'rule_' + Date.now() is not unique under concurrency and correlates with nothing. Now a random dec_…, also stamped on detection.detection_id so the two join. Random rather than sequential because ids leave the process, and a counter leaks request volume to anyone who sees two.

Plus deniedBy('tripwire'), and ERROR as a distinct conclusion from DENY — both serve the request, but only one of them means "we never decided".

Compatibility.allowed is unchanged, including failing open on ERROR. onBlocked gets the decision as a trailing argument, so existing handlers are untouched; detection is now typed SDKDetectionResponse instead of any.

One trap worth noting: protect() used to do { ...result, edge }, which would silently strip the methods off a class. It now calls decision.withEdge(edge), and there's a test that would have caught the spread.

#731 — characteristics

rateLimit({ keyBy }) was the only way to change what a rule keyed on, and it was per-rule. Everything else was IP-only — the wrong subject for an authenticated API, and the wrong subject for us specifically, since the actor model exists precisely because IP is not identity.

constwd=newWebDecoy({characteristics: [(ctx)=>ctx.headers['x-api-key']],rules: [rateLimit({max: 100,window: 60})],});

A rule's own keyBy still wins. An absent characteristic falls back to the IP, not to an empty component — otherwise every unauthenticated request shares one bucket, so a limit meant for one tenant takes out anonymous traffic site-wide, and it's invisible until it happens. A characteristic that throws is treated the same way.

Decision caching

Deliberately narrow — server-derived DENY and CHALLENGE only:

  • ALLOW is never cached. That's how a client that has since started misbehaving keeps sailing through, and it saves the cheap request — a low-risk one already returns without calling out.
  • Rule outcomes are never cached. A rate limiter has to see every request to advance its window, and a cached tripwire hit would stop the violation being reported.

Bounded at 10k entries, oldest-first eviction, refreshed on overwrite so a repeatedly-denied key isn't evicted ahead of one nothing has touched.

Verification

21 new tests, 327 total, all passing. no-explicit-any budgets drop: express 14→12, nextjs 5→3, fastify 2→0. Build, lint and check:edge green.

protect() returned { allowed, detection } and the adapters typed the value
they handed to onBlocked as `any`, so integrating meant destructuring a
blob and string-matching to find out which rule fired. Three things the
SDK already knew had nowhere to go:
- Which rules ran. The engine collapsed to one deciding rule plus a
violations array, so a filter rule that never ran for want of enrichment
was indistinguishable from one that ran and passed. Both reported ALLOW.
Every rule now appears in results[] with RUN / DRY_RUN / NOT_RUN /
CACHED, and a dry-run rule that matched reports DENY -- what it WOULD
have done is the reason you turned it on.
- "Challenge this one." We ship a proof-of-work captcha and the decision
type could not express it, so it was reachable only by hand.
- A stable id. 'rule_' + Date.now() is not unique under concurrency and
correlates with nothing.
characteristics answers a separate question the SDK had also hard-coded:
rate limits keyed on IP, which is the wrong subject for an authenticated
API and the wrong subject for us specifically, since the actor model
exists because IP is not identity. An absent characteristic falls back to
the IP rather than keying under empty -- otherwise one tenant's limit
takes out all anonymous traffic, invisibly.
Decision caching is deliberately narrow: server-derived DENY and CHALLENGE
only. Caching ALLOW is how a client that has since started misbehaving
keeps sailing through, and rule outcomes must not be cached because a rate
limiter has to see every request.
allowed is unchanged, including failing open on error. 327 tests pass, and
the any budgets drop (fastify to zero).
ClosesWebDecoy/app#730ClosesWebDecoy/app#731
@cport1
cport1 merged commit 63b2f97 into mainAug 22, 2026
2 checks passed
Sign up for freeto 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

@cport1
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content

feat(sdk): a typed decision, and characteristics for who the caller is - #28

Merged
cport1 merged 1 commit into
mainfrom
feat/typed-decision
Aug 22, 2026
Merged

feat(sdk): a typed decision, and characteristics for who the caller is#28
cport1 merged 1 commit into
mainfrom
feat/typed-decision

Conversation

@cport1

Copy link
Copy Markdown
Contributor

Closes #730 and #731. First of the milestone-26 batch, and the foundational one — #734 (testing utilities) and the any burndown both build on it.

#730 — the decision

protect() returned { allowed, detection }, and all three adapters typed the value they hand to onBlocked as any. Integrating meant destructuring a blob and string-matching to find out which rule fired. Three things the SDK already knew had nowhere to go:

Which rules ran. The engine collapsed to one deciding rule plus a violations array. A filter() rule that never ran for want of IP enrichment and one that ran and passed both reported ALLOW — indistinguishable, and the first reads as "checked, and this IP is fine". Every rule now appears in results[]:

stateMeaning
RUNEvaluated, conclusion counts
DRY_RUNEvaluated, conclusion recorded but not enforced
NOT_RUNCould not evaluate — a needed signal was absent
CACHEDNot evaluated; a prior decision was reused

A dry-run rule that matched reports conclusion: 'DENY' with state: 'DRY_RUN'. Reading its action verbatim would show it as ALLOW, which is the opposite of what the operator turned it on to see.

"Challenge this one." We ship a proof-of-work captcha in @webdecoy/client and the decision type could not express a challenge, so it was reachable only by wiring it up by hand. CHALLENGE is now a conclusion, produced when the server says challenge and the score cleared the threshold.

A stable id.'rule_' + Date.now() is not unique under concurrency and correlates with nothing. Now a random dec_…, also stamped on detection.detection_id so the two join. Random rather than sequential because ids leave the process, and a counter leaks request volume to anyone who sees two.

Plus deniedBy('tripwire'), and ERROR as a distinct conclusion from DENY — both serve the request, but only one of them means "we never decided".

Compatibility.allowed is unchanged, including failing open on ERROR. onBlocked gets the decision as a trailing argument, so existing handlers are untouched; detection is now typed SDKDetectionResponse instead of any.

One trap worth noting: protect() used to do { ...result, edge }, which would silently strip the methods off a class. It now calls decision.withEdge(edge), and there's a test that would have caught the spread.

#731 — characteristics

rateLimit({ keyBy }) was the only way to change what a rule keyed on, and it was per-rule. Everything else was IP-only — the wrong subject for an authenticated API, and the wrong subject for us specifically, since the actor model exists precisely because IP is not identity.

constwd=newWebDecoy({characteristics: [(ctx)=>ctx.headers['x-api-key']],rules: [rateLimit({max: 100,window: 60})],});

A rule's own keyBy still wins. An absent characteristic falls back to the IP, not to an empty component — otherwise every unauthenticated request shares one bucket, so a limit meant for one tenant takes out anonymous traffic site-wide, and it's invisible until it happens. A characteristic that throws is treated the same way.

Decision caching

Deliberately narrow — server-derived DENY and CHALLENGE only:

  • ALLOW is never cached. That's how a client that has since started misbehaving keeps sailing through, and it saves the cheap request — a low-risk one already returns without calling out.
  • Rule outcomes are never cached. A rate limiter has to see every request to advance its window, and a cached tripwire hit would stop the violation being reported.

Bounded at 10k entries, oldest-first eviction, refreshed on overwrite so a repeatedly-denied key isn't evicted ahead of one nothing has touched.

Verification

21 new tests, 327 total, all passing. no-explicit-any budgets drop: express 14→12, nextjs 5→3, fastify 2→0. Build, lint and check:edge green.

protect() returned { allowed, detection } and the adapters typed the value
they handed to onBlocked as `any`, so integrating meant destructuring a
blob and string-matching to find out which rule fired. Three things the
SDK already knew had nowhere to go:
- Which rules ran. The engine collapsed to one deciding rule plus a
violations array, so a filter rule that never ran for want of enrichment
was indistinguishable from one that ran and passed. Both reported ALLOW.
Every rule now appears in results[] with RUN / DRY_RUN / NOT_RUN /
CACHED, and a dry-run rule that matched reports DENY -- what it WOULD
have done is the reason you turned it on.
- "Challenge this one." We ship a proof-of-work captcha and the decision
type could not express it, so it was reachable only by hand.
- A stable id. 'rule_' + Date.now() is not unique under concurrency and
correlates with nothing.
characteristics answers a separate question the SDK had also hard-coded:
rate limits keyed on IP, which is the wrong subject for an authenticated
API and the wrong subject for us specifically, since the actor model
exists because IP is not identity. An absent characteristic falls back to
the IP rather than keying under empty -- otherwise one tenant's limit
takes out all anonymous traffic, invisibly.
Decision caching is deliberately narrow: server-derived DENY and CHALLENGE
only. Caching ALLOW is how a client that has since started misbehaving
keeps sailing through, and rule outcomes must not be cached because a rate
limiter has to see every request.
allowed is unchanged, including failing open on error. 327 tests pass, and
the any budgets drop (fastify to zero).
ClosesWebDecoy/app#730ClosesWebDecoy/app#731
@cport1
cport1 merged commit 63b2f97 into mainAug 22, 2026
2 checks passed
Sign up for freeto 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

@cport1
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(sdk): a typed decision, and characteristics for who the caller is - #28

Merged
cport1 merged 1 commit into
mainfrom
feat/typed-decision
Aug 22, 2026
Merged

feat(sdk): a typed decision, and characteristics for who the caller is#28
cport1 merged 1 commit into
mainfrom
feat/typed-decision

Conversation

@cport1

Copy link
Copy Markdown
Contributor

Closes #730 and #731. First of the milestone-26 batch, and the foundational one — #734 (testing utilities) and the any burndown both build on it.

#730 — the decision

protect() returned { allowed, detection }, and all three adapters typed the value they hand to onBlocked as any. Integrating meant destructuring a blob and string-matching to find out which rule fired. Three things the SDK already knew had nowhere to go:

Which rules ran. The engine collapsed to one deciding rule plus a violations array. A filter() rule that never ran for want of IP enrichment and one that ran and passed both reported ALLOW — indistinguishable, and the first reads as "checked, and this IP is fine". Every rule now appears in results[]:

stateMeaning
RUNEvaluated, conclusion counts
DRY_RUNEvaluated, conclusion recorded but not enforced
NOT_RUNCould not evaluate — a needed signal was absent
CACHEDNot evaluated; a prior decision was reused

A dry-run rule that matched reports conclusion: 'DENY' with state: 'DRY_RUN'. Reading its action verbatim would show it as ALLOW, which is the opposite of what the operator turned it on to see.

"Challenge this one." We ship a proof-of-work captcha in @webdecoy/client and the decision type could not express a challenge, so it was reachable only by wiring it up by hand. CHALLENGE is now a conclusion, produced when the server says challenge and the score cleared the threshold.

A stable id.'rule_' + Date.now() is not unique under concurrency and correlates with nothing. Now a random dec_…, also stamped on detection.detection_id so the two join. Random rather than sequential because ids leave the process, and a counter leaks request volume to anyone who sees two.

Plus deniedBy('tripwire'), and ERROR as a distinct conclusion from DENY — both serve the request, but only one of them means "we never decided".

Compatibility.allowed is unchanged, including failing open on ERROR. onBlocked gets the decision as a trailing argument, so existing handlers are untouched; detection is now typed SDKDetectionResponse instead of any.

One trap worth noting: protect() used to do { ...result, edge }, which would silently strip the methods off a class. It now calls decision.withEdge(edge), and there's a test that would have caught the spread.

#731 — characteristics

rateLimit({ keyBy }) was the only way to change what a rule keyed on, and it was per-rule. Everything else was IP-only — the wrong subject for an authenticated API, and the wrong subject for us specifically, since the actor model exists precisely because IP is not identity.

constwd=newWebDecoy({characteristics: [(ctx)=>ctx.headers['x-api-key']],rules: [rateLimit({max: 100,window: 60})],});

A rule's own keyBy still wins. An absent characteristic falls back to the IP, not to an empty component — otherwise every unauthenticated request shares one bucket, so a limit meant for one tenant takes out anonymous traffic site-wide, and it's invisible until it happens. A characteristic that throws is treated the same way.

Decision caching

Deliberately narrow — server-derived DENY and CHALLENGE only:

  • ALLOW is never cached. That's how a client that has since started misbehaving keeps sailing through, and it saves the cheap request — a low-risk one already returns without calling out.
  • Rule outcomes are never cached. A rate limiter has to see every request to advance its window, and a cached tripwire hit would stop the violation being reported.

Bounded at 10k entries, oldest-first eviction, refreshed on overwrite so a repeatedly-denied key isn't evicted ahead of one nothing has touched.

Verification

21 new tests, 327 total, all passing. no-explicit-any budgets drop: express 14→12, nextjs 5→3, fastify 2→0. Build, lint and check:edge green.

protect() returned { allowed, detection } and the adapters typed the value
they handed to onBlocked as `any`, so integrating meant destructuring a
blob and string-matching to find out which rule fired. Three things the
SDK already knew had nowhere to go:
- Which rules ran. The engine collapsed to one deciding rule plus a
violations array, so a filter rule that never ran for want of enrichment
was indistinguishable from one that ran and passed. Both reported ALLOW.
Every rule now appears in results[] with RUN / DRY_RUN / NOT_RUN /
CACHED, and a dry-run rule that matched reports DENY -- what it WOULD
have done is the reason you turned it on.
- "Challenge this one." We ship a proof-of-work captcha and the decision
type could not express it, so it was reachable only by hand.
- A stable id. 'rule_' + Date.now() is not unique under concurrency and
correlates with nothing.
characteristics answers a separate question the SDK had also hard-coded:
rate limits keyed on IP, which is the wrong subject for an authenticated
API and the wrong subject for us specifically, since the actor model
exists because IP is not identity. An absent characteristic falls back to
the IP rather than keying under empty -- otherwise one tenant's limit
takes out all anonymous traffic, invisibly.
Decision caching is deliberately narrow: server-derived DENY and CHALLENGE
only. Caching ALLOW is how a client that has since started misbehaving
keeps sailing through, and rule outcomes must not be cached because a rate
limiter has to see every request.
allowed is unchanged, including failing open on error. 327 tests pass, and
the any budgets drop (fastify to zero).
ClosesWebDecoy/app#730ClosesWebDecoy/app#731
@cport1
cport1 merged commit 63b2f97 into mainAug 22, 2026
2 checks passed
Sign up for freeto 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

@cport1
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content

feat(sdk): a typed decision, and characteristics for who the caller is - #28

Merged
cport1 merged 1 commit into
mainfrom
feat/typed-decision
Aug 22, 2026
Merged

feat(sdk): a typed decision, and characteristics for who the caller is#28
cport1 merged 1 commit into
mainfrom
feat/typed-decision

Conversation

@cport1

Copy link
Copy Markdown
Contributor

Closes #730 and #731. First of the milestone-26 batch, and the foundational one — #734 (testing utilities) and the any burndown both build on it.

#730 — the decision

protect() returned { allowed, detection }, and all three adapters typed the value they hand to onBlocked as any. Integrating meant destructuring a blob and string-matching to find out which rule fired. Three things the SDK already knew had nowhere to go:

Which rules ran. The engine collapsed to one deciding rule plus a violations array. A filter() rule that never ran for want of IP enrichment and one that ran and passed both reported ALLOW — indistinguishable, and the first reads as "checked, and this IP is fine". Every rule now appears in results[]:

stateMeaning
RUNEvaluated, conclusion counts
DRY_RUNEvaluated, conclusion recorded but not enforced
NOT_RUNCould not evaluate — a needed signal was absent
CACHEDNot evaluated; a prior decision was reused

A dry-run rule that matched reports conclusion: 'DENY' with state: 'DRY_RUN'. Reading its action verbatim would show it as ALLOW, which is the opposite of what the operator turned it on to see.

"Challenge this one." We ship a proof-of-work captcha in @webdecoy/client and the decision type could not express a challenge, so it was reachable only by wiring it up by hand. CHALLENGE is now a conclusion, produced when the server says challenge and the score cleared the threshold.

A stable id.'rule_' + Date.now() is not unique under concurrency and correlates with nothing. Now a random dec_…, also stamped on detection.detection_id so the two join. Random rather than sequential because ids leave the process, and a counter leaks request volume to anyone who sees two.

Plus deniedBy('tripwire'), and ERROR as a distinct conclusion from DENY — both serve the request, but only one of them means "we never decided".

Compatibility.allowed is unchanged, including failing open on ERROR. onBlocked gets the decision as a trailing argument, so existing handlers are untouched; detection is now typed SDKDetectionResponse instead of any.

One trap worth noting: protect() used to do { ...result, edge }, which would silently strip the methods off a class. It now calls decision.withEdge(edge), and there's a test that would have caught the spread.

#731 — characteristics

rateLimit({ keyBy }) was the only way to change what a rule keyed on, and it was per-rule. Everything else was IP-only — the wrong subject for an authenticated API, and the wrong subject for us specifically, since the actor model exists precisely because IP is not identity.

constwd=newWebDecoy({characteristics: [(ctx)=>ctx.headers['x-api-key']],rules: [rateLimit({max: 100,window: 60})],});

A rule's own keyBy still wins. An absent characteristic falls back to the IP, not to an empty component — otherwise every unauthenticated request shares one bucket, so a limit meant for one tenant takes out anonymous traffic site-wide, and it's invisible until it happens. A characteristic that throws is treated the same way.

Decision caching

Deliberately narrow — server-derived DENY and CHALLENGE only:

  • ALLOW is never cached. That's how a client that has since started misbehaving keeps sailing through, and it saves the cheap request — a low-risk one already returns without calling out.
  • Rule outcomes are never cached. A rate limiter has to see every request to advance its window, and a cached tripwire hit would stop the violation being reported.

Bounded at 10k entries, oldest-first eviction, refreshed on overwrite so a repeatedly-denied key isn't evicted ahead of one nothing has touched.

Verification

21 new tests, 327 total, all passing. no-explicit-any budgets drop: express 14→12, nextjs 5→3, fastify 2→0. Build, lint and check:edge green.

protect() returned { allowed, detection } and the adapters typed the value
they handed to onBlocked as `any`, so integrating meant destructuring a
blob and string-matching to find out which rule fired. Three things the
SDK already knew had nowhere to go:
- Which rules ran. The engine collapsed to one deciding rule plus a
violations array, so a filter rule that never ran for want of enrichment
was indistinguishable from one that ran and passed. Both reported ALLOW.
Every rule now appears in results[] with RUN / DRY_RUN / NOT_RUN /
CACHED, and a dry-run rule that matched reports DENY -- what it WOULD
have done is the reason you turned it on.
- "Challenge this one." We ship a proof-of-work captcha and the decision
type could not express it, so it was reachable only by hand.
- A stable id. 'rule_' + Date.now() is not unique under concurrency and
correlates with nothing.
characteristics answers a separate question the SDK had also hard-coded:
rate limits keyed on IP, which is the wrong subject for an authenticated
API and the wrong subject for us specifically, since the actor model
exists because IP is not identity. An absent characteristic falls back to
the IP rather than keying under empty -- otherwise one tenant's limit
takes out all anonymous traffic, invisibly.
Decision caching is deliberately narrow: server-derived DENY and CHALLENGE
only. Caching ALLOW is how a client that has since started misbehaving
keeps sailing through, and rule outcomes must not be cached because a rate
limiter has to see every request.
allowed is unchanged, including failing open on error. 327 tests pass, and
the any budgets drop (fastify to zero).
ClosesWebDecoy/app#730ClosesWebDecoy/app#731
@cport1
cport1 merged commit 63b2f97 into mainAug 22, 2026
2 checks passed
Sign up for freeto 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

@cport1
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content

feat(sdk): a typed decision, and characteristics for who the caller is - #28

Merged
cport1 merged 1 commit into
mainfrom
feat/typed-decision
Aug 22, 2026
Merged

feat(sdk): a typed decision, and characteristics for who the caller is#28
cport1 merged 1 commit into
mainfrom
feat/typed-decision

Conversation

@cport1

Copy link
Copy Markdown
Contributor

Closes #730 and #731. First of the milestone-26 batch, and the foundational one — #734 (testing utilities) and the any burndown both build on it.

#730 — the decision

protect() returned { allowed, detection }, and all three adapters typed the value they hand to onBlocked as any. Integrating meant destructuring a blob and string-matching to find out which rule fired. Three things the SDK already knew had nowhere to go:

Which rules ran. The engine collapsed to one deciding rule plus a violations array. A filter() rule that never ran for want of IP enrichment and one that ran and passed both reported ALLOW — indistinguishable, and the first reads as "checked, and this IP is fine". Every rule now appears in results[]:

stateMeaning
RUNEvaluated, conclusion counts
DRY_RUNEvaluated, conclusion recorded but not enforced
NOT_RUNCould not evaluate — a needed signal was absent
CACHEDNot evaluated; a prior decision was reused

A dry-run rule that matched reports conclusion: 'DENY' with state: 'DRY_RUN'. Reading its action verbatim would show it as ALLOW, which is the opposite of what the operator turned it on to see.

"Challenge this one." We ship a proof-of-work captcha in @webdecoy/client and the decision type could not express a challenge, so it was reachable only by wiring it up by hand. CHALLENGE is now a conclusion, produced when the server says challenge and the score cleared the threshold.

A stable id.'rule_' + Date.now() is not unique under concurrency and correlates with nothing. Now a random dec_…, also stamped on detection.detection_id so the two join. Random rather than sequential because ids leave the process, and a counter leaks request volume to anyone who sees two.

Plus deniedBy('tripwire'), and ERROR as a distinct conclusion from DENY — both serve the request, but only one of them means "we never decided".

Compatibility.allowed is unchanged, including failing open on ERROR. onBlocked gets the decision as a trailing argument, so existing handlers are untouched; detection is now typed SDKDetectionResponse instead of any.

One trap worth noting: protect() used to do { ...result, edge }, which would silently strip the methods off a class. It now calls decision.withEdge(edge), and there's a test that would have caught the spread.

#731 — characteristics

rateLimit({ keyBy }) was the only way to change what a rule keyed on, and it was per-rule. Everything else was IP-only — the wrong subject for an authenticated API, and the wrong subject for us specifically, since the actor model exists precisely because IP is not identity.

constwd=newWebDecoy({characteristics: [(ctx)=>ctx.headers['x-api-key']],rules: [rateLimit({max: 100,window: 60})],});

A rule's own keyBy still wins. An absent characteristic falls back to the IP, not to an empty component — otherwise every unauthenticated request shares one bucket, so a limit meant for one tenant takes out anonymous traffic site-wide, and it's invisible until it happens. A characteristic that throws is treated the same way.

Decision caching

Deliberately narrow — server-derived DENY and CHALLENGE only:

  • ALLOW is never cached. That's how a client that has since started misbehaving keeps sailing through, and it saves the cheap request — a low-risk one already returns without calling out.
  • Rule outcomes are never cached. A rate limiter has to see every request to advance its window, and a cached tripwire hit would stop the violation being reported.

Bounded at 10k entries, oldest-first eviction, refreshed on overwrite so a repeatedly-denied key isn't evicted ahead of one nothing has touched.

Verification

21 new tests, 327 total, all passing. no-explicit-any budgets drop: express 14→12, nextjs 5→3, fastify 2→0. Build, lint and check:edge green.

protect() returned { allowed, detection } and the adapters typed the value
they handed to onBlocked as `any`, so integrating meant destructuring a
blob and string-matching to find out which rule fired. Three things the
SDK already knew had nowhere to go:
- Which rules ran. The engine collapsed to one deciding rule plus a
violations array, so a filter rule that never ran for want of enrichment
was indistinguishable from one that ran and passed. Both reported ALLOW.
Every rule now appears in results[] with RUN / DRY_RUN / NOT_RUN /
CACHED, and a dry-run rule that matched reports DENY -- what it WOULD
have done is the reason you turned it on.
- "Challenge this one." We ship a proof-of-work captcha and the decision
type could not express it, so it was reachable only by hand.
- A stable id. 'rule_' + Date.now() is not unique under concurrency and
correlates with nothing.
characteristics answers a separate question the SDK had also hard-coded:
rate limits keyed on IP, which is the wrong subject for an authenticated
API and the wrong subject for us specifically, since the actor model
exists because IP is not identity. An absent characteristic falls back to
the IP rather than keying under empty -- otherwise one tenant's limit
takes out all anonymous traffic, invisibly.
Decision caching is deliberately narrow: server-derived DENY and CHALLENGE
only. Caching ALLOW is how a client that has since started misbehaving
keeps sailing through, and rule outcomes must not be cached because a rate
limiter has to see every request.
allowed is unchanged, including failing open on error. 327 tests pass, and
the any budgets drop (fastify to zero).
ClosesWebDecoy/app#730ClosesWebDecoy/app#731
@cport1
cport1 merged commit 63b2f97 into mainAug 22, 2026
2 checks passed
Sign up for freeto 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

@cport1