Add checkbox for optimality (does not do anything yet)

Author: spaaaacccee

client/src/components/Field.tsx

@@ -1,7 +1,11 @@
 import {
   AutocompleteProps,
+  CheckboxProps,
   Autocomplete as MuiAutocomplete,
   SxProps,
+  Checkbox as MuiCheckbox,
+  FormControlLabel,
+  FormControlLabelProps,
 } from "@mui/material";
 import Box, { BoxProps } from "@mui/material/Box";
 import FormHelperText, {
@@ -18,11 +22,11 @@ import { ComponentProps, ComponentType, Ref, forwardRef } from "react";
 import { paper } from "theme";
 
 export function Field<
-  Schema extends Record<string, string | number | object> = Record<
+  Schema extends Record<string, string | number | object | boolean> = Record<
     string,
-    string | number | object
+    string | number | object | boolean
   >,
-  T extends ComponentType<object> = typeof TextField
+  T extends ComponentType<object> = typeof TextField,
 >({
   slotProps = {},
   as,
@@ -79,15 +83,36 @@ export const Select = forwardRef(
       }}
       ref={ref}
     />
-  )
+  ),
+);
+
+export const Checkbox = forwardRef(
+  (props: Partial<FormControlLabelProps>, ref: Ref<HTMLButtonElement>) => {
+    const form = useFormikContext();
+    return (
+      <FormControlLabel
+        label="No label"
+        {...props}
+        ref={ref}
+        control={
+          <MuiCheckbox
+            defaultChecked={!!props.value}
+            onChange={(v) => {
+              form.setFieldValue(props.name, v.target.checked);
+            }}
+          />
+        }
+      />
+    );
+  },
 );
 
 export const Autocomplete = forwardRef(function <
   Value,
   Multiple extends boolean | undefined,
   DisableClearable extends boolean | undefined,
   FreeSolo extends boolean | undefined,
-  ChipComponent extends React.ElementType = "div"
+  ChipComponent extends React.ElementType = "div",
 >(
   {
     autoCompleteProps,
@@ -105,7 +130,7 @@ export const Autocomplete = forwardRef(function <
       "renderInput"
     >;
   } & TextFieldProps,
-  ref: Ref<HTMLDivElement>
+  ref: Ref<HTMLDivElement>,
 ) {
   const form = useFormikContext();
   return (

client/src/components/data-grid/cellRenderers.tsx

@@ -134,7 +134,7 @@ export const Bar = ({
             gap: 1,
           },
         },
-        props
+        props,
       )}
     >
       <Stack direction="row" sx={{ flex: 1 }}>
@@ -149,7 +149,9 @@ export const Bar = ({
                 bgcolor: "transparent",
                 transition: `flex 2s ${easeCircle}`,
                 flex: value,
-                "> .MuiLinearProgress-bar": { bgcolor: color ?? "info.main" },
+                "> .MuiLinearProgress-bar": {
+                  bgcolor: color ?? "info.main",
+                },
               }}
               value={100}
               variant="determinate"

client/src/forms/SubmissionKeyRequestForm.tsx

@@ -1,6 +1,6 @@
 import { createFilterOptions, Stack, Typography } from "@mui/material";
 import { useQuery } from "@tanstack/react-query";
-import { Autocomplete, Field } from "components/Field";
+import { Autocomplete, Checkbox, Field } from "components/Field";
 import { Form, Formik, FormikConfig, FormikProps } from "formik";
 import { chain, noop, once } from "lodash";
 import { toJson } from "queries/query";
@@ -133,11 +133,11 @@ export function SubmissionKeyRequestForm({
                 label="Affiliation"
                 placeholder="Monash University"
                 required
-              />
+              />,
             )}
             {renderLabel(
               "About your algorithm",
-              "Tell us about this algorithm you would like to submit results for."
+              "Tell us about this algorithm you would like to submit results for.",
             )}
             {renderRow(
               <Field<Request>
@@ -153,7 +153,7 @@ export function SubmissionKeyRequestForm({
                 label="Authors"
                 placeholder="John Doe, Wei Zhang, Joe Smith"
                 required
-              />
+              />,
             )}
             <Field<Request>
               name="paperReference"
@@ -164,9 +164,15 @@ export function SubmissionKeyRequestForm({
               minRows={3}
               required
             />
+            <Field<Request, typeof Checkbox>
+              name="isOptimal"
+              disabled={disabled || disabledValues?.isOptimal}
+              label="My algorithm is optimal"
+              as={Checkbox}
+            />
             {renderLabel(
               "Where your algorithm is published",
-              "Make it easier for people to find your work once we list your results on our platform."
+              "Make it easier for people to find your work once we list your results on our platform.",
             )}
             <Field<Request>
               name="googleScholar"
@@ -188,7 +194,7 @@ export function SubmissionKeyRequestForm({
             />
             {renderLabel(
               "Other info",
-              "Let us know why you would like to submit your algorithm to our tracker, as well as any other helpful information."
+              "Let us know why you would like to submit your algorithm to our tracker, as well as any other helpful information.",
             )}
             <Field<Request>
               multiline

client/src/pages/algorithms/index.tsx

@@ -44,7 +44,7 @@ const g = [
 function Table() {
   const { data: algorithms } = useAlgorithmDetailsData();
   const theme = useTheme();
-  const total = max(flatMap(g, (c) => map(algorithms, c) || 1)) * 1.5;
+  const total = max(flatMap(g, (c) => map(algorithms, c) || 1));
   const navigate = useNavigate();
   const columns: GridColDef<AlgorithmDetails>[] = [
     {

client/src/queries/useRequestQuery.ts

@@ -1,13 +1,14 @@
 import { useQueries, useQuery } from "@tanstack/react-query";
 import { APIConfig } from "core/config";
 import { map } from "lodash";
-import { InferType, object, string } from "yup";
+import { boolean, InferType, object, string } from "yup";
 import { json } from "./query";
 import { RequestWithReviewOutcome } from "./useRequestsQuery";
 
 export type Request = InferType<typeof requestSchema> & { id?: string };
 
 export const requestSchema = object({
+  isOptimal: boolean().default(false),
   requesterName: string().required("Requester name is required."),
   requesterEmail: string()
     .email("Please enter a valid email address.")
@@ -40,7 +41,7 @@ export const useRequestsData = (keys: string[]) =>
 
 export const requestByEmailQueryFn = (email: string) => async () =>
   await json<RequestWithReviewOutcome[]>(
-    `${APIConfig.apiUrl}/request/email/${email}`
+    `${APIConfig.apiUrl}/request/email/${email}`,
   );
 
 export const useRequestByEmailData = (email: string) =>

server/src/controllers/request.tsx

@@ -18,7 +18,7 @@ export const findByEmail = query(
     {
       requesterEmail: email,
     },
-  ]
+  ],
 );
 
 export const findAll: RequestHandler = (req, res) => {
@@ -64,7 +64,7 @@ async function queueMail(args: Infer<typeof Request>) {
     "noreply@pathfinding.ai",
     args.requesterEmail,
     "We have received your request",
-    a
+    a,
   );
 }
 
@@ -76,6 +76,7 @@ export const create: RequestHandler = async (req, res) => {
   }
 
   const field = {
+    isOptimal: req.body.isOptimal,
     requesterName: req.body.requesterName,
     requesterEmail: req.body.requesterEmail,
     requesterAffiliation: req.body.requesterAffiliation,
@@ -103,6 +104,7 @@ export const create: RequestHandler = async (req, res) => {
 
 const requestSchema = {
   id: z.string(),
+  isOptimal: z.boolean(),
   requesterName: z.string(),
   requesterEmail: z.string().email(),
   requesterAffiliation: z.string(),
@@ -127,7 +129,7 @@ const handleRequestUpdate = async ({
 
 export const updateRequest = route(
   z.object(requestSchema),
-  handleRequestUpdate
+  handleRequestUpdate,
 );
 
 export const updateRequestElevated = route(z.any(), handleRequestUpdate);

server/src/models/Algorithm.common.ts

@@ -0,0 +1,3 @@
+export const algorithmCommon = {
+  isOptimal: { type: Boolean, default: false },
+} as const;

server/src/models/Algorithm.ts

@@ -2,6 +2,7 @@ import { Schema, model as createModel } from "mongoose";
 import { createSchema } from "./createSchema";
 import { Types } from "mongoose";
 import { queryClient } from "query";
+import { algorithmCommon } from "./Algorithm.common";
 
 const schema = createSchema(
   {
@@ -18,6 +19,7 @@ const schema = createSchema(
     instances_closed: Number,
     instances_solved: Number,
     submittedAt: Date,
+    ...algorithmCommon,
     requestId: { type: Types.ObjectId, ref: "users" },
   },
   {

server/src/models/Request.ts

@@ -1,6 +1,7 @@
 import { Schema, model as createModel } from "mongoose";
 import { createSchema } from "./createSchema";
 import { queryClient } from "query";
+import { algorithmCommon } from "./Algorithm.common";
 
 const schema = createSchema({
   requesterName: String,
@@ -15,6 +16,7 @@ const schema = createSchema({
   githubLink: String,
   comments: String,
   isApproved: Boolean,
+  ...algorithmCommon,
   reviewStatus: {
     type: {
       status: {