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
216 changes: 216 additions & 0 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
import { assert, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as Option from "effect/Option";
import { ChildProcessSpawner } from "effect/unstable/process";
import {
type VcsError,
VcsProcessExitError,
VcsProcessSpawnError,
VcsProcessTimeoutError,
} from "@t3tools/contracts";

import * as VcsProcess from "../vcs/VcsProcess.ts";
import * as AzureDevOps from "./AzureDevOpsSourceControlProvider.ts";
import { probeSourceControlProvider } from "./SourceControlProviderDiscovery.ts";

const processOutput = (
stdout: string,
options?: {
readonly stderr?: string;
readonly exitCode?: ChildProcessSpawner.ExitCode;
},
): VcsProcess.VcsProcessOutput => ({
exitCode: options?.exitCode ?? ChildProcessSpawner.ExitCode(0),
stdout,
stderr: options?.stderr ?? "",
stdoutTruncated: false,
stderrTruncated: false,
});

interface CapturingProcess {
readonly process: VcsProcess.VcsProcess["Service"];
readonly calls: ReadonlyArray<VcsProcess.VcsProcessInput>;
}

const makeProcess = (
run: (input: VcsProcess.VcsProcessInput) => Effect.Effect<VcsProcess.VcsProcessOutput, VcsError>,
): CapturingProcess => {
const calls: VcsProcess.VcsProcessInput[] = [];
return {
calls,
process: {
run: (input) => {
calls.push(input);
return run(input);
},
},
};
};

const isVersionCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "--version";
const isAuthCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "account";

it.effect(
"reports Azure CLI as available and still runs the auth probe when `--version` times out",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.deepStrictEqual(item.auth.account, Option.some("azure-user@example.com"));
assert.ok(
calls.some(isAuthCall),
"expected an `account show` auth probe to run after a slow `--version`",
);
}),
);

it.effect(
"reports Azure CLI as missing and skips the auth probe when `--version` cannot spawn",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessSpawnError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
cause: Object.assign(new Error("spawn az ENOENT"), { code: "ENOENT" }),
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "missing");
assert.strictEqual(item.auth.status, "unknown");
assert.strictEqual(calls.length, 1);
assert.strictEqual(calls[0]?.args[0], "--version");
}),
);

it.effect(
"raises the `--version` probe timeout above 15s and reports the version on the happy path",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.succeed(processOutput("azure-cli 2.87.0\n"));
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

const versionCall = calls.find(isVersionCall);
assert.ok(versionCall, "expected a `--version` probe to run");
assert.ok(
(versionCall.timeoutMs ?? 0) >= 15_000,
`expected the \`--version\` probe timeout to be >= 15000ms, got ${String(versionCall.timeoutMs)}`,
);
assert.deepStrictEqual(item.version, Option.some("azure-cli 2.87.0"));
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
}),
);

it.effect(
"reports available but unauthenticated when `--version` times out and `account show` exits non-zero",
() =>
Effect.gen(function* () {
const { process } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(
processOutput("", {
stderr: "ERROR: Please run 'az login' to setup account.",
exitCode: ChildProcessSpawner.ExitCode(1),
}),
);
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "unauthenticated");
}),
);

it.effect(
"treats a non-spawn `--version` failure (e.g. a non-zero exit) as present and still runs the auth probe",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessExitError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
exitCode: 1,
detail: "Process exited with a non-zero status.",
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

// Only a genuine spawn failure means "missing"; any other runtime failure of
// `--version` (here a non-zero exit) means the CLI is present, so it stays
// available and the auth probe still runs. (issue #4)
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.ok(
calls.some(isAuthCall),
"expected the auth probe to run after a non-spawn `--version` failure",
);
}),
);
28 changes: 20 additions & 8 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,11 @@ import * as Option from "effect/Option";
import type * as SourceControlProvider from "./SourceControlProvider.ts";
import type * as VcsProcess from "../vcs/VcsProcess.ts";

// `az --version` on Windows routinely takes 6-8s (Python startup + Azure CLI's
// "updates available" check), so the old 5s cap misclassified a present-but-slow
// CLI as missing. Raise the discovery probe budget well above that. (issue #4)
const CLI_PROBE_TIMEOUT_MS = 15_000;

export interface SourceControlAuthProbeInput {
readonly stdout: string;
readonly stderr: string;
Expand DownExpand Up@@ -167,7 +172,7 @@ function probeCli(input: {
command: input.spec.executable,
args: input.spec.versionArgs,
cwd: input.cwd,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand All@@ -186,17 +191,24 @@ function probeCli(input: {
detail: Option.none<string>(),
}) satisfies DiscoveryProbeResult,
),
Effect.catch((cause) =>
Effect.succeed({
Effect.catch((cause) => {
// Only a genuine spawn failure (e.g. ENOENT) means the CLI is absent, so
// that is the sole case that reports "missing" and shows the install hint.
// Any other failure (timeout, non-zero exit, etc.) means the CLI is present
// but the version probe was slow/noisy; keep it "available" so
// `probeSourceControlProvider` still runs the fast `account show` auth
// probe instead of short-circuiting to the install hint. (issue #4)
const status = cause._tag === "VcsProcessSpawnError" ? "missing" : "available";
return Effect.succeed({
kind: input.spec.kind,
label: input.spec.label,
executable: input.spec.executable,
status: "missing" as const,
status,
version: Option.none<string>(),
installHint: input.spec.installHint,
detail: detailFromCause(cause),
} satisfies DiscoveryProbeResult),
),
} satisfies DiscoveryProbeResult);
}),
);
}

