Paths

Table of Contentst

Differential D3129

common/identifiers: Add SWHIDs contextual information computation
ClosedPublic
Actions

Authored by anlambert on May 6 2020, 4:09 PM.

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Maniphest Tasks

T1241: Persistent identifiers (PIDs): add a way to describe Merkle DAG paths
T2330: Simplify Permalinks box

Commits

rDWAPPS6d00ef0a2829: common/identifiers: Add SWHIDs contextual information computation

Summary

First diff related to new SWHIds contextual information plugged into swh-web.

It implements the computation of these contextual information based on the
context archived objects are browsed: directory, revision, snapshot or origin.

Next step: add the display of these new SWHIDs in the Permalinks tab of the
web UI and add frontend tests.

Related to T1241
Related to T2330

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.May 6 2020, 4:09 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptMay 6 2020, 4:09 PM

Build is green

Patch application report for D3129 (id=11115)

Rebasing onto c20d4abae8...

Current branch diff-target is up to date.

Changes applied before test

commit 17177049dc1522ee5e0d11e3613161d98df7984d
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 6 15:23:18 2020 +0200

    common/identifiers: Add SWHIDs contextual information computation
    
    Implement the computation of new SWHIds contextual information based on the
    context archived objects are browsed: directory, revision, snapshot or origin.
    
    Related to T1241
    Related to T2330

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/118/ for more details.

Harbormaster completed remote builds in B12288: Diff 11115.May 6 2020, 4:17 PM

ardumont added a subscriber: ardumont.May 6 2020, 5:12 PM

ardumont added inline comments.

swh/web/common/identifiers.py
241	What is the purpose of the "empty" swh id info?
320	"J'ai les fils qui se croisent ici" ;) Seriously though, i have difficulties reading the multiple conditionals. Why the apparently more complex implementation than before?

anlambert added inline comments.May 6 2020, 5:28 PM

swh/web/common/identifiers.py
241	To handle the empty snapshot corner case when browsing the archive. But I intend to improve that later.
320	See https://docs.softwareheritage.org/devel/swh-model/persistent-identifiers.html#qualifiers, there is a lot of possibilities for contextual info based on the browsing context. For instance, you can browse a content in a directory context or in a snapshot context or in an origin context. The function handles all possible cases.

anlambert added inline comments.May 6 2020, 5:30 PM

swh/web/common/identifiers.py
320	For instance, you can browse a content in a directory context or in a snapshot context or in an origin context. And also in a revision context ;-)

ardumont added inline comments.May 6 2020, 6:11 PM

swh/web/common/identifiers.py
320	Thanks.
swh/web/templates/includes/show-swh-ids.html
32–33	`swh_id` or `swhid`? I recall you changed those to no longer use `_`?

anlambert added inline comments.May 6 2020, 6:29 PM

swh/web/templates/includes/show-swh-ids.html
32–33	My loop variable is badly named here, it should be `swhid_info` instead. Also I should rename `swh_ids` to `swhids_info` and the function `get_swh_persistent_ids` to `get_swhids_info` for consistency. I will update the diff accordingly.

Update: Perform some renaming

Build is green

Patch application report for D3129 (id=11118)

Rebasing onto c20d4abae8...

Current branch diff-target is up to date.

Changes applied before test

commit 561b185a02c15c81b925f70b0040d1d0c24620d5
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 6 15:23:18 2020 +0200

    common/identifiers: Add SWHIDs contextual information computation
    
    Implement the computation of new SWHIds contextual information based on the
    context archived objects are browsed: directory, revision, snapshot or origin.
    
    Related to T1241
    Related to T2330

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/119/ for more details.

Harbormaster completed remote builds in B12291: Diff 11118.May 6 2020, 7:09 PM

looks good to me

(Though, i might have passed rather faster on the last 2 tests at the end of the diff)

swh/web/templates/includes/show-swh-ids.html
48	nice trick i just noticed!

This revision is now accepted and ready to land.May 7 2020, 9:58 AM

Rebase

Build is green

Patch application report for D3129 (id=11134)

Rebasing onto 486255fea1...

Current branch diff-target is up to date.

Changes applied before test

commit 6d00ef0a2829863816c3423d48868d9830a7f52a
Author: Antoine Lambert <antoine.lambert@inria.fr>
Date:   Wed May 6 15:23:18 2020 +0200

    common/identifiers: Add SWHIDs contextual information computation
    
    Implement the computation of new SWHIds contextual information based on the
    context archived objects are browsed: directory, revision, snapshot or origin.
    
    Related to T1241
    Related to T2330

See https://jenkins.softwareheritage.org/job/DWAPPS/job/tests-on-diff/121/ for more details.

Harbormaster completed remote builds in B12307: Diff 11134.May 7 2020, 12:57 PM

Closed by commit rDWAPPS6d00ef0a2829: common/identifiers: Add SWHIDs contextual information computation (authored by anlambert). · Explain WhyMay 7 2020, 1:20 PM

This revision was automatically updated to reflect the committed changes.

anlambert added a commit: rDWAPPS6d00ef0a2829: common/identifiers: Add SWHIDs contextual information computation.