feat: upgrade command upgrading CLI + install command (#856)

Co-authored-by: Martin Adámek <[email protected]>

Author: vladfrangu

CONTRIBUTING.md

@@ -134,4 +134,4 @@ afterAll(async () => {
 
 ### Running commands
 
-Running commands in tests can be done by calling `runCommand` (imported from the command framework)
+Running commands in tests can be done by calling `testRunCommand` (imported from the command framework)

scripts/build-cli-bundles.ts

@@ -93,6 +93,13 @@ for (const entryPoint of entryPoints) {
 
 			if (systemType.toLowerCase().includes('arm')) {
 				arch = 'arm64';
+
+				// On arm, process.arch will still return x64, which will break the upgrade command.
+				// So we override the arch to arm64
+
+				const newNewContent = newContent.replace('process.env.APIFY_BUNDLE_ARCH', '"arm64"');
+
+				await writeFile(metadataFile, newNewContent);
 			}
 		}
 
@@ -103,6 +110,9 @@ for (const entryPoint of entryPoints) {
 		console.log(`Building ${cliName} for ${target} (result: ${fileName})...`);
 		// TODO: --sourcemap crashes for w/e reason and --bytecode doesn't support ESM (TLA to be exact)
 		await $`bun build --compile --minify --target=${target} --outfile=${outFile} ${entryPoint}`;
+
+		// Remove the arch override
+		await writeFile(metadataFile, newContent);
 	}
 }
 

scripts/install/install.ps1

@@ -35,6 +35,8 @@ if ($WinVer.Major -lt 10 -or ($WinVer.Major -eq 10 -and $WinVer.Build -lt $MinBu
 
 $ErrorActionPreference = "Stop"
 
+$UpgradeScriptURL = "https://raw.githubusercontent.com/apify/apify-cli/main/scripts/install/upgrade.ps1"
+
 # These three environment functions are roughly copied from https://github.com/prefix-dev/pixi/pull/692
 # They are used instead of `SetEnvironmentVariable` because of unwanted variable expansions.
 function Publish-Env {
@@ -179,7 +181,7 @@ function Install-Apify {
 
             try {
                 # Use Invoke-RestMethod instead of Invoke-WebRequest because Invoke-WebRequest breaks on
-                # some machines, see
+                # some machines
                 Invoke-RestMethod -Uri $DownloadURL -OutFile $DownloadPath
             }
             catch {
@@ -216,11 +218,30 @@ function Install-Apify {
         }
     }
 
+    $UpgradeScriptPath = "${ApifyBin}\upgrade.ps1"
+    curl.exe "-#SfLo" "$UpgradeScriptPath" "$UpgradeScriptURL"
+
+    if ($LASTEXITCODE -ne 0) {
+        Write-Warning "The command 'curl.exe $UpgradeScriptURL -o $UpgradeScriptPath' exited with code ${LASTEXITCODE}`nTrying an alternative download method..."
+
+        try {
+            # Use Invoke-RestMethod instead of Invoke-WebRequest because Invoke-WebRequest breaks on
+            # some machines
+            Invoke-RestMethod -Uri $UpgradeScriptURL -OutFile $UpgradeScriptPath
+        }
+        catch {
+            Write-Output "Install Failed - could not download $UpgradeScriptURL"
+            Write-Output "The command 'Invoke-RestMethod $UpgradeScriptURL -OutFile $UpgradeScriptPath' exited with code ${LASTEXITCODE}`n"
+            return 1
+        }
+    }
+
     $C_RESET = [char]27 + "[0m"
     $C_GREEN = [char]27 + "[1;32m"
+    $C_DIM = [char]27 + "[0;2m"
 
-    Write-Output "${C_GREEN}Apify CLI ${ApifyVersion} was installed successfully!${C_RESET}"
-    Write-Output "The binary is located at ${ApifyBin}\apify.exe`n"
+    Write-Output "${C_GREEN}Apify and Actor CLI ${ApifyVersion} were installed successfully!${C_RESET}"
+    Write-Output "${C_DIM}The binaries are located at ${ApifyBin}\apify.exe and ${ApifyBin}\actor.exe${C_RESET}`n"
 
     $hasExistingOther = $false;
     try {
@@ -241,6 +262,8 @@ function Install-Apify {
             $env:PATH = $Path;
         }
 
+        # Unlike on Unix systems where we just have to symlink a file to make it just work without a reload,
+        # on Windows you _need_ to restart the running process for it to get the new path variable.
         Write-Output "To get started, restart your terminal/editor, then type `"apify`"`n"
     }
 

scripts/install/install.sh

@@ -164,8 +164,6 @@ construct_download_url() {
 }
 
 install_env=APIFY_CLI_INSTALL
-bin_env=\$$install_env/bin
-
 install_dir=${!install_env:-$HOME/.apify}
 bin_dir=$install_dir/bin
 
@@ -178,7 +176,9 @@ for executable_name in "${executable_names[@]}"; do
     download_url=$(construct_download_url "$executable_name" "$target")
     output_filename="${executable_name}"
 
-    curl --fail --location --progress-bar --output "$bin_dir/$output_filename" "$download_url" 2>/dev/null ||
+    info "Downloading $executable_name bundle for version $version and target $target"
+
+    curl --fail --location --progress-bar --output "$bin_dir/$output_filename" "$download_url" ||
         error "Failed to download $executable_name bundle for version $version and target $target (might not exist for this platform/arch combination)"
 
     chmod +x "$bin_dir/$output_filename" ||
@@ -200,161 +200,8 @@ tildify() {
     fi
 }
 
-success "Apify CLI was installed successfully to $Bold_Green$(tildify "$bin_dir/apify")"
-success "Actor CLI was installed successfully to $Bold_Green$(tildify "$bin_dir/actor")"
-
-if command -v apify >/dev/null; then
-    success "Run 'apify --help' to get started"
-    exit
-fi
-
-refresh_command=''
-
-tilde_bin_dir=$(tildify "$bin_dir")
-quoted_install_dir=\"${install_dir//\"/\\\"}\"
-
-if [[ $quoted_install_dir = \"$HOME/* ]]; then
-    quoted_install_dir=${quoted_install_dir/$HOME\//\$HOME/}
-fi
-
-if [[ -d $HOME/.local/bin ]]; then
-    # First, remove the symlinks if they exist
-    rm -f $HOME/.local/bin/apify
-    rm -f $HOME/.local/bin/actor
-    rm -f $HOME/.local/bin/apify-cli
-
-    # Symlink the three executables to /usr/local/bin
-    ln -s "$bin_dir/apify" $HOME/.local/bin/apify
-    ln -s "$bin_dir/actor" $HOME/.local/bin/actor
-    ln -s "$bin_dir/apify-cli" $HOME/.local/bin/apify-cli
-
-    info "Symlinked apify, actor, and apify-cli to $HOME/.local/bin"
-fi
-
-echo
-
-case $(basename "$SHELL") in
-fish)
-    commands=(
-        "set --export $install_env $quoted_install_dir"
-        "set --export PATH $bin_env \$PATH"
-    )
-
-    fish_config=$HOME/.config/fish/config.fish
-    tilde_fish_config=$(tildify "$fish_config")
-
-    if [[ -w $fish_config ]]; then
-        {
-            echo -e '\n# apify cli'
-
-            for command in "${commands[@]}"; do
-                echo "$command"
-            done
-        } >>"$fish_config"
-
-        info "Added \"$tilde_bin_dir\" to \$PATH in \"$tilde_fish_config\""
-
-        refresh_command="source $tilde_fish_config"
-    else
-        echo "Manually add the directory to $tilde_fish_config (or similar):"
-
-        for command in "${commands[@]}"; do
-            info_bold "  $command"
-        done
-    fi
-    ;;
-zsh)
-    commands=(
-        "export $install_env=$quoted_install_dir"
-        "export PATH=\"$bin_env:\$PATH\""
-    )
-
-    zsh_config=$HOME/.zshrc
-    tilde_zsh_config=$(tildify "$zsh_config")
-
-    if [[ -w $zsh_config ]]; then
-        {
-            echo -e '\n# apify cli'
-
-            for command in "${commands[@]}"; do
-                echo "$command"
-            done
-        } >>"$zsh_config"
-
-        info "Added \"$tilde_bin_dir\" to \$PATH in \"$tilde_zsh_config\""
-
-        refresh_command="exec $SHELL"
-    else
-        echo "Manually add the directory to $tilde_zsh_config (or similar):"
-
-        for command in "${commands[@]}"; do
-            info_bold "  $command"
-        done
-    fi
-    ;;
-bash)
-    commands=(
-        "export $install_env=$quoted_install_dir"
-        "export PATH=\"$bin_env:\$PATH\""
-    )
-
-    bash_configs=(
-        "$HOME/.bashrc"
-        "$HOME/.bash_profile"
-    )
-
-    if [[ ${XDG_CONFIG_HOME:-} ]]; then
-        bash_configs+=(
-            "$XDG_CONFIG_HOME/.bash_profile"
-            "$XDG_CONFIG_HOME/.bashrc"
-            "$XDG_CONFIG_HOME/bash_profile"
-            "$XDG_CONFIG_HOME/bashrc"
-        )
-    fi
-
-    set_manually=true
-    for bash_config in "${bash_configs[@]}"; do
-        tilde_bash_config=$(tildify "$bash_config")
-
-        if [[ -w $bash_config ]]; then
-            {
-                echo -e '\n# apify cli'
-
-                for command in "${commands[@]}"; do
-                    echo "$command"
-                done
-            } >>"$bash_config"
-
-            info "Added \"$tilde_bin_dir\" to \$PATH in \"$tilde_bash_config\""
-
-            refresh_command="source $bash_config"
-            set_manually=false
-            break
-        fi
-    done
-
-    if [[ $set_manually = true ]]; then
-        echo "Manually add the directory to $tilde_bash_config (or similar):"
-
-        for command in "${commands[@]}"; do
-            info_bold "  $command"
-        done
-    fi
-    ;;
-*)
-    echo 'Manually add the directory to ~/.bashrc (or similar):'
-    info_bold "  export $install_env=$quoted_install_dir"
-    info_bold "  export PATH=\"$bin_env:\$PATH\""
-    ;;
-esac
-
-echo
-info "To get started, run:"
-echo
-
-if [[ $refresh_command ]]; then
-    info_bold "  $refresh_command $(info "(if the shell is not automatically refreshed)")"
-fi
+success "Apify and Actor CLI $version were installed successfully!"
+info "The binaries are located at $Bold_Green$(tildify "$bin_dir/apify") ${Dim}and $Bold_Green$(tildify "$bin_dir/actor")"
 
-info_bold "  apify --help"
-echo
+# Invoke the CLI to handle shell integrations nicely
+PROVIDED_INSTALL_DIR="$install_dir" FINAL_BIN_DIR="$bin_dir" "$bin_dir/apify" install