Harmonize extract with API logic #3473
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
dbutenhof
added
Server
Code Infrastructure
API
webbnh
reviewed
Jun 30, 2023
dbutenhof
commented
Jun 30, 2023
webbnh
requested changes
Jul 1, 2023
webbnh
previously approved these changes
Jul 3, 2023
webbnh
previously approved these changes
Jul 3, 2023
PBENCH-1194 Rework Tarball inventory access to avoid the nascent cache map so that we can rely on this inside the Pbench Server process where tarballs haven't been unpacked. This also fixes some incompatibilities in the Quisby APIs which relied on the older extract semantics. In order to avoid stale streams on the `inventory` API I encapsulated the `extractfile` stream into an object that can behave as a stream but will close both the stream and tarball when done: this is deferred until Flask tears down the Response object. Finally, I've added functional tests validating the `contents`, `inventory`, `visualize`, and `compare` APIs so we'll catch any further infrastructure "drift" that might affect them.
This is in a separate commit; because I keep putting this off in favor of minimizing review complication, but I really want to do it because the test grew beyond "put" way back once I realized we couldn't set real dependencies between test files...
webbnh
approved these changes
Jul 5, 2023
dbutenhof
commented
Jul 5, 2023
dbutenhof
added a commit
to dbutenhof/pbench
that referenced
this pull request
Jul 5, 2023
PBENCH-1204 This stems from a request from the UI to help optimize a partial refresh after using the relay upload dialog, by providing identification of the new dataset. Although a client using the traditional `PUT /upload` already knows the name and MD5, the returned information may be helpful. This is a DRAFT partly because I added a validation of the new information to the functional test, which I've renamed in distributed-system-analysis#3473 ... I'll do that merge here after it's gone in. It's also DRAFT because while I like the idea of including URIs (and in particular this addresses a certain request regarding accessibility of the tarball), I'm not really sure which URIs to include or in what form. I'm certain that one or two people might possibly have opinions on this subject!
ndokos
approved these changes
Jul 6, 2023
dbutenhof
added a commit
to dbutenhof/pbench
that referenced
this pull request
Jul 6, 2023
PBENCH-1204 This stems from a request from the UI to help optimize a partial refresh after using the relay upload dialog, by providing identification of the new dataset. Although a client using the traditional `PUT /upload` already knows the name and MD5, the returned information may be helpful. This is a DRAFT partly because I added a validation of the new information to the functional test, which I've renamed in distributed-system-analysis#3473 ... I'll do that merge here after it's gone in. It's also DRAFT because while I like the idea of including URIs (and in particular this addresses a certain request regarding accessibility of the tarball), I'm not really sure which URIs to include or in what form. I'm certain that one or two people might possibly have opinions on this subject!
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PBENCH-1194
Rework Tarball inventory access to avoid the nascent cache map so that we can rely on this inside the Pbench Server process where tarballs haven't been unpacked.
This also fixes some incompatibilities in the Quisby APIs which relied on the older extract semantics.
In order to avoid stale streams on the
inventoryAPI I encapsulated theextractfilestream into an object that can behave as a stream but will close both the stream and tarball when done: this is deferred until Flask tears down the Response object.Finally, I've added functional tests validating the
contents,inventory,visualize, andcompareAPIs so we'll catch any further infrastructure "drift" that might affect them.NOTE: I renamed the
test_put.pyfunctional test file totest_datasets.py. I've put this off many times to avoid over-complicating reviews, so this time I just did it in a separate commit. All the real changes are in the first commit, and (just) the rename is in the second commit.