@zeniai/client-epic-state 5.2.77 → 5.2.79

package/lib/view/taskManager/taskDetailView/epics/fetchTaskDetailEpic.js

@@ -5,19 +5,26 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.fetchTaskDetailEpic = void 0;
 const get_1 = __importDefault(require("lodash/get"));
+const isEqual_1 = __importDefault(require("lodash/isEqual"));
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const snackbarReducer_1 = require("../../../../entity/snackbar/snackbarReducer");
 const tagReducer_1 = require("../../../../entity/tag/tagReducer");
+const taskPayload_1 = require("../../../../entity/task/taskPayload");
 const taskReducer_1 = require("../../../../entity/task/taskReducer");
+const taskSelector_1 = require("../../../../entity/task/taskSelector");
 const responsePayload_1 = require("../../../../responsePayload");
 const fileViewReducer_1 = require("../../../fileView/fileViewReducer");
+const taskDetailLocalData_1 = require("../taskDetailLocalData");
 const taskDetailReducer_1 = require("../taskDetailReducer");
 const fetchTaskDetailEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, operators_1.filter)(taskDetailReducer_1.fetchTaskDetail.match), (0, operators_1.mergeMap)((action) => {
     const { taskId, cacheOverride } = action.payload;
     const taskActions = [];
     const state = state$.value;
     const taskDetail = (0, get_1.default)(state.taskDetailState.editTaskStateById, taskId, undefined);
+    if (cacheOverride === true && (0, taskDetailLocalData_1.isLoadedTaskDetail)(taskDetail)) {
+        return refreshLoadedTaskDetail(taskId, state$, zeniAPI);
+    }
     if (cacheOverride === true) {
         taskActions.push((0, taskDetailReducer_1.removeTaskDetail)(taskId));
     }
@@ -26,7 +33,7 @@ const fetchTaskDetailEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, ope
         taskDetail.fetchTaskStatus.fetchState !== 'In-Progress') {
         taskActions.push((0, taskDetailReducer_1.updateEditTaskFetchStatus)({ taskId, fetchState: 'In-Progress' }));
         const getTaskDetail$ = zeniAPI
-            .getJSON(`${zeniAPI.apiEndPoints.taskMicroServiceBaseUrl}/1.0/task-manager/tasks/${taskId}`)
+            .getJSON(getTaskDetailUrl(zeniAPI, taskId))
             .pipe((0, operators_1.mergeMap)((response) => {
             if ((0, responsePayload_1.isSuccessResponse)(response) && response.data != null) {
                 const fetchActions = [
@@ -44,44 +51,7 @@ const fetchTaskDetailEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, ope
                 }
                 return (0, rxjs_1.from)(fetchActions);
             }
-            else {
-                const fetchActions = [
-                    (0, taskDetailReducer_1.updateEditTaskFetchStatus)({
-                        taskId,
-                        fetchState: 'Error',
-                        error: response.status,
-                    }),
-                ];
-                if (response.status.message.includes('delete')) {
-                    fetchActions.push((0, snackbarReducer_1.openSnackbar)({
-                        messageSection: 'fetch_task_detail',
-                        messageText: 'failed',
-                        type: 'error',
-                        showStatusIcon: true,
-                        variables: [
-                            {
-                                variableName: '_api-error_',
-                                variableValue: 'Cannot retrieve deleted task.',
-                            },
-                        ],
-                    }));
-                }
-                else {
-                    fetchActions.push((0, snackbarReducer_1.openSnackbar)({
-                        messageSection: 'fetch_task_detail',
-                        messageText: 'failed',
-                        type: 'error',
-                        showStatusIcon: true,
-                        variables: [
-                            {
-                                variableName: '_api-error_',
-                                variableValue: response.status.message,
-                            },
-                        ],
-                    }));
-                }
-                return (0, rxjs_1.from)(fetchActions);
-            }
+            return (0, rxjs_1.from)(getFetchFailureActions(taskId, response.status));
         }), (0, operators_1.catchError)((error) => {
             console.error(`REST API call errored out ${error}`);
             return (0, rxjs_1.of)((0, taskDetailReducer_1.updateEditTaskFetchStatus)({
@@ -98,3 +68,74 @@ const fetchTaskDetailEpic = (actions$, state$, zeniAPI) => actions$.pipe((0, ope
     }
 }));
 exports.fetchTaskDetailEpic = fetchTaskDetailEpic;
+const getTaskDetailUrl = (zeniAPI, taskId) => `${zeniAPI.apiEndPoints.taskMicroServiceBaseUrl}/1.0/task-manager/tasks/${taskId}`;
+const getFetchFailureActions = (taskId, status) => [
+    (0, taskDetailReducer_1.updateEditTaskFetchStatus)({ taskId, fetchState: 'Error', error: status }),
+    (0, snackbarReducer_1.openSnackbar)({
+        messageSection: 'fetch_task_detail',
+        messageText: 'failed',
+        type: 'error',
+        showStatusIcon: true,
+        variables: [
+            {
+                variableName: '_api-error_',
+                variableValue: status.message.includes('delete')
+                    ? 'Cannot retrieve deleted task.'
+                    : status.message,
+            },
+        ],
+    }),
+];
+// An unparseable token is never treated as stale, so the refresh still applies.
+const isOlderSyncToken = (candidate, stored) => {
+    const candidateTime = Date.parse(candidate ?? '');
+    const storedTime = Date.parse(stored);
+    return (!Number.isNaN(candidateTime) &&
+        !Number.isNaN(storedTime) &&
+        candidateTime < storedTime);
+};
+const isSaveInProgress = (state, taskId) => state.taskDetailState.editTaskStateById[taskId]?.saveStatus.fetchState ===
+    'In-Progress';
+// Live refresh of an open page: no reset or loading state, unsaved edits kept,
+// skipped during the user's own save, stale responses dropped.
+const refreshLoadedTaskDetail = (taskId, state$, zeniAPI) => {
+    if (isSaveInProgress(state$.value, taskId)) {
+        return rxjs_1.EMPTY;
+    }
+    return zeniAPI
+        .getJSON(getTaskDetailUrl(zeniAPI, taskId))
+        .pipe((0, operators_1.mergeMap)((response) => {
+        if (!(0, responsePayload_1.isSuccessResponse)(response) || response.data == null) {
+            return (0, rxjs_1.from)(getFetchFailureActions(taskId, response.status));
+        }
+        const state = state$.value;
+        const taskPayload = response.data.tasks.find((task) => task.task_id === taskId);
+        const storedTask = (0, taskSelector_1.getTaskById)(state.taskState, taskId);
+        const taskDetail = state.taskDetailState.editTaskStateById[taskId];
+        if (taskPayload == null ||
+            storedTask == null ||
+            taskDetail == null ||
+            isSaveInProgress(state, taskId) ||
+            isOlderSyncToken(taskPayload.sync_token, storedTask.syncToken)) {
+            return rxjs_1.EMPTY;
+        }
+        const refreshedTask = (0, taskPayload_1.mapTaskPayloadToTask)(taskPayload, storedTask);
+        const actions = [
+            (0, taskReducer_1.updateTasks)(response.data.tasks),
+            (0, tagReducer_1.updateTags)(response.data.tasks.map((task) => task.tags).flat()),
+            (0, taskDetailReducer_1.saveTaskUpdatesToLocalStore)({
+                taskId,
+                taskDetailLocalData: (0, taskDetailLocalData_1.rebaseTaskDetailLocalData)(taskDetail.taskDetailLocalData, (0, taskDetailLocalData_1.buildTaskDetailLocalData)(storedTask), (0, taskDetailLocalData_1.buildTaskDetailLocalData)(refreshedTask)),
+            }),
+        ];
+        if (refreshedTask.fileIds.length > 0 &&
+            !(0, isEqual_1.default)(refreshedTask.fileIds, storedTask.fileIds)) {
+            actions.push((0, fileViewReducer_1.fetchFileList)(refreshedTask.fileIds));
+        }
+        return (0, rxjs_1.from)(actions);
+    }), (0, operators_1.catchError)((error) => {
+        // Keep the page on screen; the next update or reload recovers.
+        console.error(`Task detail refresh errored out ${error}`);
+        return rxjs_1.EMPTY;
+    }));
+};

package/lib/view/taskManager/taskDetailView/epics/fetchTaskDetailPageEpic.js

@@ -5,12 +5,20 @@ const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
 const classListReducer_1 = require("../../../classList/classListReducer");
 const userListViewReducer_1 = require("../../../userListView/userListViewReducer");
+const taskDetailLocalData_1 = require("../taskDetailLocalData");
 const taskDetailReducer_1 = require("../taskDetailReducer");
 const fetchTaskDetailPageEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(taskDetailReducer_1.fetchTaskDetailPage.match), (0, operators_1.mergeMap)((action) => {
     const { cacheOverride, taskId } = action.payload;
     const taskDetailActions = [];
     const state = state$.value;
-    if (cacheOverride === true) {
+    if (cacheOverride === true &&
+        taskId != null &&
+        (0, taskDetailLocalData_1.isLoadedTaskDetail)(state.taskDetailState.editTaskStateById[taskId])) {
+        // Only the task changes on a live refresh; the list refetches would show the skeleton.
+        taskDetailActions.push((0, taskDetailReducer_1.fetchTaskDetail)(taskId, true));
+        taskDetailActions.push((0, taskDetailReducer_1.fetchTaskHistory)(taskId, true));
+    }
+    else if (cacheOverride === true) {
         taskDetailActions.push((0, userListViewReducer_1.fetchUserListByType)('taskManagerCandidate', true));
         taskDetailActions.push((0, classListReducer_1.fetchClassList)());
         if (taskId != null) {

package/lib/view/taskManager/taskDetailView/epics/initializeTaskToLocalStoreEpic.js

@@ -7,35 +7,14 @@ exports.initializeTaskToLocalStoreEpic = void 0;
 const get_1 = __importDefault(require("lodash/get"));
 const rxjs_1 = require("rxjs");
 const operators_1 = require("rxjs/operators");
+const taskDetailLocalData_1 = require("../taskDetailLocalData");
 const taskDetailReducer_1 = require("../taskDetailReducer");
 const initializeTaskToLocalStoreEpic = (actions$, state$) => actions$.pipe((0, operators_1.filter)(taskDetailReducer_1.initializeTaskToLocalStore.match), (0, operators_1.mergeMap)((action) => {
     const { taskId } = action.payload;
     const state = state$.value;
     const task = (0, get_1.default)(state.taskState.taskByID, taskId, undefined);
     if (task != null) {
-        const taskDetailLocalData = {
-            name: task.name,
-            description: task.description,
-            status: task.status.code,
-            assignee: task.assignees,
-            groupAssignees: task.groupAssignees,
-            dueDate: task.dueDate,
-            priority: task.priority.code,
-            tagIds: task.tagIds,
-            fileIds: task.fileIds,
-            type: task.type,
-            recurringFrequency: task.recurringFrequency,
-            recurringDaysOfWeek: task.recurringDaysOfWeek,
-            recurringEndDateLocalData: {
-                recurringDatePickerOptionsType: 'date', // by default, date would be selected
-                recurringEndDate: task.recurringEndDate,
-            },
-            savedRecurringEndDate: task.recurringEndDate,
-            recurringStartDate: task.recurringStartDate,
-            timeSpent: task.timeSpent,
-            isPrivate: task.isPrivate,
-            taskGroupId: task.taskGroupIds[0],
-        };
+        const taskDetailLocalData = (0, taskDetailLocalData_1.buildTaskDetailLocalData)(task);
         const actions = [
             (0, taskDetailReducer_1.saveTaskUpdatesToLocalStore)({ taskDetailLocalData, taskId }),
             (0, taskDetailReducer_1.updateEditTaskFetchStatus)({ taskId, fetchState: 'Completed' }),

package/lib/view/taskManager/taskDetailView/taskDetailLocalData.d.ts

@@ -0,0 +1,5 @@
+import { Task } from '../../../entity/task/taskState';
+import { EditTaskDetail, EditTaskLocalData } from './taskDetail';
+export declare const buildTaskDetailLocalData: (task: Task) => EditTaskLocalData;
+export declare const rebaseTaskDetailLocalData: (local: EditTaskLocalData, baseline: EditTaskLocalData, fresh: EditTaskLocalData) => EditTaskLocalData;
+export declare const isLoadedTaskDetail: (taskDetail: EditTaskDetail | undefined) => taskDetail is EditTaskDetail;

package/lib/view/taskManager/taskDetailView/taskDetailLocalData.js

@@ -0,0 +1,45 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.isLoadedTaskDetail = exports.rebaseTaskDetailLocalData = exports.buildTaskDetailLocalData = void 0;
+const isEqual_1 = __importDefault(require("lodash/isEqual"));
+const buildTaskDetailLocalData = (task) => ({
+    name: task.name,
+    description: task.description,
+    status: task.status.code,
+    assignee: task.assignees,
+    groupAssignees: task.groupAssignees,
+    dueDate: task.dueDate,
+    priority: task.priority.code,
+    tagIds: task.tagIds,
+    fileIds: task.fileIds,
+    type: task.type,
+    recurringFrequency: task.recurringFrequency,
+    recurringDaysOfWeek: task.recurringDaysOfWeek,
+    recurringEndDateLocalData: {
+        recurringDatePickerOptionsType: 'date', // by default, date would be selected
+        recurringEndDate: task.recurringEndDate,
+    },
+    savedRecurringEndDate: task.recurringEndDate,
+    recurringStartDate: task.recurringStartDate,
+    timeSpent: task.timeSpent,
+    isPrivate: task.isPrivate,
+    taskGroupId: task.taskGroupIds[0],
+});
+exports.buildTaskDetailLocalData = buildTaskDetailLocalData;
+// Untouched fields (still equal to `baseline`) take the server value; edited ones keep the user's.
+const rebaseTaskDetailLocalData = (local, baseline, fresh) => {
+    const rebased = { ...fresh };
+    const keys = Object.keys({ ...local, ...fresh });
+    keys.forEach((key) => {
+        if (!(0, isEqual_1.default)(local[key], baseline[key])) {
+            Object.assign(rebased, { [key]: local[key] });
+        }
+    });
+    return rebased;
+};
+exports.rebaseTaskDetailLocalData = rebaseTaskDetailLocalData;
+const isLoadedTaskDetail = (taskDetail) => taskDetail?.fetchTaskStatus.fetchState === 'Completed';
+exports.isLoadedTaskDetail = isLoadedTaskDetail;

package/lib/view/taskManager/taskDetailView/taskDetailReducer.js

@@ -11,6 +11,7 @@ const rootActions_1 = require("../../../rootActions");
 const commonHistory_1 = require("../../spendManagement/commonHistoryView/commonHistory");
 const commonHistoryPayload_1 = require("../../spendManagement/commonHistoryView/commonHistoryPayload");
 const taskDetail_1 = require("./taskDetail");
+const taskDetailLocalData_1 = require("./taskDetailLocalData");
 exports.initialState = {
     newTaskState: taskDetail_1.initialTaskDetail,
     editTaskStateById: {},
@@ -30,9 +31,11 @@ const taskDetailView = (0, toolkit_1.createSlice)({
                 const { taskId } = action.payload;
                 if (taskId != null) {
                     const detail = (0, get_1.default)(draft.editTaskStateById, taskId, undefined);
-                    if (action.payload.cacheOverride === true ||
-                        detail == null ||
-                        detail.fetchTaskStatus.fetchState !== 'In-Progress') {
+                    const isRefresh = action.payload.cacheOverride === true && (0, taskDetailLocalData_1.isLoadedTaskDetail)(detail);
+                    if (!isRefresh &&
+                        (action.payload.cacheOverride === true ||
+                            detail == null ||
+                            detail.fetchTaskStatus.fetchState !== 'In-Progress')) {
                         draft.editTaskStateById[taskId] = {
                             ...taskDetail_1.initialTaskDetail,
                         };
@@ -357,6 +360,11 @@ const taskDetailView = (0, toolkit_1.createSlice)({
         fetchSubTasks: {
             reducer(draft, action) {
                 const { parentTaskId } = action.payload;
+                // Only the first load reports In-Progress; it gates the detail page skeleton.
+                if (draft.subTaskListFetchStatusByParentId[parentTaskId]?.fetchState ===
+                    'Completed') {
+                    return;
+                }
                 draft.subTaskListFetchStatusByParentId[parentTaskId] = {
                     fetchState: 'In-Progress',
                     error: undefined,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@zeniai/client-epic-state",
-  "version": "5.2.77",
+  "version": "5.2.79",
   "description": "Shared module between Web & Mobile containing required abstractions for state management, async network communication. ",
   "main": "lib/index.js",
   "module": "lib/esm/index.js",