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

Add theme origin mismatch warning #1192

Merged
merged 2 commits into from
Jan 6, 2025
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
2 changes: 1 addition & 1 deletion packages/keychain/.storybook/mock.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ export function useMockedConnection({
chainId,
chainName,
policies: {},
theme: defaultTheme,
theme: { defaultTheme, verified: true },
hasPrefundRequest: false,
error: undefined,
setContext: () => {},
Expand Down
3 changes: 2 additions & 1 deletion packages/keychain/.storybook/preview.tsx
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
import React from "react";
import type { Preview, ReactRenderer } from "@storybook/react";
import { withThemeByClassName } from "@storybook/addon-themes";
import { SonnerToaster } from "@cartridge/ui-next";

import { StoryParameters } from "./mock";
import { Provider } from "./provider";

import "../src/index.css";
import { SonnerToaster } from "@cartridge/ui-next";

const preview: Preview = {
parameters: {
Expand Down
31 changes: 18 additions & 13 deletions packages/keychain/.storybook/provider.tsx
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
import React, { PropsWithChildren } from "react";
import { QueryClient, QueryClientProvider } from "react-query";
import { ConnectionContext } from "../src/components/Provider/connection";
import {
defaultTheme,
controllerConfigs,
ControllerTheme,
} from "@cartridge/presets";
import { controllerConfigs } from "@cartridge/presets";
import { mainnet } from "@starknet-react/chains";
import { StarknetConfig, publicProvider, voyager } from "@starknet-react/core";
import { useThemeEffect } from "@cartridge/ui-next";
import { StoryParameters, useMockedConnection } from "./mock";
import { ControllerThemeContext } from "../src/context/theme";
import { ChakraProvider } from "@chakra-ui/react";
import { useChakraTheme } from "../src/hooks/theme";
import { BrowserRouter } from "react-router-dom";

import { ConnectionContext } from "../src/components/Provider/connection";
import { StoryParameters, useMockedConnection } from "./mock";
import {
ControllerThemeContext,
VerifiableControllerTheme,
} from "../src/context/theme";
import { useChakraTheme } from "../src/hooks/theme";

export function Provider({
children,
parameters,
Expand All @@ -23,6 +23,11 @@ export function Provider({

if (parameters.preset) {
const config = controllerConfigs[parameters.preset];

if (parameters.preset === "cartridge" && config.theme) {
(config.theme as VerifiableControllerTheme).verified = true;
}

connection.theme = config.theme || connection.theme;
connection.policies = config.policies || connection.policies;
}
Expand All @@ -48,13 +53,13 @@ const queryClient = new QueryClient();

function ControllerThemeProvider({
children,
theme = defaultTheme,
}: PropsWithChildren<{ theme?: ControllerTheme }>) {
theme,
}: PropsWithChildren<{ theme: VerifiableControllerTheme }>) {
useThemeEffect({ theme, assetUrl: "" });
const chakraTheme = useChakraTheme(theme);
const chakraTheme = useChakraTheme({ ...theme });

return (
<ControllerThemeContext.Provider value={theme}>
<ControllerThemeContext.Provider value={{ ...theme }}>
<ChakraProvider theme={chakraTheme}>{children}</ChakraProvider>
</ControllerThemeContext.Provider>
);
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ const meta = {
session: () => true,
},
context: {
origin: "http://localhost:3002",
origin: "http://localhost:6001",
type: "execute",
transactions: [
{
Expand Down
4 changes: 2 additions & 2 deletions packages/keychain/src/components/Provider/connection.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@ import { createContext } from "react";
import Controller from "@/utils/controller";
import { ConnectionCtx } from "@/utils/connection";
import { UpgradeInterface } from "@/hooks/upgrade";
import { ControllerTheme } from "@cartridge/presets";
import { ParsedSessionPolicies } from "@/hooks/session";
import { VerifiableControllerTheme } from "@/context/theme";

export const ConnectionContext = createContext<
ConnectionContextValue | undefined
Expand All @@ -17,7 +17,7 @@ export type ConnectionContextValue = {
chainId?: string;
chainName?: string;
policies?: ParsedSessionPolicies;
theme: ControllerTheme;
theme: VerifiableControllerTheme;
hasPrefundRequest: boolean;
error?: Error;
upgrade: UpgradeInterface;
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { Meta, StoryObj } from "@storybook/react";
import { CreateControllerView } from "./CreateController";
import { ControllerTheme } from "@cartridge/presets";
import { VerifiableControllerTheme } from "@/context/theme";

const meta: Meta<typeof CreateControllerView> = {
component: CreateControllerView,
Expand All @@ -17,7 +17,8 @@ export const Default: Story = {
args: {
theme: {
name: "Cartridge",
} as ControllerTheme,
verified: true,
} as VerifiableControllerTheme,
usernameField: {
value: "",
error: undefined,
Expand All @@ -41,7 +42,8 @@ export const WithLightMode: Story = {
args: {
theme: {
name: "Cartridge",
} as ControllerTheme,
verified: true,
} as VerifiableControllerTheme,
usernameField: {
value: "",
error: undefined,
Expand All @@ -65,7 +67,7 @@ export const WithTheme: Story = {
args: {
theme: {
name: "Eternum",
} as ControllerTheme,
} as VerifiableControllerTheme,
usernameField: {
value: "",
error: undefined,
Expand All @@ -86,7 +88,8 @@ export const WithTimeoutError: Story = {
args: {
theme: {
name: "Cartridge",
} as ControllerTheme,
verified: true,
} as VerifiableControllerTheme,
usernameField: {
value: "username",
error: undefined,
Expand All @@ -108,7 +111,8 @@ export const WithValidationError: Story = {
args: {
theme: {
name: "Cartridge",
} as ControllerTheme,
verified: true,
} as VerifiableControllerTheme,
usernameField: {
value: "@#$!",
},
Expand All @@ -129,7 +133,8 @@ export const WithGenericError: Story = {
args: {
theme: {
name: "Cartridge",
} as ControllerTheme,
verified: true,
} as VerifiableControllerTheme,
usernameField: {
value: "username",
error: undefined,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,12 @@ import { useUsernameValidation } from "./useUsernameValidation";
import { LoginMode } from "../types";
import { Legal, StatusTray } from ".";
import { useCreateController } from "./useCreateController";
import { ControllerTheme } from "@cartridge/presets";
import { Input } from "@cartridge/ui-next";
import { ErrorAlert } from "@/components/ErrorAlert";
import { VerifiableControllerTheme } from "@/context/theme";

interface CreateControllerViewProps {
theme: ControllerTheme;
theme: VerifiableControllerTheme;
usernameField: {
value: string;
error?: string;
Expand Down Expand Up @@ -87,6 +88,17 @@ export function CreateControllerView({
</Content>

<Footer showCatridgeLogo>
{!theme.verified && (
<div className="mb-5">
<ErrorAlert
title="Please proceed with caution"
description="Application domain does not match the configured domain."
variant="warning"
isExpanded
/>
</div>
)}

<Legal />

<Button
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export function StatusTray({
)}
</Text>
{isTimeoutError && (
<div className="w-full flex items-center justify-between text-xs font-semibold px-4">
<div className="w-full flex items-center justify-between text-xs font-semibold px-4 text-secondary">
<div>Having trouble signing up?</div>
<Link
className="flex items-center gap-1.5 hover:underline"
Expand Down
6 changes: 5 additions & 1 deletion packages/keychain/src/context/theme.tsx
Original file line number Diff line number Diff line change
@@ -1,6 +1,10 @@
import { ControllerTheme } from "@cartridge/presets";
import { createContext } from "react";

export type VerifiableControllerTheme = ControllerTheme & {
verified: boolean;
};

export const ControllerThemeContext = createContext<
ControllerTheme | undefined
VerifiableControllerTheme | undefined
>(undefined);
57 changes: 40 additions & 17 deletions packages/keychain/src/hooks/connection.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,11 @@ import {
} from "@/utils/connection";
import { getChainName, isIframe } from "@cartridge/utils";
import { RpcProvider } from "starknet";
import { ResponseCodes, toSessionPolicies } from "@cartridge/controller";
import {
ResponseCodes,
toArray,
toSessionPolicies,
} from "@cartridge/controller";
import { setIsSignedUp } from "@/utils/cookie";
import {
ConnectionContext,
Expand All @@ -23,6 +27,7 @@ import {
ControllerTheme,
} from "@cartridge/presets";
import { ParsedSessionPolicies, parseSessionPolicies } from "./session";
import { VerifiableControllerTheme } from "@/context/theme";

type ParentMethods = AsyncMethodReturns<{ close: () => Promise<void> }>;

Expand All @@ -35,7 +40,10 @@ export function useConnectionValue() {
);
const [chainId, setChainId] = useState<string>();
const [policies, setPolicies] = useState<ParsedSessionPolicies>();
const [theme, setTheme] = useState<ControllerTheme>(defaultTheme);
const [theme, setTheme] = useState<VerifiableControllerTheme>({
verified: true,
...defaultTheme,
});
const [controller, setControllerRaw] = useState<Controller | undefined>();
const [hasPrefundRequest, setHasPrefundRequest] = useState<boolean>(false);
const upgrade: UpgradeInterface = useUpgrade(controller);
Expand Down Expand Up @@ -120,9 +128,19 @@ export function useConnectionValue() {
const decodedPreset = decodeURIComponent(themeParam);
try {
const parsedTheme = JSON.parse(decodedPreset) as ControllerTheme;
setTheme(parsedTheme);
} catch {
setTheme(controllerConfigs[decodedPreset].theme || defaultTheme);
setTheme({
...parsedTheme,
verified: true,
});
} catch (e) {
if (controllerConfigs[decodedPreset].theme) {
setTheme({
...controllerConfigs[decodedPreset].theme,
verified: true,
});
} else {
console.error(e);
}
}
}

Expand All @@ -145,28 +163,33 @@ export function useConnectionValue() {
}

// Application provided policies take precedence over preset policies.
if (
presetParam &&
presetParam in controllerConfigs
// TODO: Reenable
// &&
// origin &&
// (origin.startsWith("http://localhost") ||
// toArray(controllerConfigs[presetParam].origin).includes(origin))
) {
setTheme(controllerConfigs[presetParam].theme || defaultTheme);
if (presetParam && presetParam in controllerConfigs) {
const allowedOrigins = toArray(controllerConfigs[presetParam].origin);
const verified =
origin &&
allowedOrigins.some((allowedOrigin) => {
const originUrl = new URL(origin);
return originUrl.hostname === allowedOrigin;
});

if (controllerConfigs[presetParam].theme) {
setTheme({
verified: !!verified,
...controllerConfigs[presetParam].theme,
});
}

// Set policies from preset if no URL policies
if (!policiesParam && controllerConfigs[presetParam].policies) {
setPolicies(
parseSessionPolicies({
verified: true,
verified: !!verified,
policies: controllerConfigs[presetParam].policies,
}),
);
}
}
}, [setTheme, setPolicies, setHasPrefundRequest, setOrigin]);
}, [origin, setTheme, setPolicies, setHasPrefundRequest, setOrigin]);

useEffect(() => {
const connection = connectToController<ParentMethods>({
Expand Down
13 changes: 9 additions & 4 deletions packages/keychain/src/hooks/theme.tsx
Original file line number Diff line number Diff line change
@@ -1,18 +1,23 @@
import { ControllerThemeContext } from "@/context/theme";
import { ControllerColor, ControllerTheme } from "@cartridge/presets";
import {
ControllerThemeContext,
VerifiableControllerTheme,
} from "@/context/theme";
import { ControllerColor } from "@cartridge/presets";
import { CartridgeTheme } from "@cartridge/ui";
import { useContext, useMemo } from "react";

export function useControllerTheme() {
const ctx = useContext<ControllerTheme | undefined>(ControllerThemeContext);
const ctx = useContext<VerifiableControllerTheme | undefined>(
ControllerThemeContext,
);
if (!ctx) {
throw new Error("ControllerThemeProvider must be placed");
}

return ctx;
}

export function useChakraTheme(preset: ControllerTheme) {
export function useChakraTheme(preset: VerifiableControllerTheme) {
return useMemo(
() => ({
...CartridgeTheme,
Expand Down
2 changes: 1 addition & 1 deletion scripts/update-storybook-snapshot.sh
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
docker run \
--rm \
-v "$(pwd)":/app \
-v "$(pwd)"/node_modules:/app/node_modules \
-v /app/node_modules \
--ipc=host \
ghcr.io/cartridge-gg/controller/storybook-env:sha-91a2d36 \
bash -c "
Expand Down
Loading