Merge pull request #200 from off-grid-ai/fix/ci-build-shared-rag

CI and release builds build the shared rag package

Author: alichherawalla

.github/workflows/ci.yml

@@ -135,6 +135,8 @@ jobs:
           npm --prefix ../shared ci
           npm --prefix ../shared/packages/sync run build
           npm --prefix ../shared/packages/models run build
+          # @offgrid/rag (the document engine) ships a built dist/ like sync and models.
+          npm --prefix ../shared/packages/rag run build
           npm --prefix ../shared/packages/speech run build
           npm --prefix ../shared/packages/ui run build
       - name: Check out the private Desktop speech runtime
@@ -534,7 +536,7 @@ jobs:
           mv _shared ../shared
           mv _executorch_speech ../executorch-speech
           npm --prefix ../shared ci
-          for package in models sync use automation speech ui; do
+          for package in models rag sync use automation speech ui; do
             npm --prefix "../shared/packages/$package" run build
           done
           npm ci

.github/workflows/release.yml

@@ -274,6 +274,8 @@ jobs:
           npm --prefix ../shared/packages/use run build
           npm --prefix ../shared/packages/automation run build
           npm --prefix ../shared/packages/models run build
+          # @offgrid/rag (the document engine) ships a built dist/ like sync and models.
+          npm --prefix ../shared/packages/rag run build
           npm --prefix ../shared/packages/speech run build
           npm --prefix ../shared/packages/ui run build
       - name: Check out the private Desktop speech runtime
@@ -621,6 +623,8 @@ jobs:
           npm --prefix ../shared/packages/use run build
           npm --prefix ../shared/packages/automation run build
           npm --prefix ../shared/packages/models run build
+          # @offgrid/rag (the document engine) ships a built dist/ like sync and models.
+          npm --prefix ../shared/packages/rag run build
           npm --prefix ../shared/packages/speech run build
           npm --prefix ../shared/packages/ui run build
       - name: Check out the private Desktop speech package

.github/workflows/windows-build.yml

@@ -171,6 +171,8 @@ jobs:
           mv _shared ../shared
           npm --prefix ../shared ci
           npm --prefix ../shared/packages/models run build
+          # @offgrid/rag (the document engine) ships a built dist/ like sync and models.
+          npm --prefix ../shared/packages/rag run build
           npm --prefix ../shared/packages/sync run build
           npm --prefix ../shared/packages/use run build
           npm --prefix ../shared/packages/automation run build

e2e/fixtures/chat-queue-versions-llama-server.mjs

@@ -70,7 +70,8 @@ const server = http.createServer((request, response) => {
                   .join('\n')
         }))
     })
