Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2025-01-20 22:12:38 -05:00
Code Issues Activity

Prevent importing db core from db runtime (#10568)

Browse source 
* Prevent importing db core from db runtime

* Move runtime errors into runtime

* Add changeset
This commit is contained in:
Matthew Phillips 2024-03-27 09:04:39 -04:00 • committed by GitHub
parent bb7707e171
commit 764d67fc3f
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 58 additions and 34 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/sixty-eels-camp.md Normal file
View file

@ -0,0 +1,5 @@
---
"@astrojs/db": patch
---
Prevent runtime from importing core code

18
.eslintrc.cjs
View file

@ -136,5 +136,23 @@ module.exports = {
'arrow-body-style': ['error', 'never'],
},
},
{
files: ['packages/db/src/runtime/**/*.ts'],
rules: {
'no-restricted-imports': 'off',
'@typescript-eslint/no-restricted-imports': [
'error',
{
patterns: [
{
group: ['../core/*'],
allowTypeImports: true,
}
]
}
]
}
}
],
};

32
packages/db/src/core/errors.ts
View file

@ -37,46 +37,14 @@ export const SHELL_QUERY_MISSING_ERROR = `${red(
'▶ Please provide a query to execute using the --query flag.'
)}\n`;
export const SEED_ERROR = (error: string) => {
return `${red(`Error while seeding database:`)}\n\n${error}`;
};
export const EXEC_ERROR = (error: string) => {
return `${red(`Error while executing file:`)}\n\n${error}`;
};
export const SEED_DEFAULT_EXPORT_ERROR = (fileName: string) => {
return SEED_ERROR(`Missing default function export in ${bold(fileName)}`);
};
export const EXEC_DEFAULT_EXPORT_ERROR = (fileName: string) => {
return EXEC_ERROR(`Missing default function export in ${bold(fileName)}`);
};
export const REFERENCE_DNE_ERROR = (columnName: string) => {
return `Column ${bold(
columnName
)} references a table that does not exist. Did you apply the referenced table to the \`tables\` object in your db config?`;
};
export const FOREIGN_KEY_DNE_ERROR = (tableName: string) => {
return `Table ${bold(
tableName
)} references a table that does not exist. Did you apply the referenced table to the \`tables\` object in your db config?`;
};
export const FOREIGN_KEY_REFERENCES_LENGTH_ERROR = (tableName: string) => {
return `Foreign key on ${bold(
tableName
)} is misconfigured. \`columns\` and \`references\` must be the same length.`;
};
export const FOREIGN_KEY_REFERENCES_EMPTY_ERROR = (tableName: string) => {
return `Foreign key on ${bold(
tableName
)} is misconfigured. \`references\` array cannot be empty.`;
};
export const INTEGRATION_TABLE_CONFLICT_ERROR = (
integrationName: string,
tableName: string,

33
packages/db/src/runtime/errors.ts Normal file
View file

@ -0,0 +1,33 @@
import { bold, red } from 'kleur/colors';
export const FOREIGN_KEY_DNE_ERROR = (tableName: string) => {
return `Table ${bold(
tableName
)} references a table that does not exist. Did you apply the referenced table to the \`tables\` object in your db config?`;
};
export const FOREIGN_KEY_REFERENCES_LENGTH_ERROR = (tableName: string) => {
return `Foreign key on ${bold(
tableName
)} is misconfigured. \`columns\` and \`references\` must be the same length.`;
};
export const FOREIGN_KEY_REFERENCES_EMPTY_ERROR = (tableName: string) => {
return `Foreign key on ${bold(
tableName
)} is misconfigured. \`references\` array cannot be empty.`;
};
export const REFERENCE_DNE_ERROR = (columnName: string) => {
return `Column ${bold(
columnName
)} references a table that does not exist. Did you apply the referenced table to the \`tables\` object in your db config?`;
};
export const SEED_ERROR = (error: string) => {
return `${red(`Error while seeding database:`)}\n\n${error}`;
};
export const SEED_DEFAULT_EXPORT_ERROR = (fileName: string) => {
return SEED_ERROR(`Missing default function export in ${bold(fileName)}`);
};

2
packages/db/src/runtime/queries.ts
View file

@ -6,7 +6,7 @@ import {
FOREIGN_KEY_REFERENCES_EMPTY_ERROR,
FOREIGN_KEY_REFERENCES_LENGTH_ERROR,
REFERENCE_DNE_ERROR,
} from '../core/errors.js';
} from './errors.js';
import type {
BooleanColumn,
ColumnType,

2
packages/db/src/runtime/seed-local.ts
View file

@ -2,7 +2,7 @@ import { LibsqlError } from '@libsql/client';
import { type SQL, sql } from 'drizzle-orm';
import type { LibSQLDatabase } from 'drizzle-orm/libsql';
import { SQLiteAsyncDialect } from 'drizzle-orm/sqlite-core';
import { SEED_DEFAULT_EXPORT_ERROR, SEED_ERROR } from '../core/errors.js';
import { SEED_DEFAULT_EXPORT_ERROR, SEED_ERROR } from './errors.js';
import { type DBTables } from '../core/types.js';
import { getCreateIndexQueries, getCreateTableQuery } from './queries.js';