Skip to content

feat: onboarding wizard #6 #2768

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
comatory wants to merge 2 commits into
base: ondrej/eng-9192-onboarding-wizard-from-signup-to-live-metrics-05
Choose a base branch
from
Draft

feat: onboarding wizard #6 #2768

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
caacd6f
feat: event tracking happy path
comatory Apr 15, 2026
be76b54
feat: event tracking errors
comatory Apr 15, 2026
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
148 changes: 139 additions & 9 deletions cli/src/commands/demo/command.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ import {
checkExistingOnboarding,
} from './api.js';
import {
captureOnboardingEvent,
checkDockerReadiness,
clearScreen,
getDemoLogPath,
Expand Down Expand Up @@ -104,7 +105,17 @@ async function cleanupFederatedGraph(
const deleteResponse = await cleanUpFederatedGraph(client, graphData);

if (deleteResponse.error) {
spinner.fail(`Removing federated graph ${graphData.graph.name} failed.`);
const failText = `Removing federated graph ${graphData.graph.name} failed.`;
spinner.fail(failText);
captureOnboardingEvent({
name: 'onboarding_step_failed',
properties: {
step_name: 'delete_federated_graph',
entry_source: 'wgc',
error_category: 'resource',
error_message: `${failText}\n${deleteResponse.error.message}`,
},
});
console.error(deleteResponse.error.message);

await waitForKeyPress(
Expand All @@ -117,6 +128,14 @@ async function cleanupFederatedGraph(
);
}

captureOnboardingEvent({
name: 'onboarding_step_completed',
properties: {
step_name: 'delete_federated_graph',
entry_source: 'wgc',
},
});

spinner.succeed(`Federated graph ${pc.bold(graphData.graph.name)} removed.`);
}

Expand Down Expand Up @@ -265,7 +284,10 @@ async function handleStep3(
logPath: string;
},
) {
let firedQueries = 0;

function retryFn() {
firedQueries = 0;
resetScreen(userInfo);
return handleStep3(opts, { userInfo, routerBaseUrl, signal, logPath });
}
Expand All @@ -280,7 +302,17 @@ async function handleStep3(
// Delete existing token first (idempotent — no error if missing)
const deleteResult = await deleteRouterToken(tokenParams);
if (deleteResult.error) {
console.error(`Failed to clean up existing router token: ${deleteResult.error.message}`);
const errorText = `Failed to clean up existing router token: ${deleteResult.error.message}`;
console.error(errorText);
captureOnboardingEvent({
name: 'onboarding_step_failed',
properties: {
step_name: 'run_router_send_metrics',
entry_source: 'wgc',
error_category: 'router',
error_message: errorText,
},
});
await waitForKeyPress({ r: retryFn, R: retryFn }, 'Hit [r] to retry. CTRL+C to quit.');
return;
}
Expand All @@ -289,7 +321,17 @@ async function handleStep3(
const createResult = await createRouterToken(tokenParams);

if (createResult.error) {
spinner.fail(`Failed to generate router token: ${createResult.error.message}`);
const failText = `Failed to generate router token: ${createResult.error.message}`;
spinner.fail(failText);
captureOnboardingEvent({
name: 'onboarding_step_failed',
properties: {
step_name: 'run_router_send_metrics',
entry_source: 'wgc',
error_category: 'router',
error_message: failText,
},
});
await waitForKeyPress({ r: retryFn, R: retryFn }, 'Hit [r] to retry. CTRL+C to quit.');
return;
}
Expand All @@ -316,8 +358,30 @@ async function handleStep3(
const body = await res.json();
querySpinner.succeed('Sample query response:');
console.log(pc.dim(JSON.stringify(body, null, 2)));

if (firedQueries === 0) {
captureOnboardingEvent({
name: 'onboarding_step_completed',
properties: {
step_name: 'run_router_send_metrics',
entry_source: 'wgc',
},
});
}

firedQueries++;
} catch (err) {
querySpinner.fail(`Sample query failed: ${err instanceof Error ? err.message : String(err)}`);
const failText = `Sample query failed: ${err instanceof Error ? err.message : String(err)}`;
captureOnboardingEvent({
name: 'onboarding_step_failed',
properties: {
step_name: 'run_router_send_metrics',
entry_source: 'wgc',
error_category: 'router',
error_message: failText,
},
});
querySpinner.fail(failText);
}
showQueryPrompt();
}
Expand All @@ -337,7 +401,17 @@ async function handleStep3(
});

if (routerResult.error) {
console.error(`\nRouter exited with error: ${routerResult.error.message}`);
const errorText = `Router exited with error: ${routerResult.error.message}`;
console.error(`\n${errorText}`);
captureOnboardingEvent({
name: 'onboarding_step_failed',
properties: {
step_name: 'run_router_send_metrics',
entry_source: 'wgc',
error_category: 'router',
error_message: errorText,
},
});
await waitForKeyPress({ r: retryFn, R: retryFn }, 'Hit [r] to retry. CTRL+C to quit.');
} else {
showQueryPrompt();
Expand All @@ -356,14 +430,35 @@ async function handleGetOnboardingResponse(client: BaseCommandOptions['client'],
return onboardingCheck.onboarding;
}
case 'not-allowed': {
program.error('Only organization owners can trigger onboarding.');
const errorText = 'Only organization owners can trigger onboarding.';
captureOnboardingEvent({
name: 'onboarding_step_failed',
properties: {
step_name: 'check_onboarding',
entry_source: 'wgc',
error_category: 'resource',
error_message: errorText,
},
});
program.error(errorText);

break;
}
case 'error': {
console.error('An issue occured while fetching the onboarding status');
const errorText = 'An issue occured while fetching the onboarding status';
console.error(errorText);
console.error(onboardingCheck.error);

captureOnboardingEvent({
name: 'onboarding_step_failed',
properties: {
step_name: 'check_onboarding',
entry_source: 'wgc',
error_category: 'resource',
error_message: `${errorText}\n${onboardingCheck.error}`,
},
});

await waitForKeyPress({ Enter: retryFn }, 'Hit Enter to retry. CTRL+C to quit.');
break;
}
Expand All @@ -383,6 +478,15 @@ async function getUserInfo(client: BaseCommandOptions['client']) {

if (error) {
spinner.fail(error.message);
captureOnboardingEvent({
name: 'onboarding_step_failed',
properties: {
step_name: 'init',
entry_source: 'wgc',
error_category: 'resource',
error_message: error.message,
},
});
program.error(error.message);
}

Expand All @@ -405,10 +509,12 @@ export default function (opts: BaseCommandOptions) {
const userInfo = await getUserInfo(opts.client);
updateScreenWithUserInfo(userInfo);

const onboardingUrl = `${config.webURL}/onboarding`;
const onboardingUrl = new URL('/onboarding', config.webURL);

async function openOnboardingUrl() {
const process = await open(onboardingUrl);
const browserUrl = new URL(onboardingUrl);
browserUrl.searchParams.set('referrer', 'wgc');
const process = await open(browserUrl.toString());
process.on('error', (error) => {
console.log(pc.yellow(`\nCouldn't open browser: ${error.message}`));
});
Expand All @@ -425,12 +531,28 @@ export default function (opts: BaseCommandOptions) {

resetScreen(userInfo);

captureOnboardingEvent({
name: 'onboarding_step_completed',
properties: {
step_name: 'init',
entry_source: 'wgc',
},
});

const onboardingCheck = await handleStep1(opts, userInfo);

if (!onboardingCheck) {
return;
}

captureOnboardingEvent({
name: 'onboarding_step_completed',
properties: {
step_name: 'check_onboarding',
entry_source: 'wgc',
},
});

const logPath = getDemoLogPath();

const step2Result = await handleStep2(opts, {
Expand All @@ -445,6 +567,14 @@ export default function (opts: BaseCommandOptions) {
return;
}

captureOnboardingEvent({
name: 'onboarding_step_completed',
properties: {
step_name: 'create_federated_graph',
entry_source: 'wgc',
},
});

const routerBaseUrl = new URL(step2Result.routingUrl).origin;
await handleStep3(opts, { userInfo, routerBaseUrl, signal: controller.signal, logPath });
} finally {
Expand Down
Loading
Loading