feat(config): add client side and server side config registries

.github/workflows/docker-build.yaml

@@ -4,6 +4,7 @@ on:
   push:
     branches:
       - master
+      - canary
   release:
     types: [published]
 
@@ -43,6 +44,19 @@ jobs:
             -t itzcrazykns1337/${IMAGE_NAME}:amd64 \
             --push .
 
+      - name: Build and push AMD64 Canary Docker image
+        if: github.ref == 'refs/heads/canary' && github.event_name == 'push'
+        run: |
+          DOCKERFILE=app.dockerfile
+          IMAGE_NAME=perplexica
+          docker buildx build --platform linux/amd64 \
+            --cache-from=type=registry,ref=itzcrazykns1337/${IMAGE_NAME}:canary-amd64 \
+            --cache-to=type=inline \
+            --provenance false \
+            -f $DOCKERFILE \
+            -t itzcrazykns1337/${IMAGE_NAME}:canary-amd64 \
+            --push .
+
       - name: Build and push AMD64 release Docker image
         if: github.event_name == 'release'
         run: |
@@ -91,6 +105,19 @@ jobs:
             -t itzcrazykns1337/${IMAGE_NAME}:arm64 \
             --push .
 
+      - name: Build and push ARM64 Canary Docker image
+        if: github.ref == 'refs/heads/canary' && github.event_name == 'push'
+        run: |
+          DOCKERFILE=app.dockerfile
+          IMAGE_NAME=perplexica
+          docker buildx build --platform linux/arm64 \
+            --cache-from=type=registry,ref=itzcrazykns1337/${IMAGE_NAME}:canary-arm64 \
+            --cache-to=type=inline \
+            --provenance false \
+            -f $DOCKERFILE \
+            -t itzcrazykns1337/${IMAGE_NAME}:canary-arm64 \
+            --push .
+
       - name: Build and push ARM64 release Docker image
         if: github.event_name == 'release'
         run: |
@@ -128,6 +155,15 @@ jobs:
             --amend itzcrazykns1337/${IMAGE_NAME}:arm64
           docker manifest push itzcrazykns1337/${IMAGE_NAME}:main
 
+      - name: Create and push multi-arch manifest for canary
+        if: github.ref == 'refs/heads/canary' && github.event_name == 'push'
+        run: |
+          IMAGE_NAME=perplexica
+          docker manifest create itzcrazykns1337/${IMAGE_NAME}:canary \
+            --amend itzcrazykns1337/${IMAGE_NAME}:canary-amd64 \
+            --amend itzcrazykns1337/${IMAGE_NAME}:canary-arm64
+          docker manifest push itzcrazykns1337/${IMAGE_NAME}:canary
+
       - name: Create and push multi-arch manifest for releases
         if: github.event_name == 'release'
         run: |

app.dockerfile

@@ -15,9 +15,6 @@ COPY drizzle ./drizzle
 RUN mkdir -p /home/perplexica/data
 RUN yarn build
 