Expand DownExpand Up@@ -244,7 +256,7 @@ export function probeSourceControlProvider(input: {
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand DownExpand Up@@ -287,7 +299,7 @@ export const refineUnknownRemoteProvider = Effect.fn("refineUnknownRemoteProvide
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
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
216 changes: 216 additions & 0 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
import { assert, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as Option from "effect/Option";
import { ChildProcessSpawner } from "effect/unstable/process";
import {
type VcsError,
VcsProcessExitError,
VcsProcessSpawnError,
VcsProcessTimeoutError,
} from "@t3tools/contracts";

import * as VcsProcess from "../vcs/VcsProcess.ts";
import * as AzureDevOps from "./AzureDevOpsSourceControlProvider.ts";
import { probeSourceControlProvider } from "./SourceControlProviderDiscovery.ts";

const processOutput = (
stdout: string,
options?: {
readonly stderr?: string;
readonly exitCode?: ChildProcessSpawner.ExitCode;
},
): VcsProcess.VcsProcessOutput => ({
exitCode: options?.exitCode ?? ChildProcessSpawner.ExitCode(0),
stdout,
stderr: options?.stderr ?? "",
stdoutTruncated: false,
stderrTruncated: false,
});

interface CapturingProcess {
readonly process: VcsProcess.VcsProcess["Service"];
readonly calls: ReadonlyArray<VcsProcess.VcsProcessInput>;
}

const makeProcess = (
run: (input: VcsProcess.VcsProcessInput) => Effect.Effect<VcsProcess.VcsProcessOutput, VcsError>,
): CapturingProcess => {
const calls: VcsProcess.VcsProcessInput[] = [];
return {
calls,
process: {
run: (input) => {
calls.push(input);
return run(input);
},
},
};
};

const isVersionCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "--version";
const isAuthCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "account";

it.effect(
"reports Azure CLI as available and still runs the auth probe when `--version` times out",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.deepStrictEqual(item.auth.account, Option.some("azure-user@example.com"));
assert.ok(
calls.some(isAuthCall),
"expected an `account show` auth probe to run after a slow `--version`",
);
}),
);

it.effect(
"reports Azure CLI as missing and skips the auth probe when `--version` cannot spawn",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessSpawnError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
cause: Object.assign(new Error("spawn az ENOENT"), { code: "ENOENT" }),
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "missing");
assert.strictEqual(item.auth.status, "unknown");
assert.strictEqual(calls.length, 1);
assert.strictEqual(calls[0]?.args[0], "--version");
}),
);

it.effect(
"raises the `--version` probe timeout above 15s and reports the version on the happy path",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.succeed(processOutput("azure-cli 2.87.0\n"));
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

const versionCall = calls.find(isVersionCall);
assert.ok(versionCall, "expected a `--version` probe to run");
assert.ok(
(versionCall.timeoutMs ?? 0) >= 15_000,
`expected the \`--version\` probe timeout to be >= 15000ms, got ${String(versionCall.timeoutMs)}`,
);
assert.deepStrictEqual(item.version, Option.some("azure-cli 2.87.0"));
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
}),
);

it.effect(
"reports available but unauthenticated when `--version` times out and `account show` exits non-zero",
() =>
Effect.gen(function* () {
const { process } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(
processOutput("", {
stderr: "ERROR: Please run 'az login' to setup account.",
exitCode: ChildProcessSpawner.ExitCode(1),
}),
);
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "unauthenticated");
}),
);

it.effect(
"treats a non-spawn `--version` failure (e.g. a non-zero exit) as present and still runs the auth probe",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessExitError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
exitCode: 1,
detail: "Process exited with a non-zero status.",
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

// Only a genuine spawn failure means "missing"; any other runtime failure of
// `--version` (here a non-zero exit) means the CLI is present, so it stays
// available and the auth probe still runs. (issue #4)
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.ok(
calls.some(isAuthCall),
"expected the auth probe to run after a non-spawn `--version` failure",
);
}),
);
28 changes: 20 additions & 8 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,11 @@ import * as Option from "effect/Option";
import type * as SourceControlProvider from "./SourceControlProvider.ts";
import type * as VcsProcess from "../vcs/VcsProcess.ts";

// `az --version` on Windows routinely takes 6-8s (Python startup + Azure CLI's
// "updates available" check), so the old 5s cap misclassified a present-but-slow
// CLI as missing. Raise the discovery probe budget well above that. (issue #4)
const CLI_PROBE_TIMEOUT_MS = 15_000;

export interface SourceControlAuthProbeInput {
readonly stdout: string;
readonly stderr: string;
Expand DownExpand Up@@ -167,7 +172,7 @@ function probeCli(input: {
command: input.spec.executable,
args: input.spec.versionArgs,
cwd: input.cwd,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand All@@ -186,17 +191,24 @@ function probeCli(input: {
detail: Option.none<string>(),
}) satisfies DiscoveryProbeResult,
),
Effect.catch((cause) =>
Effect.succeed({
Effect.catch((cause) => {
// Only a genuine spawn failure (e.g. ENOENT) means the CLI is absent, so
// that is the sole case that reports "missing" and shows the install hint.
// Any other failure (timeout, non-zero exit, etc.) means the CLI is present
// but the version probe was slow/noisy; keep it "available" so
// `probeSourceControlProvider` still runs the fast `account show` auth
// probe instead of short-circuiting to the install hint. (issue #4)
const status = cause._tag === "VcsProcessSpawnError" ? "missing" : "available";
return Effect.succeed({
kind: input.spec.kind,
label: input.spec.label,
executable: input.spec.executable,
status: "missing" as const,
status,
version: Option.none<string>(),
installHint: input.spec.installHint,
detail: detailFromCause(cause),
} satisfies DiscoveryProbeResult),
),
} satisfies DiscoveryProbeResult);
}),
);
}

