Merge branch 'main' into OPIK-130/add_anonymous_usage_information

CONTRIBUTING.md

@@ -189,7 +189,7 @@ In order to develop features in the Python SDK, you will need to have Opik runni
 ```bash
 cd deployment/docker-compose
 
-# Starting the Opik platform
+# Starting the Opik platform
 docker compose up --detach
 
 # Configure the Python SDK to point to the local Opik deployment
@@ -256,6 +256,14 @@ npm run typecheck
 
 ### Contributing to the backend
 
+In order to run the external services (Clickhouse, MySQL, Redis), you can use the `build_and_run.sh` script or `docker-compose`:
+
+```bash
+cd deployment/docker-compose
+
+docker compose up clickhouse redis mysql -d
+```
+
 #### Running the backend
 
 The Opik backend is a Java application that is located in `apps/opik-backend`.
@@ -271,7 +279,7 @@ mvn clean install
 # Start the Opik application
 java -jar target/opik-backend-{project.pom.version}.jar server config.yml
 ```
-Replace `{project.pom.version}` with the version of the project in the pom file. 
+Replace `{project.pom.version}` with the version of the project in the pom file.
 
 Once the backend is running, you can access the Opik API at `http://localhost:8080`.
 
@@ -283,7 +291,12 @@ cd apps/opik-backend
 mvn test
 ```
 
-#### Advanced usage
+Tests leverage the `testcontainers` library to run integration tests against a real instances of the external services. Ports are randomly assigned by the library to avoid conflicts.
+
+#### Advanced usage
+
+*Health Check*
+To see your applications health enter url `http://localhost:8080/healthcheck`
 
 *Run migrations*
 
@@ -299,4 +312,20 @@ Replace `{project.pom.version}` with the version of the project in the pom file.
 
 You can curl the ClickHouse REST endpoint with `echo 'SELECT version()' | curl -H 'X-ClickHouse-User: opik' -H 'X-ClickHouse-Key: opik' 'http://localhost:8123/' -d @-`.
 
+```
+SHOW DATABASES
+
+Query id: a9faa739-5565-4fc5-8843-5dc0f72ff46d
+
+┌─name───────────────┐
+│ INFORMATION_SCHEMA │
+│ opik               │
+│ default            │
+│ information_schema │
+│ system             │
+└────────────────────┘
+
+5 rows in set. Elapsed: 0.004 sec. 
+```
+
 Sample result: `23.8.15.35`

apps/opik-frontend/src/components/shared/AddEditFeedbackDefinitionDialog/FeedbackDefinitionDetails/CategoricalFeedbackDefinitionDetails.tsx

@@ -1,5 +1,6 @@
 import React, { useEffect, useMemo, useState } from "react";
 import sortBy from "lodash/sortBy";
+import isNumber from "lodash/isNumber";
 import { Plus, X } from "lucide-react";
 
 import { Button } from "@/components/ui/button";
@@ -13,23 +14,30 @@ type CategoricalFeedbackDefinitionDetailsProps = {
 };
 
 type CategoryField = {
-  name?: string;
-  value?: number;
+  name: string;
+  value: number | "";
 };
 
-function categoryFieldsToDetails(
+const generateEmptyCategory = (): CategoryField => {
+  return {
+    name: "",
+    value: "",
+  };
+};
+
+const categoryFieldsToDetails = (
   categoryFields: CategoryField[],
-): CategoricalFeedbackDefinition["details"] {
+): CategoricalFeedbackDefinition["details"] => {
   const categories = {} as Record<string, number>;
 
   categoryFields.forEach((categoryField) => {
-    if (categoryField.name && categoryField.value !== undefined) {
+    if (categoryField.name && isNumber(categoryField.value)) {
       categories[categoryField.name] = categoryField.value;
     }
   });
 
   return { categories };
-}
+};
 
 const CategoricalFeedbackDefinitionDetails: React.FunctionComponent<
   CategoricalFeedbackDefinitionDetailsProps
@@ -43,7 +51,7 @@ const CategoricalFeedbackDefinitionDetails: React.FunctionComponent<
           })),
           "name",
         )