-RUN yarn add --dev @vercel/ncc
-RUN yarn ncc build ./src/lib/db/migrate.ts -o migrator
-
 FROM node:24.5.0-slim
 
 RUN apt-get update && apt-get install -y python3 python3-pip sqlite3 && rm -rf /var/lib/apt/lists/*
@@ -30,8 +27,6 @@ COPY --from=builder /home/perplexica/.next/static ./public/_next/static
 COPY --from=builder /home/perplexica/.next/standalone ./
 COPY --from=builder /home/perplexica/data ./data
 COPY drizzle ./drizzle
-COPY --from=builder /home/perplexica/migrator/build ./build
-COPY --from=builder /home/perplexica/migrator/index.js ./migrate.js
 
 RUN mkdir /home/perplexica/uploads
 

entrypoint.sh

@@ -1,6 +1,4 @@
 #!/bin/sh
 set -e
 
-node migrate.js
-
 exec node server.js

package.json

@@ -1,18 +1,18 @@
 {
   "name": "perplexica-frontend",
-  "version": "1.11.0-rc2",
+  "version": "1.11.0-rc3",
   "license": "MIT",
   "author": "ItzCrazyKns",
   "scripts": {
     "dev": "next dev",
-    "build": "npm run db:migrate && next build",
+    "build": "next build",
     "start": "next start",
     "lint": "next lint",
-    "format:write": "prettier . --write",
-    "db:migrate": "node ./src/lib/db/migrate.ts"
+    "format:write": "prettier . --write"
   },
   "dependencies": {
     "@headlessui/react": "^2.2.0",
+    "@headlessui/tailwindcss": "^0.2.2",
     "@iarna/toml": "^2.2.5",
     "@icons-pack/react-simple-icons": "^12.3.0",
     "@langchain/anthropic": "^0.3.24",
@@ -65,6 +65,7 @@
     "postcss": "^8",
     "prettier": "^3.2.5",
     "tailwindcss": "^3.3.0",
+    "ts-node": "^10.9.2",
     "typescript": "^5"
   }
 }

src/components/MessageInputActions/Focus.tsx

@@ -63,7 +63,7 @@ const Focus = () => {
     <Popover className="relative w-full max-w-[15rem] md:max-w-md lg:max-w-lg mt-[6.5px]">
       <PopoverButton
         type="button"
-        className=" text-black/50 dark:text-white/50 rounded-xl hover:bg-light-secondary dark:hover:bg-dark-secondary active:scale-95 transition duration-200 hover:text-black dark:hover:text-white"
+        className="active:border-none headless-open:text-black dark:headless-open:text-white text-black/50 dark:text-white/50 rounded-xl hover:bg-light-secondary dark:hover:bg-dark-secondary active:scale-95 transition duration-200 hover:text-black dark:hover:text-white"
       >
         {focusMode !== 'webSearch' ? (
           <div className="flex flex-row items-center space-x-1">

src/instrumentation.ts

@@ -0,0 +1,13 @@
+export const register = async () => {
+  if (process.env.NEXT_RUNTIME === 'nodejs') {
+    try {
+      console.log('Running database migrations...');
+      await import('./lib/db/migrate');
+      console.log('Database migrations completed successfully');
+    } catch (error) {
+      console.error('Failed to run database migrations:', error);
+    }
+
+    await import('./lib/config/index');
+  }
+};

src/lib/config/clientRegistry.ts

@@ -0,0 +1,13 @@
+"use client"
+
+const getClientConfig = (key: string, defaultVal?: any) => {
+    return localStorage.getItem(key) ?? defaultVal ?? undefined
+}
+
+export const getTheme = () => getClientConfig('theme', 'dark')
+
+export const getAutoImageSearch = () => Boolean(getClientConfig('autoImageSearch', 'true'))
+
+export const getAutoVideoSearch = () => Boolean(getClientConfig('autoVideoSearch', 'true'))
+
+export const getSystemInstructions = () => getClientConfig('systemInstructions', '')

src/lib/config/index.ts

@@ -0,0 +1,153 @@
+import path from 'node:path';
+import fs from 'fs';
+import { Config, ConfigModelProvider, EnvMap, UIConfigSections } from './types';
+import ModelRegistry from '../models/registry';
+import { hashObj } from '../serverUtils';
+
+class ConfigManager {
+  configPath: string = path.join(
+    process.env.DATA_DIR || process.cwd(),
+    '/data/config.json',
+  );
+  configVersion = 1;
+  currentConfig: Config = {
+    version: this.configVersion,
+    general: {},
+    modelProviders: [],
+  };
+  uiConfigSections: UIConfigSections = {
+    general: [],
+    modelProviders: [],
+  };
+  modelRegistry = new ModelRegistry();
+
+  constructor() {
+    this.initialize();
+  }
+
+  private initialize() {
+    this.initializeConfig();
+    this.initializeFromEnv();
+  }
+
+  private saveConfig() {
+    fs.writeFileSync(
+      this.configPath,
+      JSON.stringify(this.currentConfig, null, 2),
+    );
+  }
+
+  private initializeConfig() {
+    const exists = fs.existsSync(this.configPath);
+    if (!exists) {
+      fs.writeFileSync(
+        this.configPath,
+        JSON.stringify(this.currentConfig, null, 2),
+      );
+    } else {
+      try {
+        this.currentConfig = JSON.parse(
+          fs.readFileSync(this.configPath, 'utf-8'),
+        );
+      } catch (err) {
+        if (err instanceof SyntaxError) {
+          console.error(
+            `Error parsing config file at ${this.configPath}:`,
+            err,
+          );
+          console.log(
+            'Loading default config and overwriting the existing file.',
+          );
+          fs.writeFileSync(
+            this.configPath,
+            JSON.stringify(this.currentConfig, null, 2),
+          );
+          return;
+        } else {
+          console.log('Unknown error reading config file:', err);
+        }
+      }
+
+      this.currentConfig = this.migrateConfig(this.currentConfig);
+    }
+  }
+
+  private migrateConfig(config: Config): Config {
+    /* TODO: Add migrations */
+    return config;
+  }
+
+  private initializeFromEnv() {
+    const providerConfigSections = this.modelRegistry.getUIConfigSection();
+
+    this.uiConfigSections.modelProviders = providerConfigSections;
+
+    const newProviders: ConfigModelProvider[] = [];
+
+    providerConfigSections.forEach((provider) => {
+      const newProvider: ConfigModelProvider & { required?: string[] } = {
+        id: crypto.randomUUID(),
+        name: `${provider.name} ${Math.floor(Math.random() * 1000)}`,
+        type: provider.key,
+        chatModels: [],
+        embeddingModels: [],
+        config: {},
+        required: [],
+        hash: '',
+      };
+
+      provider.fields.forEach((field) => {
+        newProvider.config[field.key] =
+          process.env[field.env!] ||
+          field.default ||
+          ''; /* Env var must exist for providers */
+
+        if (field.required) newProvider.required?.push(field.key);
+      });
+
+      let configured = true;
+
+      newProvider.required?.forEach((r) => {
+        if (!newProvider.config[r]) {
+          configured = false;
+        }
+      });
+
+      if (configured) {
+        const hash = hashObj(newProvider.config);
+        newProvider.hash = hash;
+        delete newProvider.required;
+
+        const exists = this.currentConfig.modelProviders.find(
+          (p) => p.hash === hash,
+        );
+
+        if (!exists) {
+          newProviders.push(newProvider);
+        }
+      }
+    });
+
+    this.currentConfig.modelProviders.push(...newProviders);
+
+    this.saveConfig();
+  }
+
+  public getConfig(key: string, defaultValue?: any): any {
+    const nested = key.split('.');
+    let obj: any = this.currentConfig;
+
+    for (let i = 0; i < nested.length; i++) {
+      const part = nested[i];
+      if (obj == null) return defaultValue;
+
+      obj = obj[part];
+    }
+
+    return obj === undefined ? defaultValue : obj;
+  }
+}
+
+const configManager = new ConfigManager();
+
+export default configManager