Expand DownExpand Up@@ -244,7 +256,7 @@ export function probeSourceControlProvider(input: {
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand DownExpand Up@@ -287,7 +299,7 @@ export const refineUnknownRemoteProvider = Effect.fn("refineUnknownRemoteProvide
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
216 changes: 216 additions & 0 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
import { assert, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as Option from "effect/Option";
import { ChildProcessSpawner } from "effect/unstable/process";
import {
type VcsError,
VcsProcessExitError,
VcsProcessSpawnError,
VcsProcessTimeoutError,
} from "@t3tools/contracts";

import * as VcsProcess from "../vcs/VcsProcess.ts";
import * as AzureDevOps from "./AzureDevOpsSourceControlProvider.ts";
import { probeSourceControlProvider } from "./SourceControlProviderDiscovery.ts";

const processOutput = (
stdout: string,
options?: {
readonly stderr?: string;
readonly exitCode?: ChildProcessSpawner.ExitCode;
},
): VcsProcess.VcsProcessOutput => ({
exitCode: options?.exitCode ?? ChildProcessSpawner.ExitCode(0),
stdout,
stderr: options?.stderr ?? "",
stdoutTruncated: false,
stderrTruncated: false,
});

interface CapturingProcess {
readonly process: VcsProcess.VcsProcess["Service"];
readonly calls: ReadonlyArray<VcsProcess.VcsProcessInput>;
}

const makeProcess = (
run: (input: VcsProcess.VcsProcessInput) => Effect.Effect<VcsProcess.VcsProcessOutput, VcsError>,
): CapturingProcess => {
const calls: VcsProcess.VcsProcessInput[] = [];
return {
calls,
process: {
run: (input) => {
calls.push(input);
return run(input);
},
},
};
};

const isVersionCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "--version";
const isAuthCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "account";

it.effect(
"reports Azure CLI as available and still runs the auth probe when `--version` times out",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.deepStrictEqual(item.auth.account, Option.some("azure-user@example.com"));
assert.ok(
calls.some(isAuthCall),
"expected an `account show` auth probe to run after a slow `--version`",
);
}),
);

it.effect(
"reports Azure CLI as missing and skips the auth probe when `--version` cannot spawn",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessSpawnError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
cause: Object.assign(new Error("spawn az ENOENT"), { code: "ENOENT" }),
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "missing");
assert.strictEqual(item.auth.status, "unknown");
assert.strictEqual(calls.length, 1);
assert.strictEqual(calls[0]?.args[0], "--version");
}),
);

it.effect(
"raises the `--version` probe timeout above 15s and reports the version on the happy path",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.succeed(processOutput("azure-cli 2.87.0\n"));
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

const versionCall = calls.find(isVersionCall);
assert.ok(versionCall, "expected a `--version` probe to run");
assert.ok(
(versionCall.timeoutMs ?? 0) >= 15_000,
`expected the \`--version\` probe timeout to be >= 15000ms, got ${String(versionCall.timeoutMs)}`,
);
assert.deepStrictEqual(item.version, Option.some("azure-cli 2.87.0"));
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
}),
);

it.effect(
"reports available but unauthenticated when `--version` times out and `account show` exits non-zero",
() =>
Effect.gen(function* () {
const { process } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(
processOutput("", {
stderr: "ERROR: Please run 'az login' to setup account.",
exitCode: ChildProcessSpawner.ExitCode(1),
}),
);
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "unauthenticated");
}),
);

it.effect(
"treats a non-spawn `--version` failure (e.g. a non-zero exit) as present and still runs the auth probe",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessExitError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
exitCode: 1,
detail: "Process exited with a non-zero status.",
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

// Only a genuine spawn failure means "missing"; any other runtime failure of
// `--version` (here a non-zero exit) means the CLI is present, so it stays
// available and the auth probe still runs. (issue #4)
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.ok(
calls.some(isAuthCall),
"expected the auth probe to run after a non-spawn `--version` failure",
);
}),
);
28 changes: 20 additions & 8 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,11 @@ import * as Option from "effect/Option";
import type * as SourceControlProvider from "./SourceControlProvider.ts";
import type * as VcsProcess from "../vcs/VcsProcess.ts";

// `az --version` on Windows routinely takes 6-8s (Python startup + Azure CLI's
// "updates available" check), so the old 5s cap misclassified a present-but-slow
// CLI as missing. Raise the discovery probe budget well above that. (issue #4)
const CLI_PROBE_TIMEOUT_MS = 15_000;

export interface SourceControlAuthProbeInput {
readonly stdout: string;
readonly stderr: string;
Expand DownExpand Up@@ -167,7 +172,7 @@ function probeCli(input: {
command: input.spec.executable,
args: input.spec.versionArgs,
cwd: input.cwd,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand All@@ -186,17 +191,24 @@ function probeCli(input: {
detail: Option.none<string>(),
}) satisfies DiscoveryProbeResult,
),
Effect.catch((cause) =>
Effect.succeed({
Effect.catch((cause) => {
// Only a genuine spawn failure (e.g. ENOENT) means the CLI is absent, so
// that is the sole case that reports "missing" and shows the install hint.
// Any other failure (timeout, non-zero exit, etc.) means the CLI is present
// but the version probe was slow/noisy; keep it "available" so
// `probeSourceControlProvider` still runs the fast `account show` auth
// probe instead of short-circuiting to the install hint. (issue #4)
const status = cause._tag === "VcsProcessSpawnError" ? "missing" : "available";
return Effect.succeed({
kind: input.spec.kind,
label: input.spec.label,
executable: input.spec.executable,
status: "missing" as const,
status,
version: Option.none<string>(),
installHint: input.spec.installHint,
detail: detailFromCause(cause),
} satisfies DiscoveryProbeResult),
),
} satisfies DiscoveryProbeResult);
}),
);
}

