FE-1569: Add durable Brunch storage and telemetry #9487
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| /** | ||
| * The deployed conversation-store contract. | ||
| * | ||
| * Production accepts only dedicated Postgres fields. Local development and | ||
| * hermetic tests keep the existing SQLite path, but production can never | ||
| * silently select it. | ||
| */ | ||
|
|
||
| export const POSTGRES_ENV = { | ||
| authMode: "BRUNCH_POSTGRES_AUTH_MODE", | ||
| awsRegion: "BRUNCH_POSTGRES_AWS_REGION", | ||
| database: "BRUNCH_POSTGRES_DATABASE", | ||
| host: "BRUNCH_POSTGRES_HOST", | ||
| password: "BRUNCH_POSTGRES_PASSWORD", | ||
| port: "BRUNCH_POSTGRES_PORT", | ||
| tlsCaPath: "BRUNCH_POSTGRES_TLS_CA_PATH", | ||
|
Member
There was a problem hiding this comment. This should not be a required environment. It should be possible to connect to Postgres without |
||
| user: "BRUNCH_POSTGRES_USER", | ||
| } as const; | ||
|
|
||
| export interface SqliteDatabaseConfig { | ||
| readonly kind: "sqlite"; | ||
| } | ||
|
|
||
| export interface PostgresDatabaseConfig { | ||
| readonly kind: "postgres"; | ||
| readonly auth: | ||
| | { | ||
| readonly mode: "iam"; | ||
| readonly region: string; | ||
| } | ||
| | { | ||
| readonly mode: "password"; | ||
| readonly password: string; | ||
| }; | ||
| readonly database: string; | ||
| readonly host: string; | ||
| readonly port: number; | ||
| readonly tlsCaPath: string; | ||
| readonly user: string; | ||
| } | ||
|
|
||
| export type DatabaseConfig = SqliteDatabaseConfig | PostgresDatabaseConfig; | ||
|
|
||
| type Environment = Readonly<Record<string, string | undefined>>; | ||
|
|
||
| const valueOf = (environment: Environment, name: string): string => { | ||
| const value = environment[name]?.trim(); | ||
| if (value === undefined || value.length === 0) { | ||
| throw new Error(`Production database configuration requires ${name}.`); | ||
| } | ||
| return value; | ||
| }; | ||
|
cursor[bot] marked this conversation as resolved.
|
||
|
|
||
| const absent = (environment: Environment, name: string): void => { | ||
| if (environment[name] !== undefined) { | ||
| throw new Error( | ||
| `Production database configuration does not accept ${name}.`, | ||
| ); | ||
| } | ||
| }; | ||
|
Comment on lines
+54
to
+60
Member
There was a problem hiding this comment. Error on an env-var being set is a weird behavior, it should at most warn. |
||
|
|
||
| const portOf = (environment: Environment): number => { | ||
| const name = POSTGRES_ENV.port; | ||
| const source = valueOf(environment, name); | ||
| if (!/^\d+$/u.test(source)) { | ||
| throw new Error(`${name} must be an integer between 1 and 65535.`); | ||
| } | ||
| const port = Number(source); | ||
| if (!Number.isSafeInteger(port) || port < 1 || port > 65_535) { | ||
| throw new Error(`${name} must be an integer between 1 and 65535.`); | ||
| } | ||
| return port; | ||
| }; | ||
|
|
||
| const rejectLegacyProductionInputs = (environment: Environment): void => { | ||
| absent(environment, "DATABASE_URL"); | ||
| absent(environment, "BRUNCH_DEV_DB_PATH"); | ||
| absent(environment, "BRUNCH_CHAT_DB_PATH"); | ||
| }; | ||
|
|
||
| export function loadDatabaseConfig( | ||
| environment: Environment = process.env, | ||
| ): DatabaseConfig { | ||
| if (environment.NODE_ENV !== "production") { | ||
| return { kind: "sqlite" }; | ||
| } | ||
|
Comment on lines
+84
to
+86
Member
There was a problem hiding this comment. Why we cannot use Postgres in non-production builds? |
||
|
|
||
| rejectLegacyProductionInputs(environment); | ||
|
|
||
| const authMode = valueOf(environment, POSTGRES_ENV.authMode); | ||
| const common = { | ||
| kind: "postgres" as const, | ||
| database: valueOf(environment, POSTGRES_ENV.database), | ||
| host: valueOf(environment, POSTGRES_ENV.host), | ||
| port: portOf(environment), | ||
| tlsCaPath: valueOf(environment, POSTGRES_ENV.tlsCaPath), | ||
| user: valueOf(environment, POSTGRES_ENV.user), | ||
| }; | ||
|
|
||
| if (authMode === "iam") { | ||
| absent(environment, POSTGRES_ENV.password); | ||
| return { | ||
| ...common, | ||
| auth: { | ||
| mode: "iam", | ||
| region: valueOf(environment, POSTGRES_ENV.awsRegion), | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| if (authMode === "password") { | ||
| absent(environment, POSTGRES_ENV.awsRegion); | ||
| return { | ||
| ...common, | ||
| auth: { | ||
| mode: "password", | ||
| password: valueOf(environment, POSTGRES_ENV.password), | ||
| }, | ||
| }; | ||
| } | ||
|
|
||
| throw new Error( | ||
| `${POSTGRES_ENV.authMode} must be either "iam" or "password".`, | ||
| ); | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,35 @@ | ||
| import { postgres } from "@flue/postgres"; | ||
|
|
||
| import { loadDatabaseConfig } from "./database-config.ts"; | ||
| import { conversationDbPath } from "./db-path.ts"; | ||
| import { createPostgresRunner } from "./postgres.ts"; | ||
| import { shutdownBrunchTelemetry } from "./telemetry-bootstrap.ts"; | ||
| import { recordOperationalFailure } from "./telemetry.ts"; | ||
|
|
||
| import type { DatabaseConfig } from "./database-config.ts"; | ||
|
|
||
| /** | ||
| * The substrate's conversation storage — host-authored because Flue requires | ||
| * it of the consuming app. | ||
| * | ||
| * Local development and hermetic tests retain SQLite. Production must provide | ||
| * the dedicated Postgres contract and cannot fall back to a task-local file. | ||
| */ | ||
| let config: DatabaseConfig; | ||
| try { | ||
| config = loadDatabaseConfig(); | ||
| } catch (error) { | ||
| try { | ||
| await recordOperationalFailure("database_configuration", error); | ||
| } catch { | ||
| // The database configuration error remains the authoritative startup cause. | ||
| } | ||
| throw error; | ||
| } | ||
|
Comment on lines
+19
to
+28
Member
There was a problem hiding this comment. Shouldn't reading the CA file and pool-functions be wrapped as well? |
||
|
|
||
| const database = | ||
| config.kind === "postgres" | ||
| ? postgres(createPostgresRunner(config, shutdownBrunchTelemetry)) | ||
| : (await import("@flue/runtime/node")).sqlite(conversationDbPath()); | ||
|
|
||
| export default database; | ||
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.