weseek__growi/packages/app/src/server/service/slack-event-handler/link-shared.ts

import urljoin from 'url-join';
import { format } from 'date-fns';
import {
  MessageAttachment, LinkUnfurls, WebClient,
} from '@slack/web-api';
import { GrowiBotEvent } from '@growi/slack';
import { SlackEventHandler } from './base-event-handler';
import {
  DataForUnfurl, PublicData, UnfurlEventLink, UnfurlRequestEvent,
} from '../../interfaces/slack-integration/link-shared-unfurl';
import loggerFactory from '~/utils/logger';
import { EventActionsPermission } from '~/server/interfaces/slack-integration/events';

const logger = loggerFactory('growi:service:SlackEventHandler:link-shared');

export class LinkSharedEventHandler implements SlackEventHandler<UnfurlRequestEvent> {

  crowi!: any;

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

  shouldHandle(eventType: string, permission: EventActionsPermission, channel: string): boolean {
    if (eventType !== 'link_shared') return false;

    const unfurlPermission = permission.get('unfurl');

    if (!Array.isArray(unfurlPermission)) {
      return unfurlPermission as boolean;
    }

    return unfurlPermission.includes(channel);
  }

  async handleEvent(client: WebClient, growiBotEvent: GrowiBotEvent<UnfurlRequestEvent>, data?: {origin: string}): Promise<void> {
    const { event } = growiBotEvent;
    const origin = data?.origin || this.crowi.appService.getSiteUrl();
    const { channel, message_ts: ts, links } = event;

    let unfurlData: DataForUnfurl[];
    try {
      unfurlData = await this.generateUnfurlsObject(links);
    }
    catch (err) {
      logger.error('Failed to generate unfurl data:', err);
      throw err;
    }

    // unfurl
    const unfurlResults = await Promise.allSettled(unfurlData.map(async(data: DataForUnfurl) => {
      const toUrl = urljoin(origin, data.id);

      let targetUrl;
      if (data.isPermalink) {
        targetUrl = urljoin(origin, data.id);
      }
      else {
        targetUrl = urljoin(origin, data.path);
      }

      let unfurls: LinkUnfurls;

      if (data.isPublic === false) {
        unfurls = {
          [targetUrl]: {
            text: 'Page is not public.',
          },
        };
      }
      else {
        unfurls = this.generateLinkUnfurls(data as PublicData, targetUrl, toUrl);
      }

      await client.chat.unfurl({
        channel,
        ts,
        unfurls,
      });
    }));

    this.logErrorRejectedResults(unfurlResults);
  }

  // builder method for unfurl parameter
  generateLinkUnfurls(body: PublicData, growiTargetUrl: string, toUrl: string): LinkUnfurls {
    const { pageBody: text, updatedAt, commentCount } = body;

    const siteUrl = this.crowi.appService.getSiteUrl();

    const updatedAtFormatted = format(updatedAt, 'yyyy-MM-dd HH:mm');
    const footer = `URL: ${siteUrl}  Updated at: ${updatedAtFormatted}`;

    const attachment: MessageAttachment = {
      title: body.path,
      title_link: toUrl, // permalink
      text,
      footer,
    };

    const unfurls: LinkUnfurls = {
      [growiTargetUrl]: attachment,
    };
    return unfurls;
  }

  async generateUnfurlsObject(links: UnfurlEventLink[]): Promise<DataForUnfurl[]> {
    // generate paths array
    const pathOrIds: string[] = links.map((link) => {
      const { url: growiTargetUrl } = link;
      const urlObject = new URL(growiTargetUrl);

      return decodeURI(urlObject.pathname);
    });

    const idRegExp = /^\/[0-9a-z]{24}$/;
    const paths = pathOrIds.filter(pathOrId => !idRegExp.test(pathOrId));
    const ids = pathOrIds.filter(pathOrId => idRegExp.test(pathOrId)).map(id => id.replace('/', '')); // remove a slash

    // get pages with revision
    const Page = this.crowi.model('Page');
    const { PageQueryBuilder } = Page;

    const pageQueryBuilderByPaths = new PageQueryBuilder(Page.find());
    const pagesByPaths = await pageQueryBuilderByPaths
      .addConditionToListByPathsArray(paths)
      .query
      .populate('revision')
      .lean()
      .exec();

    const pageQueryBuilderByIds = new PageQueryBuilder(Page.find());
    const pagesByIds = await pageQueryBuilderByIds
      .addConditionToListByPageIdsArray(ids)
      .query
      .populate('revision')
      .lean()
      .exec();

    const unfurlDataFromNormalLinks = this.generateDataForUnfurl(pagesByPaths, false);
    const unfurlDataFromPermalinks = this.generateDataForUnfurl(pagesByIds, true);

    return [...unfurlDataFromNormalLinks, ...unfurlDataFromPermalinks];
  }

  // eslint-disable-next-line @typescript-eslint/no-explicit-any
  private generateDataForUnfurl(pages: any, isPermalink: boolean): DataForUnfurl[] {
    const Page = this.crowi.model('Page');
    const unfurlData: DataForUnfurl[] = [];

    pages.forEach((page) => {
      // not send non-public page
      if (page.grant !== Page.GRANT_PUBLIC) {
        return unfurlData.push({
          isPublic: false, isPermalink, id: page._id.toString(), path: page.path,
        });
      }

      // public page
      const { updatedAt, commentCount } = page;
      const { body } = page.revision;
      unfurlData.push({
        isPublic: true, isPermalink, id: page._id.toString(), path: page.path, pageBody: body, updatedAt, commentCount,
      });
    });

    return unfurlData;
  }

  // Promise util method to output rejected results
  private logErrorRejectedResults<T>(results: PromiseSettledResult<T>[]): void {
    const rejectedResults: PromiseRejectedResult[] = results.filter((result): result is PromiseRejectedResult => result.status === 'rejected');

    rejectedResults.forEach((rejected, i) => {
      logger.error(`Error occurred (count: ${i}): `, rejected.reason.toString());
    });
  }

}