Resolving issues with loading dotprompt files (#92)

- Adding plugin to samples which use prompt files
- Checking existence of prompt folder before reading dir
- Fixing bug in registry key

js/plugins/dotprompt/src/registry.ts

@@ -26,7 +26,7 @@ export function registryDefinitionKey(name: string, variant?: string) {
 }
 
 export function registryLookupKey(name: string, variant?: string) {
-  return `prompt/${registryDefinitionKey(name, variant)}`;
+  return `/prompt/${registryDefinitionKey(name, variant)}`;
 }
 
 export async function lookupPrompt(
@@ -71,25 +71,29 @@ export async function loadPromptFolder(
 ): Promise<void> {
   const promptsPath = resolve(dir);
   return new Promise<void>((resolve, reject) => {
-    readdir(
-      promptsPath,
-      {
-        withFileTypes: true,
-        recursive: false,
-      },
-      (err, dirEnts) => {
-        if (err) {
-          reject(err);
-        } else {
-          dirEnts.forEach(async (dirEnt) => {
-            if (dirEnt.isFile() && dirEnt.name.endsWith('.prompt')) {
-              loadPrompt(dirEnt.path, dirEnt.name);
-            }
-          });
-          resolve();
+    if (existsSync(promptsPath)) {
+      readdir(
+        promptsPath,
+        {
+          withFileTypes: true,
+          recursive: false,
+        },
+        (err, dirEnts) => {
+          if (err) {
+            reject(err);
+          } else {
+            dirEnts.forEach(async (dirEnt) => {
+              if (dirEnt.isFile() && dirEnt.name.endsWith('.prompt')) {
+                loadPrompt(dirEnt.path, dirEnt.name);
+              }
+            });
+            resolve();
+          }
         }
-      }
-    );
+      );
+    } else {
+      resolve();
+    }
   });
 }
 

js/plugins/dotprompt/tests/prompt_test.ts

@@ -18,12 +18,21 @@ import assert from 'node:assert';
 import { describe, it } from 'node:test';
 
 import { defineModel } from '@genkit-ai/ai/model';
-import z from 'zod';
-
 import { toJsonSchema, ValidationError } from '@genkit-ai/core/schema';
+import z from 'zod';
+import { registerPluginProvider } from '../../../core/src/registry.js';
 import { defineDotprompt, Dotprompt, prompt } from '../src/index.js';
 import { PromptMetadata } from '../src/metadata.js';
 
+function registerDotprompt() {
+  registerPluginProvider('dotprompt', {
+    name: 'dotprompt',
+    async initializer() {
+      return {};
+    },
+  });
+}
+
 const echo = defineModel(
   { name: 'echo', supports: { tools: true } },
   async (input) => ({
@@ -62,6 +71,7 @@ describe('Prompt', () => {
     });
 
     it('rejects input not matching the schema', async () => {
+      registerDotprompt();
       const invalidSchemaPrompt = defineDotprompt(
         {
           name: 'invalidInput',
@@ -90,6 +100,7 @@ describe('Prompt', () => {
     });
 
     it('rejects input not matching the schema', async () => {
+      registerDotprompt();
       const invalidSchemaPrompt = defineDotprompt(
         {
           name: 'invalidInput',
@@ -176,6 +187,7 @@ output:
 
   describe('definePrompt', () => {
     it('registers a prompt and its variant', async () => {
+      registerDotprompt();
       defineDotprompt(
         {
           name: 'promptName',

js/samples/byo-evaluator/src/index.ts

@@ -16,6 +16,7 @@
 import { EvaluatorAction } from '@genkit-ai/ai';
 import { ModelReference } from '@genkit-ai/ai/model';
 import { configureGenkit, genkitPlugin, PluginProvider } from '@genkit-ai/core';
+import { dotprompt } from '@genkit-ai/dotprompt';
 import { firebase } from '@genkit-ai/firebase';
 import { geminiPro, googleAI } from '@genkit-ai/googleai';
 import * as z from 'zod';
@@ -42,6 +43,7 @@ import {
 
 configureGenkit({
   plugins: [
+    dotprompt(),
     firebase(),
     googleAI({ apiVersion: ['v1', 'v1beta'] }),
     byoEval({

js/samples/cat-eval/src/index.ts

@@ -16,6 +16,7 @@
 
 import { configureGenkit } from '@genkit-ai/core';
 import { devLocalVectorstore } from '@genkit-ai/dev-local-vectorstore';
+import { dotprompt } from '@genkit-ai/dotprompt';
 import { genkitEval, GenkitMetric } from '@genkit-ai/evaluator';
 import { firebase } from '@genkit-ai/firebase';
 import { geminiPro, googleAI } from '@genkit-ai/googleai';
@@ -46,6 +47,7 @@ export const PERMISSIVE_SAFETY_SETTINGS: any = {
 
 configureGenkit({
   plugins: [
+    dotprompt(),
     firebase(),
     googleAI(),
     genkitEval({

js/samples/coffee-shop/src/index.ts

@@ -15,14 +15,18 @@
  */
 
 import { configureGenkit } from '@genkit-ai/core';
-import { defineDotprompt } from '@genkit-ai/dotprompt';
+import { defineDotprompt, dotprompt } from '@genkit-ai/dotprompt';
 import { firebase } from '@genkit-ai/firebase';
 import { defineFlow, runFlow } from '@genkit-ai/flow';
 import googleAI, { geminiPro } from '@genkit-ai/googleai';
 import * as z from 'zod';
 
 configureGenkit({
-  plugins: [googleAI({ apiVersion: ['v1', 'v1beta'] }), firebase()],
+  plugins: [
+    googleAI({ apiVersion: ['v1', 'v1beta'] }),
+    firebase(),
+    dotprompt(),
+  ],
   enableTracingAndMetrics: true,
   flowStateStore: 'firebase',
   logLevel: 'debug',

js/samples/menu-example/basic/src/index.ts

@@ -18,12 +18,13 @@
 // both.
 import { generate } from '@genkit-ai/ai';
 import { configureGenkit } from '@genkit-ai/core';
+import { dotprompt } from '@genkit-ai/dotprompt';
 import { defineFlow, startFlowsServer } from '@genkit-ai/flow';
 import { geminiPro, googleAI } from '@genkit-ai/googleai';
 import * as z from 'zod';
 
 configureGenkit({
-  plugins: [googleAI()],
+  plugins: [googleAI(), dotprompt()],
   logLevel: 'debug',
   enableTracingAndMetrics: true,
 });

js/samples/prompt-file/src/index.ts

@@ -15,13 +15,13 @@
  */
 
 import { configureGenkit } from '@genkit-ai/core';
-import { prompt } from '@genkit-ai/dotprompt';
+import { dotprompt, prompt } from '@genkit-ai/dotprompt';
 import { defineFlow } from '@genkit-ai/flow';
 import { googleAI } from '@genkit-ai/googleai';
 import * as z from 'zod';
 
 configureGenkit({
-  plugins: [googleAI()],
+  plugins: [googleAI(), dotprompt()],
   enableTracingAndMetrics: true,
   logLevel: 'debug',
 });

js/samples/rag/src/index.ts

@@ -16,6 +16,7 @@
 
 import { configureGenkit } from '@genkit-ai/core';
 import { devLocalVectorstore } from '@genkit-ai/dev-local-vectorstore';
+import { dotprompt } from '@genkit-ai/dotprompt';
 import { genkitEval, GenkitMetric } from '@genkit-ai/evaluator';
 import { firebase } from '@genkit-ai/firebase';
 import { googleAI } from '@genkit-ai/googleai';
@@ -31,6 +32,7 @@ import { pinecone } from 'genkitx-pinecone';
 
 export default configureGenkit({
   plugins: [
+    dotprompt(),
     firebase(),
     googleAI({ apiVersion: ['v1', 'v1beta'] }),
     genkitEval({