Call endpoint to request submission lock when opening submission to edit

Author: pkalita-lbl

web/src/views/SubmissionPortal/StepperView.vue

@@ -70,9 +70,9 @@ export default defineComponent({
         :name="getSubmissionLockedBy().name"
         :authenticated="true"
       />
-      <a href="/submission/home">
+      <router-link :to="{ name: 'Submission Home'}">
         Return to submission list
-      </a>
+      </router-link>
     </v-alert>
   </div>
 </template>

web/src/views/SubmissionPortal/store/api.ts

@@ -52,6 +52,13 @@ interface PaginatedResponse<T> {
   results: T[];
 }
 
+interface LockOperationResult {
+  success: boolean;
+  message: string
+  locked_by?: User | null;
+  lock_updated?: string | null;
+}
+
 async function createRecord(record: MetadataSubmission) {
   const resp = await client.post<MetadataSubmissionRecord>('metadata_submission', {
     metadata_submission: record,
@@ -83,8 +90,13 @@ async function getRecord(id: string) {
   return resp.data;
 }
 
+async function lockSubmission(id: string) {
+  const resp = await client.put<LockOperationResult>(`metadata_submission/${id}/lock`);
+  return resp.data;
+}
+
 async function unlockSubmission(id: string) {
-  const resp = await client.put<string>(`metadata_submission/${id}/unlock`);
+  const resp = await client.put<LockOperationResult>(`metadata_submission/${id}/unlock`);
   return resp.data;
 }
 
@@ -97,5 +109,6 @@ export {
   getRecord,
   listRecords,
   updateRecord,
+  lockSubmission,
   unlockSubmission,
 };

web/src/views/SubmissionPortal/store/index.ts

@@ -3,6 +3,7 @@ import CompositionApi, {
   computed, reactive, Ref, ref, shallowRef, watch,
 } from '@vue/composition-api';
 import { clone, forEach } from 'lodash';
+import axios from 'axios';
 import * as api from './api';
 import { getVariants, HARMONIZER_TEMPLATES } from '../harmonizerApi';
 import { User } from '@/data/api';
@@ -301,8 +302,22 @@ async function loadRecord(id: string) {
   sampleData.value = val.metadata_submission.sampleData;
   hasChanged.value = 0;
   status.value = isSubmissionStatus(val.status) ? val.status : submissionStatus.InProgress;
-  _submissionLockedBy = val.locked_by;
   _permissionLevel = (val.permission_level as permissionLevelValues);
+
+  try {
+    const lockResponse = await api.lockSubmission(id);
+    _submissionLockedBy = lockResponse.locked_by || null;
+  } catch (error) {
+    if (axios.isAxiosError(error)) {
+      if (error.response && error.response.status === 409) {
+        // Another user has the lock
+        _submissionLockedBy = error.response.data.locked_by || null;
+      }
+    } else {
+      // Something went wrong, and we don't know who has the lock
+      _submissionLockedBy = null;
+    }
+  }
 }
 
 watch(payloadObject, () => { hasChanged.value += 1; }, { deep: true });