feat(drizzle): Migrate to Drizzle ORM #404

realmikesolo · 2024-05-08T13:31:29Z

This PR was made to migrate from Prisma to Drizzle ORM. It involves rewriting the database interactions using Drizzle ORM.

Instructions

If you directly start the project with Drizzle ORM

Remove unnecessary schema file: Delete lib/legacy-schema.ts file as it is only used when migrating from Prisma.
Initialize Schema: The Drizzle schema located in lib/schema.ts will be used for database queries.
Apply changes to the database: Run the drizzle-kit push command to apply your changes to the database. Learn more about the push command here.
Begin using the template: You can now start using this template with Drizzle ORM.

If you migrating from Prisma

Replace the schema file: Remove the existing lib/schema.ts file and rename lib/legacy-schema.ts to lib/schema.ts.
Update database schema: email column in users table is set to not null to ensure compatibility with drizzle next-auth adapter. Apply this change by running the drizzle-kit push command. Learn more about push command here.
Complete migration: You are now ready to use this template with Drizzle ORM.

vercel · 2024-05-08T13:31:33Z

@realmikesolo is attempting to deploy a commit to the Vercel Labs Team on Vercel.

A member of the Team first needs to authorize it.

leerob

This is looking great!

leerob · 2024-05-09T12:43:08Z

app/[domain]/[slug]/page.tsx

