Uploaded image for project: 'Minimal Marketable Features'
  1. Minimal Marketable Features
  2. MMF-1766

Detailed feedback for AutoScan failed analyses

    Details

    • Type: MMF
    • Status: In Specification
    • Priority: Major
    • Resolution: Unresolved
    • Labels:

      Description

      Why?

      With MMF-1762 SonarCloud shows visual feedback for ongoing analyses. But when analysis failed, users only get a generic message with little to no explanations about what happened and how to resolve the issue.

      We want users to know what is going on in case of failure, and what to do next.

      What?

      As soon as an AutoScan analysis is failing, I expect SonarCloud to show me relevant feedback. Those errors can be of different types:

      • Functional error. I expect the UI to give me a way to get more details about why it failed and how can I fix the problem
        • Configuration error (Ex: sonar.sources and sonar.tests overlap / encoding issue / exclusions for copy-pasted detection)
          • The UI tells me something is wrong in my sonarcloud.properties file
          • I'm asked to edit it and push it to master again to trigger a new AutoScan analysis
        • Max LoC reached (for organizations under private plan)
          • The UI tells me I reached max LoC in my plan
          • I'm asked to edit my plan in Billing page, or asked to contact org admin if I don't have those rights
          • I'm asked to make a new push on my GitHub repository after this to trigger a new AutoScan analysis

       

      • Technical error. I expect the UI to tell me that something wrong happened, that the analysis could not complete and that I should try again (and at some point tell the user to go ask on Community / Contact form in case the problem still happens). In that case, we expect to have on our side the monitoring of technical errors to be aware of such situations and have actions to fix them.
        • OOM, Timeout (Analysis couldn't complete after 30mn) 
          • The UI tells me the analysis failed because of a technical issue (keep message generic)
          • I'm suggested to change analysis method (use a CI tool or manual analysis for example) or contact us (via SonarSource Community Forum) if the problem persists (Note: we should redirect users to the SonarCloud category with the AutoScan tag preselected https://community.sonarsource.com/tags/c/help/sc/autoscan ideally we should suggest a specific template for those posts)
        • Can't send report to Compute Engine
          • The UI tells me the analysis failed because of a technical issue (keep message generic)
          • I'm suggested to retry later or contact us (via SonarSource Community Forum) if the problem persists
        • Can't clone GitHub repository because it is too large and the cloning exceeds our 30mn timeout
          • The UI tells me the GH repository is too large to be cloned by AutoScan in a reasonable timeframe.
          • I'm suggested to try another analysis method instead: with a CI tool or manually
        • Can't clone GitHub repository because of issues on GitHub side
          • The UI tells me something is wrong on GitHub side
          • I'm asked to retry analysis later by making a new push on my GitHub repository
        • Background task failed
          • The UI tells me analysis failed because of "name of the background task"
          • If I have sufficient rights, I'm suggested to "Learn more" with a link to the Background task page
          • If I don't have rights to see the Background Tasks page, the UI tells me to contact my org Administrator

       

      To be continued

        Attachments

          Activity

            People

            • Assignee:
              laura.wacrenier Laura Wacrenier
              Reporter:
              laura.wacrenier Laura Wacrenier
            • Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

              Dates

              • Created:
                Updated: