Add various [Polymart] badges

[MherZaqaryan]

Added:

• Polymart Downloads badge
• Polymart Latest Version badge
• Polymart Rating badge
• Polymart Star Rating badge

Closes #7429

[shields-ci]

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

Generated by 🚫 dangerJS against 9ca8504

[chris48s]

Looks like the reason the service tests build is failing is because the service file is called polymart-rating.service.js (correctly) but the corresponding tests are polymart-raiting.tester.js (with an i). Fixing that should allow the service tests to run.

I've left some quick comments. I'll do a proper review once we've got a build passing. Thanks

[chris48s]

Could we use renderVersionBadge() here?

shields/lib/version.js

Lines 144 to 150 in 302c860

	function renderVersionBadge({ version, tag, defaultLabel }) {
	return {
	label: tag ? `${defaultLabel}@${tag}` : undefined,
	message: addv(version),
	color: versionColor(version),
	}
	}

[MherZaqaryan]

Hello, how do you recommend adding it? It seems removed now.

[chris48s]

All the Joi.object()s (response, resource, etc) should be .required() too as well as just the values inside them. Otherwise the objects themselves are optional.

[MherZaqaryan]

Ok, thanks for the information will add this too.

[chris48s]

We've got a variety of service tests all defining slightly different regular expressions to do roughly the same thing e.g:

• shields/services/pkgreview/package-rating.tester.js

  Lines 5 to 7 in b624179

  	const isRatingWithReviews = withRegex(
  	/^(([0-4](.?([0-9]))?)|5)\/5?\s*\([0-9]*\)$/
  	)

• shields/services/spiget/spiget-rating.tester.js

  Line 19 in b624179

  message: withRegex(/^(\d*\.\d+)(\/5 \()(\d+)(\))$/),

• shields/services/open-vsx/open-vsx-rating.tester.js

  Line 5 in b624179

  const isVscodeRating = withRegex(/[0-5]\.[0-9]{1}\/5?\s*\([0-9]*\)$/)

which we should pull out into a shared helper in https://github.com/badges/shields/blob/master/services/test-validators.js

I reckon it doesn't have to be a blocker to merging this, but I'm going to at least just tag here #4902 to remind us. It might make a nice next PR to to work on if you were looking for a follow-up :)

[MherZaqaryan]

Ok, should I leave it like that or wait until you add it to the shared helper?

[chris48s]

lets leave it as it is for this PR

[MherZaqaryan]

Looks like the reason the service tests build is failing is because the service file is called polymart-rating.service.js (correctly) but the corresponding tests are polymart-raiting.tester.js (with an i). Fixing that should allow the service tests to run.

I've left some quick comments. I'll do a proper review once we've got a build passing. Thanks

I've fixed that misspelling issue but there is another one no credentials configured, tests for this service will be skipped. would you mind helping me out with this?

[chris48s]

I checked your branch out locally and tried running the tests and there's a couple of problems.

One is that you are using id=1 for your "not found" tests, but this is actually a valid Resource ID on PolyMart:
https://api.polymart.org/v1/getResourceInfo/?resource_id=1
so your 'not found' tests are returning valid badges, rather than a not found response.

I'd suggest changing the 'not found' tests to use id=0 - this isn't a real resource, and it seems like a reasonably safe bet it probably won't be.
https://api.polymart.org/v1/getResourceInfo/?resource_id=0

Once you do, that the second problem you're going to hit is that the 'not found' response from this API isn't a 404 - its a 200 OK but with a body that indicates an error, so we can't rely on the standard error handling. We're going to need to:

• Declare 2 Joi schemas: one for the valid response and one for the error, then use Joi.alternatives() to accept either one or the other
• Check for the error and manually throw a NotFound() exception

Something this would be a good example of this pattern to crib from:

shields/services/steam/steam-workshop.service.js

