Add support for non-null ReferencedField optimization using model info

We automatically use the model info to optimize rules/check constraints
when compiling the schema.

Change-type: minor

src/AbstractSQLCompiler.ts

@@ -571,16 +571,19 @@ export function compileRule(
 	abstractSQL: UpsertQueryNode,
 	engine: Engines,
 	noBinds: true,
+	abstractSqlModel?: AbstractSqlModel,
 ): [string, string];
 export function compileRule(
 	abstractSQL: AbstractSqlQuery,
 	engine: Engines,
 	noBinds: true,
+	abstractSqlModel?: AbstractSqlModel,
 ): string;
 export function compileRule(
 	abstractSQL: UpsertQueryNode,
 	engine: Engines,
 	noBinds?: false,
+	abstractSqlModel?: AbstractSqlModel,
 ): [SqlResult, SqlResult];
 export function compileRule(
 	abstractSQL:
@@ -591,23 +594,27 @@ export function compileRule(
 		| DeleteQueryNode,
 	engine: Engines,
 	noBinds?: false,
+	abstractSqlModel?: AbstractSqlModel,
 ): SqlResult;
 export function compileRule(
 	abstractSQL: AbstractSqlQuery,
 	engine: Engines,
 	noBinds?: false,
+	abstractSqlModel?: AbstractSqlModel,
 ): SqlResult | [SqlResult, SqlResult];
 export function compileRule(
 	abstractSQL: AbstractSqlQuery,
 	engine: Engines,
 	noBinds?: boolean,
+	abstractSqlModel?: AbstractSqlModel,
 ): SqlResult | [SqlResult, SqlResult] | string;
 export function compileRule(
 	abstractSQL: AbstractSqlQuery,
 	engine: Engines,
 	noBinds = false,
+	abstractSqlModel?: AbstractSqlModel,
 ): SqlResult | [SqlResult, SqlResult] | string | [string, string] {
-	abstractSQL = AbstractSQLOptimiser(abstractSQL, noBinds);
+	abstractSQL = AbstractSQLOptimiser(abstractSQL, noBinds, abstractSqlModel);
 	return AbstractSQLRules2SQL(abstractSQL, engine, noBinds);
 }
 
@@ -700,10 +707,12 @@ $$;`);
 				createSQL: [
 					`\
 CREATE ${orReplaceStr}VIEW "${table.name}" AS (
-${compileRule(definitionAbstractSql as AbstractSqlQuery, engine, true).replace(
-	/^/gm,
-	'	',
-)}
+${compileRule(
+	definitionAbstractSql as AbstractSqlQuery,
+	engine,
+	true,
+	abstractSqlModel,
+).replace(/^/gm, '	')}
 );`,
 				],
 				dropSQL: [`DROP VIEW "${table.name}";`],
@@ -785,6 +794,7 @@ $$;`);
 					check.abstractSql as AbstractSqlQuery,
 					engine,
 					true,
+					abstractSqlModel,
 				);
 				createSqlElements.push(`\
 ${comment}${constraintName}CHECK (${sql})`);
