Add routeEnum with validation and enhance error handling in BaseService [Twitter Gem TeamCity Packagist MozillaObservatory HexPm Greasyfork] by jNullj · Pull Request #11800 · badges/shields

jNullj · 2026-04-11T22:56:53Z

A step towards #11371 and express.js

some impotent points:

We can't use enum in route anymore in future versions of dependencies, this is a refactor is part 1 to solve this
i tried to get the most elegant and efficient solution at the cost of flexibility
the code assumes and limits enum only the first param, i couldn't find any services with multiple enum params and non first param as enum, it also makes semse
if any exception arise, we can always solve them at handle()
i could make a multi param system but it would be more costly in run-time then a single include check in an array.
this will require many follow up PR for all services...

…f strings

github-actions · 2026-04-11T22:58:19Z

	Warnings
⚠️	This PR modified service code for `gem` but not its test code. That's okay so long as it's refactoring existing code.
⚠️	This PR modified service code for `greasyfork` but not its test code. That's okay so long as it's refactoring existing code.
⚠️	This PR modified service code for `hexpm` but not its test code. That's okay so long as it's refactoring existing code.
⚠️	This PR modified service code for `mozilla-observatory` but not its test code. That's okay so long as it's refactoring existing code.
⚠️	This PR modified service code for `packagist` but not its test code. That's okay so long as it's refactoring existing code.
⚠️	This PR modified service code for `teamcity` but not its test code. That's okay so long as it's refactoring existing code.
⚠️	This PR modified service code for `twitter` but not its test code. That's okay so long as it's refactoring existing code.
⚠️	Found badge URL that may not follow our standard route abbreviations in `services/gem/gem-downloads.service.js`. Please ensure you've reviewed our conventions.

	Messages
📖	✨ Thanks for your contribution to Shields, @jNullj!
📖	Thanks for contributing to our documentation. We ❤️ our documentarians!

Generated by 🚫 dangerJS against 7f8aba5

…adges#11812) part of issue badges#3329 helps unblock badges#11800 Co-authored-by: Copilot <copilot@github.com>

* refactor: replace route format with pattern for [travis] part of issue #3329 helps unblock #11800 Co-authored-by: Copilot <copilot@github.com> * fix: remove redundant '/com' prefix from Travis tests * remove php-v route exclusion --------- Co-authored-by: Copilot <copilot@github.com>

replace `route`'s deprecated `format` with `pattern` part of badges#3329 helps badges#11800

