Accessibility-insights-web: Issue filing fails for some ADO project configurations

[pownkel]

Describe the bug

When configuring Azure issue filing, the user is given the option to put issue details in either the "description" or "repro steps" field. Depending on which option they choose, filing an issue will create either a Bug or an Issue.

However, some ADO project may be configured to with different work item types. If the user tries to file an issue with a type that does not exist for that project, they will get a "server error" screen.

To Reproduce

1. Create a new ADO project with the process "scrum" (this setting does not include the Issue work item type)
2. Open Accessibility Insights for Web
3. Click the settings gear and scroll down to "Issue filing"
4. Select "Azure boards," enter the URL for the new test project you have created, and select "Description" for the issue details field (normally, this would attempt to create an Issue in that ADO project)
5. Run fastpass and attempt to file a bug for one of the issues
6. The newly opened page will display this error screen:
   

Expected behavior

Issue filing works as expected regardless of the settings of the ADO project

Additional context

This bug was created using details from this Stack Overflow post

[msftbot[bot]]

This issue has been marked as ready for team triage; we will triage it in our weekly review and update the issue. Thank you for contributing to Accessibility Insights!

[pownkel]

This looks useful--ADO provides an API to get available work item types for a given project:
https://docs.microsoft.com/en-us/rest/api/azure/devops/wit/work%20item%20types/list?view=azure-devops-rest-6.0

Maybe we could provide a dropdown list of work item types for the user to choose from?

[ferBonnin]

@pownkel what does the scrum setting in ADO has for issues & bugs tracking by default?

[pownkel]

@pownkel what does the scrum setting in ADO has for issues & bugs tracking by default?

it has the "Bug" type, just not "Issues."

[ferBonnin]

with the bug type, if you choose _Repro steps_ in the dropdown does it still fails?

[ferBonnin]

related to #2920 & #1009

[pownkel]

with the bug type, if you choose _Repro steps_ in the dropdown does it still fails?

It does work with Repro Steps, but it's not immediately clear that that is a solution to the problem

[ferBonnin]

thanks @pownkel!
Last time we received this issue we updated our documentation. could we ask the user if this clarification helps unblock them? I suggestleaving this open to discuss at bug triage if we want to add additional functionality to clarify this in the settings :)

[ferBonnin]

per conversation with Peter, lets add a clarification of what to do if a user receives _server error_ when filing bugs, in the docs > Web > Issue filing (or FAQ) for this. @LiLoDavis can you help us draft this, please?

At this moment we don't believe changes in the extension UI are needed.

[msftbot[bot]]

This issue requires additional investigation by the Accessibility Insights team. When the issue is ready to be triaged again, we will update the issue with the investigation result and add "status: ready for triage". Thank you for contributing to Accessibility Insights!

[LiLoDavis]

@ferBonnin I'll be happy to write this up.

[pownkel]

The user got back to me, and said that using "Repro steps" is failing for them as well. We may need to note that the ADO project must have the Bug or Issue work item type enabled

[ferBonnin]

@pownkel interesting! I see that you ask them what they use to file bugs but would be good to add this in the instructions too @LiLoDavis

[msftbot[bot]]

The team requires additional author feedback; please review their replies and update this issue accordingly. Thank you for contributing to Accessibility Insights!

[ferBonnin]

marking this as needs more info to track the need of knowing how else do teams file bugs/ issues

[LiLoDavis]

@pownkel and @ferBonnin the Web > Issue filing page currently includes the following instructions:

To resolve this problem:

1. In Accessibility Insights, go to Settings > Issue filing > Select a field for issue details, and choose a different option.
2. If the problem persists, make sure the bug or issue work item type is enabled in Azure DevOps.

Is there something else you recommend adding?

[LiLoDavis]

BTW, I've updated only the documentation for web. Is this relevant to Android and Windows, too?

[ferBonnin]

@LiLoDavis yes for Android. unsure on Windows @peterdur?

[peterdur]

@ferBonnin Verified that Windows successfully displays the work item form when doing a File Issue to a Scrum project. It doesn't look like you can disable system work item types.

[LiLoDavis]

@ferBonnin So the changes I made to the Web > Issue filing page also need to be made to the Android > Issue filing page, correct?

[ferBonnin]

yes, please!

[msftbot[bot]]

This issue has been automatically marked as stale because it is marked as requiring author feedback but has not had any activity for 4 days. It will be closed if no further activity occurs within 3 days of this comment. Thank you for contributing to Accessibility Insights!