Merge branch 'main' into 394-show-privacy-links

.github/workflows/test-api-contract.yaml

@@ -4,7 +4,6 @@ on:
   push:
     branches:
       - main
-      - add-api-docs-workflow
     paths:
       - "oasst-shared/**"
       - "backend/**"
@@ -46,8 +45,8 @@ jobs:
 
       - run: ./scripts/backend-development/stop-mock-server.sh
 
-      - uses: stefanzweifel/git-auto-commit-action@v4
-        with:
-          file_pattern: "docs/docs/api/openapi.json"
-          commit_message:
-            update docs/docs/api/openapi.json by run ${{ github.run_id }}
+      #- uses: stefanzweifel/git-auto-commit-action@v4
+      #  with:
+      #    file_pattern: "docs/docs/api/openapi.json"
+      #    commit_message:
+      #      update docs/docs/api/openapi.json by run ${{ github.run_id }}

docs/docusaurus.config.js

@@ -32,12 +32,15 @@ const config = {
 
   presets: [
     [
-      "classic",
+      "docusaurus-preset-openapi",
       /** @type {import('@docusaurus/preset-classic').Options} */
       ({
         docs: {
           sidebarPath: require.resolve("./sidebars.js"),
         },
+        api: {
+          path: "docs/api/openapi.json",
+        },
         blog: false,
         theme: {
           customCss: require.resolve("./src/css/custom.css"),
@@ -62,11 +65,7 @@ const config = {
             position: "left",
             label: "Docs",
           },
-          {
-            href: "https://editor.swagger.io/?url=https://raw.githubusercontent.com/LAION-AI/Open-Assistant/main/docs/docs/api/openapi.json",
-            label: "API",
-            position: "left",
-          },
+          { to: "/api", label: "API", position: "left" },
           {
             href: "https://github.com/LAION-AI/Open-Assistant",
             label: "GitHub",

docs/package.json

@@ -19,9 +19,11 @@
     "@docusaurus/preset-classic": "2.2.0",
     "@mdx-js/react": "^1.6.22",
     "clsx": "^1.2.1",
+    "docusaurus-preset-openapi": "^0.6.3",
     "prism-react-renderer": "^1.3.5",
     "react": "^17.0.2",
-    "react-dom": "^17.0.2"
+    "react-dom": "^17.0.2",
+    "url": "^0.11.0"
   },
   "devDependencies": {
     "@docusaurus/module-type-aliases": "2.2.0",

website/prisma/schema.prisma

@@ -41,6 +41,7 @@ model User {
   email         String?   @unique
   emailVerified DateTime?
   image         String?
+  isNew         Boolean   @default(true)
   role          String    @default("general")
 
   accounts      Account[]

website/src/pages/api/auth/[...nextauth].ts

@@ -50,7 +50,7 @@ if (boolean(process.env.DEBUG_LOGIN) || process.env.NODE_ENV === "development")
           where: {
             id: user.id,
           },
-          update: {},
+          update: user,
           create: user,
         });
         return user;
@@ -86,6 +86,7 @@ export const authOptions: AuthOptions = {
      */
     async session({ session, token }) {
       session.user.role = token.role;
+      session.user.isNew = token.isNew;
       return session;
     },
     /**
@@ -93,11 +94,12 @@ export const authOptions: AuthOptions = {
      * This let's use forward the role to the session object.
      */
     async jwt({ token }) {
-      const { role } = await prisma.user.findUnique({
+      const { isNew, role } = await prisma.user.findUnique({
         where: { id: token.sub },
-        select: { role: true },
+        select: { role: true, isNew: true },
       });
       token.role = role;
+      token.isNew = isNew;
       return token;
     },
   },

website/src/pages/api/update_task.ts

@@ -17,6 +17,9 @@ const handler = withoutRole("banned", async (req, res, token) => {
   // Parse out the local task ID and the interaction contents.
   const { id: frontendId, content, update_type } = req.body;
 
+  // Record that the user has done meaningful work and is no longer new.
+  await prisma.user.update({ where: { id: token.sub }, data: { isNew: false } });
+
   // Accept the task so that we can complete it, this will probably go away soon.
   const registeredTask = await prisma.registeredTask.findUniqueOrThrow({ where: { id: frontendId } });
   const task = registeredTask.task as Prisma.JsonObject;

website/src/pages/auth/signin.tsx

@@ -94,7 +94,14 @@ function Signin({ csrfToken, providers }) {
           {email && (
             <form onSubmit={signinWithEmail}>
               <Stack>
-                <Input data-cy="email-address" variant="outline" size="lg" placeholder="Email Address" ref={emailEl} />
+                <Input
+                  type="email"
+                  data-cy="email-address"
+                  variant="outline"
+                  size="lg"
+                  placeholder="Email Address"
+                  ref={emailEl}
+                />
                 <Button
                   data-cy="signin-email-button"
                   size={"lg"}

website/src/pages/dashboard.tsx

@@ -1,9 +1,15 @@
 import Head from "next/head";
+import { useSession } from "next-auth/react";
 import { LeaderboardTable, TaskOption } from "src/components/Dashboard";
 import { getDashboardLayout } from "src/components/Layout";
 import { TaskCategory } from "src/components/Tasks/TaskTypes";
 
 const Dashboard = () => {
+  const { data: session } = useSession();
+
+  // TODO(#670): Do something more meaningful when the user is new.
+  console.log(session?.user?.isNew);
+
   return (
     <>
       <Head>

website/types/next-auth.d.ts

@@ -6,6 +6,8 @@ declare module "next-auth" {
     user: {
       /** The user's role. */
       role: string;
+      /** True when the user is new. */
+      isNew: boolean;
     } & DefaultSession["user"];
   }
 }
@@ -14,5 +16,7 @@ declare module "next-auth/jwt" {
   interface JWT {
     /** The user's role. */
     role?: string;
+    /** True when the user is new. */
+    isNew?: boolean;
   }
 }