Refactor ark-cli for Improved Code Organization and Readability
#67
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
Benchmark for 23e3961Click to view benchmark
|
kirillt
reviewed
May 25, 2024
kirillt
reviewed
May 25, 2024
kirillt
reviewed
May 25, 2024
kirillt
reviewed
May 25, 2024
kirillt
reviewed
May 25, 2024
kirillt
reviewed
May 25, 2024
kirillt
reviewed
May 25, 2024
This was referenced May 28, 2024
tareknaser
force-pushed
the
organize_in_folders
branch
from
a294147 to
463750b
Compare
Benchmark for 49b25b8Click to view benchmark
|
kirillt
reviewed
May 29, 2024
ark-cli/src/commands/file/append.rs
Outdated
| @@ -35,12 +41,13 @@ impl Append { | |||
| translate_storage(&Some(self.root_dir.to_owned()), &self.storage) | |||
| .ok_or(AppError::StorageNotFound(self.storage.to_owned()))?; | |||
|
|
|||
| // FIXME: Why do we have `self.kind` and `self.storage`? Both are used to determine the storage type | |||
There was a problem hiding this comment.
Kind is probably file or folder. It could be derived from names, at least for standard storages provided by ARK. But developers could also create their own storages which would be unknown to ark-cli, so the user would need to pass this information explicitly.
We could also figure out the storage type automatically by checking the path. But with atomic versions the path will always point to a folder, so we need to calculate depth of the folder. Folder storages would have depth of 3 (storage/entry/version/value), while file storage should have depth 2 (a file inside each version, i.e. storage/version/table).
There was a problem hiding this comment.
Kind is probably
fileorfolder.
Right.
storage: Required parameter of typeString. Gets passed totranslate_storage()to determine the file path andstorage_typekind: Optional parameter of typeStorageTypeand specifies if it's a file or folder. It overwrites the value forstorage_type
Why would we need kind if storage already determines the storage type? Are there any cases where using kind would come in handy?
There was a problem hiding this comment.
The only real use-case for kind is custom storages, i.e. when the storage is not shipped by ARK framework, but the user implemented their own instance of FileStorage or FolderStorage. In this case, we can't figure it out by the path. But we still can figure it out by the folder structure as I've described above.
Overall, kind flag is more like a temporary helper. We should determine it automatically.
There was a problem hiding this comment.
Got it.
I removed the FIXME since there is a reason to have both flags
kirillt
reviewed
May 29, 2024
kirillt
reviewed
May 29, 2024
tareknaser
force-pushed
the
organize_in_folders
branch
from
e1646c9 to
4296f73
Compare
Benchmark for bb2f958Click to view benchmark
|
kirillt
reviewed
Jun 1, 2024
Benchmark for ae97c7fClick to view benchmark
|
Benchmark for 3bf3092Click to view benchmark
|
|
@tareknaser could you investigate where does this output come from? We need to register a bug, I guess. |
2 tasks
Benchmark for 7b93af4Click to view benchmark
|
Benchmark for fd60a3bClick to view benchmark
|
I have traced this down and apparently, Here's the relevant code https://github.com/ARK-Builders/ark-rust/blob/main/ark-cli/src/main.rs#L161-L170 : EntryOutput::Link => match File::open(path) {
Ok(mut file) => {
let mut contents = String::new();
match file.read_to_string(&mut contents) {
Ok(_) => (None, None, Some(contents)),
Err(_) => return None,
}
}
Err(_) => return None,
},To address this, I have pushed a commit to check if the file content is a valid link before printing it. This is a bit of a workaround. |
If a follow-up issue is needed, feel free to register it. I think, we can merge the PR but please remove the last 2 |
kirillt
approved these changes
Jun 29, 2024
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
Signed-off-by: Tarek <[email protected]>
tareknaser
force-pushed
the
organize_in_folders
branch
from
2ec4eeb to
02c76db
Compare
Benchmark for edebd94Click to view benchmark
|
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.
Description
Previously,
ark-clilogic was concentrated in a few files, with large files such asark-cli/src/main.rscontaining all the logic for running the CLI by calling other functions. This made it difficult to debug, patch, and read the code. This PR is the first step towards addressing other issues within the crate.Changes
pub enum Commands.run()method to handle the logic for each command.main()function now only callsrun(), and if an error is encountered, it prints it to stderr. This enhances error handling.unwrap()when applicable.FIXMEnotes to track planned changes.