Skip to content

Commit

Permalink
Prevent importing db core from db runtime (#10568)
Browse files Browse the repository at this point in the history
* Prevent importing db core from db runtime

* Move runtime errors into runtime

* Add changeset
  • Loading branch information
matthewp authored Mar 27, 2024
1 parent bb7707e commit 764d67f
Show file tree
Hide file tree
Showing 6 changed files with 58 additions and 34 deletions.
5 changes: 5 additions & 0 deletions .changeset/sixty-eels-camp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@astrojs/db": patch
---

Prevent runtime from importing core code
18 changes: 18 additions & 0 deletions .eslintrc.cjs
Original file line number Diff line number Diff line change
Expand Up @@ -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 changes: 0 additions & 32 deletions packages/db/src/core/errors.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
33 changes: 33 additions & 0 deletions packages/db/src/runtime/errors.ts
Original file line number Diff line number Diff line change
@@ -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 changes: 1 addition & 1 deletion packages/db/src/runtime/queries.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down
2 changes: 1 addition & 1 deletion packages/db/src/runtime/seed-local.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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';

Expand Down

0 comments on commit 764d67f

Please sign in to comment.