Add health e2e test for db

.env.example

@@ -0,0 +1,12 @@
+NODE_ENV=development
+
+# Development
+NEXT_PUBLIC_SITE_URL=http://localhost:3000
+
+# Database
+DB_USERNAME=yourusername
+DB_PASSWORD=yourpassword
+DB_HOST=cockroachdb_cluster
+DB_PORT=26257
+DB_NAME=panther_dev
+DB_URL=postgresql://${DB_USERNAME}:${DB_PASSWORD}@${DB_HOST}:${DB_PORT}/${DB_NAME}?sslmode=verify-full

package.json

@@ -20,7 +20,7 @@
   },
   "dependencies": {
     "@nextui-org/react": "^2.0.2",
-    "@prisma/client": "5.1.1",
+    "@prisma/client": "^5.1.1",
     "autoprefixer": "10.4.14",
     "classnames": "^2.3.2",
     "eslint": "8.46.0",

src/app/[locale]/health/page.tsx

@@ -0,0 +1,26 @@
+import getURL from '@/utils/getURL';
+
+async function getData(): Promise<{ status: string }> {
+  const res = await fetch(getURL('/api/health'));
+  // The return value is *not* serialized
+  // You can return Date, Map, Set, etc.
+
+  if (!res.ok) {
+    // This will activate the closest `error.js` Error Boundary
+    throw new Error('Failed to fetch data');
+  }
+
+  const data = await res.json();
+
+  return data as { status: string };
+}
+
+export default async function HealthPage(): Promise<JSX.Element> {
+  const data = await getData();
+  return (
+    <div className="flex min-h-screen flex-col items-center justify-between p-24 dark:bg-black dark:text-slate-50 transition-colors duration-150">
+      <h1>Health</h1>
+      <p data-testid="health-status">{data.status}</p>
+    </div>
+  );
+}

src/app/api/health/route.ts

@@ -0,0 +1,17 @@
+import { PrismaClient } from '@prisma/client';
+import { NextResponse } from 'next/server';
+
+const prisma = new PrismaClient();
+
+export async function GET(): Promise<NextResponse> {
+  try {
+    const userCount = await prisma.user.count();
+    if (userCount <= 0) {
+      throw new Error('No users found, seed failed');
+    }
+
+    return NextResponse.json({ status: 'healthy' });
+  } catch (error) {
+    return NextResponse.json({ status: 'error', error });
+  }
+}

src/utils/getURL.ts

@@ -0,0 +1,8 @@
+const IS_SERVER = typeof window === 'undefined';
+export default function getURL(path: string): string {
+  const baseURL = IS_SERVER
+    ? process.env.NEXT_PUBLIC_SITE_URL
+    : window.location.origin;
+
+  return new URL(path, baseURL).toString();
+}

tests/e2e/health.spec.ts

@@ -0,0 +1,8 @@
+import { test, expect } from '@playwright/test';
+
+test('should navigate to health page and be healthy', async ({ page }) => {
+  await page.goto('/health');
+  await expect(page).toHaveURL('/health');
+  const p = page.getByTestId('health-status');
+  await expect(p).toHaveText('healthy');
+});

yarn.lock

@@ -1571,7 +1571,7 @@
   optionalDependencies:
     fsevents "2.3.2"
 
-"@prisma/client@5.1.1":
+"@prisma/client@^5.1.1":
   version "5.1.1"
   resolved "https://registry.yarnpkg.com/@prisma/client/-/client-5.1.1.tgz#ea2b0c8599bdb3f86d92e8df46fba795a744db01"
   integrity sha512-fxcCeK5pMQGcgCqCrWsi+I2rpIbk0rAhdrN+ke7f34tIrgPwA68ensrpin+9+fZvuV2OtzHmuipwduSY6HswdA==