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

feat(skip): statsig integration #739

Merged
merged 5 commits into from
Jul 1, 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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
"lint": "eslint --ext .ts,.tsx src/",
"fix-lint": "eslint --fix --ext .ts,.tsx src/",
"tag": "node scripts/generate-tag.js",
"test": "vitest run",
"test": "VITE_DISABLE_STATSIG=true vitest run",
"tsc": "tsc",
"postinstall": "tar -xzC public -f tradingview/tradingview.tgz",
"prepare": "husky",
Expand All @@ -49,7 +49,7 @@
"@cosmjs/proto-signing": "^0.32.1",
"@cosmjs/stargate": "^0.32.1",
"@cosmjs/tendermint-rpc": "^0.32.1",
"@dydxprotocol/v4-abacus": "1.8.6",
"@dydxprotocol/v4-abacus": "1.8.15",
"@dydxprotocol/v4-client-js": "^1.1.24",
"@dydxprotocol/v4-localization": "^1.1.140",
"@ethersproject/providers": "^5.7.2",
Expand Down Expand Up @@ -87,6 +87,8 @@
"@scure/bip32": "^1.3.0",
"@scure/bip39": "^1.2.0",
"@skip-router/core": "^5.1.0",
"@statsig/js-client": "1.4.0",
"@statsig/react-bindings": "1.4.0",
"@tanstack/react-query": "^5.37.1",
"@types/lodash": "^4.14.195",
"@types/styled-components": "^5.1.26",
Expand Down
34 changes: 29 additions & 5 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 2 additions & 0 deletions src/App.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@ import { LocaleProvider } from '@/hooks/useLocaleSeparators';
import { NotificationsProvider } from '@/hooks/useNotifications';
import { PotentialMarketsProvider } from '@/hooks/usePotentialMarkets';
import { RestrictionProvider } from '@/hooks/useRestrictions';
import { StatsigProvider } from '@/hooks/useStatsig';
import { SubaccountProvider } from '@/hooks/useSubaccount';

import '@/styles/constants.css';
Expand Down Expand Up @@ -159,6 +160,7 @@ const providers = [
clientId: import.meta.env.VITE_PRIVY_APP_CLIENT_ID,
config: privyConfig,
}),
wrapProvider(StatsigProvider),
wrapProvider(QueryClientProvider, { client: queryClient }),
wrapProvider(GrazProvider),
wrapProvider(PrivyWagmiConnector, { wagmiChainsConfig: configureChainsConfig }),
Expand Down
1 change: 1 addition & 0 deletions src/constants/abacus.ts
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,7 @@ export type MarketHistoricalFunding = Abacus.exchange.dydx.abacus.output.MarketH
export const PerpetualMarketType = Abacus.exchange.dydx.abacus.output.PerpetualMarketType;

// ------ Configs ------ //
export const StatsigConfig = Abacus.exchange.dydx.abacus.state.manager.StatsigConfig;
export type Configs = Abacus.exchange.dydx.abacus.output.Configs;
export type FeeDiscount = Abacus.exchange.dydx.abacus.output.FeeDiscount;
export type FeeTier = Abacus.exchange.dydx.abacus.output.FeeTier;
Expand Down
5 changes: 5 additions & 0 deletions src/constants/analytics.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { StatSigFlags } from '@/types/statsig';
import { RecordOf, TagsOf, UnionOf, ofType, unionize } from 'unionize';

