صفحهٔ اصلی گشت‌و‌گذار راهنما
ورود
wiki
/
weseek__growi
mirrorاز https://github.com/weseek/growi
2
0
انشعاب 0
پرونده‌ها مشکلات 0 ویکی
فهرست منبع

Merge pull request #4153 from weseek/feat/4836-respond-slack-reviews

Feat/4836 respond slack reviews
Yuki Takei 4 سال پیش
والد
ffb490f8b9 2e17dab5ab
کامیت
e370691f92
7فایلهای تغییر یافته به همراه172 افزوده شده و 48 حذف شده
نمای یکپارچه نمایش آمار تفاوت ها
  1. 2 0
      packages/slack/src/index.ts
  2. 28 0
      packages/slack/src/utils/publish-initial-home-view.ts
  3. 21 0
      packages/slack/src/utils/welcome-message.ts
  4. 61 48
      packages/slackbot-proxy/src/controllers/slack.ts
  5. 21 0
      packages/slackbot-proxy/src/views/install-failed.ejs
  6. 18 0
      packages/slackbot-proxy/src/views/install-succeeded-but-has-problem.ejs
  7. 21 0
      packages/slackbot-proxy/src/views/install-succeeded.ejs

+ 2 - 0
packages/slack/src/index.ts
مشاهده فایل 

@@ -26,7 +26,9 @@ export * from './utils/block-kit-builder';
 
 export * from './utils/check-communicable';
 
 export * from './utils/check-communicable';
 
 export * from './utils/get-supported-growi-actions-regexps';
 
 export * from './utils/get-supported-growi-actions-regexps';
 
 export * from './utils/post-ephemeral-errors';
 
 export * from './utils/post-ephemeral-errors';
 
+export * from './utils/publish-initial-home-view';
 
 export * from './utils/reshape-contents-body';
 
 export * from './utils/reshape-contents-body';
 
 export * from './utils/slash-command-parser';
 
 export * from './utils/slash-command-parser';
 
 export * from './utils/webclient-factory';
 
 export * from './utils/webclient-factory';
 
+export * from './utils/welcome-message';
 
 export * from './utils/required-scopes';
 
 export * from './utils/required-scopes';

+ 28 - 0
packages/slack/src/utils/publish-initial-home-view.ts
مشاهده فایل 

@@ -0,0 +1,28 @@
 
+import { ViewsPublishResponse, WebClient } from '@slack/web-api';
 
+
 
+export const publishInitialHomeView = (client: WebClient, userId: string): Promise<ViewsPublishResponse> => {
 
+  return client.views.publish({
 
+    user_id: userId,
 
+    view: {
 
+      type: 'home',
 
+      blocks: [
 
+        {
 
+          type: 'section',
 
+          text: {
 
+            type: 'mrkdwn',
 
+            text: 'Welcome GROWI Official Bot Home',
 
+          },
 
+        },
 
+        {
 
+          type: 'section',
 
+          text: {
 
+            type: 'mrkdwn',
 
+            text: 'Learn how to use GROWI Official bot.'
 
+            // eslint-disable-next-line max-len
 
+              + 'See <https://docs.growi.org/en/admin-guide/management-cookbook/slack-integration/official-bot-settings.html#official-bot-settings | Docs>.',
 
+          },
 
+        },
 
+      ],
 
+    },
 
+  });
 
+};

+ 21 - 0
packages/slack/src/utils/welcome-message.ts
مشاهده فایل 

@@ -0,0 +1,21 @@
 
+import { ChatPostMessageResponse, WebClient } from '@slack/web-api';
 
+
 
+export const postWelcomeMessage = (client: WebClient, userId: string): Promise<ChatPostMessageResponse> => {
 
+  return client.chat.postMessage({
 
+    channel: userId,
 
+    user: userId,
 
+    blocks: [
 
+      {
 
+        type: 'section',
 
+        text: {
 
+          type: 'mrkdwn',
 
+          text: ':tada: You have successfully installed GROWI Official bot on this Slack workspace.\n'
 
+            + 'At first you do `/growi register` in the channel that you want to use.\n'
 
+            + 'Looking for additional help?'
 
+            // eslint-disable-next-line max-len
 
+            + 'See <https://docs.growi.org/en/admin-guide/management-cookbook/slack-integration/official-bot-settings.html#official-bot-settings | Docs>.',
 
+        },
 
+      },
 
+    ],
 
+  });
 
+};

+ 61 - 48
packages/slackbot-proxy/src/controllers/slack.ts
مشاهده فایل 

