Page MenuHomeSoftware Heritage
Differential D2310

Add new endpoints to generate swh badges
ClosedPublic
Actions

Authored by anlambert on Nov 19 2019, 3:56 PM.

Details

Reviewers
vlorentz
Group Reviewers
Reviewers
Commits
rDWAPPSd1a53752a25f: misc: Add new endpoints to generate swh badges
Summary

Add endpoints /badge/(object_type)/(object_id)/ and /badge/(object_pid)/
to generate Github style like SVG badges for linking to the archive in
a README file.

Those new endpoints add CORS header to the HTTP responses in order to be
used from a different domain than *.softwareheritage.org ones.

Below is a preview of the generated badges according to swh object type:

  • origin:
  • content:
  • directory:
  • release:
  • revision:
  • snapshot:

Colors and texts might still be improved.

Related to T2090

Test Plan

Tests checking the badges are well-formed but also checking HTTP status codes
when an error occurs have been added.

Diff Detail

Repository
rDWAPPS Web applications
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

anlambert created this revision.Nov 19 2019, 3:56 PM
Herald added a reviewer: Reviewers. · View Herald TranscriptNov 19 2019, 3:56 PM
swh-public-ci added a comment.Nov 19 2019, 4:00 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/770/ for more details.

anlambert edited the summary of this revision. (Show Details)Nov 19 2019, 4:02 PM
swh-public-ci added a comment.Nov 19 2019, 4:06 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/371/ for more details.

Harbormaster completed remote builds in B9136: Diff 7946.Nov 19 2019, 4:06 PM
moranegg added subscribers: marla.dasilva, rdicosmo, moranegg.Nov 20 2019, 11:08 AM

Thanks for the images at the beginning of the diff, the badges are very cool !
I pinged @marla.dasilva to see the result and we might want to change the colors to more positive colors.
We are planning to meet about that on Friday, maybe we can even show it to @rdicosmo :-)

anlambert updated this revision to Diff 7953.Nov 20 2019, 11:11 AM

Rebase

swh-public-ci added a comment.Nov 20 2019, 11:16 AM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/772/ for more details.

swh-public-ci added a comment.Nov 20 2019, 11:30 AM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/373/ for more details.

Harbormaster completed remote builds in B9143: Diff 7953.Nov 20 2019, 11:30 AM
anlambert updated this revision to Diff 7964.Nov 20 2019, 5:00 PM

Rebase

swh-public-ci added a comment.Nov 20 2019, 5:07 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/774/ for more details.

swh-public-ci added a comment.Nov 20 2019, 5:22 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/375/ for more details.

Harbormaster completed remote builds in B9160: Diff 7964.Nov 20 2019, 5:22 PM
anlambert added a child revision: D2320: Integrate swh badges in Permalinks tab.Nov 21 2019, 1:19 PM
anlambert updated this revision to Diff 8011.Nov 21 2019, 2:07 PM

Update: Generate an error badge when something went wrong

swh-public-ci added a comment.Nov 21 2019, 2:13 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/777/ for more details.

swh-public-ci added a comment.Nov 21 2019, 2:21 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/378/ for more details.

Harbormaster completed remote builds in B9257: Diff 8011.Nov 21 2019, 2:21 PM
anlambert updated this revision to Diff 8013.Nov 21 2019, 2:28 PM

Rebase

vlorentz added a subscriber: vlorentz.Nov 21 2019, 2:31 PM

I think the "origin" badge should show the URL instead; so in forks it shows that it's the initial repository that is archive, while the fork may not be. It's also better for consistency.

swh-public-ci added a comment.Nov 21 2019, 2:32 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/779/ for more details.

vlorentz requested changes to this revision.Nov 21 2019, 2:38 PM

Shouldn't the badges be part of the API? Or at least be versioned.

swh/web/misc/badges.py
62–65

Nitpick: it's not a base64-encoded SVG, it's a data-URI containing the SWH logo

168–169

"Errors should never pass silently."

This revision now requires changes to proceed.Nov 21 2019, 2:38 PM
swh-public-ci added a comment.Nov 21 2019, 2:40 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/380/ for more details.

Harbormaster completed remote builds in B9270: Diff 8013.Nov 21 2019, 2:40 PM
anlambert added inline comments.Nov 21 2019, 2:44 PM
swh/web/misc/badges.py
62–65

Ack

168–169

Ack, will move the pid parsing in the first endpoint implementation then.

anlambert updated this revision to Diff 8016.Nov 21 2019, 3:20 PM

Update: Address @vlorentz comments and add tests for pid badge errors

swh-public-ci added a comment.Nov 21 2019, 3:24 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/781/ for more details.