Expand DownExpand Up@@ -244,7 +256,7 @@ export function probeSourceControlProvider(input: {
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand DownExpand Up@@ -287,7 +299,7 @@ export const refineUnknownRemoteProvider = Effect.fn("refineUnknownRemoteProvide
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
216 changes: 216 additions & 0 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
import { assert, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as Option from "effect/Option";
import { ChildProcessSpawner } from "effect/unstable/process";
import {
type VcsError,
VcsProcessExitError,
VcsProcessSpawnError,
VcsProcessTimeoutError,
} from "@t3tools/contracts";

import * as VcsProcess from "../vcs/VcsProcess.ts";
import * as AzureDevOps from "./AzureDevOpsSourceControlProvider.ts";
import { probeSourceControlProvider } from "./SourceControlProviderDiscovery.ts";

const processOutput = (
stdout: string,
options?: {
readonly stderr?: string;
readonly exitCode?: ChildProcessSpawner.ExitCode;
},
): VcsProcess.VcsProcessOutput => ({
exitCode: options?.exitCode ?? ChildProcessSpawner.ExitCode(0),
stdout,
stderr: options?.stderr ?? "",
stdoutTruncated: false,
stderrTruncated: false,
});

interface CapturingProcess {
readonly process: VcsProcess.VcsProcess["Service"];
readonly calls: ReadonlyArray<VcsProcess.VcsProcessInput>;
}

const makeProcess = (
run: (input: VcsProcess.VcsProcessInput) => Effect.Effect<VcsProcess.VcsProcessOutput, VcsError>,
): CapturingProcess => {
const calls: VcsProcess.VcsProcessInput[] = [];
return {
calls,
process: {
run: (input) => {
calls.push(input);
return run(input);
},
},
};
};

const isVersionCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "--version";
const isAuthCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "account";

it.effect(
"reports Azure CLI as available and still runs the auth probe when `--version` times out",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.deepStrictEqual(item.auth.account, Option.some("azure-user@example.com"));
assert.ok(
calls.some(isAuthCall),
"expected an `account show` auth probe to run after a slow `--version`",
);
}),
);

it.effect(
"reports Azure CLI as missing and skips the auth probe when `--version` cannot spawn",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessSpawnError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
cause: Object.assign(new Error("spawn az ENOENT"), { code: "ENOENT" }),
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "missing");
assert.strictEqual(item.auth.status, "unknown");
assert.strictEqual(calls.length, 1);
assert.strictEqual(calls[0]?.args[0], "--version");
}),
);

it.effect(
"raises the `--version` probe timeout above 15s and reports the version on the happy path",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.succeed(processOutput("azure-cli 2.87.0\n"));
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

const versionCall = calls.find(isVersionCall);
assert.ok(versionCall, "expected a `--version` probe to run");
assert.ok(
(versionCall.timeoutMs ?? 0) >= 15_000,
`expected the \`--version\` probe timeout to be >= 15000ms, got ${String(versionCall.timeoutMs)}`,
);
assert.deepStrictEqual(item.version, Option.some("azure-cli 2.87.0"));
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
}),
);

it.effect(
"reports available but unauthenticated when `--version` times out and `account show` exits non-zero",
() =>
Effect.gen(function* () {
const { process } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(
processOutput("", {
stderr: "ERROR: Please run 'az login' to setup account.",
exitCode: ChildProcessSpawner.ExitCode(1),
}),
);
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "unauthenticated");
}),
);

it.effect(
"treats a non-spawn `--version` failure (e.g. a non-zero exit) as present and still runs the auth probe",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessExitError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
exitCode: 1,
detail: "Process exited with a non-zero status.",
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

// Only a genuine spawn failure means "missing"; any other runtime failure of
// `--version` (here a non-zero exit) means the CLI is present, so it stays
// available and the auth probe still runs. (issue #4)
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.ok(
calls.some(isAuthCall),
"expected the auth probe to run after a non-spawn `--version` failure",
);
}),
);
28 changes: 20 additions & 8 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,11 @@ import * as Option from "effect/Option";
import type * as SourceControlProvider from "./SourceControlProvider.ts";
import type * as VcsProcess from "../vcs/VcsProcess.ts";

// `az --version` on Windows routinely takes 6-8s (Python startup + Azure CLI's
// "updates available" check), so the old 5s cap misclassified a present-but-slow
// CLI as missing. Raise the discovery probe budget well above that. (issue #4)
const CLI_PROBE_TIMEOUT_MS = 15_000;

export interface SourceControlAuthProbeInput {
readonly stdout: string;
readonly stderr: string;
Expand DownExpand Up@@ -167,7 +172,7 @@ function probeCli(input: {
command: input.spec.executable,
args: input.spec.versionArgs,
cwd: input.cwd,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand All@@ -186,17 +191,24 @@ function probeCli(input: {
detail: Option.none<string>(),
}) satisfies DiscoveryProbeResult,
),
Effect.catch((cause) =>
Effect.succeed({
Effect.catch((cause) => {
// Only a genuine spawn failure (e.g. ENOENT) means the CLI is absent, so
// that is the sole case that reports "missing" and shows the install hint.
// Any other failure (timeout, non-zero exit, etc.) means the CLI is present
// but the version probe was slow/noisy; keep it "available" so
// `probeSourceControlProvider` still runs the fast `account show` auth
// probe instead of short-circuiting to the install hint. (issue #4)
const status = cause._tag === "VcsProcessSpawnError" ? "missing" : "available";
return Effect.succeed({
kind: input.spec.kind,
label: input.spec.label,
executable: input.spec.executable,
status: "missing" as const,
status,
version: Option.none<string>(),
installHint: input.spec.installHint,
detail: detailFromCause(cause),
} satisfies DiscoveryProbeResult),
),
} satisfies DiscoveryProbeResult);
}),
);
}