src/lib/config/serverRegistry.ts

@@ -0,0 +1 @@
+/* TODO: add server opts */

src/lib/config/types.ts

@@ -0,0 +1,82 @@
+type BaseUIConfigField = {
+  name: string;
+  key: string;
+  required: boolean;
+  description: string;
+  scope: 'client' | 'server';
+  env?: string;
+};
+
+type StringUIConfigField = BaseUIConfigField & {
+  type: 'string';
+  placeholder?: string;
+  default?: string;
+};
+
+type SelectUIConfigFieldOptions = {
+  name: string;
+  key: string;
+  value: string;
+};
+
+type SelectUIConfigField = BaseUIConfigField & {
+  type: 'select';
+  default?: string;
+  options: SelectUIConfigFieldOptions[];
+};
+
+type PasswordUIConfigField = BaseUIConfigField & {
+  type: 'password';
+  placeholder?: string;
+  default?: string;
+};
+
+type UIConfigField =
+  | StringUIConfigField
+  | SelectUIConfigField
+  | PasswordUIConfigField;
+
+type ConfigModelProvider = {
+  id: string;
+  name: string;
+  type: string;
+  chatModels: string[];
+  embeddingModels: string[];
+  config: { [key: string]: any };
+  hash: string;
+};
+
+type Config = {
+  version: number;
+  general: {
+    [key: string]: any;
+  };
+  modelProviders: ConfigModelProvider[];
+};
+
+type EnvMap = {
+  [key: string]: {
+    fieldKey: string;
+    providerKey: string;
+  };
+};
+
+type ModelProviderUISection = {
+  name: string;
+  key: string;
+  fields: UIConfigField[];
+};
+
+type UIConfigSections = {
+  general: UIConfigField[];
+  modelProviders: ModelProviderUISection[];
+};
+
+export type {
+  UIConfigField,
+  Config,
+  EnvMap,
+  UIConfigSections,
+  ModelProviderUISection,
+  ConfigModelProvider,
+};

