[Depfu] Add support for Gitlab

[kris7t]

Fixes #7474

Following the recommendation #7474 (comment) of @chris48s, this PR adds a :vcsType parameter to depfu URLs to select between Github and Gitlab. Badges without a VCS type are redirected to the Github route via a legacy route.

[shields-ci]

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

Generated by 🚫 dangerJS against 607c509

[calebcartwright]

Thanks! Think we could use another test but otherwise LGTM

@chris48s maybe not worth discussing as part of this PR since the route change is both consistent with what we had before as well as other dependency management/update services, but it seems like this class of badge routes are all missing the NOUN portion from our canonical badge url pattern

[chris48s]

Nice. Thanks for having a look at this and providing tests.

[chris48s]

With GitLab we can't just use :user/:repo, repos can be nested in an aribtrary number of nested subgroups e.g:
https://gitlab.com/megabyte-labs/docker/ci-pipeline/ansible-lint so for projects that work with gitlab we would usually make the route something like :vcsType(github|gitlab)/:project+ (which allows an arbitrary number of slashes) and then call https://depfu.com/${vcsType}/shields/${project} assuming depfu inherits that design descension and exposes it in the same way. Do we have an example of this?

[chris48s]

maybe not worth discussing as part of this PR since the route change is both consistent with what we had before as well as other dependency management/update services, but it seems like this class of badge routes are all missing the NOUN portion from our canonical badge url pattern

@calebcartwright I think if we want to change it to /depfu/dependencies/(github|gitlab)/:project+ we might as well do it now in this PR. Then we only need to add one redirect from /depfu/:user/:repo to /depfu/dependencies/github/:project+. If we ship it with /depfu/:vcsType(github|gitlab)/:project+ and then change it in another PR we need another redirect to avoid a BC break. Lets not do that if we don't need to. That said, we're doing the same thing on requires.io and libraries.io so I can see a case for just ignoring it.

[kris7t]

I just created an example project to test this. It might be a bit trickier, because Depfu seems to require urlencoded subgroup separators: https://depfu.com/gitlab/shields/shields-example-group%252Fsubgroup/example-nodejs (replacing %252F with / doesn't work).

I guess the best approach would be to parse the :project+ argument, and replace all but the last / characters with %252F?

[chris48s]

Lets use encodeURIComponent() instead of manually replacing.

For the Gitlab case we can do something like

encodeURIComponent(project.substr(0, project.lastIndexOf('/')))
project.substr(project.lastIndexOf('/'))

We'll also want to make sure project has at least one / in it before doing that, so something like

if (!project.includes('/')) {
  throw InvalidParameter()
}

shields/core/base-service/errors.js

Line 157 in 23c0406

class InvalidParameter extends ShieldsRuntimeError {

For the Github case, we can just pass project as-is

[kris7t]

I updated this PR according to the review comments:

• The endpoint was moved to /depfu/dependencies.
• If there is no / in the project, we throw an InvalidParameter error. I left it with a default message, because I couldn't come up with any specific prettyMessage that wasn't way too long.
• I added the URI encoding regardless the vcsType to simplify logic (it doesn't do anything for Github, but it won't hurt either).
• For testing, I use the example group, subgroup, and repo that I created on my Gitlab account (the test nested repo has to have Depfu enabled, but I couldn't find any existing example repo that was nested in a subgroup).

[chris48s]

Great - thanks for finishing this up 👍 Sorry it took a few days to get back to it