Wrap SSR with auth requirements (#4129)

* Add `withGetServerSidePropsRequirements` wrapper * 👕 * ✨ * ✂️ * 👕 * Address comments from review
dust-tt · Mar 5, 2024 · 744c8ac · 744c8ac
1 parent 2d43833
commit 744c8ac
Show file tree

Hide file tree

Showing 57 changed files with 262 additions and 193 deletions.
diff --git a/front/lib/auth.ts b/front/lib/auth.ts
@@ -446,7 +446,7 @@ export class Authenticator {
 export async function getSession(
   req: NextApiRequest | GetServerSidePropsContext["req"],
   res: NextApiResponse | GetServerSidePropsContext["res"]
-): Promise<any> {
+): Promise<any | null> {
   return getServerSession(req, res, authOptions);
 }
 

diff --git a/front/lib/iam/session.ts b/front/lib/iam/session.ts
@@ -1,11 +1,19 @@
 import type { RoleType, UserTypeWithWorkspaces } from "@dust-tt/types";
+import type {
+  GetServerSideProps,
+  GetServerSidePropsContext,
+  PreviewData,
+} from "next";
+import type { ParsedUrlQuery } from "querystring";
 import { Op } from "sequelize";
 
+import { getSession } from "@app/lib/auth";
 import {
   fetchUserFromSession,
   maybeUpdateFromExternalUser,
 } from "@app/lib/iam/users";
 import { Membership, Workspace } from "@app/lib/models";
+import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
 export function isGoogleSession(session: any) {
   return session.provider.provider === "google";
@@ -75,3 +83,46 @@ export async function getUserFromSession(
     }),
   };
 }
