fix: #860 unhandled error when using a wrong property for vector search (#971)

Author: micheleriva

packages/orama/package.json

@@ -177,4 +177,4 @@
     ]
   },
   "module": "./dist/esm/index.js"
-}
+}

packages/orama/src/errors.ts

@@ -29,6 +29,7 @@ const errors = {
   UNKNOWN_GROUP_BY_PROPERTY: `Unknown groupBy property "%s".`,
   INVALID_GROUP_BY_PROPERTY: `Invalid groupBy property "%s". Allowed types: "%s", but given "%s".`,
   UNKNOWN_FILTER_PROPERTY: `Unknown filter property "%s".`,
+  UNKNOWN_VECTOR_PROPERTY: `Unknown vector property "%s". Make sure the property exists in the schema and is configured as a vector.`,
   INVALID_VECTOR_SIZE: `Vector size must be a number greater than 0. Got "%s" instead.`,
   INVALID_VECTOR_VALUE: `Vector value must be a number greater than 0. Got "%s" instead.`,
   INVALID_INPUT_VECTOR: `Property "%s" was declared as a %s-dimensional vector, but got a %s-dimensional vector instead.\nInput vectors must be of the size declared in the schema, as calculating similarity between vectors of different sizes can lead to unexpected results.`,

packages/orama/src/methods/search-vector.ts

@@ -21,6 +21,10 @@ export function innerVectorSearch<T extends AnyOrama, ResultDocument = TypedDocu
   }
 
   const vectorIndex = orama.data.index.vectorIndexes[vector!.property]
+  if (!vectorIndex) {
+    throw createError('UNKNOWN_VECTOR_PROPERTY', vector!.property)
+  }
+  
   const vectorSize = vectorIndex.node.size
 
   if (vector?.value.length !== vectorSize) {

packages/orama/tests/search-vector.test.ts

@@ -173,6 +173,31 @@ t.test('search', async (t) => {
     t.same((results2.hits[1].document as any).vectors.embedding_2, [0.2, 0.2, 0.21, 0.21, 0.21, 0.21])
     t.same((results2.hits[2].document as any).vectors.embedding_2, [0.2, 0.02, 0.1, 0.1, 0.1, 0.1])
   })
+
+  t.test('should throw an error when using unknown vector property', async (t) => {
+    const db = await create({
+      schema: {
+        title: 'string',
+        embedding: 'vector[5]'
+      } as const
+    })
+
+    await insertMultiple(db, [{ title: 'foo', embedding: [1, 1, 1, 1, 1] }])
+
+    try {
+      await search(db, {
+        mode: 'vector',
+        vector: {
+          value: [1, 1, 1, 1, 1],
+          property: 'nonexistent_vector'
+        }
+      })
+      t.fail('Should have thrown an error')
+    } catch (err: any) {
+      t.ok(err.message.includes('Unknown vector property "nonexistent_vector"'), 'error message contains property name')
+      t.same(err.code, 'UNKNOWN_VECTOR_PROPERTY', 'correct error code')
+    }
+  })
 })
 
 t.test('vector search with where clause', async (t) => {

packages/tokenizers/package.json

@@ -82,4 +82,4 @@
     "tshy": "^3.0.2",
     "tsx": "^4.19.2"
   }
-}
+}