fix(core): prevent breaking error when registering transpiler #16929

passbyval · 2023-05-10T22:38:05Z

Current Behavior

Some versions of @swc-node/register do not return a cleanup function, causing registerTsProject to call an undefined function:

 >  NX   Failed to load plugin '@nx' declared in 'apps/nextgen-ui/.eslintrc.json': fn is not a function

@swc-node/register 1.6.5 vs 1.4.2 for reference.

Expected Behavior

To check @swc-node/register's return value, and return a no-op for versions that do not have a cleanup function.

vercel · 2023-05-10T22:38:10Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
nx-dev	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 12, 2023 4:40pm

nx-cloud · 2023-05-10T22:42:21Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1fefa83. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 8 targets

Sent with 💌 from NxCloud.

prevent 'fn is not a function' error when running registerTranspiler. depending on the version, @swc-node/register does not always return a cleanup function, so an explicit check for this is now added.

…de/register returns no cleanup function

passbyval · 2023-05-12T05:08:10Z

packages/nx/src/plugins/js/utils/register.ts

+  const cleanupFn = register(compilerOptions);
+  const isFunction = typeof cleanupFn === 'function';
+
+  if (!isFunction) return () => {};
+
+  return cleanupFn;


Here is the fix.

The rest of the PR is purely refactor to avoid variable reassignment and reduce the amount of nesting. e.g. early returns.

This makes sense, swapping to a ternary to avoid extra variables

passbyval · 2023-05-12T05:08:41Z

packages/nx/src/plugins/js/utils/register.ts

+  type ISwcRegister = typeof import('@swc-node/register/register')['register'];
+  type ISwcRegisterVoid = (...args: Parameters<ISwcRegister>) => void;
+
+  // These are requires to prevent it from registering when it shouldn't
+  const register = require('@swc-node/register/register').register as
+    | ISwcRegister
+    | ISwcRegisterVoid;


Add explicit type-checking to account for versions of @swc-node/register that do not return cleanup functions.

I'm removing some of this, since we are removing the strict portion it doesn't end up helping and looks a bit confusing

Makes sense without strict null checks 👍

passbyval · 2023-05-12T05:13:34Z

packages/nx/src/plugins/js/utils/register.ts

@@ -35,6 +35,59 @@ export const registerTsProject = (
  };
 };

+export function getSwcTranspiler(


Needed to enable strictNullChecks otherwise TypeScript was allowing this function to return null/undefined even when the return type was a function.

I hear you, and I agree, but I don't think we should do this via an extra tsconfig, since that won't get checked at build time.

We'd eventually like to enable strict mode for the nx package globally, but can't just yet. I've removed this part of the changes.

Sounds good, and strict mode is a great idea for the entire project.

AgentEnder

Thanks for the fix @passbyval! I've made some changes and it looks good to go 🎉

AgentEnder · 2023-05-12T15:53:21Z

packages/nx/src/plugins/js/utils/register.ts

@@ -35,6 +35,59 @@ export const registerTsProject = (
  };
 };

