Merge pull request backstage#4827 from backstage/dependabot/npm_and_y…

…arn/knex-0.95.1 chore(deps): bump knex from 0.21.18 to 0.95.1
jeremyguarini · Mar 8, 2021 · 8e15b19 · 8e15b19
2 parents c598de8 + 7616988
commit 8e15b19
Show file tree

Hide file tree

Showing 41 changed files with 160 additions and 258 deletions.
diff --git a/.changeset/nasty-garlics-explain.md b/.changeset/nasty-garlics-explain.md
@@ -0,0 +1,18 @@
+---
+'@backstage/backend-common': patch
+---
+
+Bump to the latest version of the Knex library.
+
+You will most likely want to bump your own `packages/backend/package.json` as well:
+
+```diff
+-    "knex": "^0.21.18",
++    "knex": "^0.95.1",
+```
+
+Note that the recent versions of the Knex library have some changes that may affect your internal plugins' database migration files. Importantly, they now support `ALTER TABLE` on SQLite, and no longer accidentally remove indices when making some modifications. It now also exports the `Knex` typescript type as a named export.
+
+```ts
+import { Knex } from 'knex';
+```
diff --git a/.changeset/old-laws-begin.md b/.changeset/old-laws-begin.md
@@ -0,0 +1,8 @@
+---
+'@backstage/plugin-auth-backend': patch
+'@backstage/plugin-catalog-backend': patch
+'@backstage/plugin-scaffolder-backend': patch
+'@backstage/plugin-techdocs-backend': patch
+---
+
+Bump to the latest version of the Knex library.
diff --git a/packages/backend-common/package.json b/packages/backend-common/package.json
@@ -47,7 +47,7 @@
     "git-url-parse": "^11.4.4",
     "helmet": "^4.0.0",
     "isomorphic-git": "^1.8.0",
-    "knex": "^0.21.6",
+    "knex": "^0.95.1",
     "lodash": "^4.17.15",
     "logform": "^2.1.1",
     "minimatch": "^3.0.4",

diff --git a/packages/backend-common/src/database/SingleConnection.ts b/packages/backend-common/src/database/SingleConnection.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import Knex from 'knex';
+import { Knex } from 'knex';
 import { Config } from '@backstage/config';
 import { createDatabaseClient, ensureDatabaseExists } from './connection';
 import { PluginDatabaseManager } from './types';

diff --git a/packages/backend-common/src/database/connection.ts b/packages/backend-common/src/database/connection.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import knex from 'knex';
+import knexFactory, { Knex } from 'knex';
 import { Config } from '@backstage/config';
 import { mergeDatabaseConfig } from './config';
 import { createPgDatabaseClient, ensurePgDatabaseExists } from './postgres';
@@ -30,7 +30,7 @@ type DatabaseClient = 'pg' | 'sqlite3' | string;
  */
 export function createDatabaseClient(
   dbConfig: Config,
-  overrides?: Partial<knex.Config>,
+  overrides?: Partial<Knex.Config>,
 ) {
   const client: DatabaseClient = dbConfig.getString('client');
 
@@ -40,7 +40,7 @@ export function createDatabaseClient(
     return createSqliteDatabaseClient(dbConfig);
   }
 
-  return knex(mergeDatabaseConfig(dbConfig.get(), overrides));
+  return knexFactory(mergeDatabaseConfig(dbConfig.get(), overrides));
 }
 
 /**

diff --git a/packages/backend-common/src/database/postgres.ts b/packages/backend-common/src/database/postgres.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import knex, { PgConnectionConfig } from 'knex';
+import knexFactory, { Knex } from 'knex';
 import { Config } from '@backstage/config';
 import { mergeDatabaseConfig } from './config';
 
@@ -26,10 +26,10 @@ import { mergeDatabaseConfig } from './config';
  */
 export function createPgDatabaseClient(
   dbConfig: Config,
-  overrides?: knex.Config,
+  overrides?: Knex.Config,
 ) {
   const knexConfig = buildPgDatabaseConfig(dbConfig, overrides);
-  const database = knex(knexConfig);
+  const database = knexFactory(knexConfig);
   return database;
 }
 
