@m1212e/rumble 0.23.23 → 0.24.0

package/out/index.mjs

@@ -62,7 +62,7 @@ return (
 db.query.users
 .findFirst({
 ...query,
-where: ctx.abilities.users.filter("read").single.where,
+where: (await ctx.abilities.users.filter("read")).single.where,
 })
 // note that we need to manually raise an error if the value is not found
 .then(assertFindFirstExists)
@@ -104,7 +104,7 @@ name: args.newName,
 .where(
 and(
 eq(schema.users.id, args.userId),
-ctx.abilities.users.filter("update").single.where
+(await ctx.abilities.users.filter("update")).single.where
 )
 )
 .returning({ id: schema.users.id, name: schema.users.name })
@@ -167,7 +167,7 @@ pubsub.updated(user.id);
 return db.query.user
 .findFirst(
 query(
-ctx.abilities.user.filter('read').merge(
+(await ctx.abilities.user.filter('read')).merge(
 {
 where: { id: user.id },
 }
@@ -186,7 +186,7 @@ function mapNullFieldsToUndefined(obj) {
 }
 //#endregion
 //#region package.json
-var version = "0.23.23";
+var version = "0.24.0";
 //#endregion
 //#region lib/helpers/errorLogging.ts
 function hasMessage(error) {
@@ -618,7 +618,6 @@ function attributeValue(value) {
 		case "boolean": return value;
 		case "bigint": return value.toString();
 		case "undefined": return "null";
-		default: break;
 	}
 	if (value === null) return "null";
 	if (Array.isArray(value) && isHomogeneousPrimitiveArray(value)) return value;
@@ -656,11 +655,28 @@ function durationMs(start) {
 //#endregion
 //#region lib/abilityBuilder.ts
 function isDynamicQueryFilter(filter) {
-	return typeof filter === "function" && filter.constructor.name !== "AsyncFunction";
+	return typeof filter === "function";
 }
 function isStaticQueryFilter(filter) {
 	return typeof filter !== "function";
 }
+/**
+* filter() is async. Without type checking (plain JS, `any`) a forgotten await would
+* hand the promise itself to drizzle
+*/
+function guardAgainstMissingAwait(promise) {
+	for (const key of [
+		"query",
+		"sql",
+		"merge"
+	]) Object.defineProperty(promise, key, {
+		enumerable: true,
+		get() {
+			throw new RumbleError(`Tried to access "${key}" on the result of abilities.<table>.filter(...) which is a Promise. filter() is async, did you forget to await it?`);
+		}
+	});
+	return promise;
+}
 const makeNothingRegisteredWarner = (config, logger) => debounce((model, action) => {
 	const msg = `No abilities registered for ${model}/${action} — blocking everything. Register the ability or ignore this warning if intentional.`;
 	if (logger) logger.warn({
@@ -716,8 +732,10 @@ const createAbilityBuilder = ({ db, actions, defaultLimit, otel, logger: loggerC
 				*/
 when: (queryFilter) => {
 					for (const action of actions) {
-						if (queryFilters.get(action) === "unrestricted") if (setUnrestrictedByThisCall.has(action)) queryFilters.set(action, []);
-						else continue;
+						if (queryFilters.get(action) === "unrestricted") {
+							if (setUnrestrictedByThisCall.has(action)) queryFilters.set(action, []);
+							else continue;
+						}
 						queryFilters.get(action).push(queryFilter);
 					}
 				} };
@@ -822,7 +840,7 @@ by: (explicitFilter) => {
 								* @example
 								* ```ts
 								* author: t.relation("author", {
-								*  query: (_args, ctx) => ctx.abilities.users.filter("read").query.single,
+								*  query: async (_args, ctx) => (await ctx.abilities.users.filter("read")).query.single,
 								* }),
 								* ´´´
 								*/
@@ -860,7 +878,7 @@ by: (explicitFilter) => {
 								*	.where(
 								*	  and(
 								*	    eq(schema.users.id, args.userId),
-								*	    ctx.abilities.users.filter("update").sql.where,
+								*	    (await ctx.abilities.users.filter("update")).sql.where,
 								*	  ),
 								*	);
 								* ```
@@ -876,7 +894,7 @@ by: (explicitFilter) => {
 								* @example
 								* ```ts
 								* author: t.relation("author", {
-								*  query: (_args, ctx) => ctx.abilities.users.filter("read").query.single,
+								*  query: async (_args, ctx) => (await ctx.abilities.users.filter("read")).query.single,
 								* }),
 								* ´´´
 								*/
@@ -912,7 +930,7 @@ by: (explicitFilter) => {
 								*	.where(
 								*	  and(
 								*	    eq(schema.users.id, args.userId),
-								*	    ctx.abilities.users.filter("update").sql.where,
+								*	    (await ctx.abilities.users.filter("update")).sql.where,
 								*	  ),
 								*	);
 								* ```
@@ -935,8 +953,8 @@ by: (explicitFilter) => {
 						return ret;
 					}
 					return { withContext: (userContext) => {
-						return { filter: (action) => {
-							const assembleAbilities = (attributes) => {
+						const prepare = (action) => {
+							const assembleAbilities = async (attributes) => {
 								const filters = queryFilters.get(action);
 								if (filters === "unrestricted") {
 									attributes[ATTR_ABILITIES_STATUS] = "unrestricted";
@@ -947,19 +965,12 @@ by: (explicitFilter) => {
 									nothingRegisteredWarningLogger(String(tableName), action);
 									return transformToResponse(blockEverythingFilter);
 								}
-								const dynamicResults = new Array(dynamicQueryFilters[action].length);
-								let filtersReturned = 0;
-								for (let i = 0; i < dynamicQueryFilters[action].length; i++) {
-									const func = dynamicQueryFilters[action][i];
-									const result = func(userContext);
-									if (result === "allow") {
-										attributes[ATTR_ABILITIES_STATUS] = "unrestricted";
-										return transformToResponse();
-									}
-									if (result === void 0) continue;
-									dynamicResults[filtersReturned++] = result;
+								const rawResults = await Promise.all(dynamicQueryFilters[action].map((func) => func(userContext)));
+								if (rawResults.includes("allow")) {
+									attributes[ATTR_ABILITIES_STATUS] = "unrestricted";
+									return transformToResponse();
 								}
-								dynamicResults.length = filtersReturned;
+								const dynamicResults = rawResults.filter((r) => r !== void 0);
 								attributes[ATTR_ABILITIES_DYNAMIC] = dynamicResults.length;
 								attributes[ATTR_ABILITIES_STATIC] = simpleQueryFilters[action].length;
 								const allQueryFilters = [...simpleQueryFilters[action], ...dynamicResults];
@@ -974,13 +985,13 @@ by: (explicitFilter) => {
 								attributes[ATTR_ABILITIES_STATUS] = "applied";
 								return transformToResponse(mergedFilters);
 							};
-							const run = (span) => {
+							const run = async (span) => {
 								const attributes = {
 									[ATTR_TABLE]: String(tableName),
 									[ATTR_ACTION]: action
 								};
 								try {
-									const result = assembleAbilities(attributes);
+									const result = await assembleAbilities(attributes);
 									log?.debug({
 										...attributes,
 										...traceCorrelationFields(telemetryConfig, span)
@@ -998,14 +1009,23 @@ by: (explicitFilter) => {
 									span?.setAttributes(attributes);
 								}
 							};
-							if (otel?.enabled && otel.tracer) return otel.tracer.startActiveSpan(SPAN_ABILITIES_PREPARE, (span) => {
+							if (otel?.enabled && otel.tracer) return otel.tracer.startActiveSpan(SPAN_ABILITIES_PREPARE, async (span) => {
 								try {
-									return run(span);
+									return await run(span);
 								} finally {
 									span.end();
 								}
 							});
 							return run();
+						};
+						const cache = /* @__PURE__ */ new Map();
+						return { filter: (action) => {
+							let prepared = cache.get(action);
+							if (!prepared) {
+								prepared = guardAgainstMissingAwait(prepare(action));
+								cache.set(action, prepared);
+							}
+							return prepared;
 						} };
 					} };
 				};
@@ -1088,16 +1108,18 @@ const createEnumImplementer = ({ schema, schemaBuilder }) => {
 		if (enumObject) {
 			enumSchemaName = enumObject.enumName;
 			enumValues = enumObject.enumValues;
-		} else if (enumColumn) if (is(enumColumn, MySqlEnumColumn) || is(enumColumn, MySqlEnumObjectColumn)) {
-			enumValues = enumColumn.enumValues;
-			const colTable = enumColumn.table;
-			const tableName = colTable && isTable(colTable) ? getTableName(colTable) : void 0;
-			enumSchemaName = tableName ? `${tableName}_${enumColumn.name}` : enumColumn.name;
-		} else {
-			const pgEnum = enumColumn.enum;
-			if (!pgEnum) throw new RumbleError(`Could not find enum definition on column. Make sure the column is a pgEnum column.`);
-			enumSchemaName = pgEnum.enumName;
-			enumValues = enumColumn.enumValues;
+		} else if (enumColumn) {
+			if (is(enumColumn, MySqlEnumColumn) || is(enumColumn, MySqlEnumObjectColumn)) {
+				enumValues = enumColumn.enumValues;
+				const colTable = enumColumn.table;
+				const tableName = colTable && isTable(colTable) ? getTableName(colTable) : void 0;
+				enumSchemaName = tableName ? `${tableName}_${enumColumn.name}` : enumColumn.name;
+			} else {
+				const pgEnum = enumColumn.enum;
+				if (!pgEnum) throw new RumbleError(`Could not find enum definition on column. Make sure the column is a pgEnum column.`);
+				enumSchemaName = pgEnum.enumName;
+				enumValues = enumColumn.enumValues;
+			}
 		}
 		if (!enumSchemaName || !enumValues) throw new RumbleError("Could not determine enum structure!");
 		const graphqlImplementationName = refName ?? `${capitalize(toCamelCase(enumSchemaName))}Enum`;
@@ -1118,8 +1140,10 @@ function mapSQLTypeToGraphQLType({ sqlType, fieldName }) {
 	if (isIntLikeSQLTypeString(normalized)) ret = "Int";
 	if (isBigIntLikeSQLTypeString(normalized)) ret = "BigInt";
 	if (isFloatLikeSQLTypeString(normalized)) ret = "Float";
-	if (isStringLikeSQLTypeString(normalized)) if (fieldName && (fieldName.toLowerCase().endsWith("_id") || fieldName.toLowerCase().endsWith("id"))) ret = "ID";
-	else ret = "String";
+	if (isStringLikeSQLTypeString(normalized)) {
+		if (fieldName && (fieldName.toLowerCase().endsWith("_id") || fieldName.toLowerCase().endsWith("id"))) ret = "ID";
+		else ret = "String";
+	}
 	if (isIDLikeSQLTypeString(normalized)) ret = "ID";
 	if (isBooleanSQLTypeString(normalized)) ret = "Boolean";
 	if (isDateTimeLikeSQLTypeString(normalized)) ret = "DateTime";
@@ -1367,8 +1391,9 @@ const clientCreatorImplementer = ({ builtSchema }) => {
 			useExternalUrqlClient,
 			removeExisting
 		})}`);
+		const schema = builtSchema();
 		await generateFromSchema({
-			schema: builtSchema(),
+			schema,
 			outputPath,
 			rumbleImportPath,
 			apiUrl,
@@ -1440,7 +1465,7 @@ const createCountQueryImplementer = ({ db, schemaBuilder, whereArgImplementer, m
 				resolve: async (_root, args, ctx, _info) => {
 					if (isAllowed && !await isAllowed(ctx)) throw new RumbleErrorSafe("Not allowed to perform this action");
 					deepSetProto(args);
-					return db.select({ count: count() }).from(tableSchema.table).where(ctx.abilities[table].filter(listAction).merge(mapNullFieldsToUndefined(args)).sql.where).then(assertFirstEntryExists).then((r) => r.count);
+					return db.select({ count: count() }).from(tableSchema.table).where((await ctx.abilities[table].filter(listAction)).merge(mapNullFieldsToUndefined(args)).sql.where).then(assertFirstEntryExists).then((r) => r.count);
 				}
 			}) };
 		});
@@ -2018,15 +2043,15 @@ const createObjectImplementer = ({ db, search, otel, logger: loggerConfig, schem
 						subscribe,
 						nullable,
 						description: `Get the ${pluralize.plural(relationSchema.tsName)} related to this ${pluralize.singular(tableSchema.tsName)}`,
-						query: (args, ctx) => {
+						query: async (args, ctx) => {
 							args = JSON.parse(JSON.stringify(args));
 							if (isMany) adjustQueryArgsForSearch({
 								search,
 								args,
 								tableSchema: relationSchema,
-								abilities: ctx.abilities[relationSchema.tsName].filter(readAction)
+								abilities: await ctx.abilities[relationSchema.tsName].filter(readAction)
 							});
-							const filter = ctx.abilities[relationSchema.tsName].filter(readAction).merge({
+							const filter = (await ctx.abilities[relationSchema.tsName].filter(readAction)).merge({
 								where: args.where,
 								limit: args.limit,
 								extras: args.extras
@@ -2186,16 +2211,16 @@ const createQueryImplementer = ({ db, schemaBuilder, search, otel, logger: logge
 						});
 					},
 					args: manyArgs,
-					resolve: (query, _root, args, ctx, _info) => {
+					resolve: async (query, _root, args, ctx, _info) => {
 						deepSetProto(args);
 						adjustQueryArgsForSearch({
 							search,
 							args,
 							tableSchema,
-							abilities: ctx.abilities[table].filter(listAction)
+							abilities: await ctx.abilities[table].filter(listAction)
 						});
 						const mappedArgs = mapNullFieldsToUndefined(args);
-						const filter = ctx.abilities[table].filter(listAction).merge(mappedArgs).query.many;
+						const filter = (await ctx.abilities[table].filter(listAction)).merge(mappedArgs).query.many;
 						if (mappedArgs.offset) filter.offset = mappedArgs.offset;
 						if (mappedArgs.orderBy) filter.orderBy = mappedArgs.orderBy;
 						const queryArgs = query(filter);
@@ -2223,9 +2248,9 @@ const createQueryImplementer = ({ db, schemaBuilder, search, otel, logger: logge
 					smartSubscription: true,
 					description: `Get a single ${singularName} by ID`,
 					args: { id: t.arg.id({ required: true }) },
-					resolve: (query, _root, args, ctx, _info) => {
+					resolve: async (query, _root, args, ctx, _info) => {
 						deepSetProto(args);
-						const filter = ctx.abilities[table].filter(readAction).merge({ where: { [primaryKeyField.name]: args.id } }).query.single;
+						const filter = (await ctx.abilities[table].filter(readAction)).merge({ where: { [primaryKeyField.name]: args.id } }).query.single;
 						const queryArgs = query(filter);
 						if (filter.columns) queryArgs.columns = filter.columns;
 						return findFirst ? findFirst({