Merge pull request #331 from hms-dbmi-cellenics/apiv2-processingSettings

[BIOMAGE-1804] Implement load & save processing settings for api v2
hms-dbmi-cellenics · Apr 21, 2022 · c002b90 · c002b90
2 parents 3f0090c + 743aa0c
commit c002b90
Show file tree

Hide file tree

Showing 13 changed files with 1,057 additions and 184 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/src/api.v2/controllers/experimentController.js b/src/api.v2/controllers/experimentController.js
@@ -86,6 +86,22 @@ const updateSamplePosition = async (req, res) => {
   res.json(OK());
 };
 
+const getProcessingConfig = async (req, res) => {
+  const { params: { experimentId } } = req;
+  logger.log('Getting processing config for experiment ', experimentId);
+
+  const result = await new Experiment().getProcessingConfig(experimentId);
+  res.json(result);
+};
+
+const updateProcessingConfig = async (req, res) => {
+  const { params: { experimentId }, body } = req;
+  logger.log('Updating processing config for experiment ', experimentId);
+
+  await new Experiment().updateProcessingConfig(experimentId, body);
+  res.json(OK());
+};
+
 const getBackendStatus = async (req, res) => {
   const { experimentId } = req.params;
 
@@ -114,7 +130,9 @@ module.exports = {
   getAllExperiments,
   getExperiment,
   createExperiment,
+  updateProcessingConfig,
   patchExperiment,
   updateSamplePosition,
+  getProcessingConfig,
   getBackendStatus,
 };
diff --git a/src/api.v2/model/Experiment.js b/src/api.v2/model/Experiment.js
@@ -143,6 +143,25 @@ class Experiment extends BasicModel {
     }
   }
 
