feat(openapi): add allow option to OpenAPIReferenceHandlerPlugin - #1911
Merged
Conversation
Allows serving the docs UI and OpenAPI spec conditionally, e.g. only to authenticated users. When allow resolves to false, the request falls through as unmatched, as if the plugin were not installed. Resolves middleapi#1907
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
More templates
@orpc/ai-sdk
@orpc/arktype
@orpc/bun
@orpc/client
@orpc/cloudflare
@orpc/contract
@orpc/experimental-effect
@orpc/evlog
@orpc/hibernation
@orpc/json-schema
@orpc/experimental-msw
@orpc/nest
@orpc/next
@orpc/node
@orpc/openapi
@orpc/opentelemetry
@orpc/pinia-colada
@orpc/pino
@orpc/publisher
@orpc/ratelimit
@orpc/server
@orpc/shared
@orpc/swr
@orpc/tanstack-query
@orpc/trpc
@orpc/valibot
@orpc/zod
commit: |
![pullfrog[bot]](https://avatars.githubusercontent.com/in/1768019?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
✅ No new issues found. The
allowoption is correctly scoped, well-typed, and the coverages genuinely exercise the new behavior.
Reviewed changes
allowoption onOpenAPIReferenceHandlerPlugin: Newallow: Value<Promisable<boolean>, [...]>option (defaulttrue), stored viaoptions.allow ?? true. Ininit, it's awaited only after a GET request falls through as unmatched AND its URL matchesspecPath/docsPath, and before the spec is generated — so a denied request returns the original unmatched result and never touchesspec, matching the "as if the plugin were not installed" contract.- Tests: Two new cases. The deny case loops
/and/spec.json, asserts the unmatched result is returned unchanged andspecis not called, and that the predicate receives the routing options (includingrequest.url). The allow-true case assertsallowis not invoked for unrelated paths and the spec serves with 200. - Docs: New
## Restricting Accesssection with aallowexample, heading level consistent with## Learn More.
No regressions found. The default is unchanged (allow omitted = served), the new tests fail if the gate regresses, and value()'s boolean/function handling makes the true default a no-op.
DeepSeek Flash (free via Pullfrog for OSS) ｜ 𝕏
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
Contributor
There was a problem hiding this comment.
✅ No new issues found. The refactor keeps the implemented behavior intact and tightens the deny contract.
Reviewed changes
- Dropped the stored
truedefault:this.allow = options.allow ?? true→this.allow = options.allow, and the@default trueJSDoc line was removed. Omittingallownow storesundefined. - Stricter gate:
if (!await value(this.allow, opts))→if (await value(this.allow, opts) === false). This is exactly what makes dropping the default safe:value(undefined, opts)yieldsundefined, andundefined === falseisfalse, so omittedallowstill serves. It also prevents a predicate that happens to resolve to a falsy-but-not-falsevalue (e.g. a missingreturnin an async fn) from silently denying the docs — consistent with the documented contract "when it resolves tofalse". - Tests and docs were not touched by this commit; the existing deny/allow-true/unrelated-path cases continue to cover the gate. I re-ran the plugin test file (10/10 pass) and
tsc -bfor@orpc/openapi(clean).
No regressions found. await value(...) === false parses as (await value(...)) === false, confirming the strict comparison applies to the resolved value.
DeepSeek Flash (free via Pullfrog for OSS) ｜ 𝕏
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
1 participant
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.
Adds an
allowoption toOpenAPIReferenceHandlerPluginso the docs UI and OpenAPI spec can be served conditionally, for example only to authenticated users. When it resolves tofalse, the request falls through as unmatched, as if the plugin were not installed, so unauthorized clients cannot tell the docs and spec paths exist.Resolves #1907
Design
allow: Value<Promisable<boolean>, [StandardHandlerRoutingInterceptorOptions<T>]>, defaulting totrue. It receives the same options asspec,docsTitle, anddocsHead, so decisions can use the handler context or request headers.Testing