@balena/pinejs 14.59.1 → 15.0.0-build-15-x-9f7b9bfe63741d7ae5f446e013251758d9d6ca26-1

package/src/http-transactions/transactions.js

@@ -3,6 +3,7 @@ import { odataNameToSqlName } from '@balena/odata-to-abstract-sql';
 // @ts-ignore
 const transactionModel = require('./transaction.sbvr');
 
+/** @type {import('../config-loader/config-loader').Config} */
 export let config = {
 	models: [
 		{
@@ -24,6 +25,23 @@ ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT N
 ALTER TABLE "transaction"
 ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;\
 `,
+				'15.0.0-data-types': async (tx, sbvrUtils) => {
+					switch (sbvrUtils.db.engine) {
+						case 'mysql':
+							await tx.executeSql(`\
+								ALTER TABLE "lock"
+								MODIFY "is exclusive" BOOLEAN NOT NULL,
+								MODIFY "is under lock" BOOLEAN NOT NULL;`);
+							break;
+						case 'postgres':
+							await tx.executeSql(`\
+								ALTER TABLE "lock"
+								ALTER COLUMN "is exclusive" SET DATA TYPE BOOLEAN USING b::BOOLEAN,
+								ALTER COLUMN "is under lock" SET DATA TYPE BOOLEAN USING b::BOOLEAN;`);
+							break;
+						// No need to migrate for websql
+					}
+				},
 			},
 		},
 	],

package/src/migrator/utils.ts

@@ -12,6 +12,23 @@ import { delay } from '../sbvr-api/control-flow';
 
 // tslint:disable-next-line:no-var-requires
 export const modelText = require('./migrations.sbvr');
+export const migrations: Migrations = {
+	'15.0.0-data-types': async (tx, { db }) => {
+		switch (db.engine) {
+			case 'mysql':
+				await tx.executeSql(`\
+					ALTER TABLE "migration"
+					MODIFY "executed migrations" JSON NOT NULL;`);
+				break;
+			case 'postgres':
+				await tx.executeSql(`\
+					ALTER TABLE "migration"
+					ALTER COLUMN "executed migrations" SET DATA TYPE JSONB USING b::JSONB;`);
+				break;
+			// No need to migrate for websql
+		}
+	},
+};
 
 import * as sbvrUtils from '../sbvr-api/sbvr-utils';
 export enum MigrationCategories {
@@ -73,14 +90,14 @@ export function isSyncMigration(
 	return typeof migration === 'function' || typeof migration === 'string';
 }
 export function areCategorizedMigrations(
-	migrations: Migrations,
-): migrations is CategorizedMigrations {
+	$migrations: Migrations,
+): $migrations is CategorizedMigrations {
 	const containsCategories = Object.keys(MigrationCategories).some(
-		(key) => key in migrations,
+		(key) => key in $migrations,
 	);
 	if (
 		containsCategories &&
-		Object.keys(migrations).some((key) => !(key in MigrationCategories))
+		Object.keys($migrations).some((key) => !(key in MigrationCategories))
 	) {
 		throw new Error(
 			'Mixing categorized and uncategorized migrations is not supported',
@@ -104,31 +121,31 @@ export type MigrationStatus = {
 };
 
 export const getRunnableAsyncMigrations = (
-	migrations: Migrations,
+	$migrations: Migrations,
 ): RunnableAsyncMigrations | undefined => {
-	if (migrations[MigrationCategories.async]) {
+	if ($migrations[MigrationCategories.async]) {
 		if (
-			Object.values(migrations[MigrationCategories.async]).some(
+			Object.values($migrations[MigrationCategories.async]).some(
 				(migration) => !isAsyncMigration(migration),
 			) ||
-			typeof migrations[MigrationCategories.async] !== 'object'
+			typeof $migrations[MigrationCategories.async] !== 'object'
 		) {
 			throw new Error(
 				`All loaded async migrations need to be of type: ${MigrationCategories.async}`,
 			);
 		}
-		return migrations[MigrationCategories.async] as RunnableAsyncMigrations;
+		return $migrations[MigrationCategories.async] as RunnableAsyncMigrations;
 	}
 };
 
 // migration loader should either get migrations from model
 // or from the filepath
 export const getRunnableSyncMigrations = (
-	migrations: Migrations,
+	$migrations: Migrations,
 ): RunnableMigrations => {
-	if (areCategorizedMigrations(migrations)) {
+	if (areCategorizedMigrations($migrations)) {
 		const runnableMigrations: RunnableMigrations = {};
-		for (const [category, categoryMigrations] of Object.entries(migrations)) {
+		for (const [category, categoryMigrations] of Object.entries($migrations)) {
 			if (category in MigrationCategories) {
 				for (const [key, migration] of Object.entries(
 					categoryMigrations as Migrations,
@@ -145,16 +162,16 @@ export const getRunnableSyncMigrations = (
 		}
 		return runnableMigrations;
 	}
-	return migrations;
+	return $migrations;
 };
 
 // turns {"key1": migration, "key3": migration, "key2": migration}
 // into  [["key1", migration], ["key2", migration], ["key3", migration]]
 export const filterAndSortPendingMigrations = (
-	migrations: NonNullable<RunnableMigrations | RunnableAsyncMigrations>,
+	$migrations: NonNullable<RunnableMigrations | RunnableAsyncMigrations>,
 	executedMigrations: string[],
 ): MigrationTuple[] =>
-	(_(migrations).omit(executedMigrations) as _.Object<typeof migrations>)
+	(_($migrations).omit(executedMigrations) as _.Object<typeof $migrations>)
 		.toPairs()
 		.sortBy(([migrationKey]) => migrationKey)
 		.value();
@@ -313,8 +330,10 @@ WHERE "migration"."model name" = ${1}`,
 	if (data == null) {
 		return [];
 	}
-
-	return JSON.parse(data.executed_migrations) as string[];
+	if (typeof data.executed_migrations === 'string') {
+		return JSON.parse(data.executed_migrations);
+	}
+	return data.executed_migrations;
 };
 
 export const migrationTablesExist = async (tx: Tx) => {
@@ -338,7 +357,7 @@ WHERE NOT EXISTS (SELECT 1 FROM "migration status" WHERE "migration key" = ${5})
 			[
 				migrationStatus['migration_key'],
 				migrationStatus['start_time'],
-				migrationStatus['is_backing_off'] ? 1 : 0,
+				migrationStatus['is_backing_off'],
 				migrationStatus['run_count'],
 				migrationStatus['migration_key'],
 			],
@@ -372,7 +391,7 @@ WHERE "migration status"."migration key" = ${7};`,
 				migrationStatus['migrated_row_count'],
 				migrationStatus['error_count'],
 				migrationStatus['converged_time'],
-				migrationStatus['is_backing_off'] ? 1 : 0,
+				migrationStatus['is_backing_off'],
 				migrationStatus['migration_key'],
 			],
 		);
@@ -409,7 +428,8 @@ LIMIT 1;`,
 			migrated_row_count: data['migrated row count'],
 			error_count: data['error count'],
 			converged_time: data['converged time'],
-			is_backing_off: data['is backing off'] === 1,
+			is_backing_off:
+				data['is backing off'] === true || data['is backing off'] === 1,
 		};
 	} catch (err: any) {
 		// we report any error here, as no error should happen at all

package/src/pinejs-session-store/pinejs-session-store.ts

@@ -173,6 +173,21 @@ export class PinejsSessionStore extends Store {
 						ALTER TABLE "session"
 						ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
 					`,
+					'15.0.0-data-types': async (tx, sbvrUtils) => {
+						switch (sbvrUtils.db.engine) {
+							case 'mysql':
+								await tx.executeSql(`\
+									ALTER TABLE "session"
+									MODIFY "data" JSON NOT NULL;`);
+								break;
+							case 'postgres':
+								await tx.executeSql(`\
+									ALTER TABLE "session"
+									ALTER COLUMN "data" SET DATA TYPE JSONB USING b::JSONB;`);
+								break;
+							// No need to migrate for websql
+						}
+					},
 				},
 			},
 		],

package/src/sbvr-api/odata-response.ts

@@ -90,8 +90,7 @@ const getLocalFields = (table: AbstractSqlTable) => {
 	if (table.localFields == null) {
 		table.localFields = {};
 		for (const { fieldName, dataType } of table.fields) {
-			// TODO-MAJOR: This should also include ConceptType fields
-			if (dataType !== 'ForeignKey') {
+			if (!['ForeignKey', 'ConceptType'].includes(dataType)) {
 				const odataName = sqlNameToODataName(fieldName);
 				table.localFields[odataName] = true;
 			}

package/src/sbvr-api/permissions.ts

@@ -862,9 +862,7 @@ const rewriteRelationship = memoizeWeak(
 								foundCanAccessLink = true;
 							}
 							// return a true expression to not select the relationship, which might be virtual
-							// this should be a boolean expression, but needs to be a subquery in case it
-							// is wrapped in an `or` or `and`
-							return ['Equals', ['Boolean', true], ['Boolean', true]];
+							return ['Boolean', true];
 						};
 
 						try {
@@ -1446,26 +1444,13 @@ const checkApiKey = async (
 	apiKey: string,
 	tx?: Tx,
 ): Promise<PermissionReq['apiKey']> => {
-	let permissions: string[];
-	try {
-		permissions = await getApiKeyPermissions(apiKey, tx);
-	} catch (err: any) {
-		console.warn('Error with API key:', err);
-		// Ignore errors getting the api key and just use an empty permissions object.
-		permissions = [];
-	}
-	let actor;
-	if (permissions.length > 0) {
-		actor = await getApiKeyActorId(apiKey, tx);
-	}
-	const resolvedApiKey: PermissionReq['apiKey'] = {
+	const permissions = await getApiKeyPermissions(apiKey, tx);
+	const actor = await getApiKeyActorId(apiKey, tx);
+	return {
 		key: apiKey,
 		permissions,
+		actor,
 	};
-	if (actor != null) {
-		resolvedApiKey.actor = actor;
-	}
-	return resolvedApiKey;
 };
 
 export const resolveAuthHeader = async (
@@ -1474,11 +1459,6 @@ export const resolveAuthHeader = async (
 	// TODO: Consider making tx the second argument in the next major
 	tx?: Tx,
 ): Promise<PermissionReq['apiKey']> => {
-	// TODO-MAJOR: remove this check
-	if (req.apiKey != null) {
-		return;
-	}
-
 	const auth = req.header('Authorization');
 	if (!auth) {
 		return;
@@ -1524,11 +1504,6 @@ export const resolveApiKey = async (
 	// TODO: Consider making tx the second argument in the next major
 	tx?: Tx,
 ): Promise<PermissionReq['apiKey']> => {
-	// TODO-MAJOR: remove this check
-	if (req.apiKey != null) {
-		return;
-	}
-
 	const apiKey =
 		req.params[paramName] ?? req.body[paramName] ?? req.query[paramName];
 	if (apiKey == null) {
@@ -1538,9 +1513,6 @@ export const resolveApiKey = async (
 };
 
 export const customApiKeyMiddleware = (paramName = 'apikey') => {
-	if (paramName == null) {
-		paramName = 'apikey';
-	}
 	return async (
 		req: HookReq | Express.Request,
 		_res?: Express.Response,
@@ -1632,32 +1604,18 @@ const getReqPermissions = async (
 	req: PermissionReq,
 	odataBinds: ODataBinds = [],
 ) => {
-	const [guestPermissions] = await Promise.all([
-		(async () => {
-			if (
-				guestPermissionsInitialized === false &&
-				(req.user === root.user || req.user === rootRead.user)
-			) {
-				// In the case that guest permissions are not initialized yet and the query is being made with root permissions
-				// then we need to bypass `getGuestPermissions` as it will cause an infinite loop back to here.
-				// Therefore to break that loop we just ignore guest permissions.
-				return [];
-			}
-			return await getGuestPermissions();
-		})(),
-		(async () => {
-			// TODO: Remove this extra actor ID lookup making actor non-optional and updating open-balena-api.
-			if (
-				req.apiKey != null &&
-				req.apiKey.actor == null &&
-				req.apiKey.permissions != null &&
-				req.apiKey.permissions.length > 0
-			) {
-				const actorId = await getApiKeyActorId(req.apiKey.key);
-				req.apiKey!.actor = actorId;
-			}
-		})(),
-	]);
+	const guestPermissions = await (async () => {
+		if (
+			guestPermissionsInitialized === false &&
+			(req.user === root.user || req.user === rootRead.user)
+		) {
+			// In the case that guest permissions are not initialized yet and the query is being made with root permissions
+			// then we need to bypass `getGuestPermissions` as it will cause an infinite loop back to here.
+			// Therefore to break that loop we just ignore guest permissions.
+			return [];
+		}
+		return await getGuestPermissions();
+	})();
 
 	let actorPermissions: string[] = [];
 	const addActorPermissions = (actorId: number, perms: string[]) => {

package/src/sbvr-api/sbvr-utils.ts

@@ -123,7 +123,7 @@ export interface User extends Actor {
 
 export interface ApiKey extends Actor {
 	key: string;
-	actor?: number;
+	actor: number;
 }
 
 export interface Response {
@@ -569,7 +569,10 @@ export const executeModels = async (
 					let uri = '/dev/model';
 					const body: AnyObject = {
 						is_of__vocabulary: model.vocab,
-						model_value: model[modelType],
+						model_value:
+							typeof model[modelType] === 'string'
+								? { value: model[modelType] }
+								: model[modelType],
 						model_type: modelType,
 					};
 					const id = result?.[0]?.id;
@@ -1696,6 +1699,31 @@ export const executeStandardModels = async (tx: Db.Tx): Promise<void> => {
 					ALTER TABLE "model"
 					ADD COLUMN IF NOT EXISTS "modified at" TIMESTAMP DEFAULT CURRENT_TIMESTAMP NOT NULL;
 				`,
+				'15.0.0-data-types': async ($tx, sbvrUtils) => {
+					switch (sbvrUtils.db.engine) {
+						case 'mysql':
+							await $tx.executeSql(`\
+								ALTER TABLE "model"
+								MODIFY "model value" JSON NOT NULL;
+
+								UPDATE "model"
+								SET "model value" = CAST('{"value":' || CAST("model value" AS CHAR) || '}' AS JSON)
+								WHERE "model type" IN ('se', 'odataMetadata')
+								AND CAST("model value" AS CHAR) LIKE '"%';`);
+							break;
+						case 'postgres':
+							await $tx.executeSql(`\
+								ALTER TABLE "model"
+								ALTER COLUMN "model value" SET DATA TYPE JSONB USING "model value"::JSONB;
+
+								UPDATE "model"
+								SET "model value" = CAST('{"value":' || CAST("model value" AS TEXT) || '}' AS JSON)
+								WHERE "model type" IN ('se', 'odataMetadata')
+								AND CAST("model value" AS TEXT) LIKE '"%';`);
+							break;
+						// No need to migrate for websql
+					}
+				},
 			},
 		});
 		await executeModels(tx, permissions.config.models);

