automatically end review mode if no active reviewer for 5 minutes

Author: bprize15

src/main/webapp/app/pages/curation/CurationPage.tsx

@@ -49,6 +49,7 @@ export const CurationPage = (props: ICurationPageProps) => {
   const genomicIndicatorsPath = `${firebaseGenePath}/genomic_indicators`;
   const firebaseMetaGeneReviewPath = `${getFirebaseMetaGenePath(isGermline, hugoSymbol)}/review`;
   const firebaseMetaCurrentReviewerPath = `${firebaseMetaGeneReviewPath}/currentReviewer`;
+  const firebaseMetaLastActiveReviewPath = `${firebaseMetaGeneReviewPath}/lastActiveReview`;
 
   useEffect(() => {
     async function checkIfGeneExists() {
@@ -119,6 +120,39 @@ export const CurationPage = (props: ICurationPageProps) => {
     return getTooltipHistoryList(tabHistoryList);
   }, [tabHistoryList]);
 
+  /* eslint-disable no-console */
+  useEffect(() => {
+    async function checkLastActiveReview() {
+      if (
+        props.firebaseDb === undefined ||
+        props.clearCurrentReviwer === undefined ||
+        hugoSymbol === undefined ||
+        isGermline === undefined
+      ) {
+        return;
+      }
+
+      const lastActiveReviewSnapshot = await get(ref(props.firebaseDb, firebaseMetaLastActiveReviewPath));
+      const lastActiveReview: number | undefined = lastActiveReviewSnapshot.val();
+
+      if (lastActiveReview !== undefined && Date.now() - lastActiveReview > 5 * 60 * 1000) {
+        props.clearCurrentReviwer(hugoSymbol, isGermline);
+      }
+    }
+
+    checkLastActiveReview();
+    const interval = setInterval(
+      () => {
+        checkLastActiveReview();
+      },
+      5 * 60 * 1000,
+    );
+
+    return () => {
+      clearTimeout(interval);
+    };
+  }, [props.firebaseDb, firebaseMetaLastActiveReviewPath, hugoSymbol, isGermline, props.clearCurrentReviwer]);
+
   if (!geneIsFound) {
     return <div>the gene &quot;{hugoSymbolParam}&quot; was not found</div>;
   }
@@ -330,6 +364,7 @@ const mapStoreToProps = ({
   layoutStore,
   routerStore,
   curationPageStore,
+  firebaseMetaService,
 }: IRootStore) => ({
   firebaseDb: firebaseAppStore.firebaseDb,
   firebaseInitSuccess: firebaseAppStore.firebaseInitSuccess,
@@ -353,6 +388,7 @@ const mapStoreToProps = ({
   setReadOnly: curationPageStore.setReadOnly,
   isMutationListRendered: curationPageStore.isMutationListRendered,
   setIsMutationListRendered: curationPageStore.setIsMutationListRendered,
+  clearCurrentReviwer: firebaseMetaService.clearCurrentReviewer,
 });
 
 type StoreProps = ReturnType<typeof mapStoreToProps>;

src/main/webapp/app/pages/curation/review/ReviewPage.tsx

@@ -122,6 +122,21 @@ const ReviewPage: React.FunctionComponent<IReviewPageProps> = (props: IReviewPag
     };
   }, [hugoSymbol, isGermline, props.firebaseDb]);
 
+  useEffect(() => {
+    if (hugoSymbol === undefined || isGermline === undefined || props.updateGeneLastActiveReview === undefined) {
+      return;
+    }
+
+    props.updateGeneLastActiveReview?.(hugoSymbol, isGermline);
+    const interval = setInterval(() => {
+      props.updateGeneLastActiveReview?.(hugoSymbol, isGermline);
+    }, 60 * 1000);
+
+    return () => {
+      clearInterval(interval);
+    };
+  }, [hugoSymbol, isGermline]);
+
   const acceptAllChangesFromEditors = async (editors: string[]) => {
     if (hugoSymbol === undefined) {
       notifyError(new SentryError('Cannot accept all changes because hugo symbol is unknown.', { hugoSymbol, geneData }));
@@ -299,7 +314,7 @@ const mapStoreToProps = ({
   loadingGenes: geneStore.loading,
   firebaseInitSuccess: firebaseAppStore.firebaseInitSuccess,
   isGermline: routerStore.isGermline,
-  updateCurrentReviewer: firebaseMetaService.updateGeneCurrentReviewer,
+  updateGeneLastActiveReview: firebaseMetaService.updateGeneLastActiveReview,
 });
 
 type StoreProps = Partial<ReturnType<typeof mapStoreToProps>>;

src/main/webapp/app/service/firebase/firebase-meta-service.ts

@@ -87,6 +87,19 @@ export class FirebaseMetaService {
     });
   };
 
+  updateGeneLastActiveReview = async (hugoSymbol: string, isGermline: boolean) => {
+    await this.firebaseRepository.update(`${getFirebaseMetaGenePath(isGermline, hugoSymbol)}/review`, {
+      lastActiveReview: Date.now(),
+    });
+  };
+
+  clearCurrentReviewer = async (hugoSymbol: string, isGermline: boolean) => {
+    await this.firebaseRepository.update(`${getFirebaseMetaGenePath(isGermline, hugoSymbol)}/review`, {
+      currentReviewer: '',
+      lastActiveReview: null,
+    });
+  };
+
   createMetaGene = async (hugoSymbol: string, isGermline: boolean) => {
     await this.firebaseRepository.create(getFirebaseMetaGenePath(isGermline, hugoSymbol), new Meta());
   };

src/main/webapp/app/shared/model/firebase/firebase.model.ts

@@ -419,7 +419,8 @@ export class Meta {
 
 export class MetaReview {
   currentReviewer = '';
-  [key: string]: string | boolean;
+  lastActiveReview?: number;
+  [key: string]: string | boolean | number | undefined;
 }
 
 export type CommentList = Record<string, Comment>;