Lines 24 to 55 in 0d6873b

	const steamCollectionSchema = Joi.object({
	response: Joi.object()
	.keys({
	collectiondetails: Joi.array()
	.items(
	Joi.object({
	children: Joi.array().required(),
	}).required()
	)
	.required(),
	})
	.required(),
	}).required()
	const steamCollectionNotFoundSchema = Joi.object({
	response: Joi.object()
	.keys({
	collectiondetails: Joi.array()
	.items(
	Joi.object({
	result: Joi.number().integer().min(9).max(9).required(),
	}).required()
	)
	.required(),
	})
	.required(),
	}).required()
	const collectionFoundOrNotSchema = Joi.alternatives(
	steamCollectionSchema,
	steamCollectionNotFoundSchema
	)

shields/services/steam/steam-workshop.service.js

Lines 146 to 148 in 0d6873b

	if (json.response.collectiondetails[0].result) {
	throw new NotFound({ prettyMessage: 'collection not found' })
	}

You can run your service tests locally using

npm run test:services -- --only="polymart"

I think the messages about missing credentials are a red herring - they apply to other services.

[MherZaqaryan]

@chris48s Hey, I fixed some issues, and there is a problem, while I am trying to run a test for a single service, would you mind helping me out?

Here's what happens when I try running only polymart service.

> npm run test:services -- --only="polymart"

shields.io@0.0.0 test:services
cross-env NODE_CONFIG_ENV=test mocha core/service-test-runner/cli.js "--only=polymart"

Running tests for 1 services: polymart.


Error: Unknown services: polymart
    at Runner.only (/shields/core/service-test-runner/runner.js:64:13)
    at /shields/core/service-test-runner/cli.js:127:10

[chris48s]

Hmm. I wonder if you are hitting #8437

Are you using Windows?

[MherZaqaryan]

Hmm. I wonder if you are hitting #8437

Are you using Windows?

Yep! I am using Windows, and I am probably facing the same issue.

[MherZaqaryan]

Bump!

[MherZaqaryan]

@chris48s Bump

[chris48s]

Sorry this one has been on a back burner for a while. Looks like you've still got some failing tests but we merged #8786 recently which should allow you to update this branch and run your tests locally. Can you have a look at getting the build passing and I'll circle back and review.

[github-actions]

	Fails
🚫	Danger failed to run dangerfile.js.

	Warnings
⚠️	This PR modified the server but none of its tests. That's okay so long as it's refactoring existing code.
⚠️	📚 Remember to ensure any changes to config.private in services/github/github-constellation.js are reflected in the server secrets documentation

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

Error Error

