1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
|
import type { InStatement } from '@libsql/client';
import { createClient } from '@libsql/client';
import type { LibSQLDatabase } from 'drizzle-orm/libsql';
import { drizzle as drizzleLibsql } from 'drizzle-orm/libsql';
import { type SqliteRemoteDatabase, drizzle as drizzleProxy } from 'drizzle-orm/sqlite-proxy';
import { z } from 'zod';
import { DetailedLibsqlError, safeFetch } from './utils.js';
const isWebContainer = !!process.versions?.webcontainer;
function applyTransactionNotSupported(db: SqliteRemoteDatabase) {
Object.assign(db, {
transaction() {
throw new Error(
'`db.transaction()` is not currently supported. We recommend `db.batch()` for automatic error rollbacks across multiple queries.',
);
},
});
}
export function createLocalDatabaseClient({ dbUrl }: { dbUrl: string }): LibSQLDatabase {
const url = isWebContainer ? 'file:content.db' : dbUrl;
const client = createClient({ url });
const db = drizzleLibsql(client);
applyTransactionNotSupported(db);
return db;
}
const remoteResultSchema = z.object({
columns: z.array(z.string()),
columnTypes: z.array(z.string()),
rows: z.array(z.array(z.unknown())),
rowsAffected: z.number(),
lastInsertRowid: z.unknown().optional(),
});
export function createRemoteDatabaseClient(appToken: string, remoteDbURL: string) {
if (appToken == null) {
throw new Error(`Cannot create a remote client: missing app token.`);
}
const url = new URL('/db/query', remoteDbURL);
const db = drizzleProxy(
async (sql, parameters, method) => {
const requestBody: InStatement = { sql, args: parameters };
const res = await safeFetch(
url,
{
method: 'POST',
headers: {
Authorization: `Bearer ${appToken}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(requestBody),
},
async (response) => {
throw await parseRemoteError(response);
},
);
let remoteResult: z.infer<typeof remoteResultSchema>;
try {
const json = await res.json();
remoteResult = remoteResultSchema.parse(json);
} catch {
throw new DetailedLibsqlError({
message: await getUnexpectedResponseMessage(res),
code: KNOWN_ERROR_CODES.SQL_QUERY_FAILED,
});
}
if (method === 'run') {
const rawRows = Array.from(remoteResult.rows);
// Implement basic `toJSON()` for Drizzle to serialize properly
(remoteResult as any).rows.toJSON = () => rawRows;
// Using `db.run()` drizzle massages the rows into an object.
// So in order to make dev/prod consistent, we need to do the same here.
// This creates an object and loops over each row replacing it with the object.
for (let i = 0; i < remoteResult.rows.length; i++) {
let row = remoteResult.rows[i];
let item: Record<string, any> = {};
remoteResult.columns.forEach((col, index) => {
item[col] = row[index];
});
(remoteResult as any).rows[i] = item;
}
return remoteResult;
}
// Drizzle expects each row as an array of its values
const rowValues: unknown[][] = [];
for (const row of remoteResult.rows) {
if (row != null && typeof row === 'object') {
rowValues.push(Object.values(row));
}
}
if (method === 'get') {
return { rows: rowValues[0] };
}
return { rows: rowValues };
},
async (queries) => {
const stmts: InStatement[] = queries.map(({ sql, params }) => ({ sql, args: params }));
const res = await safeFetch(
url,
{
method: 'POST',
headers: {
Authorization: `Bearer ${appToken}`,
'Content-Type': 'application/json',
},
body: JSON.stringify(stmts),
},
async (response) => {
throw await parseRemoteError(response);
},
);
let remoteResults: z.infer<typeof remoteResultSchema>[];
try {
const json = await res.json();
remoteResults = z.array(remoteResultSchema).parse(json);
} catch {
throw new DetailedLibsqlError({
message: await getUnexpectedResponseMessage(res),
code: KNOWN_ERROR_CODES.SQL_QUERY_FAILED,
});
}
let results: any[] = [];
for (const [idx, rawResult] of remoteResults.entries()) {
if (queries[idx]?.method === 'run') {
results.push(rawResult);
continue;
}
// Drizzle expects each row as an array of its values
const rowValues: unknown[][] = [];
for (const row of rawResult.rows) {
if (row != null && typeof row === 'object') {
rowValues.push(Object.values(row));
}
}
if (queries[idx]?.method === 'get') {
results.push({ rows: rowValues[0] });
}
results.push({ rows: rowValues });
}
return results;
},
);
applyTransactionNotSupported(db);
return db;
}
const errorSchema = z.object({
success: z.boolean(),
error: z.object({
code: z.string(),
details: z.string().optional(),
}),
});
const KNOWN_ERROR_CODES = {
SQL_QUERY_FAILED: 'SQL_QUERY_FAILED',
};
const getUnexpectedResponseMessage = async (response: Response) =>
`Unexpected response from remote database:\n(Status ${response.status}) ${await response
.clone()
.text()}`;
async function parseRemoteError(response: Response): Promise<DetailedLibsqlError> {
let error;
try {
error = errorSchema.parse(await response.clone().json()).error;
} catch {
return new DetailedLibsqlError({
message: await getUnexpectedResponseMessage(response),
code: KNOWN_ERROR_CODES.SQL_QUERY_FAILED,
});
}
// Strip LibSQL error prefixes
let baseDetails =
error.details?.replace(/.*SQLite error: /, '') ?? 'Error querying remote database.';
// Remove duplicated "code" in details
const details = baseDetails.slice(baseDetails.indexOf(':') + 1).trim();
let hint = `See the Astro DB guide for query and push instructions: https://docs.astro.build/en/guides/astro-db/#query-your-database`;
if (error.code === KNOWN_ERROR_CODES.SQL_QUERY_FAILED && details.includes('no such table')) {
hint = `Did you run \`astro db push\` to push your latest table schemas?`;
}
return new DetailedLibsqlError({ message: details, code: error.code, hint });
}
|
