⬆️ improvement: ensure correct datatypes in distinction filters

Author: m1212e

lib/abilityBuilder.ts

@@ -1,4 +1,5 @@
 import { and, eq, or } from "drizzle-orm";
+import { createDistinctValuesFromSQLType } from "./helpers/sqlTypes/distinctValuesFromSQLType";
 import type {
 	GenericDrizzleDbTypeConstraints,
 	QueryConditionObject,
@@ -145,9 +146,18 @@ export const createAbilityBuilder = <
 							);
 						}
 
+						// we want a filter that excludes everything
+						const distinctValues = createDistinctValuesFromSQLType(
+							primaryKeyField.getSQLType(),
+						);
+
+						// when the user has no permission for anything, ensure returns nothing
 						conditionsPerEntityAndAction = [
 							{
-								where: and(eq(primaryKeyField, "1"), eq(primaryKeyField, "2")),
+								where: and(
+									eq(primaryKeyField, distinctValues.value1),
+									eq(primaryKeyField, distinctValues.value2),
+								),
 							},
 						];
 					}

lib/helpers/sqlTypes/distinctValuesFromSQLType.ts

@@ -0,0 +1,68 @@
+import { type PossibleSQLType, UnknownTypeRumbleError } from "./types";
+
+export function createDistinctValuesFromSQLType(sqlType: PossibleSQLType): {
+	value1: any;
+	value2: any;
+} {
+	if (
+		["serial", "int", "integer", "tinyint", "smallint", "mediumint"].includes(
+			sqlType,
+		)
+	) {
+		return {
+			value1: 1,
+			value2: 2,
+		};
+	}
+
+	if (["real", "decimal", "double", "float"].includes(sqlType)) {
+		return {
+			value1: 1.1,
+			value2: 2.2,
+		};
+	}
+
+	if (["string", "text", "varchar", "char", "text(256)"].includes(sqlType)) {
+		return {
+			value1: "a",
+			value2: "b",
+		};
+	}
+
+	if (["uuid"].includes(sqlType)) {
+		return {
+			value1: "fba31870-5528-42d7-b27e-2e5ee657aea5",
+			value2: "fc65db81-c2d1-483d-8a25-a30e2cf6e02d",
+		};
+	}
+
+	if (["boolean"].includes(sqlType)) {
+		return {
+			value1: true,
+			value2: false,
+		};
+	}
+
+	if (["timestamp", "datetime"].includes(sqlType)) {
+		return {
+			value1: new Date(2022, 1, 1),
+			value2: new Date(2022, 1, 2),
+		};
+	}
+
+	if (["date"].includes(sqlType)) {
+		return {
+			value1: new Date(2022, 1, 1),
+			value2: new Date(2022, 1, 2),
+		};
+	}
+
+	if (["json"].includes(sqlType)) {
+		return {
+			value1: { a: 1 },
+			value2: { b: 2 },
+		};
+	}
+
+	throw UnknownTypeRumbleError(sqlType, "Distinct");
+}

lib/helpers/mapSQLTypeToTSType.ts renamed to lib/helpers/sqlTypes/mapSQLTypeToTSType.ts

@@ -1,6 +1,6 @@
-import type { SchemaBuilderType } from "../schemaBuilder";
-import type { GenericDrizzleDbTypeConstraints } from "../types/genericDrizzleDbType";
-import { RumbleError } from "../types/rumbleError";
+import type { SchemaBuilderType } from "../../schemaBuilder";
+import type { GenericDrizzleDbTypeConstraints } from "../../types/genericDrizzleDbType";
+import { type PossibleSQLType, UnknownTypeRumbleError } from "./types";
 
 export function mapSQLTypeToGraphQLType<
 	UserContext extends Record<string, any>,
@@ -13,20 +13,12 @@ export function mapSQLTypeToGraphQLType<
 		RequestEvent,
 		Action
 	>,
->(sqlType: string) {
+>(sqlType: PossibleSQLType) {
 	type ReturnType = Parameters<
 		Parameters<Parameters<SchemaBuilder["queryField"]>[1]>[0]["field"]
 	>[0]["type"];
 
 	let ret: ReturnType | undefined = undefined;
-	// Int
-	// Float
-	// String
-	// ID
-	// Boolean
-	// DateTime
-	// Date
-	// JSON
 
 	if (
 		["serial", "int", "integer", "tinyint", "smallint", "mediumint"].includes(
@@ -36,7 +28,7 @@ export function mapSQLTypeToGraphQLType<
 		ret = "Int";
 	}
 
-	if (["real", "decimal", "real", "double", "float"].includes(sqlType)) {
+	if (["real", "decimal", "double", "float"].includes(sqlType)) {
 		ret = "Float";
 	}
 
@@ -68,7 +60,5 @@ export function mapSQLTypeToGraphQLType<
 		return ret;
 	}
 
-	throw new RumbleError(
-		`RumbleError: Unknown SQL type '${sqlType}'. Please open an issue so it can be added.`,
-	);
+	throw UnknownTypeRumbleError(sqlType, "SQL to GQL");
 }

lib/helpers/sqlTypes/types.ts

@@ -0,0 +1,35 @@
+import { RumbleError } from "../../types/rumbleError";
+
+export const possibleSQLTypesStrings = [
+	"serial",
+	"int",
+	"integer",
+	"tinyint",
+	"smallint",
+	"mediumint",
+	"real",
+	"decimal",
+	"double",
+	"float",
+	"string",
+	"text",
+	"varchar",
+	"char",
+	"text(256)",
+	"uuid",
+	"boolean",
+	"date",
+	"datetime",
+	"timestamp",
+	"json",
+] as const;
+
+export type PossibleSQLType = (typeof possibleSQLTypesStrings)[number];
+
+export const UnknownTypeRumbleError = (
+	sqlType: string,
+	additionalInfo?: string,
+) =>
+	new RumbleError(
+		`RumbleError: Unknown SQL type '${sqlType}'. Please open an issue (https://github.com/m1212e/rumble/issues) so it can be added. (${additionalInfo})`,
+	);

lib/object.ts

@@ -1,4 +1,4 @@
-import { mapSQLTypeToGraphQLType } from "./helpers/mapSQLTypeToTSType";
+import { mapSQLTypeToGraphQLType } from "./helpers/sqlTypes/mapSQLTypeToTSType";
 import { type MakePubSubInstanceType, createPubSubInstance } from "./pubsub";
 import type { SchemaBuilderType } from "./schemaBuilder";
 import type { GenericDrizzleDbTypeConstraints } from "./types/genericDrizzleDbType";

lib/whereArg.ts

@@ -1,6 +1,6 @@
 import { and, eq } from "drizzle-orm";
 import { capitalizeFirstLetter } from "./helpers/capitalize";
-import { mapSQLTypeToGraphQLType } from "./helpers/mapSQLTypeToTSType";
+import { mapSQLTypeToGraphQLType } from "./helpers/sqlTypes/mapSQLTypeToTSType";
 import type { SchemaBuilderType } from "./schemaBuilder";
 import type { GenericDrizzleDbTypeConstraints } from "./types/genericDrizzleDbType";
 import { RumbleError } from "./types/rumbleError";