ENOENT: no such file or directory, open 'services/polymart/polymart-downloads.tester.js'
Error: ENOENT: no such file or directory, open 'services/polymart/polymart-downloads.tester.js'
    at Object.openSync (node:fs:590:3)
    at Object.readFileSync (node:fs:458:35)
    at _loop_1 (/home/runner/work/shields/shields/node_modules/danger-plugin-no-test-shortcuts/dist/index.js:18:28)
    at noTestShortcuts (/home/runner/work/shields/shields/node_modules/danger-plugin-no-test-shortcuts/dist/index.js:51:9)
    at Object.<anonymous> (dangerfile.js:103:1)
    at Module._compile (node:internal/modules/cjs/loader:1165:14)
    at requireFromString (/home/runner/work/shields/shields/node_modules/require-from-string/index.js:28:4)
    at /home/runner/work/shields/shields/node_modules/danger/distribution/runner/runners/inline.js:157:68
    at step (/home/runner/work/shields/shields/node_modules/danger/distribution/runner/runners/inline.js:52:23)
    at Object.next (/home/runner/work/shields/shields/node_modules/danger/distribution/runner/runners/inline.js:33:53)
    at /home/runner/work/shields/shields/node_modules/danger/distribution/runner/runners/inline.js:27:71
    at new Promise (<anonymous>)
    at __awaiter (/home/runner/work/shields/shields/node_modules/danger/distribution/runner/runners/inline.js:23:12)
    at runDangerfileEnvironment (/home/runner/work/shields/shields/node_modules/danger/distribution/runner/runners/inline.js:118:132)
    at /home/runner/work/shields/shields/node_modules/danger/distribution/platforms/GitHub.js:178:38
    at step (/home/runner/work/shields/shields/node_modules/danger/distribution/platforms/GitHub.js:44:23)
    at Object.next (/home/runner/work/shields/shields/node_modules/danger/distribution/platforms/GitHub.js:25:53)
    at /home/runner/work/shields/shields/node_modules/danger/distribution/platforms/GitHub.js:19:71
    at new Promise (<anonymous>)
    at __awaiter (/home/runner/work/shields/shields/node_modules/danger/distribution/platforms/GitHub.js:15:12)
    at Object.executeRuntimeEnvironment (/home/runner/work/shields/shields/node_modules/danger/distribution/platforms/GitHub.js:143:88)
    at /home/runner/work/shields/shields/node_modules/danger/distribution/commands/danger-runner.js:100:47
    at step (/home/runner/work/shields/shields/node_modules/danger/distribution/commands/danger-runner.js:34:23)
    at Object.next (/home/runner/work/shields/shields/node_modules/danger/distribution/commands/danger-runner.js:15:53)
    at fulfilled (/home/runner/work/shields/shields/node_modules/danger/distribution/commands/danger-runner.js:6:58)
    at processTicksAndRejections (node:internal/process/task_queues:96:5)

Dangerfile

------^

Generated by 🚫 dangerJS against c3fbe9c

[MherZaqaryan]

Sorry this one has been on a back burner for a while. Looks like you've still got some failing tests but we merged #8786 recently which should allow you to update this branch and run your tests locally. Can you have a look at getting the build passing and I'll circle back and review.

Hey! Thank you for that, could you please tell me if there is a problem with my latest activity, because I feel like I've done something wrong.

[chris48s]

Yes there's definitely something wrong with this branch now, as we can tell from the diff: https://github.com/badges/shields/pull/8352/files
but I couldn't tell you what you've done.

Rather than try to unpick it, I think from this point the best suggestion I can give you is:

I'm assuming you have https://github.com/badges/shields.git set up as a remote called upstream on your local checkout - if not, add it with git remote add upstream https://github.com/badges/shields.git

Pull down the latest changes:

git fetch upstream

Create a clean branch based off the latest changes from the upstream:

git checkout -b my-new-branch 2fb9889

Cherry pick the commits you want from this branch onto the new one:

git cherry-pick d403bb1
git cherry-pick fe1c933
git cherry-pick cb114a7
git cherry-pick 31ad897
git cherry-pick 64b460c

That will give you a new branch based off the latest commit on master with you changes so far from this PR replayed on top of it that you can work from.

Then either submit a new PR from that branch and I'll pick up the review from there, or force push your new branch to this one.

[MherZaqaryan]

Yes there's definitely something wrong with this branch now, as we can tell from the diff: https://github.com/badges/shields/pull/8352/files but I couldn't tell you what you've done.

Rather than try to unpick it, I think from this point the best suggestion I can give you is:

I'm assuming you have https://github.com/badges/shields.git set up as a remote called upstream on your local checkout - if not, add it with git remote add upstream https://github.com/badges/shields.git

Pull down the latest changes:

git fetch upstream

Create a clean branch based off the latest changes from the upstream:

git checkout -b my-new-branch 2fb9889

Cherry pick the commits you want from this branch onto the new one:

git cherry-pick d403bb1
git cherry-pick fe1c933
git cherry-pick cb114a7
git cherry-pick 31ad897
git cherry-pick 64b460c

That will give you a new branch based off the latest commit on master with you changes so far from this PR replayed on top of it that you can work from.

Then either submit a new PR from that branch and I'll pick up the review from there, or force push your new branch to this one.

Thank you very much, I will open a new pull request!