[bug#38630] Software Heritage (swh): Fix API change, causing repeatedly submitting archives

[bug#38630] Software Heritage (swh): Fix API change, causing repeatedly submitting archives

[Björn Höfling]

[-- Attachment #1.1: Type: text/plain, Size: 403 bytes --]

Hi Guix,

when linting, I recognized that the archival linter was repeatedly
sending packages to the SWH, despite that the package was already
archived.

With some investigations, I noticed they changed the API. Here's a
patch that fixes it.

I have not communicated with SWH about that, especially I have not asked
SWH why they broke the API without updating the version number.

Björn


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1.2: 0001-swh-Fix-API-call-for-getting-origin.patch --]
[-- Type: text/x-patch, Size: 1482 bytes --]

From a5ada85d168b45d517d8faf0d79ad5beccc26911 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Bj=C3=B6rn=20H=C3=B6fling?=
 <bjoern.hoefling@bjoernhoefling.de>
Date: Sun, 15 Dec 2019 22:00:56 +0100
Subject: [PATCH] swh: Fix API call for getting origin.

When using the archival linter, git origins already in the archive where
not recognized due to an API change and where repeatedly asked for archival.
This is fixed here.

* guix/swh.scm (lookup-origin): Fix API URI for getting origin.
(<origin>): Fix comment with API URI example.
---
 guix/swh.scm | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/guix/swh.scm b/guix/swh.scm
index 7acad05928..372e4c84d1 100644
--- a/guix/swh.scm
+++ b/guix/swh.scm
@@ -244,7 +244,7 @@ FALSE-IF-404? is true, return #f upon 404 responses."
        docstring
        (call (swh-url components ...) json->value)))))
 
-;; <https://archive.softwareheritage.org/api/1/origin/git/url/https://github.com/guix-mirror/guix/>
+;; <https://archive.softwareheritage.org/api/1/origin//https://github.com/guix-mirror/guix/get>
 (define-json-mapping <origin> make-origin origin?
   json->origin
   (id origin-id)
@@ -365,7 +365,7 @@ FALSE-IF-404? is true, return #f upon 404 responses."
 
 (define-query (lookup-origin url)
   "Return an origin for URL."
-  (path "/api/1/origin/git/url" url)
+  (path "/api/1/origin" url "get")
   json->origin)
 
 (define-query (lookup-content hash type)
-- 
2.23.0


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

[bug#38630] Software Heritage (swh): Fix API change, causing repeatedly submitting archives

[Ludovic Courtès]

Hello!

Björn Höfling <bjoern.hoefling@bjoernhoefling.de> skribis:

> when linting, I recognized that the archival linter was repeatedly
> sending packages to the SWH, despite that the package was already
> archived.
>
> With some investigations, I noticed they changed the API. Here's a
> patch that fixes it.

Good catch!

> I have not communicated with SWH about that, especially I have not asked
> SWH why they broke the API without updating the version number.

Yeah, that’s weird, I’ve pinged them on IRC.

It seems that the removal was intentional as part of
<https://forge.softwareheritage.org/D2167>, but it wasn’t clear whether
the API breakage should have happened.  This led them to open a new
task: <https://forge.softwareheritage.org/T2158>.  We should keep an eye
on it.

> From a5ada85d168b45d517d8faf0d79ad5beccc26911 Mon Sep 17 00:00:00 2001
> From: =?UTF-8?q?Bj=C3=B6rn=20H=C3=B6fling?=
>  <bjoern.hoefling@bjoernhoefling.de>
> Date: Sun, 15 Dec 2019 22:00:56 +0100
> Subject: [PATCH] swh: Fix API call for getting origin.
>
> When using the archival linter, git origins already in the archive where
> not recognized due to an API change and where repeatedly asked for archival.
> This is fixed here.
>
> * guix/swh.scm (lookup-origin): Fix API URI for getting origin.
> (<origin>): Fix comment with API URI example.

In the meantime, your patch looks like the right move, so you can push it.

Thank you!

Ludo’.

bug#38630: Software Heritage (swh): Fix API change, causing repeatedly submitting archives

[Björn Höfling]

[-- Attachment #1: Type: text/plain, Size: 873 bytes --]

On Tue, 17 Dec 2019 17:41:04 +0100
Ludovic Courtès <ludo@gnu.org> wrote:

> > I have not communicated with SWH about that, especially I have not
> > asked SWH why they broke the API without updating the version
> > number.  
> 
> Yeah, that’s weird, I’ve pinged them on IRC.
> 
> It seems that the removal was intentional as part of
> <https://forge.softwareheritage.org/D2167>, but it wasn’t clear
> whether the API breakage should have happened.  This led them to open
> a new task: <https://forge.softwareheritage.org/T2158>.  We should
> keep an eye on it.

I will be frequently linting and see what's happening :-)

[..]

> In the meantime, your patch looks like the right move, so you can
> push it.

Thanks for your review and further information, pushed as

356a79becc4061d158c68718ad169abac1ab672f

Closing this ticket.

Björn

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

[bug#38630] Software Heritage (swh): Fix API change, causing repeatedly submitting archives

[Jonathan Brielmaier]

On 17.12.19 23:32, Björn Höfling wrote:
> Thanks for your review and further information, pushed as
>
> 356a79becc4061d158c68718ad169abac1ab672f
>
> Closing this ticket.

I guess the "origin//" in the comment should be "origin/" :)

[bug#38630] Software Heritage (swh): Fix API change, causing repeatedly submitting archives

[Björn Höfling]

[-- Attachment #1: Type: text/plain, Size: 460 bytes --]

On Wed, 18 Dec 2019 10:22:27 +0100
Jonathan Brielmaier <jonathan.brielmaier@web.de> wrote:

> On 17.12.19 23:32, Björn Höfling wrote:
> > Thanks for your review and further information, pushed as
> >
> > 356a79becc4061d158c68718ad169abac1ab672f
> >
> > Closing this ticket.  
> 
> I guess the "origin//" in the comment should be "origin/" :)

Hi Jonathan,

thanks for that hint, fixed in:

6afea7489b76c8db58d4f389fdbedc7c2b8992bd

Björn

[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 195 bytes --]

[bug#38630] Software Heritage (swh): Fix API change, causing repeatedly submitting archives

[Jonathan Brielmaier]

On 18.12.19 22:44, Björn Höfling wrote:
> On Wed, 18 Dec 2019 10:22:27 +0100
> Jonathan Brielmaier <jonathan.brielmaier@web.de> wrote:
>
>> On 17.12.19 23:32, Björn Höfling wrote:
>>> Thanks for your review and further information, pushed as
>>>
>>> 356a79becc4061d158c68718ad169abac1ab672f
>>>
>>> Closing this ticket.
>>
>> I guess the "origin//" in the comment should be "origin/" :)
>
> Hi Jonathan,
>
> thanks for that hint, fixed in:
>
> 6afea7489b76c8db58d4f389fdbedc7c2b8992bd

Now we lost the h in https, but it's only a comment so not really
important :)