@@ -910,6 +920,8 @@ CREATE TABLE ${ifNotExistsStr}"${table.name}" (
 			const { query: ruleSQL, bindings: ruleBindings } = compileRule(
 				ruleBody,
 				engine,
+				undefined,
+				abstractSqlModel,
 			) as SqlResult;
 			let referencedFields: ReferencedFields | undefined;
 			try {
@@ -941,8 +953,10 @@ const generateExport = (engine: Engines, ifNotExists: boolean) => {
 	return {
 		optimizeSchema,
 		compileSchema: _.partial(compileSchema, _, engine, ifNotExists),
-		compileRule: (abstractSQL: AbstractSqlQuery) =>
-			compileRule(abstractSQL, engine, false),
+		compileRule: (
+			abstractSQL: AbstractSqlQuery,
+			abstractSqlModel?: AbstractSqlModel,
+		) => compileRule(abstractSQL, engine, false, abstractSqlModel),
 		dataTypeValidate,
 		getReferencedFields,
 		getModifiedFields,

src/AbstractSQLOptimiser.ts

@@ -2,10 +2,14 @@ import * as _ from 'lodash';
 
 import { Dictionary } from 'lodash';
 import {
+	AbstractSqlModel,
 	AbstractSqlQuery,
 	AbstractSqlType,
+	AliasNode,
 	DurationNode,
+	ReferencedFieldNode,
 	ReplaceNode,
+	TableNode,
 } from './AbstractSQLCompiler';
 import * as AbstractSQLRules2SQL from './AbstractSQLRules2SQL';
 
@@ -14,7 +18,6 @@ const {
 	getAbstractSqlQuery,
 	checkArgs,
 	checkMinArgs,
-	isNotNullable,
 } = AbstractSQLRules2SQL;
 
 type OptimisationMatchFn = (
@@ -36,7 +39,9 @@ const escapeForLike = (str: AbstractSqlType): ReplaceNode => [
 ];
 
 let helped = false;
+let aliases: { [alias: string]: string } = {};
 let noBinds = false;
+let abstractSqlModel: AbstractSqlModel | undefined;
 const Helper = <F extends (...args: any[]) => any>(fn: F) => {
 	return (...args: Parameters<F>): ReturnType<F> => {
 		const result = fn(...args);
@@ -65,6 +70,22 @@ const isEmptySelectQuery = (query: AbstractSqlQuery): boolean => {
 	return false;
 };
 
+const isNotNullable = (node: AbstractSqlQuery): boolean => {
+	switch (node[0]) {
+		case 'ReferencedField':
+			if (abstractSqlModel != null) {
+				const [, aliasName, fieldName] = node as ReferencedFieldNode;
+				const tableName = aliases[aliasName] ?? aliasName;
+				const table = abstractSqlModel.tables[tableName];
+				const field = table?.fields.find((f) => f.fieldName === fieldName);
+				if (field?.required === true) {
+					return true;
+				}
+			}
+	}
+	return AbstractSQLRules2SQL.isNotNullable(node);
+};
+
 const rewriteMatch = (
 	name: string,
 	matchers: Array<(args: AbstractSqlType) => AbstractSqlType>,
@@ -455,6 +476,10 @@ const typeRules: Dictionary<MatchFn> = {
 	},
 	From: (args) => {
 		checkArgs('From', args, 1);
+		const maybeAlias = args[0] as AliasNode<TableNode>;
+		if (maybeAlias[0] === 'Alias' && maybeAlias[1][0] === 'Table') {
+			aliases[maybeAlias[2]] = maybeAlias[1][1];
+		}
 		return ['From', MaybeAlias(args[0] as AbstractSqlQuery, FromMatch)];
 	},
 	Join: JoinMatch('Join'),
@@ -1309,10 +1334,13 @@ const typeRules: Dictionary<MatchFn> = {
 export const AbstractSQLOptimiser = (
 	abstractSQL: AbstractSqlQuery,
 	$noBinds = false,
+	$abstractSqlModel?: AbstractSqlModel,
 ): AbstractSqlQuery => {
 	noBinds = $noBinds;
+	abstractSqlModel = $abstractSqlModel;
 	do {
 		helped = false;
+		aliases = {};
 		const [type, ...rest] = abstractSQL;
 		switch (type) {
 			case 'SelectQuery':

src/AbstractSQLSchemaOptimiser.ts

@@ -60,7 +60,7 @@ export const optimizeSchema = (
 			}
 
 			// Optimize the rule body, this also normalizes it making the check constraint check easier
-			ruleBody = AbstractSQLOptimiser(ruleBody, true);
+			ruleBody = AbstractSQLOptimiser(ruleBody, true, abstractSqlModel);
 
 			const count = countFroms(ruleBody);
 			if (