feat(prisma): support pglite in developer environments

[LoneRifle]

Problem

In some local dev environments, we may not be able to connect to a postgres instance, for the following non-exhaustive reasons:

• The machine is disallowed from connecting to postgres servers
• The machine cannot run docker, and there is no practical way to procure a standalone postgres server
• The environment is actually StackBlitz and is run completely in-browser

Solution

In such instances, we will allow for use of pglite, if NODE_ENV is development or test, and there is no DATABASE_URL specified. If both conditions hold, we inject a placeholder database url to placate prisma, and set up a PGLite adapter.

Testing evidence

 ✓ Starting...
 ✓ Ready in 1566ms
 ○ Compiling /sign-in ...
 ✓ Compiled /sign-in in 3.9s (2725 modules)
 GET /sign-in?callbackUrl=%2Fsign-in 200 in 4787ms
 ✓ Compiled /api/trpc/[trpc] in 255ms (300 modules)
{"level":40,"time":1728010001039,"pid":53386,"hostname":"localhost","msg":"DATABASE_URL not set, using pglite"}

[vercel]

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

Name	Status	Preview	Comments	Updated (UTC)
starter-kit	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Oct 8, 2024 7:10am

[datadog-opengovsg]

Datadog Report

Branch report: feat/prisma/pglite
Commit report: 45f5f94
Test service: starter-kit

✅ 0 Failed, 13 Passed, 0 Skipped, 10.03s Total Time

[qin-guan]

Keeping sane inside Pulau Tekong

[karrui]

I don't know if starter kit should be using pglite for development (and couple more code to the node environment). Does not seem like a useful thing for OGP folks. We want to stop tailoring this kit for external use at the expense of internal use!

[LoneRifle]

I don't know if starter kit should be using pglite for development (and couple more code to the node environment). Does not seem like a useful thing for OGP folks. We want to stop tailoring this kit for external use at the expense of internal use!

@karrui but is it really at the expense of internal use?

Granted this PR (and a few more I have planned) would add a few more moving parts, mostly properties or logic driven by NODE_ENV and DATABASE_URL, but it could unlock quite a fair bit of opportunity. Consider eg being able to try out an open-sourced @opengovsg product based on Starter Kit within a locked down intranet environment, or a non-technical person being able to see what the product can do for their organisation by demoing it completely out of their browser

[karrui]

I think the important thing for this starter kit is for it to be tight. Users already have to delete so many things to get it to a clean slate; and I want to reduce unnecessary code in the code base.

I'd rather you update the docs to add this as a possibility if one does not have the propensity to spin up a database for use.

However, I don't want to recommend people to use pglite in development either; you can't really connect to the db and explore the db as one would a real database.

[LoneRifle]

I think the important thing for this starter kit is for it to be tight. Users already have to delete so many things to get it to a clean slate; and I want to reduce unnecessary code in the code base.

I'd rather you update the docs to add this as a possibility if one does not have the propensity to spin up a database for use.

Okay, that's unfortunate but fair. I'll see how I can have this documented.