Add ability to self uninstall swiftly

[louisunlimited]

swiftly self-uninstall

• Fixes Add self-uninstall command #84

Implements the command swiftly self-uninstall, the ability to self uninstall swiftly incase it's no longer needed.
It deletes swiftly by removing everything under swiftBinDir and swiftHomeDir, and also removes the lines in shell profiles added by swiftly

TODO:

• Implement removing shell profile entry
• Tests for removing shell profile entry
• Update documentation in README
• Update docc ref

Questions:

• Are swift bin and swift home dir guaranteed to be safe for removal with fs.remove(atPath: ...)?
• Anything else we need to delete?
• Specific requirements for the deletion flow?
• What flags should we support?

Issue

Due to the way we mock home directories, the removesEntryFromShellProfile fails because any shell profiles .zprofile, .profile will be removed alongside swiftlyBinDir/swiftlyHomeDir, so the expect present check fails. Need to come up a better way to manage mockedTestHome directories

[louisunlimited]

Hi @cmcgee1024 do you mind taking a look at this PR when you have time? Thanks!

[cmcgee1024]

praise: It's good to see the tests here for this functionality that are small and fast to run.

[cmcgee1024]

question: Can this test invoke a swiftly init to do the usual install behaviour instead of duplicating the logic here?

[louisunlimited]

Well yeah ofc, my thought was to keep the tests as independent as possible so future changes to swiftly init won't interfere with something here, but i guess they are strongly coupled anyways. So what I did here was manually creating shell profiles only and see if the source lines are removed correctly. This might've been better if it's a unit test for that particular line of code removing the sourcelines:

for path in profilePaths {
    if try await fs.exists(atPath: path) {
        await ctx.print("Removing swiftly source line from \(path)...")
        let isFishProfile = path.extension == "fish"
        let sourceLine = isFishProfile ? fishSourceLine : shSourceLine
        if case let profileContents = try String(contentsOf: path, encoding: .utf8), profileContents.contains(sourceLine) {
            let newContents = profileContents.replacingOccurrences(of: sourceLine, with: "")
            try Data(newContents.utf8).write(to: path, options: [.atomic])
        }
    }
}

[cmcgee1024]

Overall, this looks good. I've added a few suggestions, and a question.

[louisunlimited]

Hi @cmcgee1024 I just made the changes you requested! lmk if there's anything else :)

[cmcgee1024]

nitpick: s/savely/safely/ here

[cmcgee1024]

issue (blocking): Thinking on this a little bit I think that we will need to take some extra care here. fs.remove is a big hammer. It can remove important directories and files without warning or recourse. The user can set their SWIFTLY_BIN_DIR to a shared directory with other binaries in it.

suggestion: Instead of removing the directory, how about removing the individual proxies by checking if they are symlinks to the swiftly binary, then remove the swiftly binary itself. Finally, if this directory is empty, then remove it.

The same kind of thing should probably be used for the SWIFTLY_HOME_DIR too. Remove the config.json, the environment files, and then remove the directory if it is empty.

For toolchains directory, remove all of the known toolchains first, and then check if it is empty.

[cmcgee1024]

Let's take advantage of the verbose flag here. If it's set then we report every file path that we removed.

[cmcgee1024]

thought: The user might reorganize their profile manually, or invoke some kind of tooling that does that. Some of these lines might exist, and others might not. Maybe a user removes the comment, leaving only the source line. We could perhaps match each line and remove them individually to make this a bit more robust and safe. Each one is unique enough that I think they shouldn't have too many false matches.

[cmcgee1024]

suggestion: If the verbose flag is set then output that the profile file was updated.