feat(graasp-export): import and export the APP items (#1877)

* feat(graasp-export): import and export the APP items

* feat(graasp-export): import and export the APP items

* refactor: apply PR requested changes

* refactor: fix test

* refactor: remove console log

* refactor: remove debug

* refactor: apply PR requested changes

---------

Co-authored-by: kim <kim.phanhoang@epfl.ch>

Author: MatveyK

src/services/item/plugins/app/appSetting/appSetting.repository.ts

@@ -19,6 +19,10 @@ export class AppSettingRepository {
     return res[0];
   }
 
+  async createMany(dbConnection: DBConnection, appSettings: AppSettingInsertDTO[]): Promise<void> {
+    await dbConnection.insert(appSettingsTable).values(appSettings);
+  }
+
   async updateOne(
     dbConnection: DBConnection,
     appSettingId: string,

src/services/item/plugins/app/appSetting/appSetting.service.ts

@@ -16,13 +16,6 @@ export class AppSettingService {
   private readonly appSettingRepository: AppSettingRepository;
 
   hooks = new HookManager<{
-    post: {
-      pre: {
-        appSetting: Omit<AppSettingInsertDTO, 'itemId' | 'memberId'>;
-        itemId: string;
-      };
-      post: { appSetting: AppSettingRaw; itemId: string };
-    };
     patch: {
       pre: { appSetting: Partial<AppSettingRaw>; itemId: string };
       post: { appSetting: AppSettingRaw; itemId: string };
@@ -66,20 +59,12 @@ export class AppSettingService {
       permission: PermissionLevel.Admin,
     });
 
-    await this.hooks.runPreHooks('post', member, dbConnection, {
-      appSetting: body,
-      itemId,
-    });
-
     const appSetting = await this.appSettingRepository.addOne(dbConnection, {
       ...body,
       itemId,
       creatorId: member.id,
     });
-    await this.hooks.runPostHooks('post', member, dbConnection, {
-      appSetting,
-      itemId,
-    });
+
     return appSetting;
   }
 

src/services/item/plugins/importExport/index.ts

@@ -12,7 +12,7 @@ import { BaseLogger } from '../../../../logger';
 import { asDefined, assertIsDefined } from '../../../../utils/assertions';
 import { ActionService } from '../../../action/action.service';
 import { isAuthenticated, matchOne, optionalIsAuthenticated } from '../../../auth/plugins/passport';
-import { assertIsMember, isMember } from '../../../authentication';
+import { assertIsMember } from '../../../authentication';
 import { AuthorizedItemService } from '../../../authorizedItem.service';
 import { validatedMemberAccountRole } from '../../../member/strategies/validatedMemberAccountRole';
 import { WrongItemTypeError } from '../../errors';

src/services/item/plugins/importExport/service.ts

@@ -20,13 +20,14 @@ import {
 } from '@graasp/sdk';
 
 import { type DBConnection } from '../../../../drizzle/db';
-import { type ItemRaw } from '../../../../drizzle/types';
+import { AppSettingInsertDTO, AppSettingRaw, type ItemRaw } from '../../../../drizzle/types';
 import { BaseLogger } from '../../../../logger';
 import { MaybeUser, MinimalMember } from '../../../../types';
 import { AuthorizedItemService } from '../../../authorizedItem.service';
 import { UploadEmptyFileError } from '../../../file/utils/errors';
 import { isItemType } from '../../discrimination';
 import { ItemService } from '../../item.service';
+import { AppSettingRepository } from '../app/appSetting/appSetting.repository';
 import { EtherpadItemService } from '../etherpad/etherpad.service';
 import FileItemService from '../file/itemFile.service';
 import { H5PService } from '../html/h5p/h5p.service';
@@ -58,6 +59,7 @@ export type GraaspExportItem = {
   thumbnailFilename?: string;
   children?: GraaspExportItem[];
   mimetype?: string;
+  appSettings?: Omit<AppSettingRaw, 'id'>[];
 };
 
 @singleton()
@@ -68,6 +70,7 @@ export class ImportExportService {
   private readonly authorizedItemService: AuthorizedItemService;
   private readonly etherpadService: EtherpadItemService;
   private readonly itemThumbnailService: ItemThumbnailService;
+  private readonly appSettingRepository: AppSettingRepository;
   private readonly log: BaseLogger;
 
   constructor(
@@ -76,13 +79,17 @@ export class ImportExportService {
     h5pService: H5PService,
     etherpadService: EtherpadItemService,
     authorizedItemService: AuthorizedItemService,
+    itemThumbnailService: ItemThumbnailService,
+    appSettingRepository: AppSettingRepository,
     log: BaseLogger,
   ) {
     this.fileItemService = fileItemService;
     this.h5pService = h5pService;
     this.itemService = itemService;
     this.etherpadService = etherpadService;
     this.authorizedItemService = authorizedItemService;
+    this.itemThumbnailService = itemThumbnailService;
+    this.appSettingRepository = appSettingRepository;
     this.log = log;
   }
 
@@ -310,7 +317,12 @@ export class ImportExportService {
             h5pFileStream,
           );
 
-          extra = h5pFileInfo;
+          extra = { [ItemType.H5P]: h5pFileInfo };
+        }
+
+        // Handle the APP item extra
+        if (item.type === ItemType.APP) {
+          extra = item.extra;
         }
 
         // Handle the file upload
@@ -343,6 +355,9 @@ export class ImportExportService {
       parentId: parentId,
     });
 
+    // Create the app settings for the APP items
+    await this.insertAppSettings(dbConnection, actor, uploadedItems, items);
+
     // Recursively handle the children items
     for (let i = 0; i < items.length; i++) {
       if (items[i].type === ItemType.FOLDER) {
@@ -359,6 +374,48 @@ export class ImportExportService {
     }
   }
 
+  /**
+   * Extract the app settings from the export items and attach them to the existing items in the DB.
+   */
+  private async insertAppSettings(
+    dbConnection: DBConnection,
+    actor: MinimalMember,
+    uploadedItems: ItemRaw[],
+    items: GraaspExportItem[],
+  ): Promise<void> {
+    const appSettings = uploadedItems.reduce<Omit<AppSettingInsertDTO[], 'id'>>(
+      (arr, uploadedItem, idx) => {
+        const settings = items[idx].appSettings;
+        if (uploadedItem.type !== ItemType.APP || !settings) {
+          return arr;
+        }
+
+        return arr.concat(
+          settings.reduce<Omit<AppSettingInsertDTO[], 'id'>>((arr, appSetting) => {
+            // ignore app setting file
+            if (appSetting.data[ItemType.FILE]) {
+              return arr;
+            }
+
+            // Remove the id property from the imported app settings as a precaution. Remove this condition as soon as the id is stripped directly in the post function.
+            // eslint-disable-next-line @typescript-eslint/ban-ts-comment
+            // @ts-expect-error
+            // eslint-disable-next-line @typescript-eslint/no-unused-vars
+            const { id, creatorId, itemId, ...appSettingData } = appSetting;
+
+            return arr.concat([
+              { creatorId: actor.id, itemId: uploadedItem.id, ...appSettingData },
+            ]);
+          }, []),
+        );
+      },
+      [],
+    );
+    if (appSettings.length) {
+      await this.appSettingRepository.createMany(dbConnection, appSettings);
+    }
+  }
+
   /**
    * Add item in archive, recursively add children in folder
    * @param actor
@@ -441,6 +498,16 @@ export class ImportExportService {
       archive,
     );
 
+    // Get the app settings if an item is an APP
+    let appSettings: Omit<AppSettingRaw, 'id'>[] | undefined = undefined;
+    if (isItemType(item, ItemType.APP)) {
+      const itemAppSettings = await this.appSettingRepository.getForItem(dbConnection, item.id);
+
+      appSettings = itemAppSettings.map((appSetting) => {
+        return { ...appSetting, id: undefined, itemId: exportItemId };
+      });
+    }
+
     // TODO EXPORT treat the shortcut items correctly
     // ignore the shortcuts for now
     if (isItemType(item, ItemType.SHORTCUT)) {
@@ -484,6 +551,7 @@ export class ImportExportService {
       extra: item.extra,
       thumbnailFilename,
       mimetype,
+      appSettings,
     });
     archive.addReadStream(stream, itemPath);
     return itemManifest;

src/services/item/plugins/importExport/specifications.md

@@ -16,6 +16,7 @@ The export operation produces a single zip file. This file is a simple zip file
 - thumbnailFilename (item thumbnail in the original size, if present)
 - children (item children, in case of a folder item)
 - mimetype (item file mimetype, in case there's a file attached to the item)
+- appSettings (app settings for the APP items)
 ```
 
 ### Files and thumbnails
@@ -30,7 +31,7 @@ The `description` field for all items is sanitized before item creation.
 
 ### Item type-specific treatment
 
-- `APP` - Not currently supported.
+- `APP` - The app item extras are imported as-is. The app settings are also imported (ignoring files).
 - `DOCUMENT` - The `name` and `content` fields are sanitized.
 - `FOLDER` - The children are recursively imported, if present.
 - `LINK` - Not currently supported.

src/services/item/plugins/importExport/test/fixtures/graasp-archive.zip

@@ -28,7 +28,7 @@ import { seedFromJson } from '../../../../../../test/mocks/seed';
 import { resolveDependency } from '../../../../../di/utils';
 import { db } from '../../../../../drizzle/db';
 import { isDescendantOrSelf, isDirectChild } from '../../../../../drizzle/operations';
-import { itemsRawTable } from '../../../../../drizzle/schema';
+import { appSettingsTable, itemsRawTable } from '../../../../../drizzle/schema';
 import { MailerService } from '../../../../../plugins/mailer/mailer.service';
 import { assertIsDefined } from '../../../../../utils/assertions';
 import { ITEMS_ROUTE_PREFIX, THUMBNAILS_ROUTE_PREFIX } from '../../../../../utils/config';
@@ -78,13 +78,18 @@ const setupActorAndItems = async () => {
       order: i,
     };
   });
+  const appItem = {
+    type: ItemType.APP,
+    name: `secondLevelItemApp`,
+    appSettings: [{ creator: { name: 'bob' }, name: 'app-setting' }],
+  };
   const firstLevelChildren = Array.from({ length: 15 }).map((_val, i) => {
     if (i === 0) {
       return {
         name: `folderItem1`,
         type: ItemType.FOLDER,
         order: i,
-        children: secondLevelChildren,
+        children: [...secondLevelChildren, appItem],
       };
     }
     return {
@@ -118,6 +123,7 @@ const setupActorAndItems = async () => {
     firstLevelFolderItem,
     firstLevelItems,
     secondLevelItems,
+    appItem,
   };
 };
 
@@ -435,6 +441,8 @@ describe('ZIP routes tests', () => {
       const pdfName = 'output.pdf';
       const pdfContent = 'This is a real document.';
       const h5pFilename = 'test-05-collage-54.h5p';
+      const appUrl = 'https://justinjackson.ca/words.html';
+      const appName = 'My App';
 
       // Create the actor and the parent item
       const {
@@ -468,13 +476,15 @@ describe('ZIP routes tests', () => {
         const documentItem = itemsInDB[1];
         const fileItem = itemsInDB[2];
         const h5pItem = itemsInDB[3];
+        const appItem = itemsInDB[4];
 
         // Check that all the items have been imported and that their order is correct
-        expect(itemsInDB.length).toEqual(4);
+        expect(itemsInDB.length).toEqual(5);
         expect(folderItem.type).toEqual(ItemType.FOLDER);
         expect(documentItem.type).toEqual(ItemType.DOCUMENT);
         expect(fileItem.type).toEqual(ItemType.FILE);
         expect(h5pItem.type).toEqual(ItemType.H5P);
+        expect(appItem.type).toEqual(ItemType.APP);
         expect(Number(itemsInDB[1].order)).toBeLessThan(Number(itemsInDB[2].order));
 
         // Check that all the item properties have been assigned for the document type
@@ -495,15 +505,23 @@ describe('ZIP routes tests', () => {
 
         // Check the the file item thumbnail has been imported correctly
         expect(fileItem.settings.hasThumbnail).toBeTruthy();
-
         const thumbnailURLResponse = await app.inject({
           method: HttpMethod.Get,
           url: `${ITEMS_ROUTE_PREFIX}/${fileItem.id}${THUMBNAILS_ROUTE_PREFIX}/${ThumbnailSize.Original}`,
         });
-
         expect(thumbnailURLResponse.statusCode).toBe(StatusCodes.OK);
 
+        // Check the H5P item
         expect(h5pItem.name).toEqual(h5pFilename);
+
+        // Check the APP item
+        expect(appItem.extra[ItemType.APP]).toBeDefined();
+        expect(appItem.extra[ItemType.APP].url).toEqual(appUrl);
+        const appSetting = await db.query.appSettingsTable.findFirst({
+          where: eq(appSettingsTable.itemId, appItem.id),
+        });
+        expect(appSetting).toBeDefined();
+        expect(appSetting!.name).toEqual(appName);
       });
     });
   });
@@ -733,7 +751,8 @@ describe('ZIP routes tests', () => {
     });
 
     it('Graasp export recreates the file structure', async () => {
-      const { actor, folderItem, firstLevelItems, secondLevelItems } = await setupActorAndItems();
+      const { actor, folderItem, firstLevelItems, secondLevelItems, appItem } =
+        await setupActorAndItems();
       assertIsDefined(actor);
       mockAuthenticate(actor);
 
@@ -761,6 +780,11 @@ describe('ZIP routes tests', () => {
         secondLevelItems.map((x) => x.name),
       );
 
+      const foundAppItem = foundSecondLevelChildren?.find((i) => i.type === ItemType.APP);
+      expect(foundAppItem).toBeDefined();
+      expect(foundAppItem!.appSettings).toBeDefined();
+      expect(foundAppItem!.appSettings![0].name).toEqual(appItem.appSettings[0].name);
+
       // delete the folder in which the files were unzipped
       fs.rmSync(targetFolder, { recursive: true });
     });