-      : [{}, {}],
+      : [generateEmptyCategory(), generateEmptyCategory()],
   );
 
   const categoricalDetails = useMemo(
@@ -82,16 +90,22 @@ const CategoricalFeedbackDefinitionDetails: React.FunctionComponent<
               placeholder="0.0"
               value={category.value}
               type="number"
+              step="any"
               onChange={(event) => {
                 setCategories((prevCategories) => {
                   return prevCategories.map((prevCategory) => {
                     if (prevCategory !== category) {
                       return prevCategory;
                     }
 
+                    const value =
+                      event.target.value === ""
+                        ? ""
+                        : Number(event.target.value);
+
                     return {
                       ...prevCategory,
-                      value: Number(event.target.value),
+                      value,
                     };
                   });
                 });
@@ -121,7 +135,10 @@ const CategoricalFeedbackDefinitionDetails: React.FunctionComponent<
           variant="secondary"
           size="sm"
           onClick={() => {
-            setCategories((categories) => [...categories, {}]);
+            setCategories((categories) => [
+              ...categories,
+              generateEmptyCategory(),
+            ]);
           }}
         >
           <Plus className="mr-2 size-4" /> Add category

apps/opik-frontend/src/components/shared/AddEditFeedbackDefinitionDialog/FeedbackDefinitionDetails/NumericalFeedbackDefinitionDetails.tsx

@@ -1,9 +1,20 @@
 import React, { useEffect, useState } from "react";
+import isNumber from "lodash/isNumber";
 
 import { Input } from "@/components/ui/input";
 import { Label } from "@/components/ui/label";
 import { NumericalFeedbackDefinition } from "@/types/feedback-definitions";
 
+const INVALID_DETAILS_VALUE: NumericalFeedbackDefinition["details"] = {
+  min: 0,
+  max: 0,
+};
+
+type NumericalFeedbackDefinitionDetails = {
+  min: number | "";
+  max: number | "";
+};
+
 type NumericalFeedbackDefinitionDetailsProps = {
   onChange: (details: NumericalFeedbackDefinition["details"]) => void;
   details?: NumericalFeedbackDefinition["details"];
@@ -12,12 +23,18 @@ type NumericalFeedbackDefinitionDetailsProps = {
 const NumericalFeedbackDefinitionDetails: React.FunctionComponent<
   NumericalFeedbackDefinitionDetailsProps
 > = ({ onChange, details }) => {
-  const [numericalDetails, setNumericalDetails] = useState<
-    NumericalFeedbackDefinition["details"]
-  >(details ?? { min: 0, max: 1 });
+  const [numericalDetails, setNumericalDetails] =
+    useState<NumericalFeedbackDefinitionDetails>(details ?? { min: 0, max: 1 });
 
   useEffect(() => {
-    onChange(numericalDetails);
+    const isValid =
+      isNumber(numericalDetails.min) && isNumber(numericalDetails.max);
+
+    onChange(
+      isValid
+        ? (numericalDetails as NumericalFeedbackDefinition["details"])
+        : INVALID_DETAILS_VALUE,
+    );
   }, [numericalDetails, onChange]);
 
   return (
@@ -29,10 +46,11 @@ const NumericalFeedbackDefinitionDetails: React.FunctionComponent<
           placeholder="Min"
           value={numericalDetails.min}
           type="number"
+          step="any"
           onChange={(event) =>
             setNumericalDetails((details) => ({
               ...details,
-              min: Number(event.target.value),
+              min: event.target.value === "" ? "" : Number(event.target.value),
             }))
           }
         />
@@ -45,10 +63,11 @@ const NumericalFeedbackDefinitionDetails: React.FunctionComponent<
           placeholder="Max"
           value={numericalDetails.max}
           type="number"
+          step="any"
           onChange={(event) =>
             setNumericalDetails((details) => ({
               ...details,
-              max: Number(event.target.value),
+              max: event.target.value === "" ? "" : Number(event.target.value),
             }))
           }
         />

apps/opik-frontend/src/components/shared/FeedbackScoresEditor/AddFeedbackScorePopover.tsx

@@ -37,7 +37,7 @@ const AddFeedbackScorePopover: React.FunctionComponent<
 
   const [activeFeedbackDefinition, setActiveFeedbackDefinition] =
     useState<FeedbackDefinition>();
-  const [value, setValue] = useState<number>();
+  const [value, setValue] = useState<number | "">("");
 
   const workspaceName = useAppStore((state) => state.activeWorkspaceName);
   const { data: feedbackDefinitionsData } = useFeedbackDefinitionsList({
@@ -53,7 +53,7 @@ const AddFeedbackScorePopover: React.FunctionComponent<
   const resetState = () => {
     setSearch("");
     setActiveFeedbackDefinition(undefined);
-    setValue(undefined);
+    setValue("");
   };
 
   const feedbackDefinitions: FeedbackDefinition[] = useMemo(
@@ -131,10 +131,15 @@ const AddFeedbackScorePopover: React.FunctionComponent<
               <Input
                 max={activeFeedbackDefinition.details.max}
                 min={activeFeedbackDefinition.details.min}
-                onChange={(event) => setValue(Number(event.target.value))}
+                onChange={(event) =>
+                  setValue(
+                    event.target.value === "" ? "" : Number(event.target.value),
+                  )
+                }
                 placeholder="Value"
                 type="number"
-                value={String(value)}
+                step="any"
+                value={value}
               />
             </div>
             <div>

apps/opik-frontend/src/components/shared/TraceDetailsPanel/TraceAnnotateViewer/AnnotateRow.tsx

@@ -1,14 +1,14 @@
-import React, { useCallback, useEffect, useMemo, useState } from "react";
-import debounce from "lodash/debounce";
+import React, { useCallback, useEffect, useState } from "react";
 import isUndefined from "lodash/isUndefined";
+import isNumber from "lodash/isNumber";
 import sortBy from "lodash/sortBy";
 import { X } from "lucide-react";
 
 import useTraceFeedbackScoreSetMutation from "@/api/traces/useTraceFeedbackScoreSetMutation";
 import useTraceFeedbackScoreDeleteMutation from "@/api/traces/useTraceFeedbackScoreDeleteMutation";
-import { Input } from "@/components/ui/input";
-import { ToggleGroup, ToggleGroupItem } from "@/components/ui/toggle-group";
+import DebounceInput from "@/components/shared/DebounceInput/DebounceInput";
 import ColoredTag from "@/components/shared/ColoredTag/ColoredTag";
+import { ToggleGroup, ToggleGroupItem } from "@/components/ui/toggle-group";
 import {
   FEEDBACK_DEFINITION_TYPE,
   FeedbackDefinition,
@@ -40,9 +40,11 @@ const AnnotateRow: React.FunctionComponent<AnnotateRowProps> = ({
     setCategoryName(feedbackScore?.category_name);
   }, [feedbackScore?.category_name, traceId, spanId]);
 
-  const [value, setValue] = useState(feedbackScore?.value);
+  const [value, setValue] = useState<number | "">(
+    isNumber(feedbackScore?.value) ? feedbackScore?.value : "",
+  );
   useEffect(() => {
-    setValue(feedbackScore?.value);
+    setValue(isNumber(feedbackScore?.value) ? feedbackScore?.value : "");
   }, [feedbackScore?.value, spanId, traceId]);
 
   const feedbackScoreDeleteMutation = useTraceFeedbackScoreDeleteMutation();
@@ -58,38 +60,46 @@ const AnnotateRow: React.FunctionComponent<AnnotateRowProps> = ({
 
   const setTraceFeedbackScoreMutation = useTraceFeedbackScoreSetMutation();
 
-  const handleChangeValue = useMemo(() => {
-    return debounce((value: number, categoryName?: string) => {
+  const handleChangeValue = useCallback(
+    (value: number, categoryName?: string) => {
       setTraceFeedbackScoreMutation.mutate({
         categoryName,
         name,
         spanId,
         traceId,
         value,
       });
-    }, SET_VALUE_DEBOUNCE_DELAY);
-
+    },
     // setTraceFeedbackScoreMutation re triggers this memo when it should not
     // eslint-disable-next-line react-hooks/exhaustive-deps
-  }, [name, spanId, traceId]);
+    [name, spanId, traceId],
+  );
 
   const renderOptions = (feedbackDefinition: FeedbackDefinition) => {
     if (feedbackDefinition.type === FEEDBACK_DEFINITION_TYPE.numerical) {
       return (
-        <Input
+        <DebounceInput
           className="min-w-[100px]"
           max={feedbackDefinition.details.max}
           min={feedbackDefinition.details.min}
+          step="any"
           dimension="sm"
-          onChange={(event) => {
-            const newValue = Number(event.target.value);
+          delay={SET_VALUE_DEBOUNCE_DELAY}
+          onChangeValue={(value) => {
+            const newValue = value === "" ? "" : Number(value);
 
             setValue(newValue);
-            handleChangeValue(newValue);
+            if (
+              isNumber(newValue) &&
+              newValue >= feedbackDefinition.details.min &&
+              newValue <= feedbackDefinition.details.max
+            ) {
+              handleChangeValue(newValue);
+            }
           }}
           placeholder="Score"
           type="number"
-          value={String(value)}
+          value={value}
         />
       );
     }

apps/opik-frontend/src/components/ui/input.tsx

@@ -9,7 +9,7 @@ const inputVariants = cva(
     variants: {
       variant: {
         default:
-          "border border-input hover:shadow-sm focus-visible:border-primary hover:disabled:shadow-none",
+          "border border-input invalid:border-warning hover:shadow-sm focus-visible:border-primary focus-visible:invalid:border-warning hover:disabled:shadow-none",
         ghost: "",
       },
       dimension: {

apps/opik-frontend/src/components/ui/textarea.tsx

@@ -10,7 +10,7 @@ const Textarea = React.forwardRef<HTMLTextAreaElement, TextareaProps>(
     return (
       <textarea
         className={cn(
-          "flex min-h-44 w-full rounded-md border border-input bg-background px-3 py-2 text-sm placeholder:text-light-slate hover:shadow-sm hover:disabled:shadow-none focus-visible:outline-none focus-visible:border-primary disabled:cursor-not-allowed disabled:text-muted-gray disabled:bg-muted-disabled disabled:placeholder:text-muted-gray",
+          "flex min-h-44 w-full rounded-md border border-input bg-background px-3 py-2 text-sm placeholder:text-light-slate invalid:border-warning hover:shadow-sm focus-visible:border-primary focus-visible:outline-none focus-visible:invalid:border-warning disabled:cursor-not-allowed disabled:bg-muted-disabled disabled:text-muted-gray disabled:placeholder:text-muted-gray hover:disabled:shadow-none",
           className,
         )}
         ref={ref}

apps/opik-frontend/src/lib/traces.ts

@@ -1,6 +1,6 @@
 import md5 from "md5";
 import get from "lodash/get";
-import isUndefined from "lodash/isUndefined";
+import isNumber from "lodash/isNumber";
 import { TAG_VARIANTS } from "@/components/ui/tag";
 import { ExperimentItem } from "@/types/datasets";
 
@@ -14,8 +14,8 @@ export const isObjectSpan = (object: object) => get(object, "trace_id", false);
 
 export const isNumericFeedbackScoreValid = (
   { min, max }: { min: number; max: number },
-  value?: number,
-) => !isUndefined(value) && value >= min && value <= max;
+  value?: number | "",
+) => isNumber(value) && value >= min && value <= max;
 
 export const traceExist = (item: ExperimentItem) =>
   item.output || item.input || item.feedback_scores;