-
-
Notifications
You must be signed in to change notification settings - Fork 1.6k
fix: avoid false positives in import-protection plugin #6708
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
27 changes: 27 additions & 0 deletions
27
e2e/react-start/import-protection/src/violations/boundary-safe.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| import { | ||
| createIsomorphicFn, | ||
| createServerFn, | ||
| createServerOnlyFn, | ||
| } from '@tanstack/react-start' | ||
|
|
||
| import { getSecret } from './secret.server' | ||
|
|
||
| // NOTE: `getSecret` is only referenced inside compiler-recognized boundaries. | ||
| // The Start compiler should prune the `./secret.server` import from the client | ||
| // build output. | ||
|
|
||
| export const safeServerOnly = createServerOnlyFn(() => { | ||
| return getSecret() | ||
| }) | ||
|
|
||
| export const safeServerFn = createServerFn().handler(async () => { | ||
| return getSecret() | ||
| }) | ||
|
|
||
| export const safeIsomorphic = createIsomorphicFn() | ||
| .server(() => { | ||
| return getSecret() | ||
| }) | ||
| .client(() => { | ||
| return 'client' | ||
| }) |
22 changes: 22 additions & 0 deletions
22
e2e/react-start/import-protection/src/violations/factory-safe/createSecretFactory.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,22 @@ | ||
| import { createMiddleware, createServerFn } from '@tanstack/react-start' | ||
| import { getRequest } from '@tanstack/react-start/server' | ||
|
|
||
| import { getSecret } from '../secret.server' | ||
|
|
||
| // This file intentionally contains denied imports (./secret.server and | ||
| // @tanstack/react-start/server), but they are only referenced inside | ||
| // compiler-recognized server boundaries. | ||
|
|
||
| const secretMiddleware = createMiddleware({ type: 'function' }).server( | ||
| ({ next }) => { | ||
| const req = getRequest() | ||
| const secret = getSecret() | ||
| return next({ | ||
| context: { method: req.method, secret } as const, | ||
| }) | ||
| }, | ||
| ) | ||
|
|
||
| export const createSecretFactoryServerFn = createServerFn().middleware([ | ||
| secretMiddleware, | ||
| ]) |
11 changes: 11 additions & 0 deletions
11
e2e/react-start/import-protection/src/violations/factory-safe/usage.ts
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,11 @@ | ||
| import { createSecretFactoryServerFn } from './createSecretFactory' | ||
|
|
||
| export const factorySafeServerFn = createSecretFactoryServerFn().handler( | ||
| async ({ context, method }) => { | ||
| return { | ||
| name: 'factorySafeServerFn', | ||
| method, | ||
| context, | ||
| } | ||
| }, | ||
| ) |
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
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
Oops, something went wrong.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fix Playwright import style to satisfy lint rules.
The linter flags inline type specifiers and member ordering. Split the type-only import into its own line.
✅ Suggested fix
📝 Committable suggestion
🧰 Tools
🪛 ESLint
[error] 4-4: Member 'FullConfig' of the import declaration should be sorted alphabetically.
(sort-imports)
[error] 4-4: Prefer using a top-level type-only import instead of inline type specifiers.
(import/consistent-type-specifier-style)
🤖 Prompt for AI Agents