package/src/sbvr-api/uri-parser.ts

@@ -144,7 +144,8 @@ export const memoizedParseOdata = (() => {
 
 export const memoizedGetOData2AbstractSQL = memoizeWeak(
 	(abstractSqlModel: AbstractSQLCompiler.AbstractSqlModel) => {
-		return new OData2AbstractSQL(abstractSqlModel, undefined, {
+		// TODO: REMOVE THIS, it's temporary due to mismatched abstract-sql-compiler versions
+		return new OData2AbstractSQL(abstractSqlModel as any, undefined, {
 			// Use minimized aliases when not in debug mode for smaller queries
 			minimizeAliases: !env.DEBUG,
 		});
@@ -418,7 +419,8 @@ export const translateUri = <
 				return true;
 			},
 		});
-		request.abstractSqlQuery = abstractSqlQuery;
+		// TODO: REMOVE THIS, it's temporary due to mismatched abstract-sql-compiler versions
+		request.abstractSqlQuery = abstractSqlQuery as any;
 		return request;
 	}
 	return request;

package/tsconfig.json

@@ -11,7 +11,7 @@
 		"removeComments": true,
 		"rootDir": "src",
 		"sourceMap": true,
-		"target": "es2019",
+		"target": "es2021",
 		"declaration": true,
 		"skipLibCheck": true,
 		"resolveJsonModule": true,