Fix search clauses to use JSON-serialized values (#40941)

GitOrigin-RevId: edfe7005d54a5210db8bce566d9ba24e4b598310

Author: Nicolapps

npm-packages/dashboard-common/src/features/data/components/DataFilters/IndexFilters.tsx

@@ -7,7 +7,7 @@ import {
   MagnifyingGlassIcon,
 } from "@radix-ui/react-icons";
 import { GenericDocument } from "convex/server";
-import { ValidatorJSON } from "convex/values";
+import { convexToJson, ValidatorJSON } from "convex/values";
 import {
   DatabaseIndexFilter,
   FilterByIndexRange,
@@ -227,7 +227,10 @@ export function IndexFilters({
                       clauses: option.fields.map((field: string) => ({
                         field,
                         enabled: false,
-                        value: defaultDocument[field],
+                        value:
+                          defaultDocument[field] === undefined
+                            ? undefined
+                            : convexToJson(defaultDocument[field]),
                       })),
                     } satisfies SearchIndexFilter,
                   }

npm-packages/system-udfs/convex/_system/frontend/lib/filters.test.ts

@@ -1,5 +1,5 @@
 import { describe, test, expect, it } from "vitest";
-import { GenericDocument } from "convex/server";
+import { GenericDocument, SearchIndex } from "convex/server";
 import {
   Filter,
   FilterByIndex,
@@ -21,7 +21,6 @@ import {
   validateIndexFilter,
   validateSearchIndexFilter,
 } from "./filters";
-import { SearchIndex } from "../../../../../convex/dist/internal-cjs-types/server";
 
 const samplePage: GenericDocument[] = [
   { variableType: "stringValue" },
@@ -572,6 +571,86 @@ describe("filters", () => {
       ]);
     });
 
+    it("should apply search index filters with undefined values", () => {
+      const mockBuilder = new MockSearchBuilder();
+      const searchString = "test search";
+      const searchIndexFilters = [
+        { field: "organizationId", enabled: true, value: undefined },
+      ];
+      const selectedIndex: SearchIndex = {
+        indexDescriptor: "testSearchIndex",
+        searchField: "description",
+        filterFields: ["userId", "organizationId"],
+      };
+
+      applySearchIndexFilters(
+        mockBuilder as any,
+        searchString,
+        searchIndexFilters,
+        selectedIndex,
+      );
+
+      expect(mockBuilder.operations).toEqual([
+        { op: "search", field: "description", value: "test search" },
+        { op: "eq", field: "organizationId", value: undefined },
+      ]);
+    });
+
+    it("should apply search index filters with JSON-serialized values", () => {
+      const mockBuilder = new MockSearchBuilder();
+      const searchString = "test search";
+      const searchIndexFilters = [
+        { field: "userId", enabled: true, value: { $integer: "AQAAAAAAAAA=" } },
+      ];
+      const selectedIndex: SearchIndex = {
+        indexDescriptor: "testSearchIndex",
+        searchField: "description",
+        filterFields: ["userId", "organizationId"],
+      };
+
+      applySearchIndexFilters(
+        mockBuilder as any,
+        searchString,
+        searchIndexFilters,
+        selectedIndex,
+      );
+
+      expect(mockBuilder.operations).toEqual([
+        { op: "search", field: "description", value: "test search" },
+        { op: "eq", field: "userId", value: BigInt(1) },
+      ]);
+    });
+
+    it("should apply search index filters with value = undefined", () => {
+      const mockBuilder = new MockSearchBuilder();
+      const searchString = "test search";
+      const searchIndexFilters = [
+        {
+          field: "userId",
+          enabled: true,
+          value:
+            "__CONVEX_PLACEHOLDER_undefined_I23atX0jcndVbFgXoQZffsih7eAqktCyFjgUuAeNBtfr3ySOljPSPSEOPFgprkdBO3zXNiGEJxmJ5ZFPc5C5qKesG80QRPvlJe8vgSxAt9feLTwxTg4PHfVwUaTEJU67FDwldWmTxp1guMPwxQ2jOuhEryTBf3mQ",
+        },
+      ];
+      const selectedIndex: SearchIndex = {
+        indexDescriptor: "testSearchIndex",
+        searchField: "description",
+        filterFields: ["userId", "organizationId"],
+      };
+
+      applySearchIndexFilters(
+        mockBuilder as any,
+        searchString,
+        searchIndexFilters,
+        selectedIndex,
+      );
+
+      expect(mockBuilder.operations).toEqual([
+        { op: "search", field: "description", value: "test search" },
+        { op: "eq", field: "userId", value: undefined },
+      ]);
+    });
+
     it("should only apply filters for fields that exist in the filter", () => {
       const mockBuilder = new MockSearchBuilder();
       const searchString = "test search";
@@ -782,7 +861,7 @@ describe("filters", () => {
       const result = validateSearchIndexFilter(
         indexName,
         [
-          { field: "userId", enabled: true, value: BigInt(123) },
+          { field: "userId", enabled: true, value: 123 },
           { field: "organization", enabled: true, value: "exampleOrg" },
         ],
         selectedIndex,
@@ -818,7 +897,7 @@ describe("filters", () => {
       const result = validateSearchIndexFilter(
         indexName,
         [
-          { field: "userId", enabled: true, value: BigInt(123) },
+          { field: "userId", enabled: true, value: 123 },
           { field: "organization", enabled: true, value: "exampleOrg" },
         ],
         selectedIndex,
@@ -842,7 +921,7 @@ describe("filters", () => {
       const result = validateSearchIndexFilter(
         indexName,
         [
-          { field: "userId", enabled: true, value: BigInt(123) },
+          { field: "userId", enabled: true, value: 123 },
           { field: "organization", enabled: false, value: "exampleOrg" },
         ],
         selectedIndex,
@@ -889,8 +968,8 @@ describe("filters", () => {
       const result = validateSearchIndexFilter(
         indexName,
         [
-          { field: "userId", enabled: true, value: BigInt(123) },
-          { field: "userId", enabled: true, value: BigInt(123) },
+          { field: "userId", enabled: true, value: 123 },
+          { field: "userId", enabled: true, value: 123 },
         ],
         selectedIndex,
         "asc",
@@ -912,8 +991,8 @@ describe("filters", () => {
       const result = validateSearchIndexFilter(
         indexName,
         [
-          { field: "userId", enabled: true, value: BigInt(123) },
-          { field: "userId", enabled: false, value: BigInt(456) },
+          { field: "userId", enabled: true, value: 123 },
+          { field: "userId", enabled: false, value: 456 },
         ],
         selectedIndex,
         "asc",

npm-packages/system-udfs/convex/_system/frontend/lib/filters.ts

@@ -29,11 +29,13 @@ export type SearchIndexFilter = {
   name: string;
   search: string;
   /** The clauses on the filter fields of the search index */
-  clauses: {
-    field: string;
-    enabled: boolean;
-    value: Value;
-  }[];
+  clauses: SearchIndexFilterClause[];
+};
+
+export type SearchIndexFilterClause = {
+  field: string;
+  enabled: boolean;
+  value: JSONValue | undefined;
 };
 
 export type FilterCommon = {
@@ -362,15 +364,20 @@ export function applySearchIndexFilters<
 >(
   q: SearchFilterBuilder<Document, SearchIndexConfig>,
   search: string,
-  filters: Array<{ field: string; enabled: boolean; value: Value }>,
+  filters: SearchIndexFilterClause[],
   selectedIndex: SearchIndex,
 ): SearchFilterFinalizer<Document, SearchIndexConfig> {
   let builder = q.search(selectedIndex.searchField, search);
 
   // Apply filters
   for (const { field, enabled, value } of filters) {
     if (enabled) {
-      builder = builder.eq(field, value as any);
+      builder = builder.eq(
+        field,
+        (value === UNDEFINED_PLACEHOLDER
+          ? undefined
+          : jsonToConvexOrValue(value)) as any,
+      );
     }
   }
 
@@ -452,7 +459,7 @@ export function validateIndexFilter(
  */
 export function validateSearchIndexFilter(
   indexName: string,
-  filters: Array<{ field: string; enabled: boolean; value: Value }>,
+  filters: SearchIndexFilterClause[],
   selectedIndex: Index | SearchIndex | undefined,
   order: "asc" | "desc",
 ) {