[MM-62462] Plugin link tooltip for Jira plugin opens takes a very long time to load

[M-ZubairAhmed]

Summary

Changes to adopt with the new plugin link tooltip component for this plugin

Ticket Link

Fixes https://mattermost.atlassian.net/browse/MM-62462

Screenshot

Notes

This is a breaking change and should be included in Mattermost v10.5 thats where mattermost/mattermost#29727 is scheduled to be added

[hanzei]

A couple of questions from my side:

1. Do we also need to update https://github.com/mattermost/mattermost-plugin-github?
2. Given this is a breaking change, do we need to mention it in the changelog?
3. Do we need to cut a new release of the JIRA plugin and repackage it with v10.5?

[hanzei]

Does that mean we query the API on every mouseover?

[M-ZubairAhmed]

Yes, plugins can implement caching on their side to avoid repeated API calls if they want. However, from the webapp performance perspective, this component will get unmounted and remounted.

[hanzei]

Does the JIRA plugin implement such caching? In other words, does the tooltip load as quickly as before the webapp before on the 2nd mouseover?

[M-ZubairAhmed]

It loads depending on the network request resolution. Does that answer your question?

[hanzei]

Not quite. Previously (If I remember correctly), the webapp would only make one network request per link. Is that still the case? I'm concerned about the number of API requests we make to JIRA, which has caused issues in the past.

[M-ZubairAhmed]

There was no caching mechanism in place previously, and that remains the case. The webapp still makes a single request per link. However, the performance improvement from the new implementation — particularly by preventing memory leaks present in the previous approach — far outweighs the impact of this minor change.

[hmhealey]

Testing it on Hub, the current version sort of implicitly caches these because the TicketPopover stays mounted for as long as the user keeps a channel, so it'll only load once per channel switch when the user mouses over a Jira link. The same applies to links on posts in the RHS or Threads view.

If I'm reading the code right, the new logic will make the TicketPopover remount any time the user mouses over and off of a link, so it will make more requests, but I'm not sure how meaningful of a difference that will be unless a user repeatedly does that on purpose. It would be more impactful for keyboard users tabbing over the elements which I'm hesitant to downplay given our focus on accessibility, but I don't know how common that actually is.

Ideally, I think this would be addressed in the Jira plugin by caching it since it's kind of a happy accident that it "cached" data as well as it did before. This is yet another case where loading and caching data effectively is hard.

Overall, I think it's still worth it to make this change to address the side effect of the memory leak despite the potential increase in the number of requests, but I think it'd be good to schedule a followup ticket to improve the caching on the plugin side

[wiggin77]

Ticket created: https://mattermost.atlassian.net/browse/MM-62571

[M-ZubairAhmed]

1. Do we also need to update https://github.com/mattermost/mattermost-plugin-github?

A couple of questions from my side:

1. Do we also need to update https://github.com/mattermost/mattermost-plugin-github?

2. Given this is a breaking change, do we need to mention it in the changelog?

3. Do we need to cut a new release of the JIRA plugin and repackage it with v10.5?

1. That plugin is not effected because it uses the useEffect with correct dependency
2. Yes we need to mention, i mentioned in the webapp changelogs
3. Yes added you to the thread in Staff team

[hanzei]

I'm still not sure if the number of requests to the JIRA plugin changes with this PR or not. Per https://github.com/mattermost/mattermost-plugin-jira/pull/1145/files#r1910298062, I suppose it doesn't.

QA should check that during testing.

[wiggin77]

@M-ZubairAhmed let me know when this is merged so I can create a release and update the prepackaged version in MM.

[wiggin77]

@M-ZubairAhmed the minimum server version will need to be updated in plugin.json