Expand DownExpand Up@@ -244,7 +256,7 @@ export function probeSourceControlProvider(input: {
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand DownExpand Up@@ -287,7 +299,7 @@ export const refineUnknownRemoteProvider = Effect.fn("refineUnknownRemoteProvide
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
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
216 changes: 216 additions & 0 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
import { assert, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as Option from "effect/Option";
import { ChildProcessSpawner } from "effect/unstable/process";
import {
type VcsError,
VcsProcessExitError,
VcsProcessSpawnError,
VcsProcessTimeoutError,
} from "@t3tools/contracts";

import * as VcsProcess from "../vcs/VcsProcess.ts";
import * as AzureDevOps from "./AzureDevOpsSourceControlProvider.ts";
import { probeSourceControlProvider } from "./SourceControlProviderDiscovery.ts";

const processOutput = (
stdout: string,
options?: {
readonly stderr?: string;
readonly exitCode?: ChildProcessSpawner.ExitCode;
},
): VcsProcess.VcsProcessOutput => ({
exitCode: options?.exitCode ?? ChildProcessSpawner.ExitCode(0),
stdout,
stderr: options?.stderr ?? "",
stdoutTruncated: false,
stderrTruncated: false,
});

interface CapturingProcess {
readonly process: VcsProcess.VcsProcess["Service"];
readonly calls: ReadonlyArray<VcsProcess.VcsProcessInput>;
}

const makeProcess = (
run: (input: VcsProcess.VcsProcessInput) => Effect.Effect<VcsProcess.VcsProcessOutput, VcsError>,
): CapturingProcess => {
const calls: VcsProcess.VcsProcessInput[] = [];
return {
calls,
process: {
run: (input) => {
calls.push(input);
return run(input);
},
},
};
};

const isVersionCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "--version";
const isAuthCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "account";

it.effect(
"reports Azure CLI as available and still runs the auth probe when `--version` times out",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.deepStrictEqual(item.auth.account, Option.some("azure-user@example.com"));
assert.ok(
calls.some(isAuthCall),
"expected an `account show` auth probe to run after a slow `--version`",
);
}),
);

it.effect(
"reports Azure CLI as missing and skips the auth probe when `--version` cannot spawn",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessSpawnError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
cause: Object.assign(new Error("spawn az ENOENT"), { code: "ENOENT" }),
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "missing");
assert.strictEqual(item.auth.status, "unknown");
assert.strictEqual(calls.length, 1);
assert.strictEqual(calls[0]?.args[0], "--version");
}),
);

it.effect(
"raises the `--version` probe timeout above 15s and reports the version on the happy path",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.succeed(processOutput("azure-cli 2.87.0\n"));
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

const versionCall = calls.find(isVersionCall);
assert.ok(versionCall, "expected a `--version` probe to run");
assert.ok(
(versionCall.timeoutMs ?? 0) >= 15_000,
`expected the \`--version\` probe timeout to be >= 15000ms, got ${String(versionCall.timeoutMs)}`,
);
assert.deepStrictEqual(item.version, Option.some("azure-cli 2.87.0"));
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
}),
);

it.effect(
"reports available but unauthenticated when `--version` times out and `account show` exits non-zero",
() =>
Effect.gen(function* () {
const { process } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(
processOutput("", {
stderr: "ERROR: Please run 'az login' to setup account.",
exitCode: ChildProcessSpawner.ExitCode(1),
}),
);
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "unauthenticated");
}),
);

it.effect(
"treats a non-spawn `--version` failure (e.g. a non-zero exit) as present and still runs the auth probe",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessExitError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
exitCode: 1,
detail: "Process exited with a non-zero status.",
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

// Only a genuine spawn failure means "missing"; any other runtime failure of
// `--version` (here a non-zero exit) means the CLI is present, so it stays
// available and the auth probe still runs. (issue #4)
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.ok(
calls.some(isAuthCall),
"expected the auth probe to run after a non-spawn `--version` failure",
);
}),
);
28 changes: 20 additions & 8 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,11 @@ import * as Option from "effect/Option";
import type * as SourceControlProvider from "./SourceControlProvider.ts";
import type * as VcsProcess from "../vcs/VcsProcess.ts";

// `az --version` on Windows routinely takes 6-8s (Python startup + Azure CLI's
// "updates available" check), so the old 5s cap misclassified a present-but-slow
// CLI as missing. Raise the discovery probe budget well above that. (issue #4)
const CLI_PROBE_TIMEOUT_MS = 15_000;

export interface SourceControlAuthProbeInput {
readonly stdout: string;
readonly stderr: string;
Expand DownExpand Up@@ -167,7 +172,7 @@ function probeCli(input: {
command: input.spec.executable,
args: input.spec.versionArgs,
cwd: input.cwd,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand All@@ -186,17 +191,24 @@ function probeCli(input: {
detail: Option.none<string>(),
}) satisfies DiscoveryProbeResult,
),
Effect.catch((cause) =>
Effect.succeed({
Effect.catch((cause) => {
// Only a genuine spawn failure (e.g. ENOENT) means the CLI is absent, so
// that is the sole case that reports "missing" and shows the install hint.
// Any other failure (timeout, non-zero exit, etc.) means the CLI is present
// but the version probe was slow/noisy; keep it "available" so
// `probeSourceControlProvider` still runs the fast `account show` auth
// probe instead of short-circuiting to the install hint. (issue #4)
const status = cause._tag === "VcsProcessSpawnError" ? "missing" : "available";
return Effect.succeed({
kind: input.spec.kind,
label: input.spec.label,
executable: input.spec.executable,
status: "missing" as const,
status,
version: Option.none<string>(),
installHint: input.spec.installHint,
detail: detailFromCause(cause),
} satisfies DiscoveryProbeResult),
),
} satisfies DiscoveryProbeResult);
}),
);
}

