fix(framework): Resolve CJS issues this time with json-schema-faker #6766

SokratisVidros · 2024-10-24T14:35:36Z

What changed? Why was the change needed?

Apply more configuration changes for better ESM/CJS support. Also try to remove the Node https dependency from json-schema-faker

Fixes #6701
Fixes #6332

netlify · 2024-10-24T14:35:53Z

✅ Deploy Preview for novu-stg-vite-dashboard-poc ready!

Name	Link
🔨 Latest commit	`cb6c2e5`
🔍 Latest deploy log	https://app.netlify.com/sites/novu-stg-vite-dashboard-poc/deploys/671f3a7be8efe30008f15b53
😎 Deploy Preview	https://deploy-preview-6766--novu-stg-vite-dashboard-poc.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

pkg-pr-new · 2024-10-24T15:18:45Z

Open in Stackblitz

@novu/client

pnpm add https://pkg.pr.new/novuhq/novu/@novu/client@6766

@novu/framework

pnpm add https://pkg.pr.new/novuhq/novu/@novu/framework@6766

@novu/headless

pnpm add https://pkg.pr.new/novuhq/novu/@novu/headless@6766

@novu/js

pnpm add https://pkg.pr.new/novuhq/novu/@novu/js@6766

@novu/nextjs

pnpm add https://pkg.pr.new/novuhq/novu/@novu/nextjs@6766

@novu/nest

pnpm add https://pkg.pr.new/novuhq/novu/@novu/nest@6766

@novu/node

pnpm add https://pkg.pr.new/novuhq/novu/@novu/node@6766

@novu/notification-center

pnpm add https://pkg.pr.new/novuhq/novu/@novu/notification-center@6766

novu

pnpm add https://pkg.pr.new/novuhq/novu@6766

@novu/providers

pnpm add https://pkg.pr.new/novuhq/novu/@novu/providers@6766

@novu/react

pnpm add https://pkg.pr.new/novuhq/novu/@novu/react@6766

@novu/react-native

pnpm add https://pkg.pr.new/novuhq/novu/@novu/react-native@6766

@novu/shared

pnpm add https://pkg.pr.new/novuhq/novu/@novu/shared@6766

@novu/stateless

pnpm add https://pkg.pr.new/novuhq/novu/@novu/stateless@6766

commit: cb6c2e5

Json-schema-faker is causing big HMR and Webpack headaches when @novu/framework is used in Next.js. To address the issue, we decided to go old-school and hardcode the IIFE version of the source code in our package. The code was copied for https://unpkg.com/browse/json-schema-faker@0.5.6/dist/main.iife.js. PLEASE NOTE THE CODE WAS SLIGHTLY MODIFIED TO MAKE IT WORK IN @novu/framework. See the end of this file. See json-schema-faker/json-schema-faker#796 (comment).

SokratisVidros · 2024-10-28T07:17:42Z

packages/framework/express/package.json

