Update docs for debugging server plugins #1370

mickmister · 2024-05-21T05:52:02Z

Summary

Old docs
https://developers.mattermost.com/integrate/plugins/developer-workflow/#debug-server-side-plugins-using-delve

New docs
http://mattermost-dev-docs-preview-pulls.s3-website-us-east-1.amazonaws.com/1370/integrate/plugins/developer-workflow/#debug-server-side-plugins-using-delve

This PR updates the section on debugging server-side plugins on the Developer Workflow page. There are some changes due to previously having external libraries checked in a vendor folder, which now exist in Go modules.

The PR includes a script to automate modifying the rpc_client.go file in the go-plugin package, to allow for long pauses from the debugger. Note there is an open PR upstream to implement this into the package hashicorp/go-plugin#101, as well as an issue I had opened for this a while ago hashicorp/go-plugin#248. Patching the library locally for development purposes seems harmless to me. I'm wondering if there's a more appropriate way to do this.

Ticket Link

Fixes #1365

github-actions · 2024-05-21T05:52:31Z

Newest code from mickmister has been published to preview environment for Git SHA 055a148

github-actions · 2024-05-21T05:53:07Z

Newest code from mickmister has been published to preview environment for Git SHA 055a148

mickmister · 2024-05-21T06:23:30Z

If we want to debug the OnActivate function, I think we'll need to run the plugin in attach mode, which allows the plugin to run on its own, and attach itself to the running Mattermost instance. This way, we can attach a debugger to the running plugin before it's interacting with the Mattermost server. This is attach strategy is done in unit testing in other projects https://github.com/mattermost/mattermost-plugin-msteams/blob/fd8798ee2ec005f7de528067d6f1ec863f70ffff/server/helper_test.go#L61

mickmister · 2024-05-21T07:41:18Z

site/content/integrate/plugins/developer-workflow.md

+make attach-headless
+```
+
+This starts a headless `delve` process for your IDE to connect to. The process listens on port `2346`, which is the port defined in our `launch.json` configuration. Somewhat related, the Mattermost server's `Makefile` has a command `debug-server-headless`, which starts a headless `delve` process for the Mattermost server, listening on port `2345`. So you can create a similar `launch.json` configuration in the server directory of the monorepo to connect to your server by using that port.


We should probably check in these launch.json files

Are they just missing? What would be needed to add them?

mickmister · 2024-05-21T07:44:37Z

site/content/integrate/plugins/developer-workflow.md

+
+In the script below, we automatically modify the file located at `${GOPATH}/pkg/mod/github.com/hashicorp/go-plugin@${GO_PLUGIN_PACKAGE_VERSION}/rpc_client.go`, where `GO_PLUGIN_PACKAGE_VERSION` is the version of `go-plugin` that your Mattermost server is using. This can be found in your local copy of the monorepo at [server/go.mod](https://github.com/mattermost/mattermost/blob/4bdd8bb18e47d16f9680905972516526b6fd61d8/server/go.mod#L141).
+
+This script essentially replaces the line in [go-plugin/rpc_client.go](https://github.com/hashicorp/go-plugin/blob/586d14f3dcef1eb42bfb7da4c7af102ec6638668/rpc_client.go#L66) to have a custom configuration for the RPC client connection, that disables the "keep alive" feature. This makes it so the debugger can be paused for long amounts of time, and the Mattermost server will keep the connection with the plugin open.


This section is wordy about describing the script. Also the section should probably contain instructions on how to do this manually, like the previous docs had

github-actions · 2024-05-21T18:40:16Z

Newest code from mickmister has been published to preview environment for Git SHA e763268

github-actions · 2024-06-07T18:46:19Z

Newest code from azigler has been published to preview environment for Git SHA 29bbb9b

azigler

Really fantastic update, @mickmister! 👍 💯 Thanks for taking the time to update this.

azigler · 2024-06-07T18:47:00Z

site/content/integrate/plugins/developer-workflow.md

+make attach-headless
+```
+
+This starts a headless `delve` process for your IDE to connect to. The process listens on port `2346`, which is the port defined in our `launch.json` configuration. Somewhat related, the Mattermost server's `Makefile` has a command `debug-server-headless`, which starts a headless `delve` process for the Mattermost server, listening on port `2345`. So you can create a similar `launch.json` configuration in the server directory of the monorepo to connect to your server by using that port.


Are they just missing? What would be needed to add them?

github-actions · 2024-07-01T18:37:11Z

Newest code from azigler has been published to preview environment for Git SHA 9221588

mickmister · 2024-07-01T22:04:56Z

Are they just missing? What would be needed to add them?

@azigler Yes they need to be added to the repos as .vscode/launch.json files https://learn.microsoft.com/en-us/microsoft-edge/visual-studio-code/microsoft-edge-devtools-extension/launch-json

azigler · 2024-07-02T22:35:40Z

Are they just missing? What would be needed to add them?

@azigler Yes they need to be added to the repos as .vscode/launch.json files https://learn.microsoft.com/en-us/microsoft-edge/visual-studio-code/microsoft-edge-devtools-extension/launch-json

Could we provide an example file inline in this docs PR?

hanzei

Awesome 🚀

github-actions · 2024-07-04T17:17:41Z

Newest code from mickmister has been published to preview environment for Git SHA 2c3a4e1

github-actions · 2024-07-04T17:25:43Z

Newest code from mickmister has been published to preview environment for Git SHA 99dcd1b

mickmister · 2024-07-04T17:31:41Z

Could we provide an example file inline in this docs PR?

@azigler Yeah there's an example launch.json config included in the docs here

mattermost-developer-documentation/site/content/integrate/plugins/developer-workflow.md

