SAFE CLI subcommand suggestions: reset and uninstall

General
7

safe reset will revert all local file and directory creation made by Safe. To revert, all points of file and directory creation, of any repo of Safe Network · GitLab, must be cataloged.

To build the catalogue, I’ll search the repos for the use of any API known to create files or directories. API known to create files or directories:

  • std::fs::DirBuilder::create
  • std::fs::File::create
  • std::fs::File::with_options
  • std::fs::OpenOptions::create
  • std::fs::OpenOptions::create_new
  • std::fs::OpenOptions::open
  • std::fs::copy
  • std::fs::create_dir
  • std::fs::create_dir_all
  • std::fs::hard_link
  • std::fs::soft_link
  • std::fs::write

If you know of others in use in Safe repos, please reply with a link to a line of code.

Just use diff

I could diff my FS before and after some Safe usage, however it’s likely that it wouldn’t reveal all, especially lazily-created, files and directories. The better place to run diff checking is on test/CD/CI infrastructure as that should exercise the codebase more than any other, and therefore reveal lazily-created files and directories.

Limitations

The initial scope of this implementation will revert only file and directory creation in Safe’s repos. A complete catalogue would require that the entire dependency graph of Safe’s crates be searched.

safe reset is prone to becoming stale over time as code using file and directory creation API is added. I’d appreciate anyone’s ideas for maintaining safe reset’s consistency with the codebase, preferably without manual developer intervention. My current best idea is for a test/CD/CI diff task comparing diff results with a file and directory creation ‘manifest’ config file which lists the files and directories safe reset deletes.

1 Like