mirror/plane
1
0
Fork 0
mirror of https://github.com/makeplane/plane.git synced 2026-01-24 07:09:53 -06:00
Code Issues Packages Projects Releases Wiki Activity

[WEB - 1418] chore: events for auth & onboarding (#4576)

Browse Source 
* chore: onboarding events added

* chore: updated events

* event payload updated

---------

Co-authored-by: sriram veeraghanta <veeraghanta.sriram@gmail.com>
This commit is contained in:
Lakhan Baheti
2024-06-18 14:14:46 +05:30
committed by GitHub
parent d3d723cadd
commit 190c85468b
6 changed files with 47 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
web/core/components/account/auth-forms/auth-root.tsx
View File

@@ -50,6 +50,7 @@ export const AuthRoot: FC<TAuthRoot> = observer((props) => {
const [authStep, setAuthStep] = useState<EAuthSteps>(EAuthSteps.EMAIL);
const [email, setEmail] = useState(emailParam ? emailParam.toString() : "");
const [errorInfo, setErrorInfo] = useState<TAuthErrorInfo | undefined>(undefined);
const [isExistingEmail, setIsExistingEmail] = useState(false);
// hooks
const { config } = useInstance();
@@ -125,6 +126,7 @@ export const AuthRoot: FC<TAuthRoot> = observer((props) => {
setAuthStep(EAuthSteps.PASSWORD);
}
}
setIsExistingEmail(response.existing);
})
.catch((error) => {
const errorhandler = authErrorHandler(error?.error_code?.toString(), data?.email || undefined);
@@ -172,6 +174,7 @@ export const AuthRoot: FC<TAuthRoot> = observer((props) => {
<AuthUniqueCodeForm
mode={authMode}
email={email}
isExistingEmail={isExistingEmail}
handleEmailClear={handleEmailClear}
generateEmailUniqueCode={generateEmailUniqueCode}
nextPath={nextPath || undefined}

13
web/core/components/account/auth-forms/password.tsx
View File

@@ -10,7 +10,12 @@ import { Button, Input, Spinner } from "@plane/ui";
// components
import { ForgotPasswordPopover, PasswordStrengthMeter } from "@/components/account";
// constants
import { FORGOT_PASSWORD } from "@/constants/event-tracker";
import {
FORGOT_PASSWORD,
SIGN_IN_WITH_CODE,
SIGN_IN_WITH_PASSWORD,
SIGN_UP_WITH_PASSWORD,
} from "@/constants/event-tracker";
// helpers
import { EAuthModes, EAuthSteps } from "@/helpers/authentication.helper";
import { API_BASE_URL } from "@/helpers/common.helper";
@@ -70,6 +75,7 @@ export const AuthPasswordForm: React.FC<Props> = observer((props: Props) => {
const redirectToUniqueCodeSignIn = async () => {
handleAuthStep(EAuthSteps.UNIQUE_CODE);
captureEvent(SIGN_IN_WITH_CODE);
};
const passwordSupport =
@@ -116,7 +122,10 @@ export const AuthPasswordForm: React.FC<Props> = observer((props: Props) => {
className="mt-5 space-y-4"
method="POST"
action={`${API_BASE_URL}/auth/${mode === EAuthModes.SIGN_IN ? "sign-in" : "sign-up"}/`}
onSubmit={() => setIsSubmitting(true)}
onSubmit={() => {
setIsSubmitting(true);
captureEvent(mode === EAuthModes.SIGN_IN ? SIGN_IN_WITH_PASSWORD : SIGN_UP_WITH_PASSWORD);
}}
onError={() => setIsSubmitting(false)}
>
<input type="hidden" name="csrfmiddlewaretoken" value={csrfToken} />

16
web/core/components/account/auth-forms/unique-code.tsx
View File

@@ -3,10 +3,13 @@
import React, { useEffect, useState } from "react";
import { CircleCheck, XCircle } from "lucide-react";
import { Button, Input, Spinner } from "@plane/ui";
// constants
import { CODE_VERIFIED } from "@/constants/event-tracker";
// helpers
import { EAuthModes } from "@/helpers/authentication.helper";
import { API_BASE_URL } from "@/helpers/common.helper";
// hooks
import { useEventTracker } from "@/hooks/store";
import useTimer from "@/hooks/use-timer";
// services
import { AuthService } from "@/services/auth.service";
@@ -17,6 +20,7 @@ const authService = new AuthService();
type TAuthUniqueCodeForm = {
mode: EAuthModes;
email: string;
isExistingEmail: boolean;
handleEmailClear: () => void;
generateEmailUniqueCode: (email: string) => Promise<{ code: string } | undefined>;
nextPath: string | undefined;
@@ -33,9 +37,9 @@ const defaultValues: TUniqueCodeFormValues = {
};
export const AuthUniqueCodeForm: React.FC<TAuthUniqueCodeForm> = (props) => {
const { mode, email, handleEmailClear, generateEmailUniqueCode, nextPath } = props;
const { mode, email, handleEmailClear, generateEmailUniqueCode, isExistingEmail, nextPath } = props;
// hooks
// const { captureEvent } = useEventTracker();
const { captureEvent } = useEventTracker();
// derived values
const defaultResetTimerValue = 5;
// states
@@ -76,7 +80,13 @@ export const AuthUniqueCodeForm: React.FC<TAuthUniqueCodeForm> = (props) => {
className="mt-5 space-y-4"
method="POST"
action={`${API_BASE_URL}/auth/${mode === EAuthModes.SIGN_IN ? "magic-sign-in" : "magic-sign-up"}/`}
onSubmit={() => setIsSubmitting(true)}
onSubmit={() => {
setIsSubmitting(true);
captureEvent(CODE_VERIFIED, {
state: "SUCCESS",
first_time: !isExistingEmail,
});
}}
onError={() => setIsSubmitting(false)}
>
<input type="hidden" name="csrfmiddlewaretoken" value={csrfToken} />

6
web/core/components/onboarding/create-workspace.tsx
View File

@@ -7,7 +7,7 @@ import { IUser, IWorkspace, TOnboardingSteps } from "@plane/types";
// ui
import { Button, CustomSelect, Input, Spinner, TOAST_TYPE, setToast } from "@plane/ui";
// constants
import { WORKSPACE_CREATED } from "@/constants/event-tracker";
import { E_ONBOARDING, WORKSPACE_CREATED } from "@/constants/event-tracker";
import { ORGANIZATION_SIZE, RESTRICTED_URLS } from "@/constants/workspace";
// hooks
import { useEventTracker, useUserProfile, useWorkspace } from "@/hooks/store";
@@ -71,7 +71,7 @@ export const CreateWorkspace: React.FC<Props> = (props) => {
...res,
state: "SUCCESS",
first_time: true,
element: "Onboarding",
element: E_ONBOARDING,
},
});
await fetchWorkspaces();
@@ -83,7 +83,7 @@ export const CreateWorkspace: React.FC<Props> = (props) => {
payload: {
state: "FAILED",
first_time: true,
element: "Onboarding",
element: E_ONBOARDING,
},
});
setToast({

16
web/core/components/onboarding/profile-setup.tsx
View File

@@ -15,7 +15,7 @@ import { PasswordStrengthMeter } from "@/components/account";
import { UserImageUploadModal } from "@/components/core";
import { OnboardingHeader, SwitchAccountDropdown } from "@/components/onboarding";
// constants
import { USER_DETAILS } from "@/constants/event-tracker";
import { USER_DETAILS, E_ONBOARDING_STEP_1, E_ONBOARDING_STEP_2 } from "@/constants/event-tracker";
// helpers
import { getPasswordStrength } from "@/helpers/password.helper";
// hooks
@@ -142,8 +142,10 @@ export const ProfileSetup: React.FC<Props> = observer((props) => {
totalSteps > 2 && stepChange({ profile_complete: true }),
]);
captureEvent(USER_DETAILS, {
use_case: formData.use_case,
role: formData.role,
state: "SUCCESS",
element: "Onboarding",
element: E_ONBOARDING_STEP_1,
});
setToast({
type: TOAST_TYPE.SUCCESS,
@@ -157,7 +159,7 @@ export const ProfileSetup: React.FC<Props> = observer((props) => {
} catch {
captureEvent(USER_DETAILS, {
state: "FAILED",
element: "Onboarding",
element: E_ONBOARDING_STEP_1,
});
setToast({
type: TOAST_TYPE.ERROR,
@@ -181,7 +183,7 @@ export const ProfileSetup: React.FC<Props> = observer((props) => {
} catch {
captureEvent(USER_DETAILS, {
state: "FAILED",
element: "Onboarding",
element: E_ONBOARDING_STEP_1,
});
setToast({
type: TOAST_TYPE.ERROR,
@@ -202,8 +204,10 @@ export const ProfileSetup: React.FC<Props> = observer((props) => {
totalSteps > 2 && stepChange({ profile_complete: true }),
]);
captureEvent(USER_DETAILS, {
use_case: formData.use_case,
role: formData.role,
state: "SUCCESS",
element: "Onboarding",
element: E_ONBOARDING_STEP_2,
});
setToast({
type: TOAST_TYPE.SUCCESS,
@@ -217,7 +221,7 @@ export const ProfileSetup: React.FC<Props> = observer((props) => {
} catch {
captureEvent(USER_DETAILS, {
state: "FAILED",
element: "Onboarding",
element: E_ONBOARDING_STEP_2,
});
setToast({
type: TOAST_TYPE.ERROR,

7
web/core/constants/event-tracker.ts
View File

@@ -192,6 +192,8 @@ export const SETUP_PASSWORD = "Password setup";
export const PASSWORD_CREATE_SELECTED = "Password created";
export const PASSWORD_CREATE_SKIPPED = "Skipped to setup";
export const SIGN_IN_WITH_PASSWORD = "Sign in with password";
export const SIGN_UP_WITH_PASSWORD = "Sign up with password";
export const SIGN_IN_WITH_CODE = "Sign in with magic link";
export const FORGOT_PASSWORD = "Forgot password clicked";
export const FORGOT_PASS_LINK = "Forgot password link generated";
export const NEW_PASS_CREATED = "New password created";
@@ -222,3 +224,8 @@ export const SNOOZED_NOTIFICATIONS = "Snoozed notifications viewed";
export const ARCHIVED_NOTIFICATIONS = "Archived notifications viewed";
// Groups
export const GROUP_WORKSPACE = "Workspace_metrics";
//Elements
export const E_ONBOARDING = "Onboarding";
export const E_ONBOARDING_STEP_1 = "Onboarding step 1";
export const E_ONBOARDING_STEP_2 = "Onboarding step 2";