Lines 120 to 132 in 2c3a4e1

    
           Include this configuration in your VSCode instance's `launch.json`: 
        
           ```json 
        
           { 
        
               "name": "Attach to Mattermost plugin", 
        
               "type": "go", 
        
               "request": "attach", 
        
               "mode": "remote", 
        
               "port": 2346, 
        
               "host": "127.0.0.1", 
        
               "apiVersion": 2 
        
           } 
        
           ```

github-actions · 2024-07-11T20:28:58Z

Newest code from cwarnermm has been published to preview environment for Git SHA 4fa21ac

github-actions · 2024-07-31T12:24:11Z

Newest code from hanzei has been published to preview environment for Git SHA 4fa21ac

hanzei · 2024-07-31T12:24:12Z

@cwarnermm We got two dev approvals; I think that is enough to hand the PR to you.

github-actions · 2024-07-31T12:24:38Z

Newest code from hanzei has been published to preview environment for Git SHA 4fa21ac

github-actions · 2024-07-31T13:21:29Z

Newest code from cwarnermm has been published to preview environment for Git SHA ad54f9e

cwarnermm

Fantastic dev docs update!

mickmister added 3 commits May 21, 2024 01:24

update docs for debugging server plugins with delve

14dd7c8

add screenshots of vscode

131ea78

add note about editing external code only in development

055a148

mickmister added the 1: Dev Review Requires review by a core commiter label May 21, 2024

mickmister requested review from fmartingr, azigler, hanzei and ayusht2810 May 21, 2024 05:52

mickmister added the preview-environment Allow the preview environment to be generated for Pull Requests coming from fork repositories label May 21, 2024

mickmister commented May 21, 2024

View reviewed changes

clean up

e763268

Merge branch 'master' into debug-server-plugins

29bbb9b

azigler approved these changes Jun 7, 2024

View reviewed changes

Merge branch 'master' into debug-server-plugins

9221588

mickmister requested a review from Kshitij-Katiyar July 2, 2024 05:03

hanzei approved these changes Jul 4, 2024

View reviewed changes

Merge branch 'master' into debug-server-plugins

2c3a4e1

include link to launch.json vscode docs

99dcd1b

Merge branch 'master' into debug-server-plugins

4fa21ac

hanzei requested a review from cwarnermm July 31, 2024 12:23

hanzei self-assigned this Jul 31, 2024

hanzei added the 2: Editor Review Requires review by an editor label Jul 31, 2024

Merge branch 'master' into debug-server-plugins

ad54f9e

cwarnermm approved these changes Jul 31, 2024

View reviewed changes

cwarnermm merged commit 6a57252 into master Jul 31, 2024
5 checks passed

cwarnermm deleted the debug-server-plugins branch July 31, 2024 13:22

hanzei removed their assignment Aug 3, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update docs for debugging server plugins #1370

Update docs for debugging server plugins #1370

mickmister commented May 21, 2024 •

edited

Loading

github-actions bot commented May 21, 2024

github-actions bot commented May 21, 2024

mickmister commented May 21, 2024 •

edited

Loading

mickmister May 21, 2024

azigler Jun 7, 2024

mickmister May 21, 2024

github-actions bot commented May 21, 2024

github-actions bot commented Jun 7, 2024

azigler left a comment

azigler Jun 7, 2024

github-actions bot commented Jul 1, 2024

mickmister commented Jul 1, 2024

azigler commented Jul 2, 2024

hanzei left a comment

github-actions bot commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

mickmister commented Jul 4, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 31, 2024

hanzei commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

cwarnermm left a comment


		In the script below, we automatically modify the file located at `${GOPATH}/pkg/mod/github.com/hashicorp/go-plugin@${GO_PLUGIN_PACKAGE_VERSION}/rpc_client.go`, where `GO_PLUGIN_PACKAGE_VERSION` is the version of `go-plugin` that your Mattermost server is using. This can be found in your local copy of the monorepo at [server/go.mod](https://github.com/mattermost/mattermost/blob/4bdd8bb18e47d16f9680905972516526b6fd61d8/server/go.mod#L141).

		This script essentially replaces the line in [go-plugin/rpc_client.go](https://github.com/hashicorp/go-plugin/blob/586d14f3dcef1eb42bfb7da4c7af102ec6638668/rpc_client.go#L66) to have a custom configuration for the RPC client connection, that disables the "keep alive" feature. This makes it so the debugger can be paused for long amounts of time, and the Mattermost server will keep the connection with the plugin open.

Update docs for debugging server plugins #1370

Update docs for debugging server plugins #1370

Conversation

mickmister commented May 21, 2024 • edited Loading

Summary

Ticket Link

github-actions bot commented May 21, 2024

github-actions bot commented May 21, 2024

mickmister commented May 21, 2024 • edited Loading

mickmister May 21, 2024

Choose a reason for hiding this comment

azigler Jun 7, 2024

Choose a reason for hiding this comment

mickmister May 21, 2024

Choose a reason for hiding this comment

github-actions bot commented May 21, 2024

github-actions bot commented Jun 7, 2024

azigler left a comment

Choose a reason for hiding this comment

azigler Jun 7, 2024

Choose a reason for hiding this comment

github-actions bot commented Jul 1, 2024

mickmister commented Jul 1, 2024

azigler commented Jul 2, 2024

hanzei left a comment

Choose a reason for hiding this comment

github-actions bot commented Jul 4, 2024

github-actions bot commented Jul 4, 2024

mickmister commented Jul 4, 2024

github-actions bot commented Jul 11, 2024

github-actions bot commented Jul 31, 2024

hanzei commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

github-actions bot commented Jul 31, 2024

cwarnermm left a comment

Choose a reason for hiding this comment

mickmister commented May 21, 2024 •

edited

Loading

mickmister commented May 21, 2024 •

edited

Loading