mirror of
https://github.com/shishantbiswas/bknd.git
synced 2026-03-16 12:37:20 +00:00
feat: introduce new modes helpers
This commit is contained in:
dswbx
49
app/src/modes/code.ts
Normal file
49
app/src/modes/code.ts
Normal file
@@ -0,0 +1,49 @@
|
||||
import type { BkndConfig } from "bknd/adapter";
|
||||
import { makeModeConfig, type BkndModeConfig } from "./shared";
|
||||
import { $console } from "bknd/utils";
|
||||
|
||||
export type BkndCodeModeConfig<Args = any> = BkndModeConfig<Args>;
|
||||
|
||||
export type CodeMode<AdapterConfig extends BkndConfig> = AdapterConfig extends BkndConfig<
|
||||
infer Args
|
||||
>
|
||||
? BkndModeConfig<Args, AdapterConfig>
|
||||
: never;
|
||||
|
||||
export function code<Args>(config: BkndCodeModeConfig<Args>): BkndConfig<Args> {
|
||||
return {
|
||||
...config,
|
||||
app: async (args) => {
|
||||
const {
|
||||
config: appConfig,
|
||||
plugins,
|
||||
isProd,
|
||||
syncSchemaOptions,
|
||||
} = await makeModeConfig(config, args);
|
||||
|
||||
if (appConfig?.options?.mode && appConfig?.options?.mode !== "code") {
|
||||
$console.warn("You should not set a different mode than `db` when using code mode");
|
||||
}
|
||||
|
||||
return {
|
||||
...appConfig,
|
||||
options: {
|
||||
...appConfig?.options,
|
||||
mode: "code",
|
||||
plugins,
|
||||
manager: {
|
||||
// skip validation in prod for a speed boost
|
||||
skipValidation: isProd,
|
||||
onModulesBuilt: async (ctx) => {
|
||||
if (!isProd && syncSchemaOptions.force) {
|
||||
$console.log("[code] syncing schema");
|
||||
await ctx.em.schema().sync(syncSchemaOptions);
|
||||
}
|
||||
},
|
||||
...appConfig?.options?.manager,
|
||||
},
|
||||
},
|
||||
};
|
||||
},
|
||||
};
|
||||
}
|
||||
88
app/src/modes/hybrid.ts
Normal file
88
app/src/modes/hybrid.ts
Normal file
@@ -0,0 +1,88 @@
|
||||
import type { BkndConfig } from "bknd/adapter";
|
||||
import { makeModeConfig, type BkndModeConfig } from "./shared";
|
||||
import { getDefaultConfig, type MaybePromise, type ModuleConfigs, type Merge } from "bknd";
|
||||
import type { DbModuleManager } from "modules/db/DbModuleManager";
|
||||
import { invariant, $console } from "bknd/utils";
|
||||
|
||||
export type BkndHybridModeOptions = {
|
||||
/**
|
||||
* Reader function to read the configuration from the file system.
|
||||
* This is required for hybrid mode to work.
|
||||
*/
|
||||
reader?: (path: string) => MaybePromise<string>;
|
||||
/**
|
||||
* Provided secrets to be merged into the configuration
|
||||
*/
|
||||
secrets?: Record<string, any>;
|
||||
};
|
||||
|
||||
export type HybridBkndConfig<Args = any> = BkndModeConfig<Args, BkndHybridModeOptions>;
|
||||
export type HybridMode<AdapterConfig extends BkndConfig> = AdapterConfig extends BkndConfig<
|
||||
infer Args
|
||||
>
|
||||
? BkndModeConfig<Args, Merge<BkndHybridModeOptions & AdapterConfig>>
|
||||
: never;
|
||||
|
||||
export function hybrid<Args>({
|
||||
configFilePath = "bknd-config.json",
|
||||
...rest
|
||||
}: HybridBkndConfig<Args>): BkndConfig<Args> {
|
||||
return {
|
||||
...rest,
|
||||
config: undefined,
|
||||
app: async (args) => {
|
||||
const {
|
||||
config: appConfig,
|
||||
isProd,
|
||||
plugins,
|
||||
syncSchemaOptions,
|
||||
} = await makeModeConfig(
|
||||
{
|
||||
...rest,
|
||||
configFilePath,
|
||||
},
|
||||
args,
|
||||
);
|
||||
|
||||
if (appConfig?.options?.mode && appConfig?.options?.mode !== "db") {
|
||||
$console.warn("You should not set a different mode than `db` when using hybrid mode");
|
||||
}
|
||||
invariant(
|
||||
typeof appConfig.reader === "function",
|
||||
"You must set the `reader` option when using hybrid mode",
|
||||
);
|
||||
|
||||
let fileConfig: ModuleConfigs;
|
||||
try {
|
||||
fileConfig = JSON.parse(await appConfig.reader!(configFilePath)) as ModuleConfigs;
|
||||
} catch (e) {
|
||||
const defaultConfig = (appConfig.config ?? getDefaultConfig()) as ModuleConfigs;
|
||||
await appConfig.writer!(configFilePath, JSON.stringify(defaultConfig, null, 2));
|
||||
fileConfig = defaultConfig;
|
||||
}
|
||||
|
||||
return {
|
||||
...(appConfig as any),
|
||||
beforeBuild: async (app) => {
|
||||
if (app && !isProd) {
|
||||
const mm = app.modules as DbModuleManager;
|
||||
mm.buildSyncConfig = syncSchemaOptions;
|
||||
}
|
||||
},
|
||||
config: fileConfig,
|
||||
options: {
|
||||
...appConfig?.options,
|
||||
mode: isProd ? "code" : "db",
|
||||
plugins,
|
||||
manager: {
|
||||
// skip validation in prod for a speed boost
|
||||
skipValidation: isProd,
|
||||
// secrets are required for hybrid mode
|
||||
secrets: appConfig.secrets,
|
||||
...appConfig?.options?.manager,
|
||||
},
|
||||
},
|
||||
};
|
||||
},
|
||||
};
|
||||
}
|
||||
3
app/src/modes/index.ts
Normal file
3
app/src/modes/index.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
export * from "./code";
|
||||
export * from "./hybrid";
|
||||
export * from "./shared";
|
||||
183
app/src/modes/shared.ts
Normal file
183
app/src/modes/shared.ts
Normal file
@@ -0,0 +1,183 @@
|
||||
import type { AppPlugin, BkndConfig, MaybePromise, Merge } from "bknd";
|
||||
import { syncTypes, syncConfig } from "bknd/plugins";
|
||||
import { syncSecrets } from "plugins/dev/sync-secrets.plugin";
|
||||
import { invariant, $console } from "bknd/utils";
|
||||
|
||||
export type BkndModeOptions = {
|
||||
/**
|
||||
* Whether the application is running in production.
|
||||
*/
|
||||
isProduction?: boolean;
|
||||
/**
|
||||
* Writer function to write the configuration to the file system
|
||||
*/
|
||||
writer?: (path: string, content: string) => MaybePromise<void>;
|
||||
/**
|
||||
* Configuration file path
|
||||
*/
|
||||
configFilePath?: string;
|
||||
/**
|
||||
* Types file path
|
||||
* @default "bknd-types.d.ts"
|
||||
*/
|
||||
typesFilePath?: string;
|
||||
/**
|
||||
* Syncing secrets options
|
||||
*/
|
||||
syncSecrets?: {
|
||||
/**
|
||||
* Whether to enable syncing secrets
|
||||
*/
|
||||
enabled?: boolean;
|
||||
/**
|
||||
* Output file path
|
||||
*/
|
||||
outFile?: string;
|
||||
/**
|
||||
* Format of the output file
|
||||
* @default "env"
|
||||
*/
|
||||
format?: "json" | "env";
|
||||
/**
|
||||
* Whether to include secrets in the output file
|
||||
* @default false
|
||||
*/
|
||||
includeSecrets?: boolean;
|
||||
};
|
||||
/**
|
||||
* Determines whether to automatically sync the schema if not in production.
|
||||
* @default true
|
||||
*/
|
||||
syncSchema?: boolean | { force?: boolean; drop?: boolean };
|
||||
};
|
||||
|
||||
export type BkndModeConfig<Args = any, Additional = {}> = BkndConfig<
|
||||
Args,
|
||||
Merge<BkndModeOptions & Additional>
|
||||
>;
|
||||
|
||||
export async function makeModeConfig<
|
||||
Args = any,
|
||||
Config extends BkndModeConfig<Args> = BkndModeConfig<Args>,
|
||||
>(_config: Config, args: Args) {
|
||||
const appConfig = typeof _config.app === "function" ? await _config.app(args) : _config.app;
|
||||
|
||||
const config = {
|
||||
..._config,
|
||||
...appConfig,
|
||||
} as Omit<Config, "app">;
|
||||
|
||||
if (typeof config.isProduction !== "boolean") {
|
||||
$console.warn(
|
||||
"You should set `isProduction` option when using managed modes to prevent accidental issues",
|
||||
);
|
||||
}
|
||||
|
||||
invariant(
|
||||
typeof config.writer === "function",
|
||||
"You must set the `writer` option when using managed modes",
|
||||
);
|
||||
|
||||
const { typesFilePath, configFilePath, writer, syncSecrets: syncSecretsOptions } = config;
|
||||
|
||||
const isProd = config.isProduction;
|
||||
const plugins = appConfig?.options?.plugins ?? ([] as AppPlugin[]);
|
||||
const syncSchemaOptions =
|
||||
typeof config.syncSchema === "object"
|
||||
? config.syncSchema
|
||||
: {
|
||||
force: config.syncSchema !== false,
|
||||
drop: true,
|
||||
};
|
||||
|
||||
if (!isProd) {
|
||||
if (typesFilePath) {
|
||||
if (plugins.some((p) => p.name === "bknd-sync-types")) {
|
||||
throw new Error("You have to unregister the `syncTypes` plugin");
|
||||
}
|
||||
plugins.push(
|
||||
syncTypes({
|
||||
enabled: true,
|
||||
includeFirstBoot: true,
|
||||
write: async (et) => {
|
||||
try {
|
||||
await config.writer?.(typesFilePath, et.toString());
|
||||
} catch (e) {
|
||||
console.error(`Error writing types to"${typesFilePath}"`, e);
|
||||
}
|
||||
},
|
||||
}) as any,
|
||||
);
|
||||
}
|
||||
|
||||
if (configFilePath) {
|
||||
if (plugins.some((p) => p.name === "bknd-sync-config")) {
|
||||
throw new Error("You have to unregister the `syncConfig` plugin");
|
||||
}
|
||||
plugins.push(
|
||||
syncConfig({
|
||||
enabled: true,
|
||||
includeFirstBoot: true,
|
||||
write: async (config) => {
|
||||
try {
|
||||
await writer?.(configFilePath, JSON.stringify(config, null, 2));
|
||||
} catch (e) {
|
||||
console.error(`Error writing config to "${configFilePath}"`, e);
|
||||
}
|
||||
},
|
||||
}) as any,
|
||||
);
|
||||
}
|
||||
|
||||
if (syncSecretsOptions?.enabled) {
|
||||
if (plugins.some((p) => p.name === "bknd-sync-secrets")) {
|
||||
throw new Error("You have to unregister the `syncSecrets` plugin");
|
||||
}
|
||||
|
||||
let outFile = syncSecretsOptions.outFile;
|
||||
const format = syncSecretsOptions.format ?? "env";
|
||||
if (!outFile) {
|
||||
outFile = ["env", !syncSecretsOptions.includeSecrets && "example", format]
|
||||
.filter(Boolean)
|
||||
.join(".");
|
||||
}
|
||||
|
||||
plugins.push(
|
||||
syncSecrets({
|
||||
enabled: true,
|
||||
includeFirstBoot: true,
|
||||
write: async (secrets) => {
|
||||
const values = Object.fromEntries(
|
||||
Object.entries(secrets).map(([key, value]) => [
|
||||
key,
|
||||
syncSecretsOptions.includeSecrets ? value : "",
|
||||
]),
|
||||
);
|
||||
|
||||
try {
|
||||
if (format === "env") {
|
||||
await writer?.(
|
||||
outFile,
|
||||
Object.entries(values)
|
||||
.map(([key, value]) => `${key}=${value}`)
|
||||
.join("\n"),
|
||||
);
|
||||
} else {
|
||||
await writer?.(outFile, JSON.stringify(values, null, 2));
|
||||
}
|
||||
} catch (e) {
|
||||
console.error(`Error writing secrets to "${outFile}"`, e);
|
||||
}
|
||||
},
|
||||
}) as any,
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
return {
|
||||
config,
|
||||
isProd,
|
||||
plugins,
|
||||
syncSchemaOptions,
|
||||
};
|
||||
}
|
||||
Reference in New Issue
Block a user