+export function getSwcTranspiler(


I hear you, and I agree, but I don't think we should do this via an extra tsconfig, since that won't get checked at build time.

We'd eventually like to enable strict mode for the nx package globally, but can't just yet. I've removed this part of the changes.

AgentEnder · 2023-05-12T15:54:43Z

packages/nx/src/plugins/js/utils/register.ts

+  type ISwcRegister = typeof import('@swc-node/register/register')['register'];
+  type ISwcRegisterVoid = (...args: Parameters<ISwcRegister>) => void;
+
+  // These are requires to prevent it from registering when it shouldn't
+  const register = require('@swc-node/register/register').register as
+    | ISwcRegister
+    | ISwcRegisterVoid;


I'm removing some of this, since we are removing the strict portion it doesn't end up helping and looks a bit confusing

AgentEnder · 2023-05-12T15:55:06Z

packages/nx/src/plugins/js/utils/register.ts

+  const cleanupFn = register(compilerOptions);
+  const isFunction = typeof cleanupFn === 'function';
+
+  if (!isFunction) return () => {};
+
+  return cleanupFn;


This makes sense, swapping to a ternary to avoid extra variables

github-actions · 2023-05-18T00:06:28Z

This pull request has already been merged/closed. If you experience issues related to these changes, please open a new issue referencing this pull request.

passbyval requested review from vsavkin, FrozenPandaz and AgentEnder as code owners May 10, 2023 22:38

passbyval changed the title ~~Fix error when running eslint after using @nx/linter:workspace-rule generator~~ fix(linter) error when running eslint after using @nx/linter:workspace-rule generator May 10, 2023

vercel bot deployed to Preview May 10, 2023 22:42 View deployment

passbyval changed the title ~~fix(linter) error when running eslint after using @nx/linter:workspace-rule generator~~ [WIP] fix(linter) error when running eslint after using @nx/linter:workspace-rule generator May 10, 2023

passbyval changed the title ~~[WIP] fix(linter) error when running eslint after using @nx/linter:workspace-rule generator~~ [WIP] fix(js) error when running eslint after using @nx/linter:workspace-rule generator May 11, 2023

passbyval force-pushed the patch-1 branch from a275f51 to 97daf3a Compare May 11, 2023 00:07

vercel bot deployed to Preview May 11, 2023 00:11 View deployment

passbyval changed the title ~~[WIP] fix(js) error when running eslint after using @nx/linter:workspace-rule generator~~ fix(js): prevent breaking error when registering transpiler May 11, 2023

vercel bot deployed to Preview May 11, 2023 02:44 View deployment

vercel bot deployed to Preview May 11, 2023 03:20 View deployment

passbyval changed the title ~~fix(js): prevent breaking error when registering transpiler~~ fix(nx-plugin): prevent breaking error when registering transpiler May 11, 2023

fix(nx-plugin): prevent breaking error when registering transpiler

25863d4

prevent 'fn is not a function' error when running registerTranspiler. depending on the version, @swc-node/register does not always return a cleanup function, so an explicit check for this is now added.

passbyval force-pushed the patch-1 branch from f6f9d52 to 25863d4 Compare May 11, 2023 09:19

vercel bot deployed to Preview May 11, 2023 09:23 View deployment

Merge branch 'master' into patch-1

14fbd1e

vercel bot deployed to Preview May 11, 2023 23:18 View deployment

passbyval added 4 commits May 11, 2023 22:02

cleanup(nx-plugin): add explicit type checking for cases when @swc-no…

64d2924

…de/register returns no cleanup function

chore(nx-plugin): run nx format

e39cc71

Merge branch 'patch-1' of github.com:passbyval/nx into patch-1

af32017

chore(nx-plugin): fix typo

59607a3

passbyval commented May 12, 2023

View reviewed changes

vercel bot had a problem deploying to Preview May 12, 2023 05:09 Failure

passbyval commented May 12, 2023

View reviewed changes

cleanup(nx-plugin): enable strictNullChecks for plugins/js/utils only

590ca0f

vercel bot deployed to Preview May 12, 2023 05:50 View deployment

vercel bot deployed to Preview May 12, 2023 07:03 View deployment

AgentEnder changed the title ~~fix(nx-plugin): prevent breaking error when registering transpiler~~ fix(core): prevent breaking error when registering transpiler May 12, 2023

cleanup(misc): remove comment

16bcb31

AgentEnder force-pushed the patch-1 branch from b95710c to 16bcb31 Compare May 12, 2023 15:51

AgentEnder approved these changes May 12, 2023

View reviewed changes

vercel bot deployed to Preview May 12, 2023 16:10 View deployment

Merge branch 'master' into patch-1

1fefa83

vercel bot deployed to Preview May 12, 2023 16:40 View deployment

AgentEnder merged commit 8460c63 into nrwl:master May 12, 2023

passbyval deleted the patch-1 branch May 12, 2023 22:32

github-actions bot locked as resolved and limited conversation to collaborators May 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(core): prevent breaking error when registering transpiler #16929

fix(core): prevent breaking error when registering transpiler #16929

passbyval commented May 10, 2023 •

edited

Loading

vercel bot commented May 10, 2023 •

edited

Loading

nx-cloud bot commented May 10, 2023 •

edited

Loading

passbyval May 12, 2023

AgentEnder May 12, 2023

passbyval May 12, 2023

AgentEnder May 12, 2023

passbyval May 12, 2023

passbyval May 12, 2023

AgentEnder May 12, 2023

passbyval May 12, 2023

AgentEnder left a comment

AgentEnder May 12, 2023

AgentEnder May 12, 2023

AgentEnder May 12, 2023

github-actions bot commented May 18, 2023

fix(core): prevent breaking error when registering transpiler #16929

fix(core): prevent breaking error when registering transpiler #16929

Conversation

passbyval commented May 10, 2023 • edited Loading

Current Behavior

Expected Behavior

vercel bot commented May 10, 2023 • edited Loading

nx-cloud bot commented May 10, 2023 • edited Loading

☁️ Nx Cloud Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AgentEnder left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented May 18, 2023

passbyval commented May 10, 2023 •

edited

Loading

vercel bot commented May 10, 2023 •

edited

Loading

nx-cloud bot commented May 10, 2023 •

edited

Loading