Wire up the local and remote persisters #1203
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
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
3 times, most recently
from
660e5e9 to
c131559
Compare
ankur22
commented
Feb 1, 2024
ankur22
commented
Feb 1, 2024
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
2 times, most recently
from
7125509 to
205f173
Compare
3 tasks
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
3 times, most recently
from
e68c888 to
cc0496d
Compare
inancgumus
reviewed
Feb 12, 2024
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
from
cc0496d to
9ea3968
Compare
This refactor will enable us to swap out the LocalFilePersister and RemotePersister. The Persist method in LocalFilePersist must match what is a requirement for the RemotePersister, which is the addition of the context as a param, even though the LocalFilePersister doesn't work with it. These two persisters will be interchangeable at a later stage depending on the environment setup.
This env var will be used to configure the remote persister. When this env var is available and setup correctly, it will help configure the module to swap out the LocalFilePersister with the RemotePersister.
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
from
e3e2be3 to
7a2324d
Compare
ankur22
changed the title
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
2 times, most recently
from
db21b71 to
35cba6e
Compare
This will parse the url, basePath and headers from K6_BROWSER_SCREENSHOTS_OUTPUT. It will also help determine whether the module should use a RemoteFilePersister or a LocalPersister.
This method will help determine whether to use the LocalFilePersister or the RemoteFilePersister. It mainly depends on whether a valid K6_BROWSER_SCREENSHOTS_OUTPUT env var has been setup.
This initialise a FilePersister (either a local or remote) depending on the environment, which is dictated by K6_BROWSER_SCREENSHOTS_OUTPUT.
Use the interface instead of the LocalFilePersister throughout the codebase so that we can easily swap it out for a different persister.
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
3 times, most recently
from
b330937 to
62d1405
Compare
inancgumus
reviewed
Feb 13, 2024
inancgumus
reviewed
Feb 13, 2024
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
2 times, most recently
from
1456485 to
1a01469
Compare
The packages will now own their own interfaces instead of borrowing one that was implemented in storage.
The browser package is the work horse on initialising and setting up the environment for the global test run, iteration or vu. The decision on whether to create a Local or Remote persister should rest in the browser package's hands, but leave the details of what and how the two persisters do their job in the storage package.
This type helps encapsulate and helps document what the parsed types and usages are from the K6_BROWSER_SCREENSHOTS_OUTPUT env var.
This explains what it is doing better than parseEnvVar.
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
from
250b95c to
f913425
Compare
Use a mock persister when there's no need for either a local or remote persister in a test. These tests do not need to validate that a screenshot was saved.
ankur22
force-pushed
the
refactor/wire-local-remote-persister
branch
from
f913425 to
d7dad6a
Compare
inancgumus
approved these changes
Feb 13, 2024
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.
What?
Now that we have the LocalFilePersister and RemoteFilePersister, the next step is to easily switch between the two depending on the environment configuration.
The key environmental change is the addition of
K6_BROWSER_SCREENSHOTS_OUTPUTwhich allows us to configure the necessary settings which will enable the browser module to upload the screenshots to the cloud. If this isn't present then it will assume that the screenshots are to be persisted to the local disk.Why?
It will allow us to easily swap out the local persister with the remote one. The design of this closely follows how it was implemented for tracing.
Checklist
Related PR(s)/Issue(s)
Updates: #1160