Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 17 additions & 4 deletions packages/cli/install
Original file line number Diff line number Diff line change
Expand Up @@ -277,10 +277,23 @@ else
# Stable build: resolve version and download from GitHub Releases.

if [[ -z "$requested_version" ]]; then
version=$(curl -fsSL https://api.github.com/repos/getsentry/cli/releases/latest \
| sed -n 's/.*"tag_name": *"\([^"]*\)".*/\1/p')
if [[ -z "$version" ]]; then
die "Failed to fetch latest version" "gh-version"
# Craft publishes this app's stable version to the release registry.
# Avoid GitHub's anonymous API quota, which is shared by every user of an IP.
# Consume the full JSON response: an early parser exit can cause SIGPIPE under pipefail.
if metadata=$(curl -fsSL --max-time 10 https://release-registry.services.sentry.io/apps/sentry/latest); then
version=$(printf '%s\n' "$metadata" \
| sed -n 's/.*"version": *"\([^"]*\)".*/\1/p')
fi
if [[ ! "$version" =~ ^[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
echo -e "${MUTED}Could not resolve latest version from Sentry's release registry. Trying GitHub...${NC}" >&2
version=""
if metadata=$(curl -fsSL --max-time 10 https://api.github.com/repos/getsentry/cli/releases/latest); then
version=$(printf '%s\n' "$metadata" \
| sed -n 's/.*"tag_name": *"\([^"]*\)".*/\1/p')
fi
if [[ ! "$version" =~ ^v?[0-9]+\.[0-9]+\.[0-9]+$ ]]; then
die "Failed to fetch latest stable version from Sentry's release registry and GitHub. Retry or install a specific version with --version <version>." "resolve-version"
fi
fi
else
version="$requested_version"
Expand Down
149 changes: 149 additions & 0 deletions packages/cli/test/lib/install-script.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ describe("install script", () => {
SENTRY_CLI_NO_TELEMETRY: "1",
SENTRY_TEST_DIR: testDir,
SENTRY_TEST_INSTALL_SCRIPT: installScript,
SENTRY_TEST_GITHUB_FAIL: "22",
TMPDIR: testDir,
};

Expand All @@ -46,6 +47,30 @@ describe("install script", () => {
writeFileSync(
join(binDir, "curl"),
`#!/usr/bin/env bash
for arg in "$@"; do
case "$arg" in
https://*) url="$arg" ;;
esac
done
printf '%s\\n' "$url" >> "$SENTRY_TEST_DIR/download-urls"
case "$url" in
https://api.github.com/*)
if [[ "\${SENTRY_TEST_GITHUB_FAIL:-0}" != "0" ]]; then
echo "GitHub request failed (curl exit $SENTRY_TEST_GITHUB_FAIL)" >&2
exit "$SENTRY_TEST_GITHUB_FAIL"
fi
printf '%s\\n' "$SENTRY_TEST_GITHUB_RESPONSE"
exit 0
;;
https://release-registry.services.sentry.io/apps/sentry/latest)
if [[ "\${SENTRY_TEST_REGISTRY_FAIL:-0}" != "0" ]]; then
echo "Registry request failed (curl exit $SENTRY_TEST_REGISTRY_FAIL)" >&2
exit "$SENTRY_TEST_REGISTRY_FAIL"
fi
printf '%s\\n' "$SENTRY_TEST_REGISTRY_RESPONSE"
exit 0
;;
esac
cat <<'SCRIPT'
#!/usr/bin/env bash
set -euo pipefail
Expand Down Expand Up @@ -88,6 +113,125 @@ SCRIPT
rmSync(testDir, { recursive: true, force: true });
});

test.each([
'{"canonical":"app:sentry","version":"0.45.0"}',
'{\n "canonical": "app:sentry",\n "version": "0.45.0"\n}',
JSON.stringify(
{ version: "0.45.0", description: "x".repeat(96 * 1024) },
null,
2
),
])("installs the latest stable release when GitHub API access is blocked", (metadata) => {
env.SENTRY_TEST_REGISTRY_RESPONSE = metadata;
const result = spawnSync("bash", [installScript], {
env,
encoding: "utf8",
timeout: 10_000,
});

expect(result.status, result.stdout + result.stderr).toBe(0);
expect(recorded("download-urls")).toEqual([
"https://release-registry.services.sentry.io/apps/sentry/latest",
expect.stringMatching(
/^https:\/\/github\.com\/getsentry\/cli\/releases\/download\/0\.45\.0\/sentry-.+\.gz$/
),
]);
expect(existsSync(join(installDir, "sentry"))).toBe(true);
});

test.each([
{ name: "HTTP error", metadata: "", failure: "22" },
{ name: "timeout", metadata: "", failure: "28" },
{ name: "missing version", metadata: "{}" },
{ name: "non-JSON response", metadata: "<html>Unavailable</html>" },
{ name: "nonstable version", metadata: '{"version":"nightly"}' },
])("falls back to GitHub after a registry $name", ({ metadata, failure }) => {
env.SENTRY_TEST_REGISTRY_RESPONSE = metadata;
env.SENTRY_TEST_REGISTRY_FAIL = failure;
env.SENTRY_TEST_GITHUB_FAIL = "0";
env.SENTRY_TEST_GITHUB_RESPONSE = '{"tag_name":"0.45.0"}';
const result = spawnSync("bash", [installScript], {
env,
encoding: "utf8",
timeout: 10_000,
});

expect(result.status, result.stdout + result.stderr).toBe(0);
expect(result.stderr).toContain("Trying GitHub");
expect(recorded("download-urls")).toEqual([
"https://release-registry.services.sentry.io/apps/sentry/latest",
"https://api.github.com/repos/getsentry/cli/releases/latest",
expect.stringMatching(
/^https:\/\/github\.com\/getsentry\/cli\/releases\/download\/0\.45\.0\/sentry-.+\.gz$/
),
]);
expect(existsSync(join(installDir, "sentry"))).toBe(true);
});

test.each([
{ name: "a leading v", metadata: '{\n "tag_name": "v0.45.0"\n}' },
{
name: "large release metadata",
metadata: JSON.stringify(
{ tag_name: "0.45.0", body: "x".repeat(96 * 1024) },
null,
2
),
},
])("accepts a GitHub release with $name", ({ metadata }) => {
env.SENTRY_TEST_REGISTRY_FAIL = "22";
env.SENTRY_TEST_GITHUB_FAIL = "0";
env.SENTRY_TEST_GITHUB_RESPONSE = metadata;
const result = spawnSync("bash", [installScript], {
env,
encoding: "utf8",
timeout: 10_000,
});

expect(result.status, result.stdout + result.stderr).toBe(0);
expect(recorded("download-urls").at(-1)).toMatch(
/^https:\/\/github\.com\/getsentry\/cli\/releases\/download\/0\.45\.0\/sentry-.+\.gz$/
);
expect(existsSync(join(installDir, "sentry"))).toBe(true);
});

test.each([
{ name: "HTTP error", metadata: "", failure: "22" },
{ name: "timeout", metadata: "", failure: "28" },
{ name: "missing tag", metadata: "{}", failure: "0" },
{
name: "non-JSON response",
metadata: "<html>Unavailable</html>",
failure: "0",
},
{ name: "nonstable tag", metadata: '{"tag_name":"nightly"}', failure: "0" },
])("stops when the registry and GitHub fail: $name", ({
metadata,
failure,
}) => {
env.SENTRY_TEST_REGISTRY_FAIL = "22";
env.SENTRY_TEST_GITHUB_RESPONSE = metadata;
env.SENTRY_TEST_GITHUB_FAIL = failure;
const result = spawnSync("bash", [installScript], {
env,
encoding: "utf8",
timeout: 10_000,
});

expect(result.status).toBe(1);
expect(result.stderr).toContain(
"Failed to fetch latest stable version from Sentry's release registry and GitHub"
);
expect(result.stderr).toContain("--version <version>");
expect(result.stderr).not.toContain("Unexpected failure at line");
expect(recorded("download-urls")).toEqual([
"https://release-registry.services.sentry.io/apps/sentry/latest",
"https://api.github.com/repos/getsentry/cli/releases/latest",
]);
expect(recorded("setup-args")).toEqual([]);
expect(existsSync(join(installDir, "sentry"))).toBe(false);
});

function recorded(name: string): string[] {
const path = join(testDir, name);
return existsSync(path)
Expand Down Expand Up @@ -169,6 +313,11 @@ process.exitCode = result.status ?? 1;
]);
expect(recorded("post-args")).toEqual([]);
expect(existsSync(join(installDir, "sentry"))).toBe(true);
expect(recorded("download-urls")).toEqual([
expect.stringMatching(
/^https:\/\/github\.com\/getsentry\/cli\/releases\/download\/0\.31\.0\/sentry-.+\.gz$/
),
]);
});

test("connects setup to the controlling terminal without launching another process", () => {
Expand Down
Loading