@@ -113,7 +109,7 @@ export default async function SitePostPage({
          href={
            data.site?.user?.username
              ? `https://twitter.com/${data.site.user.username}`
-              : `https://github.com/${data.site?.user?.gh_username}`
+              : `https://github.com/${data.site?.user?.ghUsername}`


Would this require a data migration?

leerob · 2024-05-09T12:45:54Z

lib/actions.ts

+      })
+      .returning();
+
+    // unnecessary await


Remove the await?

leerob · 2024-05-09T12:46:20Z

lib/actions.ts

+        .where(eq(sites.id, site.id))
+        .returning();
+
+      await revalidateTag(


Suggested change

await revalidateTag(

revalidateTag(

leerob · 2024-05-09T12:46:34Z

lib/actions.ts

+        `${site.subdomain}.${process.env.NEXT_PUBLIC_ROOT_DOMAIN}-metadata`,
+      );
+      response.customDomain &&
+        (await revalidateTag(`${site.customDomain}-metadata`));


Suggested change

(await revalidateTag(`${site.customDomain}-metadata`));

revalidateTag(`${site.customDomain}-metadata`);

leerob · 2024-05-09T12:46:49Z

lib/actions.ts

+      })
+      .returning();
+
+    await revalidateTag(


Suggested change

await revalidateTag(

revalidateTag(

m-torin · 2024-05-09T15:00:40Z

It's an interesting choice to move away from a project that enterprises and governments support to one that's unknown and may require security reviews. What benefits make this worth it?

leerob · 2024-05-09T18:48:16Z

@m-torin if you would like to use Prisma, that's great. Please do! I don't have anything against Prisma. In fact, we just worked with them on this https://db-latency.vercel.app/.

…chema

realmikesolo · 2024-05-11T17:29:46Z

I made some edits based on the review, updated the Drizzle schema, upgraded drizzle-kit to version 0.21.1, and created a new Prisma compatible schema with an initial migration. These can be used if switching from Prisma to Drizzle ORM. The migration was created after pulling the DDL from an existing database, which was initially used with Prisma. The only thing that needs to be done is to set the email field in the User table to 'not null' for type compatibility with the Drizzle adapter for next-auth.

Currently, there are two bugs related to drizzle-kit removing foreign key constraints and recreating them, and drizzle-kit detecting changes in timestamp precision even when there are none. These should be fixed soon. Once they are resolved, the Prisma compatible schema can be used. If it's a new project, it's recommended to use the standard Drizzle schema.

Please let me know if anything needs updating.

AlexBlokh · 2024-05-13T12:16:51Z

app/[domain]/[slug]/page.tsx

 import { getPostData, getSiteData } from "@/lib/fetchers";
 import BlogCard from "@/components/blog-card";
 import BlurImage from "@/components/blur-image";
 import MDX from "@/components/mdx";
 import { placeholderBlurhash, toDateString } from "@/lib/utils";
+import db from "@/lib/db/db";


AlexBlokh · 2024-05-13T12:27:02Z

components/posts.tsx


-  return posts.length > 0 ? (
+  const query = db


make in query syntax

AlexBlokh · 2024-05-13T12:29:58Z

components/sites.tsx

-  });
+  const query = db
+    .select({
+      ...getTableColumns(sites),


realmikesolo · 2024-05-16T11:32:05Z

Bugs with Drizzle-kit were fixed

vercel · 2024-06-04T14:08:48Z

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

Name	Status	Preview	Comments	Updated (UTC)
platforms	❌ Failed (Inspect)			Jun 4, 2024 2:10pm

prisma-compatible/migrations/0000_concerned_virginia_dare.sql

socket-security · 2024-06-07T18:39:40Z

New and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/[email protected]	None	`0`	8.55 kB	lukeed
npm/[email protected]	None	`0`	0 B
npm/[email protected]	environment, network	`0`	77.6 kB	brianc
npm/[email protected]	environment, filesystem	`+2`	343 kB	ai
npm/[email protected]	environment, filesystem, unsafe	`0`	8.25 MB	prettier-bot
npm/[email protected]	None	`+1`	727 kB	dcas
npm/[email protected]	environment, filesystem Transitive: network, shell, unsafe	`+87`	14.2 MB	adamwathan
npm/[email protected]	None	`0`	32.4 MB	typescript-bot

🚮 Removed packages: npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected], npm/[email protected]

View full report↗︎

socket-security · 2024-06-07T18:39:43Z

🚨 Potential security issues detected. Learn more about Socket for GitHub ↗︎

To accept the risk, merge this PR and you will not be notified again.

Alert	Package	Note	Source
Nonpermissive License	npm/@vercel/[email protected]	Location: Package overview	orphan: npm/@vercel/[email protected]
Copyleft License	npm/@vercel/[email protected]	Location: Package overview	orphan: npm/@vercel/[email protected]
Nonpermissive License	npm/@vercel/[email protected]	Location: Package overview	Source
Copyleft License	npm/@vercel/[email protected]	Location: Package overview	Source

View full report↗︎

Next steps

What do I need to know about license files?

(Experimental) A license not known to be considered permissive was found

Determine whether use of material not offered under a known permissive license works for you

What do I need to know about license files?

(Experimental) Copyleft license information was found

Determine whether use of copyleft material works for you

Take a deeper look at the dependency

Take a moment to review the security alert above. Review the linked package source code to understand the potential risk. Ensure the package is not malicious before proceeding. If you're unsure how to proceed, reach out to your security team or ask the Socket team for help at support [AT] socket [DOT] dev.

Remove the package

If you happen to install a dependency that Socket reports as Known Malware you should immediately remove it and select a different dependency. For other alert types, you may may wish to investigate alternative packages or consider if there are other ways to mitigate the specific risk posed by the dependency.

Mark a package as acceptable risk

To ignore an alert, reply with a comment starting with @SocketSecurity ignore followed by a space separated list of ecosystem/package-name@version specifiers. e.g. @SocketSecurity ignore npm/[email protected] or ignore all packages with @SocketSecurity ignore-all

@SocketSecurity ignore npm/@vercel/[email protected]
@SocketSecurity ignore npm/@vercel/[email protected]

leerob

Thank you!

mdichtler · 2024-06-19T12:25:49Z

@leerob @realmikesolo - this seems to break Github auth as it might happen that Github login that's in the example returns null for the email, due to the schema email field being set to notNull in users table. This happens when the person trying to login in Github email preferences has Keep my email addresses private checked.

mdichtler · 2024-06-19T12:28:12Z

Submitted issue for tracking: #412

AlexBlokh · 2024-06-19T12:31:07Z

@mdichtler we're a bit confused with @realmikesolo as of now, since originally Prisma's adapter did have this field as just unique, then the Next Auth author mentioned that field(we might've got it wrong) can be .notNull and even for github they will still get the email if it's null. If the field can be null or empty string - it can't be unique either

mdichtler · 2024-06-19T12:36:39Z

@AlexBlokh - I'm free for the next hour if you want to troubleshoot this a bit - add my discord: @MartinDichtler also attaching screenshot of my github profile where email is set to null. This is logged from auth.ts line 14 (profile callback)

AlexBlokh · 2024-06-19T12:54:50Z

@mdichtler here's a conversation with the NextAuth team in Discord

They advise us to do a migration of id -> email where email is null before declaring a schema and seems like they consider this a bug, but we tend to just make this field nullable since it doesn't make sense to have it not null

realmikesolo added 7 commits March 26, 2024 17:49

migrate to drizzle: wip

45115e7

migrate to drizzle: wip

56065b0

migrate to drizzle: finish

d15d04d

update next-auth: wip

a631151

migrate to drizzle: remove prisma

3454c21

fix: syntax & format errors

80ede30

cleanup

18c4e96

leerob reviewed May 9, 2024

View reviewed changes

realmikesolo added 3 commits May 11, 2024 18:30

add: prisma compatible schema for drizzle & update: current drizzle s…

128d055

…chema

fix: format & syntax errors & remove: redundant await

0e0e8ea

upgrade drizzle-kit to 0.21.0

caa9359

AlexBlokh reviewed May 13, 2024

View reviewed changes

components/posts.tsx Outdated

return posts.length > 0 ? (

const query = db

Copy link

AlexBlokh May 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

make in query syntax

AlexBlokh reviewed May 13, 2024

View reviewed changes

components/sites.tsx Outdated

});

const query = db

.select({

...getTableColumns(sites),

Copy link

AlexBlokh May 13, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

redundant

realmikesolo added 2 commits May 13, 2024 22:49

made edits according to the review

d67e4e1

update: drizzle kit to new version & fix: bugs

fce5c6c

vercel bot had a problem deploying to Preview June 4, 2024 14:09 Failure

leerob reviewed Jun 4, 2024

View reviewed changes

prisma-compatible/migrations/0000_concerned_virginia_dare.sql Outdated Show resolved Hide resolved

realmikesolo added 2 commits June 7, 2024 20:10

feat(drizzle): add instructions & bump drizzle orm & drizzle-kit version

6daa8ea

feat(drizzle): fix table names

879e0fb

realmikesolo requested a review from leerob June 7, 2024 18:24

leerob approved these changes Jun 8, 2024

View reviewed changes

leerob merged commit 7e33556 into vercel:main Jun 8, 2024
1 of 3 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(drizzle): Migrate to Drizzle ORM #404

feat(drizzle): Migrate to Drizzle ORM #404

realmikesolo commented May 8, 2024 •

edited

Loading

vercel bot commented May 8, 2024

leerob left a comment

leerob May 9, 2024

leerob May 9, 2024

leerob May 9, 2024

leerob May 9, 2024

leerob May 9, 2024

m-torin commented May 9, 2024

leerob commented May 9, 2024

realmikesolo commented May 11, 2024 •

edited

Loading

AlexBlokh May 13, 2024

AlexBlokh May 13, 2024

AlexBlokh May 13, 2024

realmikesolo commented May 16, 2024

vercel bot commented Jun 4, 2024 •

edited

Loading

socket-security bot commented Jun 7, 2024

socket-security bot commented Jun 7, 2024

leerob left a comment

mdichtler commented Jun 19, 2024

mdichtler commented Jun 19, 2024

AlexBlokh commented Jun 19, 2024

mdichtler commented Jun 19, 2024

AlexBlokh commented Jun 19, 2024

	(await revalidateTag(`${site.customDomain}-metadata`));
	revalidateTag(`${site.customDomain}-metadata`);

feat(drizzle): Migrate to Drizzle ORM #404

feat(drizzle): Migrate to Drizzle ORM #404

Conversation

realmikesolo commented May 8, 2024 • edited Loading

Instructions

If you directly start the project with Drizzle ORM

If you migrating from Prisma

vercel bot commented May 8, 2024

leerob 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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

m-torin commented May 9, 2024

leerob commented May 9, 2024

realmikesolo commented May 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

realmikesolo commented May 16, 2024

vercel bot commented Jun 4, 2024 • edited Loading

socket-security bot commented Jun 7, 2024

socket-security bot commented Jun 7, 2024

Next steps

leerob left a comment

Choose a reason for hiding this comment

mdichtler commented Jun 19, 2024

mdichtler commented Jun 19, 2024

AlexBlokh commented Jun 19, 2024

mdichtler commented Jun 19, 2024

AlexBlokh commented Jun 19, 2024

realmikesolo commented May 8, 2024 •

edited

Loading

realmikesolo commented May 11, 2024 •

edited

Loading

vercel bot commented Jun 4, 2024 •

edited

Loading