feat: Github reaction emojis on PR comments #2706

marcusramberg · 2022-11-21T22:02:17Z

what

Adds 👀 reaction to the comment whenever it detects an atlantis command.

I've tested this on a dev instance of Atlantis and it works as expected for my trivial test cases,
but not sure what kind of unit tests you'd like to see for this, so opening it for discussion.
I guess this could also be behind a command line flag, but I'm not sure if that's necessary?

Note that I've stubbed the other VCS providers, as I don't have access to any of them for testing,
I suppose at least bitbucket could support this feature as well tho.

why

Emojis (github reactions) on atlantis command comments like atlantis apply can give us assurance that Atlantis has picked up the job

references

Partially implements Reaction emojis when running atlantis workflows #1084 for Github

nitrocode · 2022-11-21T22:54:39Z

server/controllers/events/events_controller.go

+	body := event.GetComment().GetBody()
+
+	if strings.HasPrefix(body, "atlantis ") {
+		err = e.VCSClient.ReactToComment(baseRepo, *event.Comment.ID, "eyes")


Thank you for the pr.

Please make the emojis configurable from the server config and overwritable in the repo config

Nice feature. The rapid feedback improves the developer experience. I also want to add 🚀 .

It might be better to move react logic in here.

atlantis/server/controllers/events/events_controller.go

Line 574 in 9a38e35

logger.Debug("executing command")

@krrrr38 I would have preferred that as well, but there you don't have access to the event object anymore so I don't see a way to get to the comment id.

nitrocode · 2022-11-21T22:56:43Z

server/events/vcs/github_client.go

@@ -181,6 +181,13 @@ func (g *GithubClient) CreateComment(repo models.Repo, pullNum int, comment stri
 	return nil
 }

+// ReactToComment adds a reaction to a comment.
+func (g *GithubClient) ReactToComment(repo models.Repo, commentID int64, reaction string) error {


Please add tests

nitrocode · 2022-12-05T03:29:12Z

@marcusramberg friendly ping. I'd love to see this in the next release if you have the time 😄 🙏

marcusramberg · 2022-12-05T07:27:03Z

@marcusramberg friendly ping. I'd love to see this in the next release if you have the time 😄 🙏

Got a bit stuck on rewriting the mocks but will try to refocus on completing this PR this week.

nitrocode · 2022-12-22T15:07:34Z

Got a bit stuck on rewriting the mocks but will try to refocus on completing this PR this week.

You mean regenerating the mocks using pegomock?

marcusramberg · 2022-12-23T08:24:19Z

Got a bit stuck on rewriting the mocks but will try to refocus on completing this PR this week.

You mean regenerating the mocks using pegomock?

No, I meant I started a branch to rewrite the mocks using gomock. Regenerating went well but it's a lot of work to rewire the tests to use the gomock apis, I have a WIP branch here main...marcusramberg:atlantis:marcus/new_mock - although it's now already conflicting a lot with latest main :)

nitrocode · 2022-12-23T15:45:58Z

I think the gomock rewrite is noble but can be done in a separate PR. The pegomock should be good enough for this PR, no?

server/controllers/events/events_controller.go

server/core/config/raw/repo_cfg_test.go

github-actions · 2023-03-12T02:03:40Z

This issue is stale because it has been open for 1 month with no activity. Remove stale label or comment or this will be closed in 1 month.

marcusramberg · 2023-04-19T10:45:35Z

Finally got around to write a test for this, sorry for the delay.

GenPage

LGTM, thank you for your contribution

Adds eyes whenever it detects an `atlantis` command.

GenPage · 2023-04-21T14:16:46Z

Rebased to pull in workflow fixes from #3342

GenPage · 2023-04-21T14:19:13Z

@marcusramberg The linter failures might not be all of your changes, but for the sake can you take a pass and see if any apply? Thanks

marcusramberg · 2023-04-21T14:27:05Z

@marcusramberg The linter failures might not be all of your changes, but for the sake can you take a pass and see if any apply? Thanks
That's a lot of linter errors. Seems like there's only one that applies to this PR:

Tbh I'm not sure if I agree with this error since this is a stub function that hopefully should be implemented later for gitlab, but if you feel it should be adressed I can change it to _

The function would look like this then:

GenPage

Thank you for this.

* feat: Basic implementation of github reactions on PRs Adds eyes whenever it detects an `atlantis` command. * feat: Make the emoji reaction configurable * tests: Add a mocked test for EmojiReaction being called in github * ci: Disable revive linter for stubs

marcusramberg requested a review from a team as a code owner November 21, 2022 22:02

marcusramberg force-pushed the emoji_reactions branch from fa81e5a to ea39183 Compare November 21, 2022 22:17

nitrocode reviewed Nov 21, 2022

View reviewed changes

nitrocode added waiting-on-response Waiting for a response from the user waiting-on-review Waiting for a review from a maintainer needs tests Change requires tests labels Nov 24, 2022

nitrocode changed the title ~~Basic implementation of github reactions on PRs~~ feat: Github reaction emojis on PR comments Dec 19, 2022

nitrocode marked this pull request as draft December 22, 2022 22:40

nitrocode added this to the 0.22.1 milestone Dec 23, 2022

marcusramberg force-pushed the emoji_reactions branch from 71ca654 to 244e654 Compare December 24, 2022 11:12

nitrocode reviewed Dec 24, 2022

View reviewed changes

server/controllers/events/events_controller.go Outdated Show resolved Hide resolved

nitrocode reviewed Dec 24, 2022

View reviewed changes

server/core/config/raw/repo_cfg_test.go Outdated Show resolved Hide resolved

marcusramberg force-pushed the emoji_reactions branch 4 times, most recently from 58a0a25 to 5268f5e Compare December 26, 2022 20:06

nitrocode modified the milestones: 0.22.2, 0.22.3, 0.23.0 Jan 6, 2023

nitrocode modified the milestones: v0.23.0, v0.24.0 Jan 21, 2023

github-actions bot added the Stale label Mar 12, 2023

github-actions bot added provider/bitbucket provider/github provider/gitlab labels Apr 19, 2023

marcusramberg force-pushed the emoji_reactions branch 2 times, most recently from 682d86c to 25675c3 Compare April 19, 2023 10:45

marcusramberg requested review from krrrr38 and nitrocode April 19, 2023 11:40

GenPage previously approved these changes Apr 20, 2023

View reviewed changes

marcusramberg added 3 commits April 21, 2023 10:15

feat: Basic implementation of github reactions on PRs

fc817b7

Adds eyes whenever it detects an `atlantis` command.

feat: Make the emoji reaction configurable

86948f9

tests: Add a mocked test for EmojiReaction being called in github

a22a959

GenPage force-pushed the emoji_reactions branch from 25675c3 to a22a959 Compare April 21, 2023 14:15

GenPage enabled auto-merge (squash) April 21, 2023 14:16

ci: Disable revive linter for stubs

5cdda7f

auto-merge was automatically disabled April 23, 2023 18:58
Head branch was pushed to by a user without write access

marcusramberg dismissed GenPage’s stale review via 5cdda7f April 23, 2023 18:58

marcusramberg requested a review from GenPage April 25, 2023 21:00

GenPage enabled auto-merge (squash) April 25, 2023 21:22

GenPage approved these changes Apr 25, 2023

View reviewed changes

GenPage merged commit f8b293a into runatlantis:main Apr 25, 2023

marcusramberg mentioned this pull request Apr 29, 2023

feat(reaction): disable reactions by setting an empty string #3360

Merged

albertorm95 mentioned this pull request May 19, 2023

fix(metrics): add missing stat metric scopes #3416

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Github reaction emojis on PR comments #2706

feat: Github reaction emojis on PR comments #2706

marcusramberg commented Nov 21, 2022 •

edited by nitrocode

Loading

nitrocode Nov 21, 2022

krrrr38 Dec 22, 2022

krrrr38 Dec 22, 2022

marcusramberg Dec 22, 2022

nitrocode Nov 21, 2022

nitrocode commented Dec 5, 2022

marcusramberg commented Dec 5, 2022

nitrocode commented Dec 22, 2022

marcusramberg commented Dec 23, 2022

nitrocode commented Dec 23, 2022

github-actions bot commented Mar 12, 2023

marcusramberg commented Apr 19, 2023

GenPage left a comment

GenPage commented Apr 21, 2023

GenPage commented Apr 21, 2023

marcusramberg commented Apr 21, 2023 •

edited

Loading

GenPage left a comment

feat: Github reaction emojis on PR comments #2706

feat: Github reaction emojis on PR comments #2706

Conversation

marcusramberg commented Nov 21, 2022 • edited by nitrocode Loading

what

why

references

nitrocode Nov 21, 2022

Choose a reason for hiding this comment

krrrr38 Dec 22, 2022

Choose a reason for hiding this comment

krrrr38 Dec 22, 2022

Choose a reason for hiding this comment

marcusramberg Dec 22, 2022

Choose a reason for hiding this comment

nitrocode Nov 21, 2022

Choose a reason for hiding this comment

nitrocode commented Dec 5, 2022

marcusramberg commented Dec 5, 2022

nitrocode commented Dec 22, 2022

marcusramberg commented Dec 23, 2022

nitrocode commented Dec 23, 2022

github-actions bot commented Mar 12, 2023

marcusramberg commented Apr 19, 2023

GenPage left a comment

Choose a reason for hiding this comment

GenPage commented Apr 21, 2023

GenPage commented Apr 21, 2023

marcusramberg commented Apr 21, 2023 • edited Loading

GenPage left a comment

Choose a reason for hiding this comment

marcusramberg commented Nov 21, 2022 •

edited by nitrocode

Loading

marcusramberg commented Apr 21, 2023 •

edited

Loading