feat: add discussion saviour bot as as lambda function #1194

KhudaDad414 · 2022-12-28T18:04:44Z

Description

This lambda function will work as the backend for the bot that we will use in slack to move discussions to GitHub.
Before merging, we should make sure that the following environment variables are in place:

SLACK_TOKEN
GITHUB_TOKEN
DISCUSSION_TARGET_REPO_OWNER
DISCUSSION_TARGET_REPO_NAME

after this PR is merged, we can update its link in slack and everything should be in place.

How it works

this is how a thread can be moved to GitHub:

Select Save to GitHub in the overflow menu of the message:

Fill the title and select the discussion category that it belongs to:

Click on save.
A message will be posted in that thread confirming where the message is preserved.

How it looks

netlify · 2022-12-28T18:04:51Z

✅ Deploy Preview for asyncapi-website ready!

Built without sensitive environment variables

Name	Link
🔨 Latest commit	`c98a5f1`
🔍 Latest deploy log	https://app.netlify.com/sites/asyncapi-website/deploys/64130ec359d7df0009ebd767
😎 Deploy Preview	https://deploy-preview-1194--asyncapi-website.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

github-actions · 2022-12-28T18:12:46Z

⚡️ Lighthouse report for the changes in this PR:

Category	Score
🟠 Performance	61
🟠 Accessibility	88
🟢 Best practices	100
🟢 SEO	100
🔴 PWA	30

Lighthouse ran on https://deploy-preview-1194--asyncapi-website.netlify.app/

magicmatatjahu

Good work! As I see you didn't install the @netlify/functions dependency, so how did you test it 😄?

netlify/functions/save-discussion/index.ts

netlify/functions/save-discussion/GithubReposity.ts

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

KhudaDad414

@magicmatatjahu thanks for the review. I was actually testing it in another repo 😆
👁️ 🙏

netlify/functions/save-discussion/index.ts

KhudaDad414 · 2023-01-17T09:50:07Z

@derberg @magicmatatjahu @akshatnema pinging for visibility.

akshatnema

@KhudaDad414 Can you please add comments for future reference so that everyone can understand the implementation and logic behind code.

Also, will the Save to Github feature be enabled to all users? If yes, the user has to integrate GitHub with Slack in order to save the Slack in a Discussion?

akshatnema · 2023-01-20T18:04:12Z

