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 paper acknowledgement form #3637

Merged
merged 2 commits into from
Aug 8, 2023
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
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
-- AlterTable
ALTER TABLE "User" ADD COLUMN "paperackName" TEXT NOT NULL DEFAULT '',
ADD COLUMN "paperackYes" BOOLEAN NOT NULL DEFAULT false;
2 changes: 2 additions & 0 deletions website/prisma/schema.prisma
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,8 @@ model User {
image String?
isNew Boolean @default(true)
role String @default("general")
paperackYes Boolean @default(false)
paperackName String @default("")

accounts Account[]
sessions Session[]
Expand Down
3 changes: 2 additions & 1 deletion website/public/locales/en/account.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
"delete_account_intro": "Deleting an account entails the following:",
"delete_account_leaderboard": "Accounts of deleted users won't show up on the leaderboards",
"delete_account_permanent": "This action is permanent and cannot be undone",
"linked_accounts": "Linked accounts",
"edit_paper_ack": "Edit paper acknowledgement",
"go_to_dashboard": "Go back to dashboard",
"linked_accounts": "Linked accounts",
"yes_delete": "Yes, delete my account permanently"
}
5 changes: 4 additions & 1 deletion website/src/pages/account/index.tsx
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
import { Divider, Flex, Grid, Icon, Text } from "@chakra-ui/react";
import { Divider, Flex, Grid, Icon, Text, Button } from "@chakra-ui/react";
import Head from "next/head";
import Link from "next/link";
import { useSession } from "next-auth/react";
Expand Down Expand Up @@ -71,6 +71,9 @@ export default function Account() {
</>
)}
</Grid>
<Button as={Link} href="/account/paperack">
{t("account:edit_paper_ack")}
</Button>
<Divider my={4} />
<XPBar />
</SurveyCard>
Expand Down
89 changes: 89 additions & 0 deletions website/src/pages/account/paperack.tsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
import { Button, FormControl, FormLabel, Input, InputGroup, useToast } from "@chakra-ui/react";
import Head from "next/head";
import React, { useEffect, useMemo } from "react";
import { useForm } from "react-hook-form";
export { getStaticProps } from "src/lib/defaultServerSideProps";
import { get, post } from "src/lib/api";
import useSWRImmutable from "swr/immutable";
import useSWRMutation from "swr/mutation";

interface AckData {
paperackYes: boolean;
paperackName: string;
}

export default function PaperAck() {
const toast = useToast();

const { data: defaultValues } = useSWRImmutable<AckData>("/api/paperack", get);
const { trigger } = useSWRMutation<AckData, any, any, AckData>("/api/paperack", post, {
onSuccess() {
toast({
title: "Successfully updated your preferences",
status: "success",
});
},
onError(err) {
console.error(err);
toast({
title: "An error occurred!",
status: "error",
});
},
});

const {
register,
formState: { errors },
handleSubmit,
reset,
watch,
} = useForm<AckData>({ defaultValues });

useEffect(() => {
reset(defaultValues);
}, [defaultValues, reset]);

const updatePaperAck = useMemo(() => handleSubmit((data: AckData) => trigger(data)), [handleSubmit, trigger]);

const { paperackYes, paperackName } = watch();

return (
<>
<Head>
<title>Open Assistant</title>
</Head>
<main className="oa-basic-theme h-3/4 z-0 flex flex-col items-center justify-center">
<div className="max-w-3xl">
<div className="m-4">
<p className="mb-8">
If you want to be considered for acknowledgements in the paper for your contributions, tick the box below
AND enter your (real) name.
</p>
<form onSubmit={updatePaperAck}>
<InputGroup className="flex flex-col gap-6">
<FormControl className="flex flex-row gap-2">
<input
id="paperackYes"
type="checkbox"
name="paperackYes"
{...register("paperackYes")}
className="mb-2"
/>
<FormLabel htmlFor="paperackYes">I want to be mentioned in the acknowledgements</FormLabel>
</FormControl>
<FormControl isInvalid={errors.paperackName ? true : false}>
<FormLabel>Write the name by which you want to be mentioned in the acknowledgements</FormLabel>
<Input placeholder="Name" type="text" {...register("paperackName")}></Input>
</FormControl>
<Button isDisabled={paperackYes && !paperackName} type="submit">
Submit
</Button>
</InputGroup>
</form>
</div>
</div>
</main>
</>
);
}
40 changes: 40 additions & 0 deletions website/src/pages/api/paperack.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
import { withoutRole } from "src/lib/auth";
import prisma from "src/lib/prismadb";

/**
* Updates the user's paper ack info
*/
const handler = withoutRole("banned", async (req, res, token) => {
// handle GET
if (req.method === "GET") {
const user = await prisma.user.findUnique({
where: {
id: token.sub,
},
select: {
paperackYes: true,
paperackName: true,
},
});
return res.status(200).json(user);
}

const { paperackYes, paperackName } = req.body;

const user = await prisma.user.update({
where: {
id: token.sub,
},
data: {
paperackYes,
paperackName,
},
select: {
paperackYes: true,
paperackName: true,
},
});
return res.status(200).json(user);
});

export default handler;