@appweaver/data 2.0.1 → 2.1.0

package/database/create-client.d.ts

@@ -1,4 +1,4 @@
-import { PrismaClient } from '../prisma/client/client';
+import { Prisma, PrismaClient } from '../prisma/client/client';
 /**
  * Creates and returns a PrismaClient instance based on the configured database type.
  *
@@ -9,3 +9,5 @@ import { PrismaClient } from '../prisma/client/client';
  * @return {PrismaClient} A PrismaClient instance configured for the selected database type.
  */
 export declare function createClient(): PrismaClient;
+/** Logs a query, as a warning without its parameters when it is slow. */
+export declare function logQuery(e: Prisma.QueryEvent): void;

package/database/create-client.js

@@ -4,15 +4,17 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createClient = createClient;
+exports.logQuery = logQuery;
 const node_path_1 = __importDefault(require("node:path"));
 const common_1 = require("@appweaver/common");
 const database_config_1 = require("./database-config");
+const logger = (0, common_1.createLogger)('database');
 const options = {
     transactionOptions: {
         maxWait: database_config_1.databaseConfig.TRANSACTION_MAX_WAIT,
         timeout: database_config_1.databaseConfig.TRANSACTION_TIMEOUT
     },
-    log: database_config_1.databaseConfig.LOG_EVENTS.map((e) => ({ emit: 'event', level: e }))
+    log: emittedEvents().map((e) => ({ emit: 'event', level: e }))
 };
 /**
  * Creates and returns a PrismaClient instance based on the configured database type.
@@ -129,17 +131,33 @@ function createPrismaClient(adapter) {
     const { PrismaClient } = (0, common_1.requireModule)(clientPath, true).value;
     const client = new PrismaClient({ adapter, ...options });
     // Add configured Prisma event logging
-    for (const event of database_config_1.databaseConfig.LOG_EVENTS) {
+    for (const event of emittedEvents()) {
         if (event === common_1.DatabaseEvent.Query) {
-            client.$on(event, (e) => {
-                common_1.logger.debug(e, 'Prisma query');
-            });
+            client.$on(event, logQuery);
         }
         else {
             client.$on(event, (e) => {
-                common_1.logger[event](e, `Prisma ${event} log`);
+                logger[event](e, `Prisma ${event} log`);
             });
         }
     }
     return client;
 }
+/** The events Prisma emits: the logged ones, and the queries to time with a slow query threshold. */
+function emittedEvents() {
+    const events = new Set(database_config_1.databaseConfig.LOG_EVENTS);
+    if (database_config_1.databaseConfig.SLOW_QUERY_THRESHOLD > 0) {
+        events.add(common_1.DatabaseEvent.Query);
+    }
+    return [...events];
+}
+/** Logs a query, as a warning without its parameters when it is slow. */
+function logQuery(e) {
+    const threshold = database_config_1.databaseConfig.SLOW_QUERY_THRESHOLD;
+    if (threshold > 0 && e.duration >= threshold) {
+        logger.warn({ query: e.query, duration: e.duration, threshold }, 'Slow database query');
+    }
+    else if (database_config_1.databaseConfig.LOG_EVENTS.includes(common_1.DatabaseEvent.Query)) {
+        logger.debug(e, 'Prisma query');
+    }
+}

package/database/database-config.d.ts

@@ -10,5 +10,6 @@ export declare const databaseConfig: Readonly<{
     TRANSACTION_TIMEOUT: number;
     AI_DANGEROUS_ACTIONS_ENABLED: boolean;
     LOG_EVENTS: DatabaseEvent[];
+    SLOW_QUERY_THRESHOLD: number;
     PROVIDER: string;
 }>;

package/database/database-config.js

@@ -35,6 +35,9 @@ exports.databaseConfig = (0, common_1.defineConfig)('database', {
     LOG_EVENTS: typebox_1.Type.Array(typebox_1.Type.Enum(common_1.DatabaseEvent), {
         default: []
     }),
+    /** Duration in milliseconds from which a query is logged as a warning by the `database` logger, `0` to disable it.
+     * Default: `0`. */
+    SLOW_QUERY_THRESHOLD: typebox_1.Type.Integer({ default: 0, minimum: 0 }),
     /** Database provider: `auto` or `prisma`, or `none` for an application without a database. Default: `'auto'`. */
     PROVIDER: typebox_1.Type.String({ default: 'auto' })
 });

package/database/prisma-database.js

@@ -5,6 +5,7 @@ const common_1 = require("@appweaver/common");
 const database_config_1 = require("./database-config");
 const create_client_1 = require("./create-client");
 const internal_1 = require("@appweaver/core/internal");