Expand DownExpand Up@@ -244,7 +256,7 @@ export function probeSourceControlProvider(input: {
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand DownExpand Up@@ -287,7 +299,7 @@ export const refineUnknownRemoteProvider = Effect.fn("refineUnknownRemoteProvide
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
216 changes: 216 additions & 0 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
import { assert, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as Option from "effect/Option";
import { ChildProcessSpawner } from "effect/unstable/process";
import {
type VcsError,
VcsProcessExitError,
VcsProcessSpawnError,
VcsProcessTimeoutError,
} from "@t3tools/contracts";

import * as VcsProcess from "../vcs/VcsProcess.ts";
import * as AzureDevOps from "./AzureDevOpsSourceControlProvider.ts";
import { probeSourceControlProvider } from "./SourceControlProviderDiscovery.ts";

const processOutput = (
stdout: string,
options?: {
readonly stderr?: string;
readonly exitCode?: ChildProcessSpawner.ExitCode;
},
): VcsProcess.VcsProcessOutput => ({
exitCode: options?.exitCode ?? ChildProcessSpawner.ExitCode(0),
stdout,
stderr: options?.stderr ?? "",
stdoutTruncated: false,
stderrTruncated: false,
});

interface CapturingProcess {
readonly process: VcsProcess.VcsProcess["Service"];
readonly calls: ReadonlyArray<VcsProcess.VcsProcessInput>;
}

const makeProcess = (
run: (input: VcsProcess.VcsProcessInput) => Effect.Effect<VcsProcess.VcsProcessOutput, VcsError>,
): CapturingProcess => {
const calls: VcsProcess.VcsProcessInput[] = [];
return {
calls,
process: {
run: (input) => {
calls.push(input);
return run(input);
},
},
};
};

const isVersionCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "--version";
const isAuthCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "account";

it.effect(
"reports Azure CLI as available and still runs the auth probe when `--version` times out",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.deepStrictEqual(item.auth.account, Option.some("azure-user@example.com"));
assert.ok(
calls.some(isAuthCall),
"expected an `account show` auth probe to run after a slow `--version`",
);
}),
);

it.effect(
"reports Azure CLI as missing and skips the auth probe when `--version` cannot spawn",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessSpawnError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
cause: Object.assign(new Error("spawn az ENOENT"), { code: "ENOENT" }),
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "missing");
assert.strictEqual(item.auth.status, "unknown");
assert.strictEqual(calls.length, 1);
assert.strictEqual(calls[0]?.args[0], "--version");
}),
);

it.effect(
"raises the `--version` probe timeout above 15s and reports the version on the happy path",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.succeed(processOutput("azure-cli 2.87.0\n"));
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

const versionCall = calls.find(isVersionCall);
assert.ok(versionCall, "expected a `--version` probe to run");
assert.ok(
(versionCall.timeoutMs ?? 0) >= 15_000,
`expected the \`--version\` probe timeout to be >= 15000ms, got ${String(versionCall.timeoutMs)}`,
);
assert.deepStrictEqual(item.version, Option.some("azure-cli 2.87.0"));
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
}),
);

it.effect(
"reports available but unauthenticated when `--version` times out and `account show` exits non-zero",
() =>
Effect.gen(function* () {
const { process } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(
processOutput("", {
stderr: "ERROR: Please run 'az login' to setup account.",
exitCode: ChildProcessSpawner.ExitCode(1),
}),
);
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "unauthenticated");
}),
);

it.effect(
"treats a non-spawn `--version` failure (e.g. a non-zero exit) as present and still runs the auth probe",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessExitError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
exitCode: 1,
detail: "Process exited with a non-zero status.",
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

// Only a genuine spawn failure means "missing"; any other runtime failure of
// `--version` (here a non-zero exit) means the CLI is present, so it stays
// available and the auth probe still runs. (issue #4)
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.ok(
calls.some(isAuthCall),
"expected the auth probe to run after a non-spawn `--version` failure",
);
}),
);
28 changes: 20 additions & 8 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,11 @@ import * as Option from "effect/Option";
import type * as SourceControlProvider from "./SourceControlProvider.ts";
import type * as VcsProcess from "../vcs/VcsProcess.ts";

// `az --version` on Windows routinely takes 6-8s (Python startup + Azure CLI's
// "updates available" check), so the old 5s cap misclassified a present-but-slow
// CLI as missing. Raise the discovery probe budget well above that. (issue #4)
const CLI_PROBE_TIMEOUT_MS = 15_000;

export interface SourceControlAuthProbeInput {
readonly stdout: string;
readonly stderr: string;
Expand DownExpand Up@@ -167,7 +172,7 @@ function probeCli(input: {
command: input.spec.executable,
args: input.spec.versionArgs,
cwd: input.cwd,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand All@@ -186,17 +191,24 @@ function probeCli(input: {
detail: Option.none<string>(),
}) satisfies DiscoveryProbeResult,
),
Effect.catch((cause) =>
Effect.succeed({
Effect.catch((cause) => {
// Only a genuine spawn failure (e.g. ENOENT) means the CLI is absent, so
// that is the sole case that reports "missing" and shows the install hint.
// Any other failure (timeout, non-zero exit, etc.) means the CLI is present
// but the version probe was slow/noisy; keep it "available" so
// `probeSourceControlProvider` still runs the fast `account show` auth
// probe instead of short-circuiting to the install hint. (issue #4)
const status = cause._tag === "VcsProcessSpawnError" ? "missing" : "available";
return Effect.succeed({
kind: input.spec.kind,
label: input.spec.label,
executable: input.spec.executable,
status: "missing" as const,
status,
version: Option.none<string>(),
installHint: input.spec.installHint,
detail: detailFromCause(cause),
} satisfies DiscoveryProbeResult),
),
} satisfies DiscoveryProbeResult);
}),
);
}

