@crowdin/app-project-module 3.0.1 → 3.2.0

package/out/storage/drizzle/d1/index.js

@@ -13,11 +13,12 @@ exports.migrateD1 = void 0;
 exports.initD1 = initD1;
 const d1_1 = require("drizzle-orm/d1");
 const init_1 = require("./migrations/init");
+const user_errors_indexes_1 = require("./migrations/user-errors-indexes");
 const types_1 = require("./types");
 function initD1({ database, additionalSchema, }) {
     return (0, d1_1.drizzle)(database, { schema: Object.assign(Object.assign({}, types_1.D1_SCHEMA), additionalSchema) });
 }
-const migrations = [init_1.INIT_MIGRATION];
+const migrations = [init_1.INIT_MIGRATION, user_errors_indexes_1.USER_ERRORS_INDEXES_MIGRATION];
 const migrationHistoryTableName = '__drizzle_migrations';
 const migrateD1 = (db_1, ...args_1) => __awaiter(void 0, [db_1, ...args_1], void 0, function* (db, additionalMigrations = []) {
     const allMigrations = [...migrations, ...additionalMigrations];

package/out/storage/drizzle/d1/migrations/user-errors-indexes.d.ts

@@ -0,0 +1,7 @@
+import { Migration } from '../types';
+/**
+ * Indexes for the paginated error log query:
+ * WHERE crowdin_id = ? AND integration_id = ? ORDER BY created_at DESC LIMIT ? OFFSET ?
+ * and for the retention cron, which deletes by created_at.
+ */
+export declare const USER_ERRORS_INDEXES_MIGRATION: Migration;

package/out/storage/drizzle/d1/migrations/user-errors-indexes.js

@@ -0,0 +1,27 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.USER_ERRORS_INDEXES_MIGRATION = void 0;
+/**
+ * Indexes for the paginated error log query:
+ * WHERE crowdin_id = ? AND integration_id = ? ORDER BY created_at DESC LIMIT ? OFFSET ?
+ * and for the retention cron, which deletes by created_at.
+ */
+exports.USER_ERRORS_INDEXES_MIGRATION = {
+    name: 'user-errors-indexes',
+    run: (db) => __awaiter(void 0, void 0, void 0, function* () {
+        yield db.$client.batch([
+            db.$client.prepare(`CREATE INDEX IF NOT EXISTS idx_user_errors_crowdin_integration_created_at
+                    ON user_errors (crowdin_id, integration_id, created_at)`),
+            db.$client.prepare('CREATE INDEX IF NOT EXISTS idx_user_errors_created_at ON user_errors (created_at)'),
+        ]);
+    }),
+};

package/out/storage/drizzle/index.d.ts

@@ -1,7 +1,7 @@
 import { IntegrationConfig, IntegrationCredentials, IntegrationFilesSnapshot, IntegrationSyncSettings, IntegrationWebhooks, Provider } from '../../modules/integration/types';
 import { CreateJobParams, GetActiveJobsParams, GetAllJobsParams, GetFileTranslationCache, GetFileTranslationCacheByLanguageParams, GetJobParams, GetUnsyncedFiles, IntegrationSyncedData, Job, TranslationCache, UnsyncedFiles, UpdateJobParams, UpdateTranslationCacheParams } from '../../modules/integration/util/types';
 import { Config, CrowdinCredentials, UnauthorizedConfig } from '../../types';
-import { DB_TYPE, Storage, UserErrors } from '../types';
+import { DB_TYPE, GetUserErrorParams, GetUserErrorsParams, Storage, UserErrorListItem, UserErrors, UserErrorsFilter } from '../types';
 import { POSTGRESQL_DB, POSTGRESQL_SCHEMA } from './postgresql';
 export declare class DrizzleStorage implements Storage {
     readonly db: POSTGRESQL_DB;
@@ -48,7 +48,14 @@ export declare class DrizzleStorage implements Storage {
     getWebhooks(fileId: string, integrationId: string, crowdinId: string, provider: Provider): Promise<IntegrationWebhooks | undefined>;
     saveWebhooks(fileId: string, integrationId: string, crowdinId: string, provider: Provider): Promise<void>;
     deleteWebhooks(fileIds: string[], integrationId: string, crowdinId: string, provider: Provider): Promise<void>;
+    private userErrorsWhereClause;
+    /**
+     * @deprecated kept for backward compatibility only - see {@link Storage.getAllUserErrors}.
+     */
     getAllUserErrors(crowdinId: string, integrationId?: string): Promise<UserErrors[] | undefined>;
+    getUserErrors({ crowdinId, integrationId, search, limit, offset, orderDirection, }: GetUserErrorsParams): Promise<UserErrorListItem[]>;
+    countUserErrors(params: UserErrorsFilter): Promise<number>;
+    getUserError({ id, crowdinId, integrationId }: GetUserErrorParams): Promise<UserErrors | undefined>;
     saveUserError(action: string, message: string, data: string, createdAt: string, crowdinId: string, integrationId?: string): Promise<void>;
     deleteUserErrors(createdAt: string, crowdinId: string, integrationId?: string): Promise<void>;
     deleteAllUsersErrorsOlderThan(createdAt: string): Promise<void>;

package/out/storage/drizzle/index.js

@@ -595,13 +595,30 @@ class DrizzleStorage {
                 .where((0, drizzle_orm_1.and)((0, drizzle_orm_1.inArray)(this.schema.webhooks.file_id, fileIds), (0, drizzle_orm_1.eq)(this.schema.webhooks.integration_id, integrationId), (0, drizzle_orm_1.eq)(this.schema.webhooks.crowdin_id, crowdinId), (0, drizzle_orm_1.eq)(this.schema.webhooks.provider, provider)));
         });
     }
+    userErrorsWhereClause({ crowdinId, integrationId, search }) {
+        const conditions = [
+            (0, drizzle_orm_1.eq)(this.schema.userErrors.crowdin_id, crowdinId),
+            integrationId
+                ? (0, drizzle_orm_1.eq)(this.schema.userErrors.integration_id, integrationId)
+                : (0, drizzle_orm_1.isNull)(this.schema.userErrors.integration_id),
+        ];
+        const searchTerm = search === null || search === void 0 ? void 0 : search.trim().toLowerCase();
+        if (searchTerm) {
+            // escape LIKE wildcards so that a literal % or _ typed by the user is matched as is
+            const pattern = `%${searchTerm.replace(/[\\%_]/g, (char) => `\\${char}`)}%`;
+            conditions.push((0, drizzle_orm_1.or)((0, drizzle_orm_1.sql) `lower(${this.schema.userErrors.action}) like ${pattern} escape '\\'`, (0, drizzle_orm_1.sql) `lower(${this.schema.userErrors.message}) like ${pattern} escape '\\'`));
+        }
+        return (0, drizzle_orm_1.and)(...conditions);
+    }
+    /**
+     * @deprecated kept for backward compatibility only - see {@link Storage.getAllUserErrors}.
+     */
     getAllUserErrors(crowdinId, integrationId) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.migrationPromise;
-            const whereClause = integrationId
-                ? (0, drizzle_orm_1.and)((0, drizzle_orm_1.eq)(this.schema.userErrors.crowdin_id, crowdinId), (0, drizzle_orm_1.eq)(this.schema.userErrors.integration_id, integrationId))
-                : (0, drizzle_orm_1.and)((0, drizzle_orm_1.eq)(this.schema.userErrors.crowdin_id, crowdinId), (0, drizzle_orm_1.isNull)(this.schema.userErrors.integration_id));
-            const items = yield this.db.query.userErrors.findMany({ where: whereClause });
+            const items = yield this.db.query.userErrors.findMany({
+                where: this.userErrorsWhereClause({ crowdinId, integrationId }),
+            });
             return items.map((item) => ({
                 id: item.id,
                 action: item.action,
@@ -613,6 +630,60 @@ class DrizzleStorage {
             }));
         });
     }