import type { AbacusApiStatus, HumanReadablePlaceOrderPayload } from './abacus';
Expand Down Expand Up @@ -51,6 +52,9 @@ export const AnalyticsUserProperties = unionize(
>(),
Version: ofType<string | null>(),

// StatSigFlags
StatsigFlags: ofType<{ [key in StatSigFlags]?: boolean }>(),

// Network
Network: ofType<DydxNetwork>(),

Expand All @@ -70,6 +74,7 @@ export const AnalyticsUserPropertyLoggableTypes = {
Locale: 'selectedLocale',
Breakpoint: 'breakpoint',
Version: 'version',
StatsigFlags: 'statsigFlags',
Network: 'network',
WalletType: 'walletType',
WalletConnectionType: 'walletConnectionType',
Expand Down
8 changes: 7 additions & 1 deletion src/hooks/useAnalytics.ts
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,14 @@ import { useApiState } from './useApiState';
import { useBreakpoints } from './useBreakpoints';
import { useDydxClient } from './useDydxClient';
import { useSelectedNetwork } from './useSelectedNetwork';
import { useAllStatsigGateValues } from './useStatsig';

export const useAnalytics = () => {
const latestTag = import.meta.env.VITE_LAST_TAG;
const { walletType, walletConnectionType, evmAddress, dydxAddress, selectedWalletType } =
useAccounts();
const { indexerClient } = useDydxClient();

const statsigConfig = useAllStatsigGateValues();
/** User properties */

// AnalyticsUserProperty.Breakpoint
Expand Down Expand Up @@ -67,6 +68,11 @@ export const useAnalytics = () => {
}
}, [latestTag]);

// AnalyticsUserProperty.StatsigConfigs
useEffect(() => {
identify(AnalyticsUserProperties.StatsigFlags(statsigConfig));
}, [statsigConfig]);

// AnalyticsUserProperty.Network
const { selectedNetwork } = useSelectedNetwork();

Expand Down
5 changes: 4 additions & 1 deletion src/hooks/useInitializePage.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ import abacusStateManager from '@/lib/abacus';
import { validateAgainstAvailableEnvironments } from '@/lib/network';

import { useLocalStorage } from './useLocalStorage';
import { useAllStatsigGateValues } from './useStatsig';

export const useInitializePage = () => {
const dispatch = useAppDispatch();
Expand All @@ -20,9 +21,11 @@ export const useInitializePage = () => {
defaultValue: DEFAULT_APP_ENVIRONMENT,
validateFn: validateAgainstAvailableEnvironments,
});
const statsigConfig = useAllStatsigGateValues();

useEffect(() => {
dispatch(initializeLocalization());
abacusStateManager.setStatsigConfigs(statsigConfig);
abacusStateManager.start({ network: localStorageNetwork });
}, []);
}, [dispatch, localStorageNetwork, statsigConfig]);
};
6 changes: 4 additions & 2 deletions src/hooks/useLocalNotifications.tsx
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import { createContext, useCallback, useContext, useEffect } from 'react';

import { StatSigFlags } from '@/types/statsig';
import { useQuery } from '@tanstack/react-query';

import { AnalyticsEvents } from '@/constants/analytics';
Expand All @@ -13,6 +14,7 @@ import { STATUS_ERROR_GRACE_PERIOD, fetchTransferStatus, trackSkipTx } from '@/l

import { useEndpointsConfig } from './useEndpointsConfig';
import { useLocalStorage } from './useLocalStorage';
import { useStatsigGateValue } from './useStatsig';

const LocalNotificationsContext = createContext<
ReturnType<typeof useLocalNotificationsContext> | undefined
Expand All @@ -31,6 +33,8 @@ const ERROR_COUNT_THRESHOLD = 3;