Expand DownExpand Up@@ -244,7 +256,7 @@ export function probeSourceControlProvider(input: {
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand DownExpand Up@@ -287,7 +299,7 @@ export const refineUnknownRemoteProvider = Effect.fn("refineUnknownRemoteProvide
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
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
216 changes: 216 additions & 0 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
import { assert, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as Option from "effect/Option";
import { ChildProcessSpawner } from "effect/unstable/process";
import {
type VcsError,
VcsProcessExitError,
VcsProcessSpawnError,
VcsProcessTimeoutError,
} from "@t3tools/contracts";

import * as VcsProcess from "../vcs/VcsProcess.ts";
import * as AzureDevOps from "./AzureDevOpsSourceControlProvider.ts";
import { probeSourceControlProvider } from "./SourceControlProviderDiscovery.ts";

const processOutput = (
stdout: string,
options?: {
readonly stderr?: string;
readonly exitCode?: ChildProcessSpawner.ExitCode;
},
): VcsProcess.VcsProcessOutput => ({
exitCode: options?.exitCode ?? ChildProcessSpawner.ExitCode(0),
stdout,
stderr: options?.stderr ?? "",
stdoutTruncated: false,
stderrTruncated: false,
});

interface CapturingProcess {
readonly process: VcsProcess.VcsProcess["Service"];
readonly calls: ReadonlyArray<VcsProcess.VcsProcessInput>;
}

const makeProcess = (
run: (input: VcsProcess.VcsProcessInput) => Effect.Effect<VcsProcess.VcsProcessOutput, VcsError>,
): CapturingProcess => {
const calls: VcsProcess.VcsProcessInput[] = [];
return {
calls,
process: {
run: (input) => {
calls.push(input);
return run(input);
},
},
};
};

const isVersionCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "--version";
const isAuthCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "account";

it.effect(
"reports Azure CLI as available and still runs the auth probe when `--version` times out",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.deepStrictEqual(item.auth.account, Option.some("azure-user@example.com"));
assert.ok(
calls.some(isAuthCall),
"expected an `account show` auth probe to run after a slow `--version`",
);
}),
);

it.effect(
"reports Azure CLI as missing and skips the auth probe when `--version` cannot spawn",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessSpawnError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
cause: Object.assign(new Error("spawn az ENOENT"), { code: "ENOENT" }),
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "missing");
assert.strictEqual(item.auth.status, "unknown");
assert.strictEqual(calls.length, 1);
assert.strictEqual(calls[0]?.args[0], "--version");
}),
);

it.effect(
"raises the `--version` probe timeout above 15s and reports the version on the happy path",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.succeed(processOutput("azure-cli 2.87.0\n"));
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

const versionCall = calls.find(isVersionCall);
assert.ok(versionCall, "expected a `--version` probe to run");
assert.ok(
(versionCall.timeoutMs ?? 0) >= 15_000,
`expected the \`--version\` probe timeout to be >= 15000ms, got ${String(versionCall.timeoutMs)}`,
);
assert.deepStrictEqual(item.version, Option.some("azure-cli 2.87.0"));
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
}),
);

it.effect(
"reports available but unauthenticated when `--version` times out and `account show` exits non-zero",
() =>
Effect.gen(function* () {
const { process } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(
processOutput("", {
stderr: "ERROR: Please run 'az login' to setup account.",
exitCode: ChildProcessSpawner.ExitCode(1),
}),
);
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "unauthenticated");
}),
);

it.effect(
"treats a non-spawn `--version` failure (e.g. a non-zero exit) as present and still runs the auth probe",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessExitError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
exitCode: 1,
detail: "Process exited with a non-zero status.",
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

// Only a genuine spawn failure means "missing"; any other runtime failure of
// `--version` (here a non-zero exit) means the CLI is present, so it stays
// available and the auth probe still runs. (issue #4)
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.ok(
calls.some(isAuthCall),
"expected the auth probe to run after a non-spawn `--version` failure",
);
}),
);
28 changes: 20 additions & 8 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,11 @@ import * as Option from "effect/Option";
import type * as SourceControlProvider from "./SourceControlProvider.ts";
import type * as VcsProcess from "../vcs/VcsProcess.ts";

// `az --version` on Windows routinely takes 6-8s (Python startup + Azure CLI's
// "updates available" check), so the old 5s cap misclassified a present-but-slow
// CLI as missing. Raise the discovery probe budget well above that. (issue #4)
const CLI_PROBE_TIMEOUT_MS = 15_000;

export interface SourceControlAuthProbeInput {
readonly stdout: string;
readonly stderr: string;
Expand DownExpand Up@@ -167,7 +172,7 @@ function probeCli(input: {
command: input.spec.executable,
args: input.spec.versionArgs,
cwd: input.cwd,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand All@@ -186,17 +191,24 @@ function probeCli(input: {
detail: Option.none<string>(),
}) satisfies DiscoveryProbeResult,
),
Effect.catch((cause) =>
Effect.succeed({
Effect.catch((cause) => {
// Only a genuine spawn failure (e.g. ENOENT) means the CLI is absent, so
// that is the sole case that reports "missing" and shows the install hint.
// Any other failure (timeout, non-zero exit, etc.) means the CLI is present
// but the version probe was slow/noisy; keep it "available" so
// `probeSourceControlProvider` still runs the fast `account show` auth
// probe instead of short-circuiting to the install hint. (issue #4)
const status = cause._tag === "VcsProcessSpawnError" ? "missing" : "available";
return Effect.succeed({
kind: input.spec.kind,
label: input.spec.label,
executable: input.spec.executable,
status: "missing" as const,
status,
version: Option.none<string>(),
installHint: input.spec.installHint,
detail: detailFromCause(cause),
} satisfies DiscoveryProbeResult),
),
} satisfies DiscoveryProbeResult);
}),
);
}

Expand DownExpand Up@@ -244,7 +256,7 @@ export function probeSourceControlProvider(input: {
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand DownExpand Up@@ -287,7 +299,7 @@ export const refineUnknownRemoteProvider = Effect.fn("refineUnknownRemoteProvide
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
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
216 changes: 216 additions & 0 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.test.ts
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,216 @@
import { assert, it } from "@effect/vitest";
import * as Effect from "effect/Effect";
import * as Option from "effect/Option";
import { ChildProcessSpawner } from "effect/unstable/process";
import {
type VcsError,
VcsProcessExitError,
VcsProcessSpawnError,
VcsProcessTimeoutError,
} from "@t3tools/contracts";

import * as VcsProcess from "../vcs/VcsProcess.ts";
import * as AzureDevOps from "./AzureDevOpsSourceControlProvider.ts";
import { probeSourceControlProvider } from "./SourceControlProviderDiscovery.ts";

const processOutput = (
stdout: string,
options?: {
readonly stderr?: string;
readonly exitCode?: ChildProcessSpawner.ExitCode;
},
): VcsProcess.VcsProcessOutput => ({
exitCode: options?.exitCode ?? ChildProcessSpawner.ExitCode(0),
stdout,
stderr: options?.stderr ?? "",
stdoutTruncated: false,
stderrTruncated: false,
});

interface CapturingProcess {
readonly process: VcsProcess.VcsProcess["Service"];
readonly calls: ReadonlyArray<VcsProcess.VcsProcessInput>;
}

const makeProcess = (
run: (input: VcsProcess.VcsProcessInput) => Effect.Effect<VcsProcess.VcsProcessOutput, VcsError>,
): CapturingProcess => {
const calls: VcsProcess.VcsProcessInput[] = [];
return {
calls,
process: {
run: (input) => {
calls.push(input);
return run(input);
},
},
};
};

const isVersionCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "--version";
const isAuthCall = (input: VcsProcess.VcsProcessInput): boolean => input.args[0] === "account";

it.effect(
"reports Azure CLI as available and still runs the auth probe when `--version` times out",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.deepStrictEqual(item.auth.account, Option.some("azure-user@example.com"));
assert.ok(
calls.some(isAuthCall),
"expected an `account show` auth probe to run after a slow `--version`",
);
}),
);

it.effect(
"reports Azure CLI as missing and skips the auth probe when `--version` cannot spawn",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessSpawnError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
cause: Object.assign(new Error("spawn az ENOENT"), { code: "ENOENT" }),
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "missing");
assert.strictEqual(item.auth.status, "unknown");
assert.strictEqual(calls.length, 1);
assert.strictEqual(calls[0]?.args[0], "--version");
}),
);

