379 lines
11 KiB
TypeScript
379 lines
11 KiB
TypeScript
// Events
|
|
import * as log from "loglevel";
|
|
import smartlookClient from "smartlook-client";
|
|
import { getAppsmithConfigs } from "@appsmith/configs";
|
|
import * as Sentry from "@sentry/react";
|
|
import { ANONYMOUS_USERNAME, User } from "../constants/userConstants";
|
|
import { sha256 } from "js-sha256";
|
|
|
|
export type EventLocation =
|
|
| "LIGHTNING_MENU"
|
|
| "API_PANE"
|
|
| "QUERY_PANE"
|
|
| "QUERY_TEMPLATE"
|
|
| "QUICK_COMMANDS"
|
|
| "OMNIBAR";
|
|
|
|
export type EventName =
|
|
| "LOGIN_CLICK"
|
|
| "SIGNUP_CLICK"
|
|
| "PAGE_VIEW"
|
|
| "ADD_COMPONENT"
|
|
| "DELETE_COMPONENT"
|
|
| "RESIZE_COMPONENT"
|
|
| "WIDGET_DRAG"
|
|
| "WIDGET_DROP"
|
|
| "WIDGET_DELETE"
|
|
| "WIDGET_RESIZE_START"
|
|
| "WIDGET_RESIZE_END"
|
|
| "WIDGET_PROPERTY_UPDATE"
|
|
| "WIDGET_TOGGLE_JS_PROP"
|
|
| "WIDGET_CARD_DRAG"
|
|
| "WIDGET_CARD_DROP"
|
|
| "CREATE_PAGE"
|
|
| "PAGE_RENAME"
|
|
| "PAGE_SWITCH"
|
|
| "DELETE_PAGE"
|
|
| "SIDEBAR_NAVIGATION"
|
|
| "PUBLISH_APP"
|
|
| "PREVIEW_APP"
|
|
| "EDITOR_OPEN"
|
|
| "CREATE_ACTION"
|
|
| "SAVE_SAAS"
|
|
| "DELETE_SAAS"
|
|
| "RUN_SAAS_API"
|
|
| "SAVE_API"
|
|
| "SAVE_API_CLICK"
|
|
| "RUN_API"
|
|
| "RUN_API_CLICK"
|
|
| "RUN_API_SHORTCUT"
|
|
| "DELETE_API"
|
|
| "DELETE_API_CLICK"
|
|
| "IMPORT_API"
|
|
| "EXPAND_API"
|
|
| "IMPORT_API_CLICK"
|
|
| "MOVE_API_CLICK"
|
|
| "ADD_API_PAGE"
|
|
| "DUPLICATE_API"
|
|
| "DUPLICATE_API_CLICK"
|
|
| "RUN_QUERY"
|
|
| "RUN_QUERY_CLICK"
|
|
| "RUN_QUERY_SHORTCUT"
|
|
| "DELETE_QUERY"
|
|
| "SAVE_QUERY"
|
|
| "MOVE_API"
|
|
| "3P_PROVIDER_CLICK"
|
|
| "API_SELECT"
|
|
| "CREATE_API_CLICK"
|
|
| "AUTO_COMPLETE_SHOW"
|
|
| "AUTO_COMPLETE_SELECT"
|
|
| "CREATE_APP_CLICK"
|
|
| "CREATE_APP"
|
|
| "CREATE_DATA_SOURCE_CLICK"
|
|
| "SAVE_DATA_SOURCE"
|
|
| "SAVE_DATA_SOURCE_CLICK"
|
|
| "TEST_DATA_SOURCE_SUCCESS"
|
|
| "TEST_DATA_SOURCE_CLICK"
|
|
| "CREATE_QUERY_CLICK"
|
|
| "NAVIGATE"
|
|
| "PAGE_LOAD"
|
|
| "NAVIGATE_EDITOR"
|
|
| "PROPERTY_PANE_OPEN"
|
|
| "PROPERTY_PANE_CLOSE"
|
|
| "PROPERTY_PANE_OPEN_CLICK"
|
|
| "PROPERTY_PANE_CLOSE_CLICK"
|
|
| "WIDGET_DELETE_UNDO"
|
|
| "WIDGET_COPY_VIA_SHORTCUT"
|
|
| "WIDGET_COPY"
|
|
| "WIDGET_CUT_VIA_SHORTCUT"
|
|
| "WIDGET_PASTE"
|
|
| "WIDGET_DELETE_VIA_SHORTCUT"
|
|
| "OPEN_HELP"
|
|
| "INVITE_USER"
|
|
| "ROUTE_CHANGE"
|
|
| "PROPERTY_PANE_CLOSE_CLICK"
|
|
| "APPLICATIONS_PAGE_LOAD"
|
|
| "EXECUTE_ACTION"
|
|
| "WELCOME_TOUR_CLICK"
|
|
| "GUIDED_TOUR_RATING"
|
|
| "GUIDED_TOUR_REACHED_STEP"
|
|
| "END_GUIDED_TOUR_CLICK"
|
|
| "OPEN_OMNIBAR"
|
|
| "CLOSE_OMNIBAR"
|
|
| "NAVIGATE_TO_ENTITY_FROM_OMNIBAR"
|
|
| "PAGE_SAVE"
|
|
| "CORRECT_BAD_BINDING"
|
|
| "OPEN_DEBUGGER"
|
|
| "DEBUGGER_TAB_SWITCH"
|
|
| "DEBUGGER_ENTITY_NAVIGATION"
|
|
| "GSHEET_AUTH_INIT"
|
|
| "GSHEET_AUTH_COMPLETE"
|
|
| "CYCLICAL_DEPENDENCY_ERROR"
|
|
| "DISCORD_LINK_CLICK"
|
|
| "BINDING_SUCCESS"
|
|
| "APP_MENU_OPTION_CLICK"
|
|
| "SLASH_COMMAND"
|
|
| "DEBUGGER_NEW_ERROR"
|
|
| "DEBUGGER_RESOLVED_ERROR"
|
|
| "DEBUGGER_NEW_ERROR_MESSAGE"
|
|
| "DEBUGGER_RESOLVED_ERROR_MESSAGE"
|
|
| "DEBUGGER_CONTEXT_MENU_CLICK"
|
|
| "ADD_MOCK_DATASOURCE_CLICK"
|
|
| "CREATE_DATA_SOURCE_AUTH_API_CLICK"
|
|
| "GEN_CRUD_PAGE_CREATE_NEW_DATASOURCE"
|
|
| "GEN_CRUD_PAGE_FORM_SUBMIT"
|
|
| "GEN_CRUD_PAGE_EDIT_DATASOURCE_CONFIG"
|
|
| "GEN_CRUD_PAGE_SELECT_DATASOURCE"
|
|
| "GEN_CRUD_PAGE_SELECT_TABLE"
|
|
| "GEN_CRUD_PAGE_SELECT_SEARCH_COLUMN"
|
|
| "GEN_CRUD_PAGE_SELECT_SEARCH_COLUMN"
|
|
| "BUILD_FROM_SCRATCH_ACTION_CARD_CLICK"
|
|
| "GEN_CRUD_PAGE_ACTION_CARD_CLICK"
|
|
| "GEN_CRUD_PAGE_DATA_SOURCE_CLICK"
|
|
| "DATASOURCE_CARD_GEN_CRUD_PAGE_ACTION"
|
|
| "DATASOURCE_CARD_DELETE_ACTION"
|
|
| "DATASOURCE_CARD_EDIT_ACTION"
|
|
| "UNSUPPORTED_PLUGIN_DIALOG_BACK_ACTION"
|
|
| "UNSUPPORTED_PLUGIN_DIALOG_CONTINUE_ACTION"
|
|
| "SELECT_IN_CANVAS_CLICK"
|
|
| "WIDGET_SELECTED_VIA_SNIPING_MODE"
|
|
| "SUGGESTED_WIDGET_CLICK"
|
|
| "ASSOCIATED_ENTITY_CLICK"
|
|
| "CREATE_DATA_SOURCE_AUTH_API_CLICK"
|
|
| "CONNECT_DATA_CLICK"
|
|
| "RESPONSE_TAB_RUN_ACTION_CLICK"
|
|
| "ASSOCIATED_ENTITY_DROPDOWN_CLICK"
|
|
| "PAGES_LIST_LOAD"
|
|
| "WIDGET_GROUP"
|
|
| "CLOSE_GEN_PAGE_INFO_MODAL"
|
|
| "PAGES_LIST_LOAD"
|
|
| "COMMENTS_TOGGLE_MODE"
|
|
| "COMMENTS_ONBOARDING_SKIP_BUTTON_CLICK"
|
|
| "COMMENTS_ONBOARDING_STEP_CHANGE"
|
|
| "COMMENTS_ONBOARDING_SUBMIT_BUTTON_CLICK"
|
|
| "COMMENTS_ONBOARDING_MODAL_DISMISSED"
|
|
| "COMMENTS_ONBOARDING_MODAL_TRIGGERED"
|
|
| "REPLAY_UNDO"
|
|
| "REPLAY_REDO"
|
|
| "SNIPPET_CUSTOMIZE"
|
|
| "SNIPPET_EXECUTE"
|
|
| "SNIPPET_FILTER"
|
|
| "SNIPPET_COPIED"
|
|
| "SNIPPET_LOOKUP"
|
|
| "SIGNPOSTING_SKIP"
|
|
| "SIGNPOSTING_CREATE_DATASOURCE_CLICK"
|
|
| "SIGNPOSTING_CREATE_QUERY_CLICK"
|
|
| "SIGNPOSTING_ADD_WIDGET_CLICK"
|
|
| "SIGNPOSTING_CONNECT_WIDGET_CLICK"
|
|
| "SIGNPOSTING_PUBLISH_CLICK"
|
|
| "SIGNPOSTING_BUILD_APP_CLICK"
|
|
| "SIGNPOSTING_WELCOME_TOUR_CLICK"
|
|
| "GS_CONNECT_GIT_CLICK"
|
|
| "GS_DISCONNECT_GIT_CLICK"
|
|
| "GS_PULL_GIT_CLICK"
|
|
| "GS_DEPLOY_GIT_CLICK"
|
|
| "GS_DEPLOY_GIT_MODAL_TRIGGERED"
|
|
| "GS_MERGE_GIT_MODAL_TRIGGERED"
|
|
| "GS_REPO_LIMIT_ERROR_MODAL_TRIGGERED"
|
|
| "GS_GIT_DOCUMENTATION_LINK_CLICK"
|
|
| "GS_REPO_URL_EDIT"
|
|
| "GS_MATCHING_REPO_NAME_ON_GIT_DISCONNECT_MODAL"
|
|
| "GS_GENERATE_KEY_BUTTON_CLICK"
|
|
| "GS_COPY_SSH_KEY_BUTTON_CLICK"
|
|
| "GS_DEFAULT_CONFIGURATION_EDIT_BUTTON_CLICK"
|
|
| "GS_DEFAULT_CONFIGURATION_CHECKBOX_TOGGLED"
|
|
| "GS_CONNECT_BUTTON_ON_GIT_SYNC_MODAL_CLICK"
|
|
| "GS_IMPORT_VIA_GIT_CLICK"
|
|
| "GS_CONTACT_SALES_CLICK"
|
|
| "REFLOW_BETA_FLAG"
|
|
| "CONNECT_GIT_CLICK"
|
|
| "REPO_URL_EDIT"
|
|
| "GENERATE_KEY_BUTTON_CLICK"
|
|
| "COPY_SSH_KEY_BUTTON_CLICK"
|
|
| "LEARN_MORE_LINK_FOR_REMOTEURL_CLICK"
|
|
| "LEARN_MORE_LINK_FOR_SSH_CLICK"
|
|
| "DEFAULT_CONFIGURATION_EDIT_BUTTON_CLICK"
|
|
| "DEFAULT_CONFIGURATION_CHECKBOX_TOGGLED"
|
|
| "CONNECT_BUTTON_ON_GIT_SYNC_MODAL_CLICK"
|
|
| "DATASOURCE_AUTH_COMPLETE";
|
|
|
|
function getApplicationId(location: Location) {
|
|
const pathSplit = location.pathname.split("/");
|
|
const applicationsIndex = pathSplit.findIndex(
|
|
(path) => path === "applications",
|
|
);
|
|
const appId = pathSplit[applicationsIndex + 1];
|
|
|
|
return appId;
|
|
}
|
|
|
|
class AnalyticsUtil {
|
|
static cachedAnonymoustId: string;
|
|
static cachedUserId: string;
|
|
static user?: User = undefined;
|
|
static initializeSmartLook(id: string) {
|
|
smartlookClient.init(id);
|
|
}
|
|
|
|
static initializeSegment(key: string) {
|
|
(function init(window: any) {
|
|
const analytics = (window.analytics = window.analytics || []);
|
|
if (!analytics.initialize) {
|
|
if (analytics.invoked) {
|
|
log.error("Segment snippet included twice.");
|
|
} else {
|
|
analytics.invoked = !0;
|
|
analytics.methods = [
|
|
"trackSubmit",
|
|
"trackClick",
|
|
"trackLink",
|
|
"trackForm",
|
|
"pageview",
|
|
"identify",
|
|
"reset",
|
|
"group",
|
|
"track",
|
|
"ready",
|
|
"alias",
|
|
"debug",
|
|
"page",
|
|
"once",
|
|
"off",
|
|
"on",
|
|
];
|
|
analytics.factory = function(t: any) {
|
|
return function() {
|
|
const e = Array.prototype.slice.call(arguments); //eslint-disable-line prefer-rest-params
|
|
e.unshift(t);
|
|
analytics.push(e);
|
|
return analytics;
|
|
};
|
|
};
|
|
}
|
|
for (let t: any = 0; t < analytics.methods.length; t++) {
|
|
const e = analytics.methods[t];
|
|
analytics[e] = analytics.factory(e);
|
|
}
|
|
analytics.load = function(t: any, e: any) {
|
|
const n = document.createElement("script");
|
|
n.type = "text/javascript";
|
|
n.async = !0;
|
|
n.src =
|
|
"https://cdn.segment.com/analytics.js/v1/" +
|
|
t +
|
|
"/analytics.min.js";
|
|
const a: any = document.getElementsByTagName("script")[0];
|
|
a.parentNode.insertBefore(n, a);
|
|
analytics._loadOptions = e;
|
|
};
|
|
analytics.SNIPPET_VERSION = "4.1.0";
|
|
analytics.load(key);
|
|
analytics.page();
|
|
}
|
|
})(window);
|
|
}
|
|
|
|
static logEvent(eventName: EventName, eventData: any = {}) {
|
|
const windowDoc: any = window;
|
|
let finalEventData = eventData;
|
|
const userData = AnalyticsUtil.user;
|
|
const appId = getApplicationId(windowDoc.location);
|
|
if (userData) {
|
|
const { segment } = getAppsmithConfigs();
|
|
let user: any = {};
|
|
if (segment.apiKey) {
|
|
user = {
|
|
userId: userData.username,
|
|
email: userData.email,
|
|
appId: appId,
|
|
source: "cloud",
|
|
};
|
|
} else {
|
|
const userId = userData.username;
|
|
if (userId !== AnalyticsUtil.cachedUserId) {
|
|
AnalyticsUtil.cachedAnonymoustId = sha256(userId);
|
|
AnalyticsUtil.cachedUserId = userId;
|
|
}
|
|
user = {
|
|
userId: AnalyticsUtil.cachedAnonymoustId,
|
|
source: "ce",
|
|
};
|
|
}
|
|
finalEventData = {
|
|
...eventData,
|
|
userData: user.userId === ANONYMOUS_USERNAME ? undefined : user,
|
|
};
|
|
}
|
|
|
|
if (windowDoc.analytics) {
|
|
log.debug("Event fired", eventName, finalEventData);
|
|
windowDoc.analytics.track(eventName, finalEventData);
|
|
} else {
|
|
log.debug("Event fired locally", eventName, finalEventData);
|
|
}
|
|
}
|
|
|
|
static identifyUser(userData: User) {
|
|
const { segment, sentry, smartLook } = getAppsmithConfigs();
|
|
const windowDoc: any = window;
|
|
const userId = userData.username;
|
|
if (windowDoc.analytics) {
|
|
// This flag is only set on Appsmith Cloud. In this case, we get more detailed analytics of the user
|
|
if (segment.apiKey) {
|
|
const userProperties = {
|
|
email: userData.email,
|
|
name: userData.name,
|
|
userId: userId,
|
|
source: "cloud",
|
|
};
|
|
AnalyticsUtil.user = userData;
|
|
log.debug("Identify User " + userId);
|
|
windowDoc.analytics.identify(userId, userProperties);
|
|
} else if (segment.ceKey) {
|
|
// This is a self-hosted instance. Only send data if the analytics are NOT disabled by the user
|
|
// This is done by setting environment variable APPSMITH_DISABLE_TELEMETRY in the docker.env file
|
|
if (userId !== AnalyticsUtil.cachedUserId) {
|
|
AnalyticsUtil.cachedAnonymoustId = sha256(userId);
|
|
AnalyticsUtil.cachedUserId = userId;
|
|
}
|
|
const userProperties = {
|
|
userId: AnalyticsUtil.cachedAnonymoustId,
|
|
source: "ce",
|
|
};
|
|
log.debug(
|
|
"Identify Anonymous User " + AnalyticsUtil.cachedAnonymoustId,
|
|
);
|
|
windowDoc.analytics.identify(
|
|
AnalyticsUtil.cachedAnonymoustId,
|
|
userProperties,
|
|
);
|
|
}
|
|
}
|
|
|
|
if (sentry.enabled) {
|
|
Sentry.configureScope(function(scope) {
|
|
scope.setUser({
|
|
id: userId,
|
|
username: userData.username,
|
|
email: userData.email,
|
|
});
|
|
});
|
|
}
|
|
|
|
if (smartLook.enabled) {
|
|
smartlookClient.identify(userId, { email: userData.email });
|
|
}
|
|
}
|
|
|
|
static reset() {
|
|
const windowDoc: any = window;
|
|
if (windowDoc.Intercom) {
|
|
windowDoc.Intercom("shutdown");
|
|
}
|
|
windowDoc.analytics && windowDoc.analytics.reset();
|
|
windowDoc.mixpanel && windowDoc.mixpanel.reset();
|
|
}
|
|
}
|
|
|
|
export default AnalyticsUtil;
|