@@ -41,7 +41,7 @@ export function createPgDatabaseClient(
  */
 export function buildPgDatabaseConfig(
   dbConfig: Config,
-  overrides?: knex.Config,
+  overrides?: Knex.Config,
 ) {
   return mergeDatabaseConfig(
     dbConfig.get(),
@@ -62,7 +62,7 @@ export function buildPgDatabaseConfig(
 export function getPgConnectionConfig(
   dbConfig: Config,
   parseConnectionString?: boolean,
-): PgConnectionConfig | string {
+): Knex.PgConnectionConfig | string {
   const connection = dbConfig.get('connection') as any;
   const isConnectionString =
     typeof connection === 'string' || connection instanceof String;

diff --git a/packages/backend-common/src/database/sqlite3.ts b/packages/backend-common/src/database/sqlite3.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import knex from 'knex';
+import knexFactory, { Knex } from 'knex';
 import { Config } from '@backstage/config';
 import { mergeDatabaseConfig } from './config';
 
@@ -26,10 +26,10 @@ import { mergeDatabaseConfig } from './config';
  */
 export function createSqliteDatabaseClient(
   dbConfig: Config,
-  overrides?: knex.Config,
+  overrides?: Knex.Config,
 ) {
   const knexConfig = buildSqliteDatabaseConfig(dbConfig, overrides);
-  const database = knex(knexConfig);
+  const database = knexFactory(knexConfig);
 
   database.client.pool.on('createSuccess', (_eventId: any, resource: any) => {
     resource.run('PRAGMA foreign_keys = ON', () => {});
@@ -46,7 +46,7 @@ export function createSqliteDatabaseClient(
  */
 export function buildSqliteDatabaseConfig(
   dbConfig: Config,
-  overrides?: knex.Config,
+  overrides?: Knex.Config,
 ) {
   return mergeDatabaseConfig(
     dbConfig.get(),

diff --git a/packages/backend-common/src/database/types.ts b/packages/backend-common/src/database/types.ts
@@ -14,7 +14,7 @@
  * limitations under the License.
  */
 
-import knex from 'knex';
+import { Knex } from 'knex';
 
 /**
  * The PluginDatabaseManager manages access to databases that Plugins get.
@@ -26,5 +26,5 @@ export interface PluginDatabaseManager {
    * The purpose of this method is to allow plugins to get isolated data
    * stores so that plugins are discouraged from database integration.
    */
-  getClient(): Promise<knex>;
+  getClient(): Promise<Knex>;
 }
diff --git a/packages/backend/package.json b/packages/backend/package.json
@@ -48,7 +48,7 @@
     "example-app": "^0.2.18",
     "express": "^4.17.1",
     "express-promise-router": "^3.0.3",
-    "knex": "^0.21.6",
+    "knex": "^0.95.1",
     "pg": "^8.3.0",
     "pg-connection-string": "^2.3.0",
     "sqlite3": "^5.0.0",

diff --git a/plugins/auth-backend/migrations/20200619125845_init.js b/plugins/auth-backend/migrations/20200619125845_init.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   return knex.schema.createTable('signing_keys', table => {
@@ -39,7 +39,7 @@ exports.up = async function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
   return knex.schema.dropTable('auth_keystore');

diff --git a/plugins/auth-backend/package.json b/plugins/auth-backend/package.json
@@ -48,7 +48,7 @@
     "helmet": "^4.0.0",
     "jose": "^1.27.1",
     "jwt-decode": "^3.1.0",
-    "knex": "^0.21.6",
+    "knex": "^0.95.1",
     "luxon": "^1.25.0",
     "morgan": "^1.10.0",
     "node-cache": "^5.1.2",

diff --git a/plugins/auth-backend/src/identity/DatabaseKeyStore.ts b/plugins/auth-backend/src/identity/DatabaseKeyStore.ts
@@ -14,10 +14,10 @@
  * limitations under the License.
  */
 
-import Knex from 'knex';
 import { resolvePackagePath } from '@backstage/backend-common';
-import { AnyJWK, KeyStore, StoredKey } from './types';
+import { Knex } from 'knex';
 import { DateTime } from 'luxon';
+import { AnyJWK, KeyStore, StoredKey } from './types';
 
 const migrationsDir = resolvePackagePath(
   '@backstage/plugin-auth-backend',

diff --git a/plugins/catalog-backend/migrations/20200511113813_init.js b/plugins/catalog-backend/migrations/20200511113813_init.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   return (
@@ -120,7 +120,7 @@ exports.up = async function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
   return knex.schema

diff --git a/plugins/catalog-backend/migrations/20200520140700_location_update_log_table.js b/plugins/catalog-backend/migrations/20200520140700_location_update_log_table.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   return knex.schema.createTable('location_update_log', table => {
@@ -36,7 +36,7 @@ exports.up = async function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
   return knex.schema.dropTableIfExists('location_update_log');

diff --git a/plugins/catalog-backend/migrations/20200527114117_location_update_log_latest_view.js b/plugins/catalog-backend/migrations/20200527114117_location_update_log_latest_view.js
@@ -17,15 +17,15 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   // Get list sorted by created_at timestamp in descending order
   // Grouped by location_id
   return knex.schema.raw(`
     CREATE VIEW location_update_log_latest AS
     SELECT t1.* FROM location_update_log t1
-    JOIN 
+    JOIN
     (
        SELECT location_id, MAX(created_at) AS MAXDATE
        FROM location_update_log
@@ -38,7 +38,7 @@ exports.up = async function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
   return knex.schema.raw(`DROP VIEW location_update_log_latest;`);

diff --git a/plugins/catalog-backend/migrations/20200702153613_entities.js b/plugins/catalog-backend/migrations/20200702153613_entities.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   // SQLite does not support FK and PK
@@ -126,7 +126,7 @@ exports.up = async function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
   // SQLite does not support FK and PK

diff --git a/plugins/catalog-backend/migrations/20200721115244_location_update_log_latest_deduplicate.js b/plugins/catalog-backend/migrations/20200721115244_location_update_log_latest_deduplicate.js
@@ -13,11 +13,17 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
+
+// @ts-check
+
+/**
+ * @param {import('knex').Knex} knex
+ */
 exports.up = function up(knex) {
   return knex.schema.raw(`DROP VIEW location_update_log_latest;`).raw(`
   CREATE VIEW location_update_log_latest AS
   SELECT t1.* FROM location_update_log t1
-  JOIN 
+  JOIN
   (
      SELECT location_id, MAX(created_at) AS MAXDATE
      FROM location_update_log
@@ -30,6 +36,9 @@ exports.up = function up(knex) {
 `);
 };
 
+/**
+ * @param {import('knex').Knex} knex
+ */
 exports.down = function down(knex) {
   knex.schema.raw(`DROP VIEW location_update_log_latest;`);
 };
diff --git a/plugins/catalog-backend/migrations/20200805163904_location_update_log_duplication_fix.js b/plugins/catalog-backend/migrations/20200805163904_location_update_log_duplication_fix.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = function up(knex) {
   return knex.schema
@@ -52,7 +52,7 @@ exports.up = function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = function down(knex) {
   return knex.schema

diff --git a/plugins/catalog-backend/migrations/20200807120600_entitySearch.js b/plugins/catalog-backend/migrations/20200807120600_entitySearch.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   // Sqlite does not support alter column.
@@ -29,7 +29,7 @@ exports.up = async function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
   // Sqlite does not support alter column.

diff --git a/plugins/catalog-backend/migrations/20200809202832_add_bootstrap_location.js b/plugins/catalog-backend/migrations/20200809202832_add_bootstrap_location.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   // Adds a single 'bootstrap' location that can be used to trigger work in processors.
@@ -30,7 +30,7 @@ exports.up = async function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
   await knex('locations')

diff --git a/plugins/catalog-backend/migrations/20200923104503_case_insensitivity.js b/plugins/catalog-backend/migrations/20200923104503_case_insensitivity.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   await knex('entities')

diff --git a/plugins/catalog-backend/migrations/20201005122705_add_entity_full_name.js b/plugins/catalog-backend/migrations/20201005122705_add_entity_full_name.js
@@ -17,7 +17,7 @@
 // @ts-check
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.up = async function up(knex) {
   await knex.schema.alterTable('entities', table => {
@@ -45,7 +45,7 @@ exports.up = async function up(knex) {
 };
 
 /**
- * @param {import('knex')} knex
+ * @param {import('knex').Knex} knex
  */
 exports.down = async function down(knex) {
   await knex.schema.alterTable('entities', table => {