@@ -1,14 +1,16 @@
 
 import {
 
 import {
 
-  BodyParams, Controller, Get, Inject, Post, Req, Res, UseBefore,
 
+  BodyParams, Controller, Get, Inject, PlatformResponse, Post, Req, Res, UseBefore,
 
 } from '@tsed/common';
 
 } from '@tsed/common';
 
 
 
 import axios from 'axios';
 
 import axios from 'axios';
 
 
 
 import { WebAPICallResult } from '@slack/web-api';
 
 import { WebAPICallResult } from '@slack/web-api';
 
+import { Installation } from '@slack/oauth';
 
+
 
 
 
 import {
 
 import {
 
   markdownSectionBlock, GrowiCommand, parseSlashCommand, postEphemeralErrors, verifySlackRequest, generateWebClient,
 
   markdownSectionBlock, GrowiCommand, parseSlashCommand, postEphemeralErrors, verifySlackRequest, generateWebClient,
 
-  InvalidGrowiCommandError,
 
+  InvalidGrowiCommandError, requiredScopes, postWelcomeMessage, publishInitialHomeView,
 
 } from '@growi/slack';
 
 } from '@growi/slack';
 
 
 
 import { Relation } from '~/entities/relation';
 
 import { Relation } from '~/entities/relation';
 
@@ -334,57 +336,68 @@ export class SlackCtrl {
 
   }
 
   }
 
 
 
   @Get('/oauth_redirect')
 
   @Get('/oauth_redirect')
 
-  async handleOauthRedirect(@Req() req: Req, @Res() res: Res): Promise<void> {
 
-
 
-    if (req.query.state === '') {
 
-      res.writeHead(500, { 'Content-Type': 'text/html; charset=utf-8' });
 
-      res.end('<html>'
 
-      + '<head><meta name="viewport" content="width=device-width,initial-scale=1"></head>'
 
-      + '<body style="text-align:center; padding-top:20%;">'
 
-      + '<h1>Illegal state, try it again.</h1>'
 
-      + '<a href="/">'
 
-      + 'Go to install page'
 
-      + '</a>'
 
-      + '</body></html>');
 
+  async handleOauthRedirect(@Req() req: Req, @Res() serverRes: Res, @Res() platformRes: PlatformResponse): Promise<void|string> {
 
+
 
+    // create 'Add to Slack' url
 
+    const addToSlackUrl = await this.installerService.installer.generateInstallUrl({
 
+      scopes: requiredScopes,
 
+    });
 
+
 
+    const state = req.query.state;
 
+    if (state == null || state === '') {
 
+      return platformRes.status(400).render('install-failed.ejs', { url: addToSlackUrl });
 
     }
 
     }
 
 
 
-    await this.installerService.installer.handleCallback(req, res, {
 
-      success: (installation, metadata, req, res) => {
 
-        logger.info('Success to install', { installation, metadata });
 
+    // promisify
 
+    const installPromise = new Promise<Installation>((resolve, reject) => {
 
+      this.installerService.installer.handleCallback(req, serverRes, {
 
+        success: async(installation, metadata) => {
 
+          logger.info('Success to install', { installation, metadata });
 
+          resolve(installation);
 
+        },
 
+        failure: async(error) => {
 
+          reject(error); // go to catch block
 
+        },
 
+      });
 
+    });
 
+
 
+    let httpStatus = 200;
 
+    let httpBody;
 
+    try {
 
+      const installation = await installPromise;
 
 
 
+      // check whether bot is not null
 
+      if (installation.bot == null) {
 
+        logger.warn('Success to install but something wrong. `installation.bot` is null.');
 
+        httpStatus = 500;
 
+        httpBody = await platformRes.render('install-succeeded-but-has-problem.ejs', { reason: '`installation.bot` is null' });
 
+      }
 
+      // MAIN PATH: everything is fine
 
+      else {
 
         const appPageUrl = `https://slack.com/apps/${installation.appId}`;
 
         const appPageUrl = `https://slack.com/apps/${installation.appId}`;
 
+        httpBody = await platformRes.render('install-succeeded.ejs', { appPageUrl });
 
 
 
-        res.writeHead(200, { 'Content-Type': 'text/html; charset=utf-8' });
 
-        res.end('<html>'
 
-        + '<head><meta name="viewport" content="width=device-width,initial-scale=1">'
 
-        + '<link href="/bootstrap/css/bootstrap.min.css" rel="stylesheet">'
 
-        + '</head>'
 
-        + '<body style="text-align:center; padding-top:20%;">'
 
-        + '<h1>Congratulations!</h1>'
 
-        + '<p>GROWI Bot installation has succeeded.</p>'
 
-        + '<div class="d-inline-flex flex-column">'
 
-        + `<a class="mb-3" href="${appPageUrl}">`
 
-        + 'Access to Slack App detail page.'
 
-        + '</a>'
 
-        + '<a class="btn btn-outline-success" href="https://docs.growi.org/en/admin-guide/management-cookbook/slack-integration/official-bot-settings.html">'
 
-        + 'Getting started'
 
-        + '</a>'
 
-        + '</div>'
 
-        + '</body></html>');
 
-      },
 
-      failure: (error, installOptions, req, res) => {
 
-        res.writeHead(500, { 'Content-Type': 'text/html; charset=utf-8' });
 
-        res.end('<html>'
 
-        + '<head><meta name="viewport" content="width=device-width,initial-scale=1"></head>'
 
-        + '<body style="text-align:center; padding-top:20%;">'
 
-        + '<h1>GROWI Bot installation failed</h1>'
 
-        + '<p>Please contact administrators of your workspace</p>'
 
-        + 'Reference: <a href="https://slack.com/help/articles/222386767-Manage-app-installation-settings-for-your-workspace">'
 
-        + 'Manage app installation settings for your workspace'
 
-        + '</a>'
 
-        + '</body></html>');
 
-      },
 
-    });
 
+        // generate client
 
+        const client = generateWebClient(installation.bot.token);
 
+
 
+        const userId = installation.user.id;
 
+
 
+        await Promise.all([
 
+          // post message
 
+          postWelcomeMessage(client, userId),
 
+          // publish home
 
+          publishInitialHomeView(client, userId),
 
+        ]);
 
+      }
 
+    }
 
+    catch (error) {
 
+      logger.error(error);
 
+      httpStatus = 500;
 
+      httpBody = await platformRes.status(400).render('install-failed.ejs', { url: addToSlackUrl });
 
+    }
 
+
 
+    platformRes.status(httpStatus);
 
+    return httpBody;
 
   }
 
   }
 
 
 
 }
 
 }

