@techstream/quark-create-app 1.3.0 → 1.5.0

package/templates/base-project/apps/worker/src/index.js

@@ -5,129 +5,93 @@
  */
 
 import {
-	createEmailService,
 	createLogger,
+	createQueue,
 	createWorker,
 } from "@techstream/quark-core";
-import { JOB_NAMES, JOB_QUEUES } from "@techstream/quark-jobs";
 import { prisma } from "@techstream/quark-db";
+import { JOB_NAMES, JOB_QUEUES } from "@techstream/quark-jobs";
+import { jobHandlers } from "./handlers/index.js";
 
 const logger = createLogger("worker");
 
 // Store workers for graceful shutdown
 const workers = [];
 
-// Initialize email service
-const emailService = createEmailService();
-
 /**
- * Escape HTML entities to prevent XSS in email body
+ * Generic queue processor — dispatches jobs to registered handlers
+ * @param {string} queueName
  */
-function escapeHtml(str) {
-	return str
-		.replace(/&/g, "&")
-		.replace(/</g, "&lt;")
-		.replace(/>/g, "&gt;")
-		.replace(/"/g, "&quot;")
-		.replace(/'/g, "&#039;");
-}
-
-/**
- * Job handler for SEND_WELCOME_EMAIL
- * @param {Job} bullJob - BullMQ job object
- */
-async function handleSendWelcomeEmail(bullJob) {
-	const { userId } = bullJob.data;
+function createQueueWorker(queueName) {
+	const queueWorker = createWorker(
+		queueName,
+		async (bullJob) => {
+			const handler = jobHandlers[bullJob.name];
+
+			if (!handler) {
+				throw new Error(`No handler registered for job: ${bullJob.name}`);
+			}
+
+			return handler(bullJob, logger);
+		},
+		{
+			concurrency: parseInt(process.env.WORKER_CONCURRENCY || "5", 10),
+		},
+	);
 
-	if (!userId) {
-		throw new Error("userId is required for SEND_WELCOME_EMAIL job");
-	}
+	workers.push(queueWorker);
 
-	logger.info(`Sending welcome email for user ${userId}`, {
-		job: JOB_NAMES.SEND_WELCOME_EMAIL,
-		userId,
+	queueWorker.on("completed", (job, result) => {
+		logger.info(`Job ${job.id} (${job.name}) completed`, { result });
 	});
 
-	// Look up the user's email
-	const userRecord = await prisma.user.findUnique({
-		where: { id: userId },
-		select: { email: true, name: true },
+	queueWorker.on("failed", (job, error) => {
+		logger.error(
+			`Job ${job.id} (${job.name}) failed after ${job.attemptsMade} attempts`,
+			{
+				error: error.message,
+				jobName: job.name,
+				attemptsMade: job.attemptsMade,
+			},
+		);
 	});
 
-	if (!userRecord?.email) {
-		throw new Error(`User ${userId} not found or has no email`);
-	}
-
-	const displayName = userRecord.name || "there";
-	const safeDisplayName = escapeHtml(displayName);
-
-	await emailService.sendEmail(
-		userRecord.email,
-		"Welcome to Quark!",
-		`<h1>Welcome, ${safeDisplayName}!</h1>
-<p>Your account has been created successfully.</p>
-<p>You can now sign in and start using the application.</p>`,
-		`Welcome, ${displayName}!\n\nYour account has been created successfully.\nYou can now sign in and start using the application.`,
+	logger.info(
+		`Queue "${queueName}" worker started (concurrency: ${queueWorker.opts.concurrency})`,
 	);
 
-	return { success: true, userId, email: userRecord.email };
+	return queueWorker;
 }
 
-/**
- * Initialize job handlers
- * Maps job names to their handler functions
- */
-const jobHandlers = {
-	[JOB_NAMES.SEND_WELCOME_EMAIL]: handleSendWelcomeEmail,
-};
-
 /**
  * Start the worker service
- * Creates workers for all queues and registers handlers
  */
 async function startWorker() {
 	logger.info("Starting Quark Worker Service");
 
 	try {
-		// Create worker for email queue
-		const emailQueueWorker = createWorker(
-			JOB_QUEUES.EMAIL,
-			async (bullJob) => {
-				const handler = jobHandlers[bullJob.name];
-
-				if (!handler) {
-					throw new Error(`No handler registered for job: ${bullJob.name}`);
-				}
+		// Register a worker for each queue
+		for (const queueName of Object.values(JOB_QUEUES)) {
+			createQueueWorker(queueName);
+		}
 
-				return handler(bullJob);
-			},
+		// Schedule repeating cleanup job (runs every 24 hours)
+		const filesQueue = createQueue(JOB_QUEUES.FILES);
+		await filesQueue.add(
+			JOB_NAMES.CLEANUP_ORPHANED_FILES,
+			{ retentionHours: 24 },
 			{
-				concurrency: parseInt(process.env.WORKER_CONCURRENCY || "5", 10),
+				repeat: { every: 24 * 60 * 60 * 1000 }, // 24h
+				jobId: "cleanup-orphaned-files-repeat",
 			},
 		);
 
-		workers.push(emailQueueWorker);
-
-		emailQueueWorker.on("completed", (job, result) => {
-			logger.info(`Job ${job.id} (${job.name}) completed`, { result });
-		});
-
-		emailQueueWorker.on("failed", (job, error) => {
-			logger.error(`Job ${job.id} (${job.name}) failed after ${job.attemptsMade} attempts`, {
-				error: error.message,
-				jobName: job.name,
-				attemptsMade: job.attemptsMade,
-			});
-		});
-
-		logger.info(
-			`Email queue worker started (concurrency: ${emailQueueWorker.opts.concurrency})`,
-		);
-
-		// Ready to process jobs
 		logger.info("Worker service ready");
 	} catch (error) {
-		logger.error("Failed to start worker service", { error: error.message, stack: error.stack });
+		logger.error("Failed to start worker service", {
+			error: error.message,
+			stack: error.stack,
+		});
 		process.exit(1);
 	}
 }
@@ -139,22 +103,28 @@ async function shutdown() {
 	logger.info("Shutting down worker service");
 
 	try {
-		// Close all workers
 		for (const worker of workers) {
 			await worker.close();
 		}
 
-		// Disconnect Prisma client
 		await prisma.$disconnect();
 
 		logger.info("All workers closed");
 		process.exit(0);
 	} catch (error) {
-		logger.error("Error during shutdown", { error: error.message, stack: error.stack });
+		logger.error("Error during shutdown", {
+			error: error.message,
+			stack: error.stack,
+		});
 		process.exit(1);
 	}
 }
 
+process.on("SIGTERM", shutdown);
+process.on("SIGINT", shutdown);
+
+startWorker();
+
 // Register shutdown handlers
 process.on("SIGTERM", shutdown);
 process.on("SIGINT", shutdown);

package/templates/base-project/package.json

@@ -18,7 +18,13 @@
 	"license": "ISC",
 	"packageManager": "pnpm@10.12.1",
 	"pnpm": {
-		"onlyBuiltDependencies": ["@prisma/engines", "esbuild", "msgpackr-extract", "prisma", "sharp"],
+		"onlyBuiltDependencies": [
+			"@prisma/engines",
+			"esbuild",
+			"msgpackr-extract",
+			"prisma",
+			"sharp"
+		],
 		"peerDependencyRules": {
 			"allowedVersions": {
 				"nodemailer": "*"

package/templates/base-project/packages/db/scripts/seed.js

@@ -1,5 +1,5 @@
-import { PrismaClient } from "../src/generated/prisma/client.js";
 import bcrypt from "bcryptjs";
+import { PrismaClient } from "../src/generated/prisma/client.js";
 
 const prisma = new PrismaClient();
 

package/templates/base-project/packages/db/src/client.js

@@ -1,19 +1,23 @@
 import { PrismaPg } from "@prisma/adapter-pg";
 import { PrismaClient } from "./generated/prisma/client.ts";
 
-// Construct DATABASE_URL from individual env vars (mirrors prisma.config.ts)
-// POSTGRES_USER, POSTGRES_PASSWORD, and POSTGRES_DB are required — no silent fallbacks.
-const user = process.env.POSTGRES_USER;
-if (!user) throw new Error("POSTGRES_USER environment variable is required");
-const password = process.env.POSTGRES_PASSWORD;
-if (!password) throw new Error("POSTGRES_PASSWORD environment variable is required");
-const host = process.env.POSTGRES_HOST || "localhost";
-const port = process.env.POSTGRES_PORT || "5432";
-const db = process.env.POSTGRES_DB;
-if (!db) throw new Error("POSTGRES_DB environment variable is required");
-const connectionString = `postgresql://${user}:${password}@${host}:${port}/${db}?schema=public`;
-
-const isProduction = process.env.NODE_ENV === "production";
+/**
+ * Builds a Postgres connection string from individual env vars (mirrors prisma.config.ts).
+ * Throws if any required variable is missing — but only when actually called,
+ * so the module can be safely imported at build time (e.g. during `next build`).
+ */
+function getConnectionString() {
+	const user = process.env.POSTGRES_USER;
+	if (!user) throw new Error("POSTGRES_USER environment variable is required");
+	const password = process.env.POSTGRES_PASSWORD;
+	if (!password)
+		throw new Error("POSTGRES_PASSWORD environment variable is required");
+	const host = process.env.POSTGRES_HOST || "localhost";
+	const port = process.env.POSTGRES_PORT || "5432";
+	const db = process.env.POSTGRES_DB;
+	if (!db) throw new Error("POSTGRES_DB environment variable is required");
+	return `postgresql://${user}:${password}@${host}:${port}/${db}?schema=public`;
+}
 
 /**
  * Returns the connection pool configuration for the `pg` driver.
@@ -26,6 +30,7 @@ const isProduction = process.env.NODE_ENV === "production";
  * @returns {{ max: number, idleTimeoutMillis: number, connectionTimeoutMillis: number }}
  */
 export function getPoolConfig() {
+	const isProduction = process.env.NODE_ENV === "production";
 	return {
 		max: Number(process.env.DB_POOL_MAX) || (isProduction ? 10 : 5),
 		idleTimeoutMillis: Number(process.env.DB_POOL_IDLE_TIMEOUT) || 30_000,
@@ -34,19 +39,30 @@ export function getPoolConfig() {
 	};
 }
 
-// Create a singleton Prisma client with the PostgreSQL driver adapter and pool settings
+// Lazy singleton — the client is created on first property access, not at import time.
+// This allows Next.js to import the module at build time without requiring DB env vars.
 const globalForPrisma = globalThis;
-export const prisma =
-	globalForPrisma.prisma ||
-	new PrismaClient({
-		adapter: new PrismaPg({
-			connectionString,
-			...getPoolConfig(),
-		}),
-	});
 
-if (!isProduction) {
-	globalForPrisma.prisma = prisma;
+function getPrismaClient() {
+	if (!globalForPrisma.__prisma) {
+		globalForPrisma.__prisma = new PrismaClient({
+			adapter: new PrismaPg({
+				connectionString: getConnectionString(),
+				...getPoolConfig(),
+			}),
+		});
+	}
+	return globalForPrisma.__prisma;
 }
 
+/**
+ * Prisma client singleton. Lazily initialized on first use so the module
+ * can be imported safely at build time (no DB env vars needed).
+ */
+export const prisma = new Proxy(/** @type {PrismaClient} */ ({}), {
+	get(_target, prop) {
+		return getPrismaClient()[prop];
+	},
+});
+
 export * from "./generated/prisma/client.ts";

package/templates/base-project/turbo.json

@@ -20,7 +20,32 @@
 		"dev": {
 			"cache": false,
 			"persistent": true,
-			"passThroughEnv": ["PORT", "POSTGRES_HOST", "POSTGRES_PORT", "POSTGRES_USER", "POSTGRES_PASSWORD", "POSTGRES_DB", "REDIS_HOST", "REDIS_PORT", "MAILHOG_HOST", "MAILHOG_SMTP_PORT", "MAILHOG_UI_PORT", "NEXTAUTH_SECRET", "APP_URL", "WORKER_CONCURRENCY"]
+			"passThroughEnv": [
+				"PORT",
+				"POSTGRES_HOST",
+				"POSTGRES_PORT",
+				"POSTGRES_USER",
+				"POSTGRES_PASSWORD",
+				"POSTGRES_DB",
+				"REDIS_HOST",
+				"REDIS_PORT",
+				"MAILHOG_HOST",
+				"MAILHOG_SMTP_PORT",
+				"MAILHOG_UI_PORT",
+				"NEXTAUTH_SECRET",
+				"APP_URL",
+				"WORKER_CONCURRENCY",
+				"STORAGE_PROVIDER",
+				"STORAGE_LOCAL_DIR",
+				"S3_BUCKET",
+				"S3_REGION",
+				"S3_ENDPOINT",
+				"S3_ACCESS_KEY_ID",
+				"S3_SECRET_ACCESS_KEY",
+				"S3_PUBLIC_URL",
+				"UPLOAD_MAX_SIZE",
+				"UPLOAD_ALLOWED_TYPES"
+			]
 		}
 	}
 }

package/templates/jobs/src/definitions.js

@@ -1,9 +1,10 @@
 export const JOB_QUEUES = {
 	EMAIL: "email-queue",
-	NOTIFICATIONS: "notifications-queue",
+	FILES: "files-queue",
 };
 
 export const JOB_NAMES = {
 	SEND_WELCOME_EMAIL: "send-welcome-email",
 	SEND_RESET_PASSWORD_EMAIL: "send-reset-password-email",
+	CLEANUP_ORPHANED_FILES: "cleanup-orphaned-files",
 };

package/templates/jobs/src/index.js

@@ -1,2 +1 @@
 export { JOB_NAMES, JOB_QUEUES } from "./definitions.js";
-export { jobHandlers } from "./handlers.js";

package/templates/base-project/packages/db/src/generated/prisma/browser.ts

@@ -1,53 +0,0 @@
-/* !!! This is code generated by Prisma. Do not edit directly. !!! */
-/* eslint-disable */
-// biome-ignore-all lint: generated file
-// @ts-nocheck
-/*
- * This file should be your main import to use Prisma-related types and utilities in a browser.
- * Use it to get access to models, enums, and input types.
- *
- * This file does not contain a `PrismaClient` class, nor several other helpers that are intended as server-side only.
- * See `client.ts` for the standard, server-side entry point.
- *
- * 🟢 You can import this file directly.
- */
-
-import * as Prisma from "./internal/prismaNamespaceBrowser.ts";
-export { Prisma };
-export * as $Enums from "./enums.ts";
-export * from "./enums.ts";
-/**
- * Model User
- *
- */
-export type User = Prisma.UserModel;
-/**
- * Model Post
- *
- */
-export type Post = Prisma.PostModel;
-/**
- * Model Account
- *
- */
-export type Account = Prisma.AccountModel;
-/**
- * Model Session
- *
- */
-export type Session = Prisma.SessionModel;
-/**
- * Model VerificationToken
- *
- */
-export type VerificationToken = Prisma.VerificationTokenModel;
-/**
- * Model Job
- *
- */
-export type Job = Prisma.JobModel;
-/**
- * Model AuditLog
- *
- */
-export type AuditLog = Prisma.AuditLogModel;

package/templates/base-project/packages/db/src/generated/prisma/client.ts

@@ -1,82 +0,0 @@
-/* !!! This is code generated by Prisma. Do not edit directly. !!! */
-/* eslint-disable */
-// biome-ignore-all lint: generated file
-// @ts-nocheck
-/*
- * This file should be your main import to use Prisma. Through it you get access to all the models, enums, and input types.
- * If you're looking for something you can import in the client-side of your application, please refer to the `browser.ts` file instead.
- *
- * 🟢 You can import this file directly.
- */
-
-import * as path from "node:path";
-import * as process from "node:process";
-import { fileURLToPath } from "node:url";
-
-globalThis["__dirname"] = path.dirname(fileURLToPath(import.meta.url));
-
-import * as runtime from "@prisma/client/runtime/client";
-import * as $Enums from "./enums.ts";
-import * as $Class from "./internal/class.ts";
-import * as Prisma from "./internal/prismaNamespace.ts";
-
-export * as $Enums from "./enums.ts";
-export * from "./enums.ts";
-/**
- * ## Prisma Client
- *
- * Type-safe database client for TypeScript
- * @example
- * ```
- * const prisma = new PrismaClient()
- * // Fetch zero or more Users
- * const users = await prisma.user.findMany()
- * ```
- *
- * Read more in our [docs](https://www.prisma.io/docs/reference/tools-and-interfaces/prisma-client).
- */
-export const PrismaClient = $Class.getPrismaClientClass();
-export type PrismaClient<
-	LogOpts extends Prisma.LogLevel = never,
-	OmitOpts extends
-		Prisma.PrismaClientOptions["omit"] = Prisma.PrismaClientOptions["omit"],
-	ExtArgs extends
-		runtime.Types.Extensions.InternalArgs = runtime.Types.Extensions.DefaultArgs,
-> = $Class.PrismaClient<LogOpts, OmitOpts, ExtArgs>;
-export { Prisma };
-
-/**
- * Model User
- *
- */
-export type User = Prisma.UserModel;
-/**
- * Model Post
- *
- */
-export type Post = Prisma.PostModel;
-/**
- * Model Account
- *
- */
-export type Account = Prisma.AccountModel;
-/**
- * Model Session
- *
- */
-export type Session = Prisma.SessionModel;
-/**
- * Model VerificationToken
- *
- */
-export type VerificationToken = Prisma.VerificationTokenModel;
-/**
- * Model Job
- *
- */
-export type Job = Prisma.JobModel;
-/**
- * Model AuditLog
- *
- */
-export type AuditLog = Prisma.AuditLogModel;