+const logger = (0, common_1.createLogger)('database');
 // Members that act on the connection itself, never on a transaction
 const ROOT_MEMBERS = new Set([
     '$connect',
@@ -27,14 +28,15 @@ class PrismaDatabase extends common_1.Database {
      * failing the start, since most drivers connect lazily and the queries reconnect once it is reachable.
      */
     async onInit() {
+        const dbType = (0, common_1.resolveDatabaseType)(database_config_1.databaseConfig.TYPE, database_config_1.databaseConfig.URL);
+        const url = this.redactUrl(database_config_1.databaseConfig.URL);
         try {
             await this.connect();
             await this.clientInstance().$queryRaw `SELECT 1`;
+            logger.info(`Connected to the ${dbType} database${url ? ` at ${url}` : ''}`);
         }
         catch (error) {
-            const dbType = (0, common_1.resolveDatabaseType)(database_config_1.databaseConfig.TYPE, database_config_1.databaseConfig.URL);
-            const url = this.redactUrl(database_config_1.databaseConfig.URL);
-            common_1.logger.error(error, `Cannot connect to the ${dbType} database${url ? ` at ${url}` : ''}`);
+            logger.error(error, `Cannot connect to the ${dbType} database${url ? ` at ${url}` : ''}`);
             // The next query creates a new client, which detects the capabilities of the database again
             await this.disconnect().catch(() => undefined);
             this._client = undefined;
@@ -55,6 +57,7 @@ class PrismaDatabase extends common_1.Database {
         }
         await this._client.$disconnect();
         this._client = undefined;
+        logger.debug('Disconnected from the database');
     }
     /**
      * Returns the Prisma client, which runs its queries in the transaction the
@@ -109,8 +112,10 @@ class PrismaDatabase extends common_1.Database {
             catch (e) {
                 await (0, internal_1.settleTransaction)(context, false);
                 if (attempt < (options.retries ?? 0) && this.isWriteConflict(e)) {
+                    logger.debug({ attempt: attempt + 1, retries: options.retries }, 'Transaction write conflict, retrying');
                     continue;
                 }
+                logger.debug({ error: e.message }, 'Transaction rolled back');
                 throw e;
             }
             await (0, internal_1.settleTransaction)(context, true);

package/export/export-service.js

@@ -7,6 +7,7 @@ const export_config_1 = require("./export-config");
 const core_1 = require("@appweaver/core");
 const file_util_1 = require("../utils/file-util");
 const export_util_1 = require("../utils/export-util");
+const logger = (0, common_1.createLogger)('resource');
 class ExportService {
     /**
      * Exports data as a CSV stream based on the provided filter and sort parameters.
@@ -59,7 +60,7 @@ class ExportService {
                     }
                     catch (e) {
                         // End early rather than fail a download already in flight
-                        common_1.logger.error(e, `${modelName} export error`);
+                        logger.error(e, `${modelName} export error`);
                         next = undefined;
                     }
                     if (chunk !== undefined) {
@@ -74,7 +75,7 @@ class ExportService {
             throw new common_1.ExportError(common_1.ErrorCode.ExportFailed, `${modelName} export failed`, { model: modelName }, { cause: e });
         }
         const fileName = this.generateExportFileName(modelName, 'csv');
-        common_1.logger.debug({ modelName, filter, fileName }, 'CSV File export');
+        logger.debug({ modelName, filter, fileName }, 'CSV File export');
         return { stream: exportStream, mimeType: 'text/csv', fileName };
     }
     /** @internal */
@@ -143,7 +144,7 @@ class ExportService {
                                 }
                                 catch (e) {
                                     mappedValues.push('');
-                                    common_1.logger.error(e, 'Export value mapping error.');
+                                    logger.error(e, 'Export value mapping error.');
                                 }
                             }
                             else if ((0, common_1.isString)(mapValue)) {

package/factory/create-model.js

@@ -6,6 +6,7 @@ const common_1 = require("@appweaver/common");
 const internal_1 = require("@appweaver/core/internal");
 const core_1 = require("@appweaver/core");
 const model_schema_1 = require("../resource/model-schema");
+const logger = (0, common_1.createLogger)('resource');
 /**
  * Creates a resource model from its configuration and defines it in the application context. The names of the
  * declared fields are inferred from the configuration, so the `read`, `create`, and `update` options only accept
@@ -18,7 +19,7 @@ const model_schema_1 = require("../resource/model-schema");
 function createModel(modelConfig, override = false) {
     const config = normalizeRelations(modelConfig);
     const resourceModel = buildModel(config);
-    common_1.logger.debug({ modelName: resourceModel.name }, 'Created resource model');
+    logger.debug({ modelName: resourceModel.name }, 'Created resource model');
     (0, core_1.define)(resourceModel, undefined, override ? 'override' : undefined);
     // The relation inputs and audit fields reference the primary key of another
     // model, which may not be loaded yet. Loaders call this hook once every model

package/factory/create-policy.js

@@ -3,6 +3,7 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createPolicy = createPolicy;
 const common_1 = require("@appweaver/common");
 const core_1 = require("@appweaver/core");
+const logger = (0, common_1.createLogger)('resource');
 /**
  * Creates the policy of a model, checking the access to its records and restricting the reads and writes. Once the
  * types are generated, the records the callbacks receive are typed by the model name.
@@ -14,7 +15,7 @@ const core_1 = require("@appweaver/core");
 function createPolicy(config, override = false) {
     config[common_1.RESOURCE_NAME] = (0, common_1.capitalize)(config.modelName);
     config[common_1.RESOURCE_TYPE] = common_1.RESOURCE_POLICY_TYPE;
-    common_1.logger.debug({ modelName: config.modelName }, 'Created resource policy');
+    logger.debug({ modelName: config.modelName }, 'Created resource policy');
     (0, core_1.define)(config, undefined, override ? 'override' : undefined);
     return config;
 }

package/factory/create-service.js

@@ -5,6 +5,7 @@ const common_1 = require("@appweaver/common");
 const core_1 = require("@appweaver/core");
 const resource_service_1 = require("../resource/resource-service");
 const text_search_util_1 = require("../resource/utils/text-search-util");
+const logger = (0, common_1.createLogger)('resource');
 /**
  * Creates the resource service of a model, running the configured hooks around its operations and applying the
  * policy of the model. The update hooks run around both an update and a replacement. Once the types are generated,
@@ -110,7 +111,7 @@ function createService(config, override = false) {
     Service[common_1.CONFIG] = config;
     Service[common_1.RESOURCE_NAME] = name;
     Service[common_1.RESOURCE_TYPE] = common_1.RESOURCE_SERVICE_TYPE;
-    common_1.logger.debug({ modelName: config.modelName }, 'Created resource service');
+    logger.debug({ modelName: config.modelName }, 'Created resource service');
     (0, core_1.define)(Service, undefined, override ? 'override' : undefined);
     return Service;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@appweaver/data",
-  "version": "2.0.1",
+  "version": "2.1.0",
   "description": "Appweaver - the backend framework for AI-first development (@data)",
   "author": "Luka Matosevic",
   "license": "MIT",
@@ -51,8 +51,8 @@
     "csv-stringify": "6.8.0"
   },
   "peerDependencies": {
-    "@appweaver/common": "^2.0.1",
-    "@appweaver/core": "^2.0.1",
+    "@appweaver/common": "^2.1.0",
+    "@appweaver/core": "^2.1.0",
     "@prisma/client": "^7.9.0"
   },
   "devDependencies": {

package/resource/load-data-resources.js

@@ -6,6 +6,7 @@ const common_1 = require("@appweaver/common");
 const core_1 = require("@appweaver/core");
 const internal_1 = require("@appweaver/core/internal");
 const resource_loader_1 = require("./resource-loader");
+const logger = (0, common_1.createLogger)('resource');
 /**
  * The setup of `@appweaver/data`: loads the models, services and policies of the application, then the resources of
  * the modules, unless the `autoLoadResources` parameter of `createApp` is `false`.
@@ -31,7 +32,7 @@ function warnUnprocessedImages() {
         .filter(([, field]) => field?.image)
         .map(([name]) => `${model.name}.${name}`));
     if (fields.length > 0) {
-        common_1.logger.warn({ fields }, 'The images of these file fields are stored unprocessed, since no image processor is provided: install ' +
+        logger.warn({ fields }, 'The images of these file fields are stored unprocessed, since no image processor is provided: install ' +
             '@appweaver/sharp, or select one in IMAGE_PROVIDER');
     }
 }

package/resource/resource-loader.js

@@ -8,6 +8,7 @@ const file_util_1 = require("../utils/file-util");
 const model_util_1 = require("../utils/model-util");
 const internal_1 = require("@appweaver/core/internal");
 const prune_util_1 = require("./utils/prune-util");
+const logger = (0, common_1.createLogger)('resource');
 /**
  * Loads the application resources: models, services and policies.
  *
@@ -124,7 +125,7 @@ async function findExports(pattern, cwd, moduleResources) {
     for (const filePath of await (0, common_1.findFilesByPattern)(pattern, cwd)) {
         const { value, error } = await (0, common_1.importModule)(filePath);
         if (error) {
-            common_1.logger.error(error, 'Resource path import error');
+            logger.error(error, 'Resource path import error');
             continue;
         }
         if (value) {

package/resource/resource-service.js

@@ -15,6 +15,7 @@ const relation_util_1 = require("./utils/relation-util");
 const cursor_util_1 = require("./utils/cursor-util");
 const filter_util_1 = require("./utils/filter-util");
 const sort_util_1 = require("./utils/sort-util");
+const logger = (0, common_1.createLogger)('resource');
 class ResourceService {
     modelName;
     /** @internal */
@@ -404,6 +405,7 @@ class ResourceService {
         this._events.emitResourceEvent(this._client.name, 'create', {
             current: resource
         });
+        logger.debug({ model: this._client.name, id: resource.id }, 'Resource created');
         return this.projectResource(resource);
     }
     /**
@@ -535,6 +537,7 @@ class ResourceService {
         this._events.emitResourceEvent(this._client.name, 'delete', {
             current: resource
         });
+        logger.debug({ model: this._client.name, id, softDelete }, 'Resource deleted');
         return this.projectResource(resource);
     }
     /**
@@ -678,6 +681,7 @@ class ResourceService {
             previous: updateResource,
             current: resource
         });
+        logger.debug({ model: this._client.name, id }, 'Resource updated');
         return {
             previous: this.projectResource(updateResource),
             current: this.projectResource(resource)
@@ -826,7 +830,15 @@ class ResourceService {
      * @internal
      */
     async applyAccessCheck(action, resource) {
-        return (0, policy_util_1.arePoliciesSkipped)() || this.checkAccess(action, resource);
+        if ((0, policy_util_1.arePoliciesSkipped)() || (await this.checkAccess(action, resource))) {
+            return true;
+        }
+        logger.debug({
+            model: this._client.name,
+            action,
+            id: resource?.id
+        }, 'Resource access denied by its policy');
+        return false;
     }
     /**
      * Builds the database conditions of a query filter: the mapped filter, its
@@ -984,7 +996,7 @@ class ResourceService {
      */
     async bulk(items, operation, prepare) {
         try {
-            return await this._db.client().$transaction(async () => {
+            const results = await this._db.client().$transaction(async () => {
                 await prepare?.();
                 const results = [];
                 for (const item of items) {
@@ -995,6 +1007,8 @@ class ResourceService {
                 }
                 return results;
             }, { timeout: resource_config_1.resourceConfig.BULK_TRANSACTION_TIMEOUT });
+            logger.debug({ model: this._client.name, count: results.length }, 'Bulk operation committed');
+            return results;
         }
         catch (e) {
             // The errors of the items are translated already, which leaves the

package/storage/file-service.js

@@ -9,6 +9,7 @@ const policy_util_1 = require("../utils/policy-util");
 const file_util_1 = require("../utils/file-util");
 const model_util_1 = require("../utils/model-util");
 const internal_1 = require("@appweaver/core/internal");
+const logger = (0, common_1.createLogger)('storage');
 class FileService {
     /** @internal */
     _db = (0, core_1.inject)(common_1.Database);
@@ -217,7 +218,7 @@ class FileService {
                 where: { name: fileName }
             }));
             deletedFile.url = (0, file_util_1.buildFileUrl)(deletedFile);
-            common_1.logger.debug({ deletedFile }, 'File deleted');
+            logger.debug({ deletedFile }, 'File deleted');
             return deletedFile;
         }
         catch (e) {
@@ -302,7 +303,7 @@ class FileService {
             }));
         }
         catch (e) {
-            common_1.logger.error({ resourceName, resourceIds, error: e }, 'Error finding resource files for deletion');
+            logger.error({ resourceName, resourceIds, error: e }, 'Error finding resource files for deletion');
             return [];
         }
         const deletedFiles = [];
@@ -312,11 +313,11 @@ class FileService {
                 deletedFiles.push(file);
             }
             else {
-                common_1.logger.error({ resourceName, resourceId: file.resourceId, fileName: file.name }, 'Failed to delete file');
+                logger.error({ resourceName, resourceId: file.resourceId, fileName: file.name }, 'Failed to delete file');
             }
         }
         if (deletedFiles.length > 0) {
-            common_1.logger.debug({ resourceName, resourceIds, deletedCount: deletedFiles.length }, 'Resource files deleted');
+            logger.debug({ resourceName, resourceIds, deletedCount: deletedFiles.length }, 'Resource files deleted');
         }
         return deletedFiles;
     }
@@ -448,7 +449,7 @@ class FileService {
         // pipe() does not forward source errors to destinations, so both branches
         // must be destroyed manually to avoid hanging on a failed upload stream.
         fileStream.on('error', (e) => {
-            common_1.logger.error(e, 'Error calculating file checksum');
+            logger.error(e, 'Error calculating file checksum');
             storageStream.destroy(e);
             checksumStream.destroy(e);
         });
@@ -502,7 +503,7 @@ class FileService {
                 file = result[data.fieldName].find((f) => f.name === createFile.name);
             }
             file.url = (0, file_util_1.buildFileUrl)(file);
-            common_1.logger.debug({ file }, 'File saved');
+            logger.debug({ file }, 'File saved');
             return file;
         }
         catch (e) {