zenstack generate fails with pnpm #560

lewebsimple · 2023-07-06T16:01:40Z

Description and expected behavior
Generating with zenstack generate fails in Nuxt 3 project when using pnpm (works fine with npm).

Environment (please complete the following information):

ZenStack version: 1.0.0-beta.6
Prisma version: 4.16.2
Database type: MySQL

Additional context
I'm trying to setup ZenStack in a Nuxt project using tRPC but I'm stumbling on the following error when generating the initial client with pnpm:

⠋ Running plugin ZodError compiling generated code:
node_modules/.pnpm/@zenstackhq+runtime@1.0.0-beta.6_@prisma+client@4.16.2/node_modules/.zenstack/zod/input/UserInput.schema.ts:23:26 - error TS2742: The inferred type of 'UserInputSchema' cannot be named without a reference to '.pnpm/@prisma+client@4.16.2_prisma@4.16.2/node_modules/.prisma/client'. This is likely not portable. A type annotation is necessary.

23             export const UserInputSchema = {
                            ~~~~~~~~~~~~~~~
node_modules/.pnpm/@zenstackhq+runtime@1.0.0-beta.6_@prisma+client@4.16.2/node_modules/.zenstack/zod/input/UserInput.schema.ts:23:26 - error TS2742: The inferred type of 'UserInputSchema' cannot be named without a reference to '.pnpm/@prisma+client@4.16.2_prisma@4.16.2/node_modules/@prisma/client/runtime'. This is likely not portable. A type annotation is necessary.

23             export const UserInputSchema = {
                            ~~~~~~~~~~~~~~~
node_modules/.pnpm/@zenstackhq+runtime@1.0.0-beta.6_@prisma+client@4.16.2/node_modules/.zenstack/zod/objects/UserArgs.schema.ts:11:15 - error TS2742: The inferred type of 'UserArgsObjectSchema' cannot be named without a reference to '.pnpm/@prisma+client@4.16.2_prisma@4.16.2/node_modules/@prisma/client/runtime'. This is likely not portable. A type annotation is necessary.

11  export const UserArgsObjectSchema = Schema
                 ~~~~~~~~~~~~~~~~~~~~
node_modules/.pnpm/@zenstackhq+runtime@1.0.0-beta.6_@prisma+client@4.16.2/node_modules/.zenstack/zod/objects/UserSelect.schema.ts:11:15 - error TS2742: The inferred type of 'UserSelectObjectSchema' cannot be named without a reference to '.pnpm/@prisma+client@4.16.2_prisma@4.16.2/node_modules/@prisma/client/runtime'. This is likely not portable. A type annotation is necessary.

11  export const UserSelectObjectSchema = Schema
                 ~~~~~~~~~~~~~~~~~~~~~~

This is likely due to the way Nuxt handles tsconfig.json

The text was updated successfully, but these errors were encountered:

NeoN0x · 2023-07-06T18:09:27Z

Hello,

Same issue with a simpler project, and pnpm, but without Nuxt/any dependency, neither tsconfig.json, when trying zenstack generate, after zenstack init

⠋ Running plugin ZodError compiling generated code:
../node_modules/.pnpm/@zenstackhq+runtime@1.0.0-beta.3_@prisma+client@4.16.2/node_modules/.zenstack/zod/input/PostInput.schema.ts:22:26 - error TS2742: The inferred type of 'PostInputSchema' cannot be named without a reference to '.pnpm/@prisma+client@4.16.2_prisma@4.16.2/node_modules/.prisma/client'. This is likely not portable. A type annotation is necessary.

22             export const PostInputSchema = {
                            ~~~~~~~~~~~~~~~
../node_modules/.pnpm/@zenstackhq+runtime@1.0.0-beta.3_@prisma+client@4.16.2/node_modules/.zenstack/zod/input/PostInput.schema.ts:22:26 - error TS2742: The inferred type of 'PostInputSchema' cannot be named without a reference to '.pnpm/@prisma+client@4.16.2_prisma@4.16.2/node_modules/@prisma/client/runtime'. This is likely not portable. A type annotation is necessary.

(... more error like that)

ymc9 · 2023-07-07T08:07:09Z

Thanks for reporting this! I'll look into it and share my finding soon.

ymc9 · 2023-07-09T01:43:55Z

Hi @lewebsimple @NeoN0x , it turns out that tsc is confused by the symlink structure generated by pnpm due to ZenStack's peer dependency on "@prisma/client". I think it's safe to just remove that peer dependency, and the problem should just go away.

I'll make a fix in the upcoming release.

ymc9 · 2023-07-09T11:57:32Z

Fixed in release 1.0.0-beta.7.

NeoN0x · 2023-07-09T21:09:24Z

Thanks a lot for your prompt answer & fix.

I'm experimenting with pnpm/pnpm workspace, and just installed zenstack "zenstack": "1.0.0-beta.7" and prisma with pnpm, and having the sample default model (schema.zmodel with User and Post).

However, I'm still having the issue :

$ pnpm zenstack generate
⌛️ ZenStack CLI v1.0.0-beta.7, running plugins
✔ Running plugin Prisma
✔ Running plugin Model Metadata
✔ Running plugin Access Policy
⠋ Running plugin ZodError compiling generated code:
../node_modules/.pnpm/@zenstackhq+runtime@1.0.0-beta.7/node_modules/.zenstack/zod/input/PostInput.schema.ts:22:26 - error TS2742: The inferred type of 'PostInputSchema' cannot be named without a reference to '.pnpm/@prisma+client@4.16.2_prisma@4.16.2/node_modules/.prisma/client'. This is likely not portable. A type annotation is necessary.

22             export const PostInputSchema = {
                            ~~~~~~~~~~~~~~~
../node_modules/.pnpm/@zenstackhq+runtime@1.0.0-beta.7/node_modules/.zenstack/zod/input/PostInput.schema.ts:22:26 - error TS2742: The inferred type of 'PostInputSchema' cannot be named without a reference to '.pnpm/@prisma+client@4.16.2_prisma@4.16.2/node_modules/@prisma/client/runtime'. This is likely not portable. A type annotation is necessary.

22             export const PostInputSchema = {
                            ~~~~~~~~~~~~~~~
(lot of error like that)

But it seems that this is specifically linked to workspace.

By not using workspace, it does not have the error.

My pnpm-workspace.yaml

packages:
  - 'db/**'
  - 'back/**'
  - 'front/**'
  # exclude packages that are inside test directories
  - '!**/src/test/**'

I'm very new to monorepo things, and after googling it (https://typescript.tv/errors/includes/ts2xxx/ts2742) it is something that might be related (quoted: In a monorepository the error TS2742 can show up when you are using a package that has not set a “main” property in its “package.json” file. Sometimes it also happens that there is a “types” property which does not point to the correct typings. Make sure both paths are present and relative:)

If this is not fixable, what do you advise, should Switch back to npm/yarn workspaces ?

ymc9 · 2023-07-10T00:23:39Z

Hey @NeoN0x , thanks for confirming this! I just tried pnpm workspace and do see the same problems. I thought explicit type annotation could be avoided, but it seems tsc just can't figure out the correct resolutions in some cases. Pnpm is cool but it's symbolic link mechanism has many edge cases :(.

Let me add those annotations and I think the problems should just go away. Will publish a new version soon.

lewebsimple · 2023-07-10T01:16:19Z

The fix in 1.0.0-beta.7 works flawlessly in the same Nuxt projet that previously didn't work.

Thanks 🎉

update well ... it installs correctly but the generated tRPC routers can't import named exports from @zenstackhq/runtime/zod/input because they are CJS. It seems the following might work:

import zodInput from '@zenstackhq/runtime/zod/input';
const { UserInputSchema, PostInputSchema } = zodInput;

instead of import { UserInputSchema, PostInputSchema } from '@zenstackhq/runtime/zod/input';

ymc9 · 2023-07-10T07:38:52Z

Hi @NeoN0x , I've added type annotation to the generated Zod schemas and pushed a new "beta.8" release. Could you check if it's working in your project now? Thanks!

NeoN0x · 2023-07-10T09:18:09Z

Hi @ymc9 ,

I set up the beta.7 to have the exact issue, then only changed to beta.8 and worked perfectly !

Thanks a lot for your dedication ;)

--

For what it worth, further my previous exploration, I managed to use pnpm workspace + beta.7 with the following setting in the schema.zmodel

plugin zod {
  provider = '@core/zod'
  output = 'zod'
}

So I think somehow the issue with using the node_module and conflicted somewhere in the symlink and specifying the output make it clear.

I understand that edge case are very complexe to manage for library like zenstack. I'm also impressed by the by the fix 574 and how it makes this more robust.

ymc9 · 2023-07-10T09:42:12Z

Awesome! So happy it's working now.

Yes, you're right. If the zod plugin's output location is hoisted outside "node_modules" the problem doesn't happen. Having the default configuration to work flawlessly will probably reduce some friction.

Thanks for catching this issue. Feel free to join discord if you haven't 😄: https://go.zenstack.dev/chat

lewebsimple changed the title ~~Cannot generate with pnpm in Nuxt project~~ zenstack generate fails with pnpm Jul 6, 2023

ymc9 mentioned this issue Jul 9, 2023

fix: zod schema compilation errors in pnpm environment due to peer dependencies #568

Merged

ymc9 added next-release in-progress labels Jul 9, 2023

ymc9 closed this as completed Jul 9, 2023

ymc9 reopened this Jul 10, 2023

ymc9 mentioned this issue Jul 10, 2023

fix: make sure zod schemas have type annotations #574

Merged

ymc9 closed this as completed Jul 15, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

zenstack generate fails with pnpm #560

zenstack generate fails with pnpm #560

lewebsimple commented Jul 6, 2023

NeoN0x commented Jul 6, 2023

ymc9 commented Jul 7, 2023

ymc9 commented Jul 9, 2023

ymc9 commented Jul 9, 2023

NeoN0x commented Jul 9, 2023 •

edited

ymc9 commented Jul 10, 2023

lewebsimple commented Jul 10, 2023 •

edited

ymc9 commented Jul 10, 2023

NeoN0x commented Jul 10, 2023

ymc9 commented Jul 10, 2023

zenstack generate fails with pnpm #560

zenstack generate fails with pnpm #560

Comments

lewebsimple commented Jul 6, 2023

NeoN0x commented Jul 6, 2023

ymc9 commented Jul 7, 2023

ymc9 commented Jul 9, 2023

ymc9 commented Jul 9, 2023

NeoN0x commented Jul 9, 2023 • edited

ymc9 commented Jul 10, 2023

lewebsimple commented Jul 10, 2023 • edited

ymc9 commented Jul 10, 2023

NeoN0x commented Jul 10, 2023

ymc9 commented Jul 10, 2023

NeoN0x commented Jul 9, 2023 •

edited

lewebsimple commented Jul 10, 2023 •

edited