[Endpoint] badge #2473

paulmelnikow · 2018-12-07T01:15:57Z

This reimplements the idea @bkdotcom came up with in #1519, and took a stab at in #1525. It’s a really powerful way to add all sorts of custom badges, particularly considering tools like RunKit endpoints and Jupyter Kernel Gateway, not to mention all the other ways cloud functions can be deployed these days.

I gave this a name which did not have JSON in it, so as not to confuse it with the dynamic JSON badges.

There are a few things that need doing before this can be shipped, including supporting several of the options I included in the schema.

Alternatively, they could be removed from the schema and added later on.

Curious for feedback! And thought I would open this up for comments before I got too far along.

Ref #1534 #2259. Closes #204 #358 #742 #999 #1519 #1752 #2625.

@bkdotcom

This reimplements the idea @bkdotcom came up with in #1519, and took a stab at in #1525. It’s a really powerful way to add all sorts of custom badges, particularly considering [tools like RunKit endpoints and Jupyter Kernel Gateway](#2259 (comment)), not to mention all the other ways cloud functions can be deployed these days. Ref #1752 #2259

shields-ci · 2018-12-07T01:17:03Z

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

Generated by 🚫 dangerJS against 92446ce

paulmelnikow · 2018-12-07T01:27:19Z

This pull request introduces 1 alert when merging 02dd662 into d0c9da0 - view on LGTM.com

new alerts:

1 for Ambiguous HTML id attribute

Comment posted by LGTM.com

calebcartwright · 2018-12-26T02:57:46Z

I don't really have any useful feedback on this one yet. React is wayyyy too new for me and I'm still trying to get a feel for that endpoint service.

Will try to get back to this one hopefully soon once I've read up a bit

paulmelnikow · 2019-01-01T19:51:22Z

React is wayyyy too new for me and I'm still trying to get a feel for that endpoint service.

Probably understanding the React code isn't that important here as it's just documentation. Looking at the review app would probably be sufficient.

calebcartwright · 2019-01-03T23:02:17Z

Okay I think I've found it now 😄 I was looking for an endpoint badge via the search function as well as perusing the page but couldn't find it.

I was able to get it via direct uri at https://shields-staging-pr-2473.herokuapp.com/#/endpoint

Can I point this thing to any endpoint that returns any JSON response?

calebcartwright · 2019-01-03T23:25:57Z

This may be expected at this point, but on my screen the json schema example looks to be in an odd location on the screen:

paulmelnikow · 2019-01-03T23:53:51Z

Can I point this thing to any endpoint that returns any JSON response?

Yea, that's exactly the idea! 😁Or rather, a JSON response in the specified format.

This is one I created for #2259: https://runkit.com/melnikow/version-from-requirements-txt

(Oops, that formatting will need some work.)

calebcartwright · 2019-01-03T23:56:27Z

Gotcha. So this is conceptually similar to the dynamic badges, except that it offers the users the ability to define their own processing functionality

calebcartwright · 2019-01-03T23:58:50Z

Do we have any idea how we might define guidelines recommendations for when a user should use this type of badge vs. implementing their own service in the Shields codebase and submitting that as a PR?

paulmelnikow · 2019-01-04T00:10:46Z

Gotcha. So this is conceptually similar to the dynamic badges, except that it offers the users the ability to define their own processing functionality

Right.

It also allows a service to publish a prerendered badge which can be proxied through shields.io to provide formatting flexibility.

Do we have any idea how we might define guidelines recommendations for when a user should use this type of badge vs. implementing their own service in the Shields codebase and submitting that as a PR?

It's a great way to get something going quickly and to quickly iterate and remix.

Beyond that I'd say if folks have something that's working well and they think it's generally useful, they should open an issue to suggest it. I don't have clear guidelines of what's too specific or too generic to include.

We probably wouldn't merge "is such-and-such the current month or not" (#1519) or "how many days are left in the year," however I could see building something along those lines that's specific to hacktoberfest.

This is also a good candidate for things we don't want to do, like exact star count or download count (#742), or nuget aggregate download counts (#204).

calebcartwright · 2019-01-04T00:17:21Z

It also allows a service to publish a prerendered badge which can be proxied through shields.io to provide formatting flexibility.

Nice! I was thinking along the same lines of use cases.

I was envisioning a scenario where someone may use this to get something going quickly, but then once they get it working well they just use it as is and not bother to share it back with the community 😄

Obviously that's not something that can be prevented, but maybe just a note in docs down the line that includes the exact sentiment you articulated:

Beyond that I'd say if folks have something that's working well and they think it's generally useful, they should open an issue to suggest it

paulmelnikow · 2019-01-04T00:59:33Z

I was envisioning a scenario where someone may use this to get something going quickly, but then once they get it working well they just use it as is and not bother to share it back with the community 😄

