new endpoint: project/<id>/versions

Author: d-beltran

src/docs/description.yml

@@ -1346,6 +1346,62 @@ paths:
                 example: >
                   No example is provided since each analysis is different. Look at the schemas
 
+  /projects/{projectAccessionOrID}/versions:
+    get:
+      summary: Get the versions of all data in a project.
+      description: >
+        Get the versions of the project metadata, every MD metadata and every analysis in a specific $DATABASE project.
+        Versions of all MDs are returned, even if a specific MD is requested.
+        References are not included. Missing versions are returned as null.
+      parameters:
+        - $ref: '#/definitions/arguments/projectAccessionOrID'
+      tags:
+        - projects
+      responses:
+        200:
+          description: an object containing data versions
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  metadata:
+                    type: string
+                    nullable: true
+                    description: Project metadata version
+                  analyses:
+                    type: object
+                    description: Versions of project-wide analyses, by analysis name
+                    additionalProperties:
+                      type: string
+                      nullable: true
+                  mds:
+                    type: array
+                    items:
+                      type: object
+                      properties:
+                        name:
+                          type: string
+                        metadata:
+                          type: string
+                          nullable: true
+                          description: MD metadata version
+                        analyses:
+                          type: object
+                          description: Versions of MD analyses, by analysis name
+                          additionalProperties:
+                            type: string
+                            nullable: true
+              example:
+                metadata: '0.0.7'
+                analyses: {}
+                mds:
+                  - name: replica 1
+                    metadata: null
+                    analyses:
+                      rmsds: '1.0.0'
+                      fluctuation: '0.1.0'
+
   /nodes:
     get:
       summary: Get a list of available nodes.

src/routes/projects/index.js

@@ -260,6 +260,8 @@ localRouter.use('/:project/references', require('./references'));
 localRouter.use('/:project/inputs', require('./inputs'));
 // Topology
 localRouter.use('/:project/topology', require('./topology'));
+// Versions
+localRouter.use('/:project/versions', require('./versions'));
 
 // If we are using the global API then any further query is mapped to the corresponding database
 // Set a handler to be used for both GET and POST methods

src/routes/projects/versions/index.js

@@ -0,0 +1,52 @@
+const Router = require('express').Router;
+// A standard request and response handler used widely in most endpoints
+const handler = require('../../../utils/generic-handler');
+// Get the database handler
+const getDatabase = require('../../../database');
+
+const router = Router({ mergeParams: true });
+
+// Get the versions of all data related to the requested project (references excluded)
+// This includes the project metadata, every MD metadata and every analysis
+router.route('/').get(
+  handler({
+    async retriever(request) {
+      // Stablish database connection and retrieve our custom handler
+      const database = await getDatabase(request);
+      // Get raw project data, which includes all MDs
+      // Note that the MD number in the request (if any) is ignored since we return versions for all MDs
+      const projectData = await database.getRawProjectData(
+        { 'metadata.ver': true, 'mds.name': true, 'mds.ver': true });
+      // If something went wrong then return the error
+      if (projectData.error) return projectData;
+      // Get the version of every analysis, but not the analysis data itself
+      const cursor = await database.analyses.find(
+        { project: projectData._id },
+        { projection: { _id: false, name: true, md: true, 'value.version': true } },
+      );
+      const analyses = await cursor.toArray();
+      // Set the versions of project-wide analyses (i.e. those with no MD)
+      const projectAnalyses = {};
+      // Set the versions of every MD, including its analyses
+      const mds = (projectData.mds || []).map(md => ({
+        name: md.name,
+        metadata: md.ver || null,
+        analyses: {},
+      }));
+      analyses.forEach(analysis => {
+        const version = (analysis.value && analysis.value.version) || null;
+        if (analysis.md === undefined || analysis.md === null)
+          projectAnalyses[analysis.name] = version;
+        // MDs may have been removed while their analyses remain, so make sure the MD exists
+        else if (mds[analysis.md]) mds[analysis.md].analyses[analysis.name] = version;
+      });
+      return {
+        metadata: (projectData.metadata && projectData.metadata.ver) || null,
+        analyses: projectAnalyses,
+        mds,
+      };
+    }
+  }),
+);
+
+module.exports = router;