src/lib/db/migrate.ts

@@ -2,9 +2,12 @@ import Database from 'better-sqlite3';
 import path from 'path';
 import fs from 'fs';
 
-const db = new Database(path.join(process.cwd(), 'data', 'db.sqlite'));
+const DATA_DIR = process.env.DATA_DIR || process.cwd();
+const dbPath = path.join(DATA_DIR, './data/db.sqlite');
 
-const migrationsFolder = path.join(process.cwd(), 'drizzle');
+const db = new Database(dbPath);
+
+const migrationsFolder = path.join(DATA_DIR, 'drizzle');
 
 db.exec(`
   CREATE TABLE IF NOT EXISTS ran_migrations (
@@ -54,7 +57,7 @@ fs.readdirSync(migrationsFolder)
                         id INTEGER PRIMARY KEY,
                         type TEXT NOT NULL,
                         chatId TEXT NOT NULL,
-                        createdAt TEXT NOT NULL,
+                        createdAt TEXT NOT NULL DEFAULT CURRENT_TIMESTAMP,
                         messageId TEXT NOT NULL,
                         content TEXT,
                         sources TEXT DEFAULT '[]'
@@ -67,8 +70,10 @@ fs.readdirSync(migrationsFolder)
                 `);
 
         messages.forEach((msg: any) => {
-          if (msg.type === 'user') {
+          while (typeof msg.metadata === 'string') {
             msg.metadata = JSON.parse(msg.metadata || '{}');
+          }
+          if (msg.type === 'user') {
             insertMessage.run(
               'user',
               msg.chatId,
@@ -78,7 +83,6 @@ fs.readdirSync(migrationsFolder)
               '[]',
             );
           } else if (msg.type === 'assistant') {
-            msg.metadata = JSON.parse(msg.metadata || '{}');
             insertMessage.run(
               'assistant',
               msg.chatId,

src/lib/models/providers/baseProvider.ts

@@ -0,0 +1,20 @@
+import { Embeddings } from '@langchain/core/embeddings';
+import { BaseChatModel } from '@langchain/core/language_models/chat_models';
+import { Model, ModelList, ProviderMetadata } from '../types';
+import { UIConfigField } from '@/lib/config/types';
+
+abstract class BaseModelProvider<CONFIG> {
+  constructor(protected config: CONFIG) {}
+  abstract getDefaultModels(): Promise<ModelList>;
+  abstract getModelList(): Promise<ModelList>;
+  abstract loadChatModel(modelName: string): Promise<BaseChatModel>;
+  abstract loadEmbeddingModel(modelName: string): Promise<Embeddings>;
+  static getProviderConfigFields(): UIConfigField[] {
+    throw new Error('Method not implemented.');
+  }
+  static getProviderMetadata(): ProviderMetadata {
+    throw new Error('Method not Implemented.');
+  }
+}
+
+export default BaseModelProvider;

src/lib/models/providers/openai.ts

@@ -0,0 +1,207 @@
+import { BaseChatModel } from '@langchain/core/language_models/chat_models';
+import { Model, ModelList, ProviderMetadata } from '../types';
+import BaseModelProvider from './baseProvider';
+import { ChatOpenAI, OpenAIEmbeddings } from '@langchain/openai';
+import { Embeddings } from '@langchain/core/embeddings';
+import { UIConfigField } from '@/lib/config/types';
+
+interface OpenAIConfig {
+  name: string;
+  apiKey: string;
+  baseURL: string;
+}
+
+const defaultChatModels: Model[] = [
+  {
+    name: 'GPT-3.5 Turbo',
+    key: 'gpt-3.5-turbo',
+  },
+  {
+    name: 'GPT-4',
+    key: 'gpt-4',
+  },
+  {
+    name: 'GPT-4 turbo',
+    key: 'gpt-4-turbo',
+  },
+  {
+    name: 'GPT-4 omni',
+    key: 'gpt-4o',
+  },
+  {
+    name: 'GPT-4o (2024-05-13)',
+    key: 'gpt-4o-2024-05-13',
+  },
+  {
+    name: 'GPT-4 omni mini',
+    key: 'gpt-4o-mini',
+  },
+  {
+    name: 'GPT 4.1 nano',
+    key: 'gpt-4.1-nano',
+  },
+  {
+    name: 'GPT 4.1 mini',
+    key: 'gpt-4.1-mini',
+  },
+  {
+    name: 'GPT 4.1',
+    key: 'gpt-4.1',
+  },
+  {
+    name: 'GPT 5 nano',
+    key: 'gpt-5-nano',
+  },
+  {
+    name: 'GPT 5',
+    key: 'gpt-5',
+  },
+  {
+    name: 'GPT 5 Mini',
+    key: 'gpt-5-mini',
+  },
+  {
+    name: 'o1',
+    key: 'o1',
+  },
+  {
+    name: 'o3',
+    key: 'o3',
+  },
+  {
+    name: 'o3 Mini',
+    key: 'o3-mini',
+  },
+  {
+    name: 'o4 Mini',
+    key: 'o4-mini',
+  },
+];
+
+const defaultEmbeddingModels: Model[] = [
+  {
+    name: 'Text Embedding 3 Small',
+    key: 'text-embedding-3-small',
+  },
+  {
+    name: 'Text Embedding 3 Large',
+    key: 'text-embedding-3-large',
+  },
+];
+
+const providerConfigFields: UIConfigField[] = [
+  /* {
+    type: 'string',
+    name: 'Name (Optional)',
+    key: 'name',
+    description: 'An optional name for this provider configuration',
+    required: false,
+    placeholder: 'Provider Name',
+    scope: 'server',
+  }, */ /* FOR NAME DIRECTLY CREATE INPUT IN FRONTEND */
+  {
+    type: 'password',
+    name: 'API Key',
+    key: 'apiKey',
+    description: 'Your OpenAI API key',
+    required: true,
+    placeholder: 'OpenAI API Key',
+    env: 'OPENAI_API_KEY',
+    scope: 'server',
+  },
+  {
+    type: 'string',
+    name: 'Base URL',
+    key: 'baseURL',
+    description: 'The base URL for the OpenAI API',
+    required: true,
+    placeholder: 'OpenAI Base URL',
+    default: 'https://api.openai.com/v1',
+    env: 'OPENAI_BASE_URL',
+    scope: 'server',
+  },
+];
+
+class OpenAIProvider extends BaseModelProvider<OpenAIConfig> {
+  constructor(config: OpenAIConfig) {
+    super(config);
+  }
+
+  async getDefaultModels(): Promise<ModelList> {
+    if (this.config.baseURL === 'https://api.openai.com/v1') {
+      return {
+        embedding: defaultEmbeddingModels,
+        chat: defaultChatModels,
+      };
+    }
+
+    return {
+      embedding: [],
+      chat: [],
+    };
+  }
+
+  async getModelList(): Promise<ModelList> {
+    /* Todo: IMPLEMENT MODEL READING FROM CONFIG FILE */
+    const defaultModels = await this.getDefaultModels();
+
+    return {
+      embedding: [...defaultModels.embedding],
+      chat: [...defaultModels.chat],
+    };
+  }
+
+  async loadChatModel(key: string): Promise<BaseChatModel> {
+    const modelList = await this.getModelList();
+
+    const exists = modelList.chat.filter((m) => m.key === key);
+
+    if (!exists) {
+      throw new Error(
+        'Error Loading OpenAI Chat Model. Invalid Model Selected',
+      );
+    }
+
+    return new ChatOpenAI({
+      apiKey: this.config.apiKey,
+      temperature: 0.7,
+      model: key,
+      configuration: {
+        baseURL: this.config.baseURL,
+      },
+    });
+  }
+
+  async loadEmbeddingModel(key: string): Promise<Embeddings> {
+    const modelList = await this.getModelList();
+
+    const exists = modelList.chat.filter((m) => m.key === key);
+
+    if (!exists) {
+      throw new Error(
+        'Error Loading OpenAI Embedding Model. Invalid Model Selected.',
+      );
+    }
+
+    return new OpenAIEmbeddings({
+      apiKey: this.config.apiKey,
+      model: key,
+      configuration: {
+        baseURL: this.config.baseURL,
+      },
+    });
+  }
+
+  static getProviderConfigFields(): UIConfigField[] {
+    return providerConfigFields;
+  }
+
+  static getProviderMetadata(): ProviderMetadata {
+    return {
+      key: 'openai',
+      name: 'OpenAI',
+    };
+  }
+}
+
+export default OpenAIProvider;

src/lib/models/registry.ts

@@ -0,0 +1,33 @@
+import { ModelProviderUISection, UIConfigField } from '../config/types';
+import { ProviderMetadata } from './types';
+import BaseModelProvider from './providers/baseProvider';
+import OpenAIProvider from './providers/openai';
+
+interface ProviderClass<T> {
+  new (config: T): BaseModelProvider<T>;
+  getProviderConfigFields(): UIConfigField[];
+  getProviderMetadata(): ProviderMetadata;
+}
+
+const providers: Record<string, ProviderClass<any>> = {
+  openai: OpenAIProvider,
+};
+
+class ModelRegistry {
+  constructor() {}
+
+  getUIConfigSection(): ModelProviderUISection[] {
+    return Object.entries(providers).map(([k, p]) => {
+      const configFields = p.getProviderConfigFields();
+      const metadata = p.getProviderMetadata();
+
+      return {
+        fields: configFields,
+        key: k,
+        name: metadata.name,
+      };
+    });
+  }
+}
+
+export default ModelRegistry;

src/lib/models/types.ts

@@ -0,0 +1,16 @@
+type Model = {
+  name: string;
+  key: string;
+};
+
+type ModelList = {
+  embedding: Model[];
+  chat: Model[];
+};
+
+type ProviderMetadata = {
+  name: string;
+  key: string;
+};
+
+export type { Model, ModelList, ProviderMetadata };

src/lib/serverUtils.ts

@@ -0,0 +1,7 @@
+import crypto from 'crypto';
+
+export const hashObj = (obj: { [key: string]: any }) => {
+  const json = JSON.stringify(obj, Object.keys(obj).sort());
+  const hash = crypto.createHash('sha256').update(json).digest('hex');
+  return hash;
+};

tailwind.config.ts

@@ -2,17 +2,17 @@ import type { Config } from 'tailwindcss';
 import type { DefaultColors } from 'tailwindcss/types/generated/colors';
 
 const themeDark = (colors: DefaultColors) => ({
-  50: '#111116',
-  100: '#1f202b',
-  200: '#2d2f3f',
-  300: '#3a3c4c',
+  50: '#0d1117',
+  100: '#161b22',
+  200: '#21262d',
+  300: '#30363d',
 });
 
 const themeLight = (colors: DefaultColors) => ({
   50: '#ffffff',
-  100: '#f1f5f9',
-  200: '#c4c7c5',
-  300: '#9ca3af',
+  100: '#f6f8fa',
+  200: '#d0d7de',
+  300: '#afb8c1',
 });
 
 const config: Config = {
@@ -49,6 +49,6 @@ const config: Config = {
       },
     },
   },
-  plugins: [require('@tailwindcss/typography')],
+  plugins: [require('@tailwindcss/typography'), require('@headlessui/tailwindcss')({ prefix: 'headless' })],
 };
 export default config;

yarn.lock

@@ -407,6 +407,11 @@
     "@react-aria/interactions" "^3.21.3"
     "@tanstack/react-virtual" "^3.8.1"
 
+"@headlessui/tailwindcss@^0.2.2":
+  version "0.2.2"
+  resolved "https://registry.yarnpkg.com/@headlessui/tailwindcss/-/tailwindcss-0.2.2.tgz#8ebde73fabca72d48636ea56ae790209dc5f0d49"
+  integrity sha512-xNe42KjdyA4kfUKLLPGzME9zkH7Q3rOZ5huFihWNWOQFxnItxPB3/67yBI8/qBfY8nwBRx5GHn4VprsoluVMGw==
+
 "@huggingface/jinja@^0.2.2":
   version "0.2.2"
   resolved "https://registry.yarnpkg.com/@huggingface/jinja/-/jinja-0.2.2.tgz#faeb205a9d6995089bef52655ddd8245d3190627"