a few more tests

Signed-off-by: Steve Cassidy <steve.cassidy@mq.edu.au>

.mocharc.json

@@ -4,5 +4,6 @@
     "require": [
         "ts-node/register"
     ],
-    "recursive": true
+    "recursive": true,
+    "timeout": 10000
 }

src/api/routes.ts

@@ -187,7 +187,7 @@ api.get(
   requireAuthenticationAPI,
   async (req, res) => {
     if (req.user && userHasPermission(req.user, req.params.id, 'read')) {
-      res.setHeader('Content-Type', 'text/csv');
+      res.setHeader('Content-Type', 'application/zip');
       streamNotebookFilesAsZip(req.params.id, req.params.viewid, res);
     } else {
       res.json({error: 'notebook not found'});

src/couchdb/notebooks.ts

@@ -683,6 +683,7 @@ export const streamNotebookFilesAsZip = async (
   res: NodeJS.WritableStream
 ) => {
   let allFilesAdded = false;
+  let doneFinalize = false;
   const iterator = await notebookRecordIterator(project_id, viewID);
   const archive = archiver('zip', {zlib: {level: 9}});
   // good practice to catch warnings (ie stat failures and other non-blocking errors)
@@ -703,8 +704,10 @@ export const streamNotebookFilesAsZip = async (
   // check on progress, if we've finished adding files and they are
   // all processed then we can finalize the archive
   archive.on('progress', (entries: any) => {
-    if (allFilesAdded && entries.total === entries.processed) {
+    if (!doneFinalize && allFilesAdded && entries.total === entries.processed) {
+      console.log('finalizing archive');
       archive.finalize();
+      doneFinalize = true;
     }
   });
 

test/api.test.ts

@@ -335,6 +335,23 @@ describe('API tests', () => {
     }
   });
 
+  it('can download files as zip', async () => {
+    // pull in some test data
+    await restoreFromBackup('test/backup.jsonl');
+
+    const adminUser = await getUserFromEmailOrUsername('admin');
+    if (adminUser) {
+      const notebooks = await getNotebooks(adminUser);
+      expect(notebooks).to.have.lengthOf(2);
+
+      await request(app)
+        .get('/api/notebooks/1693291182736-campus-survey-demo/FORM2.zip')
+        .set('Authorization', `Bearer ${adminToken}`)
+        .expect(200)
+        .expect('Content-Type', 'application/zip');
+    }
+  });
+
   if (DEVELOPER_MODE) {
     it('create random record', async () => {
       const nb1 = await createNotebook('NB1', uispec, {});

test/backup.test.ts

@@ -19,7 +19,11 @@
  */
 import PouchDB from 'pouchdb';
 import {restoreFromBackup} from '../src/couchdb/backupRestore';
-import {getNotebooks, notebookRecordIterator} from '../src/couchdb/notebooks';
+import {
+  getNotebookRecords,
+  getNotebooks,
+  notebookRecordIterator,
+} from '../src/couchdb/notebooks';
 import {registerClient} from 'faims3-datamodel';
 import {getUserFromEmailOrUsername} from '../src/couchdb/users';
 PouchDB.plugin(require('pouchdb-adapter-memory')); // enable memory adapter for testing
@@ -58,6 +62,12 @@ describe('Backup and restore', () => {
         ({record, done} = await iterator.next());
       }
       expect(count).to.equal(17);
+
+      // throw in a test of getNotebookRecords while we're here
+      const records = await getNotebookRecords(
+        notebooks[0].non_unique_project_id
+      );
+      expect(records).to.have.lengthOf(28);
     }
   });
 });

test/couchdb.test.ts

@@ -33,6 +33,7 @@ import {
   getNotebookUISpec,
   getRolesForNotebook,
   updateNotebook,
+  validateNotebookID,
 } from '../src/couchdb/notebooks';
 import * as fs from 'fs';
 import {
@@ -187,6 +188,24 @@ describe('notebook api', () => {
     }
   });
 
+  it('can validate a notebook id', async () => {
+    const jsonText = fs.readFileSync(
+      './notebooks/sample_notebook.json',
+      'utf-8'
+    );
+    const {metadata, 'ui-specification': uiSpec} = JSON.parse(jsonText);
+    const name = 'Test Notebook';
+    const projectID = await createNotebook(name, uiSpec, metadata);
+    expect(projectID).not.to.equal(undefined);
+    if (projectID) {
+      const valid = await validateNotebookID(projectID);
+      expect(valid).to.be.true;
+
+      const invalid = await validateNotebookID('invalid');
+      expect(invalid).to.be.false;
+    }
+  });
+
   it('getNotebookUISpec', async () => {
     await initialiseDatabases();