Rallly is an open-source scheduling and collaboration tool designed to make organizing events and meetings easier.
TypeScript i18nextnext-authnextjspostgresqlprismareact-emailt3-stacktailwindcsstrpcturborepotypescriptzod
⚡️ Use dedicated cookie for handling locale (#1960)
Luke Vellab544af9b7857
diff --git a/apps/web/public/locales/en/app.json b/apps/web/public/locales/en/app.jsonindex 0c229561b..e96ae6ee2 100644--- a/apps/web/public/locales/en/app.json+++ b/apps/web/public/locales/en/app.json@@ -498,5 +498,6 @@"space": "Space","preferencesDescription": "Manage your preferences","spaceSettings": "Space Settings",- "generalSettingsAdminRoleRequired": "You need to be an admin to make changes to this space."+ "generalSettingsAdminRoleRequired": "You need to be an admin to make changes to this space.",+ "localeSyncToast": "Your language preferences have changed"}diff --git a/apps/web/src/app/[locale]/(space)/settings/preferences/components/language-preference.tsx b/apps/web/src/app/[locale]/(space)/settings/preferences/components/language-preference.tsxindex 5d9faeb7b..09d905dcc 100644--- a/apps/web/src/app/[locale]/(space)/settings/preferences/components/language-preference.tsx+++ b/apps/web/src/app/[locale]/(space)/settings/preferences/components/language-preference.tsx@@ -10,6 +10,7 @@ import { LanguageSelect } from "@/components/poll/language-selector";import { Trans } from "@/components/trans";import { useTranslation } from "@/i18n/client";+import { setLocaleCookie } from "@/lib/locale/client";import { updateLocale } from "../actions";const formSchema = z.object({@@ -33,6 +34,7 @@ export const LanguagePreference = () => {onSubmit={form.handleSubmit(async (data) => {await updateLocale(data.language);i18n.changeLanguage(data.language);+ setLocaleCookie(data.language);form.reset({ language: data.language });})}>diff --git a/apps/web/src/app/[locale]/layout.tsx b/apps/web/src/app/[locale]/layout.tsxindex 8b7756b09..b6b2accea 100644--- a/apps/web/src/app/[locale]/layout.tsx+++ b/apps/web/src/app/[locale]/layout.tsx@@ -1,6 +1,5 @@import "../../style.css";-import { supportedLngs } from "@rallly/languages";import { PostHogIdentify, PostHogProvider } from "@rallly/posthog/client";import { Toaster } from "@rallly/ui/sonner";import { TooltipProvider } from "@rallly/ui/tooltip";@@ -10,14 +9,15 @@ import { Inter } from "next/font/google";import type React from "react";import { TimeZoneChangeDetector } from "@/app/[locale]/timezone-change-detector";+import type { Params } from "@/app/[locale]/types";import { requireUser } from "@/auth/data";import { UserProvider } from "@/components/user-provider";import { PreferencesProvider } from "@/contexts/preferences";import type { UserDTO } from "@/features/user/schema";import { I18nProvider } from "@/i18n/client";-import { getLocale } from "@/i18n/server/get-locale";import { FeatureFlagsProvider } from "@/lib/feature-flags/client";import { featureFlagConfig } from "@/lib/feature-flags/config";+import { LocaleSync } from "@/lib/locale/client";import { TimezoneProvider } from "@/lib/timezone/client/context";import { auth } from "@/next-auth";import { TRPCProvider } from "@/trpc/client/provider";@@ -36,7 +36,7 @@ export const viewport: Viewport = {};async function loadData() {- const [session, locale] = await Promise.all([auth(), getLocale()]);+ const [session] = await Promise.all([auth()]);const user = session?.user? !session.user.isGuest@@ -56,27 +56,19 @@ async function loadData() {return {session,- locale,user,};}export default async function Root({children,+ params,}: {children: React.ReactNode;+ params: Promise<Params>;}) {- const { locale: fallbackLocale, user } = await loadData();-- let locale = fallbackLocale;-- if (user?.locale) {- locale = user.locale;- }-- if (!supportedLngs.includes(locale)) {- locale = fallbackLocale;- }+ const { locale } = await params;+ const { user } = await loadData();return (<html lang={locale} className={inter.className}>@@ -91,6 +83,7 @@ export default async function Root({<PostHogPageView /><TooltipProvider><UserProvider user={user ?? undefined}>+ <LocaleSync userLocale={user?.locale ?? locale} /><PreferencesProviderinitialValue={{timeFormat: user?.timeFormat,diff --git a/apps/web/src/lib/locale/client.tsx b/apps/web/src/lib/locale/client.tsxnew file mode 100644index 000000000..02aa32669--- /dev/null+++ b/apps/web/src/lib/locale/client.tsx@@ -0,0 +1,39 @@+"use client";+import { toast } from "@rallly/ui/sonner";+import Cookies from "js-cookie";+import { useParams, useRouter } from "next/navigation";+import React from "react";+import { useTranslation } from "react-i18next";+import { LOCALE_COOKIE_NAME } from "@/lib/locale/constants";++export function LocaleSync({ userLocale }: { userLocale: string }) {+ const { locale } = useParams();+ const router = useRouter();+ const { t } = useTranslation();++ React.useEffect(() => {+ // update the cookie with the user locale if it's different from the current locale+ if (locale !== userLocale) {+ setLocaleCookie(userLocale);+ toast.info(+ t("localeSyncToast", {+ defaultValue: "Your language preferences changed",+ }),+ {+ action: {+ label: "Refresh",+ onClick: () => {+ router.refresh();+ },+ },+ },+ );+ }+ }, [locale, userLocale, router.refresh, t]);++ return null;+}++export function setLocaleCookie(locale: string) {+ Cookies.set(LOCALE_COOKIE_NAME, locale, { path: "/" });+}diff --git a/apps/web/src/lib/locale/constants.ts b/apps/web/src/lib/locale/constants.tsnew file mode 100644index 000000000..3279c0e43--- /dev/null+++ b/apps/web/src/lib/locale/constants.ts@@ -0,0 +1 @@+export const LOCALE_COOKIE_NAME = "rallly_locale";diff --git a/apps/web/src/lib/locale/server.ts b/apps/web/src/lib/locale/server.tsnew file mode 100644index 000000000..d3f9b3592--- /dev/null+++ b/apps/web/src/lib/locale/server.ts@@ -0,0 +1,37 @@+import { defaultLocale, supportedLngs } from "@rallly/languages";+import { getPreferredLocaleFromHeaders } from "@rallly/languages/get-preferred-locale";+import type { NextRequest, NextResponse } from "next/server";+import { LOCALE_COOKIE_NAME } from "@/lib/locale/constants";++export function getLocaleFromRequest(req: NextRequest) {+ const localeCookie = req.cookies.get(LOCALE_COOKIE_NAME);+ if (localeCookie) {+ if (supportedLngs.includes(localeCookie.value)) {+ return localeCookie.value;+ }+ }++ const acceptLanguageHeader = req.headers.get("accept-language");++ if (!acceptLanguageHeader) {+ return defaultLocale;+ }++ return getPreferredLocaleFromHeaders({+ acceptLanguageHeader,+ });+}++export function setLocaleCookie(+ req: NextRequest,+ res: NextResponse,+ locale: string,+) {+ if (req.cookies.get(LOCALE_COOKIE_NAME)) {+ return;+ }++ res.cookies.set(LOCALE_COOKIE_NAME, locale, {+ path: "/",+ });+}diff --git a/apps/web/src/middleware.ts b/apps/web/src/middleware.tsindex 0a6933dc5..55b61ecfa 100644--- a/apps/web/src/middleware.ts+++ b/apps/web/src/middleware.ts@@ -1,7 +1,6 @@-import { getPreferredLocale } from "@rallly/languages/get-preferred-locale";import { NextResponse } from "next/server";-import { withAuth } from "@/auth/edge";+import { getLocaleFromRequest, setLocaleCookie } from "@/lib/locale/server";export const middleware = withAuth(async (req) => {const { nextUrl } = req;@@ -15,14 +14,14 @@ export const middleware = withAuth(async (req) => {return NextResponse.redirect(newUrl);}- const locale = getPreferredLocale({- userLocale: req.auth?.user?.locale ?? undefined,- acceptLanguageHeader: req.headers.get("accept-language") ?? undefined,- });+ const locale = getLocaleFromRequest(req);newUrl.pathname = `/${locale}${pathname}`;const res = NextResponse.rewrite(newUrl);++ setLocaleCookie(req, res, locale);+res.headers.set("x-locale", locale);res.headers.set("x-pathname", pathname);diff --git a/packages/languages/src/get-preferred-locale.ts b/packages/languages/src/get-preferred-locale.tsindex 461ba06db..df1c9b8c4 100644--- a/packages/languages/src/get-preferred-locale.ts+++ b/packages/languages/src/get-preferred-locale.ts@@ -2,21 +2,11 @@ import { match } from "@formatjs/intl-localematcher";import Negotiator from "negotiator";import { defaultLocale, supportedLngs } from "./index";-export function getPreferredLocale({- userLocale,+export function getPreferredLocaleFromHeaders({acceptLanguageHeader,}: {- userLocale?: string;- acceptLanguageHeader?: string;+ acceptLanguageHeader: string;}) {- if (userLocale && supportedLngs.includes(userLocale)) {- return userLocale;- }-- if (!acceptLanguageHeader) {- return defaultLocale;- }-const preferredLanguages = new Negotiator({headers: {"accept-language": acceptLanguageHeader,@@ -31,3 +21,26 @@ export function getPreferredLocale({return defaultLocale;}}++/**+ * @deprecated Use getPreferredLocaleFromHeaders instead+ */+export function getPreferredLocale({+ userLocale,+ acceptLanguageHeader,+}: {+ userLocale?: string;+ acceptLanguageHeader?: string;+}) {+ if (userLocale && supportedLngs.includes(userLocale)) {+ return userLocale;+ }++ if (!acceptLanguageHeader) {+ return defaultLocale;+ }++ return getPreferredLocaleFromHeaders({+ acceptLanguageHeader,+ });+}