feat: export document item as html (#2063)

* feat: export document item as html

* test: add tests for importing graasp documents

---------

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

Author: pyphilia

src/services/item/plugins/importExport/importExport.controller.test.ts

@@ -432,6 +432,49 @@ describe('ZIP routes tests', () => {
         }
       }, 1000);
     });
+    it('Import and sanitize graasp documents', async () => {
+      const {
+        actor,
+        items: [parentItem],
+      } = await seedFromJson({ items: [{ memberships: [{ account: 'actor' }] }] });
+      assertIsDefined(actor);
+      mockAuthenticate(actor);
+
+      const form = createFormData('documents.zip');
+      const response = await app.inject({
+        method: HttpMethod.Post,
+        url: '/api/items/zip-import',
+        payload: form,
+        headers: form.getHeaders(),
+        query: { parentId: parentItem.id },
+      });
+
+      expect(response.statusCode).toBe(StatusCodes.ACCEPTED);
+
+      await waitForExpect(async () => {
+        const documents = await db.query.itemsRawTable.findMany({
+          where: and(
+            isDescendantOrSelf(itemsRawTable.path, parentItem.path),
+            ne(itemsRawTable.id, parentItem.id),
+            eq(itemsRawTable.type, ItemType.DOCUMENT),
+          ),
+        });
+        expect(documents).toHaveLength(2);
+
+        for (const item of documents) {
+          const content = item.extra[ItemType.DOCUMENT].content;
+
+          // the script with a console should not appear in the text
+          expect(content).not.toContain('script');
+          expect(content).not.toContain('console');
+          expect(content).not.toContain('style');
+
+          // content
+          expect(content).toContain('<h1>My First Heading</h1>');
+          expect(content).toContain(`<p>My first paragraph.</p>`);
+        }
+      }, 1000);
+    });
     it('Throws if signed out', async () => {
       const form = createFormData('archive.zip');
 
@@ -536,7 +579,7 @@ describe('ZIP routes tests', () => {
     });
   });
 
