Groundwork for Postgres and MySQL backends (#1134)

* groundwork for postgres and mysql backends

#1127 made the repository layer dialect-agnostic. This adds the pieces needed
to actually target a second engine, as a foundation only — nothing is wired up
and sqlite remains the sole runtime path.

- DatabaseDialect covers sqlite, postgres and mysql, resolved from
  DATABASE_DIALECT and defaulting to sqlite so nothing changes for existing
  deployments or the desktop build
- a column kit holding the per-dialect type choices in one file: booleans are
  integers on sqlite and native elsewhere, autoincrement differs three ways, and
  MySQL cannot index unbounded TEXT so key columns need varchar
- settings and users declared for all three dialects as a proof slice, chosen
  because between them they use every construct the real schema does
- pg and mysql2 added as dependencies

The tests build real queries for all three engines without a server, asserting
identifier quoting, placeholder style and boolean storage, so the property the
repositories depend on is verified rather than assumed.

* verify foreign keys and unique constraints port across dialects

The first slice only covered plain columns. The real schema also has 92 foreign
keys (80 cascade, 12 set null) and 14 unique columns, so the approach is only
viable if those survive the port.

Adds audit_logs and ssh_folders to the proof slice: one nullable reference with
ON DELETE SET NULL, one required reference with ON DELETE CASCADE, a unique
column, and an autoincrement surrogate key — which is spelled three different
ways underneath (integer primary key autoincrement, serial, int auto_increment).

All of it holds. Worth noting for whoever picks this up: getTableConfig is
dialect-specific and silently fails on a table from another dialect, so the test
uses each engine's own.

* generate the postgres and mysql schemas instead of hand-writing them

The proof slice showed the constructs port, but left the maintenance question
open. Three hand-written copies of 52 tables is the wrong answer: with foreign
keys the copies cross-reference each other, so a renamed table has to land in
three places consistently or a key silently points at the wrong one.

The mapping is mechanical, so a script does it. schema.ts stays the single
source of truth and schema.pg.ts / schema.mysql.ts are derived, covering all 52
tables — the column kit and the two-table portable slice are gone, since the
generator now holds those decisions.

The transforms are the ones the kit enumerated: integer-backed booleans become
native, autoincrement keys become serial or int auto_increment, real becomes
double precision or double, and any column that is a primary key, is unique, or
sits on either end of a foreign key becomes varchar because MySQL cannot index
unbounded TEXT.

> termix@2.6.0 lint
> node scripts/generate-dialect-schema.cjs --check && eslint .

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/database/routes/homepage-favicon-routes.ts
  99:12  warning  'err' is defined but never used  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/database/routes/homepage-ping-routes.ts
  123:12  warning  'err' is defined but never used  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/database/routes/homepage-rss-routes.ts
  144:12  warning  'err' is defined but never used  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/database/routes/session-log-routes.ts
  46:16  warning  'canAccessRecording' is defined but never used. Allowed unused vars must match /^_/u  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/hosts/vault-signer-core.ts
  55:12  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
  75:13  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/tests/hosts/auth-manager.test.ts
  18:73  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/tests/utils/shared-host-secrets-manager.test.ts
  7:6  warning  'SecretRow' is defined but never used. Allowed unused vars must match /^_/u  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/utils/auth-manager.ts
  510:13  warning  'affectedUsers' is assigned a value but never used. Allowed unused vars must match /^_/u  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/utils/notification-sender.ts
  48:12  warning  'firstErr' is defined but never used  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/api/ssh-file-operations-api.ts
  35:10  warning  'buildFileManagerUrl' is defined but never used. Allowed unused vars must match /^_/u  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/components/folder-style.tsx
   61:14  warning  Fast refresh only works when a file only exports components. Use a new file to share constants or functions between components  react-refresh/only-export-components
  116:14  warning  Fast refresh only works when a file only exports components. Use a new file to share constants or functions between components  react-refresh/only-export-components
  121:14  warning  Fast refresh only works when a file only exports components. Use a new file to share constants or functions between components  react-refresh/only-export-components
  149:17  warning  Fast refresh only works when a file only exports components. Use a new file to share constants or functions between components  react-refresh/only-export-components

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/components/proxmox/ProxmoxDiscoverDialog.tsx
  109:19  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any
  190:19  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/HomepageCanvas.tsx
  345:15  warning  Empty block statement  no-empty
  388:15  warning  Empty block statement  no-empty
  415:15  warning  Empty block statement  no-empty

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/dialogs/SingleHostEditForm.tsx
  24:6  warning  React Hook useEffect has a missing dependency: 'filter'. Either include it or remove the dependency array. If 'setHosts' needs the current value of 'filter', you can also switch to useReducer instead of useState and read 'filter' in the reducer  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/AlertFeedWidget.tsx
  93:6  warning  React Hook useEffect has a missing dependency: 'fetchData'. Either include it or remove the dependency array  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/CustomApiWidget.tsx
  77:6  warning  React Hook useEffect has a missing dependency: 'fetchData'. Either include it or remove the dependency array  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/DockerActivityWidget.tsx
  50:6  warning  React Hook useEffect has a missing dependency: 'fetchData'. Either include it or remove the dependency array  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/DockerWidget.tsx
  16:10  warning  Fast refresh only works when a file has exports. Move your component(s) to a separate file  react-refresh/only-export-components

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/FileManagerWidget.tsx
  16:10  warning  Fast refresh only works when a file has exports. Move your component(s) to a separate file  react-refresh/only-export-components

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/HostGridWidget.tsx
  61:6  warning  React Hook useCallback has a missing dependency: 'hostIds'. Either include it or remove the dependency array                                react-hooks/exhaustive-deps
  61:7  warning  React Hook useCallback has a complex expression in the dependency array. Extract it to a separate variable so it can be statically checked  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/MetricsChartWidget.tsx
  168:6  warning  React Hook useEffect has a missing dependency: 'fetchData'. Either include it or remove the dependency array  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/PingStatusWidget.tsx
  79:6  warning  React Hook useEffect has a missing dependency: 'fetchAll'. Either include it or remove the dependency array                               react-hooks/exhaustive-deps
  79:7  warning  React Hook useEffect has a complex expression in the dependency array. Extract it to a separate variable so it can be statically checked  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/QuickConnectWidget.tsx
  64:10  warning  Fast refresh only works when a file has exports. Move your component(s) to a separate file  react-refresh/only-export-components

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/RecentActivityWidget.tsx
  82:6   warning  React Hook useEffect has a missing dependency: 'fetchData'. Either include it or remove the dependency array                              react-hooks/exhaustive-deps
  82:17  warning  React Hook useEffect has a complex expression in the dependency array. Extract it to a separate variable so it can be statically checked  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/SshQuickConnectWidget.tsx
  67:6   warning  React Hook useCallback has a missing dependency: 'hostIds'. Either include it or remove the dependency array                                react-hooks/exhaustive-deps
  67:7   warning  React Hook useCallback has a complex expression in the dependency array. Extract it to a separate variable so it can be statically checked  react-hooks/exhaustive-deps
  99:17  warning  'online' is assigned a value but never used. Allowed unused vars must match /^_/u                                                           unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/SshTerminalWidget.tsx
  17:10  warning  Fast refresh only works when a file has exports. Move your component(s) to a separate file  react-refresh/only-export-components

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/SystemOverviewWidget.tsx
  72:6  warning  React Hook useEffect has a missing dependency: 'fetchData'. Either include it or remove the dependency array  react-hooks/exhaustive-deps

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/homepage/widgets/TunnelWidget.tsx
  15:10  warning  Fast refresh only works when a file has exports. Move your component(s) to a separate file  react-refresh/only-export-components

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/features/host-metrics/cards/CpuCard.tsx
  14:10  warning  'computeChartData' is defined but never used. Allowed unused vars must match /^_/u  unused-imports/no-unused-vars

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/sidebar/FolderPathPicker.tsx
  15:17  warning  Fast refresh only works when a file only exports components. Use a new file to share constants or functions between components  react-refresh/only-export-components
  22:17  warning  Fast refresh only works when a file only exports components. Use a new file to share constants or functions between components  react-refresh/only-export-components

/mnt/c/Users/29037/WebstormProjects/Termix/src/ui/sidebar/HostsPanel.tsx
  601:52  warning  Unexpected any. Specify a different type  @typescript-eslint/no-explicit-any

✖ 44 problems (0 errors, 44 warnings) now fails if the generated files are out of date, so editing the
schema without regenerating cannot reach main.

* select durability behaviour per dialect, and document the backends

The onWrite hook every repository receives exists to serialise the in-memory
SQLite database back to its encrypted file. On a client-server engine a
committed write is already durable and there is nothing to flush, so the factory
now installs no hook at all rather than one that does nothing. Repositories call
it as this.onWrite?.(), so none of the 43 of them change.

Also adds docs/database-backends.md, mostly to be explicit about encryption,
which is the part most likely to be misread. Field-level encryption is identical
on all three engines and covers every credential. Whole-file encryption has no
equivalent on Postgres or MySQL, so host names, snippet contents, audit entries
and backups are only as protected as the storage underneath them — that is the
operator's responsibility and the docs should not imply otherwise.

* generate DDL with drizzle-kit, and give settings a synchronous path

Two of the three remaining blockers.

DDL: db/index.ts hand-writes 67 CREATE TABLE statements and 122 ADD COLUMN
migrations, all in SQLite dialect. Rather than port them, drizzle-kit now
generates migrations from the schema modules — 817 lines for Postgres, 869 for
MySQL, with the type mapping already correct because the schemas it reads are
themselves generated.
> termix@2.6.0 schema:migrations
> drizzle-kit generate --config=drizzle.config.pg.ts && drizzle-kit generate --config=drizzle.config.mysql.ts

Reading config file '/mnt/c/Users/29037/WebstormProjects/Termix/drizzle.config.pg.ts'
52 tables
alert_firings 11 columns 0 indexes 2 fks
alert_rule_channels 3 columns 0 indexes 2 fks
alert_rules 11 columns 0 indexes 2 fks
api_keys 9 columns 0 indexes 1 fks
audit_logs 13 columns 0 indexes 1 fks
c2s_tunnel_presets 8 columns 0 indexes 1 fks
command_history 5 columns 0 indexes 2 fks
dashboard_service_links 8 columns 0 indexes 1 fks
dismissed_alerts 4 columns 0 indexes 1 fks
file_manager_pinned 6 columns 0 indexes 2 fks
file_manager_recent 6 columns 0 indexes 2 fks
file_manager_shortcuts 6 columns 0 indexes 2 fks
homepage_items 9 columns 0 indexes 1 fks
homepage_layouts 4 columns 0 indexes 1 fks
host_access 11 columns 0 indexes 5 fks
host_health_checks 7 columns 0 indexes 2 fks
host_health_history 8 columns 0 indexes 2 fks
host_metrics_history 8 columns 0 indexes 1 fks
host_metrics_preferences 6 columns 0 indexes 2 fks
ssh_data 94 columns 0 indexes 6 fks
network_topology 5 columns 0 indexes 1 fks
notification_channels 7 columns 0 indexes 1 fks
opkssh_tokens 12 columns 0 indexes 2 fks
recent_activity 6 columns 0 indexes 2 fks
roles 8 columns 0 indexes 0 fks
session_recordings 15 columns 0 indexes 3 fks
session_share_participants 6 columns 0 indexes 2 fks
session_shares 15 columns 0 indexes 3 fks
sessions 11 columns 0 indexes 1 fks
settings 2 columns 0 indexes 0 fks
shared_host_secrets 15 columns 0 indexes 3 fks
snippet_access 8 columns 0 indexes 4 fks
snippet_folders 8 columns 0 indexes 1 fks
snippets 11 columns 0 indexes 1 fks
ssh_credential_usage 5 columns 0 indexes 3 fks
ssh_credentials 21 columns 0 indexes 1 fks
ssh_folders 9 columns 0 indexes 2 fks
sso_providers 8 columns 0 indexes 0 fks
sync_tombstones 5 columns 0 indexes 1 fks
termix_identities 6 columns 0 indexes 1 fks
termix_identity_ca 8 columns 0 indexes 2 fks
termix_identity_keys 12 columns 0 indexes 3 fks
tmux_session_tags 6 columns 0 indexes 2 fks
transfer_recent 7 columns 0 indexes 3 fks
trusted_devices 8 columns 0 indexes 1 fks
user_open_tabs 9 columns 0 indexes 2 fks
user_preferences 23 columns 0 indexes 1 fks
user_roles 5 columns 0 indexes 3 fks
users 20 columns 0 indexes 0 fks
vault_profiles 18 columns 0 indexes 1 fks
vault_tokens 8 columns 0 indexes 2 fks
webauthn_credentials 12 columns 0 indexes 1 fks

No schema changes, nothing to migrate 😴
Reading config file '/mnt/c/Users/29037/WebstormProjects/Termix/drizzle.config.mysql.ts'
Reading schema files:
/mnt/c/Users/29037/WebstormProjects/Termix/src/backend/database/db/schema.mysql.ts

52 tables
alert_firings 11 columns 0 indexes 2 fks
alert_rule_channels 3 columns 0 indexes 2 fks
alert_rules 11 columns 0 indexes 2 fks
api_keys 9 columns 0 indexes 1 fks
audit_logs 13 columns 0 indexes 1 fks
c2s_tunnel_presets 8 columns 0 indexes 1 fks
command_history 5 columns 0 indexes 2 fks
dashboard_service_links 8 columns 0 indexes 1 fks
dismissed_alerts 4 columns 0 indexes 1 fks
file_manager_pinned 6 columns 0 indexes 2 fks
file_manager_recent 6 columns 0 indexes 2 fks
file_manager_shortcuts 6 columns 0 indexes 2 fks
homepage_items 9 columns 0 indexes 1 fks
homepage_layouts 4 columns 0 indexes 1 fks
host_access 11 columns 0 indexes 5 fks
host_health_checks 7 columns 0 indexes 2 fks
host_health_history 8 columns 0 indexes 2 fks
host_metrics_history 8 columns 0 indexes 1 fks
host_metrics_preferences 6 columns 0 indexes 2 fks
ssh_data 94 columns 0 indexes 6 fks
network_topology 5 columns 0 indexes 1 fks
notification_channels 7 columns 0 indexes 1 fks
opkssh_tokens 12 columns 0 indexes 2 fks
recent_activity 6 columns 0 indexes 2 fks
roles 8 columns 0 indexes 0 fks
session_recordings 15 columns 0 indexes 3 fks
session_share_participants 6 columns 0 indexes 2 fks
session_shares 15 columns 0 indexes 3 fks
sessions 11 columns 0 indexes 1 fks
settings 2 columns 0 indexes 0 fks
shared_host_secrets 15 columns 0 indexes 3 fks
snippet_access 8 columns 0 indexes 4 fks
snippet_folders 8 columns 0 indexes 1 fks
snippets 11 columns 0 indexes 1 fks
ssh_credential_usage 5 columns 0 indexes 3 fks
ssh_credentials 21 columns 0 indexes 1 fks
ssh_folders 9 columns 0 indexes 2 fks
sso_providers 8 columns 0 indexes 0 fks
sync_tombstones 5 columns 0 indexes 1 fks
termix_identities 6 columns 0 indexes 1 fks
termix_identity_ca 8 columns 0 indexes 2 fks
termix_identity_keys 12 columns 0 indexes 3 fks
tmux_session_tags 6 columns 0 indexes 2 fks
transfer_recent 7 columns 0 indexes 3 fks
trusted_devices 8 columns 0 indexes 1 fks
user_open_tabs 9 columns 0 indexes 2 fks
user_preferences 23 columns 0 indexes 1 fks
user_roles 5 columns 0 indexes 3 fks
users 20 columns 0 indexes 0 fks
vault_profiles 18 columns 0 indexes 1 fks
vault_tokens 8 columns 0 indexes 2 fks
webauthn_credentials 12 columns 0 indexes 1 fks

No schema changes, nothing to migrate 😴 regenerates both.

Settings: 27 call sites read settings synchronously, during startup and inside
request handlers. better-sqlite3 can do that; Postgres and MySQL cannot, and
making all 27 async would push await through code that has no reason to be
asynchronous. Settings are a handful of rarely-changing rows read constantly, so
they are cached in full — primed at startup, kept in step by SettingsRepository
on every set/delete/deleteLike. SQLite keeps reading the database directly and
stays authoritative; only the other engines use the cache.

Opening a connection is still not done. DatabaseContext.drizzle is typed as
BetterSQLite3Database and 43 repositories depend on that inference; the three
drizzle instance types are not interchangeable, so widening it is a design
decision rather than a mechanical change.

* exclude drizzle-kit output from prettier

The generated migrations and snapshots are tool output; their formatting is
drizzle-kit's to decide, and prettier cannot parse the .sql files at all.

* absorb the RETURNING gap so mysql stays reachable

MySQL has no RETURNING clause and drizzle's mysql-core does not expose the
method, while 156 call sites here read the result of a write. That is the real
blocker for MySQL, not the connection layer.

Classifying those call sites showed the split is favourable: 92 of them only
read .length, which every engine reports — as a returned array on sqlite and
postgres, as affectedRows on MySQL. rowsAffected() reads both shapes, so those
sites need no change in query shape. insertedId() does the same for the
autoincrement key, which MySQL reports as insertId.

What is left is the ~34 sites that genuinely consume the returned rows. Those
cannot be emulated without reading first, which needs a transaction to stay
correct under concurrency, so they will be handled individually rather than
behind a helper that quietly adds a round trip. supportsReturning() is the seam
for that.

Identifying the mysql2 result by its own fields rather than by array shape
matters: it hands back [ResultSetHeader, fields], which is an array, so shape
alone cannot tell it apart from a returning() result.

* name the portable database type, and open remote connections

Two pieces of the connection layer.

drizzle's three Database classes share no base class and their signatures are
incompatible, so there is no honest type that covers all three: a union is not
callable and a generic would have to be threaded through 43 repositories and
every method on them. DatabaseContext.drizzle is now PortableDatabase, still
the SQLite type underneath, but named and documented as the deliberate
approximation it is. What makes it safe is that the equivalence is asserted in
multi-dialect.test.ts rather than assumed, and the one place the surfaces truly
differ — RETURNING — is handled explicitly in mutation-result.ts.

connect.ts opens Postgres and MySQL from DATABASE_URL, with the schema module
and driver imported lazily so neither is loaded on a SQLite deployment. The URL
scheme is checked against the configured dialect first: a postgres:// URL with
DATABASE_DIALECT=mysql otherwise surfaces as a driver error deep in a stack
that never mentions the actual misconfiguration.

* open postgres and mysql at startup

* count writes without RETURNING

* read affected rows without RETURNING on mysql

* insert without RETURNING, and split the sync transactions

* stop pretending the generated schemas are used at runtime

* run the dialect checks in CI

* mysql rejects a bare CURRENT_TIMESTAMP default on text

* make the read-back mismatch loud, and stop the next bare returning()

* run the repository tests on the real schema

* skip the byte-level assertions off sqlite

* move generated ids past the seeded ones

* keep the export order the same on every engine

* stop reading better-sqlite3 fields off every write

* read counts as numbers, not whatever the driver returns

* make the fixture usable against a live server

* upsert on the engine that has no ON CONFLICT

* run the repository suite on all three engines in CI

* mysql cannot index a text column without a length

* document how to actually run on postgres or mysql

* keep the sqlite-era migrations off the other engines

* concat strings in a way mysql agrees with

* run every repository test on every engine

* bound how long replicas can disagree about settings

* generate the sqlite migrations alongside the others
This commit is contained in:
ZacharyZcR
2026-07-29 18:56:14 +08:00
committed by GitHub
parent 32fb7487df
commit 8a79e6af53
127 changed files with 29299 additions and 3003 deletions
+71
View File
@@ -0,0 +1,71 @@
import * as sqlite from "drizzle-orm/sqlite-core";
import * as pg from "drizzle-orm/pg-core";
import * as mysql from "drizzle-orm/mysql-core";
/**
* Per-dialect column constructors, so a table can be declared once instead of
* three times.
*
* The existing schema only uses three column types (text, integer, real) plus
* an integer-backed boolean, which is what makes this tractable — the surface
* to abstract is small and closed. Anything a dialect cannot express the same
* way is spelled out here rather than at 52 call sites.
*
* Notable differences this papers over:
* - booleans are integers in SQLite, native in Postgres and tinyint in MySQL
* - autoincrement keys are `integer primary key autoincrement`, `serial`, and
* `int auto_increment` respectively
* - MySQL cannot index an unbounded TEXT, so keyed/indexed strings must be
* varchar; `shortText` exists for columns used as keys or in unique indexes
*/
export interface ColumnKit {
table: typeof sqlite.sqliteTable | typeof pg.pgTable | typeof mysql.mysqlTable;
/** Free-form string; unbounded where the engine allows it. */
text: (name: string) => AnyColumnBuilder;
/** String used as a key, unique or indexed — bounded so MySQL can index it. */
shortText: (name: string, length?: number) => AnyColumnBuilder;
int: (name: string) => AnyColumnBuilder;
/** Auto-incrementing surrogate primary key. */
serial: (name: string) => AnyColumnBuilder;
bool: (name: string) => AnyColumnBuilder;
real: (name: string) => AnyColumnBuilder;
}
// drizzle's builders are heavily generic; the schema modules keep their own
// precise types, so this alias only exists to describe the kit's shape.
type AnyColumnBuilder = ReturnType<typeof sqlite.text>;
const DEFAULT_KEY_LENGTH = 255;
export const sqliteKit = {
table: sqlite.sqliteTable,
text: (name: string) => sqlite.text(name),
shortText: (name: string) => sqlite.text(name),
int: (name: string) => sqlite.integer(name),
serial: (name: string) =>
sqlite.integer(name).primaryKey({ autoIncrement: true }),
bool: (name: string) => sqlite.integer(name, { mode: "boolean" }),
real: (name: string) => sqlite.real(name),
} as const;
export const pgKit = {
table: pg.pgTable,
text: (name: string) => pg.text(name),
shortText: (name: string, length = DEFAULT_KEY_LENGTH) =>
pg.varchar(name, { length }),
int: (name: string) => pg.integer(name),
serial: (name: string) => pg.serial(name).primaryKey(),
bool: (name: string) => pg.boolean(name),
real: (name: string) => pg.doublePrecision(name),
} as const;
export const mysqlKit = {
table: mysql.mysqlTable,
text: (name: string) => mysql.text(name),
shortText: (name: string, length = DEFAULT_KEY_LENGTH) =>
mysql.varchar(name, { length }),
int: (name: string) => mysql.int(name),
serial: (name: string) => mysql.int(name).autoincrement().primaryKey(),
bool: (name: string) => mysql.boolean(name),
real: (name: string) => mysql.double(name),
} as const;
+74
View File
@@ -0,0 +1,74 @@
import type { DatabaseDialect } from "./dialect.js";
import type { PortableDatabase } from "../repositories/database-context.js";
export const DATABASE_URL_ENV = "DATABASE_URL";
/**
* Opens a connection to a client-server engine.
*
* SQLite is not handled here — it has its own lifecycle in db/index.ts, where
* the database is decrypted into memory and serialised back to a file. This
* covers the engines that connect to something already running.
*
* The returned handle is typed as PortableDatabase; see the note there on why
* that is an approximation and what guarantees it.
*/
export function databaseUrl(env: NodeJS.ProcessEnv = process.env): string | null {
const url = env[DATABASE_URL_ENV]?.trim();
return url ? url : null;
}
/**
* Checks the connection string suits the configured engine before trying to
* open it, so a mismatch fails with something readable rather than a driver
* error thirty frames down.
*/
export function assertUrlMatchesDialect(
url: string,
dialect: DatabaseDialect,
): void {
const scheme = url.split("://", 1)[0].toLowerCase();
const expected: Record<string, readonly string[]> = {
postgres: ["postgres", "postgresql"],
mysql: ["mysql", "mariadb"],
};
const allowed = expected[dialect];
if (!allowed) {
throw new Error(`${dialect} does not use ${DATABASE_URL_ENV}`);
}
if (!allowed.includes(scheme)) {
throw new Error(
`${DATABASE_URL_ENV} is a "${scheme}://" URL but DATABASE_DIALECT is "${dialect}". ` +
`Expected one of ${allowed.map((s) => `${s}://`).join(", ")}.`,
);
}
}
export async function connectRemoteDatabase(
dialect: DatabaseDialect,
env: NodeJS.ProcessEnv = process.env,
): Promise<PortableDatabase> {
const url = databaseUrl(env);
if (!url) {
throw new Error(
`${DATABASE_URL_ENV} must be set when DATABASE_DIALECT is "${dialect}".`,
);
}
assertUrlMatchesDialect(url, dialect);
// No `schema` option: it only feeds drizzle's relational query API
// (`db.query.*`), which nothing here uses. The query builder takes its table
// names and value encoders from the table objects the repositories import —
// see the note in schema.pg.ts on why the generated schemas are DDL-only.
if (dialect === "postgres") {
const { drizzle } = await import("drizzle-orm/node-postgres");
return drizzle(url) as unknown as PortableDatabase;
}
const { drizzle } = await import("drizzle-orm/mysql2");
return drizzle(url) as unknown as PortableDatabase;
}
+50
View File
@@ -0,0 +1,50 @@
/**
* Which engine the schema and repositories are built against.
*
* SQLite is not going away: the desktop app embeds its backend and cannot ship
* a database server, so it will always run on SQLite. Postgres and MySQL are
* for self-hosted deployments that need more than one process to reach the
* data. This is a multi-backend story, not a migration off SQLite.
*/
export type DatabaseDialect = "sqlite" | "postgres" | "mysql";
export const DATABASE_DIALECT_ENV = "DATABASE_DIALECT";
const SUPPORTED: readonly DatabaseDialect[] = ["sqlite", "postgres", "mysql"];
export function isDatabaseDialect(value: unknown): value is DatabaseDialect {
return (
typeof value === "string" &&
(SUPPORTED as readonly string[]).includes(value)
);
}
/**
* Resolves the configured dialect, defaulting to SQLite so existing
* deployments and the desktop build are unaffected by this being added.
*/
export function resolveDatabaseDialect(
env: NodeJS.ProcessEnv = process.env,
): DatabaseDialect {
const raw = env[DATABASE_DIALECT_ENV]?.trim().toLowerCase();
if (!raw) return "sqlite";
if (!isDatabaseDialect(raw)) {
throw new Error(
`Unsupported ${DATABASE_DIALECT_ENV}: "${raw}". Expected one of ${SUPPORTED.join(", ")}.`,
);
}
return raw;
}
/**
* Whether a write has to be explicitly persisted after it commits.
*
* SQLite here is an in-memory database serialised back to an encrypted file, so
* every write needs a trigger to flush it. Client-server engines have already
* durably committed by the time the query returns — there is no file to write
* and nothing to schedule.
*/
export function needsExplicitPersist(dialect: DatabaseDialect): boolean {
return dialect === "sqlite";
}
+57 -2
View File
@@ -14,6 +14,10 @@ import {
DataDirMisconfiguredError,
} from "../../utils/data-dir-guard.js";
import { getDefaultGuacdUrl } from "../../utils/guacd-config.js";
import { resolveDatabaseDialect, type DatabaseDialect } from "./dialect.js";
import { connectRemoteDatabase } from "./connect.js";
import { runRemoteMigrations } from "./migrate.js";
import type { PortableDatabase } from "../repositories/database-context.js";
const dataDir = process.env.DATA_DIR || "./db/data";
const dbDir = path.resolve(dataDir);
@@ -2622,10 +2626,54 @@ async function handlePostInitFileEncryption() {
}
async function initializeDatabase(): Promise<void> {
const dialect = resolveDatabaseDialect();
if (dialect !== "sqlite") {
await initializeRemoteDatabase(dialect);
return;
}
await initializeCompleteDatabase();
await handlePostInitFileEncryption();
}
/**
* Startup against Postgres or MySQL.
*
* Shorter than the SQLite path because most of what that one does has no
* counterpart here: there is no file to decrypt, no in-memory copy to keep in
* step with disk, and the schema comes from drizzle-kit migrations instead of
* the inline DDL below.
*
* What does carry over is the settings cache. 27 call sites read settings
* synchronously, which better-sqlite3 allows and no remote driver does, so the
* table is loaded once here before anything asks for it.
*/
async function initializeRemoteDatabase(
dialect: Exclude<DatabaseDialect, "sqlite">,
): Promise<void> {
databaseLogger.info(`Connecting to ${dialect} database`, {
operation: "db_init",
dialect,
});
db = await connectRemoteDatabase(dialect);
await runRemoteMigrations(dialect, db);
// Imported here rather than at the top: factory.ts imports getDb from this
// module, and a static import would close the cycle at module-load time.
const { primeCurrentSettingsCache, startSettingsCacheRefresh } = await import(
"../repositories/factory.js"
);
await primeCurrentSettingsCache();
startSettingsCacheRefresh();
databaseLogger.info(`${dialect} database ready`, {
operation: "db_init_complete",
dialect,
});
}
export { initializeDatabase };
async function cleanupDatabase() {
@@ -2703,9 +2751,9 @@ process.on("SIGTERM", async () => {
process.exit(0);
});
let db: ReturnType<typeof drizzle<typeof schema>>;
let db: PortableDatabase;
export function getDb(): ReturnType<typeof drizzle<typeof schema>> {
export function getDb(): PortableDatabase {
if (!db) {
throw new Error(
"Database not initialized. Ensure initializeDatabase() is called before accessing db.",
@@ -2716,6 +2764,13 @@ export function getDb(): ReturnType<typeof drizzle<typeof schema>> {
export function getSqlite(): Database.Database {
if (!sqlite) {
const dialect = resolveDatabaseDialect();
if (dialect !== "sqlite") {
throw new Error(
`No SQLite handle: DATABASE_DIALECT is "${dialect}". This caller needs a ` +
`synchronous query, which only SQLite offers — give it an async path instead.`,
);
}
throw new Error(
"SQLite not initialized. Ensure initializeDatabase() is called before accessing sqlite.",
);
+51
View File
@@ -0,0 +1,51 @@
import path from "path";
import type { DatabaseDialect } from "./dialect.js";
import type { PortableDatabase } from "../repositories/database-context.js";
export const MIGRATIONS_DIR_ENV = "DRIZZLE_MIGRATIONS_DIR";
/**
* Where the generated migrations live.
*
* SQLite does not appear here: it builds its schema from the DDL in index.ts
* and patches it forward with migrateSchema(). Only the client-server engines
* use drizzle-kit migrations, and each has its own folder because the
* generated SQL differs per dialect.
*/
export function migrationsFolder(
dialect: DatabaseDialect,
env: NodeJS.ProcessEnv = process.env,
): string {
const override = env[MIGRATIONS_DIR_ENV]?.trim();
const root = override || path.resolve(process.cwd(), "drizzle");
return path.join(root, dialect);
}
/**
* Brings a remote database up to the current schema.
*
* drizzle's migrator records what it has applied in its own table, so this is
* safe to run on every start — including against a database another instance
* already migrated.
*/
export async function runRemoteMigrations(
dialect: DatabaseDialect,
db: PortableDatabase,
env: NodeJS.ProcessEnv = process.env,
): Promise<void> {
if (dialect === "sqlite") {
throw new Error("SQLite builds its schema in index.ts, not from drizzle/");
}
const folder = migrationsFolder(dialect, env);
const { migrate } =
dialect === "postgres"
? await import("drizzle-orm/node-postgres/migrator")
: await import("drizzle-orm/mysql2/migrator");
await (migrate as (db: unknown, config: { migrationsFolder: string }) => Promise<void>)(
db,
{ migrationsFolder: folder },
);
}
File diff suppressed because it is too large Load Diff
File diff suppressed because it is too large Load Diff
+146 -96
View File
@@ -1,4 +1,10 @@
import { sqliteTable, text, integer, real } from "drizzle-orm/sqlite-core";
import {
sqliteTable,
text,
integer,
real,
uniqueIndex,
} from "drizzle-orm/sqlite-core";
import { sql } from "drizzle-orm";
export const users = sqliteTable("users", {
@@ -566,40 +572,47 @@ export const hostAccess = sqliteTable("host_access", {
),
});
export const sharedHostSecrets = sqliteTable("shared_host_secrets", {
id: integer("id").primaryKey({ autoIncrement: true }),
hostAccessId: integer("host_access_id")
.notNull()
.references(() => hostAccess.id, { onDelete: "cascade" }),
targetUserId: text("target_user_id")
.notNull()
.references(() => users.id, { onDelete: "cascade" }),
protocol: text("protocol").notNull().default("ssh"),
sourceType: text("source_type").notNull().default("credential"),
originalCredentialId: integer("original_credential_id").references(
() => sshCredentials.id,
{ onDelete: "cascade" },
),
encryptedUsername: text("encrypted_username"),
encryptedAuthType: text("encrypted_auth_type"),
encryptedPassword: text("encrypted_password"),
encryptedKey: text("encrypted_key", { length: 16384 }),
encryptedKeyPassword: text("encrypted_key_password"),
encryptedKeyType: text("encrypted_key_type"),
encryptedDomain: text("encrypted_domain"),
createdAt: text("created_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
updatedAt: text("updated_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
});
export const sharedHostSecrets = sqliteTable(
"shared_host_secrets",
{
id: integer("id").primaryKey({ autoIncrement: true }),
hostAccessId: integer("host_access_id")
.notNull()
.references(() => hostAccess.id, { onDelete: "cascade" }),
targetUserId: text("target_user_id")
.notNull()
.references(() => users.id, { onDelete: "cascade" }),
protocol: text("protocol").notNull().default("ssh"),
sourceType: text("source_type").notNull().default("credential"),
originalCredentialId: integer("original_credential_id").references(
() => sshCredentials.id,
{ onDelete: "cascade" },
),
encryptedUsername: text("encrypted_username"),
encryptedAuthType: text("encrypted_auth_type"),
encryptedPassword: text("encrypted_password"),
encryptedKey: text("encrypted_key", { length: 16384 }),
encryptedKeyPassword: text("encrypted_key_password"),
encryptedKeyType: text("encrypted_key_type"),
encryptedDomain: text("encrypted_domain"),
createdAt: text("created_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
updatedAt: text("updated_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
},
// Declared inline in the production DDL as UNIQUE(...), but never here,
// so the generated Postgres and MySQL schemas allowed duplicates the
// SQLite deployment forbids — and the upsert had nothing to conflict on.
(table) => [uniqueIndex("idx_shared_host_secrets_scope").on(table.hostAccessId, table.targetUserId, table.protocol)],
);
export const roles = sqliteTable("roles", {
id: integer("id").primaryKey({ autoIncrement: true }),
@@ -621,22 +634,29 @@ export const roles = sqliteTable("roles", {
.default(sql`CURRENT_TIMESTAMP`),
});
export const userRoles = sqliteTable("user_roles", {
id: integer("id").primaryKey({ autoIncrement: true }),
userId: text("user_id")
.notNull()
.references(() => users.id, { onDelete: "cascade" }),
roleId: integer("role_id")
.notNull()
.references(() => roles.id, { onDelete: "cascade" }),
grantedBy: text("granted_by").references(() => users.id, {
onDelete: "set null",
}),
grantedAt: text("granted_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
});
export const userRoles = sqliteTable(
"user_roles",
{
id: integer("id").primaryKey({ autoIncrement: true }),
userId: text("user_id")
.notNull()
.references(() => users.id, { onDelete: "cascade" }),
roleId: integer("role_id")
.notNull()
.references(() => roles.id, { onDelete: "cascade" }),
grantedBy: text("granted_by").references(() => users.id, {
onDelete: "set null",
}),
grantedAt: text("granted_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
},
// Declared inline in the production DDL as UNIQUE(...), but never here,
// so the generated Postgres and MySQL schemas allowed duplicates the
// SQLite deployment forbids — and the upsert had nothing to conflict on.
(table) => [uniqueIndex("idx_user_roles_user_role").on(table.userId, table.roleId)],
);
export const auditLogs = sqliteTable("audit_logs", {
id: integer("id").primaryKey({ autoIncrement: true }),
@@ -751,29 +771,36 @@ export const sessionShareParticipants = sqliteTable(
},
);
export const opksshTokens = sqliteTable("opkssh_tokens", {
id: integer("id").primaryKey({ autoIncrement: true }),
userId: text("user_id")
.notNull()
.references(() => users.id, { onDelete: "cascade" }),
hostId: integer("host_id")
.notNull()
.references(() => hosts.id, { onDelete: "cascade" }),
sshCert: text("ssh_cert", { length: 8192 }).notNull(),
privateKey: text("private_key", { length: 8192 }).notNull(),
email: text("email"),
sub: text("sub"),
issuer: text("issuer"),
audience: text("audience"),
createdAt: text("created_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
expiresAt: text("expires_at").notNull(),
lastUsed: text("last_used"),
});
export const opksshTokens = sqliteTable(
"opkssh_tokens",
{
id: integer("id").primaryKey({ autoIncrement: true }),
userId: text("user_id")
.notNull()
.references(() => users.id, { onDelete: "cascade" }),
hostId: integer("host_id")
.notNull()
.references(() => hosts.id, { onDelete: "cascade" }),
sshCert: text("ssh_cert", { length: 8192 }).notNull(),
privateKey: text("private_key", { length: 8192 }).notNull(),
email: text("email"),
sub: text("sub"),
issuer: text("issuer"),
audience: text("audience"),
createdAt: text("created_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
expiresAt: text("expires_at").notNull(),
lastUsed: text("last_used"),
},
// Declared inline in the production DDL as UNIQUE(...), but never here,
// so the generated Postgres and MySQL schemas allowed duplicates the
// SQLite deployment forbids — and the upsert had nothing to conflict on.
(table) => [uniqueIndex("idx_opkssh_tokens_user_host").on(table.userId, table.hostId)],
);
// Vault SSH signer profiles. These hold ONLY non-secret connection settings and
// are intended to be shared across users (shared === true makes a profile
@@ -814,24 +841,31 @@ export const vaultProfiles = sqliteTable("vault_profiles", {
// Per-user cache of the ephemeral SSH private key + Vault-signed certificate.
// Transient: rows live only until the certificate expires. Secret fields are
// encrypted under the user's data-encryption key (see field-crypto.ts).
export const vaultTokens = sqliteTable("vault_tokens", {
id: integer("id").primaryKey({ autoIncrement: true }),
userId: text("user_id")
.notNull()
.references(() => users.id, { onDelete: "cascade" }),
profileId: integer("profile_id")
.notNull()
.references(() => vaultProfiles.id, { onDelete: "cascade" }),
sshCert: text("ssh_cert", { length: 8192 }).notNull(),
privateKey: text("private_key", { length: 8192 }).notNull(),
createdAt: text("created_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
expiresAt: text("expires_at").notNull(),
lastUsed: text("last_used"),
});
export const vaultTokens = sqliteTable(
"vault_tokens",
{
id: integer("id").primaryKey({ autoIncrement: true }),
userId: text("user_id")
.notNull()
.references(() => users.id, { onDelete: "cascade" }),
profileId: integer("profile_id")
.notNull()
.references(() => vaultProfiles.id, { onDelete: "cascade" }),
sshCert: text("ssh_cert", { length: 8192 }).notNull(),
privateKey: text("private_key", { length: 8192 }).notNull(),
createdAt: text("created_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
expiresAt: text("expires_at").notNull(),
lastUsed: text("last_used"),
},
// Declared inline in the production DDL as UNIQUE(...), but never here,
// so the generated Postgres and MySQL schemas allowed duplicates the
// SQLite deployment forbids — and the upsert had nothing to conflict on.
(table) => [uniqueIndex("idx_vault_tokens_user_profile").on(table.userId, table.profileId)],
);
export const apiKeys = sqliteTable("api_keys", {
id: text("id").primaryKey(),
@@ -899,7 +933,9 @@ export const userPreferences = sqliteTable("user_preferences", {
.default(sql`CURRENT_TIMESTAMP`),
});
export const hostMetricsPreferences = sqliteTable("host_metrics_preferences", {
export const hostMetricsPreferences = sqliteTable(
"host_metrics_preferences",
{
id: integer("id").primaryKey({ autoIncrement: true }),
userId: text("user_id")
.notNull()
@@ -916,9 +952,18 @@ export const hostMetricsPreferences = sqliteTable("host_metrics_preferences", {
updatedAt: text("updated_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
});
},
// One layout per user per host. Enforced in production since the inline DDL
// creates it, but it was never declared here, so the generated Postgres and
// MySQL schemas lacked it — and the upsert has nothing to conflict on.
(table) => [
uniqueIndex("idx_host_metrics_prefs_user_host").on(table.userId, table.hostId),
],
);
export const hostHealthChecks = sqliteTable("host_health_checks", {
export const hostHealthChecks = sqliteTable(
"host_health_checks",
{
id: integer("id").primaryKey({ autoIncrement: true }),
userId: text("user_id")
.notNull()
@@ -935,7 +980,12 @@ export const hostHealthChecks = sqliteTable("host_health_checks", {
updatedAt: text("updated_at")
.notNull()
.default(sql`CURRENT_TIMESTAMP`),
});
},
// Same as above: one set of checks per user per host.
(table) => [
uniqueIndex("idx_host_health_checks_user_host").on(table.userId, table.hostId),
],
);
export const hostHealthHistory = sqliteTable("host_health_history", {
id: integer("id").primaryKey({ autoIncrement: true }),
@@ -8,6 +8,8 @@ import {
} from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { sqlTimestampDaysAgo } from "./sql-timestamp.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning, updateReturning } from "./returning.js";
type AlertRuleRecord = typeof alertRules.$inferSelect;
type NotificationChannelRecord = typeof notificationChannels.$inferSelect;
@@ -118,16 +120,17 @@ export class AlertRepository {
config: string;
enabled: boolean;
}): Promise<NotificationChannelRow> {
const [created] = await this.context.drizzle
.insert(notificationChannels)
.values({
const [created] = await insertReturning(
this.context,
notificationChannels,
{
userId: input.userId,
name: input.name,
type: input.type,
config: input.config,
enabled: input.enabled,
})
.returning();
},
);
await this.afterWrite();
return mapChannelRow(created);
@@ -147,16 +150,15 @@ export class AlertRepository {
return this.findNotificationChannelForUser(id, userId);
}
const [updated] = await this.context.drizzle
.update(notificationChannels)
.set(input)
.where(
and(
eq(notificationChannels.id, id),
eq(notificationChannels.userId, userId),
),
)
.returning();
const [updated] = await updateReturning(
this.context,
notificationChannels,
input,
and(
eq(notificationChannels.id, id),
eq(notificationChannels.userId, userId),
),
);
if (!updated) return null;
await this.afterWrite();
@@ -167,17 +169,16 @@ export class AlertRepository {
id: number,
userId: string,
): Promise<boolean> {
const deleted = await this.context.drizzle
const result = await this.context.drizzle
.delete(notificationChannels)
.where(
and(
eq(notificationChannels.id, id),
eq(notificationChannels.userId, userId),
),
)
.returning({ id: notificationChannels.id });
);
if (deleted.length === 0) return false;
if (rowsAffected(result) === 0) return false;
await this.afterWrite();
return true;
}
@@ -211,21 +212,18 @@ export class AlertRepository {
channels: number[];
now: string;
}): Promise<AlertRuleWithChannelsRow> {
const [created] = await this.context.drizzle
.insert(alertRules)
.values({
userId: input.userId,
hostId: input.hostId,
name: input.name,
enabled: input.enabled,
triggerType: input.triggerType,
thresholdValue: input.thresholdValue,
thresholdDurationSeconds: input.thresholdDurationSeconds,
cooldownMinutes: input.cooldownMinutes,
createdAt: input.now,
updatedAt: input.now,
})
.returning();
const [created] = await insertReturning(this.context, alertRules, {
userId: input.userId,
hostId: input.hostId,
name: input.name,
enabled: input.enabled,
triggerType: input.triggerType,
thresholdValue: input.thresholdValue,
thresholdDurationSeconds: input.thresholdDurationSeconds,
cooldownMinutes: input.cooldownMinutes,
createdAt: input.now,
updatedAt: input.now,
});
const channels = await this.replaceRuleChannels(
created.id,
@@ -264,9 +262,10 @@ export class AlertRepository {
now: string;
},
): Promise<AlertRuleWithChannelsRow | null> {
const [updated] = await this.context.drizzle
.update(alertRules)
.set({
const [updated] = await updateReturning(
this.context,
alertRules,
{
...(input.name !== undefined ? { name: input.name } : {}),
...(input.hostId !== undefined ? { hostId: input.hostId } : {}),
...(input.enabled !== undefined ? { enabled: input.enabled } : {}),
@@ -283,9 +282,9 @@ export class AlertRepository {
? { cooldownMinutes: input.cooldownMinutes }
: {}),
updatedAt: input.now,
})
.where(and(eq(alertRules.id, id), eq(alertRules.userId, userId)))
.returning();
},
and(eq(alertRules.id, id), eq(alertRules.userId, userId)),
);
if (!updated) return null;
@@ -299,12 +298,11 @@ export class AlertRepository {
}
async deleteAlertRule(id: number, userId: string): Promise<boolean> {
const deleted = await this.context.drizzle
const result = await this.context.drizzle
.delete(alertRules)
.where(and(eq(alertRules.id, id), eq(alertRules.userId, userId)))
.returning({ id: alertRules.id });
.where(and(eq(alertRules.id, id), eq(alertRules.userId, userId)));
if (deleted.length === 0) return false;
if (rowsAffected(result) === 0) return false;
await this.afterWrite();
return true;
}
@@ -442,10 +440,9 @@ export class AlertRepository {
.where(eq(notificationChannels.userId, userId))
).map((row) => row.id);
const firingRows = await this.context.drizzle
const firingResult = await this.context.drizzle
.delete(alertFirings)
.where(eq(alertFirings.userId, userId))
.returning({ id: alertFirings.id });
.where(eq(alertFirings.userId, userId));
const linkFilters = [
...(ruleIds.length > 0
@@ -455,37 +452,34 @@ export class AlertRepository {
? [inArray(alertRuleChannels.channelId, channelIds)]
: []),
];
const linkRows =
const linkResult =
linkFilters.length === 0
? []
? null
: await this.context.drizzle
.delete(alertRuleChannels)
.where(or(...linkFilters))
.returning({ id: alertRuleChannels.id });
.where(or(...linkFilters));
const ruleRows = await this.context.drizzle
const ruleResult = await this.context.drizzle
.delete(alertRules)
.where(eq(alertRules.userId, userId))
.returning({ id: alertRules.id });
const channelRows = await this.context.drizzle
.where(eq(alertRules.userId, userId));
const result = await this.context.drizzle
.delete(notificationChannels)
.where(eq(notificationChannels.userId, userId))
.returning({ id: notificationChannels.id });
.where(eq(notificationChannels.userId, userId));
if (
firingRows.length > 0 ||
linkRows.length > 0 ||
ruleRows.length > 0 ||
channelRows.length > 0
rowsAffected(firingResult) > 0 ||
rowsAffected(linkResult) > 0 ||
rowsAffected(ruleResult) > 0 ||
rowsAffected(result) > 0
) {
await this.afterWrite();
}
return {
firingsDeleted: firingRows.length,
ruleLinksDeleted: linkRows.length,
rulesDeleted: ruleRows.length,
channelsDeleted: channelRows.length,
firingsDeleted: rowsAffected(firingResult),
ruleLinksDeleted: rowsAffected(linkResult),
rulesDeleted: rowsAffected(ruleResult),
channelsDeleted: rowsAffected(result),
};
}
@@ -1,6 +1,8 @@
import { eq, and } from "drizzle-orm";
import { apiKeys, users } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { deleteReturning, insertReturning } from "./returning.js";
export type ApiKeyRecord = typeof apiKeys.$inferSelect;
export type NewApiKeyRecord = typeof apiKeys.$inferInsert;
@@ -24,10 +26,7 @@ export class ApiKeyRepository {
) {}
async create(apiKey: NewApiKeyRecord): Promise<ApiKeyRecord> {
const rows = await this.context.drizzle
.insert(apiKeys)
.values(apiKey)
.returning();
const rows = await insertReturning(this.context, apiKeys, apiKey);
await this.afterWrite();
return rows[0];
}
@@ -78,23 +77,23 @@ export class ApiKeyRepository {
}
async delete(id: string): Promise<ApiKeyRecord | null> {
const rows = await this.context.drizzle
.delete(apiKeys)
.where(eq(apiKeys.id, id))
.returning();
const rows = await deleteReturning(
this.context,
apiKeys,
eq(apiKeys.id, id),
);
await this.afterWrite();
return rows[0] ?? null;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(apiKeys)
.where(eq(apiKeys.userId, userId))
.returning({ id: apiKeys.id });
.where(eq(apiKeys.userId, userId));
await this.afterWrite();
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -3,6 +3,7 @@ import { auditLogs } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { sqlTimestampDaysAgo } from "./sql-timestamp.js";
import { databaseLogger } from "../../utils/logger.js";
import { countValue, rowsAffected } from "./mutation-result.js";
export type AuditLogRecord = typeof auditLogs.$inferSelect;
export type NewAuditLogRecord = typeof auditLogs.$inferInsert;
@@ -82,7 +83,7 @@ export class AuditLogRepository {
return {
logs,
total: totalResult[0]?.count ?? 0,
total: countValue(totalResult[0]?.count),
};
}
@@ -126,30 +127,28 @@ export class AuditLogRepository {
* asked. `username` is denormalised, so the entry stays attributable.
*/
async anonymizeByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(auditLogs)
.set({ userId: null })
.where(eq(auditLogs.userId, userId))
.returning({ id: auditLogs.id });
.where(eq(auditLogs.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(auditLogs)
.where(eq(auditLogs.userId, userId))
.returning({ id: auditLogs.id });
.where(eq(auditLogs.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private buildWhere(filters: AuditLogFilters) {
@@ -184,17 +183,16 @@ export class AuditLogRepository {
if (days === null) return;
const cutoff = sqlTimestampDaysAgo(days);
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(auditLogs)
.where(lt(auditLogs.timestamp, cutoff))
.returning({ id: auditLogs.id });
.where(lt(auditLogs.timestamp, cutoff));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
databaseLogger.info(
`Pruned ${rows.length} audit entries past retention`,
`Pruned ${rowsAffected(result)} audit entries past retention`,
{
operation: "audit_retention_prune",
removed: rows.length,
removed: rowsAffected(result),
retentionDays: days,
cutoff,
},
@@ -212,7 +210,7 @@ export class AuditLogRepository {
const countResult = await this.context.drizzle
.select({ count: sql<number>`COUNT(*)` })
.from(auditLogs);
const count = countResult[0]?.count ?? 0;
const count = countValue(countResult[0]?.count);
if (count < max) return;
@@ -1,6 +1,8 @@
import { and, asc, eq, sql } from "drizzle-orm";
import { c2sTunnelPresets } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning, updateReturning } from "./returning.js";
export type C2sTunnelPresetRecord = typeof c2sTunnelPresets.$inferSelect;
@@ -64,16 +66,13 @@ export class C2sTunnelPresetRepository {
userId: string,
input: C2sTunnelPresetCreateInput,
): Promise<C2sTunnelPresetRecord> {
const [created] = await this.context.drizzle
.insert(c2sTunnelPresets)
.values({
userId,
name: input.name,
config: input.config,
platform: input.platform ?? null,
computerName: input.computerName ?? null,
})
.returning();
const [created] = await insertReturning(this.context, c2sTunnelPresets, {
userId,
name: input.name,
config: input.config,
platform: input.platform ?? null,
computerName: input.computerName ?? null,
});
await this.afterWrite();
return created;
@@ -84,16 +83,15 @@ export class C2sTunnelPresetRepository {
id: number,
updates: C2sTunnelPresetUpdateInput,
): Promise<C2sTunnelPresetRecord | null> {
const [updated] = await this.context.drizzle
.update(c2sTunnelPresets)
.set({
const [updated] = await updateReturning(
this.context,
c2sTunnelPresets,
{
...updates,
updatedAt: sql`CURRENT_TIMESTAMP`,
})
.where(
and(eq(c2sTunnelPresets.id, id), eq(c2sTunnelPresets.userId, userId)),
)
.returning();
},
and(eq(c2sTunnelPresets.id, id), eq(c2sTunnelPresets.userId, userId)),
);
if (updated) {
await this.afterWrite();
@@ -103,31 +101,29 @@ export class C2sTunnelPresetRepository {
}
async deleteForUser(userId: string, id: number): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(c2sTunnelPresets)
.where(
and(eq(c2sTunnelPresets.id, id), eq(c2sTunnelPresets.userId, userId)),
)
.returning({ id: c2sTunnelPresets.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(c2sTunnelPresets)
.where(eq(c2sTunnelPresets.userId, userId))
.returning({ id: c2sTunnelPresets.id });
.where(eq(c2sTunnelPresets.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,8 @@
import { and, desc, eq, inArray, sql } from "drizzle-orm";
import { commandHistory } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning } from "./returning.js";
export type CommandHistoryRecord = typeof commandHistory.$inferSelect;
@@ -16,10 +18,12 @@ export class CommandHistoryRepository {
command: string,
executedAt = new Date().toISOString(),
): Promise<CommandHistoryRecord> {
const [created] = await this.context.drizzle
.insert(commandHistory)
.values({ userId, hostId, command, executedAt })
.returning();
const [created] = await insertReturning(this.context, commandHistory, {
userId,
hostId,
command,
executedAt,
});
await this.afterWrite();
return created;
}
@@ -76,7 +80,7 @@ export class CommandHistoryRepository {
hostId: number,
command: string,
): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(commandHistory)
.where(
and(
@@ -84,45 +88,42 @@ export class CommandHistoryRepository {
eq(commandHistory.hostId, hostId),
eq(commandHistory.command, command),
),
)
.returning({ id: commandHistory.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByUserAndHost(userId: string, hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(commandHistory)
.where(
and(
eq(commandHistory.userId, userId),
eq(commandHistory.hostId, hostId),
),
)
.returning({ id: commandHistory.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostId(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(commandHistory)
.where(eq(commandHistory.hostId, hostId))
.returning({ id: commandHistory.id });
.where(eq(commandHistory.hostId, hostId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostIds(hostIds: number[]): Promise<number> {
@@ -130,29 +131,27 @@ export class CommandHistoryRepository {
return 0;
}
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(commandHistory)
.where(inArray(commandHistory.hostId, hostIds))
.returning({ id: commandHistory.id });
.where(inArray(commandHistory.hostId, hostIds));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(commandHistory)
.where(eq(commandHistory.userId, userId))
.returning({ id: commandHistory.id });
.where(eq(commandHistory.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -3,6 +3,12 @@ import { randomUUID } from "crypto";
import { sshCredentials, sshCredentialUsage } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { DataCrypto } from "../../utils/data-crypto.js";
import { rowsAffected } from "./mutation-result.js";
import {
deleteReturning,
insertReturning,
updateReturning,
} from "./returning.js";
export type CredentialRecord = typeof sshCredentials.$inferSelect;
export type NewCredentialRecord = typeof sshCredentials.$inferInsert;
@@ -17,10 +23,10 @@ export class CredentialRepository {
) {}
async create(credential: NewCredentialRecord): Promise<CredentialRecord> {
const rows = await this.context.drizzle
.insert(sshCredentials)
.values({ syncId: randomUUID(), ...credential })
.returning();
const rows = await insertReturning(this.context, sshCredentials, {
syncId: randomUUID(),
...credential,
});
await this.afterWrite();
return rows[0];
}
@@ -46,10 +52,11 @@ export class CredentialRepository {
delete (encryptedCredential as Partial<NewCredentialRecord>).id;
}
const rows = await this.context.drizzle
.insert(sshCredentials)
.values(encryptedCredential as NewCredentialRecord)
.returning();
const rows = await insertReturning(
this.context,
sshCredentials,
encryptedCredential as NewCredentialRecord,
);
await this.afterWrite();
return DataCrypto.decryptRecord(
@@ -143,7 +150,7 @@ export class CredentialRepository {
oldName: string,
newName: string,
): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(sshCredentials)
.set({ folder: newName, updatedAt: sql`CURRENT_TIMESTAMP` })
.where(
@@ -151,14 +158,13 @@ export class CredentialRepository {
eq(sshCredentials.userId, userId),
eq(sshCredentials.folder, oldName),
),
)
.returning({ id: sshCredentials.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async updateForUser(
@@ -166,16 +172,15 @@ export class CredentialRepository {
credentialId: number,
update: CredentialUpdate,
): Promise<CredentialRecord | null> {
const rows = await this.context.drizzle
.update(sshCredentials)
.set({ ...update, updatedAt: sql`CURRENT_TIMESTAMP` })
.where(
and(
eq(sshCredentials.id, credentialId),
eq(sshCredentials.userId, userId),
),
)
.returning();
const rows = await updateReturning(
this.context,
sshCredentials,
{ ...update, updatedAt: sql`CURRENT_TIMESTAMP` },
and(
eq(sshCredentials.id, credentialId),
eq(sshCredentials.userId, userId),
),
);
await this.afterWrite();
return rows[0] ?? null;
@@ -193,16 +198,15 @@ export class CredentialRepository {
userDataKey,
);
const rows = await this.context.drizzle
.update(sshCredentials)
.set({ ...encryptedUpdate, updatedAt: sql`CURRENT_TIMESTAMP` })
.where(
and(
eq(sshCredentials.id, credentialId),
eq(sshCredentials.userId, userId),
),
)
.returning();
const rows = await updateReturning(
this.context,
sshCredentials,
{ ...encryptedUpdate, updatedAt: sql`CURRENT_TIMESTAMP` },
and(
eq(sshCredentials.id, credentialId),
eq(sshCredentials.userId, userId),
),
);
await this.afterWrite();
return this.decryptOne(rows[0] ?? null, userId);
@@ -212,31 +216,29 @@ export class CredentialRepository {
userId: string,
credentialId: number,
): Promise<{ syncId: string | null } | null> {
const rows = await this.context.drizzle
.delete(sshCredentials)
.where(
and(
eq(sshCredentials.id, credentialId),
eq(sshCredentials.userId, userId),
),
)
.returning({ syncId: sshCredentials.syncId });
const rows = await deleteReturning(
this.context,
sshCredentials,
and(
eq(sshCredentials.id, credentialId),
eq(sshCredentials.userId, userId),
),
);
await this.afterWrite();
return rows[0] ?? null;
return rows[0] ? { syncId: rows[0].syncId } : null;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sshCredentials)
.where(eq(sshCredentials.userId, userId))
.returning({ id: sshCredentials.id });
.where(eq(sshCredentials.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async recordUsage(
@@ -2,6 +2,12 @@ import { and, asc, eq } from "drizzle-orm";
import { randomUUID } from "crypto";
import { dashboardServiceLinks } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import {
deleteReturning,
insertReturning,
updateReturning,
} from "./returning.js";
export type DashboardServiceLinkRecord =
typeof dashboardServiceLinks.$inferSelect;
@@ -38,9 +44,10 @@ export class DashboardServiceLinkRepository {
const nextOrder =
existing.length > 0 ? existing[existing.length - 1].order + 1 : 0;
const [created] = await this.context.drizzle
.insert(dashboardServiceLinks)
.values({
const [created] = await insertReturning(
this.context,
dashboardServiceLinks,
{
syncId: randomUUID(),
userId,
label: input.label,
@@ -48,8 +55,8 @@ export class DashboardServiceLinkRepository {
order: nextOrder,
createdAt,
updatedAt: createdAt,
})
.returning();
},
);
await this.afterWrite();
return created;
}
@@ -77,16 +84,15 @@ export class DashboardServiceLinkRepository {
id: number,
updates: DashboardServiceLinkUpdate,
): Promise<DashboardServiceLinkRecord | null> {
const [updated] = await this.context.drizzle
.update(dashboardServiceLinks)
.set({ ...updates, updatedAt: new Date().toISOString() })
.where(
and(
eq(dashboardServiceLinks.id, id),
eq(dashboardServiceLinks.userId, userId),
),
)
.returning();
const [updated] = await updateReturning(
this.context,
dashboardServiceLinks,
{ ...updates, updatedAt: new Date().toISOString() },
and(
eq(dashboardServiceLinks.id, id),
eq(dashboardServiceLinks.userId, userId),
),
);
if (updated) {
await this.afterWrite();
@@ -99,32 +105,30 @@ export class DashboardServiceLinkRepository {
userId: string,
id: number,
): Promise<{ syncId: string | null } | null> {
const rows = await this.context.drizzle
.delete(dashboardServiceLinks)
.where(
and(
eq(dashboardServiceLinks.id, id),
eq(dashboardServiceLinks.userId, userId),
),
)
.returning({ syncId: dashboardServiceLinks.syncId });
const rows = await deleteReturning(
this.context,
dashboardServiceLinks,
and(
eq(dashboardServiceLinks.id, id),
eq(dashboardServiceLinks.userId, userId),
),
);
if (rows.length === 0) return null;
await this.afterWrite();
return rows[0];
return { syncId: rows[0].syncId };
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(dashboardServiceLinks)
.where(eq(dashboardServiceLinks.userId, userId))
.returning({ id: dashboardServiceLinks.id });
.where(eq(dashboardServiceLinks.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,12 +1,31 @@
import type { BetterSQLite3Database } from "drizzle-orm/better-sqlite3";
import type * as schema from "../db/schema.js";
// Re-exported so repositories can keep importing it from here, but defined in
// db/dialect.ts — a local copy that said "sqlite" survived here for a while and
// typed every context as SQLite-only while the runtime already carried all
// three, which silently made the dialect branches unreachable to the checker.
export type { DatabaseDialect } from "../db/dialect.js";
import type { DatabaseDialect } from "../db/dialect.js";
/**
* Engines the repository layer can run against. SQLite is the only one wired up
* today; the alias exists so that adding another is a change in one place
* rather than a hunt for string literals.
* The database handle repositories work against.
*
* Typed as the SQLite instance on purpose. drizzle's three Database classes
* share no base class and their signatures are incompatible: a union is not
* callable, and a generic would have to be threaded through all 43
* repositories and every method on them.
*
* This is a deliberate approximation, not an accident. The query-builder
* surface the repositories actually use is the same on all three engines, and
* that equivalence is asserted in multi-dialect.test.ts rather than assumed
* identifier quoting, placeholder style and value coercion are all covered
* there. At runtime this may hold a Postgres or MySQL instance.
*
* The one place the surfaces genuinely differ is RETURNING, which MySQL lacks;
* see mutation-result.ts for how that is absorbed.
*/
export type DatabaseDialect = "sqlite";
export type PortableDatabase = BetterSQLite3Database<typeof schema>;
/**
* What a repository is allowed to touch.
@@ -18,5 +37,5 @@ export type DatabaseDialect = "sqlite";
*/
export interface DatabaseContext {
dialect: DatabaseDialect;
drizzle: BetterSQLite3Database<typeof schema>;
drizzle: PortableDatabase;
}
@@ -1,6 +1,7 @@
import { and, eq } from "drizzle-orm";
import { dismissedAlerts } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
export type DismissedAlertRecord = typeof dismissedAlerts.$inferSelect;
@@ -72,34 +73,32 @@ export class DismissedAlertRepository {
}
async deleteForUser(userId: string, alertId: string): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(dismissedAlerts)
.where(
and(
eq(dismissedAlerts.userId, userId),
eq(dismissedAlerts.alertId, alertId),
),
)
.returning({ id: dismissedAlerts.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(dismissedAlerts)
.where(eq(dismissedAlerts.userId, userId))
.returning({ id: dismissedAlerts.id });
.where(eq(dismissedAlerts.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
+89 -1
View File
@@ -1,5 +1,7 @@
import { DatabaseSaveTrigger } from "../../utils/database-save-trigger.js";
import { getDb, getSqlite } from "../db/index.js";
import { needsExplicitPersist, resolveDatabaseDialect } from "../db/dialect.js";
import { primeSettingsCache, readCachedSetting } from "./settings-cache.js";
import type { DatabaseContext } from "./database-context.js";
import { WebauthnCredentialRepository } from "./webauthn-credential-repository.js";
import { AlertRepository } from "./alert-repository.js";
@@ -52,9 +54,18 @@ export function createCurrentRepositoryContext(): DatabaseContext {
};
}
/**
* Post-write hook handed to every repository.
*
* Only meaningful for SQLite, where the database lives in memory and has to be
* serialised back to its encrypted file. On Postgres and MySQL the write is
* already durable, so no hook is installed at all rather than one that does
* nothing repositories call it as `this.onWrite?.()`.
*/
export function createCurrentRepositoryWriteHook(
reason: string,
): () => Promise<void> {
): (() => Promise<void>) | undefined {
if (!needsExplicitPersist(resolveDatabaseDialect())) return undefined;
return () => DatabaseSaveTrigger.forceSave(reason);
}
@@ -68,7 +79,18 @@ export function getCurrentRepositorySqlite() {
return getSqlite();
}
/**
* Synchronous settings read.
*
* SQLite can be queried synchronously, so it is read directly and stays
* authoritative. Other engines have no synchronous query, so the value comes
* from the cache primed at startup and kept current by SettingsRepository.
*/
export function getCurrentSettingValue(key: string): string | null {
if (!needsExplicitPersist(resolveDatabaseDialect())) {
return readCachedSetting(key);
}
const row = getCurrentRepositorySqlite()
.prepare("SELECT value FROM settings WHERE key = ?")
.get(key) as { value?: string } | undefined;
@@ -375,3 +397,69 @@ export function createCurrentVaultTokenRepository(): VaultTokenRepository {
createCurrentRepositoryWriteHook("vault_token_repository_write"),
);
}
/**
* Loads the settings cache. Must run during startup on engines without a
* synchronous read, before anything calls getCurrentSettingValue.
*/
export async function primeCurrentSettingsCache(): Promise<void> {
const rows = await createCurrentSettingsRepository().listAll();
primeSettingsCache(rows);
}
/**
* How often a replica re-reads the settings table.
*
* Override with SETTINGS_CACHE_REFRESH_SECONDS; 0 disables the refresh.
*/
const REFRESH_SECONDS_ENV = "SETTINGS_CACHE_REFRESH_SECONDS";
const DEFAULT_REFRESH_SECONDS = 30;
let refreshTimer: NodeJS.Timeout | null = null;
/**
* Keeps the settings cache from drifting on a multi-replica deployment.
*
* The cache is per-process and updated in the process that writes. That is
* enough for SQLite, where there is only ever one process. On Postgres and
* MySQL which exist here precisely so more than one instance can share the
* data a setting changed on one replica would otherwise never reach the
* others, because the synchronous read has no way to go back to the database.
*
* Periodic re-priming does not make the value immediately consistent. It bounds
* how long it can be wrong, which is the difference between a setting that
* takes effect on the next tick and one that takes effect at the next restart.
*/
export function startSettingsCacheRefresh(
env = process.env,
refresh: () => Promise<void> = primeCurrentSettingsCache,
): void {
if (refreshTimer) return;
const seconds = refreshIntervalSeconds(env);
if (seconds === null) return;
refreshTimer = setInterval(() => {
void refresh().catch(() => {
// A failed refresh leaves the previous values in place, which is the
// right outcome: a transient database blip should not blank the cache.
// Every caller reads a missing setting as "use the default", so an empty
// cache would silently revert configuration across the deployment.
});
}, seconds * 1000);
refreshTimer.unref();
}
/** The configured interval, or null when refreshing is switched off. */
export function refreshIntervalSeconds(env = process.env): number | null {
const seconds = Number(env[REFRESH_SECONDS_ENV] ?? DEFAULT_REFRESH_SECONDS);
return Number.isFinite(seconds) && seconds > 0 ? seconds : null;
}
/** Test seam. */
export function stopSettingsCacheRefresh(): void {
if (!refreshTimer) return;
clearInterval(refreshTimer);
refreshTimer = null;
}
@@ -5,6 +5,7 @@ import {
fileManagerShortcuts,
} from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
export type FileManagerRecentRecord = typeof fileManagerRecent.$inferSelect;
export type FileManagerPinnedRecord = typeof fileManagerPinned.$inferSelect;
@@ -112,7 +113,7 @@ export class FileManagerBookmarkRepository {
userId: string,
input: Pick<FileManagerBookmarkInput, "hostId" | "path">,
): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerRecent)
.where(
and(
@@ -120,14 +121,13 @@ export class FileManagerBookmarkRepository {
eq(fileManagerRecent.hostId, input.hostId),
eq(fileManagerRecent.path, input.path),
),
)
.returning({ id: fileManagerRecent.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async listPinnedForHost(
@@ -199,7 +199,7 @@ export class FileManagerBookmarkRepository {
userId: string,
input: Pick<FileManagerBookmarkInput, "hostId" | "path">,
): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerPinned)
.where(
and(
@@ -207,14 +207,13 @@ export class FileManagerBookmarkRepository {
eq(fileManagerPinned.hostId, input.hostId),
eq(fileManagerPinned.path, input.path),
),
)
.returning({ id: fileManagerPinned.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async listShortcutsForHost(
@@ -288,7 +287,7 @@ export class FileManagerBookmarkRepository {
userId: string,
input: Pick<FileManagerBookmarkInput, "hostId" | "path">,
): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerShortcuts)
.where(
and(
@@ -296,14 +295,13 @@ export class FileManagerBookmarkRepository {
eq(fileManagerShortcuts.hostId, input.hostId),
eq(fileManagerShortcuts.path, input.path),
),
)
.returning({ id: fileManagerShortcuts.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByUserId(userId: string): Promise<number> {
@@ -456,75 +454,66 @@ export class FileManagerBookmarkRepository {
}
private async deleteRecentByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerRecent)
.where(eq(fileManagerRecent.userId, userId))
.returning({ id: fileManagerRecent.id });
return rows.length;
.where(eq(fileManagerRecent.userId, userId));
return rowsAffected(result);
}
private async deletePinnedByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerPinned)
.where(eq(fileManagerPinned.userId, userId))
.returning({ id: fileManagerPinned.id });
return rows.length;
.where(eq(fileManagerPinned.userId, userId));
return rowsAffected(result);
}
private async deleteShortcutsByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerShortcuts)
.where(eq(fileManagerShortcuts.userId, userId))
.returning({ id: fileManagerShortcuts.id });
return rows.length;
.where(eq(fileManagerShortcuts.userId, userId));
return rowsAffected(result);
}
private async deleteRecentByHostId(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerRecent)
.where(eq(fileManagerRecent.hostId, hostId))
.returning({ id: fileManagerRecent.id });
return rows.length;
.where(eq(fileManagerRecent.hostId, hostId));
return rowsAffected(result);
}
private async deletePinnedByHostId(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerPinned)
.where(eq(fileManagerPinned.hostId, hostId))
.returning({ id: fileManagerPinned.id });
return rows.length;
.where(eq(fileManagerPinned.hostId, hostId));
return rowsAffected(result);
}
private async deleteShortcutsByHostId(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerShortcuts)
.where(eq(fileManagerShortcuts.hostId, hostId))
.returning({ id: fileManagerShortcuts.id });
return rows.length;
.where(eq(fileManagerShortcuts.hostId, hostId));
return rowsAffected(result);
}
private async deleteRecentByHostIds(hostIds: number[]): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerRecent)
.where(inArray(fileManagerRecent.hostId, hostIds))
.returning({ id: fileManagerRecent.id });
return rows.length;
.where(inArray(fileManagerRecent.hostId, hostIds));
return rowsAffected(result);
}
private async deletePinnedByHostIds(hostIds: number[]): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerPinned)
.where(inArray(fileManagerPinned.hostId, hostIds))
.returning({ id: fileManagerPinned.id });
return rows.length;
.where(inArray(fileManagerPinned.hostId, hostIds));
return rowsAffected(result);
}
private async deleteShortcutsByHostIds(hostIds: number[]): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(fileManagerShortcuts)
.where(inArray(fileManagerShortcuts.hostId, hostIds))
.returning({ id: fileManagerShortcuts.id });
return rows.length;
.where(inArray(fileManagerShortcuts.hostId, hostIds));
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -2,6 +2,12 @@ import { and, asc, eq } from "drizzle-orm";
import { randomUUID } from "crypto";
import { homepageItems } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import {
deleteReturning,
insertReturning,
updateReturning,
} from "./returning.js";
export type HomepageItemRecord = typeof homepageItems.$inferSelect;
@@ -35,18 +41,15 @@ export class HomepageItemRepository {
input: HomepageItemCreateInput,
now = new Date().toISOString(),
): Promise<HomepageItemRecord> {
const [created] = await this.context.drizzle
.insert(homepageItems)
.values({
syncId: randomUUID(),
userId,
typeId: input.typeId,
title: input.title,
config: input.config,
createdAt: now,
updatedAt: now,
})
.returning();
const [created] = await insertReturning(this.context, homepageItems, {
syncId: randomUUID(),
userId,
typeId: input.typeId,
title: input.title,
config: input.config,
createdAt: now,
updatedAt: now,
});
await this.afterWrite();
return created;
@@ -71,11 +74,12 @@ export class HomepageItemRepository {
updates: HomepageItemUpdateInput,
updatedAt = new Date().toISOString(),
): Promise<HomepageItemRecord | null> {
const [updated] = await this.context.drizzle
.update(homepageItems)
.set({ ...updates, updatedAt })
.where(and(eq(homepageItems.id, id), eq(homepageItems.userId, userId)))
.returning();
const [updated] = await updateReturning(
this.context,
homepageItems,
{ ...updates, updatedAt },
and(eq(homepageItems.id, id), eq(homepageItems.userId, userId)),
);
if (updated) {
await this.afterWrite();
@@ -88,27 +92,27 @@ export class HomepageItemRepository {
userId: string,
id: number,
): Promise<{ syncId: string | null } | null> {
const rows = await this.context.drizzle
.delete(homepageItems)
.where(and(eq(homepageItems.id, id), eq(homepageItems.userId, userId)))
.returning({ syncId: homepageItems.syncId });
const rows = await deleteReturning(
this.context,
homepageItems,
and(eq(homepageItems.id, id), eq(homepageItems.userId, userId)),
);
if (rows.length === 0) return null;
await this.afterWrite();
return rows[0];
return { syncId: rows[0].syncId };
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(homepageItems)
.where(eq(homepageItems.userId, userId))
.returning({ id: homepageItems.id });
.where(eq(homepageItems.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,8 @@
import { eq } from "drizzle-orm";
import { homepageLayouts } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning, updateReturning } from "./returning.js";
export type HomepageLayoutRecord = typeof homepageLayouts.$inferSelect;
@@ -28,34 +30,35 @@ export class HomepageLayoutRepository {
const existing = await this.findByUserId(userId);
if (!existing) {
const [created] = await this.context.drizzle
.insert(homepageLayouts)
.values({ userId, layout, updatedAt })
.returning();
const [created] = await insertReturning(this.context, homepageLayouts, {
userId,
layout,
updatedAt,
});
await this.afterWrite();
return created;
}
const [updated] = await this.context.drizzle
.update(homepageLayouts)
.set({ layout, updatedAt })
.where(eq(homepageLayouts.userId, userId))
.returning();
const [updated] = await updateReturning(
this.context,
homepageLayouts,
{ layout, updatedAt },
eq(homepageLayouts.userId, userId),
);
await this.afterWrite();
return updated;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(homepageLayouts)
.where(eq(homepageLayouts.userId, userId))
.returning({ id: homepageLayouts.id });
.where(eq(homepageLayouts.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -3,6 +3,12 @@ import { randomUUID } from "crypto";
import type { SQLiteColumn } from "drizzle-orm/sqlite-core";
import { hosts, sshCredentials, sshFolders } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import {
deleteReturning,
insertReturning,
updateReturning,
} from "./returning.js";
export type HostFolderRecord = typeof sshFolders.$inferSelect;
export type HostFolderHostRecord = typeof hosts.$inferSelect;
@@ -24,19 +30,31 @@ export class HostFolderRepository {
newName: string,
now = new Date().toISOString(),
): Promise<RenameFolderResult> {
// CAST target: every engine spells the text type differently enough to
// matter here — MySQL has no `text` cast and wants `char`.
const textType = this.context.dialect === "mysql" ? "char" : "text";
const oldPrefix = `${oldName} / `;
const newPrefix = `${newName} / `;
const childLike = `${oldPrefix}%`;
// CONCAT, not `||`: MySQL reads `||` as logical OR unless the server runs
// with PIPES_AS_CONCAT, so the child paths would have been rewritten to 0.
// No error, just wrong folder names. CONCAT and SUBSTR mean the same thing
// on all three engines.
//
// The prefix is inlined rather than bound: CONCAT is variadic, so Postgres
// cannot infer a parameter's type from its position and rejects the
// statement with 42P18 before it runs. The value is a folder name the
// caller supplied, so it goes through a bound placeholder in a plain
// concatenation instead of sql.raw.
const renameExpr = (col: SQLiteColumn) =>
sql`CASE WHEN ${col} = ${oldName} THEN ${newName} ELSE ${newPrefix} || substr(${col}, ${oldPrefix.length + 1}) END`;
sql`CASE WHEN ${col} = ${oldName} THEN ${newName} ELSE CONCAT(CAST(${newPrefix} AS ${sql.raw(textType)}), SUBSTR(${col}, ${sql.raw(String(oldPrefix.length + 1))})) END`;
const folderMatch = (col: SQLiteColumn) =>
or(eq(col, oldName), like(col, childLike));
const updatedHosts = await this.context.drizzle
.update(hosts)
.set({ folder: renameExpr(hosts.folder), updatedAt: now })
.where(and(eq(hosts.userId, userId), folderMatch(hosts.folder)))
.returning({ id: hosts.id });
.where(and(eq(hosts.userId, userId), folderMatch(hosts.folder)));
const updatedCredentials = await this.context.drizzle
.update(sshCredentials)
@@ -46,8 +64,7 @@ export class HostFolderRepository {
eq(sshCredentials.userId, userId),
folderMatch(sshCredentials.folder),
),
)
.returning({ id: sshCredentials.id });
);
await this.context.drizzle
.update(sshFolders)
@@ -56,8 +73,8 @@ export class HostFolderRepository {
await this.afterWrite();
return {
updatedHosts: updatedHosts.length,
updatedCredentials: updatedCredentials.length,
updatedHosts: rowsAffected(updatedHosts),
updatedCredentials: rowsAffected(updatedCredentials),
};
}
@@ -78,35 +95,33 @@ export class HostFolderRepository {
): Promise<{ folder: HostFolderRecord; created: boolean }> {
const existing = await this.findFolder(userId, name);
if (existing) {
const [updated] = await this.context.drizzle
.update(sshFolders)
.set({
const [updated] = await updateReturning(
this.context,
sshFolders,
{
color,
icon,
credentialId:
credentialId === undefined ? existing.credentialId : credentialId,
updatedAt: now,
})
.where(and(eq(sshFolders.userId, userId), eq(sshFolders.name, name)))
.returning();
},
and(eq(sshFolders.userId, userId), eq(sshFolders.name, name)),
);
await this.afterWrite();
return { folder: updated, created: false };
}
const [created] = await this.context.drizzle
.insert(sshFolders)
.values({
syncId: randomUUID(),
userId,
name,
color,
icon,
credentialId: credentialId ?? null,
createdAt: now,
updatedAt: now,
})
.returning();
const [created] = await insertReturning(this.context, sshFolders, {
syncId: randomUUID(),
userId,
name,
color,
icon,
credentialId: credentialId ?? null,
createdAt: now,
updatedAt: now,
});
await this.afterWrite();
return { folder: created, created: true };
@@ -139,10 +154,11 @@ export class HostFolderRepository {
.where(and(eq(hosts.userId, userId), folderMatch(hosts.folder)));
}
const deletedFolders = await this.context.drizzle
.delete(sshFolders)
.where(and(eq(sshFolders.userId, userId), folderMatch(sshFolders.name)))
.returning({ syncId: sshFolders.syncId });
const deletedFolders = await deleteReturning(
this.context,
sshFolders,
and(eq(sshFolders.userId, userId), folderMatch(sshFolders.name)),
);
await this.afterWrite();
@@ -157,16 +173,15 @@ export class HostFolderRepository {
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sshFolders)
.where(eq(sshFolders.userId, userId))
.returning({ id: sshFolders.id });
.where(eq(sshFolders.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async findFolder(
@@ -1,6 +1,8 @@
import { and, desc, eq, notInArray } from "drizzle-orm";
import { hostHealthChecks, hostHealthHistory } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning, updateReturning } from "./returning.js";
export type HostHealthCheckRecord = typeof hostHealthChecks.$inferSelect;
export type HostHealthHistoryRecord = typeof hostHealthHistory.$inferSelect;
@@ -45,27 +47,25 @@ export class HostHealthRepository {
): Promise<HostHealthCheckRecord> {
const existing = await this.findChecksByUserAndHost(userId, hostId);
if (existing) {
const [updated] = await this.context.drizzle
.update(hostHealthChecks)
.set({ checks, intervalSeconds, updatedAt: now })
.where(eq(hostHealthChecks.id, existing.id))
.returning();
const [updated] = await updateReturning(
this.context,
hostHealthChecks,
{ checks, intervalSeconds, updatedAt: now },
eq(hostHealthChecks.id, existing.id),
);
await this.afterWrite();
return updated;
}
const [created] = await this.context.drizzle
.insert(hostHealthChecks)
.values({
userId,
hostId,
checks,
intervalSeconds,
createdAt: now,
updatedAt: now,
})
.returning();
const [created] = await insertReturning(this.context, hostHealthChecks, {
userId,
hostId,
checks,
intervalSeconds,
createdAt: now,
updatedAt: now,
});
await this.afterWrite();
return created;
@@ -121,23 +121,21 @@ export class HostHealthRepository {
checksDeleted: number;
historyDeleted: number;
}> {
const historyRows = await this.context.drizzle
const historyResult = await this.context.drizzle
.delete(hostHealthHistory)
.where(eq(hostHealthHistory.userId, userId))
.returning({ id: hostHealthHistory.id });
.where(eq(hostHealthHistory.userId, userId));
const checkRows = await this.context.drizzle
const result = await this.context.drizzle
.delete(hostHealthChecks)
.where(eq(hostHealthChecks.userId, userId))
.returning({ id: hostHealthChecks.id });
.where(eq(hostHealthChecks.userId, userId));
if (historyRows.length > 0 || checkRows.length > 0) {
if (rowsAffected(historyResult) > 0 || rowsAffected(result) > 0) {
await this.afterWrite();
}
return {
checksDeleted: checkRows.length,
historyDeleted: historyRows.length,
checksDeleted: rowsAffected(result),
historyDeleted: rowsAffected(historyResult),
};
}
@@ -1,6 +1,8 @@
import { and, eq } from "drizzle-orm";
import { hostMetricsPreferences, hosts } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning, updateReturning } from "./returning.js";
export type HostMetricsPreferenceRecord =
typeof hostMetricsPreferences.$inferSelect;
@@ -37,26 +39,28 @@ export class HostMetricsPreferenceRepository {
): Promise<HostMetricsPreferenceRecord> {
const existing = await this.findByUserAndHost(userId, hostId);
if (existing) {
const [updated] = await this.context.drizzle
.update(hostMetricsPreferences)
.set({ layout, updatedAt: now })
.where(eq(hostMetricsPreferences.id, existing.id))
.returning();
const [updated] = await updateReturning(
this.context,
hostMetricsPreferences,
{ layout, updatedAt: now },
eq(hostMetricsPreferences.id, existing.id),
);
await this.afterWrite();
return updated;
}
const [created] = await this.context.drizzle
.insert(hostMetricsPreferences)
.values({
const [created] = await insertReturning(
this.context,
hostMetricsPreferences,
{
userId,
hostId,
layout,
createdAt: now,
updatedAt: now,
})
.returning();
},
);
await this.afterWrite();
return created;
@@ -67,28 +71,26 @@ export class HostMetricsPreferenceRepository {
hostId: number,
statsConfig: string,
): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(hosts)
.set({ statsConfig })
.where(and(eq(hosts.id, hostId), eq(hosts.userId, userId)))
.returning({ id: hosts.id });
.where(and(eq(hosts.id, hostId), eq(hosts.userId, userId)));
if (rows.length === 0) return false;
if (rowsAffected(result) === 0) return false;
await this.afterWrite();
return true;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(hostMetricsPreferences)
.where(eq(hostMetricsPreferences.userId, userId))
.returning({ id: hostMetricsPreferences.id });
.where(eq(hostMetricsPreferences.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -3,6 +3,12 @@ import { randomUUID } from "crypto";
import { hostAccess, hosts } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { DataCrypto } from "../../utils/data-crypto.js";
import { rowsAffected } from "./mutation-result.js";
import {
deleteReturning,
insertReturning,
updateReturning,
} from "./returning.js";
export type HostRecord = typeof hosts.$inferSelect;
export type NewHostRecord = typeof hosts.$inferInsert;
@@ -21,10 +27,10 @@ export class HostRepository {
) {}
async create(host: NewHostRecord): Promise<HostRecord> {
const rows = await this.context.drizzle
.insert(hosts)
.values({ syncId: randomUUID(), ...host })
.returning();
const rows = await insertReturning(this.context, hosts, {
syncId: randomUUID(),
...host,
});
await this.afterWrite();
return rows[0];
}
@@ -51,10 +57,11 @@ export class HostRepository {
delete (encryptedHost as Partial<NewHostRecord>).id;
}
const rows = await this.context.drizzle
.insert(hosts)
.values(encryptedHost as NewHostRecord)
.returning();
const rows = await insertReturning(
this.context,
hosts,
encryptedHost as NewHostRecord,
);
await this.afterWrite();
return DataCrypto.decryptRecord("ssh_data", rows[0], userId, userDataKey);
@@ -150,11 +157,12 @@ export class HostRepository {
hostId: number,
update: HostUpdate,
): Promise<HostRecord | null> {
const rows = await this.context.drizzle
.update(hosts)
.set({ ...update, updatedAt: sql`CURRENT_TIMESTAMP` })
.where(and(eq(hosts.id, hostId), eq(hosts.userId, userId)))
.returning();
const rows = await updateReturning(
this.context,
hosts,
{ ...update, updatedAt: sql`CURRENT_TIMESTAMP` },
and(eq(hosts.id, hostId), eq(hosts.userId, userId)),
);
await this.afterWrite();
return rows[0] ?? null;
@@ -173,11 +181,12 @@ export class HostRepository {
userDataKey,
);
const rows = await this.context.drizzle
.update(hosts)
.set({ ...encryptedUpdate, updatedAt: sql`CURRENT_TIMESTAMP` })
.where(and(eq(hosts.id, hostId), eq(hosts.userId, userId)))
.returning();
const rows = await updateReturning(
this.context,
hosts,
{ ...encryptedUpdate, updatedAt: sql`CURRENT_TIMESTAMP` },
and(eq(hosts.id, hostId), eq(hosts.userId, userId)),
);
await this.afterWrite();
return rows[0]
@@ -213,17 +222,16 @@ export class HostRepository {
return 0;
}
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(hosts)
.set({ ...update, updatedAt: sql`CURRENT_TIMESTAMP` })
.where(and(inArray(hosts.id, hostIds), eq(hosts.userId, userId)))
.returning({ id: hosts.id });
.where(and(inArray(hosts.id, hostIds), eq(hosts.userId, userId)));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteForUser(
@@ -232,39 +240,38 @@ export class HostRepository {
): Promise<{ syncId: string | null } | null> {
await this.deleteAccessForHost(hostId);
const rows = await this.context.drizzle
.delete(hosts)
.where(and(eq(hosts.id, hostId), eq(hosts.userId, userId)))
.returning({ syncId: hosts.syncId });
const rows = await deleteReturning(
this.context,
hosts,
and(eq(hosts.id, hostId), eq(hosts.userId, userId)),
);
await this.afterWrite();
return rows[0] ?? null;
return rows[0] ? { syncId: rows[0].syncId } : null;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(hosts)
.where(eq(hosts.userId, userId))
.returning({ id: hosts.id });
.where(eq(hosts.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteAccessForHost(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(hostAccess)
.where(eq(hostAccess.hostId, hostId))
.returning({ id: hostAccess.id });
.where(eq(hostAccess.hostId, hostId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -0,0 +1,157 @@
import type { DatabaseDialect } from "../db/dialect.js";
/**
* Reading the outcome of a write without depending on RETURNING.
*
* SQLite and Postgres can attach `.returning()` to a delete or update and get
* the affected rows back. **MySQL cannot** it has no RETURNING clause, and
* drizzle's mysql-core does not expose the method at all, so the call is a
* TypeError rather than a bad query. 175 call sites here read a write's result,
* so the difference has to be absorbed somewhere.
*
* The split that matters is what the caller actually needs:
*
* - **How many rows changed** the majority, and none of them need the rows.
* They used to ask for them anyway, via `.returning().length`. Dropping the
* `.returning()` and reading the driver's own count is both portable and one
* less thing for the database to send back.
* - **The rows themselves** cannot be emulated on MySQL without reading
* first, which needs a transaction to stay correct under concurrency. Those
* call sites are handled individually rather than behind a helper that hides
* an extra round trip.
*/
/**
* The count each driver reports for a write, under its own name.
*
* Every engine says how many rows a write touched. None of them agree on what
* to call it:
*
* | driver | shape |
* |----------------|----------------------------------------|
* | better-sqlite3 | `{ changes, lastInsertRowid }` |
* | node-postgres | `{ rowCount, rows, command }` |
* | mysql2 | `[{ affectedRows, insertId }, fields]` |
*
* These are the shapes returned when NO `.returning()` is attached which is
* the portable way to write, since MySQL has no RETURNING clause at all.
*/
interface WriteHeader {
changes?: number;
rowCount?: number;
affectedRows?: number;
lastInsertRowid?: number | bigint;
insertId?: number;
}
const COUNT_FIELDS = ["changes", "rowCount", "affectedRows"] as const;
/**
* mysql2 hands back `[ResultSetHeader, fields]`, which is itself an array so
* "is it an array" cannot distinguish a write header from a returning() result.
* The header is identified by carrying one of the fields above instead.
*/
function asWriteHeader(result: unknown): WriteHeader | null {
const candidate =
Array.isArray(result) && result.length > 0 ? result[0] : result;
if (!candidate || typeof candidate !== "object") return null;
const header = candidate as WriteHeader;
const known =
COUNT_FIELDS.some((field) => typeof header[field] === "number") ||
typeof header.insertId === "number" ||
typeof header.lastInsertRowid === "number" ||
typeof header.lastInsertRowid === "bigint";
return known ? header : null;
}
/**
* Number of rows a write touched.
*
* Pass the result of the write itself every driver's header is understood, so
* the caller neither branches on the dialect nor attaches `.returning()` just to
* count what came back.
*
* A `.returning()` array is still accepted, for the call sites that need the
* rows for their own reasons and would rather not count them twice.
*/
export function rowsAffected(result: unknown): number {
const header = asWriteHeader(result);
if (header) {
for (const field of COUNT_FIELDS) {
const count = header[field];
if (typeof count === "number") return count;
}
// A header with only insertId: one row went in.
return 0;
}
if (Array.isArray(result)) return result.length;
return 0;
}
/**
* Id assigned by an insert.
*
* **Only meaningful on the result of an insert.** SQLite's `lastInsertRowid` and
* MySQL's `insertId` are connection-level values that survive the statement that
* set them after a delete, SQLite still reports whatever the last insert
* produced. Passing an update or delete result here gets a stale id, not null.
*
* Returns null when the table has no autoincrement key.
*/
export function insertedId(result: unknown): number | null {
const header = asWriteHeader(result);
if (header) {
// MySQL and SQLite both use 0 for "no autoincrement column".
if (typeof header.insertId === "number") {
return header.insertId > 0 ? header.insertId : null;
}
if (typeof header.lastInsertRowid === "bigint") {
return header.lastInsertRowid > 0n
? Number(header.lastInsertRowid)
: null;
}
if (typeof header.lastInsertRowid === "number") {
return header.lastInsertRowid > 0 ? header.lastInsertRowid : null;
}
return null;
}
if (Array.isArray(result)) {
const first = result[0] as { id?: unknown } | undefined;
return typeof first?.id === "number" ? first.id : null;
}
return null;
}
/**
* Whether `.returning()` can be attached to a write on this engine.
*
* Call sites that genuinely need the affected rows use this to choose between
* one statement and a read-then-write inside a transaction.
*/
export function supportsReturning(dialect: DatabaseDialect): boolean {
return dialect !== "mysql";
}
/**
* Reads an aggregate count as a number.
*
* `sql<number>` is a type assertion, not a conversion. Postgres returns COUNT()
* as bigint, which node-postgres hands back as a **string** so that values past
* 2^53 survive so the annotation is a lie there and comparisons like
* `count < max` compare a string to a number.
*/
export function countValue(value: unknown): number {
if (typeof value === "number") return value;
if (typeof value === "bigint") return Number(value);
if (typeof value === "string") {
const parsed = Number(value);
return Number.isFinite(parsed) ? parsed : 0;
}
return 0;
}
@@ -1,6 +1,7 @@
import { eq } from "drizzle-orm";
import { networkTopology } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
export type NetworkTopologyRecord = typeof networkTopology.$inferSelect;
@@ -45,16 +46,15 @@ export class NetworkTopologyRepository {
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(networkTopology)
.where(eq(networkTopology.userId, userId))
.returning({ id: networkTopology.id });
.where(eq(networkTopology.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,7 @@
import { and, eq, gt } from "drizzle-orm";
import { userOpenTabs } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
export type OpenTabRecord = typeof userOpenTabs.$inferSelect;
export type NewOpenTabRecord = typeof userOpenTabs.$inferInsert;
@@ -111,43 +112,40 @@ export class OpenTabRepository {
update: OpenTabUpdate,
updatedAt = new Date().toISOString(),
): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(userOpenTabs)
.set({ ...update, updatedAt })
.where(and(eq(userOpenTabs.id, id), eq(userOpenTabs.userId, userId)))
.returning({ id: userOpenTabs.id });
.where(and(eq(userOpenTabs.id, id), eq(userOpenTabs.userId, userId)));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteForUser(userId: string, id: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(userOpenTabs)
.where(and(eq(userOpenTabs.id, id), eq(userOpenTabs.userId, userId)))
.returning({ id: userOpenTabs.id });
.where(and(eq(userOpenTabs.id, id), eq(userOpenTabs.userId, userId)));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(userOpenTabs)
.where(eq(userOpenTabs.userId, userId))
.returning({ id: userOpenTabs.id });
.where(eq(userOpenTabs.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async findByIdForUser(
@@ -1,6 +1,8 @@
import { and, eq } from "drizzle-orm";
import { opksshTokens } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { upsert } from "./returning.js";
export type OpksshTokenRecord = typeof opksshTokens.$inferSelect;
@@ -26,9 +28,10 @@ export class OpksshTokenRepository {
async upsert(input: OpksshTokenUpsertInput): Promise<void> {
const createdAt = input.createdAt ?? new Date().toISOString();
await this.context.drizzle
.insert(opksshTokens)
.values({
await upsert(
this.context,
opksshTokens,
{
userId: input.userId,
hostId: input.hostId,
sshCert: input.sshCert,
@@ -38,8 +41,8 @@ export class OpksshTokenRepository {
issuer: input.issuer,
audience: input.audience,
expiresAt: input.expiresAt,
})
.onConflictDoUpdate({
},
{
target: [opksshTokens.userId, opksshTokens.hostId],
set: {
sshCert: input.sshCert,
@@ -51,7 +54,8 @@ export class OpksshTokenRepository {
expiresAt: input.expiresAt,
createdAt,
},
});
},
);
await this.afterWrite();
}
@@ -76,47 +80,44 @@ export class OpksshTokenRepository {
hostId: number,
lastUsed = new Date().toISOString(),
): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(opksshTokens)
.set({ lastUsed })
.where(
and(eq(opksshTokens.userId, userId), eq(opksshTokens.hostId, hostId)),
)
.returning({ id: opksshTokens.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteByUserAndHost(userId: string, hostId: number): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(opksshTokens)
.where(
and(eq(opksshTokens.userId, userId), eq(opksshTokens.hostId, hostId)),
)
.returning({ id: opksshTokens.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(opksshTokens)
.where(eq(opksshTokens.userId, userId))
.returning({ id: opksshTokens.id });
.where(eq(opksshTokens.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -9,6 +9,8 @@ import {
users,
} from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning } from "./returning.js";
export type RbacAccessTargetType = "user" | "role";
@@ -156,7 +158,7 @@ export class RbacAccessRepository {
return { id: existing.id, created: false };
}
const result = await this.context.drizzle.insert(hostAccess).values({
const [created] = await insertReturning(this.context, hostAccess, {
hostId: input.hostId,
userId: input.targetType === "user" ? input.targetUserId : null,
roleId: input.targetType === "role" ? input.targetRoleId : null,
@@ -166,7 +168,7 @@ export class RbacAccessRepository {
});
await this.afterWrite();
return { id: Number(result.lastInsertRowid), created: true };
return { id: created.id, created: true };
}
async revokeHostAccess(accessId: number, hostId: number): Promise<void> {
@@ -177,16 +179,15 @@ export class RbacAccessRepository {
}
async deleteHostAccessForHost(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(hostAccess)
.where(eq(hostAccess.hostId, hostId))
.returning({ id: hostAccess.id });
.where(eq(hostAccess.hostId, hostId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteHostAccessForHosts(hostIds: number[]): Promise<number> {
@@ -194,30 +195,27 @@ export class RbacAccessRepository {
return 0;
}
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(hostAccess)
.where(inArray(hostAccess.hostId, hostIds))
.returning({ id: hostAccess.id });
.where(inArray(hostAccess.hostId, hostIds));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteHostAccessForUserReferences(userId: string): Promise<number> {
const directRows = await this.context.drizzle
const directResult = await this.context.drizzle
.delete(hostAccess)
.where(eq(hostAccess.userId, userId))
.returning({ id: hostAccess.id });
.where(eq(hostAccess.userId, userId));
const grantedRows = await this.context.drizzle
const result = await this.context.drizzle
.delete(hostAccess)
.where(eq(hostAccess.grantedBy, userId))
.returning({ id: hostAccess.id });
.where(eq(hostAccess.grantedBy, userId));
const deletedCount = directRows.length + grantedRows.length;
const deletedCount = rowsAffected(directResult) + rowsAffected(result);
if (deletedCount > 0) {
await this.afterWrite();
}
@@ -291,7 +289,7 @@ export class RbacAccessRepository {
return { id: existing.id, created: false };
}
const result = await this.context.drizzle.insert(snippetAccess).values({
const [created] = await insertReturning(this.context, snippetAccess, {
snippetId: input.snippetId,
userId: input.targetType === "user" ? input.targetUserId : null,
roleId: input.targetType === "role" ? input.targetRoleId : null,
@@ -301,7 +299,7 @@ export class RbacAccessRepository {
});
await this.afterWrite();
return { id: Number(result.lastInsertRowid), created: true };
return { id: created.id, created: true };
}
async revokeSnippetAccess(
@@ -512,21 +510,20 @@ export class RbacAccessRepository {
async deleteExpiredHostAccess(
now = new Date().toISOString(),
): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(hostAccess)
.where(
and(
sql`${hostAccess.expiresAt} IS NOT NULL`,
sql`${hostAccess.expiresAt} <= ${now}`,
),
)
.returning({ id: hostAccess.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async findActiveHostAccess(
@@ -635,17 +632,16 @@ export class RbacAccessRepository {
hostId: number,
update: { permissionLevel?: string; expiresAt?: string | null },
): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(hostAccess)
.set(update)
.where(and(eq(hostAccess.id, accessId), eq(hostAccess.hostId, hostId)))
.returning({ id: hostAccess.id });
.where(and(eq(hostAccess.id, accessId), eq(hostAccess.hostId, hostId)));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async findHostAccessOwnerId(hostAccessId: number): Promise<string | null> {
@@ -1,6 +1,8 @@
import { desc, eq, inArray } from "drizzle-orm";
import { recentActivity } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning } from "./returning.js";
export type RecentActivityRecord = typeof recentActivity.$inferSelect;
export type NewRecentActivityRecord = typeof recentActivity.$inferInsert;
@@ -26,10 +28,7 @@ export class RecentActivityRepository {
async create(
activity: NewRecentActivityRecord,
): Promise<RecentActivityRecord> {
const rows = await this.context.drizzle
.insert(recentActivity)
.values(activity)
.returning();
const rows = await insertReturning(this.context, recentActivity, activity);
await this.afterWrite();
return rows[0];
@@ -51,42 +50,39 @@ export class RecentActivityRepository {
return 0;
}
const deletedRows = await this.context.drizzle
const result = await this.context.drizzle
.delete(recentActivity)
.where(inArray(recentActivity.id, idsToDelete))
.returning({ id: recentActivity.id });
.where(inArray(recentActivity.id, idsToDelete));
if (deletedRows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return deletedRows.length;
return rowsAffected(result);
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(recentActivity)
.where(eq(recentActivity.userId, userId))
.returning({ id: recentActivity.id });
.where(eq(recentActivity.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostId(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(recentActivity)
.where(eq(recentActivity.hostId, hostId))
.returning({ id: recentActivity.id });
.where(eq(recentActivity.hostId, hostId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostIds(hostIds: number[]): Promise<number> {
@@ -94,16 +90,15 @@ export class RecentActivityRepository {
return 0;
}
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(recentActivity)
.where(inArray(recentActivity.hostId, hostIds))
.returning({ id: recentActivity.id });
.where(inArray(recentActivity.hostId, hostIds));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -0,0 +1,227 @@
import { eq, type SQL } from "drizzle-orm";
import type { SQLiteColumn, SQLiteTable } from "drizzle-orm/sqlite-core";
import type { DatabaseContext } from "./database-context.js";
import {
insertedId,
rowsAffected,
supportsReturning,
} from "./mutation-result.js";
/**
* Writes that need the affected rows back.
*
* `mutation-result.ts` covers the call sites that only wanted a count. These are
* the ones that genuinely read the rows an updated record to return to the
* caller, a deleted row's fields to clean up alongside it.
*
* SQLite and Postgres do this in one statement with RETURNING. MySQL has no
* such clause, so the read is a second statement, and the pair has to be atomic:
*
* - **insert** write, then read the row back by its key.
* - **update** write, then read. Reading first would return the old values.
* - **delete** read, then write. Reading after would return nothing.
*
* Both run in a transaction. Without one, a concurrent write between the two
* statements makes the returned rows describe a state that never existed, and
* with a connection pool the second statement might not even reach the same
* connection.
*
* ## The trap, and why it cannot bite silently
*
* On MySQL the update path re-reads using the same `where`. If the update
* changes a column that `where` tests, the read finds nothing SQLite would
* have returned the row. Every current caller filters on an id it does not
* modify, but that is a convention, not a guarantee, so the mismatch is
* detected and thrown rather than returned as an empty array. Same for an
* insert whose row cannot be read back.
*
* Row types come from the table, so call sites keep the typing they had with
* `.returning()` and nothing has to be annotated by hand.
*/
/**
* What `.set()` accepts: a column's own type, or a SQL expression in its place
* `updatedAt: sql`CURRENT_TIMESTAMP`` is the common one here.
*/
type UpdateValues<T extends SQLiteTable> = {
[K in keyof T["$inferInsert"]]?: T["$inferInsert"][K] | SQL;
};
export async function updateReturning<T extends SQLiteTable>(
context: DatabaseContext,
table: T,
values: UpdateValues<T>,
where: SQL,
): Promise<T["$inferSelect"][]> {
const db = context.drizzle;
if (supportsReturning(context.dialect)) {
// The cast resolves a conditional in drizzle's return type that TypeScript
// cannot narrow while T is still generic. The runtime shape is the rows.
return db.update(table).set(values).where(where).returning() as Promise<
T["$inferSelect"][]
>;
}
return db.transaction(async (tx) => {
const written = await tx.update(table).set(values).where(where);
const rows = await tx.select().from(table).where(where);
// The trap this catches: if the update changed a column that `where` tests,
// the read finds nothing and the caller gets [] — on MySQL only, with no
// error, where SQLite would have returned the row. Rows changed but none
// readable back is exactly that case, so make it loud instead.
if (rows.length === 0 && rowsAffected(written) > 0) {
throw new Error(
`updateReturning wrote ${rowsAffected(written)} row(s) but could not read ` +
`them back: the update changed a column the where clause filters on. ` +
`Read the rows first, or filter on a column the update leaves alone.`,
);
}
return rows;
});
}
export async function deleteReturning<T extends SQLiteTable>(
context: DatabaseContext,
table: T,
where: SQL,
): Promise<T["$inferSelect"][]> {
const db = context.drizzle;
if (supportsReturning(context.dialect)) {
return db.delete(table).where(where).returning() as Promise<
T["$inferSelect"][]
>;
}
return db.transaction(async (tx) => {
const rows = await tx.select().from(table).where(where);
await tx.delete(table).where(where);
return rows;
});
}
/** A table this can read a single row back from. */
type Keyed = SQLiteTable & { id: SQLiteColumn };
/**
* Inserts one row and returns it as stored, including whatever the database
* filled in defaults, an autoincrement id, a CURRENT_TIMESTAMP.
*
* This is the one case Postgres cannot shortcut either: without RETURNING there
* is no id to read back by. Hence the split is genuinely three-way except
* that sqlite and pg both have RETURNING, so it collapses to two again.
*
* On MySQL the key comes from one of two places:
*
* - the caller supplied it (tables keyed by a text id, like `users`)
* - the engine assigned it, reported as `insertId`
*
* Restricted to tables with an `id` column, so a table keyed some other way is
* a compile error here rather than a row that silently fails to come back.
*/
export async function insertReturning<T extends Keyed>(
context: DatabaseContext,
table: T,
values: T["$inferInsert"],
): Promise<T["$inferSelect"][]> {
const db = context.drizzle;
if (supportsReturning(context.dialect)) {
return db.insert(table).values(values).returning() as Promise<
T["$inferSelect"][]
>;
}
return db.transaction(async (tx) => {
const result = await tx.insert(table).values(values);
const supplied = (values as { id?: string | number }).id;
const key = supplied ?? insertedId(result);
if (key === null || key === undefined) {
throw new Error(
`Insert into ${String(table)} returned no id to read the row back by.`,
);
}
const rows = await tx.select().from(table).where(eq(table.id, key));
if (rows.length === 0) {
throw new Error(
`Inserted into ${String(table)} but could not read the row back by id ${key}.`,
);
}
return rows;
});
}
/**
* Inserts one row into a table keyed by something other than `id`, reading it
* back by an explicit condition.
*
* `user_preferences` is keyed by `userId` and has no `id` column at all, so
* there is no insertId to read back by the caller has to say what identifies
* the row it just wrote.
*/
export async function insertReturningWhere<T extends SQLiteTable>(
context: DatabaseContext,
table: T,
values: T["$inferInsert"],
where: SQL,
): Promise<T["$inferSelect"][]> {
const db = context.drizzle;
if (supportsReturning(context.dialect)) {
return db.insert(table).values(values).returning() as Promise<
T["$inferSelect"][]
>;
}
return db.transaction(async (tx) => {
await tx.insert(table).values(values);
const rows = await tx.select().from(table).where(where);
if (rows.length === 0) {
throw new Error(
`Inserted into ${String(table)} but the read-back condition matched nothing.`,
);
}
return rows;
});
}
/**
* Insert, or update the row that collides with it.
*
* The clause has three spellings. SQLite and Postgres take
* `ON CONFLICT (cols) DO UPDATE`; **MySQL takes `ON DUPLICATE KEY UPDATE` and
* names no columns** it uses whichever unique key was violated. drizzle
* follows suit, so `onConflictDoUpdate` does not exist on mysql-core at all and
* calling it is a TypeError rather than a rejected query.
*
* The conflict target still has to be passed: it is what SQLite and Postgres
* need, and stating it keeps the caller honest about which unique constraint it
* is relying on four of those were missing from the schema entirely until the
* cross-dialect tests went looking.
*/
export async function upsert<T extends SQLiteTable>(
context: DatabaseContext,
table: T,
values: T["$inferInsert"],
conflict: { target: SQLiteColumn[]; set: UpdateValues<T> },
): Promise<void> {
const db = context.drizzle;
if (context.dialect === "mysql") {
const insert = db.insert(table).values(values) as unknown as {
onDuplicateKeyUpdate: (config: { set: UpdateValues<T> }) => Promise<void>;
};
await insert.onDuplicateKeyUpdate({ set: conflict.set });
return;
}
await db
.insert(table)
.values(values)
.onConflictDoUpdate({ target: conflict.target, set: conflict.set });
}
@@ -1,6 +1,8 @@
import { and, eq, inArray } from "drizzle-orm";
import { hostAccess, roles, userRoles } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { deleteReturning, insertReturning } from "./returning.js";
export type RoleRecord = typeof roles.$inferSelect;
export type NewRoleRecord = typeof roles.$inferInsert;
@@ -62,27 +64,27 @@ export class RoleRepository {
}
async createRole(role: NewRoleRecord): Promise<number> {
const result = await this.context.drizzle.insert(roles).values(role);
const [created] = await insertReturning(this.context, roles, role);
await this.afterWrite();
return Number(result.lastInsertRowid);
return created.id;
}
async updateRole(id: number, update: RoleUpdate): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(roles)
.set(update)
.where(eq(roles.id, id))
.returning({ id: roles.id });
.where(eq(roles.id, id));
await this.afterWrite();
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteRole(id: number): Promise<{ deletedUserIds: string[] }> {
const deletedUserRoles = await this.context.drizzle
.delete(userRoles)
.where(eq(userRoles.roleId, id))
.returning({ userId: userRoles.userId });
const deletedUserRoles = await deleteReturning(
this.context,
userRoles,
eq(userRoles.roleId, id),
);
await this.context.drizzle
.delete(hostAccess)
@@ -169,16 +171,15 @@ export class RoleRepository {
}
if (removeRole) {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(userRoles)
.where(
and(
eq(userRoles.userId, input.userId),
eq(userRoles.roleId, removeRole.id),
),
)
.returning({ id: userRoles.id });
removed = rows.length > 0;
);
removed = rowsAffected(result) > 0;
}
if (added || removed) {
@@ -196,16 +197,15 @@ export class RoleRepository {
}
async removeAllRolesFromUser(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(userRoles)
.where(eq(userRoles.userId, userId))
.returning({ id: userRoles.id });
.where(eq(userRoles.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async listUserRoleIds(userId: string): Promise<number[]> {
@@ -1,6 +1,8 @@
import { and, desc, eq, inArray, lt } from "drizzle-orm";
import { hosts, sessionRecordings } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning } from "./returning.js";
export type SessionRecordingRecord = typeof sessionRecordings.$inferSelect;
@@ -47,10 +49,11 @@ export class SessionRecordingRepository {
async create(
input: SessionRecordingCreateInput,
): Promise<SessionRecordingRecord> {
const [created] = await this.context.drizzle
.insert(sessionRecordings)
.values(input)
.returning();
const [created] = await insertReturning(
this.context,
sessionRecordings,
input,
);
await this.afterWrite();
return created;
@@ -170,31 +173,29 @@ export class SessionRecordingRepository {
}
async deleteById(id: number): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessionRecordings)
.where(eq(sessionRecordings.id, id))
.returning({ id: sessionRecordings.id });
.where(eq(sessionRecordings.id, id));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteForUser(userId: string, id: number): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessionRecordings)
.where(
and(eq(sessionRecordings.id, id), eq(sessionRecordings.userId, userId)),
)
.returning({ id: sessionRecordings.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
/**
@@ -203,43 +204,40 @@ export class SessionRecordingRepository {
* file stays on disk regardless deleting only the row would orphan it.
*/
async anonymizeByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(sessionRecordings)
.set({ userId: null })
.where(eq(sessionRecordings.userId, userId))
.returning({ id: sessionRecordings.id });
.where(eq(sessionRecordings.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessionRecordings)
.where(eq(sessionRecordings.userId, userId))
.returning({ id: sessionRecordings.id });
.where(eq(sessionRecordings.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostId(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessionRecordings)
.where(eq(sessionRecordings.hostId, hostId))
.returning({ id: sessionRecordings.id });
.where(eq(sessionRecordings.hostId, hostId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostIds(hostIds: number[]): Promise<number> {
@@ -247,16 +245,15 @@ export class SessionRecordingRepository {
return 0;
}
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessionRecordings)
.where(inArray(sessionRecordings.hostId, hostIds))
.returning({ id: sessionRecordings.id });
.where(inArray(sessionRecordings.hostId, hostIds));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,8 @@
import { and, eq, lte, ne } from "drizzle-orm";
import { sessions } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning } from "./returning.js";
export type SessionRecord = typeof sessions.$inferSelect;
export type NewSessionRecord = typeof sessions.$inferInsert;
@@ -12,10 +14,7 @@ export class SessionRepository {
) {}
async create(session: NewSessionRecord): Promise<SessionRecord> {
const rows = await this.context.drizzle
.insert(sessions)
.values(session)
.returning();
const rows = await insertReturning(this.context, sessions, session);
await this.afterWrite();
return rows[0];
}
@@ -72,13 +71,12 @@ export class SessionRepository {
}
async revoke(id: string): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessions)
.where(eq(sessions.id, id))
.returning({ id: sessions.id });
.where(eq(sessions.id, id));
await this.afterWrite();
return rows.length > 0;
return rowsAffected(result) > 0;
}
async revokeAllForUser(
@@ -89,23 +87,19 @@ export class SessionRepository {
? and(eq(sessions.userId, userId), ne(sessions.id, exceptSessionId))
: eq(sessions.userId, userId);
const rows = await this.context.drizzle
.delete(sessions)
.where(where)
.returning({ id: sessions.id });
const result = await this.context.drizzle.delete(sessions).where(where);
await this.afterWrite();
return rows.length;
return rowsAffected(result);
}
async deleteExpired(now = new Date()): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessions)
.where(lte(sessions.expiresAt, now.toISOString()))
.returning({ id: sessions.id });
.where(lte(sessions.expiresAt, now.toISOString()));
await this.afterWrite();
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -6,6 +6,8 @@ import {
users,
} from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning } from "./returning.js";
export type SessionShareRecord = typeof sessionShares.$inferSelect;
export type SessionShareParticipantRecord =
@@ -49,22 +51,19 @@ export class SessionShareRepository {
) {}
async create(input: SessionShareCreateInput): Promise<SessionShareRecord> {
const [created] = await this.context.drizzle
.insert(sessionShares)
.values({
id: input.id,
hostId: input.hostId,
ownerUserId: input.ownerUserId,
protocol: input.protocol,
sessionId: input.sessionId,
tabInstanceId: input.tabInstanceId ?? null,
shareType: input.shareType,
targetUserId: input.targetUserId ?? null,
linkToken: input.linkToken ?? null,
permissionLevel: input.permissionLevel,
expiresAt: input.expiresAt,
})
.returning();
const [created] = await insertReturning(this.context, sessionShares, {
id: input.id,
hostId: input.hostId,
ownerUserId: input.ownerUserId,
protocol: input.protocol,
sessionId: input.sessionId,
tabInstanceId: input.tabInstanceId ?? null,
shareType: input.shareType,
targetUserId: input.targetUserId ?? null,
linkToken: input.linkToken ?? null,
permissionLevel: input.permissionLevel,
expiresAt: input.expiresAt,
});
await this.afterWrite();
return created;
@@ -151,7 +150,7 @@ export class SessionShareRepository {
}
async revoke(shareId: string, requestingUserId: string): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(sessionShares)
.set({ revokedAt: new Date().toISOString() })
.where(
@@ -159,38 +158,35 @@ export class SessionShareRepository {
eq(sessionShares.id, shareId),
eq(sessionShares.ownerUserId, requestingUserId),
),
)
.returning({ id: sessionShares.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async revokeAsAdmin(shareId: string): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(sessionShares)
.set({ revokedAt: new Date().toISOString() })
.where(eq(sessionShares.id, shareId))
.returning({ id: sessionShares.id });
.where(eq(sessionShares.id, shareId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteExpiredShares(now = new Date().toISOString()): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessionShares)
.where(lt(sessionShares.expiresAt, now))
.returning({ id: sessionShares.id });
.where(lt(sessionShares.expiresAt, now));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async touchShareUsage(
@@ -213,10 +209,11 @@ export class SessionShareRepository {
userId: string | null,
guestLabel: string | null,
): Promise<SessionShareParticipantRecord> {
const [created] = await this.context.drizzle
.insert(sessionShareParticipants)
.values({ shareId, userId, guestLabel })
.returning();
const [created] = await insertReturning(
this.context,
sessionShareParticipants,
{ shareId, userId, guestLabel },
);
await this.afterWrite();
return created;
}
@@ -230,15 +227,14 @@ export class SessionShareRepository {
}
async deleteSharesForHost(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sessionShares)
.where(eq(sessionShares.hostId, hostId))
.returning({ id: sessionShares.id });
.where(eq(sessionShares.hostId, hostId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -0,0 +1,52 @@
/**
* Synchronous read-through cache for the settings table.
*
* 27 call sites read settings synchronously during startup, inside request
* handlers, and from the guacd server bootstrap. On SQLite that works because
* better-sqlite3 is synchronous; on Postgres or MySQL there is no synchronous
* query at all, and making all 27 async would push `await` through code paths
* that have no business being asynchronous.
*
* Settings are a handful of low-cardinality configuration rows that change
* rarely and are read constantly, so they are cached in full. Writes go through
* SettingsRepository, which updates the cache in the same call, and the cache is
* primed once at startup.
*/
let cache: Map<string, string> | null = null;
export function isSettingsCachePrimed(): boolean {
return cache !== null;
}
/** Loads the full settings table. Called once during startup. */
export function primeSettingsCache(
rows: { key: string; value: string }[],
): void {
cache = new Map(rows.map((row) => [row.key, row.value]));
}
/**
* Reads a cached setting.
*
* Returns null both for "not set" and "cache not primed yet" every caller
* already treats a missing setting as "use the default", and startup ordering
* means a read before priming should behave the same way rather than throw.
*/
export function readCachedSetting(key: string): string | null {
return cache?.get(key) ?? null;
}
/** Keeps the cache in step with a write. */
export function updateCachedSetting(key: string, value: string): void {
cache?.set(key, value);
}
export function forgetCachedSetting(key: string): void {
cache?.delete(key);
}
/** Test seam. */
export function resetSettingsCache(): void {
cache = null;
}
@@ -1,6 +1,8 @@
import { eq, like } from "drizzle-orm";
import { settings } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { forgetCachedSetting, updateCachedSetting } from "./settings-cache.js";
import { deleteReturning } from "./returning.js";
export class SettingsRepository {
constructor(
@@ -34,6 +36,9 @@ export class SettingsRepository {
const existing = await this.get(key);
if (existing === null) {
await this.context.drizzle.insert(settings).values({ key, value });
// Kept in step here so the synchronous readers cannot observe a stale
// value after a write in the same process.
updateCachedSetting(key, value);
await this.afterWrite();
return;
}
@@ -42,6 +47,7 @@ export class SettingsRepository {
.update(settings)
.set({ value })
.where(eq(settings.key, key));
updateCachedSetting(key, value);
await this.afterWrite();
}
@@ -51,14 +57,17 @@ export class SettingsRepository {
async delete(key: string): Promise<void> {
await this.context.drizzle.delete(settings).where(eq(settings.key, key));
forgetCachedSetting(key);
await this.afterWrite();
}
async deleteLike(pattern: string): Promise<number> {
const rows = await this.context.drizzle
.delete(settings)
.where(like(settings.key, pattern))
.returning({ key: settings.key });
const rows = await deleteReturning(
this.context,
settings,
like(settings.key, pattern),
);
for (const row of rows) forgetCachedSetting(row.key);
await this.afterWrite();
return rows.length;
}
@@ -1,6 +1,7 @@
import { and, eq, inArray, or } from "drizzle-orm";
import { hostAccess, hosts, sharedHostSecrets } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
export type SharedHostSecretRecord = typeof sharedHostSecrets.$inferSelect;
export type NewSharedHostSecretRecord = typeof sharedHostSecrets.$inferInsert;
@@ -108,16 +109,15 @@ export class SharedHostSecretsRepository {
}
async deleteByHostAccessId(hostAccessId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sharedHostSecrets)
.where(eq(sharedHostSecrets.hostAccessId, hostAccessId))
.returning({ id: sharedHostSecrets.id });
.where(eq(sharedHostSecrets.hostAccessId, hostAccessId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteForRoleMember(
@@ -148,29 +148,27 @@ export class SharedHostSecretsRepository {
}
async deleteByOriginalCredentialId(credentialId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sharedHostSecrets)
.where(eq(sharedHostSecrets.originalCredentialId, credentialId))
.returning({ id: sharedHostSecrets.id });
.where(eq(sharedHostSecrets.originalCredentialId, credentialId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByTargetUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sharedHostSecrets)
.where(eq(sharedHostSecrets.targetUserId, userId))
.returning({ id: sharedHostSecrets.id });
.where(eq(sharedHostSecrets.targetUserId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async findHostIdsReferencingCredential(
@@ -2,6 +2,12 @@ import { and, asc, eq, sql } from "drizzle-orm";
import { randomUUID } from "crypto";
import { snippetFolders, snippets } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import {
deleteReturning,
insertReturning,
updateReturning,
} from "./returning.js";
export type SnippetRecord = typeof snippets.$inferSelect;
export type SnippetFolderRecord = typeof snippetFolders.$inferSelect;
@@ -84,11 +90,16 @@ export class SnippetRepository {
}
async listSnippetsForExport(userId: string): Promise<SnippetRecord[]> {
return this.context.drizzle
.select()
.from(snippets)
.where(eq(snippets.userId, userId))
.orderBy(asc(snippets.folder), asc(snippets.order));
return (
this.context.drizzle
.select()
.from(snippets)
.where(eq(snippets.userId, userId))
// coalesce, not asc(folder): folder is nullable, and NULLs sort first on
// SQLite and MySQL but last on Postgres. An export whose row order depends
// on the engine is not much of an export.
.orderBy(sql`coalesce(${snippets.folder}, '')`, asc(snippets.order))
);
}
async listFoldersForExport(userId: string): Promise<SnippetFolderRecord[]> {
@@ -149,19 +160,16 @@ export class SnippetRepository {
? await this.nextOrderForFolder(userId, folderValue)
: input.order;
const rows = await this.context.drizzle
.insert(snippets)
.values({
syncId: randomUUID(),
userId,
name: input.name.trim(),
content: input.content.trim(),
description: input.description?.trim() || null,
folder: input.folder?.trim() || null,
order,
hostFilter: input.hostFilter ? JSON.stringify(input.hostFilter) : null,
})
.returning();
const rows = await insertReturning(this.context, snippets, {
syncId: randomUUID(),
userId,
name: input.name.trim(),
content: input.content.trim(),
description: input.description?.trim() || null,
folder: input.folder?.trim() || null,
order,
hostFilter: input.hostFilter ? JSON.stringify(input.hostFilter) : null,
});
await this.afterWrite();
return rows[0];
@@ -200,11 +208,12 @@ export class SnippetRepository {
? JSON.stringify(input.hostFilter)
: null;
const rows = await this.context.drizzle
.update(snippets)
.set(updateFields)
.where(and(eq(snippets.id, snippetId), eq(snippets.userId, userId)))
.returning();
const rows = await updateReturning(
this.context,
snippets,
updateFields,
and(eq(snippets.id, snippetId), eq(snippets.userId, userId)),
);
await this.afterWrite();
return { existing, updated: rows[0] };
@@ -229,23 +238,21 @@ export class SnippetRepository {
snippetsDeleted: number;
foldersDeleted: number;
}> {
const deletedSnippets = await this.context.drizzle
const snippetResult = await this.context.drizzle
.delete(snippets)
.where(eq(snippets.userId, userId))
.returning({ id: snippets.id });
.where(eq(snippets.userId, userId));
const deletedFolders = await this.context.drizzle
const result = await this.context.drizzle
.delete(snippetFolders)
.where(eq(snippetFolders.userId, userId))
.returning({ id: snippetFolders.id });
.where(eq(snippetFolders.userId, userId));
if (deletedSnippets.length > 0 || deletedFolders.length > 0) {
if (rowsAffected(snippetResult) > 0 || rowsAffected(result) > 0) {
await this.afterWrite();
}
return {
snippetsDeleted: deletedSnippets.length,
foldersDeleted: deletedFolders.length,
snippetsDeleted: rowsAffected(snippetResult),
foldersDeleted: rowsAffected(result),
};
}
@@ -377,16 +384,13 @@ export class SnippetRepository {
const existing = await this.findFolderByName(userId, name);
if (existing) return null;
const rows = await this.context.drizzle
.insert(snippetFolders)
.values({
syncId: randomUUID(),
userId,
name: name.trim(),
color: color?.trim() || null,
icon: icon?.trim() || null,
})
.returning();
const rows = await insertReturning(this.context, snippetFolders, {
syncId: randomUUID(),
userId,
name: name.trim(),
color: color?.trim() || null,
icon: icon?.trim() || null,
});
if (triggerSave) {
await this.afterWrite();
@@ -414,13 +418,12 @@ export class SnippetRepository {
if (color !== undefined) updateFields.color = color?.trim() || null;
if (icon !== undefined) updateFields.icon = icon?.trim() || null;
const rows = await this.context.drizzle
.update(snippetFolders)
.set(updateFields)
.where(
and(eq(snippetFolders.userId, userId), eq(snippetFolders.name, name)),
)
.returning();
const rows = await updateReturning(
this.context,
snippetFolders,
updateFields,
and(eq(snippetFolders.userId, userId), eq(snippetFolders.name, name)),
);
await this.afterWrite();
return rows[0] ?? null;
@@ -465,15 +468,14 @@ export class SnippetRepository {
.set({ folder: null })
.where(and(eq(snippets.userId, userId), eq(snippets.folder, name)));
const rows = await this.context.drizzle
.delete(snippetFolders)
.where(
and(eq(snippetFolders.userId, userId), eq(snippetFolders.name, name)),
)
.returning({ syncId: snippetFolders.syncId });
const rows = await deleteReturning(
this.context,
snippetFolders,
and(eq(snippetFolders.userId, userId), eq(snippetFolders.name, name)),
);
await this.afterWrite();
return rows[0] ?? null;
return rows[0] ? { syncId: rows[0].syncId } : null;
}
private async findFolderByName(
@@ -1,4 +1,5 @@
import { getCurrentRepositorySqlite } from "./factory.js";
import { needsExplicitPersist, resolveDatabaseDialect } from "../db/dialect.js";
export interface SqliteForeignKeyClient {
exec(sql: string): unknown;
@@ -16,8 +17,28 @@ export async function withSqliteForeignKeysDisabled<T>(
}
}
/**
* Runs a bulk import with foreign keys relaxed.
*
* Backup restore writes tables in an order that is not dependency-safe, so the
* constraints have to stand down for the duration.
*
* **This has no equivalent on Postgres or MySQL here.** Postgres needs
* superuser to disable triggers, and MySQL's `SET FOREIGN_KEY_CHECKS = 0` is
* per-connection, which a pool does not guarantee. Rather than run the import
* with constraints enforced and have it fail partway through leaving a
* half-restored database it refuses with a message that says why.
*/
export async function withCurrentSqliteForeignKeysDisabled<T>(
operation: () => Promise<T>,
): Promise<T> {
const dialect = resolveDatabaseDialect();
if (!needsExplicitPersist(dialect)) {
throw new Error(
`Importing a backup is only supported on SQLite; this deployment uses ${dialect}. ` +
`Restore into the database directly with its own tooling instead.`,
);
}
return withSqliteForeignKeysDisabled(getCurrentRepositorySqlite(), operation);
}
@@ -1,6 +1,8 @@
import { eq, inArray } from "drizzle-orm";
import { sshCredentialUsage } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning } from "./returning.js";
export type SshCredentialUsageRecord = typeof sshCredentialUsage.$inferSelect;
@@ -22,38 +24,37 @@ export class SshCredentialUsageRepository {
hostId: number,
userId: string,
): Promise<SshCredentialUsageRecord> {
const [created] = await this.context.drizzle
.insert(sshCredentialUsage)
.values({ credentialId, hostId, userId })
.returning();
const [created] = await insertReturning(this.context, sshCredentialUsage, {
credentialId,
hostId,
userId,
});
await this.afterWrite();
return created;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sshCredentialUsage)
.where(eq(sshCredentialUsage.userId, userId))
.returning({ id: sshCredentialUsage.id });
.where(eq(sshCredentialUsage.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostId(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sshCredentialUsage)
.where(eq(sshCredentialUsage.hostId, hostId))
.returning({ id: sshCredentialUsage.id });
.where(eq(sshCredentialUsage.hostId, hostId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostIds(hostIds: number[]): Promise<number> {
@@ -61,16 +62,15 @@ export class SshCredentialUsageRepository {
return 0;
}
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(sshCredentialUsage)
.where(inArray(sshCredentialUsage.hostId, hostIds))
.returning({ id: sshCredentialUsage.id });
.where(inArray(sshCredentialUsage.hostId, hostIds));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,8 @@
import { asc, eq } from "drizzle-orm";
import { ssoProviders, users } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning, updateReturning } from "./returning.js";
export type SsoProviderRecord = typeof ssoProviders.$inferSelect;
export type NewSsoProviderRecord = typeof ssoProviders.$inferInsert;
@@ -76,10 +78,7 @@ export class SsoProviderRepository {
}
async create(provider: NewSsoProviderRecord): Promise<SsoProviderRecord> {
const rows = await this.context.drizzle
.insert(ssoProviders)
.values(provider)
.returning();
const rows = await insertReturning(this.context, ssoProviders, provider);
await this.afterWrite();
return rows[0];
@@ -89,27 +88,27 @@ export class SsoProviderRepository {
id: number,
update: SsoProviderUpdate,
): Promise<SsoProviderRecord | null> {
const rows = await this.context.drizzle
.update(ssoProviders)
.set(update)
.where(eq(ssoProviders.id, id))
.returning();
const rows = await updateReturning(
this.context,
ssoProviders,
update,
eq(ssoProviders.id, id),
);
await this.afterWrite();
return rows[0] ?? null;
}
async delete(id: number): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(ssoProviders)
.where(eq(ssoProviders.id, id))
.returning({ id: ssoProviders.id });
.where(eq(ssoProviders.id, id));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async countUsersByProviderId(providerId: number): Promise<number> {
@@ -2,6 +2,12 @@ import { eq } from "drizzle-orm";
import { termixIdentityCa } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { DataCrypto } from "../../utils/data-crypto.js";
import {
insertedId,
rowsAffected,
supportsReturning,
} from "./mutation-result.js";
import { updateReturning } from "./returning.js";
export type TermixIdentityCaRecord = typeof termixIdentityCa.$inferSelect;
export type NewTermixIdentityCaRecord = typeof termixIdentityCa.$inferInsert;
@@ -54,27 +60,7 @@ export class TermixIdentityCaRepository {
ca: NewTermixIdentityCaRecord,
): Promise<TermixIdentityCaRecord> {
const userDataKey = DataCrypto.validateUserAccess(userId);
const result = this.context.drizzle.transaction((tx) => {
const inserted = tx
.insert(termixIdentityCa)
.values({ ...ca, privateKey: "" })
.returning()
.all();
const row = inserted[0];
const encrypted = DataCrypto.encryptRecord(
"termix_identity_ca",
{ id: row.id, privateKey: ca.privateKey },
userId,
userDataKey,
);
return tx
.update(termixIdentityCa)
.set({ privateKey: encrypted.privateKey })
.where(eq(termixIdentityCa.id, row.id))
.returning()
.all()[0];
});
const result = await this.insertThenEncrypt(userId, ca, userDataKey);
await this.afterWrite();
return DataCrypto.decryptRecord(
@@ -85,6 +71,81 @@ export class TermixIdentityCaRepository {
);
}
/**
* Writes a CA in two steps, because the ciphertext depends on the id.
*
* The private key is encrypted with the row's own id as context, which does
* not exist until the row does. So: insert with an empty key, encrypt, update.
* The empty key must never be observable, hence the transaction.
*
* Two branches because better-sqlite3 rejects an async transaction callback
* see the same note in UserRepository.
*/
private async insertThenEncrypt(
userId: string,
ca: NewTermixIdentityCaRecord,
userDataKey: Buffer,
): Promise<TermixIdentityCaRecord> {
const draft = { ...ca, privateKey: "" };
const seal = (id: number) =>
DataCrypto.encryptRecord(
"termix_identity_ca",
{ id, privateKey: ca.privateKey },
userId,
userDataKey,
).privateKey;
if (this.context.dialect === "sqlite") {
/* eslint-disable no-restricted-syntax -- sqlite-only branch: the dialect
is checked directly above, and better-sqlite3 needs the synchronous
.all() form, which has no async equivalent. */
return this.context.drizzle.transaction((tx) => {
const row = tx
.insert(termixIdentityCa)
.values(draft)
.returning()
.all()[0];
return tx
.update(termixIdentityCa)
.set({ privateKey: seal(row.id) })
.where(eq(termixIdentityCa.id, row.id))
.returning()
.all()[0];
});
/* eslint-enable no-restricted-syntax */
}
return this.context.drizzle.transaction(async (tx) => {
let id: number | null;
if (supportsReturning(this.context.dialect)) {
// eslint-disable-next-line no-restricted-syntax -- guarded by the check above
const rows = await tx
.insert(termixIdentityCa)
.values(draft)
.returning();
id = rows[0]?.id ?? null;
} else {
id = insertedId(await tx.insert(termixIdentityCa).values(draft));
}
if (id === null) {
throw new Error("Insert into termix_identity_ca returned no id.");
}
await tx
.update(termixIdentityCa)
.set({ privateKey: seal(id) })
.where(eq(termixIdentityCa.id, id));
const [row] = await tx
.select()
.from(termixIdentityCa)
.where(eq(termixIdentityCa.id, id));
return row;
});
}
async updateEncryptedForIdentity(
userId: string,
identityId: number,
@@ -103,43 +164,42 @@ export class TermixIdentityCaRepository {
).privateKey
: undefined;
const rows = await this.context.drizzle
.update(termixIdentityCa)
.set({
const rows = await updateReturning(
this.context,
termixIdentityCa,
{
...update,
...(encryptedPrivateKey ? { privateKey: encryptedPrivateKey } : {}),
})
.where(eq(termixIdentityCa.identityId, identityId))
.returning();
},
eq(termixIdentityCa.identityId, identityId),
);
await this.afterWrite();
return this.decryptOne(rows[0] ?? null, userId);
}
async deleteByIdentityId(identityId: number): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(termixIdentityCa)
.where(eq(termixIdentityCa.identityId, identityId))
.returning({ id: termixIdentityCa.id });
.where(eq(termixIdentityCa.identityId, identityId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(termixIdentityCa)
.where(eq(termixIdentityCa.userId, userId))
.returning({ id: termixIdentityCa.id });
.where(eq(termixIdentityCa.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private decryptOne<T extends Record<string, unknown>>(
@@ -1,6 +1,8 @@
import { and, asc, eq } from "drizzle-orm";
import { termixIdentities, termixIdentityKeys } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning, updateReturning } from "./returning.js";
export type TermixIdentityRecord = typeof termixIdentities.$inferSelect;
export type NewTermixIdentityRecord = typeof termixIdentities.$inferInsert;
@@ -57,10 +59,11 @@ export class TermixIdentityRepository {
async createIdentity(
identity: NewTermixIdentityRecord,
): Promise<TermixIdentityRecord> {
const rows = await this.context.drizzle
.insert(termixIdentities)
.values(identity)
.returning();
const rows = await insertReturning(
this.context,
termixIdentities,
identity,
);
await this.afterWrite();
return rows[0];
@@ -70,11 +73,12 @@ export class TermixIdentityRepository {
userId: string,
update: TermixIdentityUpdate,
): Promise<TermixIdentityRecord | null> {
const rows = await this.context.drizzle
.update(termixIdentities)
.set(update)
.where(eq(termixIdentities.userId, userId))
.returning();
const rows = await updateReturning(
this.context,
termixIdentities,
update,
eq(termixIdentities.userId, userId),
);
if (rows.length > 0) {
await this.afterWrite();
@@ -84,39 +88,36 @@ export class TermixIdentityRepository {
}
async deleteIdentityForUser(userId: string): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(termixIdentities)
.where(eq(termixIdentities.userId, userId))
.returning({ id: termixIdentities.id });
.where(eq(termixIdentities.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteByUserId(userId: string): Promise<{
identitiesDeleted: number;
keysDeleted: number;
}> {
const keyRows = await this.context.drizzle
const keyResult = await this.context.drizzle
.delete(termixIdentityKeys)
.where(eq(termixIdentityKeys.userId, userId))
.returning({ id: termixIdentityKeys.id });
.where(eq(termixIdentityKeys.userId, userId));
const identityRows = await this.context.drizzle
const result = await this.context.drizzle
.delete(termixIdentities)
.where(eq(termixIdentities.userId, userId))
.returning({ id: termixIdentities.id });
.where(eq(termixIdentities.userId, userId));
if (keyRows.length > 0 || identityRows.length > 0) {
if (rowsAffected(keyResult) > 0 || rowsAffected(result) > 0) {
await this.afterWrite();
}
return {
identitiesDeleted: identityRows.length,
keysDeleted: keyRows.length,
identitiesDeleted: rowsAffected(result),
keysDeleted: rowsAffected(keyResult),
};
}
@@ -170,10 +171,7 @@ export class TermixIdentityRepository {
async createKey(
key: NewTermixIdentityKeyRecord,
): Promise<TermixIdentityKeyRecord> {
const rows = await this.context.drizzle
.insert(termixIdentityKeys)
.values(key)
.returning();
const rows = await insertReturning(this.context, termixIdentityKeys, key);
await this.afterWrite();
return rows[0];
@@ -184,16 +182,12 @@ export class TermixIdentityRepository {
id: number,
update: TermixIdentityKeyUpdate,
): Promise<TermixIdentityKeyRecord | null> {
const rows = await this.context.drizzle
.update(termixIdentityKeys)
.set(update)
.where(
and(
eq(termixIdentityKeys.id, id),
eq(termixIdentityKeys.userId, userId),
),
)
.returning();
const rows = await updateReturning(
this.context,
termixIdentityKeys,
update,
and(eq(termixIdentityKeys.id, id), eq(termixIdentityKeys.userId, userId)),
);
if (rows.length > 0) {
await this.afterWrite();
@@ -203,21 +197,20 @@ export class TermixIdentityRepository {
}
async deleteKeyForUser(userId: string, id: number): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(termixIdentityKeys)
.where(
and(
eq(termixIdentityKeys.id, id),
eq(termixIdentityKeys.userId, userId),
),
)
.returning({ id: termixIdentityKeys.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async findKeyForUser(
@@ -1,6 +1,7 @@
import { and, eq } from "drizzle-orm";
import { tmuxSessionTags } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
export type TmuxSessionTagRecord = typeof tmuxSessionTags.$inferSelect;
@@ -45,7 +46,7 @@ export class TmuxSessionTagRepository {
sessionName: string,
newSessionName: string,
): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(tmuxSessionTags)
.set({ sessionName: newSessionName })
.where(
@@ -53,35 +54,33 @@ export class TmuxSessionTagRepository {
eq(tmuxSessionTags.hostId, hostId),
eq(tmuxSessionTags.sessionName, sessionName),
),
)
.returning({ id: tmuxSessionTags.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteSessionForHost(
hostId: number,
sessionName: string,
): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(tmuxSessionTags)
.where(
and(
eq(tmuxSessionTags.hostId, hostId),
eq(tmuxSessionTags.sessionName, sessionName),
),
)
.returning({ id: tmuxSessionTags.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async replaceForUserHostSession(
@@ -90,7 +89,7 @@ export class TmuxSessionTagRepository {
sessionName: string,
tags: string[],
): Promise<number> {
const deletedRows = await this.context.drizzle
const result = await this.context.drizzle
.delete(tmuxSessionTags)
.where(
and(
@@ -98,8 +97,7 @@ export class TmuxSessionTagRepository {
eq(tmuxSessionTags.hostId, hostId),
eq(tmuxSessionTags.sessionName, sessionName),
),
)
.returning({ id: tmuxSessionTags.id });
);
if (tags.length > 0) {
await this.context.drizzle.insert(tmuxSessionTags).values(
@@ -112,7 +110,7 @@ export class TmuxSessionTagRepository {
);
}
const changedRows = deletedRows.length + tags.length;
const changedRows = rowsAffected(result) + tags.length;
if (changedRows > 0) {
await this.afterWrite();
}
@@ -121,16 +119,15 @@ export class TmuxSessionTagRepository {
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(tmuxSessionTags)
.where(eq(tmuxSessionTags.userId, userId))
.returning({ id: tmuxSessionTags.id });
.where(eq(tmuxSessionTags.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,7 @@
import { and, desc, eq, inArray, or } from "drizzle-orm";
import { transferRecent } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
export type TransferRecentRecord = typeof transferRecent.$inferSelect;
@@ -100,47 +101,44 @@ export class TransferRecentRepository {
return 0;
}
const deleted = await this.context.drizzle
const result = await this.context.drizzle
.delete(transferRecent)
.where(inArray(transferRecent.id, idsToDelete))
.returning({ id: transferRecent.id });
.where(inArray(transferRecent.id, idsToDelete));
if (deleted.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return deleted.length;
return rowsAffected(result);
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(transferRecent)
.where(eq(transferRecent.userId, userId))
.returning({ id: transferRecent.id });
.where(eq(transferRecent.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostId(hostId: number): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(transferRecent)
.where(
or(
eq(transferRecent.sourceHostId, hostId),
eq(transferRecent.destHostId, hostId),
),
)
.returning({ id: transferRecent.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
async deleteByHostIds(hostIds: number[]): Promise<number> {
@@ -148,21 +146,20 @@ export class TransferRecentRepository {
return 0;
}
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(transferRecent)
.where(
or(
inArray(transferRecent.sourceHostId, hostIds),
inArray(transferRecent.destHostId, hostIds),
),
)
.returning({ id: transferRecent.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,8 @@
import { eq } from "drizzle-orm";
import { userPreferences } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturningWhere, updateReturning } from "./returning.js";
export type UserPreferenceRecord = typeof userPreferences.$inferSelect;
export type NewUserPreferenceRecord = typeof userPreferences.$inferInsert;
@@ -31,34 +33,36 @@ export class UserPreferenceRepository {
const existing = await this.findByUserId(userId);
if (!existing) {
const rows = await this.context.drizzle
.insert(userPreferences)
.values({ userId, ...update })
.returning();
const rows = await insertReturningWhere(
this.context,
userPreferences,
{ userId, ...update },
eq(userPreferences.userId, userId),
);
await this.afterWrite();
return rows[0];
}
const rows = await this.context.drizzle
.update(userPreferences)
.set(update)
.where(eq(userPreferences.userId, userId))
.returning();
const rows = await updateReturning(
this.context,
userPreferences,
update,
eq(userPreferences.userId, userId),
);
await this.afterWrite();
return rows[0];
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(userPreferences)
.where(eq(userPreferences.userId, userId))
.returning({ userId: userPreferences.userId });
.where(eq(userPreferences.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,8 @@
import { eq, inArray } from "drizzle-orm";
import { users } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected, supportsReturning } from "./mutation-result.js";
import { insertReturning, updateReturning } from "./returning.js";
export type UserRecord = typeof users.$inferSelect;
export type NewUserRecord = typeof users.$inferInsert;
@@ -62,10 +64,7 @@ export class UserRepository {
}
async create(user: NewUserRecord): Promise<UserRecord> {
const rows = await this.context.drizzle
.insert(users)
.values(user)
.returning();
const rows = await insertReturning(this.context, users, user);
await this.afterWrite();
return rows[0];
}
@@ -73,17 +72,10 @@ export class UserRepository {
async createFirstLocalUser(
user: NewFirstLocalUserRecord,
): Promise<{ user: UserRecord; isFirstUser: boolean }> {
const result = this.context.drizzle.transaction((tx) => {
const existingUsers = tx.select({ id: users.id }).from(users).all();
const isFirstUser = existingUsers.length === 0;
const rows = tx
.insert(users)
.values({ ...user, isAdmin: isFirstUser })
.returning()
.all();
return { user: rows[0], isFirstUser };
});
const result = await this.createCheckingIfFirst((isFirstUser) => ({
...user,
isAdmin: isFirstUser,
}));
await this.afterWrite();
return result;
@@ -92,41 +84,87 @@ export class UserRepository {
async createFirstSsoUser(
user: NewUserRecord,
): Promise<{ user: UserRecord; isFirstUser: boolean }> {
const result = this.context.drizzle.transaction((tx) => {
const existingUsers = tx.select({ id: users.id }).from(users).all();
const isFirstUser = existingUsers.length === 0;
const rows = tx
.insert(users)
.values({ ...user, isAdmin: isFirstUser || Boolean(user.isAdmin) })
.returning()
.all();
return { user: rows[0], isFirstUser };
});
const result = await this.createCheckingIfFirst((isFirstUser) => ({
...user,
isAdmin: isFirstUser || Boolean(user.isAdmin),
}));
await this.afterWrite();
return result;
}
/**
* Creates a user, making them an admin if the table was empty.
*
* The check and the insert have to be one transaction: two people signing up
* at once would otherwise both see an empty table and both become admin.
*
* The two branches are not a style choice. better-sqlite3 is synchronous and
* rejects an async transaction callback outright "Transaction function
* cannot return a promise" so a single body cannot serve both. It fails
* loudly rather than silently skipping the write, which is the one mercy here.
*/
private async createCheckingIfFirst(
build: (isFirstUser: boolean) => NewUserRecord,
): Promise<{ user: UserRecord; isFirstUser: boolean }> {
if (this.context.dialect === "sqlite") {
/* eslint-disable no-restricted-syntax -- sqlite-only branch: the dialect
is checked directly above, and better-sqlite3 rejects an async
transaction callback, so this cannot use the shared helpers. */
return this.context.drizzle.transaction((tx) => {
const isFirstUser =
tx.select({ id: users.id }).from(users).all().length === 0;
const rows = tx
.insert(users)
.values(build(isFirstUser))
.returning()
.all();
return { user: rows[0], isFirstUser };
});
/* eslint-enable no-restricted-syntax */
}
return this.context.drizzle.transaction(async (tx) => {
const existing = await tx.select({ id: users.id }).from(users);
const isFirstUser = existing.length === 0;
const values = build(isFirstUser);
if (supportsReturning(this.context.dialect)) {
// eslint-disable-next-line no-restricted-syntax -- guarded by the check on this line
const rows = await tx.insert(users).values(values).returning();
return { user: rows[0], isFirstUser };
}
// users is keyed by a text id the caller supplies, so there is something
// to read back by even without RETURNING.
await tx.insert(users).values(values);
const [user] = await tx
.select()
.from(users)
.where(eq(users.id, values.id));
return { user, isFirstUser };
});
}
async update(id: string, update: UserUpdate): Promise<UserRecord | null> {
const rows = await this.context.drizzle
.update(users)
.set(update)
.where(eq(users.id, id))
.returning();
const rows = await updateReturning(
this.context,
users,
update,
eq(users.id, id),
);
await this.afterWrite();
return rows[0] ?? null;
}
async delete(id: string): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(users)
.where(eq(users.id, id))
.returning({ id: users.id });
.where(eq(users.id, id));
await this.afterWrite();
return rows.length > 0;
return rowsAffected(result) > 0;
}
async countAdmins(): Promise<number> {
@@ -2,6 +2,12 @@ import { desc, eq, or } from "drizzle-orm";
import { randomUUID } from "crypto";
import { vaultProfiles } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import {
deleteReturning,
insertReturning,
updateReturning,
} from "./returning.js";
export type VaultProfileRecord = typeof vaultProfiles.$inferSelect;
@@ -45,26 +51,23 @@ export class VaultProfileRepository {
}
async create(input: VaultProfileCreateInput): Promise<VaultProfileRecord> {
const [created] = await this.context.drizzle
.insert(vaultProfiles)
.values({
syncId: randomUUID(),
userId: input.userId,
name: input.name,
description: input.description,
folder: input.folder,
tags: input.tags,
vaultAddr: input.vaultAddr,
vaultNamespace: input.vaultNamespace,
oidcMount: input.oidcMount,
oidcRole: input.oidcRole,
sshMount: input.sshMount,
sshRole: input.sshRole,
validPrincipals: input.validPrincipals,
keyType: input.keyType,
shared: input.shared ?? false,
})
.returning();
const [created] = await insertReturning(this.context, vaultProfiles, {
syncId: randomUUID(),
userId: input.userId,
name: input.name,
description: input.description,
folder: input.folder,
tags: input.tags,
vaultAddr: input.vaultAddr,
vaultNamespace: input.vaultNamespace,
oidcMount: input.oidcMount,
oidcRole: input.oidcRole,
sshMount: input.sshMount,
sshRole: input.sshRole,
validPrincipals: input.validPrincipals,
keyType: input.keyType,
shared: input.shared ?? false,
});
await this.afterWrite();
return created;
@@ -84,14 +87,15 @@ export class VaultProfileRepository {
id: number,
input: VaultProfileUpdateInput,
): Promise<VaultProfileRecord | null> {
const [updated] = await this.context.drizzle
.update(vaultProfiles)
.set({
const [updated] = await updateReturning(
this.context,
vaultProfiles,
{
...input,
updatedAt: input.updatedAt ?? new Date().toISOString(),
})
.where(eq(vaultProfiles.id, id))
.returning();
},
eq(vaultProfiles.id, id),
);
if (updated) {
await this.afterWrite();
@@ -101,27 +105,27 @@ export class VaultProfileRepository {
}
async deleteById(id: number): Promise<{ syncId: string | null } | null> {
const rows = await this.context.drizzle
.delete(vaultProfiles)
.where(eq(vaultProfiles.id, id))
.returning({ syncId: vaultProfiles.syncId });
const rows = await deleteReturning(
this.context,
vaultProfiles,
eq(vaultProfiles.id, id),
);
if (rows.length === 0) return null;
await this.afterWrite();
return rows[0];
return { syncId: rows[0].syncId };
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(vaultProfiles)
.where(eq(vaultProfiles.userId, userId))
.returning({ id: vaultProfiles.id });
.where(eq(vaultProfiles.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,8 @@
import { and, eq } from "drizzle-orm";
import { vaultTokens } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { upsert } from "./returning.js";
export type VaultTokenRecord = typeof vaultTokens.$inferSelect;
@@ -22,16 +24,17 @@ export class VaultTokenRepository {
async upsert(input: VaultTokenUpsertInput): Promise<void> {
const createdAt = input.createdAt ?? new Date().toISOString();
await this.context.drizzle
.insert(vaultTokens)
.values({
await upsert(
this.context,
vaultTokens,
{
userId: input.userId,
profileId: input.profileId,
sshCert: input.sshCert,
privateKey: input.privateKey,
expiresAt: input.expiresAt,
})
.onConflictDoUpdate({
},
{
target: [vaultTokens.userId, vaultTokens.profileId],
set: {
sshCert: input.sshCert,
@@ -39,7 +42,8 @@ export class VaultTokenRepository {
expiresAt: input.expiresAt,
createdAt,
},
});
},
);
await this.afterWrite();
}
@@ -67,7 +71,7 @@ export class VaultTokenRepository {
profileId: number,
lastUsed = new Date().toISOString(),
): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.update(vaultTokens)
.set({ lastUsed })
.where(
@@ -75,48 +79,45 @@ export class VaultTokenRepository {
eq(vaultTokens.userId, userId),
eq(vaultTokens.profileId, profileId),
),
)
.returning({ id: vaultTokens.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteByUserAndProfile(
userId: string,
profileId: number,
): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(vaultTokens)
.where(
and(
eq(vaultTokens.userId, userId),
eq(vaultTokens.profileId, profileId),
),
)
.returning({ id: vaultTokens.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
async deleteByUserId(userId: string): Promise<number> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(vaultTokens)
.where(eq(vaultTokens.userId, userId))
.returning({ id: vaultTokens.id });
.where(eq(vaultTokens.userId, userId));
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length;
return rowsAffected(result);
}
private async afterWrite(): Promise<void> {
@@ -1,6 +1,8 @@
import { and, eq } from "drizzle-orm";
import { webauthnCredentials } from "../db/schema.js";
import type { DatabaseContext } from "./database-context.js";
import { rowsAffected } from "./mutation-result.js";
import { insertReturning } from "./returning.js";
export type WebauthnCredentialRecord = typeof webauthnCredentials.$inferSelect;
export type NewWebauthnCredentialRecord =
@@ -41,10 +43,11 @@ export class WebauthnCredentialRepository {
async create(
record: NewWebauthnCredentialRecord,
): Promise<WebauthnCredentialRecord> {
const rows = await this.context.drizzle
.insert(webauthnCredentials)
.values(record)
.returning();
const rows = await insertReturning(
this.context,
webauthnCredentials,
record,
);
await this.afterWrite();
return rows[0];
@@ -63,21 +66,20 @@ export class WebauthnCredentialRepository {
}
async deleteForUser(userId: string, id: string): Promise<boolean> {
const rows = await this.context.drizzle
const result = await this.context.drizzle
.delete(webauthnCredentials)
.where(
and(
eq(webauthnCredentials.id, id),
eq(webauthnCredentials.userId, userId),
),
)
.returning({ id: webauthnCredentials.id });
);
if (rows.length > 0) {
if (rowsAffected(result) > 0) {
await this.afterWrite();
}
return rows.length > 0;
return rowsAffected(result) > 0;
}
private async afterWrite(): Promise<void> {
@@ -0,0 +1,78 @@
import { describe, expect, it } from "vitest";
import {
assertUrlMatchesDialect,
connectRemoteDatabase,
databaseUrl,
DATABASE_URL_ENV,
} from "../../../database/db/connect.js";
describe("databaseUrl", () => {
it("is absent unless set", () => {
expect(databaseUrl({})).toBeNull();
expect(databaseUrl({ [DATABASE_URL_ENV]: " " })).toBeNull();
});
it("trims surrounding whitespace", () => {
expect(
databaseUrl({ [DATABASE_URL_ENV]: " postgres://db/termix " }),
).toBe("postgres://db/termix");
});
});
describe("assertUrlMatchesDialect", () => {
it("accepts the schemes each engine answers to", () => {
expect(() =>
assertUrlMatchesDialect("postgres://db/termix", "postgres"),
).not.toThrow();
expect(() =>
assertUrlMatchesDialect("postgresql://db/termix", "postgres"),
).not.toThrow();
expect(() =>
assertUrlMatchesDialect("mysql://db/termix", "mysql"),
).not.toThrow();
// MariaDB speaks the MySQL protocol.
expect(() =>
assertUrlMatchesDialect("mariadb://db/termix", "mysql"),
).not.toThrow();
});
it("is case-insensitive about the scheme", () => {
expect(() =>
assertUrlMatchesDialect("POSTGRES://db/termix", "postgres"),
).not.toThrow();
});
it("catches a mismatch and says what is wrong", () => {
// The failure mode this exists to prevent: a driver error thirty frames
// down that never mentions the actual misconfiguration.
expect(() =>
assertUrlMatchesDialect("mysql://db/termix", "postgres"),
).toThrow(/is a "mysql:\/\/" URL but DATABASE_DIALECT is "postgres"/);
expect(() =>
assertUrlMatchesDialect("postgres://db/termix", "mysql"),
).toThrow(/expected one of mysql:\/\/, mariadb:\/\//i);
});
it("rejects sqlite, which does not use a URL", () => {
expect(() =>
assertUrlMatchesDialect("postgres://db/termix", "sqlite"),
).toThrow(/does not use DATABASE_URL/);
});
});
describe("connectRemoteDatabase", () => {
it("refuses to connect without a URL, naming the variable", () => {
return expect(connectRemoteDatabase("postgres", {})).rejects.toThrow(
/DATABASE_URL must be set when DATABASE_DIALECT is "postgres"/,
);
});
it("rejects a mismatched URL before opening a connection", () => {
return expect(
connectRemoteDatabase("postgres", {
[DATABASE_URL_ENV]: "mysql://db/termix",
}),
).rejects.toThrow(/DATABASE_DIALECT is "postgres"/);
});
});
@@ -0,0 +1,39 @@
import path from "path";
import { describe, expect, it } from "vitest";
import {
migrationsFolder,
runRemoteMigrations,
MIGRATIONS_DIR_ENV,
} from "../../../database/db/migrate.js";
describe("migrationsFolder", () => {
it("gives each engine its own folder", () => {
// The generated SQL differs per dialect, so they cannot share one.
expect(migrationsFolder("postgres", {})).toBe(
path.resolve(process.cwd(), "drizzle", "postgres"),
);
expect(migrationsFolder("mysql", {})).toBe(
path.resolve(process.cwd(), "drizzle", "mysql"),
);
});
it("honours an explicit root", () => {
expect(
migrationsFolder("postgres", { [MIGRATIONS_DIR_ENV]: "/srv/migrations" }),
).toBe(path.join("/srv/migrations", "postgres"));
});
it("ignores a blank override", () => {
expect(migrationsFolder("mysql", { [MIGRATIONS_DIR_ENV]: " " })).toBe(
path.resolve(process.cwd(), "drizzle", "mysql"),
);
});
});
describe("runRemoteMigrations", () => {
it("refuses sqlite, which builds its schema elsewhere", () => {
return expect(
runRemoteMigrations("sqlite", {} as never),
).rejects.toThrow(/SQLite builds its schema in index.ts/);
});
});
@@ -0,0 +1,223 @@
import { describe, expect, it } from "vitest";
import { eq } from "drizzle-orm";
import { drizzle as sqliteDrizzle } from "drizzle-orm/better-sqlite3";
import { drizzle as pgDrizzle } from "drizzle-orm/node-postgres";
import { drizzle as mysqlDrizzle } from "drizzle-orm/mysql2";
import { getTableConfig as sqliteTableConfig } from "drizzle-orm/sqlite-core";
import { getTableConfig as pgTableConfig } from "drizzle-orm/pg-core";
import { getTableConfig as mysqlTableConfig } from "drizzle-orm/mysql-core";
import Database from "better-sqlite3";
import * as sqliteSchema from "../../../database/db/schema.js";
import * as pgSchema from "../../../database/db/schema.pg.js";
import * as mysqlSchema from "../../../database/db/schema.mysql.js";
import {
DATABASE_DIALECT_ENV,
isDatabaseDialect,
needsExplicitPersist,
resolveDatabaseDialect,
} from "../../../database/db/dialect.js";
describe("resolveDatabaseDialect", () => {
it("defaults to sqlite so existing deployments are unaffected", () => {
expect(resolveDatabaseDialect({})).toBe("sqlite");
expect(resolveDatabaseDialect({ [DATABASE_DIALECT_ENV]: "" })).toBe(
"sqlite",
);
});
it("accepts the supported engines, case-insensitively", () => {
expect(resolveDatabaseDialect({ [DATABASE_DIALECT_ENV]: "postgres" })).toBe(
"postgres",
);
expect(resolveDatabaseDialect({ [DATABASE_DIALECT_ENV]: "MySQL" })).toBe(
"mysql",
);
});
it("refuses an unknown engine rather than silently using sqlite", () => {
expect(() =>
resolveDatabaseDialect({ [DATABASE_DIALECT_ENV]: "oracle" }),
).toThrow(/Unsupported/);
});
it("narrows correctly", () => {
expect(isDatabaseDialect("mysql")).toBe(true);
expect(isDatabaseDialect("mongo")).toBe(false);
});
});
describe("needsExplicitPersist", () => {
it("is true only for sqlite", () => {
// SQLite runs in memory and is serialised back to an encrypted file, so
// every write needs a flush. The others have already committed durably.
expect(needsExplicitPersist("sqlite")).toBe(true);
expect(needsExplicitPersist("postgres")).toBe(false);
expect(needsExplicitPersist("mysql")).toBe(false);
});
});
/**
* schema.pg.ts and schema.mysql.ts are generated from schema.ts. These check the
* generated output is usable rather than merely syntactically valid the
* repository layer's correctness rests on all three behaving the same way.
*/
describe("generated schemas", () => {
it("declares the same tables in all three dialects", () => {
const tablesOf = (schema: Record<string, unknown>) =>
Object.keys(schema).sort();
expect(tablesOf(pgSchema)).toEqual(tablesOf(sqliteSchema));
expect(tablesOf(mysqlSchema)).toEqual(tablesOf(sqliteSchema));
// Guard against a generator that silently emits nothing.
expect(tablesOf(sqliteSchema).length).toBeGreaterThan(40);
});
it("maps each column to the right storage type per dialect", () => {
expect(sqliteSchema.users.isAdmin.getSQLType()).toBe("integer");
expect(pgSchema.users.isAdmin.getSQLType()).toBe("boolean");
expect(mysqlSchema.users.isAdmin.getSQLType()).toBe("boolean");
// A primary key must be indexable, which rules out unbounded TEXT on MySQL.
expect(sqliteSchema.users.id.getSQLType()).toBe("text");
expect(pgSchema.users.id.getSQLType()).toContain("varchar");
expect(mysqlSchema.users.id.getSQLType()).toContain("varchar");
});
it("spells the autoincrement key three different ways", () => {
expect(sqliteSchema.auditLogs.id.getSQLType()).toBe("integer");
expect(pgSchema.auditLogs.id.getSQLType()).toBe("serial");
expect(mysqlSchema.auditLogs.id.getSQLType()).toBe("int");
for (const schema of [sqliteSchema, pgSchema, mysqlSchema]) {
expect(schema.auditLogs.id.primary).toBe(true);
}
});
it("preserves both foreign-key behaviours", () => {
// 80 cascade + 12 set null across the schema; set null is what keeps the
// audit trail after a user is deleted (#1132).
const perDialect = [
{ schema: sqliteSchema, config: sqliteTableConfig },
{ schema: pgSchema, config: pgTableConfig },
{ schema: mysqlSchema, config: mysqlTableConfig },
] as const;
for (const { schema, config } of perDialect) {
const read = config as (table: unknown) => {
foreignKeys: { onDelete?: string }[];
};
const auditFks = read(schema.auditLogs).foreignKeys;
expect(auditFks).toHaveLength(1);
expect(auditFks[0].onDelete).toBe("set null");
const folderFks = read(schema.sshFolders).foreignKeys;
expect(folderFks.map((fk) => fk.onDelete).sort()).toEqual([
"cascade",
"set null",
]);
}
});
it("keeps nullability and uniqueness", () => {
for (const schema of [sqliteSchema, pgSchema, mysqlSchema]) {
expect(schema.auditLogs.userId.notNull).toBe(false);
expect(schema.sshFolders.userId.notNull).toBe(true);
expect(schema.sshFolders.syncId.isUnique).toBe(true);
}
});
});
/**
* Queries are built, never executed, so no server is required. What matters is
* that identical repository-style code produces correct SQL for each engine.
*/
describe("query generation per dialect", () => {
const sqliteDb = sqliteDrizzle(new Database(":memory:"), {
schema: sqliteSchema,
});
const pgDb = pgDrizzle.mock({ schema: pgSchema });
const mysqlDb = mysqlDrizzle.mock({ schema: mysqlSchema, mode: "default" });
it("quotes identifiers the way each engine expects", () => {
const built = [
sqliteDb
.select()
.from(sqliteSchema.settings)
.where(eq(sqliteSchema.settings.key, "guac_url"))
.toSQL(),
pgDb
.select()
.from(pgSchema.settings)
.where(eq(pgSchema.settings.key, "guac_url"))
.toSQL(),
mysqlDb
.select()
.from(mysqlSchema.settings)
.where(eq(mysqlSchema.settings.key, "guac_url"))
.toSQL(),
];
expect(built[0].sql).toContain('"settings"');
expect(built[1].sql).toContain('"settings"');
expect(built[2].sql).toContain("`settings`");
// The value is parameterised either way, never inlined.
for (const sql of built) {
expect(sql.params).toEqual(["guac_url"]);
}
});
it("uses each engine's placeholder style", () => {
expect(
pgDb
.select()
.from(pgSchema.users)
.where(eq(pgSchema.users.id, "u-1"))
.toSQL().sql,
).toContain("$1");
expect(
mysqlDb
.select()
.from(mysqlSchema.users)
.where(eq(mysqlSchema.users.id, "u-1"))
.toSQL().sql,
).toContain("?");
});
it("stores booleans as the type each engine expects", () => {
const row = { id: "u-1", username: "alice", passwordHash: "hash" };
const sqliteSql = sqliteDb
.insert(sqliteSchema.users)
.values({ ...row, isAdmin: true })
.toSQL();
const pgSql = pgDb
.insert(pgSchema.users)
.values({ ...row, isAdmin: true })
.toSQL();
// The storage difference the generator exists to absorb.
expect(sqliteSql.params).toContain(1);
expect(pgSql.params).toContain(true);
});
it("round-trips on the engine that is actually wired up", () => {
const sqlite = new Database(":memory:");
sqlite.exec(
`CREATE TABLE settings (key TEXT PRIMARY KEY, value TEXT NOT NULL);`,
);
const db = sqliteDrizzle(sqlite, { schema: sqliteSchema });
db.insert(sqliteSchema.settings)
.values({ key: "guac_url", value: "guacd:4822" })
.run();
expect(db.select().from(sqliteSchema.settings).all()).toEqual([
{ key: "guac_url", value: "guacd:4822" },
]);
sqlite.close();
});
});
@@ -17,68 +17,11 @@ describe("AlertRepository", () => {
): Promise<AlertRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT,
ip TEXT NOT NULL
);
CREATE TABLE alert_rules (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER,
name TEXT NOT NULL,
enabled INTEGER NOT NULL DEFAULT 1,
trigger_type TEXT NOT NULL,
threshold_value REAL,
threshold_duration_seconds INTEGER,
cooldown_minutes INTEGER NOT NULL DEFAULT 15,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE notification_channels (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
type TEXT NOT NULL,
config TEXT NOT NULL,
enabled INTEGER NOT NULL DEFAULT 1,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE alert_rule_channels (
id INTEGER PRIMARY KEY AUTOINCREMENT,
rule_id INTEGER NOT NULL,
channel_id INTEGER NOT NULL
);
CREATE TABLE alert_firings (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
rule_id INTEGER NOT NULL,
host_id INTEGER NOT NULL,
host_name TEXT NOT NULL,
fired_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
resolved_at TEXT,
value REAL,
message TEXT NOT NULL,
severity TEXT NOT NULL DEFAULT 'warning',
acknowledged INTEGER NOT NULL DEFAULT 0
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO ssh_data (id, user_id, name, ip)
VALUES (1, 'user-1', 'alpha', '127.0.0.1');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'alpha', '127.0.0.1', 22, 'root', 'password');
`);
return new AlertRepository(context, onWrite);
@@ -17,28 +17,7 @@ describe("ApiKeyRepository", () => {
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE api_keys (
id TEXT PRIMARY KEY,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
token_hash TEXT NOT NULL,
token_prefix TEXT NOT NULL,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
expires_at TEXT,
last_used_at TEXT,
is_active INTEGER NOT NULL DEFAULT 1,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash) VALUES
('user-1', 'admin', 'hash'),
('user-2', 'target', 'hash');
@@ -17,31 +17,7 @@ describe("AuditLogRepository", () => {
): Promise<AuditLogRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE audit_logs (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT REFERENCES users(id) ON DELETE SET NULL,
username TEXT NOT NULL,
action TEXT NOT NULL,
resource_type TEXT NOT NULL,
resource_id TEXT,
resource_name TEXT,
details TEXT,
ip_address TEXT,
user_agent TEXT,
success INTEGER NOT NULL,
error_message TEXT,
timestamp TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
`);
@@ -41,23 +41,10 @@ afterEach(async () => {
async function createRepository() {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE audit_logs (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT,
username TEXT NOT NULL,
action TEXT NOT NULL,
resource_type TEXT NOT NULL,
resource_id TEXT,
resource_name TEXT,
details TEXT,
ip_address TEXT,
user_agent TEXT,
success INTEGER NOT NULL,
error_message TEXT,
timestamp TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
`);
await adapter.exec(`
INSERT INTO users (id, username, password_hash) VALUES
('u-1', 'u-1', 'hash');
`);
return new AuditLogRepository(context);
}
@@ -17,24 +17,7 @@ describe("C2sTunnelPresetRepository", () => {
): Promise<C2sTunnelPresetRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE c2s_tunnel_presets (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
config TEXT NOT NULL,
platform TEXT,
computer_name TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
`);
@@ -17,33 +17,11 @@ describe("CommandHistoryRepository", () => {
): Promise<CommandHistoryRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE command_history (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
command TEXT NOT NULL,
executed_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'one'), (2, 'user-1', 'two'), (3, 'user-2', 'other');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-1', 'two', '10.0.0.1', 22, 'root', 'password'), (3, 'user-2', 'other', '10.0.0.1', 22, 'root', 'password');
`);
return new CommandHistoryRepository(context, onWrite);
@@ -17,26 +17,7 @@ describe("DashboardServiceLinkRepository", () => {
): Promise<DashboardServiceLinkRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE dashboard_service_links (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
label TEXT NOT NULL,
url TEXT NOT NULL,
"order" INTEGER NOT NULL DEFAULT 0,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
`);
@@ -17,22 +17,7 @@ describe("DismissedAlertRepository", () => {
): Promise<DismissedAlertRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE dismissed_alerts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
alert_id TEXT NOT NULL,
dismissed_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
`);
@@ -17,50 +17,11 @@ describe("FileManagerBookmarkRepository", () => {
): Promise<FileManagerBookmarkRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE file_manager_recent (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
name TEXT NOT NULL,
path TEXT NOT NULL,
last_opened TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE file_manager_pinned (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
name TEXT NOT NULL,
path TEXT NOT NULL,
pinned_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE file_manager_shortcuts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
name TEXT NOT NULL,
path TEXT NOT NULL,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'one'), (2, 'user-1', 'two'), (3, 'user-2', 'other');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-1', 'two', '10.0.0.1', 22, 'root', 'password'), (3, 'user-2', 'other', '10.0.0.1', 22, 'root', 'password');
`);
return new FileManagerBookmarkRepository(context, onWrite);
@@ -17,25 +17,7 @@ describe("HomepageItemRepository", () => {
): Promise<HomepageItemRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE homepage_items (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
type_id TEXT NOT NULL,
title TEXT,
config TEXT NOT NULL DEFAULT '{}',
folder_id INTEGER,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
`);
@@ -17,22 +17,7 @@ describe("HomepageLayoutRepository", () => {
): Promise<HomepageLayoutRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE homepage_layouts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL UNIQUE,
layout TEXT NOT NULL DEFAULT '{}',
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
`);
@@ -1,3 +1,4 @@
import { sql } from "drizzle-orm";
import { afterEach, describe, expect, it, vi } from "vitest";
import { TestSqliteDatabase } from "./test-support.js";
import { CredentialRepository } from "../../../database/repositories/credential-repository.js";
@@ -21,174 +22,10 @@ describe("HostRepository and CredentialRepository", () => {
): Promise<{
credentials: CredentialRepository;
hosts: HostRepository;
sqlite: NonNullable<
Awaited<ReturnType<TestSqliteDatabase["connect"]>>["sqlite"]
>;
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE ssh_credentials (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
description TEXT,
folder TEXT,
tags TEXT,
auth_type TEXT NOT NULL,
username TEXT,
password TEXT,
key TEXT,
private_key TEXT,
public_key TEXT,
key_password TEXT,
key_type TEXT,
detected_key_type TEXT,
cert_public_key TEXT,
usage_count INTEGER NOT NULL DEFAULT 0,
last_used TEXT,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
connection_type TEXT NOT NULL DEFAULT 'ssh',
name TEXT,
ip TEXT NOT NULL,
port INTEGER NOT NULL,
username TEXT NOT NULL,
folder TEXT,
tags TEXT,
pin INTEGER NOT NULL DEFAULT 0,
auth_type TEXT NOT NULL,
use_warpgate INTEGER NOT NULL DEFAULT 0,
force_keyboard_interactive TEXT,
password TEXT,
key TEXT,
key_password TEXT,
key_type TEXT,
sudo_password TEXT,
autostart_password TEXT,
autostart_key TEXT,
autostart_key_password TEXT,
credential_id INTEGER,
override_credential_username INTEGER,
vault_profile_id INTEGER,
enable_terminal INTEGER NOT NULL DEFAULT 1,
enable_session_logging INTEGER NOT NULL DEFAULT 1,
allow_session_sharing INTEGER NOT NULL DEFAULT 1,
enable_command_history INTEGER NOT NULL DEFAULT 1,
enable_tunnel INTEGER NOT NULL DEFAULT 1,
tunnel_connections TEXT,
jump_hosts TEXT,
enable_file_manager INTEGER NOT NULL DEFAULT 1,
scp_legacy INTEGER NOT NULL DEFAULT 0,
enable_docker INTEGER NOT NULL DEFAULT 0,
enable_tmux_monitor INTEGER NOT NULL DEFAULT 0,
show_terminal_in_sidebar INTEGER NOT NULL DEFAULT 1,
show_file_manager_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_tunnel_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_docker_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_server_stats_in_sidebar INTEGER NOT NULL DEFAULT 0,
default_path TEXT,
stats_config TEXT,
docker_config TEXT,
enable_proxmox INTEGER NOT NULL DEFAULT 0,
proxmox_config TEXT,
terminal_config TEXT,
quick_actions TEXT,
notes TEXT,
enable_ssh INTEGER NOT NULL DEFAULT 1,
enable_rdp INTEGER NOT NULL DEFAULT 0,
enable_vnc INTEGER NOT NULL DEFAULT 0,
enable_telnet INTEGER NOT NULL DEFAULT 0,
ssh_port INTEGER DEFAULT 22,
rdp_port INTEGER DEFAULT 3389,
vnc_port INTEGER DEFAULT 5900,
telnet_port INTEGER DEFAULT 23,
rdp_credential_id INTEGER,
rdp_user TEXT,
rdp_password TEXT,
rdp_domain TEXT,
rdp_security TEXT,
rdp_ignore_cert INTEGER DEFAULT 0,
vnc_credential_id INTEGER,
vnc_password TEXT,
vnc_user TEXT,
telnet_user TEXT,
telnet_password TEXT,
telnet_credential_id INTEGER,
rdp_auth_type TEXT,
vnc_auth_type TEXT,
telnet_auth_type TEXT,
domain TEXT,
security TEXT,
ignore_cert INTEGER DEFAULT 0,
guacamole_config TEXT,
use_socks5 INTEGER,
socks5_host TEXT,
socks5_port INTEGER,
socks5_username TEXT,
socks5_password TEXT,
socks5_proxy_chain TEXT,
mac_address TEXT,
wol_broadcast_address TEXT,
port_knock_sequence TEXT,
host_key_fingerprint TEXT,
host_key_type TEXT,
host_key_algorithm TEXT DEFAULT 'sha256',
host_key_first_seen TEXT,
host_key_last_verified TEXT,
host_key_changed_count INTEGER DEFAULT 0,
connection_origin TEXT,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE,
FOREIGN KEY (credential_id) REFERENCES ssh_credentials(id) ON DELETE SET NULL
);
CREATE TABLE host_access (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_id INTEGER NOT NULL,
user_id TEXT,
role_id INTEGER,
granted_by TEXT NOT NULL,
permission_level TEXT NOT NULL DEFAULT 'view',
expires_at TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
last_accessed_at TEXT,
access_count INTEGER NOT NULL DEFAULT 0,
override_credential_id INTEGER,
FOREIGN KEY (host_id) REFERENCES ssh_data(id) ON DELETE CASCADE,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE,
FOREIGN KEY (granted_by) REFERENCES users(id) ON DELETE CASCADE,
FOREIGN KEY (override_credential_id) REFERENCES ssh_credentials(id) ON DELETE SET NULL
);
CREATE TABLE ssh_credential_usage (
id INTEGER PRIMARY KEY AUTOINCREMENT,
credential_id INTEGER NOT NULL,
host_id INTEGER NOT NULL,
user_id TEXT NOT NULL,
used_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (credential_id) REFERENCES ssh_credentials(id) ON DELETE CASCADE,
FOREIGN KEY (host_id) REFERENCES ssh_data(id) ON DELETE CASCADE,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash) VALUES
('user-1', 'user', 'hash'),
('user-2', 'other', 'hash');
@@ -197,7 +34,6 @@ describe("HostRepository and CredentialRepository", () => {
return {
credentials: new CredentialRepository(context, onCredentialWrite),
hosts: new HostRepository(context, onHostWrite),
sqlite: adapter.raw,
};
}
@@ -224,9 +60,9 @@ describe("HostRepository and CredentialRepository", () => {
// deterministically observable regardless of clock resolution --
// the sync engine's last-write-wins conflict resolution depends on
// every mutating update actually advancing this column.
repo.sqlite
.prepare("UPDATE ssh_credentials SET updated_at = ? WHERE id = ?")
.run("2000-01-01 00:00:00", created.id);
await adapter!.run(
sql`UPDATE ssh_credentials SET updated_at = ${"2000-01-01 00:00:00"} WHERE id = ${created.id}`,
);
const updated = await repo.credentials.updateForUser("user-1", created.id, {
folder: "ops",
@@ -342,23 +178,27 @@ describe("HostRepository and CredentialRepository", () => {
password: "secret",
});
const raw = repo.sqlite
.prepare("SELECT password FROM ssh_credentials WHERE id = ?")
.get(created.id) as { password: string };
const raw = (
await adapter!.query(
sql`SELECT password FROM ssh_credentials WHERE id = ${created.id}`,
)
)[0] as { password: string };
expect(raw.password).toBe("user-encrypted-password");
repo.sqlite
.prepare("UPDATE ssh_credentials SET updated_at = ? WHERE id = ?")
.run("2000-01-01 00:00:00", created.id);
await adapter!.run(
sql`UPDATE ssh_credentials SET updated_at = ${"2000-01-01 00:00:00"} WHERE id = ${created.id}`,
);
await repo.credentials.updateEncryptedForUser("user-1", created.id, {
password: "updated-secret",
});
const updatedRaw = repo.sqlite
.prepare("SELECT password, updated_at FROM ssh_credentials WHERE id = ?")
.get(created.id) as { password: string; updated_at: string };
const updatedRaw = (
await adapter!.query(
sql`SELECT password, updated_at FROM ssh_credentials WHERE id = ${created.id}`,
)
)[0] as { password: string; updated_at: string };
expect(updatedRaw.password).toBe("user-encrypted-password");
expect(updatedRaw.updated_at).not.toBe("2000-01-01 00:00:00");
@@ -410,9 +250,9 @@ describe("HostRepository and CredentialRepository", () => {
authType: "password",
folder: "prod",
});
repo.sqlite
.prepare("UPDATE ssh_credentials SET updated_at = ? WHERE id = ?")
.run("2000-01-01 00:00:00", primary.id);
await adapter!.run(
sql`UPDATE ssh_credentials SET updated_at = ${"2000-01-01 00:00:00"} WHERE id = ${primary.id}`,
);
onWrite.mockClear();
await expect(
@@ -423,9 +263,11 @@ describe("HostRepository and CredentialRepository", () => {
expect(await repo.credentials.listFolders("user-2")).toEqual(["prod"]);
expect(onWrite).toHaveBeenCalledTimes(1);
const renamedRow = repo.sqlite
.prepare("SELECT updated_at FROM ssh_credentials WHERE id = ?")
.get(primary.id) as { updated_at: string };
const renamedRow = (
await adapter!.query(
sql`SELECT updated_at FROM ssh_credentials WHERE id = ${primary.id}`,
)
)[0] as { updated_at: string };
expect(renamedRow.updated_at).not.toBe("2000-01-01 00:00:00");
});
@@ -467,9 +309,9 @@ describe("HostRepository and CredentialRepository", () => {
(await repo.hosts.listByUserId("user-1")).map((item) => item.id),
).toEqual([host.id]);
repo.sqlite
.prepare("UPDATE ssh_data SET updated_at = ? WHERE id = ?")
.run("2000-01-01 00:00:00", host.id);
await adapter!.run(
sql`UPDATE ssh_data SET updated_at = ${"2000-01-01 00:00:00"} WHERE id = ${host.id}`,
);
const updated = await repo.hosts.updateForUser("user-1", host.id, {
name: "web-1-renamed",
@@ -511,23 +353,27 @@ describe("HostRepository and CredentialRepository", () => {
password: "secret",
});
const raw = repo.sqlite
.prepare("SELECT password FROM ssh_data WHERE id = ?")
.get(created.id) as { password: string };
const raw = (
await adapter!.query(
sql`SELECT password FROM ssh_data WHERE id = ${created.id}`,
)
)[0] as { password: string };
expect(raw.password).toBe("encrypted-host-password");
repo.sqlite
.prepare("UPDATE ssh_data SET updated_at = ? WHERE id = ?")
.run("2000-01-01 00:00:00", created.id);
await adapter!.run(
sql`UPDATE ssh_data SET updated_at = ${"2000-01-01 00:00:00"} WHERE id = ${created.id}`,
);
await repo.hosts.updateEncryptedForUser("user-1", created.id, {
password: "updated-secret",
});
const updatedRaw = repo.sqlite
.prepare("SELECT password, updated_at FROM ssh_data WHERE id = ?")
.get(created.id) as { password: string; updated_at: string };
const updatedRaw = (
await adapter!.query(
sql`SELECT password, updated_at FROM ssh_data WHERE id = ${created.id}`,
)
)[0] as { password: string; updated_at: string };
expect(updatedRaw.password).toBe("encrypted-host-password");
expect(updatedRaw.updated_at).not.toBe("2000-01-01 00:00:00");
@@ -655,9 +501,9 @@ describe("HostRepository and CredentialRepository", () => {
username: "root",
authType: "password",
});
repo.sqlite
.prepare("UPDATE ssh_data SET updated_at = ? WHERE id IN (?, ?)")
.run("2000-01-01 00:00:00", first.id, second.id);
await adapter!.run(
sql`UPDATE ssh_data SET updated_at = ${"2000-01-01 00:00:00"} WHERE id IN (${first.id}, ${second.id})`,
);
onWrite.mockClear();
const states = await repo.hosts.listBulkUpdateState("user-1", [
@@ -726,11 +572,9 @@ describe("HostRepository and CredentialRepository", () => {
authType: "password",
});
repo.sqlite
.prepare(
"INSERT INTO host_access (host_id, user_id, granted_by) VALUES (?, ?, ?)",
)
.run(host.id, "user-2", "user-1");
await adapter!.run(
sql`INSERT INTO host_access (host_id, user_id, granted_by) VALUES (${host.id}, ${"user-2"}, ${"user-1"})`,
);
expect(await repo.hosts.deleteAccessForHost(host.id)).toBe(1);
expect(await repo.hosts.deleteForUser("user-1", host.id)).toEqual({
@@ -1,3 +1,4 @@
import { sql } from "drizzle-orm";
import { afterEach, describe, expect, it } from "vitest";
import { TestSqliteDatabase } from "./test-support.js";
import { HostFolderRepository } from "../../../database/repositories/host-folder-repository.js";
@@ -14,153 +15,21 @@ describe("HostFolderRepository", () => {
async function createRepository(
onWrite?: () => void | Promise<void>,
): Promise<{
repository: HostFolderRepository;
sqlite: NonNullable<
Awaited<ReturnType<TestSqliteDatabase["connect"]>>["sqlite"]
>;
}> {
): Promise<{ repository: HostFolderRepository }> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE ssh_credentials (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
folder TEXT,
auth_type TEXT NOT NULL,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
connection_type TEXT NOT NULL DEFAULT 'ssh',
name TEXT,
ip TEXT NOT NULL,
port INTEGER NOT NULL,
username TEXT NOT NULL,
folder TEXT,
tags TEXT,
pin INTEGER NOT NULL DEFAULT 0,
auth_type TEXT NOT NULL,
use_warpgate INTEGER NOT NULL DEFAULT 0,
force_keyboard_interactive TEXT,
password TEXT,
key TEXT,
key_password TEXT,
key_type TEXT,
sudo_password TEXT,
autostart_password TEXT,
autostart_key TEXT,
autostart_key_password TEXT,
credential_id INTEGER,
override_credential_username INTEGER,
vault_profile_id INTEGER,
enable_terminal INTEGER NOT NULL DEFAULT 1,
enable_session_logging INTEGER NOT NULL DEFAULT 1,
allow_session_sharing INTEGER NOT NULL DEFAULT 1,
enable_command_history INTEGER NOT NULL DEFAULT 1,
enable_tunnel INTEGER NOT NULL DEFAULT 1,
tunnel_connections TEXT,
jump_hosts TEXT,
enable_file_manager INTEGER NOT NULL DEFAULT 1,
scp_legacy INTEGER NOT NULL DEFAULT 0,
enable_docker INTEGER NOT NULL DEFAULT 0,
enable_tmux_monitor INTEGER NOT NULL DEFAULT 0,
show_terminal_in_sidebar INTEGER NOT NULL DEFAULT 1,
show_file_manager_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_tunnel_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_docker_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_server_stats_in_sidebar INTEGER NOT NULL DEFAULT 0,
default_path TEXT,
stats_config TEXT,
docker_config TEXT,
enable_proxmox INTEGER NOT NULL DEFAULT 0,
proxmox_config TEXT,
terminal_config TEXT,
quick_actions TEXT,
notes TEXT,
enable_ssh INTEGER NOT NULL DEFAULT 1,
enable_rdp INTEGER NOT NULL DEFAULT 0,
enable_vnc INTEGER NOT NULL DEFAULT 0,
enable_telnet INTEGER NOT NULL DEFAULT 0,
ssh_port INTEGER DEFAULT 22,
rdp_port INTEGER DEFAULT 3389,
vnc_port INTEGER DEFAULT 5900,
telnet_port INTEGER DEFAULT 23,
rdp_credential_id INTEGER,
rdp_user TEXT,
rdp_password TEXT,
rdp_domain TEXT,
rdp_security TEXT,
rdp_ignore_cert INTEGER DEFAULT 0,
vnc_credential_id INTEGER,
vnc_password TEXT,
vnc_user TEXT,
telnet_user TEXT,
telnet_password TEXT,
telnet_credential_id INTEGER,
rdp_auth_type TEXT,
vnc_auth_type TEXT,
telnet_auth_type TEXT,
domain TEXT,
security TEXT,
ignore_cert INTEGER DEFAULT 0,
guacamole_config TEXT,
use_socks5 INTEGER,
socks5_host TEXT,
socks5_port INTEGER,
socks5_username TEXT,
socks5_password TEXT,
socks5_proxy_chain TEXT,
mac_address TEXT,
wol_broadcast_address TEXT,
port_knock_sequence TEXT,
host_key_fingerprint TEXT,
host_key_type TEXT,
host_key_algorithm TEXT DEFAULT 'sha256',
host_key_first_seen TEXT,
host_key_last_verified TEXT,
host_key_changed_count INTEGER DEFAULT 0,
connection_origin TEXT,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE ssh_folders (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
color TEXT,
icon TEXT,
credential_id INTEGER,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO ssh_credentials (id, user_id, name, folder, auth_type, username)
VALUES (1, 'user-1', 'cred-one', 'prod', 'password', 'root'),
(2, 'user-1', 'cred-two', 'prod / api', 'password', 'root'),
(3, 'user-2', 'cred-other', 'prod', 'password', 'root');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, folder, auth_type)
VALUES
(1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'prod', 'password'),
(2, 'user-1', 'two', '10.0.0.2', 22, 'root', 'prod / api', 'password'),
(3, 'user-2', 'other', '10.0.0.3', 22, 'root', 'prod', 'password');
INSERT INTO ssh_credentials (id, user_id, name, folder, auth_type)
VALUES
(1, 'user-1', 'cred-one', 'prod', 'password'),
(2, 'user-1', 'cred-two', 'prod / api', 'password'),
(3, 'user-2', 'cred-other', 'prod', 'password');
INSERT INTO ssh_folders (id, user_id, name, color, icon)
VALUES
(1, 'user-1', 'prod', '#111111', 'server'),
@@ -168,15 +37,12 @@ describe("HostFolderRepository", () => {
(3, 'user-2', 'prod', '#333333', 'user');
`);
return {
repository: new HostFolderRepository(context, onWrite),
sqlite: adapter.raw,
};
return { repository: new HostFolderRepository(context, onWrite) };
}
it("renames folders across hosts, credentials, and folder records", async () => {
let writes = 0;
const { repository, sqlite } = await createRepository(() => {
const { repository } = await createRepository(() => {
writes += 1;
});
@@ -189,22 +55,23 @@ describe("HostFolderRepository", () => {
),
).resolves.toEqual({ updatedHosts: 2, updatedCredentials: 2 });
// Portable on purpose: the rename builds the child path with string
// concatenation, which is the one place a dialect difference shows up as
// wrong data rather than an error.
expect(
sqlite
.prepare("SELECT folder FROM ssh_data WHERE user_id = ? ORDER BY id")
.all("user-1"),
await adapter!.query(
sql`SELECT folder FROM ssh_data WHERE user_id = 'user-1' ORDER BY id`,
),
).toEqual([{ folder: "ops" }, { folder: "ops / api" }]);
expect(
sqlite
.prepare(
"SELECT folder FROM ssh_credentials WHERE user_id = ? ORDER BY id",
)
.all("user-1"),
await adapter!.query(
sql`SELECT folder FROM ssh_credentials WHERE user_id = 'user-1' ORDER BY id`,
),
).toEqual([{ folder: "ops" }, { folder: "ops / api" }]);
expect(
sqlite
.prepare("SELECT name FROM ssh_folders WHERE user_id = ? ORDER BY id")
.all("user-1"),
await adapter!.query(
sql`SELECT name FROM ssh_folders WHERE user_id = 'user-1' ORDER BY id`,
),
).toEqual([{ name: "ops" }, { name: "ops / api" }]);
expect(writes).toBe(1);
});
@@ -269,7 +136,7 @@ describe("HostFolderRepository", () => {
it("lists and deletes hosts and folder records in a folder tree", async () => {
let writes = 0;
const { repository, sqlite } = await createRepository(() => {
const { repository } = await createRepository(() => {
writes += 1;
});
@@ -278,28 +145,28 @@ describe("HostFolderRepository", () => {
await repository.deleteHostsAndFolderRecords("user-1", "prod");
expect(sqlite.prepare("SELECT id FROM ssh_data ORDER BY id").all()).toEqual(
[{ id: 3 }],
);
expect(
sqlite.prepare("SELECT id FROM ssh_folders ORDER BY id").all(),
await adapter!.query(sql`SELECT id FROM ssh_data ORDER BY id`),
).toEqual([{ id: 3 }]);
expect(
await adapter!.query(sql`SELECT id FROM ssh_folders ORDER BY id`),
).toEqual([{ id: 3 }]);
expect(writes).toBe(1);
});
it("deletes folder records for a user", async () => {
let writes = 0;
const { repository, sqlite } = await createRepository(() => {
const { repository } = await createRepository(() => {
writes += 1;
});
await expect(repository.deleteByUserId("user-1")).resolves.toBe(2);
expect(sqlite.prepare("SELECT id FROM ssh_data ORDER BY id").all()).toEqual(
[{ id: 1 }, { id: 2 }, { id: 3 }],
);
expect(
sqlite.prepare("SELECT id FROM ssh_folders ORDER BY id").all(),
await adapter!.query(sql`SELECT id FROM ssh_data ORDER BY id`),
).toEqual([{ id: 1 }, { id: 2 }, { id: 3 }]);
expect(
await adapter!.query(sql`SELECT id FROM ssh_folders ORDER BY id`),
).toEqual([{ id: 3 }]);
expect(writes).toBe(1);
});
@@ -17,44 +17,11 @@ describe("HostHealthRepository", () => {
): Promise<HostHealthRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE host_health_checks (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
checks TEXT NOT NULL,
interval_seconds INTEGER NOT NULL DEFAULT 300,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE host_health_history (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
check_id TEXT NOT NULL,
ts TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
ok INTEGER NOT NULL,
latency_ms INTEGER,
detail TEXT
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'one'), (2, 'user-2', 'two');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-2', 'two', '10.0.0.1', 22, 'root', 'password');
INSERT INTO host_health_checks (
user_id, host_id, checks, interval_seconds, created_at, updated_at
)
@@ -17,26 +17,13 @@ describe("HostMetricsHistoryRepository", () => {
): Promise<HostMetricsHistoryRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash) VALUES
('user-1', 'user-1', 'hash'),
('user-2', 'user-2', 'hash');
CREATE TABLE host_metrics_history (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_id INTEGER NOT NULL,
ts TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
cpu_percent REAL,
mem_percent REAL,
disk_percent REAL,
net_rx_bytes INTEGER,
net_tx_bytes INTEGER
);
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'one'), (2, 'user-2', 'two');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-2', 'two', '10.0.0.1', 22, 'root', 'password');
INSERT INTO host_metrics_history (
host_id, ts, cpu_percent, mem_percent, disk_percent, net_rx_bytes, net_tx_bytes
)
@@ -17,33 +17,11 @@ describe("HostMetricsPreferenceRepository", () => {
): Promise<HostMetricsPreferenceRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
stats_config TEXT
);
CREATE TABLE host_metrics_preferences (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
layout TEXT NOT NULL,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO ssh_data (id, user_id, name, stats_config)
VALUES (1, 'user-1', 'one', '{}'), (2, 'user-2', 'two', '{}');
INSERT INTO ssh_data (id, user_id, name, stats_config, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '{}', '10.0.0.1', 22, 'root', 'password'), (2, 'user-2', 'two', '{}', '10.0.0.1', 22, 'root', 'password');
INSERT INTO host_metrics_preferences (
user_id, host_id, layout, created_at, updated_at
)
@@ -27,162 +27,15 @@ describe("HostResolutionRepository", () => {
): Promise<HostResolutionRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
connection_type TEXT NOT NULL DEFAULT 'ssh',
name TEXT,
ip TEXT NOT NULL,
port INTEGER NOT NULL,
username TEXT NOT NULL,
folder TEXT,
tags TEXT,
pin INTEGER NOT NULL DEFAULT 0,
auth_type TEXT NOT NULL,
use_warpgate INTEGER NOT NULL DEFAULT 0,
force_keyboard_interactive TEXT,
password TEXT,
key TEXT,
key_password TEXT,
key_type TEXT,
sudo_password TEXT,
autostart_password TEXT,
autostart_key TEXT,
autostart_key_password TEXT,
credential_id INTEGER,
override_credential_username INTEGER,
vault_profile_id INTEGER,
enable_terminal INTEGER NOT NULL DEFAULT 1,
enable_session_logging INTEGER NOT NULL DEFAULT 1,
allow_session_sharing INTEGER NOT NULL DEFAULT 1,
enable_command_history INTEGER NOT NULL DEFAULT 1,
enable_tunnel INTEGER NOT NULL DEFAULT 1,
tunnel_connections TEXT,
jump_hosts TEXT,
enable_file_manager INTEGER NOT NULL DEFAULT 1,
scp_legacy INTEGER NOT NULL DEFAULT 0,
enable_docker INTEGER NOT NULL DEFAULT 0,
enable_tmux_monitor INTEGER NOT NULL DEFAULT 0,
show_terminal_in_sidebar INTEGER NOT NULL DEFAULT 1,
show_file_manager_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_tunnel_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_docker_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_server_stats_in_sidebar INTEGER NOT NULL DEFAULT 0,
default_path TEXT,
stats_config TEXT,
docker_config TEXT,
enable_proxmox INTEGER NOT NULL DEFAULT 0,
proxmox_config TEXT,
terminal_config TEXT,
quick_actions TEXT,
notes TEXT,
enable_ssh INTEGER NOT NULL DEFAULT 1,
enable_rdp INTEGER NOT NULL DEFAULT 0,
enable_vnc INTEGER NOT NULL DEFAULT 0,
enable_telnet INTEGER NOT NULL DEFAULT 0,
ssh_port INTEGER DEFAULT 22,
rdp_port INTEGER DEFAULT 3389,
vnc_port INTEGER DEFAULT 5900,
telnet_port INTEGER DEFAULT 23,
rdp_credential_id INTEGER,
rdp_user TEXT,
rdp_password TEXT,
rdp_domain TEXT,
rdp_security TEXT,
rdp_ignore_cert INTEGER DEFAULT 0,
vnc_credential_id INTEGER,
vnc_password TEXT,
vnc_user TEXT,
telnet_user TEXT,
telnet_password TEXT,
telnet_credential_id INTEGER,
rdp_auth_type TEXT,
vnc_auth_type TEXT,
telnet_auth_type TEXT,
domain TEXT,
security TEXT,
ignore_cert INTEGER DEFAULT 0,
guacamole_config TEXT,
use_socks5 INTEGER,
socks5_host TEXT,
socks5_port INTEGER,
socks5_username TEXT,
socks5_password TEXT,
socks5_proxy_chain TEXT,
mac_address TEXT,
wol_broadcast_address TEXT,
port_knock_sequence TEXT,
host_key_fingerprint TEXT,
host_key_type TEXT,
host_key_algorithm TEXT DEFAULT 'sha256',
host_key_first_seen TEXT,
host_key_last_verified TEXT,
host_key_changed_count INTEGER DEFAULT 0,
connection_origin TEXT,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE ssh_credentials (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
description TEXT,
folder TEXT,
tags TEXT,
auth_type TEXT NOT NULL,
username TEXT,
password TEXT,
key TEXT,
private_key TEXT,
public_key TEXT,
key_password TEXT,
key_type TEXT,
detected_key_type TEXT,
cert_public_key TEXT,
usage_count INTEGER NOT NULL DEFAULT 0,
last_used TEXT,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE host_access (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_id INTEGER NOT NULL,
user_id TEXT,
role_id INTEGER,
granted_by TEXT NOT NULL,
permission_level TEXT NOT NULL DEFAULT 'view',
expires_at TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
last_accessed_at TEXT,
access_count INTEGER NOT NULL DEFAULT 0,
override_credential_id INTEGER
);
CREATE TABLE ssh_folders (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
color TEXT,
icon TEXT,
credential_id INTEGER,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO ssh_credentials (
id, user_id, name, auth_type, username, password, private_key, key_password
)
VALUES
(7, 'user-1', 'owner', 'password', 'root', 'secret', NULL, NULL),
(8, 'user-2', 'override', 'key', 'alice', NULL, 'private', 'pass');
INSERT INTO ssh_data (
id, user_id, name, ip, port, username, auth_type, credential_id,
tunnel_connections
@@ -191,21 +44,15 @@ describe("HostResolutionRepository", () => {
(1, 'user-1', 'web', '10.0.0.1', 22, 'root', 'password', 7, '[{"autoStart":true}]'),
(2, 'user-1', 'db', '10.0.0.2', 22, 'admin', 'none', NULL, NULL),
(3, 'user-2', 'other', '10.0.0.3', 22, 'root', 'none', NULL, '[{"autoStart":false}]');
INSERT INTO ssh_credentials (
id, user_id, name, auth_type, username, password, private_key, key_password
)
VALUES
(7, 'user-1', 'owner', 'password', 'root', 'secret', NULL, NULL),
(8, 'user-2', 'override', 'key', 'alice', NULL, 'private', 'pass');
INSERT INTO host_access (
host_id, user_id, granted_by, permission_level, override_credential_id
)
VALUES (1, 'user-2', 'user-1', 'execute', 8);
INSERT INTO ssh_folders (user_id, name, credential_id)
VALUES
('user-1', 'switches', 7),
('user-1', 'switches / floor1', NULL),
('user-1', 'no-cred', NULL);
INSERT INTO host_access (
host_id, user_id, granted_by, permission_level, override_credential_id
)
VALUES (1, 'user-2', 'user-1', 'execute', 8);
`);
return new HostResolutionRepository(context, onWrite);
@@ -0,0 +1,87 @@
import { describe, expect, it } from "vitest";
import {
insertedId,
rowsAffected,
supportsReturning,
} from "../../../database/repositories/mutation-result.js";
describe("rowsAffected", () => {
it("counts a returning() array from sqlite or postgres", () => {
expect(rowsAffected([{ id: 1 }, { id: 2 }, { id: 3 }])).toBe(3);
expect(rowsAffected([])).toBe(0);
});
it("reads affectedRows from a mysql write result", () => {
expect(rowsAffected({ affectedRows: 4, insertId: 0 })).toBe(4);
expect(rowsAffected({ affectedRows: 0 })).toBe(0);
});
it("reads changes from a better-sqlite3 write result", () => {
// The shape of a write with no .returning() attached — verified against
// the driver, not assumed.
expect(rowsAffected({ changes: 1, lastInsertRowid: 7 })).toBe(1);
expect(rowsAffected({ changes: 0, lastInsertRowid: 7 })).toBe(0);
});
it("reads rowCount from a node-postgres write result", () => {
expect(rowsAffected({ rowCount: 3, rows: [], command: "DELETE" })).toBe(3);
});
it("unwraps the [header, fields] tuple mysql2 returns", () => {
expect(rowsAffected([{ affectedRows: 2 }, []])).toBe(2);
});
it("does not mistake a returning() array for a mysql header", () => {
// A single returned row is one row, not whatever affectedRows might say.
expect(rowsAffected([{ id: 7 }])).toBe(1);
});
it("reports zero for a shape it does not recognise", () => {
expect(rowsAffected(undefined)).toBe(0);
expect(rowsAffected(null)).toBe(0);
expect(rowsAffected({})).toBe(0);
});
});
describe("insertedId", () => {
it("reads the id from a returning() array", () => {
expect(insertedId([{ id: 42 }])).toBe(42);
});
it("reads insertId from a mysql write result", () => {
expect(insertedId({ affectedRows: 1, insertId: 42 })).toBe(42);
expect(insertedId([{ affectedRows: 1, insertId: 42 }, []])).toBe(42);
});
it("treats mysql's zero insertId as absent", () => {
// MySQL reports 0 when the table has no autoincrement column.
expect(insertedId({ affectedRows: 1, insertId: 0 })).toBeNull();
});
it("reads lastInsertRowid from better-sqlite3, as number or bigint", () => {
expect(insertedId({ changes: 1, lastInsertRowid: 9 })).toBe(9);
expect(insertedId({ changes: 1, lastInsertRowid: 9n })).toBe(9);
expect(insertedId({ changes: 1, lastInsertRowid: 0 })).toBeNull();
});
it("returns null when nothing was inserted", () => {
expect(insertedId([])).toBeNull();
expect(insertedId({})).toBeNull();
expect(insertedId(undefined)).toBeNull();
});
it("returns null for a non-numeric id", () => {
// Tables keyed by a text id, e.g. users.
expect(insertedId([{ id: "u-1" }])).toBeNull();
});
});
describe("supportsReturning", () => {
it("is false only for mysql", () => {
expect(supportsReturning("sqlite")).toBe(true);
expect(supportsReturning("postgres")).toBe(true);
// No RETURNING clause in MySQL, and drizzle's mysql-core does not expose
// the method — call sites that need rows back must read first.
expect(supportsReturning("mysql")).toBe(false);
});
});
@@ -17,23 +17,7 @@ describe("NetworkTopologyRepository", () => {
): Promise<NetworkTopologyRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE network_topology (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
topology TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
`);
@@ -17,29 +17,12 @@ describe("OpenTabRepository", () => {
): Promise<OpenTabRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE user_open_tabs (
id TEXT PRIMARY KEY,
user_id TEXT NOT NULL,
tab_type TEXT NOT NULL,
host_id INTEGER,
label TEXT NOT NULL,
tab_order INTEGER NOT NULL DEFAULT 0,
backend_session_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type) VALUES
(1, 'user-1', 'host-1', '10.0.0.1', 22, 'root', 'password'),
(2, 'user-1', 'host-2', '10.0.0.2', 22, 'root', 'password');
`);
return new OpenTabRepository(context, onWrite);
@@ -17,39 +17,11 @@ describe("OpksshTokenRepository", () => {
): Promise<OpksshTokenRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE opkssh_tokens (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
ssh_cert TEXT NOT NULL,
private_key TEXT NOT NULL,
email TEXT,
sub TEXT,
issuer TEXT,
audience TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
expires_at TEXT NOT NULL,
last_used TEXT,
UNIQUE(user_id, host_id)
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'one'), (2, 'user-1', 'two'), (3, 'user-2', 'other');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-1', 'two', '10.0.0.1', 22, 'root', 'password'), (3, 'user-2', 'other', '10.0.0.1', 22, 'root', 'password');
INSERT INTO opkssh_tokens (
user_id, host_id, ssh_cert, private_key, email, expires_at
)
@@ -18,112 +18,30 @@ describe("RbacAccessRepository", () => {
): Promise<RbacAccessRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE roles (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL UNIQUE,
display_name TEXT NOT NULL,
description TEXT,
is_system INTEGER NOT NULL DEFAULT 0,
permissions TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE host_access (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_id INTEGER NOT NULL,
user_id TEXT,
role_id INTEGER,
granted_by TEXT NOT NULL,
permission_level TEXT NOT NULL DEFAULT 'view',
expires_at TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
last_accessed_at TEXT,
access_count INTEGER NOT NULL DEFAULT 0,
override_credential_id INTEGER
);
CREATE TABLE shared_host_secrets (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_access_id INTEGER NOT NULL,
target_user_id TEXT NOT NULL,
protocol TEXT NOT NULL DEFAULT 'ssh',
source_type TEXT NOT NULL DEFAULT 'credential',
original_credential_id INTEGER,
encrypted_username TEXT,
encrypted_auth_type TEXT,
encrypted_password TEXT,
encrypted_key TEXT,
encrypted_key_password TEXT,
encrypted_key_type TEXT,
encrypted_domain TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
UNIQUE(host_access_id, target_user_id, protocol)
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT,
ip TEXT NOT NULL,
port INTEGER NOT NULL,
username TEXT NOT NULL,
credential_id INTEGER,
rdp_credential_id INTEGER,
vnc_credential_id INTEGER,
telnet_credential_id INTEGER,
folder TEXT,
tags TEXT
);
CREATE TABLE snippets (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
content TEXT NOT NULL,
description TEXT,
folder TEXT,
"order" INTEGER NOT NULL DEFAULT 0,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
host_filter TEXT
);
CREATE TABLE snippet_access (
id INTEGER PRIMARY KEY AUTOINCREMENT,
snippet_id INTEGER NOT NULL,
user_id TEXT,
role_id INTEGER,
granted_by TEXT NOT NULL,
permission_level TEXT NOT NULL DEFAULT 'view',
expires_at TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash, is_admin, is_oidc)
VALUES
('admin', 'admin', 'hash', 1, 0),
('user-1', 'alice', 'hash', 0, 0),
('owner-1', 'owner', 'hash', 0, 0);
INSERT INTO roles (id, name, display_name, is_system)
VALUES (7, 'ops', 'Operations', 0);
INSERT INTO ssh_credentials (id, user_id, name, username, auth_type) VALUES
(123, 'admin', 'cred-123', 'root', 'password'),
(124, 'admin', 'cred-124', 'root', 'password'),
(125, 'admin', 'cred-125', 'root', 'password'),
(126, 'admin', 'cred-126', 'root', 'password');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type) VALUES
(43, 'admin', 'host-43', '10.0.0.43', 22, 'root', 'password');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type) VALUES
(44, 'admin', 'host-44', '10.0.0.45', 22, 'root', 'password');
INSERT INTO ssh_data (
id, user_id, name, ip, port, username, credential_id, rdp_credential_id, vnc_credential_id, telnet_credential_id, folder, tags
)
VALUES (42, 'owner-1', 'prod', '10.0.0.42', 22, 'root', 123, 124, 125, 126, 'servers', 'linux');
id, user_id, name, ip, port, username, credential_id, rdp_credential_id, vnc_credential_id, telnet_credential_id, folder, tags, auth_type)
VALUES (42, 'owner-1', 'prod', '10.0.0.42', 22, 'root', 123, 124, 125, 126, 'servers', 'linux', 'password');
INSERT INTO snippets (id, user_id, name, content)
VALUES
(99, 'owner-1', 'deploy', 'echo deploy'),
(100, 'owner-1', 'rollback', 'echo rollback');
INSERT INTO host_access (
id, host_id, user_id, role_id, granted_by, permission_level, expires_at, created_at
)
@@ -131,23 +49,18 @@ describe("RbacAccessRepository", () => {
(1, 42, 'user-1', NULL, 'admin', 'view', NULL, '2026-06-26T00:00:00.000Z'),
(2, 42, NULL, 7, 'admin', 'view', '2026-06-27T00:00:00.000Z', '2026-06-26T01:00:00.000Z'),
(5, 44, 'user-1', NULL, 'admin', 'view', '2026-06-25T00:00:00.000Z', '2026-06-24T00:00:00.000Z');
INSERT INTO shared_host_secrets (
id, host_access_id, target_user_id, protocol, source_type, original_credential_id, encrypted_username, encrypted_auth_type
)
VALUES
(8, 2, 'user-1', 'ssh', 'credential', 123, 'enc-user', 'enc-auth'),
(9, 2, 'user-1', 'rdp', 'inline', NULL, 'enc-rdp-user', 'direct');
INSERT INTO snippets (id, user_id, name, content)
VALUES (99, 'owner-1', 'deploy', 'echo deploy');
INSERT INTO snippet_access (
id, snippet_id, user_id, role_id, granted_by, permission_level, expires_at, created_at
)
VALUES
(3, 99, 'user-1', NULL, 'admin', 'view', NULL, '2026-06-26T00:00:00.000Z'),
(4, 99, NULL, 7, 'admin', 'view', '2026-06-27T00:00:00.000Z', '2026-06-26T01:00:00.000Z');
INSERT INTO shared_host_secrets (
id, host_access_id, target_user_id, protocol, source_type, original_credential_id, encrypted_username, encrypted_auth_type
)
VALUES
(8, 2, 'user-1', 'ssh', 'credential', 123, 'enc-user', 'enc-auth'),
(9, 2, 'user-1', 'rdp', 'inline', NULL, 'enc-rdp-user', 'direct');
`);
return new RbacAccessRepository(context, onWrite);
@@ -1,3 +1,4 @@
import { sql } from "drizzle-orm";
import { afterEach, describe, expect, it } from "vitest";
import { TestSqliteDatabase } from "./test-support.js";
import { RecentActivityRepository } from "../../../database/repositories/recent-activity-repository.js";
@@ -16,40 +17,14 @@ describe("RecentActivityRepository", () => {
onWrite?: () => void | Promise<void>,
): Promise<{
repository: RecentActivityRepository;
sqlite: NonNullable<
Awaited<ReturnType<TestSqliteDatabase["connect"]>>["sqlite"]
>;
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE recent_activity (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
type TEXT NOT NULL,
host_id INTEGER NOT NULL,
host_name TEXT,
timestamp TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'one'), (2, 'user-1', 'two'), (3, 'user-2', 'other');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-1', 'two', '10.0.0.1', 22, 'root', 'password'), (3, 'user-2', 'other', '10.0.0.1', 22, 'root', 'password');
INSERT INTO recent_activity (id, user_id, type, host_id, host_name, timestamp)
VALUES
(1, 'user-1', 'connect', 1, 'one', '2026-06-26T00:00:00.000Z'),
@@ -59,13 +34,12 @@ describe("RecentActivityRepository", () => {
return {
repository: new RecentActivityRepository(context, onWrite),
sqlite: adapter.raw,
};
}
it("lists, creates, and trims recent activity", async () => {
let writeCount = 0;
const { repository, sqlite } = await createRepository(() => {
const { repository } = await createRepository(() => {
writeCount += 1;
});
@@ -88,11 +62,9 @@ describe("RecentActivityRepository", () => {
expect(await repository.trimUserActivity("user-1", 2)).toBe(1);
expect(
sqlite
.prepare(
"SELECT id FROM recent_activity WHERE user_id = ? ORDER BY timestamp DESC",
)
.all("user-1"),
await adapter!.query(
sql`SELECT id FROM recent_activity WHERE user_id = 'user-1' ORDER BY timestamp DESC`,
),
).toEqual([{ id: created.id }, { id: 2 }]);
expect(writeCount).toBe(2);
});
@@ -0,0 +1,177 @@
import { sql } from "drizzle-orm";
import { describe, expect, it } from "vitest";
import {
deleteReturning,
updateReturning,
} from "../../../database/repositories/returning.js";
import type { DatabaseContext } from "../../../database/repositories/database-context.js";
import type { DatabaseDialect } from "../../../database/db/dialect.js";
/**
* The MySQL path cannot be exercised against a real engine here, and its whole
* correctness is an ordering property: an update must be read AFTER the write,
* a delete BEFORE it. Get either backwards and the rows describe the wrong
* state silently, with no error anywhere.
*
* So the drizzle handle is stubbed and the order of calls is recorded.
*/
function recordingContext(dialect: DatabaseDialect) {
const calls: string[] = [];
const rows = [{ id: 1, name: "before" }];
const chain = (label: string, result: unknown) => {
calls.push(label);
const thenable = {
set: () => thenable,
from: () => thenable,
where: () => thenable,
returning: () => Promise.resolve(result),
then: (resolve: (v: unknown) => void) =>
Promise.resolve(result).then(resolve),
};
return thenable;
};
const db = {
update: () => chain("update", rows),
delete: () => chain("delete", rows),
select: () => chain("select", rows),
transaction: (fn: (tx: unknown) => Promise<unknown>) => {
calls.push("begin");
return fn(db).then((value) => {
calls.push("commit");
return value;
});
},
};
return {
context: { dialect, drizzle: db } as unknown as DatabaseContext,
calls,
};
}
const where = sql`id = 1`;
describe("updateReturning", () => {
it.each(["sqlite", "postgres"] as const)(
"uses a single statement on %s, where RETURNING exists",
async (dialect) => {
const { context, calls } = recordingContext(dialect);
await updateReturning(context, {} as never, {}, where);
expect(calls).toEqual(["update"]);
},
);
it("on mysql, writes first and reads the new state after", async () => {
const { context, calls } = recordingContext("mysql");
await updateReturning(context, {} as never, {}, where);
// Reading first would return the values the update replaced.
expect(calls).toEqual(["begin", "update", "select", "commit"]);
});
});
describe("updateReturning, when the read-back cannot find the rows", () => {
/**
* The failure mode: an update that changes a column its own `where` filters
* on. MySQL writes the rows, then the re-read matches nothing. Returning []
* would be indistinguishable from "matched nothing" and silently wrong.
*/
function contextThatWritesButCannotReadBack() {
const chain = (result: unknown) => {
const thenable: Record<string, unknown> = {
set: () => thenable,
from: () => thenable,
where: () => thenable,
then: (resolve: (v: unknown) => void) =>
Promise.resolve(result).then(resolve),
};
return thenable;
};
const db = {
update: () => chain({ affectedRows: 3 }),
select: () => chain([]),
transaction: (fn: (tx: unknown) => Promise<unknown>) => fn(db),
};
return { dialect: "mysql", drizzle: db } as unknown as DatabaseContext;
}
it("throws instead of returning an empty array", async () => {
await expect(
updateReturning(
contextThatWritesButCannotReadBack(),
{} as never,
{},
where,
),
).rejects.toThrow(/wrote 3 row\(s\) but could not read them back/);
});
it("says how to fix it", async () => {
await expect(
updateReturning(
contextThatWritesButCannotReadBack(),
{} as never,
{},
where,
),
).rejects.toThrow(/filter on a column the update leaves alone/);
});
it("still returns [] when the update genuinely matched nothing", async () => {
const { context } = recordingContext("mysql");
// recordingContext reports rows for select, so use a zero-write stub.
const chain = (result: unknown) => {
const t: Record<string, unknown> = {
set: () => t,
from: () => t,
where: () => t,
then: (r: (v: unknown) => void) => Promise.resolve(result).then(r),
};
return t;
};
const db = {
update: () => chain({ affectedRows: 0 }),
select: () => chain([]),
transaction: (fn: (tx: unknown) => Promise<unknown>) => fn(db),
};
void context;
await expect(
updateReturning(
{ dialect: "mysql", drizzle: db } as unknown as DatabaseContext,
{} as never,
{},
where,
),
).resolves.toEqual([]);
});
});
describe("deleteReturning", () => {
it("uses a single statement where RETURNING exists", async () => {
const { context, calls } = recordingContext("postgres");
await deleteReturning(context, {} as never, where);
expect(calls).toEqual(["delete"]);
});
it("on mysql, reads first and deletes after", async () => {
const { context, calls } = recordingContext("mysql");
const rows = await deleteReturning(context, {} as never, where);
// Reading after the delete would find nothing at all.
expect(calls).toEqual(["begin", "select", "delete", "commit"]);
expect(rows).toHaveLength(1);
});
it("keeps both statements in one transaction", async () => {
const { context, calls } = recordingContext("mysql");
await deleteReturning(context, {} as never, where);
// Without this, a concurrent write between them makes the returned rows
// describe a state that never existed — and with a pool the second
// statement need not even reach the same connection.
expect(calls[0]).toBe("begin");
expect(calls[calls.length - 1]).toBe("commit");
});
});
@@ -17,45 +17,7 @@ describe("RoleRepository", () => {
): Promise<RoleRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE roles (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL UNIQUE,
display_name TEXT NOT NULL,
description TEXT,
is_system INTEGER NOT NULL DEFAULT 0,
permissions TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE user_roles (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
role_id INTEGER NOT NULL,
granted_by TEXT,
granted_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE host_access (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_id INTEGER NOT NULL,
user_id TEXT,
role_id INTEGER,
granted_by TEXT NOT NULL,
permission_level TEXT NOT NULL DEFAULT 'view',
expires_at TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash, is_admin, is_oidc)
VALUES ('admin', 'admin', 'hash', 1, 0), ('user-1', 'user', 'hash', 0, 0);
`);
@@ -17,42 +17,11 @@ describe("SessionRecordingRepository", () => {
): Promise<SessionRecordingRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
ip TEXT
);
CREATE TABLE session_recordings (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_id INTEGER NOT NULL,
user_id TEXT,
username TEXT,
access_id INTEGER,
started_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
ended_at TEXT,
duration INTEGER,
commands TEXT,
dangerous_actions TEXT,
recording_path TEXT,
protocol TEXT NOT NULL DEFAULT 'ssh',
format TEXT NOT NULL DEFAULT 'text',
terminated_by_owner INTEGER DEFAULT 0,
termination_reason TEXT
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO ssh_data (id, user_id, name, ip)
VALUES (1, 'user-1', 'one', '10.0.0.1'), (2, 'user-1', 'two', '10.0.0.2'), (3, 'user-2', 'other', '10.0.0.3');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-1', 'two', '10.0.0.2', 22, 'root', 'password'), (3, 'user-2', 'other', '10.0.0.3', 22, 'root', 'password');
`);
return new SessionRecordingRepository(context, onWrite);
@@ -17,51 +17,11 @@ describe("SessionShareRepository", () => {
): Promise<SessionShareRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
ip TEXT
);
CREATE TABLE session_shares (
id TEXT PRIMARY KEY,
host_id INTEGER NOT NULL,
owner_user_id TEXT NOT NULL,
protocol TEXT NOT NULL,
session_id TEXT NOT NULL,
tab_instance_id TEXT,
share_type TEXT NOT NULL,
target_user_id TEXT,
link_token TEXT UNIQUE,
permission_level TEXT NOT NULL DEFAULT 'read-only',
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
expires_at TEXT NOT NULL,
revoked_at TEXT,
last_joined_at TEXT,
join_count INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE session_share_participants (
id INTEGER PRIMARY KEY AUTOINCREMENT,
share_id TEXT NOT NULL,
user_id TEXT,
guest_label TEXT,
joined_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
left_at TEXT
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('owner-1', 'alice', 'hash'), ('guest-1', 'bob', 'hash');
INSERT INTO ssh_data (id, user_id, name, ip)
VALUES (1, 'owner-1', 'host-one', '10.0.0.1'), (2, 'owner-1', 'host-two', '10.0.0.2');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'owner-1', 'host-one', '10.0.0.1', 22, 'root', 'password'), (2, 'owner-1', 'host-two', '10.0.0.2', 22, 'root', 'password');
`);
return new SessionShareRepository(context, onWrite);
@@ -0,0 +1,104 @@
import { afterEach, describe, expect, it, vi } from "vitest";
import {
refreshIntervalSeconds,
startSettingsCacheRefresh,
stopSettingsCacheRefresh,
} from "../../../database/repositories/factory.js";
/**
* The settings cache lives in one process and is updated by whichever process
* wrote the setting. On SQLite that is the only process there is. On Postgres
* and MySQL the reason those exist here is to let several instances share one
* database a setting changed on one replica would otherwise never reach the
* others, because the synchronous read cannot go back to the database.
*
* Re-priming on a timer does not make settings immediately consistent. It
* bounds how long they can disagree.
*/
describe("settings cache refresh", () => {
afterEach(() => stopSettingsCacheRefresh());
describe("interval", () => {
it("defaults to something short enough to matter", () => {
expect(refreshIntervalSeconds({})).toBe(30);
});
it("is configurable", () => {
expect(
refreshIntervalSeconds({ SETTINGS_CACHE_REFRESH_SECONDS: "5" }),
).toBe(5);
});
it("treats zero and nonsense as off", () => {
expect(
refreshIntervalSeconds({ SETTINGS_CACHE_REFRESH_SECONDS: "0" }),
).toBeNull();
expect(
refreshIntervalSeconds({ SETTINGS_CACHE_REFRESH_SECONDS: "-1" }),
).toBeNull();
expect(
refreshIntervalSeconds({ SETTINGS_CACHE_REFRESH_SECONDS: "soon" }),
).toBeNull();
});
});
it("re-reads on the interval", async () => {
const refresh = vi.fn().mockResolvedValue(undefined);
startSettingsCacheRefresh(
{ SETTINGS_CACHE_REFRESH_SECONDS: "0.01" },
refresh,
);
await vi.waitFor(() =>
expect(refresh.mock.calls.length).toBeGreaterThan(1),
);
});
it("keeps running after a refresh throws", async () => {
// A transient database blip must not stop the loop, or the replica is stuck
// on stale settings until it restarts — the exact failure this prevents.
const refresh = vi
.fn()
.mockRejectedValueOnce(new Error("connection reset"))
.mockResolvedValue(undefined);
startSettingsCacheRefresh(
{ SETTINGS_CACHE_REFRESH_SECONDS: "0.01" },
refresh,
);
await vi.waitFor(() =>
expect(refresh.mock.calls.length).toBeGreaterThan(1),
);
});
it("does nothing when switched off", async () => {
const refresh = vi.fn().mockResolvedValue(undefined);
startSettingsCacheRefresh({ SETTINGS_CACHE_REFRESH_SECONDS: "0" }, refresh);
await new Promise((resolve) => setTimeout(resolve, 40));
expect(refresh).not.toHaveBeenCalled();
});
it("stops when told to, and does not stack timers", async () => {
const refresh = vi.fn().mockResolvedValue(undefined);
startSettingsCacheRefresh(
{ SETTINGS_CACHE_REFRESH_SECONDS: "0.02" },
refresh,
);
startSettingsCacheRefresh(
{ SETTINGS_CACHE_REFRESH_SECONDS: "0.02" },
refresh,
);
await new Promise((resolve) => setTimeout(resolve, 70));
stopSettingsCacheRefresh();
const afterStop = refresh.mock.calls.length;
await new Promise((resolve) => setTimeout(resolve, 50));
expect(refresh.mock.calls.length).toBe(afterStop);
});
});
@@ -0,0 +1,82 @@
import { afterEach, describe, expect, it } from "vitest";
import {
forgetCachedSetting,
isSettingsCachePrimed,
primeSettingsCache,
readCachedSetting,
resetSettingsCache,
updateCachedSetting,
} from "../../../database/repositories/settings-cache.js";
afterEach(() => resetSettingsCache());
describe("settings cache", () => {
it("starts unprimed", () => {
expect(isSettingsCachePrimed()).toBe(false);
});
it("reads back what was primed", () => {
primeSettingsCache([
{ key: "guac_url", value: "guacd:4822" },
{ key: "allow_registration", value: "false" },
]);
expect(isSettingsCachePrimed()).toBe(true);
expect(readCachedSetting("guac_url")).toBe("guacd:4822");
expect(readCachedSetting("allow_registration")).toBe("false");
});
it("returns null for a key that is not set", () => {
primeSettingsCache([{ key: "guac_url", value: "guacd:4822" }]);
expect(readCachedSetting("missing")).toBeNull();
});
it("returns null rather than throwing before priming", () => {
// Startup ordering means a read can land first. Every caller already
// treats null as "use the default", so this must not throw.
expect(readCachedSetting("guac_url")).toBeNull();
});
it("reflects a write immediately", () => {
primeSettingsCache([{ key: "log_level", value: "info" }]);
updateCachedSetting("log_level", "debug");
// A synchronous reader must not see the pre-write value.
expect(readCachedSetting("log_level")).toBe("debug");
});
it("accepts a key that did not exist at prime time", () => {
primeSettingsCache([]);
updateCachedSetting("new_key", "value");
expect(readCachedSetting("new_key")).toBe("value");
});
it("forgets a deleted key", () => {
primeSettingsCache([{ key: "guac_url", value: "guacd:4822" }]);
forgetCachedSetting("guac_url");
expect(readCachedSetting("guac_url")).toBeNull();
});
it("ignores writes while unprimed instead of half-populating", () => {
// A partially filled cache would be worse than an empty one: readers
// could not tell a real value from a missing prime.
updateCachedSetting("guac_url", "guacd:4822");
expect(isSettingsCachePrimed()).toBe(false);
expect(readCachedSetting("guac_url")).toBeNull();
});
it("replaces the previous contents when primed again", () => {
primeSettingsCache([{ key: "old", value: "1" }]);
primeSettingsCache([{ key: "new", value: "2" }]);
expect(readCachedSetting("old")).toBeNull();
expect(readCachedSetting("new")).toBe("2");
});
});
@@ -15,12 +15,6 @@ describe("SettingsRepository", () => {
async function createRepository(): Promise<SettingsRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE settings (
key TEXT PRIMARY KEY,
value TEXT NOT NULL
)
`);
return new SettingsRepository(context);
}
@@ -16,65 +16,25 @@ describe("SharedHostSecretsRepository", () => {
onWrite?: () => void | Promise<void>,
): Promise<{
repository: SharedHostSecretsRepository;
sqlite: NonNullable<
Awaited<ReturnType<TestSqliteDatabase["connect"]>>["sqlite"]
>;
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE host_access (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_id INTEGER NOT NULL,
user_id TEXT,
role_id INTEGER,
granted_by TEXT NOT NULL,
permission_level TEXT NOT NULL DEFAULT 'connect',
expires_at TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
last_accessed_at TEXT,
access_count INTEGER NOT NULL DEFAULT 0,
override_credential_id INTEGER
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT,
ip TEXT NOT NULL,
port INTEGER NOT NULL,
username TEXT NOT NULL,
credential_id INTEGER,
rdp_credential_id INTEGER,
vnc_credential_id INTEGER,
telnet_credential_id INTEGER
);
CREATE TABLE shared_host_secrets (
id INTEGER PRIMARY KEY AUTOINCREMENT,
host_access_id INTEGER NOT NULL,
target_user_id TEXT NOT NULL,
protocol TEXT NOT NULL DEFAULT 'ssh',
source_type TEXT NOT NULL DEFAULT 'credential',
original_credential_id INTEGER,
encrypted_username TEXT,
encrypted_auth_type TEXT,
encrypted_password TEXT,
encrypted_key TEXT,
encrypted_key_password TEXT,
encrypted_key_type TEXT,
encrypted_domain TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
UNIQUE(host_access_id, target_user_id, protocol)
);
INSERT INTO ssh_data (id, user_id, name, ip, port, username, credential_id, rdp_credential_id)
VALUES
(42, 'owner-1', 'prod', '10.0.0.42', 22, 'root', 123, 124),
(43, 'owner-1', 'staging', '10.0.0.43', 22, 'root', NULL, NULL),
(44, 'owner-2', 'other', '10.0.0.44', 22, 'root', 123, NULL);
await adapter.exec(`
INSERT INTO users (id, username, password_hash) VALUES
('owner-1', 'owner-1', 'hash'),
('owner-2', 'owner-2', 'hash');
INSERT INTO users (id, username, password_hash) VALUES
('user-1', 'user-1', 'hash'),
('user-2', 'user-2', 'hash');
INSERT INTO roles (id, name, display_name, is_system) VALUES
(7, 'role-7', 'Role 7', 0);
INSERT INTO ssh_credentials (id, user_id, name, username, auth_type) VALUES
(123, 'user-1', 'cred-123', 'root', 'password'),
(124, 'user-1', 'cred-124', 'root', 'password');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, credential_id, rdp_credential_id, auth_type)
VALUES (42, 'owner-1', 'prod', '10.0.0.42', 22, 'root', 123, 124, 'password'),
(43, 'owner-1', 'staging', '10.0.0.43', 22, 'root', NULL, NULL, 'password'),
(44, 'owner-2', 'other', '10.0.0.44', 22, 'root', 123, NULL, 'password');
INSERT INTO host_access (id, host_id, user_id, role_id, granted_by)
VALUES
(1, 42, 'user-1', NULL, 'owner-1'),
@@ -84,7 +44,6 @@ describe("SharedHostSecretsRepository", () => {
return {
repository: new SharedHostSecretsRepository(context, onWrite),
sqlite: adapter.raw,
};
}
@@ -1,3 +1,4 @@
import { sql } from "drizzle-orm";
import { afterEach, describe, expect, it, vi } from "vitest";
import { TestSqliteDatabase } from "./test-support.js";
import { SnippetRepository } from "../../../database/repositories/snippet-repository.js";
@@ -14,37 +15,13 @@ describe("SnippetRepository", () => {
async function createRepository(onWrite?: () => void): Promise<{
repository: SnippetRepository;
sqlite: NonNullable<
Awaited<ReturnType<TestSqliteDatabase["connect"]>>["sqlite"]
>;
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE snippets (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
content TEXT NOT NULL,
description TEXT,
folder TEXT,
"order" INTEGER NOT NULL DEFAULT 0,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
host_filter TEXT
);
CREATE TABLE snippet_folders (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
color TEXT,
icon TEXT,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash) VALUES
('user-1', 'user-1', 'hash'),
('user-2', 'user-2', 'hash');
INSERT INTO snippets (
id, user_id, name, content, description, folder, "order", host_filter
@@ -53,7 +30,6 @@ describe("SnippetRepository", () => {
(1, 'user-1', 'root', 'uptime', NULL, NULL, 2, NULL),
(2, 'user-1', 'deploy', 'make deploy', 'Deploy app', 'ops', 1, 'linux'),
(3, 'user-2', 'other', 'whoami', NULL, NULL, 1, NULL);
INSERT INTO snippet_folders (id, user_id, name, color, icon)
VALUES
(1, 'user-1', 'ops', '#123456', 'terminal'),
@@ -63,7 +39,6 @@ describe("SnippetRepository", () => {
return {
repository: new SnippetRepository(context, onWrite),
sqlite: adapter.raw,
};
}
@@ -189,18 +164,18 @@ describe("SnippetRepository", () => {
it("deletes all snippets and folders for a user", async () => {
const onWrite = vi.fn();
const { repository, sqlite } = await createRepository(onWrite);
const { repository } = await createRepository(onWrite);
await expect(repository.deleteByUserId("user-1")).resolves.toEqual({
snippetsDeleted: 2,
foldersDeleted: 2,
});
expect(sqlite.prepare("SELECT id FROM snippets ORDER BY id").all()).toEqual(
[{ id: 3 }],
);
expect(
sqlite.prepare("SELECT id FROM snippet_folders ORDER BY id").all(),
await adapter!.query(sql`SELECT id FROM snippets ORDER BY id`),
).toEqual([{ id: 3 }]);
expect(
await adapter!.query(sql`SELECT id FROM snippet_folders ORDER BY id`),
).toEqual([{ id: 3 }]);
expect(onWrite).toHaveBeenCalledTimes(1);
});
@@ -17,41 +17,13 @@ describe("SshCredentialUsageRepository", () => {
): Promise<SshCredentialUsageRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE ssh_credentials (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE ssh_credential_usage (
id INTEGER PRIMARY KEY AUTOINCREMENT,
credential_id INTEGER NOT NULL,
host_id INTEGER NOT NULL,
user_id TEXT NOT NULL,
used_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'one'), (2, 'user-1', 'two'), (3, 'user-2', 'other');
INSERT INTO ssh_credentials (id, user_id, name)
VALUES (1, 'user-1', 'cred-one'), (2, 'user-2', 'cred-two');
INSERT INTO ssh_credentials (id, user_id, name, username, auth_type)
VALUES (1, 'user-1', 'cred-one', 'root', 'password'), (2, 'user-2', 'cred-two', 'root', 'password');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-1', 'two', '10.0.0.1', 22, 'root', 'password'), (3, 'user-2', 'other', '10.0.0.1', 22, 'root', 'password');
`);
return new SshCredentialUsageRepository(context, onWrite);
@@ -4,13 +4,11 @@ import { SsoProviderRepository } from "../../../database/repositories/sso-provid
describe("SsoProviderRepository", () => {
let adapter: TestSqliteDatabase | null = null;
let sqlite: Awaited<ReturnType<TestSqliteDatabase["connect"]>>["sqlite"];
afterEach(async () => {
if (adapter) {
await adapter.close();
adapter = null;
sqlite = undefined;
}
});
@@ -19,28 +17,6 @@ describe("SsoProviderRepository", () => {
): Promise<SsoProviderRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
sqlite = adapter.raw;
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0,
sso_provider_id INTEGER
);
CREATE TABLE sso_providers (
id INTEGER PRIMARY KEY AUTOINCREMENT,
name TEXT NOT NULL,
type TEXT NOT NULL,
enabled INTEGER NOT NULL DEFAULT 1,
display_order INTEGER NOT NULL DEFAULT 0,
config TEXT NOT NULL,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
`);
return new SsoProviderRepository(context, onWrite);
}
@@ -96,7 +72,7 @@ describe("SsoProviderRepository", () => {
config: "{}",
});
sqlite?.exec(`
await adapter!.exec(`
INSERT INTO users (id, username, password_hash, sso_provider_id)
VALUES ('user-1', 'u1', 'hash', ${provider.id}),
('user-2', 'u2', 'hash', ${provider.id}),
@@ -17,21 +17,7 @@ describe("SyncTombstoneRepository", () => {
): Promise<SyncTombstoneRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE sync_tombstones (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
entity_type TEXT NOT NULL,
sync_id TEXT NOT NULL,
deleted_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
`);
@@ -102,24 +88,9 @@ describe("SyncTombstoneRepository", () => {
const adapterLocal = new TestSqliteDatabase();
adapter = adapterLocal;
const context = await adapterLocal.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE sync_tombstones (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
entity_type TEXT NOT NULL,
sync_id TEXT NOT NULL,
deleted_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash');
INSERT INTO sync_tombstones (user_id, entity_type, sync_id, deleted_at)
VALUES
('user-1', 'hosts', 'old', '2026-01-01T00:00:00.000Z'),
@@ -1,4 +1,5 @@
import { afterEach, describe, expect, it, vi } from "vitest";
import { sql } from "drizzle-orm";
import { afterEach, describe, expect, vi } from "vitest";
import { TestSqliteDatabase } from "./test-support.js";
import { DataCrypto } from "../../../utils/data-crypto.js";
import { TermixIdentityCaRepository } from "../../../database/repositories/termix-identity-ca-repository.js";
@@ -16,45 +17,11 @@ describe("TermixIdentityCaRepository", () => {
async function createRepository(onWrite = vi.fn()): Promise<{
repo: TermixIdentityCaRepository;
sqlite: NonNullable<
Awaited<ReturnType<TestSqliteDatabase["connect"]>>["sqlite"]
>;
onWrite: ReturnType<typeof vi.fn>;
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE termix_identities (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL UNIQUE,
handle TEXT NOT NULL UNIQUE,
description TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
CREATE TABLE termix_identity_ca (
id INTEGER PRIMARY KEY AUTOINCREMENT,
identity_id INTEGER NOT NULL UNIQUE,
user_id TEXT NOT NULL,
public_key TEXT NOT NULL,
private_key TEXT NOT NULL,
validity_days INTEGER NOT NULL DEFAULT 90,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (identity_id) REFERENCES termix_identities(id) ON DELETE CASCADE,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash');
INSERT INTO termix_identities (id, user_id, handle)
@@ -63,7 +30,6 @@ describe("TermixIdentityCaRepository", () => {
return {
repo: new TermixIdentityCaRepository(context, onWrite),
sqlite: adapter.raw,
onWrite,
};
}
@@ -95,7 +61,7 @@ describe("TermixIdentityCaRepository", () => {
}
it("creates CA private keys with the real row id before encryption", async () => {
const { repo, sqlite, onWrite } = await createRepository();
const { repo, onWrite } = await createRepository();
mockCrypto();
const created = await repo.createEncryptedForUser("user-1", {
@@ -106,16 +72,14 @@ describe("TermixIdentityCaRepository", () => {
validityDays: 120,
});
const raw = sqlite
.prepare(
"SELECT id, public_key, private_key, validity_days FROM termix_identity_ca WHERE identity_id = ?",
)
.get(7) as {
const [raw] = (await adapter!.query(
sql`SELECT id, public_key, private_key, validity_days FROM termix_identity_ca WHERE identity_id = 7`,
)) as {
id: number;
public_key: string;
private_key: string;
validity_days: number;
};
}[];
expect(created.privateKey).toBe("decrypted-ca-private");
expect(raw.private_key).toBe("encrypted-ca-private");
@@ -131,13 +95,12 @@ describe("TermixIdentityCaRepository", () => {
});
it("reads public CA metadata without decrypting private key material", async () => {
const { repo, sqlite } = await createRepository();
const { repo } = await createRepository();
const decryptSpy = vi.spyOn(DataCrypto, "decryptRecord");
sqlite
.prepare(
"INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (?, ?, ?, ?, ?)",
)
.run(7, "user-1", "ssh-ed25519 public", "encrypted-ca-private", 45);
await adapter!.run(
sql`INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days)
VALUES (7, 'user-1', 'ssh-ed25519 public', 'encrypted-ca-private', 45)`,
);
await expect(repo.findPublicByIdentityId(7)).resolves.toEqual({
publicKey: "ssh-ed25519 public",
@@ -147,13 +110,12 @@ describe("TermixIdentityCaRepository", () => {
});
it("decrypts CA private keys through the user data boundary", async () => {
const { repo, sqlite } = await createRepository();
const { repo } = await createRepository();
mockCrypto();
sqlite
.prepare(
"INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (?, ?, ?, ?, ?)",
)
.run(7, "user-1", "ssh-ed25519 public", "encrypted-ca-private", 45);
await adapter!.run(
sql`INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days)
VALUES (7, 'user-1', 'ssh-ed25519 public', 'encrypted-ca-private', 45)`,
);
const ca = await repo.findDecryptedByIdentityId("user-1", 7);
@@ -172,13 +134,11 @@ describe("TermixIdentityCaRepository", () => {
});
it("updates CA private keys through encrypted writes", async () => {
const { repo, sqlite, onWrite } = await createRepository();
const { repo, onWrite } = await createRepository();
mockCrypto();
sqlite
.prepare(
"INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (?, ?, ?, ?, ?)",
)
.run(7, "user-1", "ssh-ed25519 old", "encrypted-ca-private", 45);
await adapter!.run(
sql`INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (7, 'user-1', 'ssh-ed25519 old', 'encrypted-ca-private', 45)`,
);
onWrite.mockClear();
const updated = await repo.updateEncryptedForIdentity("user-1", 7, {
@@ -187,15 +147,13 @@ describe("TermixIdentityCaRepository", () => {
validityDays: 90,
});
const raw = sqlite
.prepare(
"SELECT public_key, private_key, validity_days FROM termix_identity_ca WHERE identity_id = ?",
)
.get(7) as {
const [raw] = (await adapter!.query(
sql`SELECT public_key, private_key, validity_days FROM termix_identity_ca WHERE identity_id = 7`,
)) as {
public_key: string;
private_key: string;
validity_days: number;
};
}[];
expect(updated).toMatchObject({
publicKey: "ssh-ed25519 new",
@@ -219,55 +177,47 @@ describe("TermixIdentityCaRepository", () => {
});
it("deletes CA rows through the write boundary", async () => {
const { repo, sqlite, onWrite } = await createRepository();
sqlite
.prepare(
"INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (?, ?, ?, ?, ?)",
)
.run(7, "user-1", "ssh-ed25519 public", "encrypted-ca-private", 45);
const { repo, onWrite } = await createRepository();
await adapter!.run(
sql`INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (7, 'user-1', 'ssh-ed25519 public', 'encrypted-ca-private', 45)`,
);
onWrite.mockClear();
await expect(repo.deleteByIdentityId(7)).resolves.toBe(true);
await expect(repo.deleteByIdentityId(7)).resolves.toBe(false);
expect(
sqlite.prepare("SELECT COUNT(*) AS count FROM termix_identity_ca").get(),
).toEqual({ count: 0 });
(
await adapter!.query(
sql`SELECT COUNT(*) AS count FROM termix_identity_ca`,
)
).map((row) => Number((row as { count: unknown }).count)),
).toEqual([0]);
expect(onWrite).toHaveBeenCalledTimes(1);
});
it("deletes CA rows for a user", async () => {
const { repo, sqlite, onWrite } = await createRepository();
sqlite
.prepare(
"INSERT INTO users (id, username, password_hash) VALUES (?, ?, ?)",
)
.run("user-2", "bob", "hash");
sqlite
.prepare(
"INSERT INTO termix_identities (id, user_id, handle) VALUES (?, ?, ?)",
)
.run(8, "user-2", "bob");
sqlite
.prepare(
"INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (?, ?, ?, ?, ?)",
)
.run(7, "user-1", "ssh-ed25519 public", "encrypted-ca-private", 45);
sqlite
.prepare(
"INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (?, ?, ?, ?, ?)",
)
.run(8, "user-2", "ssh-ed25519 other", "encrypted-other", 90);
const { repo, onWrite } = await createRepository();
await adapter!.run(
sql`INSERT INTO users (id, username, password_hash) VALUES ('user-2', 'bob', 'hash')`,
);
await adapter!.run(
sql`INSERT INTO termix_identities (id, user_id, handle) VALUES (8, 'user-2', 'bob')`,
);
await adapter!.run(
sql`INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (7, 'user-1', 'ssh-ed25519 public', 'encrypted-ca-private', 45)`,
);
await adapter!.run(
sql`INSERT INTO termix_identity_ca (identity_id, user_id, public_key, private_key, validity_days) VALUES (8, 'user-2', 'ssh-ed25519 other', 'encrypted-other', 90)`,
);
onWrite.mockClear();
await expect(repo.deleteByUserId("user-1")).resolves.toBe(1);
await expect(repo.deleteByUserId("missing")).resolves.toBe(0);
expect(
sqlite
.prepare(
"SELECT user_id, public_key FROM termix_identity_ca ORDER BY user_id",
)
.all(),
await adapter!.query(
sql`SELECT user_id, public_key FROM termix_identity_ca ORDER BY user_id`,
),
).toEqual([{ user_id: "user-2", public_key: "ssh-ed25519 other" }]);
expect(onWrite).toHaveBeenCalledTimes(1);
});
@@ -18,44 +18,12 @@ describe("TermixIdentityRepository", () => {
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE termix_identities (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL UNIQUE,
handle TEXT NOT NULL UNIQUE,
description TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
CREATE TABLE termix_identity_keys (
id INTEGER PRIMARY KEY AUTOINCREMENT,
identity_id INTEGER NOT NULL,
user_id TEXT NOT NULL,
public_key TEXT NOT NULL,
key_type TEXT NOT NULL,
algorithm TEXT NOT NULL,
label TEXT,
comment TEXT,
source TEXT NOT NULL DEFAULT 'manual',
credential_id INTEGER,
enabled INTEGER NOT NULL DEFAULT 1,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (identity_id) REFERENCES termix_identities(id) ON DELETE CASCADE,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO ssh_credentials (id, user_id, name, username, auth_type) VALUES
(10, 'user-1', 'cred-10', 'root', 'password'),
(20, 'user-1', 'cred-20', 'root', 'password');
`);
return {
@@ -1,17 +1,59 @@
import Database from "better-sqlite3";
import { drizzle } from "drizzle-orm/better-sqlite3";
import {
getTableColumns,
getTableName,
is,
sql,
Table,
type SQL,
} from "drizzle-orm";
import fs from "fs";
import path from "path";
import * as schema from "../../../database/db/schema.js";
import type { DatabaseContext } from "../../../database/repositories/database-context.js";
import type { DatabaseDialect } from "../../../database/db/dialect.js";
/**
* Which engine the repository tests run against.
*
* Defaults to SQLite, so `npm test` behaves as it always has and needs no
* server. Set TEST_DIALECT=postgres or mysql, plus TEST_DATABASE_URL, to run
* the same tests against a real one see the database-dialects CI job.
*/
export function testDialect(env = process.env): DatabaseDialect {
const value = env.TEST_DIALECT?.trim().toLowerCase();
if (value === "postgres" || value === "mysql") return value;
return "sqlite";
}
/** Every table drizzle knows about, for wiping between tests. */
function allTableNames(): string[] {
return Object.values(schema)
.filter((value) => is(value, Table))
.map((table) => getTableName(table as Table));
}
export class TestSqliteDatabase {
private sqlite: Database.Database | null = null;
private context: DatabaseContext | null = null;
private readonly dialect: DatabaseDialect;
constructor(dialect: DatabaseDialect = testDialect()) {
this.dialect = dialect;
}
async connect(): Promise<DatabaseContext> {
if (this.context) return this.context;
if (this.dialect !== "sqlite") {
this.context = await this.connectRemote();
return this.context;
}
this.sqlite = new Database(":memory:");
this.sqlite.exec("PRAGMA foreign_keys = ON");
this.sqlite.exec(sqliteSchemaSql());
this.context = {
dialect: "sqlite",
drizzle: drizzle(this.sqlite, { schema }),
@@ -20,31 +62,393 @@ export class TestSqliteDatabase {
return this.context;
}
/**
* Schema setup for tests. Lives on the fixture rather than on
* DatabaseContext, which is drizzle-only so that no repository can reach for
* engine-specific SQL.
*/
/** Raw handle for assertions that read the database directly. Tests only. */
get raw(): Database.Database {
if (!this.sqlite) {
throw new Error("connect() must be called before raw access");
private async connectRemote(): Promise<DatabaseContext> {
const url = process.env.TEST_DATABASE_URL;
if (!url) {
throw new Error(
`TEST_DIALECT=${this.dialect} requires TEST_DATABASE_URL to be set.`,
);
}
return this.sqlite;
const { drizzle: connect } = await import(
this.dialect === "postgres"
? "drizzle-orm/node-postgres"
: "drizzle-orm/mysql2"
);
const db = connect(url) as unknown as DatabaseContext["drizzle"];
const context: DatabaseContext = { dialect: this.dialect, drizzle: db };
await migrateOnce(this.dialect, db);
await truncateAll(context);
return context;
}
exec(sql: string): void {
if (!this.sqlite) {
throw new Error("connect() must be called before exec()");
/**
* Runs seed SQL. Synchronous on SQLite, which is what the tests were written
* against; on the other engines it returns a promise the caller must await.
*
* The seeds are plain INSERTs, portable apart from identifier quoting, which
* `portableSql` fixes up.
*/
exec(statements: string): void | Promise<void> {
if (this.sqlite) {
this.sqlite.exec(statements);
return;
}
this.sqlite.exec(sql);
const context = this.context;
if (!context) throw new Error("connect() must be called before exec()");
return (async () => {
const touched = new Set<string>();
for (const statement of splitStatements(statements)) {
await runSql(context, sql.raw(portableSql(statement, context.dialect)));
const table = /INSERT INTO\s+([a-z_]+)/i.exec(statement)?.[1];
if (table) touched.add(table);
}
await resyncAutoIncrement(context, touched);
})();
}
/**
* Portable read for assertions. Build the statement with drizzle's `sql`
* template so placeholders and quoting come out right on each engine.
*/
async query<T = Record<string, unknown>>(statement: SQL): Promise<T[]> {
if (!this.context)
throw new Error("connect() must be called before query()");
return runSql<T>(this.context, statement);
}
/**
* Portable write for test setup.
*
* Separate from query() because better-sqlite3 refuses `.all()` on a
* statement that returns no rows "This statement does not return data".
*/
async run(statement: SQL): Promise<void> {
const context = this.context;
if (!context) throw new Error("connect() must be called before run()");
if (this.sqlite) {
(context.drizzle as unknown as { run: (s: SQL) => unknown }).run(
statement,
);
return;
}
await runSql(context, statement);
}
async close(): Promise<void> {
if (this.sqlite) {
this.sqlite.close();
this.sqlite = null;
this.context = null;
}
this.context = null;
}
}
async function runSql<T>(
context: DatabaseContext,
statement: SQL,
): Promise<T[]> {
const db = context.drizzle as unknown as {
all?: (s: SQL) => Promise<T[]> | T[];
execute?: (s: SQL) => Promise<unknown>;
};
if (context.dialect === "sqlite" && db.all) {
return (await db.all(statement)) as T[];
}
const result = (await db.execute!(statement)) as
| { rows?: T[] }
| T[]
| undefined;
// mysql2 answers [rows, fields]; node-postgres answers { rows }.
if (Array.isArray(result)) {
return (Array.isArray(result[0]) ? result[0] : result) as T[];
}
return (result?.rows ?? []) as T[];
}
/**
* Empties every table between tests on the client-server engines, where the
* database outlives the process and cannot be thrown away like an in-memory
* SQLite one.
*/
async function truncateAll(context: DatabaseContext): Promise<void> {
const tables = allTableNames();
if (context.dialect === "postgres") {
const list = tables.map((t) => `"${t}"`).join(", ");
await runSql(
context,
sql.raw(`TRUNCATE TABLE ${list} RESTART IDENTITY CASCADE`),
);
return;
}
// Truncating all 53 tables takes ~2s on MySQL, which every test would pay.
// Ask which ones actually hold rows first: after the first test only a
// handful do, and the check is a single query.
// Each branch is parenthesised: LIMIT binds to the whole UNION otherwise.
const counts = tables
.map((t) => `(SELECT '${t}' AS name FROM \`${t}\` LIMIT 1)`)
.join(" UNION ALL ");
const occupied = await runSql<{ name: string }>(context, sql.raw(counts));
if (occupied.length === 0) return;
await runSql(context, sql.raw("SET FOREIGN_KEY_CHECKS = 0"));
for (const { name } of occupied) {
await runSql(context, sql.raw(`TRUNCATE TABLE \`${name}\``));
}
await runSql(context, sql.raw("SET FOREIGN_KEY_CHECKS = 1"));
}
/**
* Splits seed SQL into statements, ignoring semicolons inside string literals
* JSON payloads in the fixtures contain them.
*/
function splitStatements(sql: string): string[] {
const out: string[] = [];
let current = "";
let inString = false;
for (let i = 0; i < sql.length; i++) {
const ch = sql[i];
if (ch === "'") {
// '' is an escaped quote inside a string, not a delimiter.
if (inString && sql[i + 1] === "'") {
current += "''";
i++;
continue;
}
inString = !inString;
}
if (ch === ";" && !inString) {
if (current.trim()) out.push(current.trim());
current = "";
continue;
}
current += ch;
}
if (current.trim()) out.push(current.trim());
return out;
}
let cachedBooleanColumns: Set<string> | null = null;
/**
* Columns the schema declares as booleans, by table.column.
*
* Read from drizzle rather than listed here, so a new boolean column needs no
* change in this file.
*/
function booleanColumns(): Set<string> {
if (cachedBooleanColumns) return cachedBooleanColumns;
const found = new Set<string>();
for (const value of Object.values(schema)) {
if (!is(value, Table)) continue;
const table = getTableName(value as Table);
for (const column of Object.values(getTableColumns(value as Table))) {
if (column.dataType === "boolean") found.add(`${table}.${column.name}`);
}
}
cachedBooleanColumns = found;
return found;
}
/**
* Seeds are written in SQLite's dialect. Two things do not carry:
*
* - a reserved word used as a column name is `"order"` on SQLite and Postgres,
* `` `order` `` on MySQL
* - SQLite stores booleans as 0/1, and writing an integer into a native boolean
* column is an error on Postgres. Every engine understands the TRUE/FALSE
* keywords, so boolean columns are rewritten to those.
*/
function portableSql(statement: string, dialect: DatabaseDialect): string {
const out = rewriteBooleanLiterals(statement);
if (dialect !== "mysql") return out;
// Only the column list, before VALUES. A blanket replace also mangles the
// double quotes inside JSON payloads in the values — '{"slots":[]}' became
// '{`slots`:[]}', which is valid SQL and silently wrong data.
const split = /^(.*?\bVALUES\b)(.*)$/is.exec(out);
if (!split) return out.replace(/"([a-z_]+)"/g, "`$1`");
return split[1].replace(/"([a-z_]+)"/g, "`$1`") + split[2];
}
/** Rewrites 0/1 to FALSE/TRUE in the value positions of boolean columns. */
function rewriteBooleanLiterals(statement: string): string {
const booleans = booleanColumns();
return statement.replace(
/INSERT INTO\s+([a-z_]+)\s*\(([^)]*)\)\s*VALUES\s*((?:\([^()]*\)\s*,?\s*)+)/gis,
(whole, table: string, cols: string, values: string) => {
const names = cols.split(",").map((c) => c.trim().replace(/["`]/g, ""));
const flags = names.map((n) => booleans.has(`${table}.${n}`));
if (!flags.some(Boolean)) return whole;
const rewritten = values.replace(
/\(([^()]*)\)/g,
(row, inner: string) => {
const parts = splitValues(inner);
return `(${parts
.map((v, i) =>
flags[i] && /^[01]$/.test(v.trim())
? v.trim() === "1"
? "TRUE"
: "FALSE"
: v,
)
.join(",")})`;
},
);
return `INSERT INTO ${table} (${cols}) VALUES ${rewritten}`;
},
);
}
/** Splits a VALUES row on commas that are not inside a string literal. */
function splitValues(row: string): string[] {
const parts: string[] = [];
let current = "";
let inString = false;
for (let i = 0; i < row.length; i++) {
const ch = row[i];
if (ch === "'") {
if (inString && row[i + 1] === "'") {
current += "''";
i++;
continue;
}
inString = !inString;
}
if (ch === "," && !inString) {
parts.push(current);
current = "";
continue;
}
current += ch;
}
parts.push(current);
return parts;
}
/**
* Moves each table's id generator past the ids the seed inserted by hand.
*
* SQLite picks `max(id) + 1` when a row omits the key, so a fixture that writes
* `id = 1, 2, 3` and then lets the repository insert one more just works. A
* Postgres sequence or a MySQL auto_increment counter does not know about rows
* inserted with an explicit id, so it hands out 1 again and the insert collides
* with the fixture's own data.
*/
async function resyncAutoIncrement(
context: DatabaseContext,
tables: Set<string>,
): Promise<void> {
for (const table of tables) {
// Only tables whose id is generated. A text primary key, like users.id,
// has no sequence and no counter to move.
if (context.dialect === "postgres") {
const [seq] = await runSql<{ name: string | null }>(
context,
sql.raw(`SELECT pg_get_serial_sequence('${table}', 'id') AS name`),
);
if (!seq?.name) continue;
await runSql(
context,
sql.raw(
`SELECT setval('${seq.name}', ` +
`COALESCE((SELECT MAX(id) FROM "${table}"), 0) + 1, false)`,
),
);
continue;
}
const [column] = await runSql<{ extra: string }>(
context,
sql.raw(
`SELECT EXTRA AS extra FROM information_schema.columns ` +
`WHERE TABLE_SCHEMA = DATABASE() AND TABLE_NAME = '${table}' ` +
`AND COLUMN_NAME = 'id'`,
),
);
if (!column?.extra?.includes("auto_increment")) continue;
const [row] = await runSql<{ next: number | null }>(
context,
sql.raw(`SELECT MAX(id) + 1 AS next FROM \`${table}\``),
);
if (row?.next) {
await runSql(
context,
sql.raw(`ALTER TABLE \`${table}\` AUTO_INCREMENT = ${row.next}`),
);
}
}
}
/**
* Migrations run once per worker, not once per fixture.
*
* Every test builds a fixture, and each would otherwise re-run the migrator
* against the same shared database. drizzle's journal makes that a no-op only
* when the first run finished several fixtures racing inside one file hit
* "table already exists" instead.
*/
const migrations = new Map<string, Promise<void>>();
function migrateOnce(
dialect: DatabaseDialect,
db: DatabaseContext["drizzle"],
): Promise<void> {
const key = `${dialect}:${process.env.TEST_DATABASE_URL}`;
let running = migrations.get(key);
if (!running) {
running = (async () => {
const { runRemoteMigrations } =
await import("../../../database/db/migrate.js");
await runRemoteMigrations(dialect, db);
})();
migrations.set(key, running);
}
return running;
}
let cachedSqliteSchema: string | null = null;
/**
* The full schema, from the generated SQLite migration rather than hand-written
* DDL in each test file.
*
* Tests used to declare a cut-down version of every table they touched a
* `users` with five columns where the real one has thirty. That drifts from the
* schema silently, and it is the reason the same tests could not be pointed at
* another engine.
*/
function sqliteSchemaSql(): string {
if (cachedSqliteSchema) return cachedSqliteSchema;
const dir = path.resolve(process.cwd(), "drizzle", "sqlite");
const file = fs
.readdirSync(dir)
.filter((name) => name.endsWith(".sql"))
.sort()
.at(-1);
if (!file) throw new Error(`No SQLite migration found in ${dir}`);
cachedSqliteSchema = fs
.readFileSync(path.join(dir, file), "utf8")
.split("--> statement-breakpoint")
.join("\n");
return cachedSqliteSchema;
}
@@ -17,32 +17,11 @@ describe("TmuxSessionTagRepository", () => {
): Promise<TmuxSessionTagRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE tmux_session_tags (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
host_id INTEGER NOT NULL,
session_name TEXT NOT NULL,
tag TEXT NOT NULL,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'one'), (2, 'user-2', 'two');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'one', '10.0.0.1', 22, 'root', 'password'), (2, 'user-2', 'two', '10.0.0.1', 22, 'root', 'password');
INSERT INTO tmux_session_tags (user_id, host_id, session_name, tag)
VALUES
('user-1', 1, 'api', 'prod'),
@@ -17,33 +17,11 @@ describe("TransferRecentRepository", () => {
): Promise<TransferRecentRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE hosts (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL
);
CREATE TABLE transfer_recent (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
source_host_id INTEGER NOT NULL,
dest_host_id INTEGER NOT NULL,
dest_path TEXT NOT NULL,
dest_path_label TEXT NOT NULL,
last_used TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO hosts (id, user_id, name)
VALUES (1, 'user-1', 'source'), (2, 'user-1', 'dest-a'), (3, 'user-1', 'dest-b'), (4, 'user-2', 'other');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES (1, 'user-1', 'source', '10.0.0.1', 22, 'root', 'password'), (2, 'user-1', 'dest-a', '10.0.0.1', 22, 'root', 'password'), (3, 'user-1', 'dest-b', '10.0.0.1', 22, 'root', 'password'), (4, 'user-2', 'other', '10.0.0.1', 22, 'root', 'password');
`);
return new TransferRecentRepository(context, onWrite);
@@ -17,27 +17,7 @@ describe("TrustedDeviceRepository", () => {
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE trusted_devices (
id TEXT PRIMARY KEY,
user_id TEXT NOT NULL,
device_fingerprint TEXT NOT NULL,
device_type TEXT NOT NULL,
device_info TEXT NOT NULL,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
expires_at TEXT NOT NULL,
last_used_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash) VALUES
('user-1', 'admin', 'hash'),
('user-2', 'user', 'hash');
@@ -15,146 +15,17 @@ describe("UserDataExportRepository", () => {
async function createRepository(): Promise<UserDataExportRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE ssh_data (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
connection_type TEXT NOT NULL DEFAULT 'ssh',
name TEXT,
ip TEXT NOT NULL,
port INTEGER NOT NULL,
username TEXT NOT NULL,
folder TEXT,
tags TEXT,
pin INTEGER NOT NULL DEFAULT 0,
auth_type TEXT NOT NULL,
use_warpgate INTEGER NOT NULL DEFAULT 0,
force_keyboard_interactive TEXT,
password TEXT,
key TEXT,
key_password TEXT,
key_type TEXT,
sudo_password TEXT,
autostart_password TEXT,
autostart_key TEXT,
autostart_key_password TEXT,
credential_id INTEGER,
override_credential_username INTEGER,
vault_profile_id INTEGER,
enable_terminal INTEGER NOT NULL DEFAULT 1,
enable_session_logging INTEGER NOT NULL DEFAULT 1,
allow_session_sharing INTEGER NOT NULL DEFAULT 1,
enable_command_history INTEGER NOT NULL DEFAULT 1,
enable_tunnel INTEGER NOT NULL DEFAULT 1,
tunnel_connections TEXT,
jump_hosts TEXT,
enable_file_manager INTEGER NOT NULL DEFAULT 1,
scp_legacy INTEGER NOT NULL DEFAULT 0,
enable_docker INTEGER NOT NULL DEFAULT 0,
enable_tmux_monitor INTEGER NOT NULL DEFAULT 0,
show_terminal_in_sidebar INTEGER NOT NULL DEFAULT 1,
show_file_manager_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_tunnel_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_docker_in_sidebar INTEGER NOT NULL DEFAULT 0,
show_server_stats_in_sidebar INTEGER NOT NULL DEFAULT 0,
default_path TEXT,
stats_config TEXT,
docker_config TEXT,
enable_proxmox INTEGER NOT NULL DEFAULT 0,
proxmox_config TEXT,
terminal_config TEXT,
quick_actions TEXT,
notes TEXT,
enable_ssh INTEGER NOT NULL DEFAULT 1,
enable_rdp INTEGER NOT NULL DEFAULT 0,
enable_vnc INTEGER NOT NULL DEFAULT 0,
enable_telnet INTEGER NOT NULL DEFAULT 0,
ssh_port INTEGER DEFAULT 22,
rdp_port INTEGER DEFAULT 3389,
vnc_port INTEGER DEFAULT 5900,
telnet_port INTEGER DEFAULT 23,
rdp_credential_id INTEGER,
rdp_user TEXT,
rdp_password TEXT,
rdp_domain TEXT,
rdp_security TEXT,
rdp_ignore_cert INTEGER DEFAULT 0,
vnc_credential_id INTEGER,
vnc_password TEXT,
vnc_user TEXT,
telnet_user TEXT,
telnet_password TEXT,
telnet_credential_id INTEGER,
rdp_auth_type TEXT,
vnc_auth_type TEXT,
telnet_auth_type TEXT,
domain TEXT,
security TEXT,
ignore_cert INTEGER DEFAULT 0,
guacamole_config TEXT,
use_socks5 INTEGER,
socks5_host TEXT,
socks5_port INTEGER,
socks5_username TEXT,
socks5_password TEXT,
socks5_proxy_chain TEXT,
mac_address TEXT,
wol_broadcast_address TEXT,
port_knock_sequence TEXT,
host_key_fingerprint TEXT,
host_key_type TEXT,
host_key_algorithm TEXT DEFAULT 'sha256',
host_key_first_seen TEXT,
host_key_last_verified TEXT,
host_key_changed_count INTEGER DEFAULT 0,
connection_origin TEXT,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
CREATE TABLE ssh_credentials (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
description TEXT,
folder TEXT,
tags TEXT,
auth_type TEXT NOT NULL,
username TEXT,
password TEXT,
key TEXT,
private_key TEXT,
public_key TEXT,
key_password TEXT,
key_type TEXT,
detected_key_type TEXT,
cert_public_key TEXT,
usage_count INTEGER NOT NULL DEFAULT 0,
last_used TEXT,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES
(1, 'user-1', 'web', '10.0.0.1', 22, 'root', 'password'),
(2, 'user-2', 'db', '10.0.0.2', 22, 'root', 'password');
INSERT INTO ssh_credentials (id, user_id, name, auth_type, username, password)
VALUES
(1, 'user-1', 'prod', 'password', 'root', 'secret'),
(2, 'user-2', 'other', 'password', 'root', 'secret');
INSERT INTO ssh_data (id, user_id, name, ip, port, username, auth_type)
VALUES
(1, 'user-1', 'web', '10.0.0.1', 22, 'root', 'password'),
(2, 'user-2', 'db', '10.0.0.2', 22, 'root', 'password');
`);
return new UserDataExportRepository(context);
@@ -17,41 +17,7 @@ describe("UserPreferenceRepository", () => {
): Promise<UserPreferenceRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE user_preferences (
user_id TEXT PRIMARY KEY,
reopen_tabs_on_login INTEGER NOT NULL DEFAULT 0,
theme TEXT,
font_size TEXT,
accent_color TEXT,
language TEXT,
storage_mode TEXT,
command_autocomplete INTEGER,
command_palette_enabled INTEGER,
show_host_tags INTEGER,
host_tray_on_click INTEGER,
pin_app_rail INTEGER,
expand_app_rail_on_hover INTEGER,
folders_collapsed INTEGER,
confirm_snippet_execution INTEGER,
disable_update_check INTEGER,
confirm_tab_close INTEGER,
hidden_rail_tabs TEXT,
compact_host_view INTEGER,
status_color_scheme TEXT,
custom_themes TEXT,
custom_keybindings TEXT,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash');
`);
@@ -35,45 +35,6 @@ describe("UserRepository and SessionRepository", () => {
}> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL,
is_admin INTEGER NOT NULL DEFAULT 0,
is_oidc INTEGER NOT NULL DEFAULT 0,
oidc_identifier TEXT,
sso_provider_id INTEGER,
client_id TEXT,
client_secret TEXT,
issuer_url TEXT,
authorization_url TEXT,
token_url TEXT,
identifier_path TEXT,
name_path TEXT,
scopes TEXT DEFAULT 'openid email profile',
totp_secret TEXT,
totp_enabled INTEGER NOT NULL DEFAULT 0,
totp_backup_codes TEXT,
registered_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
donation_modal_dismissed INTEGER NOT NULL DEFAULT 0
);
CREATE TABLE sessions (
id TEXT PRIMARY KEY,
user_id TEXT NOT NULL,
jwt_token TEXT NOT NULL,
device_type TEXT NOT NULL,
device_info TEXT NOT NULL,
oidc_sub TEXT,
oidc_sid TEXT,
sso_provider_id INTEGER,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
expires_at TEXT NOT NULL,
last_active_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
FOREIGN KEY (user_id) REFERENCES users(id) ON DELETE CASCADE
);
`);
return {
users: new UserRepository(context, options.onUserWrite),
@@ -17,41 +17,13 @@ describe("VaultProfileRepository", () => {
): Promise<VaultProfileRepository> {
adapter = new TestSqliteDatabase();
const context = await adapter.connect();
adapter.exec(`
CREATE TABLE users (
id TEXT PRIMARY KEY,
username TEXT NOT NULL,
password_hash TEXT NOT NULL
);
CREATE TABLE vault_profiles (
id INTEGER PRIMARY KEY AUTOINCREMENT,
user_id TEXT NOT NULL,
name TEXT NOT NULL,
description TEXT,
folder TEXT,
tags TEXT,
vault_addr TEXT NOT NULL,
vault_namespace TEXT,
oidc_mount TEXT,
oidc_role TEXT,
ssh_mount TEXT,
ssh_role TEXT NOT NULL,
valid_principals TEXT,
key_type TEXT,
shared INTEGER NOT NULL DEFAULT 0,
sync_id TEXT,
created_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
updated_at TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP
);
await adapter.exec(`
INSERT INTO users (id, username, password_hash)
VALUES ('user-1', 'alice', 'hash'), ('user-2', 'bob', 'hash');
INSERT INTO vault_profiles (
id, user_id, name, vault_addr, ssh_role, shared, updated_at
)
VALUES
(1, 'user-1', 'owned', 'https://vault.one', 'role-one', 0, '2026-01-01T00:00:00.000Z'),
VALUES (1, 'user-1', 'owned', 'https://vault.one', 'role-one', 0, '2026-01-01T00:00:00.000Z'),
(2, 'user-2', 'shared', 'https://vault.two', 'role-two', 1, '2026-01-02T00:00:00.000Z'),
(3, 'user-2', 'hidden', 'https://vault.three', 'role-three', 0, '2026-01-03T00:00:00.000Z');
`);

Some files were not shown because too many files have changed in this diff Show More