21901: Clarify documentation for WebDAVLogDownloadInterval

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Log all keep-web GET requests that request the first byte

We use this as a heuristic for "starting a new download." This heuristic
does mean that a GET request can avoid being logged if:

* it comes from the same source address (from the server's perspective)
* it uses the same API token
* it requests Range: bytes=1-

Those conditions seem acceptably narrow for now.

The http_range module used here is effectively a public export of the
same logic used by Go's HTTP FS server. I felt like it was important to
use the same logic to avoid different outcomes in the logging logic
vs. serving logic.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Add manifest text to some arvados.Collection fixtures

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Add integration test to not throttle different source addresses

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Refactor common functions out of log throttle integration tests

To prepare to add more tests.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: keep-web logs based on the last X-Forwarded-For address

Instead of the first.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Copyedit nearby documentation

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Add download log throttling to keep-web

See rationale in config.default.yml comments.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Add clientToken to fileEventLog

As an aid to log deduplication.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Add clientAddr to fileEventLog

Preparation for log deduplication.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Introduce fileEventLog to keep-web

Rather than storing all log metadata twice (once as a logger field and
once as an Arvados log property), this lets us store it all in one place
and then export it as needed. This restructure will make it easier to
add smarts to the logging infrastructure.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21901: Add TestCollectionUUIDToPDH map

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

Merge branch '22003-keep-web-and-wb2-redirect-parameter' refs #22003

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

Merge branch '21927-discovery-doc-test'

fixes #21927

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21927: Fix race condition in test.

Test was occasionally failing because the "wait for pending reqs, then
count reqs" step ran before the background refresh had progressed far
enough to be counted as a pending req.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21927: Fix test stub not waiting for holdReqs.

"Ensure requests are handled concurrently" feature was not working for
some of the test stanzas.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

Merge branch '21998-zoe-translates-keep-web-directory-listing-encode-url'

fixes #21998

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

Merge branch '21904-no-unqueueable-reqs'

fixes #21904

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21998: gofmt.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21998: Fixup comments.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21998: Use http scheme if indicated by load balancer.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

Merge branch '21943-dir-output' refs #21943

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

Merge branch '21993-wf-step-cancel' refs #21993

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

21943: Fix bug and add integration test

The bug was caused by the fact that the path mapper de-duplicates file
references before doing the mapping, but also did not traverse
directory listings.  If the list of files was de-duplicated by
selecting the entries from the directory listing (given a choice of 2+
places a given file reference appears in output), but then the
directory listings were skipped later on, those files wouldn't be
included in the path map at all.

Now trims the directory listings while constructing the list of files
to path map, so if the file is referenced in directory listings in the
output, it isn't lost to the dedup behavior.

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

21943: Add test for files appearing multiple times in output

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

21993: Committed request with priority == 0 is treated as cancel

Now handles the case where a user cancels a container request before
it has a chance to run, which currently remains in the "Committed"
state rather than "Final".  This fixes the bug where the workflow
runner would be stuck forever.

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

22003: prevent redirect loop in Wb2 client-side redirect handler

Check that the target URL is not empty before setting
window.location.href (browsing to new URL), because setting it to empty
effectively reloads the page and triggers the redirect handler again,
causing an endless loop.

Arvados-DCO-1.1-Signed-off-by: Zoë Ma <zoe.ma@curii.com>

22003: Workbench2 and keep-web: better interoperability with redirect

keep-web: When sending an unauthenticated browser client to a redirect
to Wb2, encode the target URL path in the query part of the redirection
URL in the `Location` header. This avoids possible corrupted header and
confused client.

Workbench2:

- In redirection handler, more robust handling of the input target-path
  passed by the URL query part.
- In the "copy link to clipboard" action in the files panel of a
  collection view, when creating the URL for clipboard, better emulate
  the server-generated redirect URL (see above).

Overall, when working with redirects (either generating redirect URLs or
handling them on the client side), we're better prepared for paths that
may contain special characters.

Arvados-DCO-1.1-Signed-off-by: Zoë Ma <zoe.ma@curii.com>

21998: Try to find original request's scheme in URL generated for wget.

In the "wget" example generated on the directory listing page, try to
make the scheme part in the URL argument closer to the original
request's, by using the value of "X-Forwarded-Proto" header if it's
valid.

Arvados-DCO-1.1-Signed-off-by: Zoë Ma <zoe.ma@curii.com>

21998: Simplify percent-encoding of relative URLs in directory listing

In keep-web, generate less-verbose URLs in the href values on the
directory listing page by using the percent-encoding function
appropriate for paths.

Arvados-DCO-1.1-Signed-off-by: Zoë Ma <zoe.ma@curii.com>

21998: properly percent-encode paths in keep-web directory listing page

Use percent-encoded form of the relative URLs as the value of "href"
attribute in directory listing page generated by keep-web

The "wget" command example shown on the page now has single-quotes
around the URL argument.

For testing involving complex URL or path patterns, use the HTML parser
provided by golang.org/x/net/html to scrape the directory listing page,
instead of using regular expressions that may get unwieldy.

Minor edits to the HTML template for compliance and ease of testing.

Arvados-DCO-1.1-Signed-off-by: Zoë Ma <zoe.ma@curii.com>

Merge branch '21935-clean-pysdk-api'

Refs #21935.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Mark internal arvados.keep classes as such

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Rename SafeHTTPCache to ThreadSafeHTTPCache

This mirrors the name of ThreadSafeAPIClient and clarifies what it is
"safe" for.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935/15397: Remove StreamFileReader

Unused after earlier changes.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Add upgrade note about PySDK reorganization

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

Merge branch '22005-s3-etag'

fixes #22005

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

22005: Add Etag to s3 response header.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

Merge branch '21978-replace-files-docs'

closes #21978

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

Provide more guidance for using arvbox the first time.

When arvbox is ready, now provides more information about things that
need to be done before you log in to arvbox workbench.

Also add a workbench banner with text and links to the Arvados docs,
based on the playground banner.

no issue #

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

21904: Remove LogCreateRequestFraction config.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21978: Streamline replace_files cross-reference markup

If we're linking to the section anyway, we can use less words and not
worry about whether it's "above" or "below."

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21904: Allow queueing "create log" requests.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21904: Remove obsolete test stub functionality (POST .../logs).

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21978: Broaden replace_files argument summary to match new features.

Also update "below" to "above" in text, to match the current location
of the replace_files section on the page.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21978: Note replace_files usage restrictions re federated clusters.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

Merge branch '21907-cache-s3-token'

Closes #21907.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21907: Rename s3SecretCacheTidyInterval

For improved clarity.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21907: Make new functions and methods private

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21907: Use an APIClientAuthorization pointer directly

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21907: Lock mutex when looking up cached S3 secrets

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21907: Cache valid S3 secrets in keep-web

This improves performance by avoiding a call to
/arvados/v1/api_client_authorizations on each request.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

Merge branch '22001-run-tests-py3'

Closes #22001.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

22001: Install PySDK earlier in run-tests.sh

See comments for rationale.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

22001: Run arvados_version.py before `pip install`

Otherwise `pip install` may package and try to install source that
doesn't include _version.py.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

22001: Simplify virtualenv management in run-tests

A lot of the current virtualenv management code is parameterized,
probably to able to support virtualenvs for Python 2 and 3 in
parallel. Since we don't need that anymore, remove all this code to
simplify the script.

* initialize() calls setup_virtualenv(), which ensures the virtualenv
  exists and then activates it. Everything else in the script can assume
  this is done.
* install_env() installs the Python build tools and support libraries
  we need.
* install_deps() installs our Python modules that are used by other
  components in Arvados.

With all this, there should be no need for regular virtualenv
de/reactivation.

Various old incantations meant to work around old setuptools/pip bugs
got cleaned up as part of this too.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

22001: Remove :py3 suffix from tests

We haven't supported Python 2 for a while, so requiring the user to
specify just demands extra typing for no reason.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Fix docstring markup typo

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Add a docstring to arvados.commands

Mostly to annotate it @private so pdoc skips rendering it.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Extract BaseDirectory classes to arvados._internal.basedirs

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Move arvados._pycurlhelper to arvados._internal.pycurl

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Merge _normalize_stream and _ranges into arvados._internal.streams

All these classes and functions are related to parsing and manipulating
streams, so it makes sense to collect them in one module with a name
reflecting that.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Move arvados.http_to_keep under arvados._internal

This functionality could be useful to provide to people writing their
own tools. However, because of the way it was extracted out of
arvados-cwl-runner, the API wasn't really designed to be public, and has
already had one breaking change since it was introduced.

Make the current module internal so the API doesn't ossify. We can
always develop a public API for it in the future.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Move arvados.diskcache under arvados._internal

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Merge arvados.timer into arvados._internal

It's one small class. It doesn't need a dedicated module.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Move arvados.util._deprecated to arvados._internal

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

15397: Remove documentation about upgrading to Crunch v2

Now that the Crunch v1 jobs API has been removed, there is no need to
document how to transition away from it.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935/15397: Remove arv-migrate-docker19

This tool was written to aid a migration that became necessary with the
release of Docker 1.10 in February 2016. Its time has passed.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Rename safeapi.ThreadSafeApiCache to api.ThreadSafeAPIClient

Moving the class lets us delist the safeapi module from reference
documentation and streamline it.

Changing the class name better describes what it does (it doesn't
cache anything!) and follows PEP 8 case rules.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Move arvados.cache.SafeHTTPCache to arvados.api

This removes a module from the reference documentation while maintaining
backwards compatibility.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21935: Correct return type of arvados.api.http_cache

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21974: Remove CentOS discussion from Arvados 3.0 release notes

Redundant since this support was removed in Arvados 2.7.4.
Refs #21974.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

Fix a couple of upgrade note typos.

refs #21947

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

Synchronize upgrade notes between 2.7 branch and main

refs #21947

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

Merge branch '21989-headers'

fixes #21989

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21989: Fix order-sensitive test.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21989: Keepstore: Use comma separator for X-Keep-Storage-Classes-Confirmed header

When generating the X-Keep-Storage-Classes-Confirmed header, use comma
(",") instead of semicolon (";") as the separator for multi-entry value.

This is to be consistent with keep-proxy's behavior and the arv-put
client's expectation. Plus, it follows RFC 9110 (see sec. 5.2).

Without the fix, arv-put wrongly believes that storage classes are not
supported on the cluster it is putting to. The spurious warning
"X-Keep-Storage-Classes header not supported by the cluster" can be seen
in arv-put messages and in Workbench2.

Arvados-DCO-1.1-Signed-off-by: Zoë Ma <zoe.ma@curii.com>

Merge branch '21931-public-suffix-pin'

Refs #21931.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

Merge branch '21701-replace-files-current-version'

refs #21701

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21931: Revert net-imap dependency

This was updated as part of #21933 in
9167b2053ef2a39a4e8a7c13e4127e12470b14ed.
However, net-imap 0.4 requires Ruby > 2.7.3, while Ubuntu 20.04 only
ships with Ruby 2.7.0. Upgrading this gem doesn't seem to be required
for the new Rails release, so don't.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21931: Narrow public_suffix dependency for arvados-google-api-client gem

For the usual reason: to force `gem install` to resolve dependencies in
a way that works on Ruby 2.7.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

Merge branch 'jszlenk/create_new_subproject' refs #21937

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

Merge branch '21934-python36-compat'

Refs #21934.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21934: Avoid using subprocess.run capture_output for Py3.6 compatibility

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21934: Use older name of ssl.CertificateError

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21934: Set explicit cache_max in test_disk_cache_retry_write_error

Without this, the test might fail if /tmp is small and the initially
calculated cache_max is already at the floor.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21934: Use assertGreater

To improve diagnostics if the test fails.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

21934: Autospec mmap mocks

So attribute checks get the right result.

Arvados-DCO-1.1-Signed-off-by: Brett Smith <brett.smith@curii.com>

Merge branch '21764-project-picker-crash' into main. Closes #21764

Arvados-DCO-1.1-Signed-off-by: Stephen Smith <stephen@curii.com>

Merge branch '15814-wb2-secrets' refs #15814

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

21701: Reword examples, add h4 headings and IDs.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21701: Use <PDH> to distinguish literal strings from placeholders.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

15814: Fix runtime typecheck error

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

21701: Update comments.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

Merge branch 'main' into 15814-wb2-secrets

Arvados-DCO-1.1-Signed-off-by: Peter Amstutz <peter.amstutz@curii.com>

Merge branch '20640-computed-permissions-api'

closes #20640

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

20640: Merge branch 'main' into 20640-computed-permissions-api

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

20640: Fix obfuscated asserts.

Arvados-DCO-1.1-Signed-off-by: Tom Clegg <tom@curii.com>

21764: Consolidate tree node extraction to be reused for tests, add TreePicker unit tests

Arvados-DCO-1.1-Signed-off-by: Stephen Smith <stephen@curii.com>

21764: Add more type safety to TreePicker

Arvados-DCO-1.1-Signed-off-by: Stephen Smith <stephen@curii.com>