feat: use yazl for export actions of items (#1914)

* feat: use yazl for export actions of items

* refactor: refactor code

* refactor: remove file

* refactor: refactor code

* refactor: use action export format locally

* refactor: apply PR requested changes

* refactor: update code

Author: pyphilia

package.json

@@ -73,7 +73,6 @@
     "@sentry/tracing": "7.120.3",
     "@sinclair/typebox": "0.34.33",
     "ajv": "8.17.1",
-    "archiver": "7.0.1",
     "bcrypt": "5.1.1",
     "bullmq": "5.46.1",
     "date-fns": "4.1.0",
@@ -129,7 +128,6 @@
     "@jest/globals": "29.7.0",
     "@quobix/vacuum": "0.17.0",
     "@trivago/prettier-plugin-sort-imports": "5.2.2",
-    "@types/archiver": "6.0.2",
     "@types/bad-words": "3.0.3",
     "@types/bcrypt": "5.0.2",
     "@types/checksum": "0.1.35",

src/drizzle/schema.ts

@@ -38,10 +38,11 @@ export const actionViewEnum = pgEnum('action_view_enum', [
   'auth',
   'unknown',
 ]);
-export const actionRequestExportFormatEnum = pgEnum('action_request_export_format_enum', [
-  'json',
-  'csv',
-]);
+export const actionRequestExportFormats = ['json', 'csv'] as const;
+export const actionRequestExportFormatEnum = pgEnum(
+  'action_request_export_format_enum',
+  actionRequestExportFormats,
+);
 export const itemExportRequestTypeEnum = pgEnum('item_export_request_type_enum', ['raw', 'graasp']);
 export const chatMentionStatusEnum = pgEnum('chat_mention_status_enum', ['unread', 'read']);
 export const shortLinkPlatformEnum = pgEnum('short_link_platform_enum', [

src/drizzle/types.ts

@@ -334,6 +334,7 @@ export type MemberProfileRaw = typeof memberProfilesTable.$inferSelect;
 export type MemberProfileInsertDTO = typeof memberProfilesTable.$inferInsert;
 
 export type ActionRequestExportRaw = typeof actionRequestExportsTable.$inferSelect;
+export type ActionRequestExportFormat = ActionRequestExportRaw['format'];
 
 export type ItemExportRequestRaw = typeof itemExportRequestsTable.$inferSelect;
 

src/services/action/action.repository.ts

@@ -91,11 +91,12 @@ export class ActionRepository {
       andConditions.push(eq(actionsTable.accountId, filters.accountId));
     }
     // subquery for items descendants of the itemPath queried
-    const itemSub = await dbConnection
+    const itemSub = dbConnection
       .select()
       .from(items)
       .where(isDescendantOrSelf(items.path, itemPath))
       .as('item');
+
     const res = await dbConnection
       .select()
       .from(actionsTable)

src/services/action/types.ts

@@ -1,24 +1,3 @@
 import { type Lookup, lookup } from 'geoip-lite';
 
-import { AggregateFunction, AggregateMetric, type UnionOfConst } from '@graasp/sdk';
-
 export const getGeolocationIp = (ip: string | number): Lookup | null => lookup(ip);
-
-export const aggregateExpressionNames = {
-  user: 'action.account_id',
-  actionType: 'action.type',
-  actionLocation: 'action.geolocation',
-  itemId: 'action.item_id',
-  createdDay: "date_trunc('day', action.createdAt)",
-  createdTimeOfDay: 'extract(hour from action.created_at)',
-  createdDayOfWeek: 'extract(dow from action.created_at)',
-} as const;
-export type AggregateExpressionValuesOptions = UnionOfConst<typeof aggregateExpressionNames>;
-
-export const buildAggregateExpression = (
-  subqueryName: string,
-  func?: AggregateFunction,
-  metric?: AggregateMetric,
-): string => {
-  return `${func}(${subqueryName}."${metric}")`;
-};

src/services/action/utils/actions.ts

@@ -17,80 +17,3 @@ export class CannotWriteFileError extends GraaspActionError {
     );
   }
 }
-
-export class InvalidAggregationError extends GraaspActionError {
-  constructor(message?: string) {
-    super({
-      code: 'GPAERR002',
-      statusCode: StatusCodes.BAD_REQUEST,
-      message: 'The query parameters for the aggregation are invalid: ' + message,
-    });
-  }
-}
-
-export class AggregateByCannotUserError extends GraaspActionError {
-  constructor(data?: unknown) {
-    super(
-      {
-        code: 'GPAERR003',
-        statusCode: StatusCodes.BAD_REQUEST,
-        message: 'aggregate by cannot be "user"',
-      },
-      data,
-    );
-  }
-}
-
-export class AggregateByCannotIncludeAggregateMetricError extends GraaspActionError {
-  constructor(data?: unknown) {
-    super(
-      {
-        code: 'GPAERR004',
-        statusCode: StatusCodes.BAD_REQUEST,
-        message: 'aggregateBy cannot include aggregateMetric',
-      },
-      data,
-    );
-  }
-}
-
-// todo: not sure of the name, I'm not sure what it really does
-export class CountGroupByShouldIncludeAggregateMetricError extends GraaspActionError {
-  constructor(data?: unknown) {
-    super(
-      {
-        code: 'GPAERR005',
-        statusCode: StatusCodes.BAD_REQUEST,
-        message:
-          "countGroupBy should include aggregateMetric, except for aggregateMetric !== 'actionCount'",
-      },
-      data,
-    );
-  }
-}
-
-export class CountGroupByShouldIncludeAggregateByError extends GraaspActionError {
-  constructor(data?: unknown) {
-    super(
-      {
-        code: 'GPAERR006',
-        statusCode: StatusCodes.BAD_REQUEST,
-        message: 'countGroupBy should include aggregateBy, unless it is actionCount',
-      },
-      data,
-    );
-  }
-}
-
-export class InvalidAggregateFunctionError extends GraaspActionError {
-  constructor(data?: unknown) {
-    super(
-      {
-        code: 'GPAERR007',
-        statusCode: StatusCodes.BAD_REQUEST,
-        message: 'aggregateFunction cannot be applied on aggregateMetric=actionCount',
-      },
-      data,
-    );
-  }
-}