const useLocalNotificationsContext = () => {
const { skip } = useEndpointsConfig();
const useSkip = useStatsigGateValue(StatSigFlags.ffSkipMigration);

const [allTransferNotifications, setAllTransferNotifications] = useLocalStorage<{
[key: `dydx${string}`]: TransferNotifcation[];
version: string;
Expand Down Expand Up @@ -132,8 +136,6 @@ const useLocalNotificationsContext = () => {
chainId: fromChainId,
baseUrl: skip,
};
// TODO: replace with statsig call
const useSkip = false;
if (!tracked && useSkip) {
const { tx_hash: trackedTxHash } = await trackSkipTx(skipParams);
// if no tx hash was returned, transfer has not yet been tracked
Expand Down
39 changes: 39 additions & 0 deletions src/hooks/useStatsig.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
import { useEffect, useMemo, useState } from 'react';

import { StatSigFlags, StatsigConfigType } from '@/types/statsig';
import { StatsigClient } from '@statsig/js-client';
import {
StatsigProvider as StatsigProviderInternal,
useStatsigClient,
} from '@statsig/react-bindings';

import { initStatsig } from '@/lib/statsig';

export const StatsigProvider = ({ children }: { children: React.ReactNode }) => {
const [client, setClient] = useState<StatsigClient | null>(null);
useEffect(() => {
const setAsyncClient = async () => {
const statsigClient = await initStatsig();
setClient(statsigClient);
};
setAsyncClient();
}, [initStatsig]);
// if no client, render without provider until a client exists
if (!client) return <div>{children}</div>;
return <StatsigProviderInternal client={client}> {children} </StatsigProviderInternal>;
};

export const useStatsigGateValue = (gate: StatSigFlags) => {
const { checkGate } = useStatsigClient();
return checkGate(gate);
};

export const useAllStatsigGateValues = () => {
const { checkGate } = useStatsigClient();
const allGateValues = useMemo(() => {
return Object.values(StatSigFlags).reduce((acc, gate) => {
return { ...acc, [gate]: checkGate(gate) };
}, {} as StatsigConfigType);
}, []);
return allGateValues;
};
20 changes: 18 additions & 2 deletions src/lib/abacus/index.ts
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
// eslint-disable-next-line import/no-cycle
import { StatSigFlags } from '@/types/statsig';
import type { LocalWallet, SelectedGasDenom } from '@dydxprotocol/v4-client-js';

import type {
Expand Down Expand Up @@ -29,6 +31,7 @@ import {
HistoricalPnlPeriod,
IOImplementations,
OnboardingConfig,
StatsigConfig,
TradeInputField,
TransferInputField,
TransferType,
Expand All @@ -46,7 +49,6 @@ import { getInputTradeOptions, getTransferInputs } from '@/state/inputsSelectors

import { LocaleSeparators } from '../numbers';
import AbacusAnalytics from './analytics';
// eslint-disable-next-line import/no-cycle
import AbacusChainTransaction from './dydxChainTransactions';
import AbacusFileSystem from './filesystem';
import AbacusFormatter from './formatter';
Expand Down Expand Up @@ -103,7 +105,6 @@ class AbacusStateManager {

const appConfigs = AbacusAppConfig.Companion.forWebAppWithIsolatedMargins;
appConfigs.onboardingConfigs.squidVersion = OnboardingConfig.SquidVersion.V2;

this.stateManager = new AsyncAbacusStateManager(
'',
CURRENT_ABACUS_DEPLOYMENT,
Expand Down Expand Up @@ -409,6 +410,21 @@ class AbacusStateManager {
getChainById = (chainId: string) => {
return this.stateManager.getChainById(chainId);
};

/**
*
* Updates Abacus' global StatsigConfig object.
* You must destructure the new flag you want to use from the config and set
* the relevant property on the StatsigConfig object.
*
* TODO: establish standardized naming conventions between
* statsig FF name and boolean propery in abacus StatsigConfig
* https://linear.app/dydx/project/feature-experimentation-6853beb333d7/overview
*/
setStatsigConfigs = (statsigConfig: { [key in StatSigFlags]?: boolean }) => {
const { [StatSigFlags.ffSkipMigration]: useSkip = false } = statsigConfig;
StatsigConfig.useSkip = useSkip;
};
}

const abacusStateManager = new AbacusStateManager();
Expand Down
17 changes: 17 additions & 0 deletions src/lib/statsig.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
import { StatsigClient } from '@statsig/js-client';

let statsigClient: StatsigClient;

export const initStatsig = async () => {
if (statsigClient) return statsigClient;
statsigClient = new StatsigClient(
import.meta.env.VITE_STATSIG_CLIENT_KEY,
{},
{
disableLogging: import.meta.env.VITE_DISABLE_STATSIG,
disableStorage: import.meta.env.VITE_DISABLE_STATSIG,
}
);
await statsigClient.initializeAsync();
return statsigClient;
};
5 changes: 5 additions & 0 deletions src/types/statsig.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
export type StatsigConfigType = Record<StatSigFlags, boolean>;

export enum StatSigFlags {
ffSkipMigration = 'ff_skip_migration',
}
Loading