feat(settings): allow customization of prisma client import

[nvitaterna]

closes #47

Brings support for the output option in the prisma client generator. Also allows you to set this location manually via the settings option. Maybe a better way at doing this as I didn't spend too much time looking through the library - but it works for both cases (manually setting or using the settings function).

TODO

• docs
• tests

[codecov-commenter]

Codecov Report

Merging #49 (a5a1d4c) into main (2447f56) will decrease coverage by 0.19%.
The diff coverage is 25.00%.

@@            Coverage Diff             @@
##             main      #49      +/-   ##
==========================================
- Coverage   44.66%   44.47%   -0.20%     
==========================================
  Files          26       26              
  Lines         403      407       +4     
  Branches       80       81       +1     
==========================================
+ Hits          180      181       +1     
- Misses        203      206       +3     
  Partials       20       20              

[janpio]

Uh, that Windows failure is interesting. Seems it can not require the C:\Users\RUNNER~1\AppData\Local\Temp\084ac39e4bdb644eb917fbdce69cff3aode_modules\@prisma\client that seems to be the output client location in that schema or project. (I am on Windows, so let me know when you need some help understanding things locally.)

Update: That path actually looks broken:

'> some-test-project@1.0.0 reflect:prisma C:\\Users\\RUNNER~1\\AppData\\Local\\Temp\\084ac39e4bdb644eb917fbdce69cff3a\n' +
'> prisma generate\n' +
'\n' +
'Environment variables loaded from .env\n' +
'Prisma schema loaded from prisma\\schema.prisma\n' +
'You can now start using Nexus Prisma in your code. Reference: https://pris.ly/d/nexus-prisma\n' +
'\n' +
'✔ Generated Prisma Client (2.23.0) to .\\node_modules\\@prisma\\client in 105ms\n' +
'\n' +
...

That should create C:\Users\RUNNER~1\AppData\Local\Temp\084ac39e4bdb644eb917fbdce69cff3a\node_modules\@prisma\client and not C:\Users\RUNNER~1\AppData\Local\Temp\084ac39e4bdb644eb917fbdce69cff3aode_modules\@prisma\client. Where does the \n go here (obviously this rings a bell as a special character... but it should be escaped in the original string).

[nvitaterna]

I think it might be this part here:
https://github.com/prisma/nexus-prisma/blob/27d7ad172d776f7564e36a67743c181954790015/src/cli/nexus-prisma.ts#L33

I should have checked the default of not supplying the option - I'm guessing the output has a value that is generated by default if it's not provided. I'll have to look into what the default is and most likely ignore it - as if it's not set by the user there's no need to change the option.

[janpio]

In the test project it is set by the user I think, so it does the right thing here. It's just that the path is weird in some way I think on Windows. I am trying to run the test locally now to be able to look at the project it creates there.

[nvitaterna]

Okay, on second though it might be this part - though it still should be escaped:
https://github.com/prisma/nexus-prisma/blob/27d7ad172d776f7564e36a67743c181954790015/src/generator/models/javascript.ts#L57-L59

[janpio]

Probably it just worked accidentally before as this test project actually generates the output to the default location 😛

[janpio]

...
const gentimeSettings = {
  "projectIdIntToGraphQL": "Int",
  "docPropagation": {
    "GraphQLDocs": true,
    "JSDoc": true
  },
  "prismaClientLocation": "C:\\Users\\Jan\\AppData\\Local\\Temp\\9dfe0c5ba27ce64390f947e584e3caeb\
ode_modules\\@prisma\\client"
}

const dmmf = getPrismaClientDmmf(gentimeSettings.prismaClientLocation)
...

Something is amiss here ⚔️

[janpio]

Ok, I think I got it. This is a bug totally unrelated to your change deep inside Nexus Prisma when the gentimeSettings are written to a file. If I find a fix, I will send a PR to your branch as well or we can merge it to main quickly and you can rebase.

You can continue with tests etc 👍

[janpio]

I could figure out what is going wrong, but have no instant fix, so I created an issue: #50

[jasonkuhrt]

LGTM thanks 💯

[jasonkuhrt]

Testing this is blocked/part of #44 so no need to do it here. It is going to be tedious/hard to test this kind of thing.

Aside: I'm happy we had the E2E tests to catch the subtle bug revealed by this PR change :D

[janpio]

I think that test that fails/failed is already testing this then! We have a custom output there, which accidentally just was @prisma/client anyway but cause the new code that @nvitaterna wrote to be triggered. We could/should probably add another test project or schema where it is something clearly else than the default package path - as that might just work accidentally. Can you take a shot at this @nvitaterna?

[medz]

This requirement caused @vercel/ncc packaging to fail!
The ncc packaged code itself can be copied to any place for execution, but this requirement causes the effect to disappear

[jasonkuhrt]

@medz can you go into specifics? Users can customize the output location of prisma client. Do you have suggestions about how to support that?

[medz]

@medz can you go into specifics? Users can customize the output location of prisma client. Do you have suggestions about how to support that?

@jasonkuhrt See #109

At first I thought it was a problem with my code. Later, when I encountered problems that could not run, I found that the content submitted by this PR and the content of another PR caused the ncc to be incompatible.

Simply put, it is to create a Nexus + Prisma + ncc project, using nexus-prisma. Then use ncc for packaging. The content of ncc packaging can be moved separately to other places (such as Docker image) for independent operation without the need to download dependencies (this can greatly reduce the size of the running code during deployment. , We all know how big node_modules is).

And nexus-prisma obtains dmmf dynamically from the set module flag (default is @client/prisma).

The key code is https://github.com/prisma/nexus-prisma/blob/main/src/generator/models/javascript.ts#L40

[rostislav-simonik-nexus-prisma-admin]

🎉 This PR is included in version 1.0.0 🎉

The release is available on:

• npm package (@next-major dist-tag)
• GitHub release

Your semantic-release bot 📦🚀