@lobehub/chat 0.161.3 → 0.161.4

package/CHANGELOG.md

@@ -2,6 +2,39 @@
 
 # Changelog
 
+### [Version 0.161.4](https://github.com/lobehub/lobe-chat/compare/v0.161.3...v0.161.4)
+
+<sup>Released on **2024-05-22**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor the app ENV.
+
+#### 🐛 Bug Fixes
+
+- **misc**: Fix market and plugin cache.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor the app ENV, closes [#2604](https://github.com/lobehub/lobe-chat/issues/2604) ([acc0fdc](https://github.com/lobehub/lobe-chat/commit/acc0fdc))
+
+#### What's fixed
+
+- **misc**: Fix market and plugin cache, closes [#2608](https://github.com/lobehub/lobe-chat/issues/2608) ([a3f161e](https://github.com/lobehub/lobe-chat/commit/a3f161e))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.161.3](https://github.com/lobehub/lobe-chat/compare/v0.161.2...v0.161.3)
 
 <sup>Released on **2024-05-22**</sup>

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.161.3",
+  "version": "0.161.4",
   "description": "Lobe Chat - an open-source, high-performance chatbot framework that supports speech synthesis, multimodal, and extensible Function Call plugin system. Supports one-click free deployment of your private ChatGPT/LLM web application.",
   "keywords": [
     "framework",

package/src/app/api/chat/apiKeyManager.test.ts

@@ -2,8 +2,6 @@
 import { nanoid } from 'nanoid';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import { getServerConfig } from '@/config/server';
-
 import { ApiKeyManager } from './apiKeyManager';
 
 function generateKeys(count: number = 1) {

package/src/app/api/market/AgentMarket.test.ts

@@ -1,3 +1,4 @@
+// @vitest-environment node
 import { describe, expect, it } from 'vitest';
 
 import { AgentMarket } from './AgentMarket';

package/src/app/api/market/AgentMarket.ts

@@ -1,6 +1,6 @@
 import urlJoin from 'url-join';
 
-import { getServerConfig } from '@/config/server';
+import { appEnv } from '@/config/app';
 import { DEFAULT_LANG, isLocaleNotSupport } from '@/const/locale';
 import { Locales, normalizeLocale } from '@/locales/resources';
 
@@ -8,7 +8,7 @@ export class AgentMarket {
   private readonly baseUrl: string;
 
   constructor(baseUrl?: string) {
-    this.baseUrl = baseUrl || getServerConfig().AGENTS_INDEX_URL;
+    this.baseUrl = baseUrl || appEnv.AGENTS_INDEX_URL;
   }
 
   getAgentIndexUrl = (lang: Locales = DEFAULT_LANG) => {

package/src/app/api/market/route.ts

@@ -4,6 +4,8 @@ import { AgentMarket } from './AgentMarket';
 
 export const runtime = 'edge';
 
+export const revalidate = 3600; // revalidate at almost every hour
+
 export const GET = async (req: Request) => {
   const locale = new URL(req.url).searchParams.get('locale');
 

package/src/app/api/middleware/auth/utils.ts

@@ -1,7 +1,7 @@
 import { type AuthObject } from '@clerk/backend/internal';
 import { importJWK, jwtVerify } from 'jose';
 
-import { getServerConfig } from '@/config/server';
+import { getAppConfig } from '@/config/app';
 import {
   JWTPayload,
   JWT_SECRET_KEY,
@@ -71,7 +71,7 @@ export const checkAuthMethod = ({
   // if apiKey exist
   if (apiKey) return;
 
-  const { ACCESS_CODES } = getServerConfig();
+  const { ACCESS_CODES } = getAppConfig();
 
   // if accessCode doesn't exist
   if (!ACCESS_CODES.length) return;

package/src/app/api/openai/createBizOpenAI/auth.test.ts

@@ -1,3 +1,4 @@
+// @vitest-environment node
 import { checkAuth } from './auth';
 
 describe('ACCESS_CODE', () => {

package/src/app/api/openai/createBizOpenAI/auth.ts

@@ -1,4 +1,4 @@
-import { getServerConfig } from '@/config/server';
+import { getAppConfig } from '@/config/app';
 import { ChatErrorType } from '@/types/fetch';
 
 interface AuthConfig {
@@ -13,7 +13,7 @@ export const checkAuth = ({ apiKey, accessCode, oauthAuthorized }: AuthConfig) =
     return { auth: true };
   }
 
-  const { ACCESS_CODES } = getServerConfig();
+  const { ACCESS_CODES } = getAppConfig();
 
   // if apiKey exist
   if (apiKey) {

package/src/app/api/plugin/gateway/route.ts

@@ -3,7 +3,7 @@ import { createGatewayOnEdgeRuntime } from '@lobehub/chat-plugins-gateway';
 
 import { createErrorResponse } from '@/app/api/errorResponse';
 import { getJWTPayload } from '@/app/api/middleware/auth/utils';
-import { getServerConfig } from '@/config/server';
+import { getAppConfig } from '@/config/app';
 import { LOBE_CHAT_AUTH_HEADER, OAUTH_AUTHORIZED, enableNextAuth } from '@/const/auth';
 import { LOBE_CHAT_TRACE_ID, TraceNameMap } from '@/const/trace';
 import { AgentRuntimeError } from '@/libs/agent-runtime';
@@ -14,7 +14,7 @@ import { getTracePayload } from '@/utils/trace';
 import { parserPluginSettings } from './settings';
 
 const checkAuth = (accessCode: string | null, oauthAuthorized: boolean | null) => {
-  const { ACCESS_CODES, PLUGIN_SETTINGS } = getServerConfig();
+  const { ACCESS_CODES, PLUGIN_SETTINGS } = getAppConfig();
 
   // if there is no plugin settings, just skip the auth
   if (!PLUGIN_SETTINGS) return { auth: true };
@@ -32,7 +32,7 @@ const checkAuth = (accessCode: string | null, oauthAuthorized: boolean | null) =
   return { auth: true };
 };
 
-const { PLUGINS_INDEX_URL: pluginsIndexUrl, PLUGIN_SETTINGS } = getServerConfig();
+const { PLUGINS_INDEX_URL: pluginsIndexUrl, PLUGIN_SETTINGS } = getAppConfig();
 
 const defaultPluginSettings = parserPluginSettings(PLUGIN_SETTINGS);
 

package/src/app/api/plugin/store/Store.test.ts

@@ -1,7 +1,6 @@
+// @vitest-environment node
 import { describe, expect, it, vi } from 'vitest';
 
-import { isLocaleNotSupport } from '@/const/locale';
-
 import { PluginStore } from './Store';
 
 const baseURL = 'https://chat-plugins.lobehub.com';

package/src/app/api/plugin/store/Store.ts

@@ -1,6 +1,6 @@
 import urlJoin from 'url-join';
 
-import { getServerConfig } from '@/config/server';
+import { appEnv } from '@/config/app';
 import { DEFAULT_LANG, isLocaleNotSupport } from '@/const/locale';
 import { Locales, normalizeLocale } from '@/locales/resources';
 
@@ -8,7 +8,7 @@ export class PluginStore {
   private readonly baseUrl: string;
 
   constructor(baseUrl?: string) {
-    this.baseUrl = baseUrl || getServerConfig().PLUGINS_INDEX_URL;
+    this.baseUrl = baseUrl || appEnv.PLUGINS_INDEX_URL;
   }
 
   getPluginIndexUrl = (lang: Locales = DEFAULT_LANG) => {

package/src/app/api/plugin/store/route.ts

@@ -4,6 +4,8 @@ import { PluginStore } from './Store';
 
 export const runtime = 'edge';
 
+export const revalidate = 43_200; // revalidate at almost every 12 hours
+
 export const GET = async (req: Request) => {
   const locale = new URL(req.url).searchParams.get('locale');
 
@@ -11,7 +13,7 @@ export const GET = async (req: Request) => {
 
   let res: Response;
 
-  res = await fetch(pluginStore.getPluginIndexUrl(locale as any), { next: { revalidate: 3600 } });
+  res = await fetch(pluginStore.getPluginIndexUrl(locale as any));
 
   if (res.status === 404) {
     res = await fetch(pluginStore.getPluginIndexUrl(DEFAULT_LANG));

package/src/app/metadata.ts

@@ -1,14 +1,13 @@
 import { Metadata } from 'next';
 
-import { getClientConfig } from '@/config/client';
-import { getServerConfig } from '@/config/server';
+import { appEnv, getAppConfig } from '@/config/app';
 import { OFFICIAL_URL } from '@/const/url';
 import { translation } from '@/server/translation';
 
 const title = 'LobeChat';
 
-const { SITE_URL = OFFICIAL_URL } = getServerConfig();
-const { BASE_PATH } = getClientConfig();
+const { SITE_URL = OFFICIAL_URL } = getAppConfig();
+const BASE_PATH = appEnv.NEXT_PUBLIC_BASE_PATH;
 
 // if there is a base path, then we don't need the manifest
 const noManifest = !!BASE_PATH;

package/src/components/Error/sentryCaptureException.ts

@@ -1,11 +1,9 @@
-import { getClientConfig } from '@/config/client';
-
-const { ENABLE_SENTRY } = getClientConfig();
+import { appEnv } from '@/config/app';
 
 export type ErrorType = Error & { digest?: string };
 
 export const sentryCaptureException = async (error: Error & { digest?: string }) => {
-  if (!ENABLE_SENTRY) return;
+  if (!appEnv.NEXT_PUBLIC_ENABLE_SENTRY) return;
   const { captureException } = await import('@sentry/nextjs');
   return captureException(error);
 };

package/src/config/__tests__/{server.test.ts → app.test.ts}

@@ -1,6 +1,7 @@
+// @vitest-environment node
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
-import { getServerConfig } from '../server';
+import { getAppConfig } from '../app';
 
 // Stub the global process object to safely mock environment variables
 vi.stubGlobal('process', {
@@ -14,28 +15,15 @@ describe('getServerConfig', () => {
     vi.restoreAllMocks();
   });
 
-  it('throws an error if process is undefined', () => {
-    const originalProcess = global.process;
-    // To simulate the error condition, temporarily set the global process to `undefined`,
-    // @ts-ignore
-    global.process = undefined;
-
-    expect(() => getServerConfig()).toThrow(
-      '[Server Config] you are importing a server-only module outside of server',
-    );
-
-    global.process = originalProcess; // Restore the original process object
-  });
-
   // it('correctly handles values for OPENAI_FUNCTION_REGIONS', () => {
   //   process.env.OPENAI_FUNCTION_REGIONS = 'iad1,sfo1';
-  //   const config = getServerConfig();
+  //   const config = getAppConfig();
   //   expect(config.OPENAI_FUNCTION_REGIONS).toStrictEqual(['iad1', 'sfo1']);
   // });
 
   describe('index url', () => {
     it('should return default URLs when no environment variables are set', () => {
-      const config = getServerConfig();
+      const config = getAppConfig();
       expect(config.AGENTS_INDEX_URL).toBe('https://chat-agents.lobehub.com');
       expect(config.PLUGINS_INDEX_URL).toBe('https://chat-plugins.lobehub.com');
     });
@@ -43,7 +31,7 @@ describe('getServerConfig', () => {
     it('should return custom URLs when environment variables are set', () => {
       process.env.AGENTS_INDEX_URL = 'https://custom-agents-url.com';
       process.env.PLUGINS_INDEX_URL = 'https://custom-plugins-url.com';
-      const config = getServerConfig();
+      const config = getAppConfig();
       expect(config.AGENTS_INDEX_URL).toBe('https://custom-agents-url.com');
       expect(config.PLUGINS_INDEX_URL).toBe('https://custom-plugins-url.com');
     });
@@ -52,7 +40,7 @@ describe('getServerConfig', () => {
       process.env.AGENTS_INDEX_URL = '';
       process.env.PLUGINS_INDEX_URL = '';
 
-      const config = getServerConfig();
+      const config = getAppConfig();
       expect(config.AGENTS_INDEX_URL).toBe('https://chat-agents.lobehub.com');
       expect(config.PLUGINS_INDEX_URL).toBe('https://chat-plugins.lobehub.com');
     });

package/src/config/app.ts

@@ -0,0 +1,58 @@
+/* eslint-disable sort-keys-fix/sort-keys-fix */
+import { createEnv } from '@t3-oss/env-nextjs';
+import { z } from 'zod';
+
+declare global {
+  // eslint-disable-next-line @typescript-eslint/no-namespace
+  namespace NodeJS {
+    interface ProcessEnv {
+      ACCESS_CODE?: string;
+    }
+  }
+}
+
+export const getAppConfig = () => {
+  const ACCESS_CODES = process.env.ACCESS_CODE?.split(',').filter(Boolean) || [];
+
+  return createEnv({
+    client: {
+      NEXT_PUBLIC_BASE_PATH: z.string(),
+      NEXT_PUBLIC_ENABLE_SENTRY: z.boolean(),
+    },
+    server: {
+      ACCESS_CODES: z.any(z.string()).optional(),
+
+      AGENTS_INDEX_URL: z.string().url(),
+
+      DEFAULT_AGENT_CONFIG: z.string(),
+
+      PLUGINS_INDEX_URL: z.string().url(),
+      PLUGIN_SETTINGS: z.string().optional(),
+
+      SITE_URL: z.string().optional(),
+    },
+    runtimeEnv: {
+      NEXT_PUBLIC_BASE_PATH: process.env.NEXT_PUBLIC_BASE_PATH || '',
+
+      // Sentry
+      NEXT_PUBLIC_ENABLE_SENTRY: !!process.env.NEXT_PUBLIC_SENTRY_DSN,
+
+      ACCESS_CODES: ACCESS_CODES as any,
+
+      AGENTS_INDEX_URL: !!process.env.AGENTS_INDEX_URL
+        ? process.env.AGENTS_INDEX_URL
+        : 'https://chat-agents.lobehub.com',
+
+      DEFAULT_AGENT_CONFIG: process.env.DEFAULT_AGENT_CONFIG || '',
+
+      PLUGINS_INDEX_URL: !!process.env.PLUGINS_INDEX_URL
+        ? process.env.PLUGINS_INDEX_URL
+        : 'https://chat-plugins.lobehub.com',
+
+      PLUGIN_SETTINGS: process.env.PLUGIN_SETTINGS,
+      SITE_URL: process.env.SITE_URL,
+    },
+  });
+};
+
+export const appEnv = getAppConfig();

package/src/config/client.ts

@@ -22,11 +22,6 @@ declare global {
 export const getClientConfig = () => ({
   ENABLED_SERVER_SERVICE: process.env.NEXT_PUBLIC_SERVICE_MODE === 'server',
 
-  BASE_PATH: process.env.NEXT_PUBLIC_BASE_PATH || '',
-
-  // Sentry
-  ENABLE_SENTRY: !!process.env.NEXT_PUBLIC_SENTRY_DSN,
-
   // i18n debug mode
   I18N_DEBUG: process.env.NEXT_PUBLIC_I18N_DEBUG === '1',
   I18N_DEBUG_BROWSER: process.env.NEXT_PUBLIC_I18N_DEBUG_BROWSER === '1',

package/src/libs/trpc/middleware/password.test.ts

@@ -1,8 +1,9 @@
+// @vitest-environment node
 import { TRPCError } from '@trpc/server';
 import { beforeEach, describe, expect, it, vi } from 'vitest';
 
 import * as utils from '@/app/api/middleware/auth/utils';
-import * as serverConfig from '@/config/server';
+import * as appConfig from '@/config/app';
 import { createCallerFactory } from '@/libs/trpc';
 import { trpc } from '@/libs/trpc/init';
 import { AuthContext, createContextInner } from '@/server/context';
@@ -32,7 +33,7 @@ describe('passwordChecker middleware', () => {
   });
 
   it('should throw UNAUTHORIZED error if access code is not correct', async () => {
-    vi.spyOn(serverConfig, 'getServerConfig').mockReturnValue({
+    vi.spyOn(appConfig, 'getAppConfig').mockReturnValue({
       ACCESS_CODES: ['123'],
     } as any);
     vi.spyOn(utils, 'getJWTPayload').mockResolvedValue({ accessCode: '456' });
@@ -45,7 +46,7 @@ describe('passwordChecker middleware', () => {
 
   it('should call next with jwtPayload in context if access code is correct', async () => {
     const jwtPayload = { accessCode: '123' };
-    vi.spyOn(serverConfig, 'getServerConfig').mockReturnValue({
+    vi.spyOn(appConfig, 'getAppConfig').mockReturnValue({
       ACCESS_CODES: ['123'],
     } as any);
     vi.spyOn(utils, 'getJWTPayload').mockResolvedValue(jwtPayload);
@@ -60,7 +61,7 @@ describe('passwordChecker middleware', () => {
 
   it('should call next with jwtPayload in context if no access codes are set', async () => {
     const jwtPayload = {};
-    vi.spyOn(serverConfig, 'getServerConfig').mockReturnValue({
+    vi.spyOn(appConfig, 'getAppConfig').mockReturnValue({
       ACCESS_CODES: [],
     } as any);
     vi.spyOn(utils, 'getJWTPayload').mockResolvedValue(jwtPayload);
@@ -74,7 +75,7 @@ describe('passwordChecker middleware', () => {
   });
   it('should call next with jwtPayload in context if  access codes is undefined', async () => {
     const jwtPayload = {};
-    vi.spyOn(serverConfig, 'getServerConfig').mockReturnValue({} as any);
+    vi.spyOn(appConfig, 'getAppConfig').mockReturnValue({} as any);
     vi.spyOn(utils, 'getJWTPayload').mockResolvedValue(jwtPayload);
 
     ctx = await createContextInner({ authorizationHeader: 'Bearer token' });

package/src/libs/trpc/middleware/password.ts

@@ -1,11 +1,11 @@
 import { TRPCError } from '@trpc/server';
 
 import { getJWTPayload } from '@/app/api/middleware/auth/utils';
-import { getServerConfig } from '@/config/server';
+import { getAppConfig } from '@/config/app';
 import { trpc } from '@/libs/trpc/init';
 
 export const passwordChecker = trpc.middleware(async (opts) => {
-  const { ACCESS_CODES } = getServerConfig();
+  const { ACCESS_CODES } = getAppConfig();
 
   const { ctx } = opts;
 

package/src/server/globalConfig/index.ts

@@ -1,3 +1,4 @@
+import { getAppConfig } from '@/config/app';
 import { fileEnv } from '@/config/file';
 import { langfuseEnv } from '@/config/langfuse';
 import { getLLMConfig } from '@/config/llm';
@@ -7,7 +8,6 @@ import {
   OpenRouterProviderCard,
   TogetherAIProviderCard,
 } from '@/config/modelProviders';
-import { getServerConfig } from '@/config/server';
 import { enableNextAuth } from '@/const/auth';
 import { GlobalServerConfig } from '@/types/serverConfig';
 import { extractEnabledModels, transformToChatModelCards } from '@/utils/parseModels';
@@ -15,7 +15,7 @@ import { extractEnabledModels, transformToChatModelCards } from '@/utils/parseMo
 import { parseAgentConfig } from './parseDefaultAgent';
 
 export const getServerGlobalConfig = () => {
-  const { ACCESS_CODES, DEFAULT_AGENT_CONFIG } = getServerConfig();
+  const { ACCESS_CODES, DEFAULT_AGENT_CONFIG } = getAppConfig();
 
   const {
     ENABLED_OPENAI,
@@ -123,7 +123,7 @@ export const getServerGlobalConfig = () => {
 };
 
 export const getServerDefaultAgentConfig = () => {
-  const { DEFAULT_AGENT_CONFIG } = getServerConfig();
+  const { DEFAULT_AGENT_CONFIG } = getAppConfig();
 
   return parseAgentConfig(DEFAULT_AGENT_CONFIG) || {};
 };

package/src/server/ld.ts

@@ -1,11 +1,11 @@
 import urlJoin from 'url-join';
 
-import { getServerConfig } from '@/config/server';
+import { getAppConfig } from '@/config/app';
 import { EMAIL_BUSINESS, EMAIL_SUPPORT, OFFICIAL_SITE, OFFICIAL_URL, X } from '@/const/url';
 
 import pkg from '../../package.json';
 
-const { SITE_URL = OFFICIAL_URL } = getServerConfig();
+const { SITE_URL = OFFICIAL_URL } = getAppConfig();
 const LAST_MODIFIED = new Date().toISOString();
 export const AUTHOR_LIST = {
   arvinxx: {

package/src/utils/basePath.ts

@@ -1,3 +1,3 @@
-import { getClientConfig } from '@/config/client';
+import { appEnv } from '@/config/app';
 
-export const withBasePath = (path: string) => getClientConfig().BASE_PATH + path;
+export const withBasePath = (path: string) => appEnv.NEXT_PUBLIC_BASE_PATH + path;

package/src/config/server/app.ts

@@ -1,45 +0,0 @@
-/* eslint-disable sort-keys-fix/sort-keys-fix , typescript-sort-keys/interface */
-
-declare global {
-  // eslint-disable-next-line @typescript-eslint/no-namespace
-  namespace NodeJS {
-    interface ProcessEnv {
-      ACCESS_CODE?: string;
-
-      SITE_URL?: string;
-
-      AGENTS_INDEX_URL?: string;
-
-      PLUGINS_INDEX_URL?: string;
-      PLUGIN_SETTINGS?: string;
-
-      DEFAULT_AGENT_CONFIG?: string;
-    }
-  }
-}
-
-export const getAppConfig = () => {
-  if (typeof process === 'undefined') {
-    throw new Error('[Server Config] you are importing a server-only module outside of server');
-  }
-
-  const ACCESS_CODES = process.env.ACCESS_CODE?.split(',').filter(Boolean) || [];
-
-  return {
-    ACCESS_CODES,
-
-    DEFAULT_AGENT_CONFIG: process.env.DEFAULT_AGENT_CONFIG || '',
-
-    SITE_URL: process.env.SITE_URL,
-
-    AGENTS_INDEX_URL: !!process.env.AGENTS_INDEX_URL
-      ? process.env.AGENTS_INDEX_URL
-      : 'https://chat-agents.lobehub.com',
-
-    PLUGINS_INDEX_URL: !!process.env.PLUGINS_INDEX_URL
-      ? process.env.PLUGINS_INDEX_URL
-      : 'https://chat-plugins.lobehub.com',
-
-    PLUGIN_SETTINGS: process.env.PLUGIN_SETTINGS,
-  };
-};

package/src/config/server/index.ts

@@ -1,9 +0,0 @@
-import { getAppConfig } from './app';
-
-export const getServerConfig = () => {
-  if (typeof process === 'undefined') {
-    throw new Error('[Server Config] you are importing a server-only module outside of server');
-  }
-
-  return getAppConfig();
-};