+
+interface WithGetServerSidePropsRequirementsOptions {
+  enableLogging?: boolean;
+  requireAuth?: boolean;
+}
+
+const defaultWithGetServerSidePropsRequirements: WithGetServerSidePropsRequirementsOptions =
+  {
+    enableLogging: true,
+    requireAuth: true,
+  };
+
+export function withGetServerSidePropsRequirements<
+  T extends { [key: string]: any } = { [key: string]: any }
+>(
+  getServerSideProps: GetServerSideProps<T>,
+  opts: WithGetServerSidePropsRequirementsOptions = defaultWithGetServerSidePropsRequirements
+): GetServerSideProps<T> {
+  return async (
+    context: GetServerSidePropsContext<ParsedUrlQuery, PreviewData>
+  ) => {
+    const { enableLogging, requireAuth } = opts;
+
+    if (requireAuth) {
+      const session = await getSession(context.req, context.res);
+      if (!session) {
+        return {
+          redirect: {
+            permanent: false,
+            // TODO(2024-03-04 flav) Add support for `returnTo=`.
+            destination: "/",
+          },
+        };
+      }
+    }
+
+    if (enableLogging) {
+      return withGetServerSidePropsLogging(getServerSideProps)(context);
+    }
+
+    return getServerSideProps(context);
+  };
+}
diff --git a/front/pages/index.tsx b/front/pages/index.tsx
@@ -52,36 +52,41 @@ import ScrollingHeader from "@app/components/home/scrollingHeader";
 import { PricePlans } from "@app/components/PlansTables";
 import { getSession } from "@app/lib/auth";
 import { getUserFromSession } from "@app/lib/iam/session";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { classNames } from "@app/lib/utils";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
 const { GA_TRACKING_ID = "" } = process.env;
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   gaTrackingId: string;
-}>(async (context) => {
-  const session = await getSession(context.req, context.res);
-  const user = await getUserFromSession(session);
+}>(
+  async (context) => {
+    const session = await getSession(context.req, context.res);
+    const user = await getUserFromSession(session);
 
-  if (user && user.workspaces.length > 0) {
-    let url = `/w/${user.workspaces[0].sId}`;
+    if (user && user.workspaces.length > 0) {
+      let url = `/w/${user.workspaces[0].sId}`;
 
-    if (context.query.inviteToken) {
-      url = `/api/login?inviteToken=${context.query.inviteToken}`;
+      if (context.query.inviteToken) {
+        url = `/api/login?inviteToken=${context.query.inviteToken}`;
+      }
+
+      return {
+        redirect: {
+          destination: url,
+          permanent: false,
+        },
+      };
     }
 
     return {
-      redirect: {
-        destination: url,
-        permanent: false,
-      },
+      props: { gaTrackingId: GA_TRACKING_ID },
     };
+  },
+  {
+    requireAuth: false,
   }
-
-  return {
-    props: { gaTrackingId: GA_TRACKING_ID },
-  };
-});
+);
 
 export default function Home({
   gaTrackingId,

diff --git a/front/pages/login-error.tsx b/front/pages/login-error.tsx
@@ -2,23 +2,28 @@ import { Button, Logo } from "@dust-tt/sparkle";
 import type { InferGetServerSidePropsType } from "next";
 import Link from "next/link";
 
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 
 const { URL = "", GA_TRACKING_ID = "" } = process.env;
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   domain?: string;
   gaTrackingId: string;
   baseUrl: string;
-}>(async (context) => {
-  return {
-    props: {
-      domain: context.query.domain as string,
-      baseUrl: URL,
-      gaTrackingId: GA_TRACKING_ID,
-    },
-  };
-});
+}>(
+  async (context) => {
+    return {
+      props: {
+        domain: context.query.domain as string,
+        baseUrl: URL,
+        gaTrackingId: GA_TRACKING_ID,
+      },
+    };
+  },
+  {
+    requireAuth: false,
+  }
+);
 
 export default function LoginError({
   domain,

diff --git a/front/pages/no-workspace.tsx b/front/pages/no-workspace.tsx
@@ -11,9 +11,9 @@ import { useRouter } from "next/router";
 
 import { getSession } from "@app/lib/auth";
 import { getUserFromSession } from "@app/lib/iam/session";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { Membership, Workspace, WorkspaceHasDomain } from "@app/lib/models";
 import logger from "@app/logger/logger";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
 // Fetch workspace details for scenarios where auto-join is disabled.
 async function fetchWorkspaceDetails(
@@ -55,7 +55,7 @@ async function fetchRevokedWorkspace(
   return Workspace.findByPk(revokedWorkspaceId);
 }
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   status: "auto-join-disabled" | "revoked";
   userFirstName: string;
   workspaceName: string;

diff --git a/front/pages/poke/[wId]/assistants/[aId]/index.tsx b/front/pages/poke/[wId]/assistants/[aId]/index.tsx
@@ -10,9 +10,9 @@ import type { InferGetServerSidePropsType } from "next";
 import PokeNavbar from "@app/components/poke/PokeNavbar";
 import { getAgentConfigurations } from "@app/lib/api/assistant/configuration";
 import { Authenticator, getSession } from "@app/lib/auth";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   agentConfigurations: AgentConfigurationType[];
 }>(async (context) => {
   const session = await getSession(context.req, context.res);

diff --git a/front/pages/poke/[wId]/data_sources/[name]/index.tsx b/front/pages/poke/[wId]/data_sources/[name]/index.tsx
@@ -25,14 +25,14 @@ import { getDataSource } from "@app/lib/api/data_sources";
 import { Authenticator, getSession } from "@app/lib/auth";
 import { useSubmitFunction } from "@app/lib/client/utils";
 import { getDisplayNameForDocument } from "@app/lib/data_sources";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { useDocuments } from "@app/lib/swr";
 import { formatTimestampToFriendlyDate, timeAgoFrom } from "@app/lib/utils";
 import logger from "@app/logger/logger";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
 const { TEMPORAL_CONNECTORS_NAMESPACE = "" } = process.env;
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   owner: WorkspaceType;
   dataSource: DataSourceType;
   coreDataSource: CoreAPIDataSource;

diff --git a/front/pages/poke/[wId]/data_sources/[name]/search.tsx b/front/pages/poke/[wId]/data_sources/[name]/search.tsx
@@ -10,10 +10,10 @@ import PokeNavbar from "@app/components/poke/PokeNavbar";
 import { getDataSource } from "@app/lib/api/data_sources";
 import { Authenticator, getSession } from "@app/lib/auth";
 import { getDisplayNameForDocument } from "@app/lib/data_sources";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { classNames, timeAgoFrom } from "@app/lib/utils";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   owner: WorkspaceType;
   dataSource: DataSourceType;
 }>(async (context) => {

diff --git a/front/pages/poke/[wId]/data_sources/[name]/view.tsx b/front/pages/poke/[wId]/data_sources/[name]/view.tsx
@@ -6,11 +6,11 @@ import type { InferGetServerSidePropsType } from "next";
 import PokeNavbar from "@app/components/poke/PokeNavbar";
 import { getDataSource } from "@app/lib/api/data_sources";
 import { Authenticator, getSession } from "@app/lib/auth";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { classNames } from "@app/lib/utils";
 import logger from "@app/logger/logger";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   document: CoreAPIDocument;
 }>(async (context) => {
   const session = await getSession(context.req, context.res);

diff --git a/front/pages/poke/[wId]/index.tsx b/front/pages/poke/[wId]/index.tsx
@@ -38,16 +38,16 @@ import {
 import { Authenticator, getSession } from "@app/lib/auth";
 import { useSubmitFunction } from "@app/lib/client/utils";
 import { isDevelopment } from "@app/lib/development";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import {
   FREE_TEST_PLAN_CODE,
   FREE_UPGRADED_PLAN_CODE,
   isUpgraded,
 } from "@app/lib/plans/plan_codes";
 import { getPlanInvitation } from "@app/lib/plans/subscription";
 import { usePokePlans } from "@app/lib/swr";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   owner: WorkspaceType;
   subscription: SubscriptionType;
   planInvitation: PlanInvitationType | null;

diff --git a/front/pages/poke/[wId]/memberships.tsx b/front/pages/poke/[wId]/memberships.tsx
@@ -11,9 +11,9 @@ import React from "react";
 import PokeNavbar from "@app/components/poke/PokeNavbar";
 import { getMembers } from "@app/lib/api/workspace";
 import { Authenticator, getSession } from "@app/lib/auth";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   owner: WorkspaceType;
   members: UserTypeWithWorkspaces[];
 }>(async (context) => {

diff --git a/front/pages/poke/connectors/[connectorId]/index.tsx b/front/pages/poke/connectors/[connectorId]/index.tsx
@@ -2,10 +2,10 @@ import type { ConnectorType } from "@dust-tt/types";
 import { ConnectorsAPI } from "@dust-tt/types";
 
 import { Authenticator, getSession } from "@app/lib/auth";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import logger from "@app/logger/logger";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
-export const getServerSideProps = withGetServerSidePropsLogging<object>(
+export const getServerSideProps = withGetServerSidePropsRequirements<object>(
   async (context) => {
     const session = await getSession(context.req, context.res);
     const auth = await Authenticator.fromSuperUserSession(session, null);

diff --git a/front/pages/poke/index.tsx b/front/pages/poke/index.tsx
@@ -5,10 +5,10 @@ import React, { useState } from "react";
 
 import PokeNavbar from "@app/components/poke/PokeNavbar";
 import { Authenticator, getSession } from "@app/lib/auth";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { usePokeWorkspaces } from "@app/lib/swr";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
-export const getServerSideProps = withGetServerSidePropsLogging<object>(
+export const getServerSideProps = withGetServerSidePropsRequirements<object>(
   async (context) => {
     const session = await getSession(context.req, context.res);
     const auth = await Authenticator.fromSuperUserSession(session, null);

diff --git a/front/pages/poke/plans.tsx b/front/pages/poke/plans.tsx
@@ -23,10 +23,10 @@ import {
 import PokeNavbar from "@app/components/poke/PokeNavbar";
 import { SendNotificationsContext } from "@app/components/sparkle/Notification";
 import { Authenticator, getSession } from "@app/lib/auth";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { usePokePlans } from "@app/lib/swr";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
-export const getServerSideProps = withGetServerSidePropsLogging<object>(
+export const getServerSideProps = withGetServerSidePropsRequirements<object>(
   async (context) => {
     const session = await getSession(context.req, context.res);
     const auth = await Authenticator.fromSuperUserSession(session, null);

diff --git a/front/pages/w/[wId]/a/[aId]/clone.tsx b/front/pages/w/[wId]/a/[aId]/clone.tsx
@@ -23,12 +23,12 @@ import WorkspacePicker from "@app/components/WorkspacePicker";
 import { getApp } from "@app/lib/api/app";
 import { Authenticator, getSession } from "@app/lib/auth";
 import { getUserFromSession } from "@app/lib/iam/session";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { classNames } from "@app/lib/utils";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
 const { GA_TRACKING_ID = "" } = process.env;
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   user: UserTypeWithWorkspaces;
   owner: WorkspaceType;
   subscription: SubscriptionType;

diff --git a/front/pages/w/[wId]/a/[aId]/datasets/[name]/index.tsx b/front/pages/w/[wId]/a/[aId]/datasets/[name]/index.tsx
@@ -20,11 +20,11 @@ import { getApp } from "@app/lib/api/app";
 import { getDatasetHash, getDatasetSchema } from "@app/lib/api/datasets";
 import { Authenticator, getSession } from "@app/lib/auth";
 import { useRegisterUnloadHandlers } from "@app/lib/front";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 
 const { GA_TRACKING_ID = "" } = process.env;
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   owner: WorkspaceType;
   subscription: SubscriptionType;
   readOnly: boolean;

diff --git a/front/pages/w/[wId]/a/[aId]/datasets/index.tsx b/front/pages/w/[wId]/a/[aId]/datasets/index.tsx
@@ -16,12 +16,12 @@ import {
 import { getApp } from "@app/lib/api/app";
 import { getDatasets } from "@app/lib/api/datasets";
 import { Authenticator, getSession } from "@app/lib/auth";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { classNames } from "@app/lib/utils";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
 const { GA_TRACKING_ID = "" } = process.env;
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   owner: WorkspaceType;
   subscription: SubscriptionType;
   readOnly: boolean;

diff --git a/front/pages/w/[wId]/a/[aId]/datasets/new.tsx b/front/pages/w/[wId]/a/[aId]/datasets/new.tsx
@@ -20,11 +20,11 @@ import { getApp } from "@app/lib/api/app";
 import { getDatasets } from "@app/lib/api/datasets";
 import { Authenticator, getSession } from "@app/lib/auth";
 import { useRegisterUnloadHandlers } from "@app/lib/front";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 
 const { GA_TRACKING_ID = "" } = process.env;
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   owner: WorkspaceType;
   subscription: SubscriptionType;
   app: AppType;

diff --git a/front/pages/w/[wId]/a/[aId]/execute/index.tsx b/front/pages/w/[wId]/a/[aId]/execute/index.tsx
@@ -40,9 +40,9 @@ import {
   getDatasetTypes,
   getValueType,
 } from "@app/lib/datasets";
+import { withGetServerSidePropsRequirements } from "@app/lib/iam/session";
 import { useSavedRunStatus } from "@app/lib/swr";
 import { classNames } from "@app/lib/utils";
-import { withGetServerSidePropsLogging } from "@app/logger/withlogging";
 
 const CodeEditor = dynamic(
   () => import("@uiw/react-textarea-code-editor").then((mod) => mod.default),
@@ -57,7 +57,7 @@ type Event = {
   };
 };
 
-export const getServerSideProps = withGetServerSidePropsLogging<{
+export const getServerSideProps = withGetServerSidePropsRequirements<{
   owner: WorkspaceType;
   subscription: SubscriptionType;
   app: AppType;