it.effect(
"raises the `--version` probe timeout above 15s and reports the version on the happy path",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.succeed(processOutput("azure-cli 2.87.0\n"));
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

const versionCall = calls.find(isVersionCall);
assert.ok(versionCall, "expected a `--version` probe to run");
assert.ok(
(versionCall.timeoutMs ?? 0) >= 15_000,
`expected the \`--version\` probe timeout to be >= 15000ms, got ${String(versionCall.timeoutMs)}`,
);
assert.deepStrictEqual(item.version, Option.some("azure-cli 2.87.0"));
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
}),
);

it.effect(
"reports available but unauthenticated when `--version` times out and `account show` exits non-zero",
() =>
Effect.gen(function* () {
const { process } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessTimeoutError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
timeoutMs: input.timeoutMs ?? 0,
}),
);
}
return Effect.succeed(
processOutput("", {
stderr: "ERROR: Please run 'az login' to setup account.",
exitCode: ChildProcessSpawner.ExitCode(1),
}),
);
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "unauthenticated");
}),
);

it.effect(
"treats a non-spawn `--version` failure (e.g. a non-zero exit) as present and still runs the auth probe",
() =>
Effect.gen(function* () {
const { process, calls } = makeProcess((input) => {
if (isVersionCall(input)) {
return Effect.fail(
new VcsProcessExitError({
operation: input.operation,
command: input.command,
cwd: input.cwd,
exitCode: 1,
detail: "Process exited with a non-zero status.",
}),
);
}
return Effect.succeed(processOutput("azure-user@example.com\n"));
});

const item = yield* probeSourceControlProvider({
spec: AzureDevOps.discovery,
process,
cwd: "/repo",
});

// Only a genuine spawn failure means "missing"; any other runtime failure of
// `--version` (here a non-zero exit) means the CLI is present, so it stays
// available and the auth probe still runs. (issue #4)
assert.strictEqual(item.status, "available");
assert.strictEqual(item.auth.status, "authenticated");
assert.ok(
calls.some(isAuthCall),
"expected the auth probe to run after a non-spawn `--version` failure",
);
}),
);
28 changes: 20 additions & 8 deletions apps/server/src/sourceControl/SourceControlProviderDiscovery.ts
Original file line numberDiff line numberDiff line change
Expand Up@@ -10,6 +10,11 @@ import * as Option from "effect/Option";
import type * as SourceControlProvider from "./SourceControlProvider.ts";
import type * as VcsProcess from "../vcs/VcsProcess.ts";

// `az --version` on Windows routinely takes 6-8s (Python startup + Azure CLI's
// "updates available" check), so the old 5s cap misclassified a present-but-slow
// CLI as missing. Raise the discovery probe budget well above that. (issue #4)
const CLI_PROBE_TIMEOUT_MS = 15_000;

export interface SourceControlAuthProbeInput {
readonly stdout: string;
readonly stderr: string;
Expand DownExpand Up@@ -167,7 +172,7 @@ function probeCli(input: {
command: input.spec.executable,
args: input.spec.versionArgs,
cwd: input.cwd,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand All@@ -186,17 +191,24 @@ function probeCli(input: {
detail: Option.none<string>(),
}) satisfies DiscoveryProbeResult,
),
Effect.catch((cause) =>
Effect.succeed({
Effect.catch((cause) => {
// Only a genuine spawn failure (e.g. ENOENT) means the CLI is absent, so
// that is the sole case that reports "missing" and shows the install hint.
// Any other failure (timeout, non-zero exit, etc.) means the CLI is present
// but the version probe was slow/noisy; keep it "available" so
// `probeSourceControlProvider` still runs the fast `account show` auth
// probe instead of short-circuiting to the install hint. (issue #4)
const status = cause._tag === "VcsProcessSpawnError" ? "missing" : "available";
return Effect.succeed({
kind: input.spec.kind,
label: input.spec.label,
executable: input.spec.executable,
status: "missing" as const,
status,
version: Option.none<string>(),
installHint: input.spec.installHint,
detail: detailFromCause(cause),
} satisfies DiscoveryProbeResult),
),
} satisfies DiscoveryProbeResult);
}),
);
}

Expand DownExpand Up@@ -244,7 +256,7 @@ export function probeSourceControlProvider(input: {
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand DownExpand Up@@ -287,7 +299,7 @@ export const refineUnknownRemoteProvider = Effect.fn("refineUnknownRemoteProvide
args: spec.authArgs,
cwd: input.cwd,
allowNonZeroExit: true,
timeoutMs: 5_000,
timeoutMs: CLI_PROBE_TIMEOUT_MS,
maxOutputBytes: 8_000,
appendTruncationMarker: true,
})
Expand Down