[GH-61]: Show code block previews of Gitlab permalinks #299

shivamjosh · 2022-06-02T09:39:36Z

Summary

For every message, we now hook into the MessageWillBePosted event and check
if it contains a permalink to a Gitlab file.

If yes, we parse out the link and make an API call to the Gitlab files API.
Get the file contents and filter out the required lines given in the permalink anchor.

Then we construct a code block in markdown and replace the original string.

Added a config key to gate this feature.

Screenshots:

With config disabled:

After enabling it:

The newly formed hyperlink is a link to the original permalink

Config setting:

Ticket Link

Fixes #61

MI-1840: Show code block previews of Gitlab permalinks

mattermod · 2022-06-02T09:39:40Z

Hello @shivamjosh,

Thanks for your pull request! A Core Committer will review your pull request soon. For code contributions, you can learn more about the review process here.

Per the Mattermost Contribution Guide, we need to add you to the list of approved contributors for the Mattermost project.

Please help complete the Mattermost contribution license agreement?
Once you have signed the CLA, please comment with /check-cla and confirm that the CLA check is green.

This is a standard procedure for many open source projects.

Please let us know if you have any questions.

We are very happy to have you join our growing community! If you're not yet a member, please consider joining our Contributors community channel to meet other contributors and discuss new opportunities with the core team.

…failing CI

codecov · 2022-06-06T13:16:41Z

Codecov Report

Patch coverage: 64.12% and project coverage change: +1.84 🎉

Comparison is base (4a527b4) 31.20% compared to head (9fc71e6) 33.05%.

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #299      +/-   ##
==========================================
+ Coverage   31.20%   33.05%   +1.84%     
==========================================
  Files          21       22       +1     
  Lines        3778     4000     +222     
==========================================
+ Hits         1179     1322     +143     
- Misses       2479     2547      +68     
- Partials      120      131      +11

Impacted Files	Coverage Δ
server/configuration.go	`33.33% <ø> (ø)`
server/main.go	`0.00% <0.00%> (ø)`
server/plugin.go	`14.52% <5.40%> (-0.55%)`	⬇️
server/permalinks.go	`67.92% <67.92%> (ø)`
server/utils.go	`78.02% <87.34%> (+7.14%)`	⬆️

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

mattermod · 2022-06-23T01:01:26Z

This PR has been automatically labelled "stale" because it hasn't had recent activity.
A core team member will check in on the status of the PR to help with questions.
Thank you for your contribution!

…-plugin-gitlab into permalink_preview

levb

Mostly LGTM, with nits.

The big question I have if we should be using MessageHasBeenPosted here instead, to rewrite the post asynchronously.

server/plugin.go

server/permalinks.go

mickmister

Thanks for this @shivamjosh 👍

I have a few requests including one regarding performance, and a few questions.

I also have a request that when there has been prior review on the work, to please link to the existing PR in the new PR's description: Brightscout#4. GitHub isn't allowing me to reply on conversations there so I'm copying this discussion here Brightscout#4 (comment)

Have you checked if there's a difference between Github and Gitlab permalinks or just copied this regex from Github plugin?

I have copied it from Github plugin and then made changes according to the GitLab plugin.

How confident are we that the URL formats between GitHub and GitLab are generally identical?

server/plugin.go

mickmister · 2022-07-13T04:12:37Z

server/utils.go

