Selected Agile Board ID is not referenced from project-sidebar app URL causing confusion when shared

Description

Currently when loading an app hosted using the "Jira Project Sidebar" web item, the user-facing URL does not contain a reference to the currently selected board. If this URL is shared with a colleague, the board which is shown is dependant on which board the recipient last viewed, rather than the one the sender was viewing.

In short, the URL is nondeterministic.

This causes significant confusion with our apps as our data is stored on a per-board basis.

I have reproduced this issue for your convenience in this video: https://youtu.be/VtVINd61cpE

Steps to reproduce:

  1. Load an app using the "Jira Project Sidebar" in the context of a project with at least two boards in two separate tabs of the same browser.

  2. Note that both board referenced in both tabs is the same.

  3. Change the board in the first tab (Jira will reload to the backlog or active sprint with a rapidView parameter).

  4. Refresh the second tab which still contains the app.

  5. Note that the selected board has changed with no change in the URL.

Proposed fix

  1. Add the currently selected board ID to the URL of the "Jira Project Sidebar" web item.

  2. When the app is loaded, pass through the board ID in the URL (if it exists) instead of the board ID in the session.

Environment

Jira Software Cloud

Activity

Show:
Dave Elkan
March 17, 2020, 9:56 PM

We’ve had another support request asking for us to resolve the issue with a lack of canonical URLs for project-centric web-panels. Can we please get this simple issue addressed? Thanks!

Nick Muldoon
April 24, 2020, 12:12 AM

Hi Atlassian,

Possible to get an update on this? It is being flagged as a question from people testing a migration from DC to Cloud.

Thank you,
Nick Muldoon, Easy Agile

Matt Seddon
May 15, 2020, 2:15 AM

We’ve had yet another support request re: this issue.

Tomasz Zasada
September 10, 2020, 9:15 PM
Edited

Hi Dave,
We’ve discussed this issue thoroughly and at this moment we can’t solve it in the way you described, i.e. add dedicated boardId query param to be supported by Jira Project Sidebar - as this Connect module should stay project-specific and should not mix board-specific query params.
But - there’s a quite cool working solution already in Connect that you can implement right away.

You can introduce your own Board dropdown list and feed it with data from this API:
https://developer.atlassian.com/cloud/jira/software/rest/api-group-board/#api-group-board

This would require to ignore {board.id} context parameter and depend on board id that was selected in your own dropdown. Then you can generate your own permalink to share the view by introducing App-specific context parameters:
https://developer.atlassian.com/cloud/jira/software/context-parameters/#app-specific-context-parameters
These parameters are passed down from main product URL to your app iFrame so you can utilize it to pass currently selected boardId in your dropdown.
Other useful methods from AP library that can be helpful in this:
AP.navigator.go();
AP.navigator.reload();
AP.getLocation();

Hope this helps. If you have any more questions, don’t hesitate to ask.
Cheers.

Dave Elkan
October 12, 2020, 5:58 AM

Hi Tomasz,

Sorry that I missed your message. I’ve been off on vacation recently.

I understand that you don’t want to mix project and board parameters, however the solution you have put forward seems like passing the buck to us app developers for short-comings in the Jira ecosystem.

This web item has been around far longer than the new UI where the “project / board” split concept was introduced. It was simply not upgraded or an alternative built when that occurred, leaving us to deal with a substandard solution. You can see the proof of that here from the issue I raised in 2016 when I originally requested the board id be added. A feature which was possible in Server and that we’ve since built a Platinum Atlassian Marketplace Partner business off the back of:

The option of creating a Board-specific web item would be ideal from both a Product and Customer perspective, so why not do that?

I look forward to speaking to you about it in the near future.

Cheers

Dave

Won't Do

Assignee

Unassigned

Reporter

Dave Elkan

Labels

None

Components