typo fixes; added doc links

Documentation updates

Requested changes

Removed unused code

Changes requested in the review

Review changes

• checking for origin_url in request params
• better tests
• redirect to /snapshot/log/<id>

Commit message changes to include "Fixes <ticket>"

Review changes and changes to the commit message

Review changes

In D6449#167375, @vlorentz wrote:

Please use the imperative form in diff and commit titles. For example (respectively):

Fix navigation to directory(code) in snapshot view

and

Add an extra parameter called directory_url in the snapshot_context

To fix missing URL to the code (directory) view in case the snapshot is missing an origin context.

Related to T3644

or just this:

Fix missing URL to the code (directory) view in case the snapshot is missing an origin context.

Related to T3644

Two other nitpicks:

1. it's easier for everyone to have the diff title and message match the commit message most of the time
2. Use "Fixes Txxxx" or "Closes Txxxx" instead of "Related to Txxxx" for commits that completely fix an issue, it gives more details on the relation between the commit and the task.

See https://docs.softwareheritage.org/devel/contributing/git-style-guide.html

Review changes

In T3641#71966, @anlambert wrote:

Looks like the bug comes from that piece of javascript code. We should test if the pathname ends with /branches/ or /releases/ instead to activate the correct tab.

Diff for log routes

WIP: Many URLs defined in the origin view (urlconf) are redundant.
This fix redirects /origin/branches?origin_url=<url> and
/origin/<url>/branches to /snapshot-branches/

Yes we can, the snapshot should be provided as query parameter in other views in that case.

In T3608#71803, @olasd wrote:

I'm asking this because using predictable origin-centric URLs is generally much more user friendly than having to use multiple APIs to look up the SWHID of a given object before being able to construct the URL, and one would have to always to dynamic API calls to generate the URL for browsing the "latest archival" of a given origin.

For instance, the "archived origin" SWH badge https://www.softwareheritage.org/2020/01/13/the-swh-badges-are-here/ uses an origin-centric URL.

In T3608#71802, @olasd wrote:

Just to be clear, you're looking to keep these URL working, but turn them into redirects over to swhid-centric URLs with context parameters (and drop the original view code from these URLs), correct?

@anlambert do you think we can deprecate following routes as well? I think they can be redirected to the corresponding swh/web/browse/views/<object_type>.py routes.

• Unit tests for mongo backend
• stubs
• small change
• more
• missing test stubs

In T3608#71673, @anlambert wrote:

The issue is, the redirected url (/browse/directory/<sha1>?origin_url=<>) will call the same function (get_snapshot_context) again. This is true for all the urls.
Do you see some other efficient alternative to fix this ticket?

@jayeshv, all costly storage requests result (getting origin visits, snapshot content and size) performed by the get_snapshot_context
function are cached at the django level so no need to worry about performance here as it has already been handled.

@anlambert This ticket might have some performance implications.
for eg: in the first case, to redirect /browse/origin/directory/?origin_url=<> to the root directory, we have to query the archive first. The obvious way would be to call the get_snapshot_context function.
https://forge.softwareheritage.org/source/swh-web/browse/master/swh/web/browse/snapshot_context.py$395

Updated requirements

Fixed the issue in timestamp comparison

more tests

• added stubs
• small fixes
• more doc strings
• Better doc strings

• Unit tests for mongo backend
• Added tests for multiple records
• Added more unit tests
• String corrections

In D6291#163149, @aeviso wrote:

I'm not really convinced about adding this test, it essentially recreates situations that are already tested in the test_provenance_storage test (but there it is done for all backends at once).
Also, performing direct queries to the mongodb object breaks the abstraction layer which means any future refactoring will require reimplementing this tests.
I rather design test to be independent of the actual implementation, so that they check that the class behave as expected from a semantic point of view.

string changes

Added missing tests for multiple records

LGTM.

In D6220#160865, @aeviso wrote:

Not sure we really want to restrict this methods to test-only in the documentation. But we can change this in the future anyway

In D6220#160846, @douardda wrote:

Please use imperative style in the got commit message
https://chris.beams.io/posts/git-commit/

Docstring changes for test only methods (Minor).

In T3405#67656, @anlambert wrote:

I stumbled across GitLab GraphQL API while working on T3442, could be a great source of inspiration.

Initial version is merged to master.

First test 07/09/2021
Against the simple/experimental data model version. (https://forge.softwareheritage.org/rDPROV3e009a2f77de1d4d00eb52f838537c7af327f010)
Computer: Dell 7400

MongoDB backend implementation for provenancestorage.