paulononato/backstage
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

switch us over to better-sqlite3

Browse Source 
Signed-off-by: Fredrik Adelöw <freben@gmail.com>
This commit is contained in:
Fredrik Adelöw
2022-03-11 14:01:35 +01:00
parent 3f21eb4d13
commit efc73db10c
39 changed files with 121 additions and 302 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.changeset/heavy-kangaroos-confess.md
+13
View File
@@ -0,0 +1,13 @@
---
'@backstage/backend-common': patch
'@backstage/backend-tasks': patch
'@backstage/backend-test-utils': patch
'@backstage/plugin-auth-backend': patch
'@backstage/plugin-bazaar-backend': patch
'@backstage/plugin-catalog-backend': patch
'@backstage/plugin-code-coverage-backend': patch
'@backstage/plugin-config-schema': patch
'@backstage/plugin-scaffolder-backend': patch
---
Use `better-sqlite3` instead of `@vscode/sqlite3`
.changeset/warm-impalas-march.md
+24
View File
@@ -0,0 +1,24 @@
---
'@backstage/create-app': patch
---
The main repo has switched from `@vscode/sqlite3` to `better-sqlite3` as its preferred SQLite installation. This decision was triggered by a number of issues with the former that arose because it needs build infrastructure in place and functional in order to be installed. The main drawback of this is that the new package uses the database client ID `better-sqlite3` instead of the plain `sqlite3`.
If you want to perform the same switch in your own repository,
- Replace all of your `package.json` dependencies on `@vscode/sqlite3` with the latest version of `better-sqlite3` instead
```diff
"dependencies": {
- "@vscode/sqlite3": "^5.0.7",
+ "better-sqlite3": "^7.5.0",
```
- In your app-config and tests, wherever you supply `client: 'sqlite3'`, instead supply `client: 'better-sqlite3`
```diff
backend:
database:
- client: sqlite3
+ client: better-sqlite3
```
app-config.yaml
+1 -1
View File
@@ -33,7 +33,7 @@ backend:
listen:
port: 7007
database:
client: sqlite3
client: better-sqlite3
connection: ':memory:'
cache:
store: memory
docs/getting-started/configuration.md
+1 -1
View File
@@ -78,7 +78,7 @@ from the previous steps.
```diff
backend:
database:
- client: sqlite3
- client: better-sqlite3
- connection: ':memory:'
+ # config options: https://node-postgres.com/api/client
+ client: pg
docs/tutorials/configuring-plugin-databases.md
+8 -8
View File
@@ -33,17 +33,17 @@ Backstage's databases.
### Dependencies
Please ensure the appropriate database drivers are installed in your `backend`
package. If you intend to use both `postgres` and `sqlite3`, you can install
package. If you intend to use both PostgreSQL and SQLite, you can install
both of them.
```sh
cd packages/backend
# install pg if you need postgres
# install pg if you need PostgreSQL
yarn add pg
# install sqlite3 if you intend to set it as the client
yarn add sqlite3
# install SQLite 3 if you intend to set it as the client
yarn add better-sqlite3
```
From an operational perspective, you only need to install drivers for clients
@@ -66,14 +66,14 @@ configurations below.
### Minimal In-Memory Configuration
In the example below, we are using `sqlite3` in-memory databases for all
In the example below, we are using `better-sqlite3` in-memory databases for all
plugins. You may want to use this configuration for testing or other non-durable
use cases.
```yaml
backend:
database:
client: sqlite3
client: better-sqlite3
connection: ':memory:'
```
@@ -138,7 +138,7 @@ backend:
### PostgreSQL and SQLite 3
The example below uses PostgreSQL (`pg`) as the database client for all plugins
except the `auth` plugin which uses `sqlite3`. As the `auth` plugin's client
except the `auth` plugin which uses `better-sqlite3`. As the `auth` plugin's client
type is different from the base client type, the connection configuration for
`auth` is used verbatim without extending the base configuration for PostgreSQL.
@@ -149,7 +149,7 @@ backend:
connection: 'postgresql://foo:bar@some.example-pg-instance.tld:5432'
plugin:
auth:
client: sqlite3
client: better-sqlite3
connection: ':memory:'
```
docs/tutorials/switching-sqlite-postgres.md
+1 -1
View File
@@ -33,7 +33,7 @@ configuration for the backend:
```diff
backend:
database:
- client: sqlite3
- client: better-sqlite3
- connection: ':memory:'
+ # config options: https://node-postgres.com/api/client
+ client: pg
packages/backend-common/config.d.ts
Vendored
+2 -2
View File
@@ -70,7 +70,7 @@ export interface Config {
/** Database connection configuration, select base database type using the `client` field */
database: {
/** Default database client to use */
client: 'sqlite3' | 'pg';
client: 'better-sqlite3' | 'sqlite3' | 'pg';
/**
* Base database connection string or Knex object
* @secret
@@ -106,7 +106,7 @@ export interface Config {
plugin?: {
[pluginId: string]: {
/** Database client override */
client?: 'sqlite3' | 'pg';
client?: 'better-sqlite3' | 'sqlite3' | 'pg';
/**
* Database connection string or Knex object override
* @secret
packages/backend-common/src/database/DatabaseManager.test.ts
+14 -14
View File
@@ -97,13 +97,13 @@ describe('DatabaseManager', () => {
},
},
differentclient: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: {
filename: 'plugin_with_different_client',
},
},
differentclientconnstring: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
},
stringoverride: {
@@ -176,7 +176,7 @@ describe('DatabaseManager', () => {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
},
},
@@ -198,7 +198,7 @@ describe('DatabaseManager', () => {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: 'some-file-path',
},
},
@@ -215,7 +215,7 @@ describe('DatabaseManager', () => {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: {
directory: 'sqlite-files',
},
@@ -239,7 +239,7 @@ describe('DatabaseManager', () => {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: {
directory: 'sqlite-files',
},
@@ -270,7 +270,7 @@ describe('DatabaseManager', () => {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: {
directory: 'sqlite-files',
},
@@ -349,7 +349,7 @@ describe('DatabaseManager', () => {
// plugin connection should be used as base config, client is different
expect(baseConfig.get()).toMatchObject({
client: 'sqlite3',
client: 'better-sqlite3',
connection: config.backend.database.plugin[pluginId].connection,
});
});
@@ -361,10 +361,10 @@ describe('DatabaseManager', () => {
const mockCalls = mocked(createDatabaseClient).mock.calls.splice(-1);
const [baseConfig, overrides] = mockCalls[0];
// plugin client should be sqlite3
expect(baseConfig.get().client).toEqual('sqlite3');
// plugin client should be better-sqlite3
expect(baseConfig.get().client).toEqual('better-sqlite3');
// sqlite3 uses 'filename' instead of 'database'
// SQLite uses 'filename' instead of 'database'
expect(overrides).toHaveProperty(
'connection.filename',
'plugin_with_different_client',
@@ -378,7 +378,7 @@ describe('DatabaseManager', () => {
const mockCalls = mocked(createDatabaseClient).mock.calls.splice(-1);
const [baseConfig, overrides] = mockCalls[0];
expect(baseConfig.get().client).toEqual('sqlite3');
expect(baseConfig.get().client).toEqual('better-sqlite3');
expect(overrides).toHaveProperty('connection.filename', ':memory:');
});
@@ -465,7 +465,7 @@ describe('DatabaseManager', () => {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
pluginDivisionMode: 'schema',
connection: {
host: 'localhost',
@@ -484,7 +484,7 @@ describe('DatabaseManager', () => {
const [baseConfig, overrides] = mockCalls[0];
expect(baseConfig.get()).toMatchObject({
client: 'sqlite3',
client: 'better-sqlite3',
connection: config.backend.database.connection,
});
packages/backend-common/src/database/config.test.ts
+22 -2
View File
@@ -101,7 +101,7 @@ describe('config', () => {
expect(
mergeDatabaseConfig(
{
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
useNullAsDefault: true,
},
@@ -112,7 +112,27 @@ describe('config', () => {
},
),
).toEqual({
client: 'sqlite3',
client: 'better-sqlite3',
connection: {
filename: '/path/to/file',
},
useNullAsDefault: true,
});
expect(
mergeDatabaseConfig(
{
client: 'better-sqlite3',
connection: ':memory:',
useNullAsDefault: true,
},
{
connection: {
filename: '/path/to/file',
},
},
),
).toEqual({
client: 'better-sqlite3',
connection: {
filename: '/path/to/file',
},
packages/backend-common/src/database/connection.test.ts
+6 -4
View File
@@ -59,7 +59,7 @@ describe('database connection', () => {
expect(
createDatabaseClient(
new ConfigReader({
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
}),
),
@@ -133,7 +133,7 @@ describe('database connection', () => {
});
it('returns Knex config for sqlite', () => {
expect(createNameOverride('sqlite3', 'testsqlite')).toHaveProperty(
expect(createNameOverride('better-sqlite3', 'testsqlite')).toHaveProperty(
'connection.filename',
'testsqlite',
);
@@ -178,7 +178,9 @@ describe('database connection', () => {
});
it('throws error for sqlite', () => {
expect(createSchemaOverride('sqlite3', 'testsqlite')).toBeUndefined();
expect(
createSchemaOverride('better-sqlite3', 'testsqlite'),
).toBeUndefined();
});
it('returns Knex config for mysql', () => {
@@ -218,7 +220,7 @@ describe('database connection', () => {
return expect(
ensureSchemaExists(
new ConfigReader({
client: 'sqlite3',
client: 'better-sqlite3',
schema: 'catalog',
connection: ':memory:',
}),
packages/backend-common/src/database/connectors/sqlite3.test.ts
+1 -89
View File
@@ -21,87 +21,6 @@ import {
createSqliteDatabaseClient,
} from './sqlite3';
describe('sqlite3', () => {
const createConfig = (connection: any) =>
new ConfigReader({ client: 'sqlite3', connection });
describe('buildSqliteDatabaseConfig', () => {
it('builds an in-memory connection', () => {
expect(buildSqliteDatabaseConfig(createConfig(':memory:'))).toEqual({
client: 'sqlite3',
connection: { filename: ':memory:' },
useNullAsDefault: true,
});
});
it('builds an in-memory connection by override with filename', () => {
expect(
buildSqliteDatabaseConfig(
createConfig(path.join('path', 'to', 'foo')),
{ connection: ':memory:' },
),
).toEqual({
client: 'sqlite3',
connection: { filename: ':memory:' },
useNullAsDefault: true,
});
});
it('builds a persistent connection, normalize config with filename', () => {
expect(
buildSqliteDatabaseConfig(createConfig(path.join('path', 'to', 'foo'))),
).toEqual({
client: 'sqlite3',
connection: { filename: path.join('path', 'to', 'foo') },
useNullAsDefault: true,
});
});
it('builds a persistent connection', () => {
expect(
buildSqliteDatabaseConfig(
createConfig({
filename: path.join('path', 'to', 'foo'),
}),
),
).toEqual({
client: 'sqlite3',
connection: {
filename: path.join('path', 'to', 'foo'),
},
useNullAsDefault: true,
});
});
it('replaces the connection with an override', () => {
expect(
buildSqliteDatabaseConfig(createConfig(':memory:'), {
connection: { filename: path.join('path', 'to', 'foo') },
}),
).toEqual({
client: 'sqlite3',
connection: {
filename: path.join('path', 'to', 'foo'),
},
useNullAsDefault: true,
});
});
});
describe('createSqliteDatabaseClient', () => {
it('creates an in memory knex instance', () => {
expect(
createSqliteDatabaseClient(
createConfig({
client: 'sqlite3',
connection: ':memory:',
}),
),
).toBeTruthy();
});
});
});
describe('better-sqlite3', () => {
const createConfig = (connection: any) =>
new ConfigReader({ client: 'better-sqlite3', connection });
@@ -171,14 +90,7 @@ describe('better-sqlite3', () => {
describe('createSqliteDatabaseClient', () => {
it('creates an in memory knex instance', () => {
expect(
createSqliteDatabaseClient(
createConfig({
client: 'better-sqlite3',
connection: ':memory:',
}),
),
).toBeTruthy();
expect(createSqliteDatabaseClient(createConfig(':memory:'))).toBeTruthy();
});
});
});
packages/backend-common/src/database/util.ts
+1
View File
@@ -28,6 +28,7 @@ export function isDatabaseConflictError(e: unknown) {
return (
typeof message === 'string' &&
(/SQLITE_CONSTRAINT(?:_UNIQUE)?: UNIQUE/.test(message) ||
/UNIQUE constraint failed:/.test(message) ||
/unique constraint/.test(message))
);
}
packages/backend-tasks/src/tasks/PluginTaskSchedulerJanitor.ts
+1 -1
View File
@@ -56,7 +56,7 @@ export class PluginTaskSchedulerJanitor {
// SQLite currently (Oct 1 2021) returns a number for returning()
// statements, effectively ignoring them and instead returning the outcome
// of the delete() - and knex also emits a warning about that fact, which
// is why we avoid that entirely for the sqlite3 driver.
// is why we avoid that entirely for the sqlite3 family of drivers.
// https://github.com/knex/knex/issues/4370
// https://github.com/mapbox/node-sqlite3/issues/1453
packages/backend-test-utils/.snyk
-47
View File
@@ -1,47 +0,0 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.22.1
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
ignore:
SNYK-JS-TAR-1579155:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1579152:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1579147:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536758:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536531:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536528:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
patch: {}
packages/backend-test-utils/package.json
+1 -1
View File
@@ -37,7 +37,7 @@
"@backstage/backend-common": "^0.13.0",
"@backstage/cli": "^0.15.2",
"@backstage/config": "^0.1.15",
"@vscode/sqlite3": "^5.0.7",
"better-sqlite3": "^7.5.0",
"knex": "^1.0.2",
"msw": "^0.35.0",
"mysql2": "^2.2.5",
packages/backend-test-utils/src/database/types.ts
+1 -1
View File
@@ -66,6 +66,6 @@ export const allDatabases: Record<TestDatabaseId, TestDatabaseProperties> =
},
SQLITE_3: {
name: 'SQLite 3.x',
driver: 'sqlite3',
driver: 'better-sqlite3',
},
});
packages/backend/.snyk
-47
View File
@@ -1,47 +0,0 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.22.1
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
ignore:
SNYK-JS-TAR-1579155:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1579152:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1579147:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536758:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536531:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536528:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
patch: {}
packages/backend/knexfile.ts
+1 -1
View File
@@ -16,7 +16,7 @@
module.exports = {
development: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: {
filename: './dev.sqlite3',
},
packages/backend/package.json
+1 -1
View File
@@ -62,7 +62,7 @@
"@backstage/plugin-todo-backend": "^0.1.26",
"@gitbeaker/node": "^35.1.0",
"@octokit/rest": "^18.5.3",
"@vscode/sqlite3": "^5.0.7",
"better-sqlite3": "^7.5.0",
"azure-devops-node-api": "^11.0.1",
"dockerode": "^3.3.1",
"example-app": "link:../app",
packages/create-app/templates/default-app/app-config.yaml.hbs
+1 -1
View File
@@ -25,7 +25,7 @@ backend:
credentials: true
{{#if dbTypeSqlite}}
database:
client: sqlite3
client: better-sqlite3
connection: ':memory:'
{{/if}}
{{#if dbTypePG}}
packages/create-app/templates/default-app/packages/backend/package.json.hbs
+1 -1
View File
@@ -46,7 +46,7 @@
"pg": "^8.3.0",
{{/if}}
{{#if dbTypeSqlite}}
"@vscode/sqlite3": "^5.0.7",
"better-sqlite3": "^7.5.0",
{{/if}}
"winston": "^3.2.1"
},
plugins/auth-backend/src/identity/DatabaseKeyStore.test.ts
+1 -1
View File
@@ -20,7 +20,7 @@ import { DateTime } from 'luxon';
function createDB() {
const knex = Knex({
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
useNullAsDefault: true,
});
plugins/auth-backend/src/identity/KeyStores.test.ts
+1 -1
View File
@@ -49,7 +49,7 @@ describe('KeyStores', () => {
const config = new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
},
},
plugins/auth-backend/src/service/standaloneServer.ts
+1 -1
View File
@@ -39,7 +39,7 @@ export async function startStandaloneServer(
const database = useHotMemoize(module, () => {
const knex = Knex({
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
useNullAsDefault: true,
});
plugins/bazaar-backend/src/service/standaloneServer.ts
+1 -1
View File
@@ -38,7 +38,7 @@ export async function startStandaloneServer(
const db = useHotMemoize(module, () => {
const knex = knexFactory({
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
useNullAsDefault: true,
});
plugins/catalog-backend/.snyk
-47
View File
@@ -1,47 +0,0 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.22.1
# ignores vulnerabilities until expiry date; change duration by modifying expiry date
ignore:
SNYK-JS-TAR-1579155:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1579152:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1579147:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536758:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536531:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
SNYK-JS-TAR-1536528:
- 'sqlite3 > node-gyp > tar':
reason: >-
The only usage is via node-gyp; there is no unpacking of untrusted tar
files
expires: 2022-11-11T14:30:05.581Z
created: 2021-11-11T14:30:05.582Z
patch: {}
plugins/catalog-backend/knexfile.js
+1 -1
View File
@@ -17,7 +17,7 @@
// This file makes it possible to run "yarn knex migrate:make some_file_name"
// to assist in making new migrations
module.exports = {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
useNullAsDefault: true,
migrations: {
plugins/catalog-backend/package.json
+1 -1
View File
@@ -77,7 +77,7 @@
"@types/lodash": "^4.14.151",
"@types/supertest": "^2.0.8",
"@types/uuid": "^8.0.0",
"@vscode/sqlite3": "^5.0.7",
"better-sqlite3": "^7.5.0",
"msw": "^0.35.0",
"supertest": "^6.1.3",
"wait-for-expect": "^3.0.2",
plugins/catalog-backend/src/database/DefaultProcessingDatabase.ts
+2 -2
View File
@@ -35,7 +35,7 @@ import {
ListParentsResult,
} from './types';
import { DeferredEntity } from '../processing/types';
import { RefreshIntervalFunction } from '../processing/refresh';
import { ProcessingIntervalFunction } from '../processing/refresh';
import { rethrowError, timestampToDateTime } from './conversion';
import { initDatabaseMetrics } from './metrics';
import {
@@ -59,7 +59,7 @@ export class DefaultProcessingDatabase implements ProcessingDatabase {
private readonly options: {
database: Knex;
logger: Logger;
refreshInterval: RefreshIntervalFunction;
refreshInterval: ProcessingIntervalFunction;
},
) {
initDatabaseMetrics(options.database);
plugins/catalog-backend/src/database/conversion.ts
+2 -4
View File
@@ -14,6 +14,7 @@
* limitations under the License.
*/
import { isDatabaseConflictError } from '@backstage/backend-common';
import { ConflictError, InputError } from '@backstage/errors';
import { DateTime } from 'luxon';
@@ -47,10 +48,7 @@ export function timestampToDateTime(input: Date | string): DateTime {
* Rethrows an error, possibly translating it to a more precise error type.
*/
export function rethrowError(e: any): never {
if (
/SQLITE_CONSTRAINT: UNIQUE/.test(e.message) ||
/unique constraint/.test(e.message)
) {
if (isDatabaseConflictError(e)) {
throw new ConflictError(`Rejected due to a conflicting entity`, e);
}
plugins/catalog-backend/src/service/standaloneServer.ts
+3 -1
View File
@@ -46,7 +46,9 @@ export async function startStandaloneServer(
const database = useHotMemoize(module, () => {
const manager = DatabaseManager.fromConfig(
new ConfigReader({
backend: { database: { client: 'sqlite3', connection: ':memory:' } },
backend: {
database: { client: 'better-sqlite3', connection: ':memory:' },
},
}),
);
return manager.forPlugin('catalog');
plugins/code-coverage-backend/src/service/CodeCoverageDatabase.test.ts
+1 -1
View File
@@ -26,7 +26,7 @@ const db = DatabaseManager.fromConfig(
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
},
},
plugins/code-coverage-backend/src/service/router.test.ts
+1 -1
View File
@@ -31,7 +31,7 @@ function createDatabase(): PluginDatabaseManager {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
},
},
plugins/code-coverage-backend/src/service/standaloneServer.ts
+1 -1
View File
@@ -40,7 +40,7 @@ export async function startStandaloneServer(
const db = useHotMemoize(module, () => {
const knex = knexFactory({
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
useNullAsDefault: true,
});
plugins/config-schema/dev/example-schema.json
+1 -1
View File
@@ -346,7 +346,7 @@
"properties": {
"client": {
"type": "string",
"enum": ["sqlite3"]
"enum": ["sqlite3", "better-sqlite3"]
},
"connection": {
"type": "string"
plugins/scaffolder-backend/src/scaffolder/tasks/StorageTaskBroker.test.ts
+1 -1
View File
@@ -26,7 +26,7 @@ async function createStore(): Promise<DatabaseTaskStore> {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
},
},
plugins/scaffolder-backend/src/scaffolder/tasks/TaskWorker.test.ts
+1 -1
View File
@@ -33,7 +33,7 @@ async function createStore(): Promise<DatabaseTaskStore> {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
},
},
plugins/scaffolder-backend/src/service/router.test.ts
+1 -1
View File
@@ -60,7 +60,7 @@ function createDatabase(): PluginDatabaseManager {
new ConfigReader({
backend: {
database: {
client: 'sqlite3',
client: 'better-sqlite3',
connection: ':memory:',
},
},
yarn.lock
-12
View File
@@ -6865,13 +6865,6 @@
"@typescript-eslint/types" "5.9.0"
eslint-visitor-keys "^3.0.0"
"@vscode/sqlite3@^5.0.7":
version "5.0.7"
resolved "https://registry.npmjs.org/@vscode/sqlite3/-/sqlite3-5.0.7.tgz#358df36bb0e9e735c54785e3e4b9b2dce1d32895"
integrity sha512-NlsOf+Hir2r4zopI1qMvzWXPwPJuFscirkmFTniTAT24Yz2FWcyZxzK7UT8iSNiTqOCPz48yF55ZVHaz7tTuVQ==
dependencies:
node-addon-api "^4.2.0"
"@webassemblyjs/ast@1.11.1":
version "1.11.1"
resolved "https://registry.npmjs.org/@webassemblyjs/ast/-/ast-1.11.1.tgz#2bfd767eae1a6996f432ff7e8d7fc75679c0b6a7"
@@ -18250,11 +18243,6 @@ node-abort-controller@^3.0.1:
resolved "https://registry.npmjs.org/node-abort-controller/-/node-abort-controller-3.0.1.tgz#f91fa50b1dee3f909afabb7e261b1e1d6b0cb74e"
integrity sha512-/ujIVxthRs+7q6hsdjHMaj8hRG9NuWmwrz+JdRwZ14jdFoKSkm+vDsCbF9PLpnSqjaWQJuTmVtcWHNLr+vrOFw==
node-addon-api@^4.2.0:
version "4.3.0"
resolved "https://registry.npmjs.org/node-addon-api/-/node-addon-api-4.3.0.tgz#52a1a0b475193e0928e98e0426a0d1254782b77f"
integrity sha512-73sE9+3UaLYYFmDsFZnqCInzPyh3MqIwZO9cw58yIqAZhONrrabrYyYe3TuIqtIiOuTXVhsGau8hcrhhwSsDIQ==
node-cache@^5.1.2:
version "5.1.2"
resolved "https://registry.npmjs.org/node-cache/-/node-cache-5.1.2.tgz#f264dc2ccad0a780e76253a694e9fd0ed19c398d"