+  async getProcessingConfig(experimentId) {
+    const result = await this.findOne({ id: experimentId });
+    if (_.isEmpty(result)) {
+      throw new NotFoundError('Experiment not found');
+    }
+
+    return result.processingConfig;
+  }
+
+  async updateProcessingConfig(experimentId, body) {
+    const { name: stepName, body: change } = body[0];
+    const updateString = JSON.stringify({ [stepName]: change });
+
+    await this.sql(tableNames.EXPERIMENT)
+      .update({
+        processing_config: this.sql.raw(`processing_config || '${updateString}'::jsonb`),
+      }).where('id', experimentId);
+  }
+
   async addSample(experimentId, sampleId) {
     await this.sql(tableNames.EXPERIMENT)
       .update({

diff --git a/src/api.v2/model/__mocks__/Experiment.js b/src/api.v2/model/__mocks__/Experiment.js
@@ -4,6 +4,8 @@ const stub = {
   getAllExperiments: jest.fn(),
   getExperimentData: jest.fn(),
   updateSamplePosition: jest.fn(),
+  updateProcessingConfig: jest.fn(),
+  getProcessingConfig: jest.fn(),
   addSample: jest.fn(),
   deleteSample: jest.fn(),
   ...BasicModel,

diff --git a/src/api.v2/routes/experiment.js b/src/api.v2/routes/experiment.js
@@ -1,6 +1,6 @@
 const {
-  createExperiment, getExperiment, patchExperiment, getAllExperiments,
-  updateSamplePosition, getBackendStatus,
+  createExperiment, getExperiment, patchExperiment, updateSamplePosition,
+  getAllExperiments, getProcessingConfig, updateProcessingConfig, getBackendStatus,
 } = require('../controllers/experimentController');
 
 const { expressAuthenticationOnlyMiddleware, expressAuthorizationMiddleware } = require('../middlewares/authMiddlewares');
@@ -26,6 +26,14 @@ module.exports = {
     expressAuthorizationMiddleware,
     (req, res, next) => updateSamplePosition(req, res).catch(next),
   ],
+  'experiment#getProcessingConfig': [
+    expressAuthorizationMiddleware,
+    (req, res, next) => getProcessingConfig(req, res).catch(next),
+  ],
+  'experiment#updateProcessingConfig': [
+    expressAuthorizationMiddleware,
+    (req, res, next) => updateProcessingConfig(req, res).catch(next),
+  ],
   'experiment#getBackendStatus': [
     expressAuthorizationMiddleware,
     (req, res, next) => getBackendStatus(req, res).catch(next),

diff --git a/src/specs/api.v2.yaml b/src/specs/api.v2.yaml
@@ -58,6 +58,71 @@ paths:
                   - env
                   - clusterEnv
       description: Returns a status on the health of the API.
+  '/experiments/{experimentId}/processingConfig':
+    get:
+      summary: Get processing configuration for an experiment
+      description: Get processing configuration for an experiment
+      operationId: getProcessingConfig
+      x-eov-operation-id: experiment#getProcessingConfig
+      x-eov-operation-handler: routes/experiment
+      responses:
+        '200':
+          description: get processing configuration for an experiment
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProcessingConfig'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPError'        
+        '401':
+          description: The request lacks authentication credentials.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPError'        
+        '404':
+          description: Not found error.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPError'
+
+    put:
+      summary: Update processing configuration for an experiment
+      description: Update processing configuration for an experiment
+      operationId: updateProcessingConfig
+      x-eov-operation-id: experiment#updateProcessingConfig
+      x-eov-operation-handler: routes/experiment
+      responses:
+        '200':
+          description: Processing configuration for an experiment
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPSuccess'
+        '400':
+          description: Bad Request
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPError'
+        '401':
+          description: The request lacks authentication credentials.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPError'
+        '404':
+          description: Not found error.
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/HTTPError'
+
   '/experiments':
     get:
       summary: Get all experiments
@@ -417,6 +482,7 @@ paths:
             application/json:
               schema:
                 $ref: '#/components/schemas/HTTPError'
+
 components:
   schemas:
     CreateExperiment:
@@ -425,6 +491,8 @@ components:
       $ref: './models/experiment-bodies/ExperimentInfo.v2.yaml'
     PatchExperiment:
       $ref: './models/experiment-bodies/PatchExperiment.v2.yaml'
+    ProcessingConfig:
+      $ref: './models/experiment-bodies/ProcessingConfig.v2.yaml'
     GetAllExperiments:
       $ref: './models/experiment-bodies/GetAllExperiments.v2.yaml'
     CreateSample:

diff --git a/src/specs/models/experiment-bodies/ProcessingConfig.v2.yaml b/src/specs/models/experiment-bodies/ProcessingConfig.v2.yaml
@@ -25,4 +25,4 @@ required:
   - numGenesVsNumUmis
   - doubletScores
   - dataIntegration
-  - configureEmbedding
+  - configureEmbedding
diff --git a/tests/api.v2/controllers/experimentController.test.js b/tests/api.v2/controllers/experimentController.test.js
@@ -177,6 +177,38 @@ describe('experimentController', () => {
     expect(experimentInstance.updateSamplePosition).not.toHaveBeenCalled();
   });
 
+  it('getProcessingConfig works', async () => {
+    const mockReq = {
+      params: {
+        experimentId: mockExperiment.id,
+      },
+    };
+    experimentInstance.getProcessingConfig.mockImplementationOnce(() => Promise.resolve());
+
+    await experimentController.getProcessingConfig(mockReq, mockRes);
+    expect(experimentInstance.getProcessingConfig).toHaveBeenCalledWith(mockExperiment.id);
+  });
+
+  it('updateProcessingConfig works', async () => {
+    const mockReq = {
+      params: {
+        experimentId: mockExperiment.id,
+      },
+      body: [{
+        name: 'classifier',
+        body: {
+          someChangedField: 'a value',
+        },
+      }],
+    };
+    experimentInstance.updateProcessingConfig.mockImplementationOnce(() => Promise.resolve());
+
+    await experimentController.updateProcessingConfig(mockReq, mockRes);
+    expect(experimentInstance.updateProcessingConfig).toHaveBeenCalledWith(
+      mockExperiment.id, mockReq.body,
+    );
+  });
+
   it('getBackendStatus works correctly', async () => {
     getPipelineStatus
       .mockImplementationOnce(() => Promise.resolve('gem2sStatus'))