This repository has been archived by the owner on Feb 16, 2023. It is now read-only.
Release v0.24.0 #154
Merged
Release v0.24.0 #154
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
…ption Update README onle-line description
Rephrase getting help in README
Update README examples to use new constructor and ReadString to develop
Add shorthand for generating random alphanumeric characters
Restructure the readme
Don't add a query parameter when no subject types are given.
These iterators make it possible to iterate over an infinite stream of audit events. The events are fetched in batches (pages) from the API, but this is abstracted away in the iterator.
This makes the logs easier to read, as the logs of downloading the modules will be in a different component.
Cache go modules and download them in a different step in CI
Only add query params to request when not empty
The current paginator is not the right abstraction. There currently is nothing generic about the paginator, which results in everything being injected as functions. Once we implement link headers, we can abstract away how we get the URL of the next page, which is then done in the same way for all pages.
Instead of waiting until a request is made, return the error when constructing the client.
Now we don't go back and forth between strings and URLs. Now this also doesn't return an error anymore.
It works just like mkdir -p, creating all directories that do not exist yet recursively and it does not error when the directories already exist.
Add CreateAll func to dir service to create dirs recursively
Also, don't support filtering subject types just yet. We'll add that later.
By doing so, we can remove the error from the constructor of the iterator
We still have to add the subject type(s) filter before the full functionality of ListEvents can be achieved with EventIterator. Before then, we'll not deprecate ListEvents just yet.
Add missing validation check
Add Exists func to dir service
Add EventIterator funcs
Add a fake for dirService.Exists
mackenbach
reviewed
Dec 2, 2019
There was a problem hiding this comment.
I was just reading up on the changes and found two small things. @SimonBarendse could you have a quick look?
Also, could you walk me through the decision process for going with the AuditEventIteratorParams struct in person?
| // | ||
| // // Use event | ||
| // } | ||
| EventIterator(path string, _ *AuditEventIteratorParams) AuditEventIterator |
There was a problem hiding this comment.
Why do we have an unnamed parameter here? Would params be more descriptive?
There was a problem hiding this comment.
Yes, params as a name could also work.
The paramater is unnamed because it is not currently being used; there are no parameters to pass to the event iterator yet. The paramater is already added so that we can add parameters to the params struct without requiring a breaking change.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Added
CreateAllto create dirs recursively (Add CreateAll func to dir service to create dirs recursively #146)Existsfor directories ( Add Exists func to dir service #149, Add a fake for dirService.Exists #153)