+ 21 - 0
packages/slackbot-proxy/src/views/install-failed.ejs
مشاهده فایل 

@@ -0,0 +1,21 @@
 
+<%- include('commons/head'); %>
 
+
 
+<body>
 
+  <div class="container">
 
+    <div class="row">
 
+      <div class="col text-center">
 
+        <h1 class="my-5">GROWI Bot installation failed..</h1>
 
+        <p>
 
+          Retry from
 
+          <a href=<%- url %>>
 
+            <img alt="Add to Slack" height="40" width="139" src="/images/add-to-slack.png"/>
 
+          </a>
 
+        </p>
 
+        <p>
 
+          Or, please contact administrators of your workspace<br>
 
+          Reference: <a href="https://slack.com/help/articles/222386767-Manage-app-installation-settings-for-your-workspace">Manage app installation settings for your workspace</a>
 
+        </p>
 
+      </div>
 
+    </div>
 
+  </div>
 
+</body>

+ 18 - 0
packages/slackbot-proxy/src/views/install-succeeded-but-has-problem.ejs
مشاهده فایل 

@@ -0,0 +1,18 @@
 
+<%- include('commons/head'); %>
 
+
 
+<body>
 
+  <div class="container">
 
+    <div class="row">
 
+      <div class="col text-center">
 
+        <h1 class="my-5">GROWI Bot installation has succeeded, but something went wrong..</h1>
 
+        <p>
 
+          Reason: <%- reason%>
 
+        </p>
 
+        <p>
 
+          Please contact administrators of your workspace<br>
 
+          Reference: <a href="https://slack.com/help/articles/222386767-Manage-app-installation-settings-for-your-workspace">Manage app installation settings for your workspace</a>
 
+        </p>
 
+      </div>
 
+    </div>
 
+  </div>
 
+</body>

+ 21 - 0
packages/slackbot-proxy/src/views/install-succeeded.ejs
مشاهده فایل 

@@ -0,0 +1,21 @@
 
+<%- include('commons/head'); %>
 
+
 
+<body>
 
+  <div class="container">
 
+    <div class="row">
 
+      <div class="col text-center">
 
+        <h1 class="my-5">Congratulations!</h1>
 
+        <h2 class="my-5">GROWI Bot installation has succeeded!</h2>
 
+        <p>
 
+          Retry from
 
+          <a href=<%- appPageUrl %>>
 
+            Access to Slack App detail page.
 
+          </a>
 
+        </p>
 
+        <p>
 
+          <a class="btn btn-outline-success" href="https://docs.growi.org/en/admin-guide/management-cookbook/slack-integration/official-bot-settings.html">Getting started</a>
 
+        </p>
 
+      </div>
 
+    </div>
 
+  </div>
 
+</body>