Global feature flags via environment variables

core/.env.test

@@ -19,4 +19,3 @@ HONEYCOMB_API_KEY="xxx"
 # KYSELY_DEBUG="true"
 
 GCLOUD_KEY_FILE='xxx'
-

core/actions/_lib/runActionInstance.ts

@@ -16,7 +16,7 @@ import { logger } from "logger";
 import type { ActionSuccess } from "../types";
 import type { ClientException, ClientExceptionOptions } from "~/lib/serverActions";
 import { db } from "~/kysely/database";
-import { env } from "~/lib/env/env.mjs";
+import { flags } from "~/lib/env/env";
 import { hydratePubValues } from "~/lib/fields/utils";
 import { createLastModifiedBy } from "~/lib/lastModifiedBy";
 import { getPubsWithRelatedValues } from "~/lib/server";
@@ -237,7 +237,7 @@ export async function runActionInstance(args: RunActionInstanceArgs, trx = db) {
 		};
 	}
 
-	if (env.DISABLED_ACTIONS?.includes(actionInstance.action)) {
+	if (flags.get("disabled-actions").includes(actionInstance.action)) {
 		return {
 			error: "Action is disabled",
 			stack: args.stack,

core/actions/datacite/run.ts

@@ -9,7 +9,7 @@ import { assert, AssertionError, expect } from "utils";
 import type { ActionPub } from "../types";
 import type { action } from "./action";
 import type { components } from "./types";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 import { getPubsWithRelatedValues, updatePub } from "~/lib/server";
 import { isClientExceptionOptions } from "~/lib/serverActions";
 import { defineRun } from "../types";

core/actions/googleDriveImport/getGDriveFiles.ts

@@ -7,7 +7,7 @@ import { JWT } from "google-auth-library";
 
 import { logger } from "logger";
 
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 
 // Load the service account key JSON file
 // const keyFilePath = path.join(process.cwd(), 'src/utils/google/keyFile.json');

core/app/(user)/magic-link/route.ts

@@ -7,7 +7,7 @@ import type { AuthTokenType } from "db/public";
 import { logger } from "logger";
 
 import { lucia } from "~/lib/authentication/lucia";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 import { InvalidTokenError, TokenFailureReason, validateToken } from "~/lib/server/token";
 
 const redirectToURL = (

core/app/api/v0/c/[communitySlug]/internal/[...ts-rest]/route.ts

@@ -8,7 +8,7 @@ import { runInstancesForEvent } from "~/actions/_lib/runActionInstance";
 import { scheduleActionInstances } from "~/actions/_lib/scheduleActionInstance";
 import { runActionInstance } from "~/actions/api/server";
 import { compareAPIKeys, getBearerToken } from "~/lib/authentication/api";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 import { NotFoundError, tsRestHandleErrors } from "~/lib/server";
 import { findCommunityBySlug } from "~/lib/server/community";
 
@@ -97,4 +97,4 @@ const handler = createNextHandler(
 	}
 );
 
-export { handler as GET, handler as POST, handler as PUT, handler as PATCH, handler as DELETE };
+export { handler as DELETE, handler as GET, handler as PATCH, handler as POST, handler as PUT };

core/app/c/[communitySlug]/developers/docs/page.tsx

@@ -8,7 +8,7 @@ import { redirect } from "next/navigation";
 
 import { getPageLoginData } from "~/lib/authentication/loginData";
 import { isCommunityAdmin } from "~/lib/authentication/roles";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 
 export const dynamic = "force-dynamic";
 

core/app/c/[communitySlug]/pubs/page.tsx

@@ -3,6 +3,7 @@ import type { Metadata } from "next";
 import type { CommunitiesId } from "db/public";
 
 import { getPageLoginData } from "~/lib/authentication/loginData";
+import { env } from "~/lib/env/env";
 import { findCommunityBySlug } from "~/lib/server/community";
 import PubHeader from "./PubHeader";
 import { PaginatedPubList } from "./PubList";

core/instrumentation.edge.mts

@@ -2,7 +2,7 @@ import * as Sentry from "@sentry/nextjs";
 
 import { logger } from "logger";
 
-import { env } from "./lib/env/env.mjs";
+import { env } from "./lib/env/env";
 
 logger.info("Running instrumentation hook for edge...");
 

core/instrumentation.node.mts

@@ -4,7 +4,7 @@ import * as Sentry from "@sentry/nextjs";
 
 import { logger } from "logger";
 
-import { env } from "./lib/env/env.mjs";
+import { env } from "./lib/env/env";
 
 // function hook() {
 logger.info("Running instrumentation hook for nodejs...");

core/kysely/database.ts

@@ -1,4 +1,4 @@
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 import { createDatabase } from "./database-init";
 
 export const db = createDatabase({

core/lib/__tests__/db.ts

@@ -8,7 +8,7 @@ import { databaseTables } from "db/table-names";
 import { logger } from "logger";
 
 import { UpdatedAtPlugin } from "~/kysely/updated-at-plugin";
-import { env } from "../env/env.mjs";
+import { env } from "../env/env";
 
 const int8TypeId = 20;
 

core/lib/api.ts

@@ -2,7 +2,7 @@ import { initTsrReactQuery } from "@ts-rest/react-query/v5";
 
 import { siteApi } from "contracts";
 
-import { env } from "./env/env.mjs";
+import { env } from "./env/env";
 
 export const client = initTsrReactQuery(siteApi, {
 	baseUrl: typeof window === "undefined" ? env.PUBPUB_URL : window.location.origin,

core/lib/authentication/createMagicLink.ts

@@ -1,7 +1,7 @@
 import type { AuthTokenType, UsersId } from "db/public";
 
 import { db } from "~/kysely/database";
-import { env } from "../env/env.mjs";
+import { env } from "../env/env";
 import { createToken } from "../server/token";
 
 type NativeMagicLinkOptions = {

core/lib/authentication/lucia.ts

@@ -17,7 +17,7 @@ import { AuthTokenType } from "db/public";
 import { logger } from "logger";
 
 import { db } from "~/kysely/database";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 
 type UserWithMembersShips = Omit<Users, "passwordHash"> & {
 	memberships: (CommunityMemberships & {

core/lib/env/env.mjs → core/lib/env/env.ts

@@ -1,16 +1,11 @@
-// @ts-check
+import type { ZodTypeAny } from "zod";
 
 import { createEnv } from "@t3-oss/env-nextjs";
 import { z } from "zod";
 
-/**
- * Parameters which are optional if the app is self-hosted
- * but we do want checked for our AWS deploys
- *
- * @template {import("zod").ZodTypeAny} Z
- * @param {Z} schema
- */
-const selfHostedOptional = (schema) => {
+import { createFlags, flagsSchema } from "./flags";
+
+const selfHostedOptional = (schema: ZodTypeAny) => {
 	return process.env.SELF_HOSTED ? schema.optional() : schema;
 };
 
@@ -52,25 +47,7 @@ export const env = createEnv({
 		DATACITE_REPOSITORY_ID: z.string().optional(),
 		DATACITE_PASSWORD: z.string().optional(),
 		SENTRY_AUTH_TOKEN: z.string().optional(),
-		DISABLED_ACTIONS: z
-			.string()
-			.transform((value) => value.split(","))
-			.pipe(
-				z
-					// TODO: Figure out how to get `import {actionSchema} from "db/public"` working
-					.enum([
-						"log",
-						"pdf",
-						"email",
-						"pushToV6",
-						"http",
-						"move",
-						"googleDriveImport",
-						"datacite",
-					])
-					.array()
-			)
-			.optional(),
+		FLAGS: flagsSchema,
 	},
 	client: {},
 	experimental__runtimeEnv: {
@@ -79,3 +56,5 @@ export const env = createEnv({
 	skipValidation: Boolean(process.env.SKIP_VALIDATION),
 	emptyStringAsUndefined: true,
 });
+
+export const flags = createFlags(env.FLAGS);

core/lib/env/flags.ts

@@ -0,0 +1,79 @@
+import { z, ZodError } from "zod";
+
+import { actionSchema } from "db/public";
+
+const flagStateToBoolean = (flagState: string, ctx: z.RefinementCtx) => {
+	switch (flagState) {
+		case "on":
+		case "true":
+			return true;
+		case "off":
+		case "false":
+			return false;
+	}
+	ctx.addIssue({
+		code: z.ZodIssueCode.custom,
+		message: "Invalid flag state",
+		fatal: true,
+	});
+	return z.NEVER;
+};
+
+const flagSchema = z.union([
+	z.tuple([
+		z.literal("disabled-actions"),
+		z
+			.string()
+			.optional()
+			.transform((s) => (s ? s.split("+").map((a) => a.trim()) : []))
+			.pipe(actionSchema.array()),
+	]),
+	z.tuple([
+		z.literal("invites"),
+		z.string().transform(flagStateToBoolean).optional().default("on"),
+	]),
+	z.tuple([
+		z.literal("uploads"),
+		z.string().transform(flagStateToBoolean).optional().default("on"),
+	]),
+]);
+
+export const flagsSchema = z
+	.string()
+	.optional()
+	.transform((s) => (s ? s.split(",") : []))
+	.transform((flagStrings, ctx) => {
+		const parsedFlags: FlagSchema[] = [];
+		for (const flagString of flagStrings) {
+			if (flagString === "") {
+				continue;
+			}
+			try {
+				const [flagName, flagArgs] = flagString.split(":");
+				const parsedFlag = flagSchema.parse([flagName, flagArgs]);
+				parsedFlags.push(parsedFlag);
+			} catch (error) {
+				if (error instanceof ZodError) {
+					error.issues.forEach(ctx.addIssue);
+				}
+			}
+		}
+		return parsedFlags;
+	});
+
+type FlagSchema = z.infer<typeof flagSchema>;
+type FlagName = FlagSchema[0];
+type FlagArgs<F extends FlagName> = Extract<FlagSchema, [F, unknown]>[1];
+
+class Flags {
+	#flags;
+	constructor(flags: FlagSchema[]) {
+		this.#flags = new Map(flags as [string, unknown][]);
+	}
+	get<F extends FlagName>(flagName: F): FlagArgs<F> {
+		return (this.#flags.get(flagName) ??
+			flagSchema.parse([flagName, undefined])[1]) as FlagArgs<F>;
+	}
+}
+
+export const createFlags = (flags: FlagSchema[]) => new Flags(flags);

core/lib/server/assets.db.test.ts

@@ -3,7 +3,7 @@ import fs from "fs/promises";
 import { beforeAll, describe, expect, it } from "vitest";
 
 import { mockServerCode } from "~/lib/__tests__/utils";
-import { env } from "../env/env.mjs";
+import { env } from "../env/env";
 
 const { createForEachMockedTransaction } = await mockServerCode();
 

core/lib/server/assets.ts

@@ -5,7 +5,7 @@ import { getSignedUrl } from "@aws-sdk/s3-request-presigner";
 import type { PubsId } from "db/public";
 import { logger } from "logger";
 
-import { env } from "../env/env.mjs";
+import { env } from "../env/env";
 
 let s3Client: S3Client;
 

core/lib/server/cache/autoRevalidate.ts

@@ -4,7 +4,7 @@ import { logger } from "logger";
 
 import type { autoCache } from "./autoCache";
 import type { AutoRevalidateOptions, DirectAutoOutput, ExecuteFn, QB } from "./types";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 import { getCommunitySlug } from "./getCommunitySlug";
 import { revalidateTagsForCommunity } from "./revalidate";
 import { cachedFindTables, directAutoOutput } from "./sharedAuto";

core/lib/server/cache/memoize.ts

@@ -6,7 +6,7 @@ import { unstable_cache } from "next/cache";
 import { logger } from "logger";
 
 import type { CacheTag } from "./cacheTags";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 import { ONE_YEAR } from "./constants";
 
 type Callback<Parameters extends unknown[], ReturnType> = (

core/lib/server/cache/revalidate.ts

@@ -3,7 +3,7 @@ import { revalidateTag } from "next/cache";
 import { logger } from "logger";
 
 import type { CacheScope } from "./cacheTags";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 import { createCommunityCacheTags } from "./cacheTags";
 import { getCommunitySlug } from "./getCommunitySlug";
 

core/lib/server/email.tsx

@@ -11,7 +11,7 @@ import type { XOR } from "../types";
 import type { FormInviteLinkProps } from "./form";
 import { db } from "~/kysely/database";
 import { createMagicLink } from "~/lib/authentication/createMagicLink";
-import { env } from "../env/env.mjs";
+import { env } from "../env/env";
 import { createFormInviteLink } from "./form";
 import { getSmtpClient } from "./mailgun";
 

core/lib/server/jobs.ts

@@ -5,7 +5,7 @@ import { makeWorkerUtils } from "graphile-worker";
 import { logger } from "logger";
 
 import type { ClientException, ClientExceptionOptions } from "../serverActions";
-import { env } from "../env/env.mjs";
+import { env } from "../env/env";
 
 import "date-fns";
 

core/lib/server/mailgun.ts

@@ -2,7 +2,7 @@ import type SMTPPool from "nodemailer/lib/smtp-pool";
 
 import nodemailer from "nodemailer";
 
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 
 let smtpclient: nodemailer.Transporter;
 

core/lib/server/pub.ts

@@ -37,14 +37,7 @@ import type {
 	UsersId,
 } from "db/public";
 import type { LastModifiedBy, StageConstraint } from "db/types";
-import {
-	Capabilities,
-	CoreSchemaType,
-	MemberRole,
-	MembershipType,
-	OperationType,
-	pubTypesIdSchema,
-} from "db/public";
+import { Capabilities, CoreSchemaType, MemberRole, MembershipType, OperationType } from "db/public";
 import { NO_STAGE_OPTION } from "db/types";
 import { logger } from "logger";
 import { assert, expect } from "utils";
@@ -53,7 +46,7 @@ import type { DefinitelyHas, MaybeHas, XOR } from "../types";
 import type { SafeUser } from "./user";
 import { db } from "~/kysely/database";
 import { isUniqueConstraintError } from "~/kysely/errors";
-import { env } from "../env/env.mjs";
+import { env } from "../env/env";
 import { parseRichTextForPubFieldsAndRelatedPubs } from "../fields/richText";
 import { hydratePubValues, mergeSlugsWithFields } from "../fields/utils";
 import { parseLastModifiedBy } from "../lastModifiedBy";

core/lib/server/render/pub/renderWithPubUtils.ts

@@ -3,7 +3,7 @@ import { CoreSchemaType } from "db/public";
 import { expect } from "utils";
 
 import { db } from "~/kysely/database";
-import { env } from "~/lib/env/env.mjs";
+import { env } from "~/lib/env/env";
 import { autoCache } from "~/lib/server/cache/autoCache";
 import { addMemberToForm, createFormInviteLink } from "../../form";