weseek__growi/apps/app/src/server/service/page-operation.ts

import { pagePathUtils } from '@growi/core/dist/utils';

import type { IPageOperationProcessInfo, IPageOperationProcessData } from '~/interfaces/page-operation';
import { PageActionType, PageActionStage } from '~/interfaces/page-operation';
import type { PageOperationDocument } from '~/server/models/page-operation';
import PageOperation from '~/server/models/page-operation';
import loggerFactory from '~/utils/logger';

import type Crowi from '../crowi';
import type { ObjectIdLike } from '../interfaces/mongoose-utils';
import { collectAncestorPaths } from '../util/collect-ancestor-paths';

const logger = loggerFactory('growi:services:page-operation');

const {
  isEitherOfPathAreaOverlap, isPathAreaOverlap, isTrashPage,
} = pagePathUtils;
const AUTO_UPDATE_INTERVAL_SEC = 5;

const {
  Create, Update,
  Duplicate, Delete, DeleteCompletely, Revert, NormalizeParent,
} = PageActionType;

class PageOperationService {

  crowi: Crowi;

  constructor(crowi: Crowi) {
    this.crowi = crowi;
  }

  async init(): Promise<void> {
    // cleanup PageOperation documents except ones with { actionType: Rename, actionStage: Sub }
    const types = [Create, Update, Duplicate, Delete, DeleteCompletely, Revert, NormalizeParent];
    await PageOperation.deleteByActionTypes(types);
    await PageOperation.deleteMany({ actionType: PageActionType.Rename, actionStage: PageActionStage.Main });
  }

  /**
   * Execute functions that should be run after the express server is ready.
   */
  async afterExpressServerReady(): Promise<void> {
    try {
      const pageOps = await PageOperation.find({ actionType: PageActionType.Rename, actionStage: PageActionStage.Sub })
        .sort({ createdAt: 'asc' });
      // execute rename operation
      await this.executeAllRenameOperationBySystem(pageOps);
    }
    catch (err) {
      logger.error(err);
    }
  }

  /**
   * Execute renameSubOperation on every page operation for rename ordered by createdAt ASC
   */
  private async executeAllRenameOperationBySystem(pageOps: PageOperationDocument[]): Promise<void> {
    if (pageOps.length === 0) return;

    const Page = this.crowi.model('Page');

    for await (const pageOp of pageOps) {

      const renamedPage = await Page.findById(pageOp.page._id);
      if (renamedPage == null) {
        logger.warn('operating page is not found');
        continue;
      }

      // rename
      await this.crowi.pageService.resumeRenameSubOperation(renamedPage, pageOp);
    }
  }

  /**
   * Check if the operation is operatable
   * @param isRecursively Boolean that determines whether the operation is recursive or not
   * @param fromPathToOp The path to operate from
   * @param toPathToOp The path to operate to
   * @returns boolean
   */
  async canOperate(isRecursively: boolean, fromPathToOp: string | null, toPathToOp: string | null): Promise<boolean> {
    const pageOperations = await PageOperation.find();

    if (pageOperations.length === 0) {
      return true;
    }

    const fromPaths = pageOperations.map(op => op.fromPath).filter((p): p is string => p != null);
    const toPaths = pageOperations.map(op => op.toPath).filter((p): p is string => p != null);

    if (isRecursively) {
      if (fromPathToOp != null && !isTrashPage(fromPathToOp)) {
        const fromFlag = fromPaths.some(p => isEitherOfPathAreaOverlap(p, fromPathToOp));
        if (fromFlag) return false;

        const toFlag = toPaths.some(p => isEitherOfPathAreaOverlap(p, fromPathToOp));
        if (toFlag) return false;
      }

      if (toPathToOp != null && !isTrashPage(toPathToOp)) {
        const fromFlag = fromPaths.some(p => isPathAreaOverlap(p, toPathToOp));
        if (fromFlag) return false;

        const toFlag = toPaths.some(p => isPathAreaOverlap(p, toPathToOp));
        if (toFlag) return false;
      }

    }
    else {
      if (fromPathToOp != null && !isTrashPage(fromPathToOp)) {
        const fromFlag = fromPaths.some(p => isPathAreaOverlap(p, fromPathToOp));
        if (fromFlag) return false;

        const toFlag = toPaths.some(p => isPathAreaOverlap(p, fromPathToOp));
        if (toFlag) return false;
      }

      if (toPathToOp != null && !isTrashPage(toPathToOp)) {
        const fromFlag = fromPaths.some(p => isPathAreaOverlap(p, toPathToOp));
        if (fromFlag) return false;

        const toFlag = toPaths.some(p => isPathAreaOverlap(p, toPathToOp));
        if (toFlag) return false;
      }
    }

    return true;
  }

  /**
   * Generate object that connects page id with processData of PageOperation.
   * The processData is a combination of actionType as a key and information on whether the action is processable as a value.
   */
  generateProcessInfo(pageOps: PageOperationDocument[]): IPageOperationProcessInfo {
    const processInfo: IPageOperationProcessInfo = {};

    pageOps.forEach((pageOp) => {
      const pageId = pageOp.page._id.toString();

      const actionType = pageOp.actionType;
      const isProcessable = pageOp.isProcessable();

      // processData for processInfo
      const mainProcessableInfo = pageOp.actionStage === PageActionStage.Main ? { isProcessable } : undefined;
      const subProcessableInfo = pageOp.actionStage === PageActionStage.Sub ? { isProcessable } : undefined;
      const processData: IPageOperationProcessData = {
        [actionType]: {
          [PageActionStage.Main]: mainProcessableInfo,
          [PageActionStage.Sub]: subProcessableInfo,
        },
      };

      // Merge processData if other processData exist
      if (processInfo[pageId] != null) {
        const otherProcessData = processInfo[pageId];
        processInfo[pageId] = Object.assign(otherProcessData, processData);
        return;
      }
      // add new process data to processInfo
      processInfo[pageId] = processData;
    });

    return processInfo;
  }

  /**
   * Set interval to update unprocessableExpiryDate every AUTO_UPDATE_INTERVAL_SEC seconds.
   * This is used to prevent the same page operation from being processed multiple times at once
   */
  autoUpdateExpiryDate(operationId: ObjectIdLike): NodeJS.Timeout {
    // https://github.com/Microsoft/TypeScript/issues/30128#issuecomment-651877225
    const timerObj = global.setInterval(async() => {
      await PageOperation.extendExpiryDate(operationId);
    }, AUTO_UPDATE_INTERVAL_SEC * 1000);
    return timerObj;
  }

  clearAutoUpdateInterval(timerObj: NodeJS.Timeout): void {
    clearInterval(timerObj);
  }

  /**
   * Get ancestor's paths using fromPath and toPath. Merge same paths if any.
   */
  getAncestorsPathsByFromAndToPath(fromPath: string, toPath: string): string[] {
    const fromAncestorsPaths = collectAncestorPaths(fromPath);
    const toAncestorsPaths = collectAncestorPaths(toPath);
    // merge duplicate paths and return paths of ancestors
    return Array.from(new Set(toAncestorsPaths.concat(fromAncestorsPaths)));
  }

  async getRenameSubOperationByPageId(pageId: ObjectIdLike): Promise<PageOperationDocument | null> {
    const filter = { actionType: PageActionType.Rename, actionStage: PageActionStage.Sub, 'page._id': pageId };
    return PageOperation.findOne(filter);
  }

}

export default PageOperationService;