-  describe('POST /api/download-file', () => {
+  describe('GET /api/download-file', () => {
     it('Export successfully if has access', async () => {
       const {
         actor,
@@ -555,7 +598,7 @@ describe('ZIP routes tests', () => {
       mockAuthenticate(actor);
 
       const response = await app.inject({
-        method: HttpMethod.Post,
+        method: HttpMethod.Get,
         url: `/api/items/${item.id}/download-file`,
       });
 
@@ -580,7 +623,7 @@ describe('ZIP routes tests', () => {
       mockAuthenticate(guest);
 
       const response = await app.inject({
-        method: HttpMethod.Post,
+        method: HttpMethod.Get,
         url: `/api/items/${item.id}/download-file`,
       });
 
@@ -603,7 +646,7 @@ describe('ZIP routes tests', () => {
       });
 
       const response = await app.inject({
-        method: HttpMethod.Post,
+        method: HttpMethod.Get,
         url: `/api/items/${item.id}/download-file`,
       });
 
@@ -641,7 +684,7 @@ describe('ZIP routes tests', () => {
       const { id: h5pId, name: h5pName } = h5pUploadResponse.json();
 
       const response = await app.inject({
-        method: HttpMethod.Post,
+        method: HttpMethod.Get,
         url: `/api/items/${h5pId}/download-file`,
       });
 
@@ -651,6 +694,65 @@ describe('ZIP routes tests', () => {
       expect(response.headers['content-disposition']).toContain('.h5p');
       expect(response.headers['content-disposition']).not.toContain('.zip');
     });
+
+    it('Export successfully document item', async () => {
+      const {
+        actor,
+        items: [doc],
+      } = await seedFromJson({
+        items: [
+          {
+            name: 'doc',
+            type: ItemType.DOCUMENT,
+            extra: { document: { content: 'my content in the document', isRaw: true } },
+            memberships: [{ account: 'actor' }],
+          },
+        ],
+      });
+      assertIsDefined(actor);
+      mockAuthenticate(actor);
+
+      const response = await app.inject({
+        method: HttpMethod.Get,
+        url: `/api/items/${doc.id}/download-file`,
+      });
+
+      expect(response.statusCode).toBe(StatusCodes.OK);
+      expect(response.payload.length).toBeGreaterThan(10);
+      expect(response.headers['content-disposition']).toContain(doc.name);
+      expect(response.headers['content-disposition']).toContain('.html');
+      expect(response.headers['content-type']).toContain('text/html');
+    });
+
+    it('Export successfully html document item', async () => {
+      const {
+        actor,
+        items: [doc],
+      } = await seedFromJson({
+        items: [
+          {
+            name: 'doc',
+            type: ItemType.DOCUMENT,
+            extra: { document: { content: 'my html in the document', isRaw: false } },
+            memberships: [{ account: 'actor' }],
+          },
+        ],
+      });
+      assertIsDefined(actor);
+      mockAuthenticate(actor);
+
+      const response = await app.inject({
+        method: HttpMethod.Get,
+        url: `/api/items/${doc.id}/download-file`,
+      });
+
+      expect(response.statusCode).toBe(StatusCodes.OK);
+      expect(response.payload.length).toBeGreaterThan(10);
+      expect(response.headers['content-disposition']).toContain(doc.name);
+      expect(response.headers['content-disposition']).toContain('.html');
+      expect(response.headers['content-type']).toContain('text/html');
+    });
+
     it('Throw for folder', async () => {
       const {
         actor,
@@ -662,7 +764,7 @@ describe('ZIP routes tests', () => {
       mockAuthenticate(actor);
 
       const response = await app.inject({
-        method: HttpMethod.Post,
+        method: HttpMethod.Get,
         url: `/api/items/${item.id}/download-file`,
       });
       expect(response.statusCode).toBe(StatusCodes.BAD_REQUEST);

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

@@ -98,7 +98,7 @@ const plugin: FastifyPluginAsyncTypebox = async (fastify) => {
   );
 
   // export non-folder item as raw file
-  fastify.post(
+  fastify.get(
     '/:itemId/download-file',
     {
       schema: downloadFile,
@@ -132,7 +132,6 @@ const plugin: FastifyPluginAsyncTypebox = async (fastify) => {
 
       // return single file
       const { stream, mimetype, name } = await itemExportService.fetchItemData(db, maybeUser, item);
-
       // allow browser to access content disposition
       reply.header('Access-Control-Expose-Headers', 'Content-Disposition');
       reply.raw.setHeader('Content-Disposition', `attachment; filename="${encodeFilename(name)}"`);

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

@@ -60,7 +60,7 @@ export class ItemExportService {
         return {
           stream: Readable.from([item.extra.document?.content]),
           name: getFilenameFromItem(item),
-          mimetype: item.extra.document.isRaw ? 'text/html' : 'text/plain',
+          mimetype: 'text/html',
         };
       }
       case isItemType(item, ItemType.LINK): {

src/services/item/plugins/importExport/test/fixtures/documents.zip

@@ -162,11 +162,11 @@ describe('File name', () => {
     const item = DocumentItemFactory({
       name: 'mydoc',
     }) as unknown as ItemRaw;
-    expect(getFilenameFromItem(item)).toEqual('mydoc.graasp');
+    expect(getFilenameFromItem(item)).toEqual('mydoc.html');
     const item1 = DocumentItemFactory({
       name: 'mydoc.graasp',
     }) as unknown as ItemRaw;
-    expect(getFilenameFromItem(item1)).toEqual('mydoc.graasp');
+    expect(getFilenameFromItem(item1)).toEqual('mydoc.graasp.html');
   });
   it('get file name from raw document item', () => {
     const item = DocumentItemFactory({

src/services/item/plugins/importExport/utils.spec.ts

@@ -74,10 +74,7 @@ export const getFilenameFromItem = (item: ItemRaw): string => {
       return extractFileName(item.name, 'app');
     }
     case isItemType(item, ItemType.DOCUMENT): {
-      if (item.extra.document.isRaw) {
-        return extractFileName(item.name, 'html');
-      }
-      return extractFileName(item.name, 'graasp');
+      return extractFileName(item.name, 'html');
     }
     case isItemType(item, ItemType.FILE): {
       const mimetype = getMimetype(item.extra);