+    getUserErrors(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ crowdinId, integrationId, search, limit, offset, orderDirection = 'desc', }) {
+            yield this.migrationPromise;
+            // `columns` keeps the heavy `data` column out of the result set
+            const items = yield this.db.query.userErrors.findMany({
+                columns: { id: true, action: true, message: true, created_at: true },
+                where: this.userErrorsWhereClause({ crowdinId, integrationId, search }),
+                orderBy: [
+                    orderDirection === 'asc'
+                        ? (0, drizzle_orm_1.asc)(this.schema.userErrors.created_at)
+                        : (0, drizzle_orm_1.desc)(this.schema.userErrors.created_at),
+                ],
+                limit,
+                offset,
+            });
+            return items.map((item) => ({
+                id: item.id,
+                action: item.action,
+                message: item.message,
+                createdAt: item.created_at,
+            }));
+        });
+    }
+    countUserErrors(params) {
+        return __awaiter(this, void 0, void 0, function* () {
+            var _a;
+            yield this.migrationPromise;
+            const [row] = yield this.db
+                .select({ value: (0, drizzle_orm_1.count)() })
+                .from(this.schema.userErrors)
+                .where(this.userErrorsWhereClause(params));
+            return Number((_a = row === null || row === void 0 ? void 0 : row.value) !== null && _a !== void 0 ? _a : 0);
+        });
+    }
+    getUserError(_a) {
+        return __awaiter(this, arguments, void 0, function* ({ id, crowdinId, integrationId }) {
+            yield this.migrationPromise;
+            const item = yield this.db.query.userErrors.findFirst({
+                where: (0, drizzle_orm_1.and)((0, drizzle_orm_1.eq)(this.schema.userErrors.id, id), this.userErrorsWhereClause({ crowdinId, integrationId })),
+            });
+            if (!item) {
+                return undefined;
+            }
+            return {
+                id: item.id,
+                action: item.action,
+                message: item.message,
+                data: item.data,
+                createdAt: item.created_at,
+                crowdinId: item.crowdin_id,
+                integrationId: item.integration_id,
+            };
+        });
+    }
     saveUserError(action, message, data, createdAt, crowdinId, integrationId) {
         return __awaiter(this, void 0, void 0, function* () {
             yield this.migrationPromise;

package/out/storage/drizzle/postgresql/migrations/0003_user_errors_pagination_index.sql

@@ -0,0 +1,5 @@
+-- index that backs the paginated error log query:
+-- WHERE crowdin_id = ? AND integration_id = ? ORDER BY created_at DESC LIMIT ? OFFSET ?
+CREATE INDEX IF NOT EXISTS idx_user_errors_crowdin_integration_created_at ON "user_errors" ("crowdin_id","integration_id","created_at");
+-- index for the retention cron, which deletes by created_at
+CREATE INDEX IF NOT EXISTS idx_user_errors_created_at ON "user_errors" ("created_at");