@@ -1,5 +1,3 @@
 {
-  "main": "../dist/cjs/servers/express.cjs",


After careful testing, these are not required as ESM sub-exports will always be fetched from the top-level package.json

SokratisVidros · 2024-10-28T07:18:31Z

packages/framework/package.json

@@ -239,7 +239,6 @@
    "better-ajv-errors": "^1.2.0",
    "chalk": "^4.1.2",
    "cross-fetch": "^4.0.0",
-    "json-schema-faker": "^0.5.6",


This package is causing a lot of ESM/CJS trouble. It was decided to hardcode its UMD version in the framework.

SokratisVidros · 2024-10-28T07:19:26Z

packages/framework/package.json

@@ -37,7 +37,7 @@
    "format:fix": "prettier --write --ignore-path .gitignore .",
    "build": "NODE_ENV=production tsup",
    "build:watch": "tsup --watch",
-    "postbuild": "./scripts/copy-package-json.sh && pnpm run check:exports && pnpm check:circulars",


Copy-package.json is not anymore assuming package exports work correctly. Attw confirms the removal.

SokratisVidros · 2024-10-28T07:19:50Z

packages/framework/tsup.config.ts


 const frameworks: SupportedFrameworkName[] = ['h3', 'express', 'next', 'nuxt', 'sveltekit', 'remix', 'lambda', 'nest'];

 const baseConfig: Options = {
  entry: ['src/index.ts', 'src/internal/index.ts', ...frameworks.map((framework) => `src/servers/${framework}.ts`)],
  sourcemap: false,
  clean: true,
-  treeshake: true,


Libraries need to be treeshaken by the host application bundler.

SokratisVidros · 2024-10-28T07:22:13Z

packages/framework/tsup.config.ts


 const frameworks: SupportedFrameworkName[] = ['h3', 'express', 'next', 'nuxt', 'sveltekit', 'remix', 'lambda', 'nest'];

 const baseConfig: Options = {
  entry: ['src/index.ts', 'src/internal/index.ts', ...frameworks.map((framework) => `src/servers/${framework}.ts`)],
  sourcemap: false,
  clean: true,
-  treeshake: true,
  dts: true,
  minify: true,


Libraries shouldn't be minified. The host application bundler should handle that.

However, setting bundle: false and minify: false in tsup config, breaks Nest.js loading @novu/framework.

The hypothesis is that building through ESBuild alone is not enough. Minify triggers a rollup processing that, for some reason, satisfies Nest.js CommonJS requirements.

We will get back to this in a separate PR, as this one is already big enough.

Thanks for the detailed explanation. Sounds like a good plan 👍

SokratisVidros · 2024-10-28T07:23:25Z

packages/framework/tsup.config.ts

  dts: true,
  minify: true,
  minifyWhitespace: true,
  minifyIdentifiers: true,
  minifySyntax: true,
+  define: {
+    SDK_VERSION: `"${version}"`,


Static code replacements allow us to eliminate importing package.json on runtime that can cause some CJS/ESM issues.

Awesome! 👍

SokratisVidros temporarily deployed to Linting October 24, 2024 14:35 — with GitHub Actions Inactive

SokratisVidros had a problem deploying to Linting October 24, 2024 14:35 — with GitHub Actions Failure

SokratisVidros temporarily deployed to Linting October 24, 2024 14:35 — with GitHub Actions Inactive

SokratisVidros temporarily deployed to Linting October 24, 2024 15:01 — with GitHub Actions Inactive

SokratisVidros had a problem deploying to Linting October 24, 2024 15:01 — with GitHub Actions Failure

SokratisVidros temporarily deployed to Linting October 24, 2024 15:16 — with GitHub Actions Inactive

SokratisVidros temporarily deployed to Linting October 24, 2024 15:22 — with GitHub Actions Inactive

SokratisVidros temporarily deployed to Linting October 24, 2024 15:48 — with GitHub Actions Inactive

SokratisVidros force-pushed the framework_in_edge_runtimes branch from 7c18a50 to aba2de9 Compare October 24, 2024 15:49

SokratisVidros temporarily deployed to Linting October 24, 2024 15:49 — with GitHub Actions Inactive

SokratisVidros force-pushed the framework_in_edge_runtimes branch from 990adf1 to ac7b5af Compare October 25, 2024 08:19

SokratisVidros temporarily deployed to Linting October 25, 2024 08:19 — with GitHub Actions Inactive

SokratisVidros had a problem deploying to Linting October 25, 2024 08:19 — with GitHub Actions Failure

SokratisVidros temporarily deployed to Linting October 25, 2024 08:23 — with GitHub Actions Inactive

SokratisVidros force-pushed the framework_in_edge_runtimes branch from ef941ef to d68d18a Compare October 25, 2024 08:31

SokratisVidros temporarily deployed to Linting October 25, 2024 08:32 — with GitHub Actions Inactive

SokratisVidros temporarily deployed to Linting October 25, 2024 11:06 — with GitHub Actions Inactive

SokratisVidros temporarily deployed to Linting October 25, 2024 11:18 — with GitHub Actions Inactive

SokratisVidros force-pushed the framework_in_edge_runtimes branch from 07a77b6 to 659f791 Compare October 25, 2024 14:26

SokratisVidros temporarily deployed to Linting October 25, 2024 14:26 — with GitHub Actions Inactive

SokratisVidros changed the title ~~fix(framework): Try with dynamic import to resolve CJS issues this time.~~ fix(framework): Resolve CJS issues this time with json-schema-faker Oct 25, 2024

SokratisVidros force-pushed the framework_in_edge_runtimes branch from 659f791 to bdb270d Compare October 25, 2024 19:47

SokratisVidros temporarily deployed to Linting October 25, 2024 19:47 — with GitHub Actions Inactive

SokratisVidros marked this pull request as ready for review October 28, 2024 07:16

SokratisVidros added 3 commits October 28, 2024 09:17

fix(framework): Try with dynamic import to resolve CJS issues this time.

7550580

fix(framework): Try with an unminified build

d408671

SokratisVidros force-pushed the framework_in_edge_runtimes branch from bdb270d to cb6c2e5 Compare October 28, 2024 07:17

SokratisVidros temporarily deployed to Linting October 28, 2024 07:17 — with GitHub Actions Inactive

SokratisVidros commented Oct 28, 2024

View reviewed changes

rifont self-requested a review October 28, 2024 08:23

rifont approved these changes Oct 28, 2024

View reviewed changes

SokratisVidros merged commit d6d4250 into next Oct 29, 2024
45 checks passed

SokratisVidros deleted the framework_in_edge_runtimes branch October 29, 2024 07:20

github-actions bot mentioned this pull request Nov 12, 2024

chore( framework): release 2.4.0 #6952

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix(framework): Resolve CJS issues this time with json-schema-faker #6766

fix(framework): Resolve CJS issues this time with json-schema-faker #6766

SokratisVidros commented Oct 24, 2024 •

edited

Loading

netlify bot commented Oct 24, 2024 •

edited

Loading

pkg-pr-new bot commented Oct 24, 2024 •

edited

Loading

SokratisVidros Oct 28, 2024 •

edited

Loading

SokratisVidros Oct 28, 2024

SokratisVidros Oct 28, 2024

SokratisVidros Oct 28, 2024

SokratisVidros Oct 28, 2024

rifont Oct 28, 2024

SokratisVidros Oct 28, 2024

rifont Oct 28, 2024

fix(framework): Resolve CJS issues this time with json-schema-faker #6766

fix(framework): Resolve CJS issues this time with json-schema-faker #6766

Conversation

SokratisVidros commented Oct 24, 2024 • edited Loading

What changed? Why was the change needed?

netlify bot commented Oct 24, 2024 • edited Loading

✅ Deploy Preview for novu-stg-vite-dashboard-poc ready!

pkg-pr-new bot commented Oct 24, 2024 • edited Loading

SokratisVidros Oct 28, 2024 • edited Loading

Choose a reason for hiding this comment

SokratisVidros Oct 28, 2024

Choose a reason for hiding this comment

SokratisVidros Oct 28, 2024

Choose a reason for hiding this comment

SokratisVidros Oct 28, 2024

Choose a reason for hiding this comment

SokratisVidros Oct 28, 2024

Choose a reason for hiding this comment

rifont Oct 28, 2024

Choose a reason for hiding this comment

SokratisVidros Oct 28, 2024

Choose a reason for hiding this comment

rifont Oct 28, 2024

Choose a reason for hiding this comment

SokratisVidros commented Oct 24, 2024 •

edited

Loading

netlify bot commented Oct 24, 2024 •

edited

Loading

pkg-pr-new bot commented Oct 24, 2024 •

edited

Loading

SokratisVidros Oct 28, 2024 •

edited

Loading