@balena/abstract-sql-compiler 10.2.4-build-tests-ts-beb2503119ff2e479e1da25051d33a021129a9d7-1 → 10.2.4

package/test/odata/resource_parsing.js

@@ -22,7 +22,7 @@ const teamFieldsStr = teamFields.join(', ');
 test('/pilot', (result, sqlEquals) => {
 	it('should select from pilot', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT ${pilotFieldsStr}
 FROM "pilot"`,
@@ -33,7 +33,7 @@ FROM "pilot"`,
 test('/pilot(1)', 'GET', [['Bind', 0]], (result, sqlEquals) => {
 	it('should select from pilot with id', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT ${pilotFieldsStr}
 FROM "pilot"
@@ -45,7 +45,7 @@ WHERE ("pilot"."id") IS NOT NULL AND ("pilot"."id") = (?)`,
 test("/pilot('TextKey')", 'GET', [['Bind', 0]], (result, sqlEquals) => {
 	it('should select from pilot with id', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT ${pilotFieldsStr}
 FROM "pilot"
@@ -57,7 +57,7 @@ WHERE ("pilot"."id") IS NOT NULL AND ("pilot"."id") = (?)`,
 test('/pilot(1)/licence', 'GET', [['Bind', 0]], (result, sqlEquals) => {
 	it('should select from the licence of pilot with id', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT ${aliasLicenceFieldsStr}
 FROM "pilot",
@@ -71,7 +71,7 @@ AND ("pilot"."id") IS NOT NULL AND ("pilot"."id") = (?)`,
 test('/licence(1)/is_of__pilot', 'GET', [['Bind', 0]], (result, sqlEquals) => {
 	it('should select from the pilots of licence with id', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT ${aliasPilotLicenceFieldsStr}
 FROM "licence",
@@ -89,7 +89,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select from the plane of pilot with id', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT ${aliasPlaneFieldsStr}
 FROM "pilot",
@@ -110,7 +110,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select from the pilots of plane with id', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT ${aliasPilotFields}
 FROM "plane",
@@ -127,7 +127,7 @@ AND ("plane"."id") IS NOT NULL AND ("plane"."id") = (?)`,
 test('/pilot(1)', 'DELETE', [['Bind', 0]], (result, sqlEquals) => {
 	it('should delete the pilot with id 1', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 DELETE FROM "pilot"
 WHERE ("pilot"."id") IS NOT NULL AND ("pilot"."id") = (?)`,
@@ -195,7 +195,7 @@ test(
 	(result, sqlEquals) => {
 		it('should insert/update the pilot with id 1', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 INSERT INTO "pilot" ("name")
 VALUES (?)`,
@@ -206,7 +206,7 @@ VALUES (?)`,
 test('/pilot', 'POST', (result, sqlEquals) => {
 	it('should insert a pilot with default values', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 INSERT INTO "pilot" DEFAULT VALUES`,
 		);
@@ -214,15 +214,14 @@ INSERT INTO "pilot" DEFAULT VALUES`,
 });
 
 (function () {
-	// prettier-ignore
-	const bindings = /** @type {const} */ ([
+	const bindings = [
 		['Bind', ['pilot', 'is_experienced']],
 		['Bind', 0],
-	]);
+	];
 	const testFunc = (result, sqlEquals) => {
 		it('should update the pilot with id 1', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 UPDATE "pilot"
 SET "is experienced" = ?
@@ -241,7 +240,7 @@ test(
 	(result, sqlEquals) => {
 		it('should delete the pilot with id 1', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 DELETE FROM "pilot-can fly-plane"
 WHERE ("pilot-can fly-plane"."id") IS NOT NULL AND ("pilot-can fly-plane"."id") = (?)`,
@@ -306,7 +305,7 @@ test(
 	(result, sqlEquals) => {
 		it('should insert/update the pilot-can fly-plane with id 1', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 INSERT INTO "pilot-can fly-plane" ("pilot", "can fly-plane")
 VALUES (?, ?)`,
@@ -317,7 +316,7 @@ VALUES (?, ?)`,
 test('/pilot__can_fly__plane', 'POST', (result, sqlEquals) => {
 	it('should insert a "pilot-can fly-plane" with default values', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 INSERT INTO "pilot-can fly-plane" DEFAULT VALUES`,
 		);
@@ -325,15 +324,14 @@ INSERT INTO "pilot-can fly-plane" DEFAULT VALUES`,
 });
 
 (function () {
-	// prettier-ignore
-	const bindings = /** @type {const} */ ([
+	const bindings = [
 		['Bind', ['pilot-can fly-plane', 'pilot']],
 		['Bind', 0],
-	]);
+	];
 	const testFunc = (result, sqlEquals) => {
 		it('should update the pilot with id 1', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 UPDATE "pilot-can fly-plane"
 SET "pilot" = ?
@@ -348,7 +346,7 @@ WHERE ("pilot-can fly-plane"."id") IS NOT NULL AND ("pilot-can fly-plane"."id")
 test('/pilot(1)/$links/licence', 'GET', [['Bind', 0]], (result, sqlEquals) => {
 	it('should select the list of licence ids, for generating the links', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT "pilot"."licence" AS "licence"
 FROM "pilot"
@@ -364,7 +362,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select the list of plane ids, for generating the links', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT "pilot.pilot-can fly-plane"."can fly-plane" AS "plane"
 FROM "pilot",
@@ -376,18 +374,18 @@ AND ("pilot"."id") IS NOT NULL AND ("pilot"."id") = (?)`,
 	},
 );
 
-test.fail('/pilot(1)/favourite_colour/red', () => {
+test.skip('/pilot(1)/favourite_colour/red', () => {
 	it("should select the red component of the pilot's favourite colour");
 });
 
-test.fail('/method(1)/child?foo=bar', () => {
+test.skip('/method(1)/child?foo=bar', () => {
 	it('should do something..');
 });
 
 test("/team('purple')", 'GET', [['Bind', 0]], (result, sqlEquals) => {
 	it('should select the team with the "favourite colour" id of "purple"', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT ${teamFieldsStr}
 FROM "team"
@@ -404,7 +402,7 @@ test(
 	(result, sqlEquals) => {
 		it('should insert a team', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 INSERT INTO "team" ("favourite colour")
 VALUES (?)`,
@@ -413,7 +411,7 @@ VALUES (?)`,
 	},
 );
 
-test.fail('/pilot/$count/$count', (result) => {
+test('/pilot/$count/$count', (result) => {
 	it('should fail because it is invalid', () => {
 		expect(result).to.be.instanceOf(ODataParser.SyntaxError);
 	});
@@ -422,7 +420,7 @@ test.fail('/pilot/$count/$count', (result) => {
 test('/pilot/$count', (result, sqlEquals) => {
 	it('should select count(*) from pilot', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"`,
@@ -430,13 +428,13 @@ FROM "pilot"`,
 	});
 });
 
-test.fail('/pilot(5)/$count', (result) => {
+test('/pilot(5)/$count', (result) => {
 	it('should fail because it is invalid', () => {
 		expect(result).to.be.instanceOf(ODataParser.SyntaxError);
 	});
 });
 
-test.fail('/pilot?$filter=id eq 5/$count', (result) => {
+test('/pilot?$filter=id eq 5/$count', (result) => {
 	it('should fail because it is invalid', () => {
 		expect(result).to.be.instanceOf(ODataParser.SyntaxError);
 	});
@@ -449,7 +447,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select count(*) from pilot where pilot/id > 5 ', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"
@@ -469,7 +467,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select count(*) from pilot where id in (5,10)', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"
@@ -487,7 +485,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select count(*) from pilot where id in (5,10)', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"
@@ -501,7 +499,7 @@ OR "pilot"."id" IS NULL)`,
 test('/pilot(5)/licence/$count', 'GET', [['Bind', 0]], (result, sqlEquals) => {
 	it('should select count(*) the licence from pilot where pilot/id', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot",
@@ -515,7 +513,7 @@ AND ("pilot"."id") IS NOT NULL AND ("pilot"."id") = (?)`,
 test('/pilot/$count?$orderby=id asc', (result, sqlEquals) => {
 	it('should select count(*) from pilot and ignore orderby', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"`,
@@ -526,7 +524,7 @@ FROM "pilot"`,
 test('/pilot/$count?$skip=5', (result, sqlEquals) => {
 	it('should select count(*) from pilot and ignore skip', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"`,
@@ -537,7 +535,7 @@ FROM "pilot"`,
 test('/pilot/$count?$top=5', (result, sqlEquals) => {
 	it('should select count(*) from pilot and ignore top', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"`,
@@ -548,7 +546,7 @@ FROM "pilot"`,
 test('/pilot/$count?$top=5&$skip=5', (result, sqlEquals) => {
 	it('should select count(*) from pilot and ignore top and skip', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"`,
@@ -559,7 +557,7 @@ FROM "pilot"`,
 test('/pilot/$count?$select=id', (result, sqlEquals) => {
 	it('should select count(*) from pilot and ignore select', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT COUNT(*) AS "$count"
 FROM "pilot"`,

package/test/odata/select.js

@@ -5,7 +5,7 @@ const pilotFieldsStr = pilotFields.join(', ');
 test('/pilot?$select=name', (result, sqlEquals) => {
 	it('should select name from pilot', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT "pilot"."name"
 FROM "pilot"`,
@@ -16,7 +16,7 @@ FROM "pilot"`,
 test('/pilot?$select=favourite_colour', (result, sqlEquals) => {
 	it('should select favourite_colour from pilot', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT "pilot"."favourite colour" AS "favourite_colour"
 FROM "pilot"`,
@@ -31,7 +31,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select from pilot with id', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT "pilot"."favourite colour" AS "favourite_colour"
 FROM "pilot"
@@ -48,7 +48,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select favourite colour from pilot "TextKey"', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT "pilot"."favourite colour" AS "favourite_colour"
 FROM "pilot"
@@ -61,7 +61,7 @@ WHERE ("pilot"."id") IS NOT NULL AND ("pilot"."id") = (?)`,
 test('/pilot?$select=trained__pilot/name', (result, sqlEquals) => {
 	it('should select name from pilot', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT "pilot.trained-pilot"."name"
 FROM "pilot"
@@ -73,7 +73,7 @@ LEFT JOIN "pilot" AS "pilot.trained-pilot" ON "pilot"."id" = "pilot.trained-pilo
 test('/pilot?$select=trained__pilot/name,age', (result, sqlEquals) => {
 	it('should select name, age from pilot', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT "pilot.trained-pilot"."name", "pilot"."age"
 FROM "pilot"
@@ -85,7 +85,7 @@ LEFT JOIN "pilot" AS "pilot.trained-pilot" ON "pilot"."id" = "pilot.trained-pilo
 test('/pilot?$select=*', (result, sqlEquals) => {
 	it('should select * from pilot', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT ${pilotFieldsStr}
 FROM "pilot"`,
@@ -96,7 +96,7 @@ FROM "pilot"`,
 test('/pilot?$select=licence/id', (result, sqlEquals) => {
 	it('should select licence/id for pilots', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT "pilot.licence"."id"
 FROM "pilot"
@@ -108,7 +108,7 @@ LEFT JOIN "licence" AS "pilot.licence" ON "pilot"."licence" = "pilot.licence"."i
 test('/pilot?$select=can_fly__plane/plane/id', (result, sqlEquals) => {
 	it('should select can_fly__plane/plane/id for pilots', () => {
 		sqlEquals(
-			result,
+			result.query,
 			`\
 SELECT "pilot.pilot-can fly-plane.plane"."id"
 FROM "pilot"

package/test/odata/stress.js

@@ -14,8 +14,7 @@ const filterBindsNandString = _.map(
 	() => 'NOT(("pilot"."id") IS NOT NULL AND ("pilot"."id") = (?))',
 ).join('\nAND ');
 
-// prettier-ignore
-const filterBinds = filterIDs.map((_n, i) => /** @type {const} */ (['Bind', i]));
+const filterBinds = _.map(filterIDs, (_n, i) => ['Bind', i]);
 
 let filterString = `id in (${filterIDs.join(', ')})`;
 test(
@@ -25,7 +24,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select from pilot with a long IN clause', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT ${pilotFieldsStr}
 FROM "pilot"
@@ -45,7 +44,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select from pilot with a long NOT IN clause', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT ${pilotFieldsStr}
 FROM "pilot"
@@ -65,7 +64,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select from pilot with a long IN clause', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT ${pilotFieldsStr}
 FROM "pilot"
@@ -83,7 +82,7 @@ test(
 	(result, sqlEquals) => {
 		it('should select from pilot with a long NOT IN clause', () => {
 			sqlEquals(
-				result,
+				result.query,
 				`\
 SELECT ${pilotFieldsStr}
 FROM "pilot"

package/test/odata/test.js

@@ -0,0 +1,138 @@
+import * as fs from 'node:fs';
+import * as ODataParser from '@balena/odata-parser';
+import { OData2AbstractSQL } from '@balena/odata-to-abstract-sql';
+const sbvrModel = fs.readFileSync(require.resolve('../model.sbvr'), 'utf8');
+
+import * as AbstractSQLCompiler from '../..';
+
+import { expect } from 'chai';
+import _ from 'lodash';
+
+const generateClientModel = function (input) {
+	// eslint-disable-next-line @typescript-eslint/no-var-requires
+	const sbvrTypes = require('@balena/sbvr-types').default;
+	const typeVocab = fs.readFileSync(
+		require.resolve('@balena/sbvr-types/Type.sbvr'),
+		'utf8',
+	);
+
+	// eslint-disable-next-line @typescript-eslint/no-var-requires
+	const SBVRParser = require('@balena/sbvr-parser').SBVRParser.createInstance();
+	SBVRParser.enableReusingMemoizations(SBVRParser._sideEffectingRules);
+	SBVRParser.AddCustomAttribute('Database ID Field:');
+	SBVRParser.AddCustomAttribute('Database Table Name:');
+	SBVRParser.AddBuiltInVocab(typeVocab);
+
+	// eslint-disable-next-line @typescript-eslint/no-var-requires
+	const LF2AbstractSQL = require('@balena/lf-to-abstract-sql');
+	const LF2AbstractSQLTranslator = LF2AbstractSQL.createTranslator(sbvrTypes);
+
+	const lf = SBVRParser.matchAll(input, 'Process');
+	const abstractSql = LF2AbstractSQLTranslator(lf, 'Process');
+	return abstractSql;
+};
+
+export const clientModel = generateClientModel(sbvrModel);
+const odata2AbstractSQL = new OData2AbstractSQL(clientModel);
+
+const bindingsTest = function (actualBindings, expectedBindings) {
+	if (expectedBindings == null) {
+		expectedBindings = false;
+	}
+	if (expectedBindings === false) {
+		it('should not have any bindings', () => {
+			expect(actualBindings).to.be.empty;
+		});
+	} else {
+		it('should have matching bindings', () => {
+			expect(actualBindings).to.deep.equal(expectedBindings);
+		});
+	}
+};
+
+const equals = (actual, expected) => {
+	expect(actual).to.equal(expected);
+};
+const sqlEquals = {
+	websql: equals,
+	mysql: equals,
+	postgres(actual, expected) {
+		let num = 1;
+		while (_.includes(expected, '?')) {
+			expected = expected.replace('?', '$' + num);
+			num++;
+		}
+		equals(actual, expected);
+	},
+};
+
+const runExpectation = function (describe, engine, input, ...args) {
+	/** @type {import('@balena/odata-parser').SupportedMethod} */
+	let method = 'GET';
+	let expectedBindings = false;
+	let body = {};
+	let expectation;
+	switch (args.length) {
+		case 1:
+			[expectation] = args;
+			break;
+		case 2:
+			[method, expectation] = args;
+			break;
+		case 3:
+			[method, expectedBindings, expectation] = args;
+			break;
+		case 4:
+			[method, expectedBindings, body, expectation] = args;
+			break;
+	}
+
+	describe(
+		'Parsing ' + method + ' ' + _.truncate(input, { length: 100 }),
+		function () {
+			let result;
+			try {
+				input = ODataParser.parse(input);
+				const { tree, extraBodyVars } = odata2AbstractSQL.match(
+					input.tree,
+					method,
+					_.keys(body),
+					0,
+				);
+				_.assign(body, extraBodyVars);
+				result = AbstractSQLCompiler[engine].compileRule(tree);
+			} catch (e) {
+				expectation(e);
+				return;
+			}
+			if (Array.isArray(result)) {
+				for (let i = 0; i < result.length; i++) {
+					const actualResult = result[i];
+					if (expectedBindings[0][0] === 'Bind') {
+						bindingsTest(actualResult.bindings, expectedBindings);
+					} else {
+						bindingsTest(actualResult.bindings, expectedBindings[i]);
+					}
+				}
+			} else {
+				bindingsTest(result.bindings, expectedBindings);
+			}
+			expectation(result, sqlEquals[engine]);
+		},
+	);
+};
+
+const bindRunExpectation = function (engine) {
+	const bound = runExpectation.bind(null, describe, engine);
+	bound.skip = runExpectation.bind(null, describe.skip, engine);
+	// eslint-disable-next-line no-only-tests/no-only-tests -- this is a false positive
+	bound.only = runExpectation.bind(null, describe.only, engine);
+	return bound;
+};
+
+const testFn = bindRunExpectation('postgres');
+testFn.postgres = bindRunExpectation('postgres');
+testFn.mysql = bindRunExpectation('mysql');
+testFn.websql = bindRunExpectation('websql');
+
+export default testFn;