package.json

  },
  "devDependencies": {
+    "@netlify/functions": "^1.4.0",


Why we add @netlify/functions as a devDependency as we need netlify cli to integrate Netlify functions with frontend?

I have only been using some types from @netlify/functions and it's cli for testing functions. that's why I think it should be in devDependencies.

KhudaDad414 · 2023-02-04T14:49:22Z

@akshatnema Hey mate. I have refactored the code and added comments for clarity. 👀 🙏

will the Save to Github feature be enabled to all users? If yes, the user has to integrate GitHub with Slack in order to save the Slack in a Discussion?

Yes, It will be enabled for all users. And no, users won't need a GitHub with Slack integration for this to work since we will use one of the bot's API keys to access Slack discussions and store them in GitHub.

akshatnema · 2023-02-14T06:07:55Z

Sorry for the delay @KhudaDad414, I was quite on medical leave and just recovered from it in weekend.

Yes, It will be enabled for all users. And no, users won't need a GitHub with Slack integration for this to work since we will use one of the bot's API keys to access Slack discussions and store them in GitHub.

So, if everyone has access, it may happen the someone from the community spam a lot of threads in the GitHub discussions. We in this case should have control over this. And also, our API Key has been used to generate Github discussions, the token may result in rate limit due to excessive use by community members. So, in my opinion, you should have some restrictions on the use of this feature. WDYT? @derberg

KhudaDad414 · 2023-02-14T13:11:39Z

@akshatnema Happy to hear that you have recovered. Welcome back, mate!

KhudaDad414 · 2023-02-14T13:14:34Z

So, if everyone has access, it may happen the someone from the community spam a lot of threads in the GitHub discussions. We in this case should have control over this.

I think the best we can do is improve the message to show the user who saved the discussion and then we can block the bad actors from the Slack community itself.
or as you said limit the users who can use it, maybe TSC members only? would like to know what others think.

the token may result in a rate limit due to excessive use by community members.

I don't think the usage area of this feature is that common. Yes, it can happen but the user has to save around 100 discussions to use 1000 points. which I don't think is that worrisome.

akshatnema · 2023-02-14T13:43:35Z

or as you said limit the users who can use it, maybe TSC members only? would like to know what others think.

I will prefer for having this permission for TSC_Members only because for any thread in Slack, a TSC member can very well judge/decide whether this thread should be saved in discussion or not. Secondly, if a non-TSC member wants to save a thread of Slack, he can surely ask any of the TSC members or Community managers (like @derberg) to add the respective thread on GitHub. This is what I think about the functionality we should have.

derberg · 2023-02-22T18:17:54Z

tbh I do not worry people will spam us because of misuse. We were afraid the same will happen with feedback for on docs, and yeah, nothing bad happened.

I'm more concerned on the limit of free functions invocation, but again, YOLO 😆 , if we will hit the limit, we can think about custom backend on digital ocean 🤷🏼

In github discussion, at the top, in main message we need to indicate where it is coming from, and provide link to slack

btw Khuda you plan to write an article about it, right? RIGHT? 😄

btw nice code, if only not TS 🤣

KhudaDad414 · 2023-02-23T09:53:59Z

In github discussion, at the top, in main message we need to indicate where it is coming from, and provide link to slack

It was there in the first version, 🤦 adding it now.

btw Khuda you plan to write an article about it, right? RIGHT? 😄

right. 😄

btw nice code, if only not TS 🤣

Come on man, don't do whatever you did to Twitter to TS as well. 😆 some of us actually like it. 😄

KhudaDad414 · 2023-02-23T18:31:36Z

@derberg 👁️ 🙏

akshatnema

I wish I could test this on some of my test repos but looks like will not be able to. But yeah, I believe in @KhudaDad414 and hence approving ✔️

KhudaDad414 · 2023-03-15T11:06:42Z

@akshatnema thanks mate.

derberg · 2023-03-15T13:29:32Z

@akshatnema yeah this dude already pushed some not tested changes to CI and I bet he learned to test things now before merging 😆

@KhudaDad414 from Poland with love 😆

btw netlify environment variable is set and ready

KhudaDad414 · 2023-03-15T13:33:15Z

@derberg Those are some big allegations you are making brother. (please don't send any links in this PR, we don't like that. 😆)

KhudaDad414 · 2023-03-16T13:40:58Z

/rtm

feat: add discussion saviour bot as as lambda func

f1627a7

KhudaDad414 requested review from fmvilas, derberg, mcturco, akshatnema, magicmatatjahu and asyncapi-bot-eve as code owners December 28, 2022 18:04

add dependency

93ea49b

final touches

9567a9d

magicmatatjahu reviewed Jan 9, 2023

View reviewed changes

KhudaDad414 and others added 7 commits January 9, 2023 10:37

Update netlify/functions/save-discussion/index.ts

27553af

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

Update netlify/functions/save-discussion/index.ts

122fecc

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

Update netlify/functions/save-discussion/index.ts

728901c

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

Update netlify/functions/save-discussion/index.ts

10e0076

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

refactor the code

a7183c3

Update netlify/functions/save-discussion/GithubReposity.ts

06db4e5

Co-authored-by: Maciej Urbańczyk <urbanczyk.maciej.95@gmail.com>

add a comment

a5da627

KhudaDad414 commented Jan 9, 2023

View reviewed changes

netlify/functions/save-discussion/index.ts Show resolved Hide resolved

KhudaDad414 requested a review from magicmatatjahu January 9, 2023 16:48

Merge branch 'master' into add-bot-lambda

6f6fcb0

Merge branch 'master' into add-bot-lambda

67913ad

akshatnema reviewed Jan 20, 2023

View reviewed changes

KhudaDad414 and others added 2 commits February 4, 2023 14:43

refactor

9d631be

Merge branch 'master' into add-bot-lambda

7e1dc50

KhudaDad414 requested review from akshatnema and removed request for magicmatatjahu February 4, 2023 14:49

Merge branch 'master' into add-bot-lambda

3e62da0

Merge branch 'master' into add-bot-lambda

89a7714

KhudaDad414 mentioned this pull request Feb 21, 2023

store slack memberID of TSC members asyncapi/community#606

Closed

KhudaDad414 and others added 2 commits February 23, 2023 18:21

final touches

b31833c

Merge branch 'master' into add-bot-lambda

1876fab

Merge branch 'master' into add-bot-lambda

8524453

akshatnema approved these changes Mar 15, 2023

View reviewed changes

Merge branch 'master' into add-bot-lambda

a68f96b

Merge branch 'master' into add-bot-lambda

c98a5f1

asyncapi-bot added the ready-to-merge label Mar 16, 2023

asyncapi-bot merged commit 595fb72 into asyncapi:master Mar 16, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: add discussion saviour bot as as lambda function #1194

feat: add discussion saviour bot as as lambda function #1194

KhudaDad414 commented Dec 28, 2022 •

edited

Loading

netlify bot commented Dec 28, 2022 •

edited

Loading

github-actions bot commented Dec 28, 2022 •

edited

Loading

magicmatatjahu left a comment

KhudaDad414 left a comment

KhudaDad414 commented Jan 17, 2023

akshatnema left a comment

akshatnema Jan 20, 2023

KhudaDad414 Feb 4, 2023

KhudaDad414 commented Feb 4, 2023 •

edited

Loading

akshatnema commented Feb 14, 2023

KhudaDad414 commented Feb 14, 2023 •

edited

Loading

KhudaDad414 commented Feb 14, 2023

akshatnema commented Feb 14, 2023

derberg commented Feb 22, 2023

KhudaDad414 commented Feb 23, 2023

KhudaDad414 commented Feb 23, 2023

akshatnema left a comment

KhudaDad414 commented Mar 15, 2023

derberg commented Mar 15, 2023

KhudaDad414 commented Mar 15, 2023

KhudaDad414 commented Mar 16, 2023

feat: add discussion saviour bot as as lambda function #1194

feat: add discussion saviour bot as as lambda function #1194

Conversation

KhudaDad414 commented Dec 28, 2022 • edited Loading

Description

How it works

How it looks

netlify bot commented Dec 28, 2022 • edited Loading

✅ Deploy Preview for asyncapi-website ready!

github-actions bot commented Dec 28, 2022 • edited Loading

magicmatatjahu left a comment

Choose a reason for hiding this comment

KhudaDad414 left a comment

Choose a reason for hiding this comment

KhudaDad414 commented Jan 17, 2023

akshatnema left a comment

Choose a reason for hiding this comment

akshatnema Jan 20, 2023

Choose a reason for hiding this comment

KhudaDad414 Feb 4, 2023

Choose a reason for hiding this comment

KhudaDad414 commented Feb 4, 2023 • edited Loading

akshatnema commented Feb 14, 2023

KhudaDad414 commented Feb 14, 2023 • edited Loading

KhudaDad414 commented Feb 14, 2023

akshatnema commented Feb 14, 2023

derberg commented Feb 22, 2023

KhudaDad414 commented Feb 23, 2023

KhudaDad414 commented Feb 23, 2023

akshatnema left a comment

Choose a reason for hiding this comment

KhudaDad414 commented Mar 15, 2023

derberg commented Mar 15, 2023

KhudaDad414 commented Mar 15, 2023

KhudaDad414 commented Mar 16, 2023

KhudaDad414 commented Dec 28, 2022 •

edited

Loading

netlify bot commented Dec 28, 2022 •

edited

Loading

github-actions bot commented Dec 28, 2022 •

edited

Loading

KhudaDad414 commented Feb 4, 2023 •

edited

Loading

KhudaDad414 commented Feb 14, 2023 •

edited

Loading