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

Move from zod to valibot to reduce the frontend bundle size #4026

Merged
merged 1 commit into from
Feb 13, 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
37 changes: 17 additions & 20 deletions frontend/package-lock.json

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

5 changes: 2 additions & 3 deletions frontend/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,6 @@
"@radix-ui/react-dialog": "^1.1.6",
"@tanstack/react-query": "^5.66.0",
"@tanstack/react-router": "^1.102.5",
"@tanstack/router-zod-adapter": "^1.81.5",
"@vector-im/compound-design-tokens": "3.0.1",
"@vector-im/compound-web": "^7.6.2",
"@zxcvbn-ts/core": "^3.0.4",
Expand All @@ -36,8 +35,8 @@
"react-dom": "^19.0.0",
"react-i18next": "^15.4.0",
"swagger-ui-dist": "^5.18.3",
"vaul": "^1.1.2",
"zod": "^3.24.2"
"valibot": "^1.0.0-rc.0",
"vaul": "^1.1.2"
},
"devDependencies": {
"@biomejs/biome": "^1.9.4",
Expand Down
34 changes: 17 additions & 17 deletions frontend/src/pagination.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
// Please see LICENSE in the repository root for full details.

import { useState } from "react";
import * as z from "zod";
import * as v from "valibot";

// PageInfo we get on connections from the GraphQL API
type PageInfo = {
Expand All @@ -18,32 +18,32 @@ type PageInfo = {
export const FIRST_PAGE = Symbol("FIRST_PAGE");
const LAST_PAGE = Symbol("LAST_PAGE");

export const anyPaginationSchema = z.object({
first: z.number().nullish(),
after: z.string().nullish(),
last: z.number().nullish(),
before: z.string().nullish(),
export const anyPaginationSchema = v.object({
first: v.nullish(v.number()),
after: v.nullish(v.string()),
last: v.nullish(v.number()),
before: v.nullish(v.string()),
});

const forwardPaginationSchema = z.object({
first: z.number(),
after: z.string().nullish(),
const forwardPaginationSchema = v.object({
first: v.number(),
after: v.nullish(v.string()),
});

const backwardPaginationSchema = z.object({
last: z.number(),
before: z.string().nullish(),
const backwardPaginationSchema = v.object({
last: v.number(),
before: v.nullish(v.string()),
});

const paginationSchema = z.union([
const paginationSchema = v.union([
forwardPaginationSchema,
backwardPaginationSchema,
]);

type ForwardPagination = z.infer<typeof forwardPaginationSchema>;
type BackwardPagination = z.infer<typeof backwardPaginationSchema>;
export type Pagination = z.infer<typeof paginationSchema>;
export type AnyPagination = z.infer<typeof anyPaginationSchema>;
type ForwardPagination = v.InferOutput<typeof forwardPaginationSchema>;
type BackwardPagination = v.InferOutput<typeof backwardPaginationSchema>;
export type Pagination = v.InferOutput<typeof paginationSchema>;
export type AnyPagination = v.InferOutput<typeof anyPaginationSchema>;

// Check if the pagination is a valid pagination
const isValidPagination = (
Expand Down
53 changes: 26 additions & 27 deletions frontend/src/routes/_account.index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@

import { queryOptions } from "@tanstack/react-query";
import { createFileRoute, redirect } from "@tanstack/react-router";
import { zodSearchValidator } from "@tanstack/router-zod-adapter";
import * as z from "zod";
import * as v from "valibot";
import { query as userEmailListQuery } from "../components/UserProfile/UserEmailList";
import { graphql } from "../gql";
import { graphqlRequest } from "../graphql";
Expand Down Expand Up @@ -38,39 +37,39 @@ export const query = queryOptions({
queryFn: ({ signal }) => graphqlRequest({ query: QUERY, signal }),
});

const actionSchema = z
.discriminatedUnion("action", [
z.object({
action: z.enum(["profile", "org.matrix.profile"]),
const actionSchema = v.variant("action", [
v.object({
action: v.picklist(["profile", "org.matrix.profile"]),
}),
v.object({
action: v.picklist(["sessions_list", "org.matrix.sessions_list"]),
}),
v.object({
action: v.picklist(["session_view", "org.matrix.session_view"]),
device_id: v.optional(v.string()),
}),
v.object({
action: v.picklist(["session_end", "org.matrix.session_end"]),
device_id: v.optional(v.string()),
}),
v.object({
action: v.literal("org.matrix.cross_signing_reset"),
}),
v.partial(
v.looseObject({
action: v.never(),
}),
z.object({
action: z.enum(["sessions_list", "org.matrix.sessions_list"]),
}),
z.object({
action: z.enum(["session_view", "org.matrix.session_view"]),
device_id: z.string().optional(),
}),
z.object({
action: z.enum(["session_end", "org.matrix.session_end"]),
device_id: z.string().optional(),
}),
z.object({
action: z.literal("org.matrix.cross_signing_reset"),
}),
z.object({
action: z.undefined(),
}),
])
.catch({ action: undefined });
),
]);

export const Route = createFileRoute("/_account/")({
validateSearch: zodSearchValidator(actionSchema),
validateSearch: actionSchema,

beforeLoad({ search }) {
switch (search.action) {
case "profile":
case "org.matrix.profile":
throw redirect({ to: "/" });
throw redirect({ to: "/", search: {} });

case "sessions_list":
case "org.matrix.sessions_list":
Expand Down
16 changes: 8 additions & 8 deletions frontend/src/routes/_account.sessions.browsers.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
// Please see LICENSE in the repository root for full details.

import { createFileRoute } from "@tanstack/react-router";
import { zodSearchValidator } from "@tanstack/router-zod-adapter";
import * as z from "zod";
import * as v from "valibot";

import { queryOptions } from "@tanstack/react-query";
import { graphql } from "../gql";
Expand Down Expand Up @@ -81,14 +80,15 @@ export const query = (pagination: AnyPagination, inactive: true | undefined) =>
}),
});

const searchSchema = z
.object({
inactive: z.literal(true).optional(),
})
.and(anyPaginationSchema);
const searchSchema = v.intersect([
v.object({
inactive: v.optional(v.literal(true)),
}),
anyPaginationSchema,
]);

export const Route = createFileRoute("/_account/sessions/browsers")({
validateSearch: zodSearchValidator(searchSchema),
validateSearch: searchSchema,

loaderDeps: ({ search: { inactive, ...pagination } }) => ({
inactive,
Expand Down
16 changes: 8 additions & 8 deletions frontend/src/routes/_account.sessions.index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,7 @@
// Please see LICENSE in the repository root for full details.

import { createFileRoute } from "@tanstack/react-router";
import { zodSearchValidator } from "@tanstack/router-zod-adapter";
import * as z from "zod";
import * as v from "valibot";

import { queryOptions } from "@tanstack/react-query";
import { graphql } from "../gql";
Expand Down Expand Up @@ -98,14 +97,15 @@ export const listQuery = (
}),
});

const searchSchema = z
.object({
inactive: z.literal(true).optional(),
})
.and(anyPaginationSchema);
const searchSchema = v.intersect([
v.object({
inactive: v.optional(v.literal(true)),
}),
anyPaginationSchema,
]);

export const Route = createFileRoute("/_account/sessions/")({
validateSearch: zodSearchValidator(searchSchema),
validateSearch: searchSchema,

loaderDeps: ({ search: { inactive, ...pagination } }) => ({
inactive,
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/routes/emails.$id.in-use.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ function EmailInUse(): React.ReactElement {
})}
/>

<ButtonLink as="a" Icon={IconArrowLeft} kind="tertiary" to="/">
<ButtonLink Icon={IconArrowLeft} kind="tertiary" to="/">
{t("action.back")}
</ButtonLink>
</Layout>
Expand Down
2 changes: 1 addition & 1 deletion frontend/src/routes/emails.$id.verify.lazy.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -189,7 +189,7 @@ function EmailVerify(): React.ReactElement {
{t("frontend.verify_email.resend_code")}
</Button>

<ButtonLink as="a" Icon={IconArrowLeft} kind="tertiary" to="/">
<ButtonLink Icon={IconArrowLeft} kind="tertiary" to="/">
{t("action.back")}
</ButtonLink>
</Form.Root>
Expand Down
9 changes: 4 additions & 5 deletions frontend/src/routes/password.recovery.index.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@

import { queryOptions } from "@tanstack/react-query";
import { createFileRoute, notFound } from "@tanstack/react-router";
import { zodSearchValidator } from "@tanstack/router-zod-adapter";
import * as z from "zod";
import * as v from "valibot";
import { graphql } from "../gql";
import { graphqlRequest } from "../graphql";

Expand All @@ -31,12 +30,12 @@ export const query = (ticket: string) =>
graphqlRequest({ query: QUERY, signal, variables: { ticket } }),
});

const schema = z.object({
ticket: z.string(),
const schema = v.object({
ticket: v.string(),
});

export const Route = createFileRoute("/password/recovery/")({
validateSearch: zodSearchValidator(schema),
validateSearch: schema,

loaderDeps: ({ search: { ticket } }) => ({ ticket }),

Expand Down
9 changes: 4 additions & 5 deletions frontend/src/routes/reset-cross-signing.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,21 @@ import {
Outlet,
createFileRoute,
} from "@tanstack/react-router";
import { zodSearchValidator } from "@tanstack/router-zod-adapter";
import IconError from "@vector-im/compound-design-tokens/assets/web/icons/error";
import { Button, Text } from "@vector-im/compound-web";
import * as z from "zod";
import * as v from "valibot";

import { useTranslation } from "react-i18next";
import BlockList from "../components/BlockList";
import Layout from "../components/Layout";
import PageHeading from "../components/PageHeading";

const searchSchema = z.object({
deepLink: z.boolean().optional(),
const searchSchema = v.object({
deepLink: v.optional(v.boolean()),
});

export const Route = createFileRoute("/reset-cross-signing")({
validateSearch: searchSchema,
component: () => (
<Layout>
<BlockList>
Expand All @@ -31,7 +31,6 @@ export const Route = createFileRoute("/reset-cross-signing")({
</Layout>
),
errorComponent: ResetCrossSigningError,
validateSearch: zodSearchValidator(searchSchema),
});

function ResetCrossSigningError({
Expand Down
Loading