-    if (prompt === 'Keep the saved answer after failure.' && attempt === 2) {
+    // The resend fails, and so does the one retry the chat fallback makes for an unavailable model.
+    if (prompt === 'Keep the saved answer after failure.' && (attempt === 2 || attempt === 3)) {
       response.writeHead(503, { 'Content-Type': 'application/json' })
       response.end(JSON.stringify({ error: { message: 'Synthetic model unavailable.' } }))
       return

src/main/__tests__/fixtures/synthetic-pdf.ts

@@ -12,7 +12,7 @@ import crypto from 'crypto'
 import fs from 'fs'
 import os from 'os'
 import path from 'path'
-import { SYNTHETIC_PDF } from './fixtures/synthetic-pdf'
+import { textLayerPdf } from './fixtures/synthetic-pdf'
 
 const TMP_DIR = fs.mkdtempSync(path.join(os.tmpdir(), 'offgrid-ragstore-it-'))
 
@@ -271,7 +271,11 @@ describe('knowledge base over the document engine', () => {
 
   it('reads a real PDF page by page', async () => {
     store.createProject({ id: 'p-pdf', name: 'PDF' })
-    const pdf = await addFile('p-pdf', 'decision.pdf', SYNTHETIC_PDF)
+    const pdf = await addFile(
+      'p-pdf',
+      'decision.pdf',
+      textLayerPdf('Decision record: the launch moves to the second week of March after the audit.')
+    )
 
     const indexed = await finishedIndexing(pdf.documentId!)
     expect(indexed.state).toBe('ready')

src/main/__tests__/rag-store-integration.dbtest.ts

@@ -1,5 +1,7 @@
 // ProjectDocumentsPort: a project's knowledge base as document sources. Every chat filed in the
 // project uses these files alongside its own attachments; the rules are the shared turn service's.
+// Reads the knowledge-base rows (rag/store) directly: the knowledge-base service sits above this
+// layer and uses it, so importing the service here would be a cycle.
 
 import fs from 'node:fs'
 import type { DocumentSource, ProjectDocumentsPort } from '@offgrid/rag/documents'
@@ -8,10 +10,10 @@ import type { RagDocument } from '@offgrid/rag'
 /** Kinds the engine reads from the file itself; the rest are indexed from their transcript or caption. */
 const FILE_KINDS = new Set(['pdf', 'docx', 'text'])
 
-async function sourceFor(document: RagDocument): Promise<DocumentSource | null> {
-  const { knowledgeBase } = await import('../rag')
-  // A file added before files had document ids is indexed in the background; it joins later turns.
-  const id = await knowledgeBase.documentIdFor(document, FILE_KINDS.has(document.kind))
+function sourceFor(document: RagDocument): DocumentSource | null {
+  // A file added before files had document ids has none until the knowledge-base list indexes it
+  // (rag-ipc); it joins the turns from then on.
+  const id = document.documentId
   if (!id) return null
   const onDisk = FILE_KINDS.has(document.kind) && fs.existsSync(document.path)
   return {
@@ -24,17 +26,17 @@ async function sourceFor(document: RagDocument): Promise<DocumentSource | null>
 
 export const projectDocuments: ProjectDocumentsPort = {
   async forConversation(conversationId) {
-    const { projectOfConversation } = await import('../rag')
+    const { projectOfConversation } = await import('../rag/store')
     const projectId = projectOfConversation(conversationId)
     return projectId ? projectDocuments.forProject(projectId) : []
   },
   async forProject(projectId) {
-    const { listRagDocuments } = await import('../rag')
+    const { listRagDocuments } = await import('../rag/store')
     const sources: DocumentSource[] = []
     // Oldest first, so the stable prompt block keeps its order as files are added.
     for (const document of listRagDocuments(projectId).reverse()) {
       if (!document.enabled) continue
-      const source = await sourceFor(document)
+      const source = sourceFor(document)
       if (source) sources.push(source)
     }
     return sources
@@ -43,6 +45,6 @@ export const projectDocuments: ProjectDocumentsPort = {
 
 /** Every document id a knowledge base holds, so cache cleanup never drops one. */
 export async function knowledgeBaseDocumentIds(): Promise<Set<string>> {
-  const { listAllRagDocuments } = await import('../rag')
+  const { listAllRagDocuments } = await import('../rag/store')
   return new Set(listAllRagDocuments().flatMap((document) => (document.documentId ? [document.documentId] : [])))
 }

src/main/documents/project-documents.ts

@@ -5,9 +5,20 @@
 // knowledge base and the chat's attachments.
 
 import { describeTurnStatus } from '@offgrid/rag/documents'
-import type { ToolContext, ToolExtension } from '../tools'
+import type { SearchResult } from '../../shared/search-contract'
 import { documentStore, documentTurns } from '.'
-import { foundPassageSource } from './chat-turn'
+import { foundPassageSource, type DocumentsActivity } from './chat-turn'
+
+/**
+ * What these tools read from the tool loop's context (fields of tools.ts's ToolContext). Declared
+ * here, not imported: the tool loop imports this module, so importing it back would be a cycle.
+ */
+export interface DocumentToolContext {
+  conversationId?: string
+  projectId?: string
+  citeDocumentPassage?: (source: SearchResult) => number
+  onActivity?: (activity: DocumentsActivity) => void
+}
 
 const SEARCH = 'search_documents'
 const READ = 'read_pages'
@@ -57,7 +68,7 @@ function where(label: string | undefined, page: number): string {
 }
 
 /** The documents this tool call may see. */
-function scopeOf(context: ToolContext | undefined): { conversationId?: string; projectId?: string } {
+function scopeOf(context: DocumentToolContext | undefined): { conversationId?: string; projectId?: string } {
   return {
     ...(context?.conversationId ? { conversationId: context.conversationId } : {}),
     ...(context?.projectId ? { projectId: context.projectId } : {})
@@ -69,7 +80,7 @@ function scopeOf(context: ToolContext | undefined): { conversationId?: string; p
  * this turn's sources (also used by search_knowledge_base).
  */
 export async function searchDocumentsForTool(
-  context: ToolContext | undefined,
+  context: DocumentToolContext | undefined,
   query: string,
   documentName?: string
 ): Promise<string> {
@@ -87,14 +98,18 @@ export async function searchDocumentsForTool(
   return result.text.slice(0, MAX_CHARS)
 }
 
-export const documentToolExtension: ToolExtension = {
+export const documentToolExtension = {
   id: 'attached-documents',
-  category: 'tool',
+  category: 'tool' as const,
   // Added per turn by toolChat when the conversation has documents, never from the shared list.
-  schemas: () => [],
-  canHandle: (name) => name === SEARCH || name === READ,
-  isReadOnlyTool: () => true,
-  async execute(name, args, context) {
+  schemas: (): unknown[] => [],
+  canHandle: (name: string): boolean => name === SEARCH || name === READ,
+  isReadOnlyTool: (): boolean => true,
+  async execute(
+    name: string,
+    args: Record<string, unknown>,
+    context?: DocumentToolContext
+  ): Promise<string> {
     if (name === SEARCH) {
       const query = typeof args.query === 'string' ? args.query.trim() : ''
       if (!query) return 'Give a query to search for.'
@@ -122,6 +137,6 @@ export const documentToolExtension: ToolExtension = {
       .join('\n\n')
       .slice(0, MAX_CHARS)
   },
-  systemHint: () =>
+  systemHint: (): string =>
     'search_documents and read_pages look further into this chat\'s documents when the passages given are not enough.'
 }

src/main/documents/tool-extension.ts

@@ -297,7 +297,7 @@ export function VoiceSettingsTab(): React.JSX.Element {
         'This is the Off Grid AI voice.',
         voices.length ? voice : undefined
       )
-      if (!result?.dataUrl) throw new Error('No audio returned')
+      if (!result.dataUrl) throw new Error('No audio returned')
       const audio = new Audio(result.dataUrl)
       testAudioRef.current = audio
       audio.playbackRate = preferences.speed