…ce (badges#11858) replace `route`'s deprecated `format` with `pattern` part of badges#3329 helps badges#11800

firstParamName was used as litteral string insted of evaludating the value of the actual firstParamName extracted beforehand.

github-actions · 2026-07-21T20:37:25Z

🚀 Updated review app: https://pr-11800-badges-shields.fly.dev

PyvesB · 2026-07-21T20:44:35Z

   - `pattern` defines the variable part of the route, everything that comes after `/example/`. It can include any number of named parameters. These are converted into regular expressions by [`path-to-regexp`][path-to-regexp]. Because a service instance won't be created until it's time to handle a request, the route and other metadata must be obtained by examining the classes themselves. [That's why they're marked `static`.][static]
-   - There is additional documentation on conventions for [designing badge URLs](./badge-urls.md)
+
+- `routeEnum` (optional): an array of strings that defines a finite set of allowed values for an enum-like parameter in the route. When `routeEnum` is present, the first named parameter in the route `pattern` is treated as the enum value to validate against `routeEnum`.


Indentation of these new elements is no consistent with that of other parameters:

fixed at 3d56bc5

@jNullj was it intentional to drop the link to ./badge-urls.md in this commit? It felt useful to me.

@PyvesB it looked like its getting a bit too convoluted with so many internal lines so i tried to reduce it a bit
i think it was nice to have but its one of the things i could cut out without hurting the main content.

i don't mind getting it back, let me see if i can make it a bit more clear this time

jNullj · 2026-08-01T15:34:29Z

test failure: only gemrank failed, but it also fails in daily tests, we get timout and such, unrelated to this pr.

jNullj · 2026-08-01T19:59:46Z

moved it back to where it was, i just realized i moved it into routeEnum by mistake.

jNullj added 13 commits April 12, 2026 00:43

add base service routeEnum

1c77127

enhance error handling in BaseService for invalid parameters

76d1ab3

check for pattern for routeEnum as well to be used

9c66f73

validate routeEnum in BaseService to ensure it is a non-empty array o…

fc74bc1

…f strings

add routeEnum validation and handling in BaseService tests

c310122

refactor route pattern in GemDownloads to use routeEnum

de01715

add routeEnum to redirector

b837447

refactor route pattern in TeamCityBuild use routeEnum

e9ec499

refactor TwitterUrlRedirect route pattern to use routeEnum

d071103

refactor PackagistDownloads route pattern to use routeEnum

e4f4816

refactor MozillaObservatory route pattern to use routeEnum

e33f252

refactor HexPmDownloads route pattern to use routeEnum

142872f

refactor GreasyForkInstalls route pattern to use routeEnum

6a0b728

jNullj added the core Server, BaseService, GitHub auth, Shared helpers label Apr 11, 2026

jNullj added 4 commits April 12, 2026 02:06

refactor documentation to include routeEnum support and examples

93befa3

remove @type tag description for routeEnum

3a59191

refactor getBadgeExampleCall to support routeEnum for path parameters

316217a

refactor BaseService to support routeEnum for dynamic route registration

3ab6453

This was referenced Apr 25, 2026

refactor: replace 'format' with 'pattern' in deprecated example/test #11812

Merged

refactor: replace route format with pattern for [Travis] #11813

Merged

pull Bot pushed a commit to mikeyhodl/shields that referenced this pull request May 5, 2026

refactor: replace 'format' with 'pattern' in deprecated example/test (b…

e553542

…adges#11812) part of issue badges#3329 helps unblock badges#11800 Co-authored-by: Copilot <copilot@github.com>

jNullj mentioned this pull request May 13, 2026

refactor: replace route format with pattern in [website] redirect service #11858

Merged

jNullj added a commit to jNullj/shields-fun-fork that referenced this pull request May 13, 2026

refactor: replace route format with pattern in website redirect service

8ac17f4

replace `route`'s deprecated `format` with `pattern` part of badges#3329 helps badges#11800

pull Bot pushed a commit to victorv/shields that referenced this pull request May 14, 2026

refactor: replace route format with pattern in website redirect servi…

46caa19

…ce (badges#11858) replace `route`'s deprecated `format` with `pattern` part of badges#3329 helps badges#11800

jNullj added 2 commits July 11, 2026 23:10

Merge branch 'master' into core/route-enum-refactor-p1

b752718

fix: correct enum route registration

8a9972e

firstParamName was used as litteral string insted of evaludating the value of the actual firstParamName extracted beforehand.

jNullj marked this pull request as ready for review July 12, 2026 19:45

PyvesB reviewed Jul 21, 2026

View reviewed changes

jNullj added 3 commits July 25, 2026 23:06

fix: remove duplicated text

de4f48b

fix: doc identation

3d56bc5

fix: robust enumParam extraction in getBadgeExampleCall

3412cc1

Merge branch 'master' into core/route-enum-refactor-p1

aed3be8

jNullj requested a review from PyvesB August 1, 2026 15:36

jNullj added 2 commits August 1, 2026 22:50

docs: add comment about url conventions in routeEnum

6904649

docs: simplify routeEnum doc

1fe630a

PyvesB previously approved these changes Aug 1, 2026

View reviewed changes

docs: move route points

7f8aba5

jNullj dismissed PyvesB’s stale review via 7f8aba5 August 1, 2026 19:59

jNullj requested a review from PyvesB August 1, 2026 20:05

PyvesB approved these changes Aug 1, 2026

View reviewed changes

jNullj enabled auto-merge August 1, 2026 20:20

jNullj disabled auto-merge August 1, 2026 20:20

jNullj merged commit d64eda3 into badges:master Aug 1, 2026
18 of 19 checks passed

jNullj mentioned this pull request Aug 2, 2026

refactor [Amo CiiBestPractices CircleCi Codecov CodeFactor CodeRabbit Conda Feedz Wordpress Debug] to use routeEnum #12090

Merged

Navigation Menu

Uh oh!

Uh oh!

Add routeEnum with validation and enhance error handling in BaseService [Twitter Gem TeamCity Packagist MozillaObservatory HexPm Greasyfork] - #11800

Add routeEnum with validation and enhance error handling in BaseService [Twitter Gem TeamCity Packagist MozillaObservatory HexPm Greasyfork]#11800
jNullj merged 26 commits into
badges:masterfrom
jNullj:core/route-enum-refactor-p1

jNullj commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026 •

edited

Loading

Uh oh!

github-actions Bot commented Jul 21, 2026

Uh oh!

Uh oh!

Uh oh!

PyvesB Jul 21, 2026

Uh oh!

jNullj Aug 1, 2026

Uh oh!

PyvesB Aug 1, 2026

Uh oh!

jNullj Aug 1, 2026

Uh oh!

jNullj commented Aug 1, 2026

Uh oh!

jNullj commented Aug 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

Uh oh!

Uh oh!

Conversation

jNullj commented Apr 11, 2026

Uh oh!

github-actions Bot commented Apr 11, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions Bot commented Jul 21, 2026

Uh oh!

Uh oh!

Uh oh!

PyvesB Jul 21, 2026

Choose a reason for hiding this comment

Uh oh!

jNullj Aug 1, 2026

Choose a reason for hiding this comment

Uh oh!

PyvesB Aug 1, 2026

Choose a reason for hiding this comment

Uh oh!

jNullj Aug 1, 2026

Choose a reason for hiding this comment

Uh oh!

jNullj commented Aug 1, 2026

Uh oh!

jNullj commented Aug 1, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Milestone

Development

Uh oh!

2 participants

github-actions Bot commented Apr 11, 2026 •

edited

Loading