Skip to content
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.

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

fix(demo): add more backend tracking #1912

Merged
merged 2 commits into from Mar 27, 2024
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.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
22 changes: 18 additions & 4 deletions packages/server/lib/controllers/onboarding.controller.ts
Expand Up @@ -55,7 +55,7 @@ class OnboardingController {
return;
}

const { user, environment } = response;
const { user, environment, account } = response;

if (environment.name !== 'dev') {
res.status(400).json({ error: 'onboarding_dev_only' });
Expand All @@ -68,6 +68,7 @@ class OnboardingController {
// Create an onboarding state to remember where user left
const onboardingId = await initOnboarding(user.id);
if (!onboardingId) {
void analytics.track(AnalyticsTypes.DEMO_1_ERR, account.id, { user_id: user.id });
res.status(500).json({
error: 'Failed to create onboarding'
});
Expand All @@ -80,6 +81,7 @@ class OnboardingController {
await createOnboardingProvider({ envId: environment.id });
}

void analytics.track(AnalyticsTypes.DEMO_1_SUCCESS, account.id, { user_id: user.id });
res.status(201).json({
id: onboardingId
});
Expand Down Expand Up @@ -185,10 +187,11 @@ class OnboardingController {
return;
}

const { environment } = response;
const { environment, account, user } = response;
const githubDemoSync = flowService.getFlow(DEMO_SYNC_NAME);
const githubDemoAction = flowService.getFlow(DEMO_ACTION_NAME);
if (!githubDemoSync || !githubDemoAction) {
void analytics.track(AnalyticsTypes.DEMO_2_ERR, account.id, { user_id: user.id });
throw new Error('failed_to_find_demo_sync');
}

Expand Down Expand Up @@ -224,12 +227,14 @@ class OnboardingController {

const deploy = await deployPreBuiltSyncConfig(environment.id, config, '');
if (!deploy.success || deploy.response === null) {
void analytics.track(AnalyticsTypes.DEMO_2_ERR, account.id, { user_id: user.id });
errorManager.errResFromNangoErr(res, deploy.error);
return;
}

await syncOrchestrator.triggerIfConnectionsExist(deploy.response.result, environment.id);

void analytics.track(AnalyticsTypes.DEMO_2_SUCCESS, account.id, { user_id: user.id });
res.status(200).json({ success: true });
} catch (err) {
next(err);
Expand All @@ -254,14 +259,15 @@ class OnboardingController {
return;
}

const { environment } = response;
const { environment, account, user } = response;
const {
success,
error,
response: status
} = await syncOrchestrator.getSyncStatus(environment.id, DEMO_GITHUB_CONFIG_KEY, [DEMO_SYNC_NAME], req.body.connectionId, true);

if (!success || !status) {
void analytics.track(AnalyticsTypes.DEMO_4_ERR, account.id, { user_id: user.id });
errorManager.errResFromNangoErr(res, error);
return;
}
Expand All @@ -288,6 +294,10 @@ class OnboardingController {
await syncOrchestrator.runSyncCommand(environment.id, DEMO_GITHUB_CONFIG_KEY, [DEMO_SYNC_NAME], SyncCommand.RUN_FULL, req.body.connectionId);
}

if (job.jobStatus === SyncStatus.SUCCESS) {
void analytics.track(AnalyticsTypes.DEMO_4_SUCCESS, account.id, { user_id: user.id });
}

res.status(200).json(job);
} catch (err) {
next(err);
Expand Down Expand Up @@ -358,9 +368,10 @@ class OnboardingController {
return;
}

const { environment } = response;
const { environment, account, user } = response;
const syncClient = await SyncClient.getInstance();
if (!syncClient) {
void analytics.track(AnalyticsTypes.DEMO_5_ERR, account.id, { user_id: user.id });
throw new NangoError('failed_to_get_sync_client');
}

Expand All @@ -370,6 +381,7 @@ class OnboardingController {
response: connection
} = await connectionService.getConnection(req.body.connectionId, DEMO_GITHUB_CONFIG_KEY, environment.id);
if (!success || !connection) {
void analytics.track(AnalyticsTypes.DEMO_5_ERR, account.id, { user_id: user.id });
errorManager.errResFromNangoErr(res, error);
return;
}
Expand All @@ -393,10 +405,12 @@ class OnboardingController {
const actionResponse = await syncClient.triggerAction(connection, DEMO_ACTION_NAME, { title: req.body.title }, activityLogId, environment.id);

if (isErr(actionResponse)) {
void analytics.track(AnalyticsTypes.DEMO_5_ERR, account.id, { user_id: user.id });
errorManager.errResFromNangoErr(res, actionResponse.err);
return;
}

void analytics.track(AnalyticsTypes.DEMO_5_SUCCESS, account.id, { user_id: user.id });
res.status(200).json({ action: actionResponse.res });
} catch (err) {
next(err);
Expand Down
8 changes: 8 additions & 0 deletions packages/shared/lib/utils/analytics.ts
Expand Up @@ -19,10 +19,18 @@ export enum AnalyticsTypes {
CONNECTION_UPDATED = 'server:connection_updated',
DEMO_0 = 'demo:step_0',
DEMO_1 = 'demo:step_1',
DEMO_1_ERR = 'demo:step_1:error',
DEMO_1_SUCCESS = 'demo:step_1:success',
DEMO_2 = 'demo:step_2',
DEMO_2_ERR = 'demo:step_2:error',
DEMO_2_SUCCESS = 'demo:step_2:success',
DEMO_3 = 'demo:step_3',
DEMO_4 = 'demo:step_4',
DEMO_4_ERR = 'demo:step_4:error',
DEMO_4_SUCCESS = 'demo:step_4:success',
DEMO_5 = 'demo:step_5',
DEMO_5_ERR = 'demo:step_5:error',
DEMO_5_SUCCESS = 'demo:step_5:success',
DEMO_6 = 'demo:step_6',
PRE_API_KEY_AUTH = 'server:pre_api_key_auth',
PRE_APP_AUTH = 'server:pre_appauth',
Expand Down