Refactor [SymfonyInsight] to new service model and rename

[calebcartwright]

Based on some discussion/feedback here, this PR now contains several changes:

• Renames the Sensiolabs badge/service content to SymfonyInsight to reflect the rebranding of that product/service
• Refactors the original service to the new service model (using BaseXmlService)
• Updates the color scheme of the original/initial badge type (SymfonyInsight Grade) to more closely mirror the colors used by the vendor/service provider
• Adds a new badge type (violation counts/summary)
• Adds both mocked and live tests (there were none before) for both the grade & violation badges using the new path symfony/i as well as a couple tests for the old path sensiolabs/i to check for backwards compatibility

Refs #1358

[shields-ci]

	Warnings
⚠️	📚 Remember to ensure any changes to serverSecrets in services/symfony/symfony-test-helpers.js are reflected in the server secrets documentation
⚠️	📚 Remember to ensure any changes to serverSecrets in services/symfony/symfony-insight.service.js are reflected in the server secrets documentation

	Messages
📖	✨ Thanks for your contribution to Shields, @calebcartwright!

Generated by 🚫 dangerJS against b42d572

[paulmelnikow]

Thanks for picking this up :) As far as testing strategy, Wheelmap is a similar case that @PyvesB recently did some work on in #2486. It's a combination of mocked tests and live tests, with live tests that run when a token is available. We created accounts with tokens for prod, CI, and staging.

I forgot that document existed; just opened a PR to bring a couple things up to date.

[calebcartwright]

Excellent, I was just looking through the wheelmap tests and think I can get that working here. I assume that means that the tokens are already set up for Sensiolabs in CI too?

[paulmelnikow]

They are not, though we probably should add one. All the CI tokens are referenced in the CircleCI config. Probably we should also collect these secrets somewhere.

[paulmelnikow]

From the review app:

Are these previews wrong? I feel like the LHS on the first one probably should be grade.

Colors look good!

These example links are both showing not authorized to access project:

• https://shields-staging-pr-2572.herokuapp.com/symfony/i/grade/45afb680-d4e6-4e66-93ea-bcfa79eb8a87.svg
• https://shields-staging-pr-2572.herokuapp.com/symfony/i/violations/45afb680-d4e6-4e66-93ea-bcfa79eb8a87.svg

[calebcartwright]

We can use the tokens I created for building out the tests, although honestly any API/User token will do as those are public analyses/projects

[paulmelnikow]

Do you think we should change the error message when a token is not configured?

[calebcartwright]

Interesting idea. What exactly were you envisioning? Throwing some kind of error when the tokens are missing, or making the request anyway and adding a new/different error messages?

I could see that being helpful for us when looking at staging/prod, and also for any potential self-hosting Shields users that are trying to create badges, especially from their private SymfonyInsight analyses. I definitely think it is worth making a distinction between "oops, you have no tokens" vs. "well you have a token but that token isn't authorized to access project foo"

[paulmelnikow]

Yea, I'm thinking throwing an error when there are no tokens, perhaps a new subclass ImproperlyConfigured.

[calebcartwright]

I really like that idea. Are you good with updating this PR with a throw, and doing the subclass work in a separate stream?

[calebcartwright]

Alright the service will now throw an error (I chose Inaccessible as it seemed the best fit with current error options) when the tokens are missing. This had an interesting impact on the tests. There's now one test that validates the error is thrown when the tokens are missing, but all the other tests need to have auth present.

I've added a review comment on the relevant portions of the test file on that topic

[calebcartwright]

I believe this is ready to merge (barring any final comments/suggestions), but there's now a merge conflict that GH is telling me I don't have access to resolve 🤔

I deleted the sensiolabs.service.js file as part of the refactor & rename, and the service content was moved to symfony related files.

[paulmelnikow]

Have you tried resolving it in the CLI? If you merge master into this branch you should be able to.

Added: I took care of it :)

[shields-deployment]

This pull request was merged to master branch. This change is now waiting for deployment, which will usually happen within a few days. Stay tuned by joining our #ops channel on Discord!

After deployment, changes are copied to gh-pages branch:

[calebcartwright]

Thanks!