Merge pull request #334 from makky3939/feature/patch_results_api

Feature/patch results api

Author: ofk

chainerui/server.py

@@ -120,7 +120,7 @@ def output_log(response):
         defaults={'id': None}, view_func=result_resource, methods=['GET'])
     app.add_url_rule(
         '/api/v1/projects/<int:project_id>/results',
-        view_func=result_resource, methods=['POST'])
+        view_func=result_resource, methods=['POST', 'PATCH'])
     app.add_url_rule(
         '/api/v1/projects/<int:project_id>/results/<int:id>',
         view_func=result_resource, methods=['GET', 'PUT', 'DELETE'])

chainerui/views/result.py

@@ -138,6 +138,33 @@ def put(self, id, project_id=None):
 
         return jsonify({'result': result.serialize})
 
+    def patch(self, project_id=None):
+        request_json = request.get_json()
+        request_results = request_json.get('results')
+        responses = []
+
+        for request_item in request_results:
+            id = request_item.get('id', None)
+            if id is None:
+                continue
+
+            result = db.session.query(Result).filter_by(id=id).first()
+            if result is None:
+                continue
+
+            is_unregistered = request_item.get('isUnregistered', None)
+            if is_unregistered is not None:
+                result.is_unregistered = is_unregistered
+
+            db.session.add(result)
+            responses.append({
+                'id': result.id,
+                'is_unregistered': result.is_unregistered,
+            })
+
+        db.session.commit()
+        return jsonify({'results': responses})
+
     def delete(self, id, project_id=None):
         """delete."""
         result = db.session.query(Result).filter_by(id=id).first()

frontend/src/actions/index.js

@@ -72,6 +72,9 @@ export const RESULT_UPDATE_FAILURE = 'RESULT_UPDATE_FAILURE';
 export const RESULT_DELETE_REQUEST = 'RESULT_DELETE_REQUEST';
 export const RESULT_DELETE_SUCCESS = 'RESULT_DELETE_SUCCESS';
 export const RESULT_DELETE_FAILURE = 'RESULT_DELETE_FAILURE';
+export const RESULTS_PATCH_REQUEST = 'RESULTS_PATCH_REQUEST';
+export const RESULTS_PATCH_SUCCESS = 'RESULTS_PATCH_SUCCESS';
+export const RESULTS_PATCH_FAILURE = 'RESULTS_PATCH_FAILURE';
 export const RESULT_LIST_CLEAR = 'RESULT_LIST_CLEAR';
 export const RESULT_ASSET_REQUEST = 'RESULT_ASSET_REQUEST';
 export const RESULT_ASSET_SUCCESS = 'RESULT_ASSET_SUCCESS';
@@ -123,6 +126,17 @@ export const deleteResult = (projectId, resultId) => {
   };
 };
 
+export const patchResults = (projectId, results = []) => {
+  return {
+    [CALL_API]: {
+      types: [RESULTS_PATCH_REQUEST, RESULTS_PATCH_SUCCESS, RESULTS_PATCH_FAILURE],
+      endpoint: `projects/${projectId}/results`,
+      method: 'PATCH',
+      body: { results },
+    },
+  };
+};
+
 export const clearResultList = () => ({
   type: RESULT_LIST_CLEAR,
 });

frontend/src/components/SelectedResultTools.jsx

@@ -10,7 +10,7 @@ const SelectedResultTools = (props) => {
     results,
     resultsStatus,
     resultTypeId,
-    onResultUpdate,
+    onResultsPatch,
     onCheckedOfResultStatusUpdate,
     onTableExpandedUpdate,
   } = props;
@@ -22,20 +22,26 @@ const SelectedResultTools = (props) => {
   const handleDeleteResults = (isUnregistered) => {
     onTableExpandedUpdate(project.id, {});
 
-    Object.keys(resultsStatus).forEach((resultStatusId) => {
+    const targetResultKeys = Object.keys(resultsStatus).filter((resultStatusId) => {
       const result = results[resultStatusId];
       const resultStatus = resultsStatus[resultStatusId];
 
       if (!result) {
-        return;
+        return false;
       }
 
       if (!resultStatus.checked) {
-        return;
+        return false;
       }
 
-      onResultUpdate(project.id, { ...result, isUnregistered });
-      onCheckedOfResultStatusUpdate(project.id, result.id, false);
+      return true;
+    });
+
+    const requestBody = targetResultKeys.map((id) => ({ id, isUnregistered }));
+    onResultsPatch(project.id, requestBody);
+
+    targetResultKeys.forEach((resultKey) => {
+      onCheckedOfResultStatusUpdate(project.id, results[resultKey].id, false);
     });
   };
 
@@ -61,7 +67,7 @@ SelectedResultTools.propTypes = {
   results: uiPropTypes.results.isRequired,
   resultsStatus: uiPropTypes.resultsStatus,
   resultTypeId: PropTypes.string.isRequired,
-  onResultUpdate: PropTypes.func.isRequired,
+  onResultsPatch: PropTypes.func.isRequired,
   onCheckedOfResultStatusUpdate: PropTypes.func.isRequired,
   onTableExpandedUpdate: PropTypes.func.isRequired,
 };

frontend/src/containers/PlotContainer.jsx

@@ -8,6 +8,7 @@ import {
   getProject,
   getResultList,
   updateResult,
+  patchResults,
   clearResultList,
   resetProjectConfig,
   updateLineInAxis,
@@ -150,7 +151,7 @@ class PlotContainer extends React.Component {
                   results={results}
                   resultTypeId={projectConfig.resultType}
                   resultsStatus={projectStatus.resultsStatus}
-                  onResultUpdate={this.props.updateResult}
+                  onResultsPatch={this.props.patchResults}
                   onTableExpandedUpdate={this.props.updateTableExpanded}
                   onCheckedOfResultStatusUpdate={this.props.updateCheckedOfResultStatus}
                 />
@@ -202,6 +203,7 @@ PlotContainer.propTypes = {
   getProject: PropTypes.func.isRequired,
   getResultList: PropTypes.func.isRequired,
   updateResult: PropTypes.func.isRequired,
+  patchResults: PropTypes.func.isRequired,
   clearResultList: PropTypes.func.isRequired,
   createCommand: PropTypes.func.isRequired,
   resetProjectConfig: PropTypes.func.isRequired,
@@ -278,6 +280,7 @@ export default connect(
     getProject,
     getResultList,
     updateResult,
+    patchResults,
     clearResultList,
     createCommand,
     resetProjectConfig,

frontend/src/reducers/index.jsx

@@ -151,6 +151,16 @@ const resultsReducer = (state = {}, action) => {
         return removePartialState(state, result.id);
       }
       return state;
+    case ActionTypes.RESULTS_PATCH_SUCCESS:
+      if (action.response && action.response.results) {
+        const { results } = action.response;
+        let currentState = state;
+        results.forEach((result) => {
+          currentState = removePartialState(currentState, result.id);
+        });
+        return currentState;
+      }
+      return state;
     case ActionTypes.COMMAND_CREATE_SUCCESS:
       if (action.response && action.response.commands) {
         const result = state[action.body.resultId];

tests/test_api.py

@@ -791,3 +791,73 @@ def test_get_assets(func_dir, app):
     assert len(data) == 2
     assert isinstance(data['message'], string_types)
     assert data['asset'] is None
+
+
+# PATCH /api/v1/projects/<int:project_id>/results/
+def test_patch_results(project, app):
+    # simplest case
+    request_json = {
+        "results": [
+            {
+                "id": 1,
+                "isUnregistered": 0
+            },
+            {
+                "id": 2,
+                "isUnregistered": 1
+            }
+        ]
+    }
+    resp = app.patch(
+        '/api/v1/projects/1/results', data=json.dumps(request_json),
+        content_type='application/json')
+    data = assert_json_api(resp)
+    assert len(data) == 1
+    assert 'results' in data
+    assert len(data['results']) == len(request_json["results"])
+
+    # The API will return no response for the part of the request
+    # that id(s) is not given.
+    request_json = {
+        "results": [
+            {
+                "id": 1,
+                "isUnregistered": 0
+            },
+            {
+                "isUnregistered": 1
+            }
+        ]
+    }
+    resp = app.patch(
+        '/api/v1/projects/1/results', data=json.dumps(request_json),
+        content_type='application/json')
+    data = assert_json_api(resp)
+    assert len(data) == 1
+    assert 'results' in data
+    assert len(data['results']) == len(request_json["results"]) - 1
+
+    # The API will return no response for the part of the request
+    # that couldn't find the result on the table by id.
+    request_json = {
+        "results": [
+            {
+                "id": 1,
+                "isUnregistered": 0
+            },
+            {
+                "id": 9999,
+                "isUnregistered": 1
+            }
+        ]
+    }
+    resp = app.patch(
+        '/api/v1/projects/1/results', data=json.dumps(request_json),
+        content_type='application/json')
+    data = assert_json_api(resp)
+    assert len(data) == 1
+    assert 'results' in data
+    assert len(data['results']) == len(request_json["results"]) - 1
+
+    # not raise an exception
+    #   when PATCH /api/v1/projects/12345/results/