Right, that's a possibility. Though the advantage of pulling the implementation into the shields server is that it will take load off their server endpoint, and probably will perform better and be more reliable.

calebcartwright · 2019-01-04T17:05:51Z

One odd thing I've noticed is that the first time I hit the endpoint page I see what I showed above in #2473 (comment), but after I reload the page I see this:

calebcartwright · 2019-01-22T00:38:59Z

lib/validate.js

@@ -11,17 +11,21 @@ function validate(
    includeKeys = false,
    traceErrorMessage = 'Data did not match schema',
    traceSuccessMessage = 'Data after validation',
+    allowAndStripUnknownKeys = true,


i have no clue what all this is used for, but my first thought here was whether any consumers of this function would ever need different values for these two keys (allowUnknown false and stripUnknown true)?

It seems unsafe to allowUnknown and not stripUnknown so if we did that, I'd tend to think we weren't doing a good job of validating.

Originally I'd passed options directly through which would have supported any combination, though I'm not sure we would ever want to do that.

services/cache-headers.spec.js

services/endpoint/endpoint.service.js

calebcartwright · 2019-01-22T00:53:09Z

services/endpoint/endpoint.service.js

+
+    const { protocol, hostname } = new URL(url)
+    if (protocol !== 'https:') {
+      throw new InvalidParameter({ prettyMessage: 'please use https' })


👍 on pushing for https

calebcartwright · 2019-01-22T01:01:12Z

I went through the changes and left feedback/questions where I could, but have to defer on the frontend content to someone with a better eye for that sort of thing. Bravo on another big add 🍻!

I'd lean toward merging and opening a bug ticket for the fix.

That makes sense to me. I feel like there's been a lot of issues opened lately that will be resolved by this so I definitely see value in getting the functionality out even if there's some short term formatting items.

paulmelnikow · 2019-01-22T03:04:53Z

I'm going to add a Beta label to this feature, which will give us a chance to change the API if we decide we want to.

calebcartwright · 2019-01-22T03:09:26Z

frontend/components/endpoint-page.js

+        schemaVersion: 1,
+        label: 'hello',
+        message: 'sweet world',
+        color: 'orange',


😆 For some reason my brain read this as hello sweet orange. wonder if i am hungry...

calebcartwright

LGTM, don't have much to offer on the frontend content though

paulmelnikow · 2019-01-22T03:20:41Z

Do you mean you don't have much to offer on the way it's coded, or about what it's saying to the user?

calebcartwright · 2019-01-22T03:29:18Z

Do you mean you don't have much to offer on the way it's coded, or about what it's saying to the user?

Apologies, the former.

paulmelnikow · 2019-01-22T03:54:47Z

Opened #2837 for the formatting issues. I'm gonna ship this!!!

shields-deployment · 2019-01-22T03:55:27Z

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:

paulmelnikow · 2019-01-22T04:20:21Z

And opened #2838 for further discussions.

paulmelnikow added the core Server, BaseService, GitHub auth label Dec 7, 2018

paulmelnikow mentioned this pull request Dec 7, 2018

[badge-json] new "badge-json" service #1525

Closed

Rm exclusive test

c3719ce

paulmelnikow changed the title ~~[WIP] Endpoint badge~~ [WIP] [Endpoint] badge Dec 7, 2018

paulmelnikow temporarily deployed to shields-staging-pr-2473 December 7, 2018 01:18 Inactive

Clean lint

02dd662

paulmelnikow temporarily deployed to shields-staging-pr-2473 December 7, 2018 01:21 Inactive

Fix up element id

075d0d1

paulmelnikow temporarily deployed to shields-staging-pr-2473 December 7, 2018 01:30 Inactive

paulmelnikow mentioned this pull request Dec 8, 2018

Support static preview with social style #2479

Closed

daxpedda mentioned this pull request Dec 28, 2018

Implement badge generation. roblabla/cargo-travis#50

Merged

Merge branch 'master' into endpoint

da7213c

paulmelnikow temporarily deployed to shields-staging-pr-2473 January 1, 2019 19:52 Inactive

paulmelnikow mentioned this pull request Jan 3, 2019

Apply math to number in dynamic badges #2625

Closed

Merge branch 'master' into endpoint

5eaf042

paulmelnikow temporarily deployed to shields-staging-pr-2473 January 3, 2019 23:55 Inactive

paulmelnikow mentioned this pull request Jan 21, 2019

automatically show light or dark logos when using simple-icons #2833

Merged

calebcartwright reviewed Jan 22, 2019

View reviewed changes

services/cache-headers.spec.js Show resolved Hide resolved

calebcartwright reviewed Jan 22, 2019

View reviewed changes

services/endpoint/endpoint.service.js Outdated Show resolved Hide resolved

calebcartwright reviewed Jan 22, 2019

View reviewed changes

Merge branch 'master' into endpoint

ef29728

paulmelnikow temporarily deployed to shields-staging-pr-2473 January 22, 2019 02:57 Inactive

Fix spelling

85f4abd

paulmelnikow temporarily deployed to shields-staging-pr-2473 January 22, 2019 02:58 Inactive

paulmelnikow added 2 commits January 21, 2019 22:06

Mark Endpoint feature as beta

5229795

Merge branch 'endpoint' of github.com:badges/shields into endpoint

5b2eac7

paulmelnikow temporarily deployed to shields-staging-pr-2473 January 22, 2019 03:07 Inactive

Run prettier

c7700f5

paulmelnikow temporarily deployed to shields-staging-pr-2473 January 22, 2019 03:08 Inactive

calebcartwright reviewed Jan 22, 2019

View reviewed changes

calebcartwright approved these changes Jan 22, 2019

View reviewed changes

Merge branch 'master' into endpoint

92446ce

paulmelnikow deployed to shields-staging-pr-2473 January 22, 2019 03:50 View deployment

paulmelnikow merged commit 0fc3df8 into master Jan 22, 2019

paulmelnikow deleted the endpoint branch January 22, 2019 03:55

daxpedda mentioned this pull request Jan 22, 2019

Add badge.json for shields.io endpoint. roblabla/cargo-travis#58

Merged

niccokunzmann mentioned this pull request Jan 29, 2019

endpoint.svg requires https for localhost #2891

Open

3 tasks

mr-c mentioned this pull request Nov 8, 2020

status of this project? tom-tan/cwl-conformance-test-summarizer#1

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[Endpoint] badge #2473

[Endpoint] badge #2473

paulmelnikow commented Dec 7, 2018 •

edited

Loading

shields-ci commented Dec 7, 2018 •

edited

Loading

paulmelnikow commented Dec 7, 2018

calebcartwright commented Dec 26, 2018 •

edited

Loading

paulmelnikow commented Jan 1, 2019

calebcartwright commented Jan 3, 2019

calebcartwright commented Jan 3, 2019

paulmelnikow commented Jan 3, 2019

calebcartwright commented Jan 3, 2019

calebcartwright commented Jan 3, 2019

paulmelnikow commented Jan 4, 2019

calebcartwright commented Jan 4, 2019 •

edited

Loading

paulmelnikow commented Jan 4, 2019

calebcartwright commented Jan 4, 2019

calebcartwright Jan 22, 2019

paulmelnikow Jan 22, 2019

calebcartwright Jan 22, 2019 •

edited

Loading

calebcartwright commented Jan 22, 2019

paulmelnikow commented Jan 22, 2019

calebcartwright Jan 22, 2019

calebcartwright left a comment

paulmelnikow commented Jan 22, 2019

calebcartwright commented Jan 22, 2019

paulmelnikow commented Jan 22, 2019

shields-deployment bot commented Jan 22, 2019

paulmelnikow commented Jan 22, 2019

[Endpoint] badge #2473

[Endpoint] badge #2473

Conversation

paulmelnikow commented Dec 7, 2018 • edited Loading

shields-ci commented Dec 7, 2018 • edited Loading

paulmelnikow commented Dec 7, 2018

calebcartwright commented Dec 26, 2018 • edited Loading

paulmelnikow commented Jan 1, 2019

calebcartwright commented Jan 3, 2019

calebcartwright commented Jan 3, 2019

paulmelnikow commented Jan 3, 2019

calebcartwright commented Jan 3, 2019

calebcartwright commented Jan 3, 2019

paulmelnikow commented Jan 4, 2019

calebcartwright commented Jan 4, 2019 • edited Loading

paulmelnikow commented Jan 4, 2019

calebcartwright commented Jan 4, 2019

calebcartwright Jan 22, 2019

Choose a reason for hiding this comment

paulmelnikow Jan 22, 2019

Choose a reason for hiding this comment

calebcartwright Jan 22, 2019 • edited Loading

Choose a reason for hiding this comment

calebcartwright commented Jan 22, 2019

paulmelnikow commented Jan 22, 2019

calebcartwright Jan 22, 2019

Choose a reason for hiding this comment

calebcartwright left a comment

Choose a reason for hiding this comment

paulmelnikow commented Jan 22, 2019

calebcartwright commented Jan 22, 2019

paulmelnikow commented Jan 22, 2019

shields-deployment bot commented Jan 22, 2019

paulmelnikow commented Jan 22, 2019

paulmelnikow commented Dec 7, 2018 •

edited

Loading

shields-ci commented Dec 7, 2018 •

edited

Loading

calebcartwright commented Dec 26, 2018 •

edited

Loading

calebcartwright commented Jan 4, 2019 •

edited

Loading

calebcartwright Jan 22, 2019 •

edited

Loading