+// isInsideLink reports whether the given index in a string is preceded
+// by zero or more space, then (, then ].
+//
+// It is a poor man's version of checking markdown hyperlinks without
+// using a full-blown markdown parser. The idea is to quickly confirm
+// whether a permalink is inside a markdown link or not. Something like
+// "text ]( permalink" is rare enough. Even then, it is okay if
+// there are false positives, but there cannot be any false negatives.
+//
+// Note: it is fine to go one byte at a time instead of one rune because
+// we are anyways looking for ASCII chars.
+func isInsideLink(msg string, index int) bool {


Is this implementation or explanation from another source?

Yes, this implementation is taken from the Github plugin.

Can we link to the code here using a GitHub permalink?

server/permalinks.go

mickmister · 2022-07-13T04:36:44Z

server/permalinks.go

+
+// makeReplacements performs the given replacements on the msg and returns
+// the new msg. The replacements slice needs to be sorted by the index in ascending order.
+func (p *Plugin) makeReplacements(msg string, replacements []replacement, glClient *gitlab.Client) string {


Was this code adapted from the GitHub plugin's implementation of this feature?

Can we put a comment linking to the original function using a GitHub permalink?

server/permalinks.go

server/permalinks_test.go

server/plugin.go

…lab into permalink_preview

…ab into permalink_preview

* [MI-1956] Review fixes 1.Removed nested struct 2.Made a global variable for "gitlabPermalinkRegex" 3.Made replacement before interacting with gitlab API 4. Used LogDebug instead of LogError * Run checkstyle 1. Added new line at the end of the file 2. Run check-style * Review Fixes 1.Made requests concurrently * Review Fixes 1. Added New line at the end of file * Review fixes 1.Made requests concurrently * Review fixes 1.Made requests concurrently * Review fixes 1.Made first letter copital of comments 2.Made requests concurrently with proper order * Review Fixes 1.used gofmt and golint * Merge branch 'permalink_preview' of /~https://github.com/Brightscout/mattermost-plugin-gitlab into permalink_preview_fixes * Review fixes 1.Used better name of myMap * Review Fixes 1.Used proper name of myMap * Review fixes 1.Used make check-style * MI-1840: Show code block previews of Github permalinks * MI-1840: Minor fix * MI-1840: Done review fixes * MI-1840: Added unit test for permalink * Fixed lint errors * [MI-1956] Review fixes 1.Removed nested struct 2.Made a global variable for "gitlabPermalinkRegex" 3.Made replacement before interacting with gitlab API 4. Used LogDebug instead of LogError * Run checkstyle 1. Added new line at the end of the file 2. Run check-style * Review Fixes 1.Made requests concurrently * Review Fixes 1. Added New line at the end of file * Review fixes 1.Made requests concurrently * Review fixes 1.Made requests concurrently * Review fixes 1.Made first letter copital of comments 2.Made requests concurrently with proper order * Review Fixes 1.used gofmt and golint * Merge branch 'permalink_preview' of /~https://github.com/Brightscout/mattermost-plugin-gitlab into permalink_preview_fixes * Review fixes 1.Used better name of myMap * Review Fixes 1.Used proper name of myMap * Review fixes 1.Used make check-style * Review Fixes 1.Removed one of the empty line * Review Fixes 1.Revert all changes unrelated to the permalink preview feature. 2.Added checkAndRefreshToken method * Review fixes 1.Changed the name of a function * Unit tests started working * Removed Package-lock.json * [MI-1956] Added Package-lock.json Co-authored-by: raghavaggarwal2308 <raghav.aggarwal@brightscout.com> Co-authored-by: Nityanand Rai <nityanand.rai@brightscout.com>

raghavaggarwal2308 · 2022-08-03T07:32:09Z

@mickmister @levb Fixed the review fixes you mentioned.

server/permalinks.go

levb

LGTM (upon resolving @mickmister's comments)

…-plugin-gitlab into permalink_preview

DHaussermann · 2023-04-26T14:52:22Z

Sorry @raghavaggarwal2308 I missed that this was ready due to the label.

I'll look shortly.

DHaussermann · 2023-04-26T14:52:54Z

/update-branch

mattermost-build · 2023-04-26T14:52:56Z

We don't have permissions to update this PR, please contact the submitter to apply the update.

…ab into permalink_preview

DHaussermann · 2023-05-05T21:21:41Z

@raghavaggarwal2308 I have retested this and this is working as expected. Thank you 👍

I have only 1 small ask. Now that there is a separate piece of functionality involving private repos, the exiting filed no longer affects anything related to private repos.

For this PR - Can you please add some text to the description of the existing filed that will clarify the scope.
(Optional) Allow the plugin to work with private repositories. could be changed to (Optional) Allow the plugin to work with private repositories for subscriptions.

This will add context that the code previews are not covered by the existing switch.

…tting.

raghavaggarwal2308 · 2023-05-07T15:48:02Z

@DHaussermann Updated the description of EnablePrivateRepos

…ab into permalink_preview

hanzei · 2023-05-24T20:39:43Z

@DHaussermann Heads up that the PR is ready for your review.

DHaussermann

Tested and passed

The last point has now been addressed. The label on the exiting radio button has been updated to clarify the scope.

LGTM!

@raghavaggarwal2308 thanks for the effort on this. Sorry it took me so long to circle back.

DHaussermann · 2023-05-25T21:31:50Z

@hanzei I had applied the Do Not Merge label for an unrelated reason. We still have not cut a GitLab release for v1.7.0 which has the oAuth token fix.

I am reluctant to merge new features into master until we get this cut. Do you have any thoughts on this? I'll start a thread in the channel on Community.

mattermost-build · 2023-06-06T01:02:51Z

This PR has been automatically labelled "stale" because it hasn't had recent activity.
A core team member will check in on the status of the PR to help with questions.
Thank you for your contribution!

DHaussermann · 2023-06-19T12:51:30Z

@hanzei I'm okay with including this into 1.7.0 is we can merge is soon and it doesn't add significant delays.

shivamjosh and others added 5 commits May 30, 2022 17:57

MI-1840: Show code block previews of Github permalinks

cd9699f

MI-1840: Minor fix

b9ee4cc

MI-1840: Done review fixes

aafe1a0

MI-1840: Added unit test for permalink

5f49eb4

Merge pull request #4 from Brightscout/MI-1840

080768e

MI-1840: Show code block previews of Gitlab permalinks

shivamjosh requested a review from mickmister as a code owner June 2, 2022 09:39

Added the verbose flag to the npm install command in Makefile to fix …

080bcb1

…failing CI

Fixed lint errors

d02813f

mickmister requested review from catalintomai, DHaussermann and levb June 12, 2022 20:52

mickmister added 2: Dev Review Requires review by a core committer 3: QA Review Requires review by a QA tester labels Jun 12, 2022

mattermod added the Lifecycle/1:stale label Jun 23, 2022

Merge branch 'permalink_preview' of github.com:Brightscout/mattermost…

c50246c

…-plugin-gitlab into permalink_preview

levb suggested changes Jul 5, 2022

View reviewed changes

server/plugin.go Outdated Show resolved Hide resolved

server/plugin.go Show resolved Hide resolved

server/permalinks.go Outdated Show resolved Hide resolved

server/permalinks.go Outdated Show resolved Hide resolved

server/permalinks.go Outdated Show resolved Hide resolved

mickmister suggested changes Jul 13, 2022

View reviewed changes

manojmalik20 and others added 3 commits July 25, 2022 15:05

Merge branch 'master' of github.com:Brightscout/mattermost-plugin-git…

d83d82d

…lab into permalink_preview

Merge branch 'master' of github.com:mattermost/mattermost-plugin-gitl…

c97a8ae

…ab into permalink_preview

raghavaggarwal2308 requested review from mickmister and levb August 3, 2022 07:30

levb reviewed Aug 4, 2022

View reviewed changes

server/permalinks.go Show resolved Hide resolved

levb reviewed Aug 4, 2022

View reviewed changes

raghavaggarwal2308 added 2 commits August 9, 2022 10:57

Merge branch 'permalink_preview' of github.com:Brightscout/mattermost…

3191b77

…-plugin-gitlab into permalink_preview

[MI-2025] Review fixes

dee58ed

DHaussermann added Do Not Merge Should not be merged until this label is removed and removed Awaiting Submitter Action Blocked on the author labels Apr 26, 2023

Merge branch 'master' of github.com:mattermost/mattermost-plugin-gitl…

fcd62c6

…ab into permalink_preview

[mattermostGH-61] Updated description of EnablePrivateRepos config se…

c1cf8f9

…tting.

Merge branch 'master' of github.com:mattermost/mattermost-plugin-gitl…

2170c8d

…ab into permalink_preview

hanzei requested a review from DHaussermann May 16, 2023 21:03

Merge branch 'master' of github.com:mattermost/mattermost-plugin-gitl…

9fc71e6

…ab into permalink_preview

hanzei removed the Do Not Merge Should not be merged until this label is removed label May 24, 2023

DHaussermann approved these changes May 25, 2023

View reviewed changes

DHaussermann added 4: Reviews Complete All reviewers have approved the pull request and removed Lifecycle/1:stale 3: QA Review Requires review by a QA tester labels May 25, 2023

hanzei added the Do Not Merge Should not be merged until this label is removed label May 26, 2023

mattermost-build added the Lifecycle/1:stale label Jun 6, 2023

DHaussermann removed the Do Not Merge Should not be merged until this label is removed label Jun 19, 2023

hanzei removed the Lifecycle/1:stale label Jun 19, 2023

hanzei modified the milestones: v1.8.0, v1.7.0 Jun 19, 2023

hanzei merged commit 842c6b3 into mattermost:master Jun 19, 2023

DHaussermann mentioned this pull request Aug 23, 2023

Included first test for GitLab code preview mattermost/mattermost-test-management#109

Merged

3 tasks

raghavaggarwal2308 deleted the permalink_preview branch April 9, 2024 07:25

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[GH-61]: Show code block previews of Gitlab permalinks #299

[GH-61]: Show code block previews of Gitlab permalinks #299

shivamjosh commented Jun 2, 2022

mattermod commented Jun 2, 2022

codecov bot commented Jun 6, 2022 •

edited

Loading

mattermod commented Jun 23, 2022

levb left a comment

mickmister left a comment •

edited

Loading

mickmister Jul 13, 2022

raghavaggarwal2308 Aug 1, 2022

mickmister Aug 19, 2022

raghavaggarwal2308 Aug 24, 2022

mickmister Jul 13, 2022

raghavaggarwal2308 Jul 27, 2022

mickmister Aug 19, 2022

raghavaggarwal2308 Aug 24, 2022

raghavaggarwal2308 commented Aug 3, 2022

levb left a comment

DHaussermann commented Apr 26, 2023

DHaussermann commented Apr 26, 2023

mattermost-build commented Apr 26, 2023

DHaussermann commented May 5, 2023

raghavaggarwal2308 commented May 7, 2023 •

edited

Loading

hanzei commented May 24, 2023

DHaussermann left a comment

DHaussermann commented May 25, 2023

mattermost-build commented Jun 6, 2023

DHaussermann commented Jun 19, 2023

[GH-61]: Show code block previews of Gitlab permalinks #299

[GH-61]: Show code block previews of Gitlab permalinks #299

Conversation

shivamjosh commented Jun 2, 2022

Summary

Ticket Link

mattermod commented Jun 2, 2022

codecov bot commented Jun 6, 2022 • edited Loading

Codecov Report

mattermod commented Jun 23, 2022

levb left a comment

Choose a reason for hiding this comment

mickmister left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

raghavaggarwal2308 commented Aug 3, 2022

levb left a comment

Choose a reason for hiding this comment

DHaussermann commented Apr 26, 2023

DHaussermann commented Apr 26, 2023

mattermost-build commented Apr 26, 2023

DHaussermann commented May 5, 2023

raghavaggarwal2308 commented May 7, 2023 • edited Loading

hanzei commented May 24, 2023

DHaussermann left a comment

Choose a reason for hiding this comment

DHaussermann commented May 25, 2023

mattermost-build commented Jun 6, 2023

DHaussermann commented Jun 19, 2023

codecov bot commented Jun 6, 2022 •

edited

Loading

mickmister left a comment •

edited

Loading

raghavaggarwal2308 commented May 7, 2023 •

edited

Loading