swh-public-ci added a comment.Nov 21 2019, 3:31 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/382/ for more details.

Harbormaster completed remote builds in B9273: Diff 8016.Nov 21 2019, 3:31 PM
anlambert updated this revision to Diff 8019.Nov 21 2019, 3:47 PM

Update: slight changes in test for generating a new commit id for fixing D2320 CI builds (arc patch fails, I messed up somewhere)

swh-public-ci added a comment.Nov 21 2019, 3:50 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/785/ for more details.

swh-public-ci added a comment.Nov 21 2019, 3:57 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/385/ for more details.

Harbormaster completed remote builds in B9276: Diff 8019.Nov 21 2019, 3:57 PM
moranegg added a comment.Nov 22 2019, 11:10 AM

@vlorentz I'm not convinced about having the url in the text of the badge.
I understand that a fork can use the "wrong" badge, by using the main repository's badge.
But the sha1 is already very long for a badge and this is really kind of a gimmick link :-)

anlambert updated this revision to Diff 8068.Nov 22 2019, 4:18 PM

Rebase

swh-public-ci added a comment.Nov 22 2019, 4:22 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/792/ for more details.

swh-public-ci added a comment.Nov 22 2019, 4:33 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/391/ for more details.

Harbormaster completed remote builds in B9339: Diff 8068.Nov 22 2019, 4:33 PM
anlambert edited the summary of this revision. (Show Details)Nov 22 2019, 4:43 PM
anlambert updated this revision to Diff 8095.Nov 25 2019, 4:13 PM

Rebase

swh-public-ci added a comment.Nov 25 2019, 4:17 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/798/ for more details.

swh-public-ci added a comment.Nov 25 2019, 4:24 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/397/ for more details.

Harbormaster completed remote builds in B9371: Diff 8095.Nov 25 2019, 4:24 PM
anlambert removed a parent revision: D2309: common/service: Add lookup_object function.Nov 25 2019, 4:38 PM
anlambert mentioned this in D2320: Integrate swh badges in Permalinks tab.Nov 25 2019, 4:57 PM
anlambert updated this revision to Diff 8346.Nov 28 2019, 10:52 AM

Update: Rebase and use a white version of the swh logo in the bages

swh-public-ci added a comment.Nov 28 2019, 10:55 AM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/812/ for more details.

swh-public-ci added a comment.Nov 28 2019, 11:02 AM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/411/ for more details.

Harbormaster completed remote builds in B9417: Diff 8346.Nov 28 2019, 11:02 AM
vlorentz added a comment.Nov 28 2019, 12:23 PM

I think you missed this comment:

In D2310#54675, @vlorentz wrote:

Shouldn't the badges be part of the API? Or at least be versioned.

anlambert added a comment.Nov 28 2019, 1:25 PM

Shouldn't the badges be part of the API? Or at least be versioned.

I don't think so, having a separate endpoint dedicated to the badge generation seems appropriate here.
API endpoints return JSON responses while the badge endpoints return SVG ones.

Also I don't see the interest having versioned badges.

vlorentz accepted this revision.Nov 28 2019, 2:22 PM
This revision is now accepted and ready to land.Nov 28 2019, 2:22 PM
anlambert updated this revision to Diff 8396.Dec 2 2019, 3:58 PM

Rebase

swh-public-ci added a comment.Dec 2 2019, 4:01 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/tox/822/ for more details.

swh-public-ci added a comment.Dec 2 2019, 4:10 PM

Build is green
See https://jenkins.softwareheritage.org/job/DWAPPS/job/cypress-diff/421/ for more details.

Harbormaster completed remote builds in B9470: Diff 8396.Dec 2 2019, 4:10 PM
Closed by commit rDWAPPSd1a53752a25f: misc: Add new endpoints to generate swh badges (authored by anlambert). · Explain WhyDec 2 2019, 4:29 PM
This revision was automatically updated to reflect the committed changes.
anlambert added a commit: rDWAPPSd1a53752a25f: misc: Add new endpoints to generate swh badges.

Revision Contents
Changeset List

PathSize
3 lines
2 lines
swh/
web/
misc/
173 lines
1 line
settings/
7 lines
static/
img/
237 lines
tests/
misc/
166 lines

Diff 8399

View Options

mypy.ini

Loading...
View Options

requirements.txt

Loading...
View Options

swh/web/misc/badges.py

Loading...
View Options

swh/web/misc/urls.py

Loading...
View Options

swh/web/settings/common.py

Loading...
View Options

swh/web/static/img/swh-logo-white.svg

Loading...
View Options

swh/web/tests/misc/test_badges.py

Loading...
About · Developer information · Legal