Differential D2309

common/service: Add lookup_object function
ClosedPublic
Actions

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

Details

Reviewers

ardumont

Group Reviewers

Reviewers

Commits

rDWAPPS611cc6583b3e: common/service: Add lookup_object function

Summary

Add an utility function for looking up an object in the archive by its type
and id. Supported object types are: content, directory, release, revision
and snapshot.

Its purpose is to factorize some code that will be needed in the upcoming
swh badge endpoints implementation. Notably, it enables to check that
an object exists in the archive in order to return adequate HTTP status code.

Related to T2090

Test Plan

Nex tests 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:26 PM

Herald added a reviewer: Reviewers. · View Herald TranscriptNov 19 2019, 3:26 PM

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

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

Harbormaster completed remote builds in B9135: Diff 7945.Nov 19 2019, 3:36 PM

anlambert added a child revision: D2310: Add new endpoints to generate swh badges.Nov 19 2019, 3:56 PM

I don't feel comfortable to accept revisions, globally... but your diff looks solid.

swh/web/api/views/identifiers.py
58	nicely done !
swh/web/tests/common/test_service.py
809	I see that tests are not documented. Here valid objects means objects that exists in the archive? Maybe known objects as the contrast of unknown objects is more appropriate...

ardumont added a subscriber: ardumont.Nov 20 2019, 9:37 AM

ardumont added inline comments.

swh/web/api/views/identifiers.py
58	Where is stored the result of the lookup_object function call?

anlambert added inline comments.Nov 20 2019, 10:53 AM

swh/web/api/views/identifiers.py
58	Here the idea is to check the object existence in the archive. An exception will be raised if it is not found and an HTTP error response will be generated.
swh/web/tests/common/test_service.py
809	Sounds better indeed, I will rename the test.