@lobehub/chat 0.161.11 → 0.161.13

package/.github/ISSUE_TEMPLATE/1_bug_report.yml

@@ -3,10 +3,29 @@ description: 'Report an bug'
 title: '[Bug] '
 labels: ['🐛 Bug']
 body:
+  - type: dropdown
+    attributes:
+      label: '📦 Environment'
+      options:
+        - Unselected
+        - Official
+        - Official Preview
+        - Vercel / Zeabur / Sealos
+        - Docker
+        - Other
+    validations:
+      required: true
+  - type: input
+    attributes:
+      label: '📌 Version'
+    validations:
+      required: true
+  
   - type: dropdown
     attributes:
       label: '💻 Operating System'
       options:
+        - Unselected
         - Windows
         - macOS
         - Ubuntu
@@ -16,21 +35,11 @@ body:
         - Other
     validations:
       required: true
-  - type: dropdown
-    attributes:
-      label: '📦 Environment'
-      options:
-        - Official Preview
-        - Vercel / Zeabur / Sealos
-        - Docker
-        - Other
-    validations:
-      required: true
-
   - type: dropdown
     attributes:
       label: '🌐 Browser'
       options:
+        - Unselected
         - Chrome
         - Edge
         - Safari
@@ -41,17 +50,17 @@ body:
   - type: textarea
     attributes:
       label: '🐛 Bug Description'
-      description: A clear and concise description of the bug.
+      description: A clear and concise description of the bug, if the above option is `Other`, please also explain in detail.
     validations:
       required: true
-  - type: textarea
-    attributes:
-      label: '🚦 Expected Behavior'
-      description: A clear and concise description of what you expected to happen.
   - type: textarea
     attributes:
       label: '📷 Recurrence Steps'
       description: A clear and concise description of how to recurrence.
+  - type: textarea
+    attributes:
+      label: '🚦 Expected Behavior'
+      description: A clear and concise description of what you expected to happen.
   - type: textarea
     attributes:
       label: '📝 Additional Information'

package/.github/ISSUE_TEMPLATE/1_bug_report_cn.yml

@@ -5,33 +5,41 @@ labels: ['🐛 Bug']
 body:
   - type: dropdown
     attributes:
-      label: '💻 系统环境'
+      label: '📦 部署环境'
       options:
-        - Windows
-        - macOS
-        - Ubuntu
-        - Other Linux
-        - iOS
-        - Android
+        - 待选择
+        - Official
+        - Official Preview
+        - Vercel / Zeabur / Sealos
+        - Docker
         - Other
     validations:
       required: true
+  - type: input
+    attributes:
+      label: '📌 软件版本'
+    validations:
+      required: true
 
   - type: dropdown
     attributes:
-      label: '📦 部署环境'
+      label: '💻 系统环境'
       options:
-        - Official Preview
-        - Vercel / Zeabur / Sealos
-        - Docker
+        - 待选择
+        - Windows
+        - macOS
+        - Ubuntu
+        - Other Linux
+        - iOS
+        - Android
         - Other
     validations:
       required: true
-
   - type: dropdown
     attributes:
       label: '🌐 浏览器'
       options:
+        - 待选择
         - Chrome
         - Edge
         - Safari
@@ -42,17 +50,17 @@ body:
   - type: textarea
     attributes:
       label: '🐛 问题描述'
-      description: 请提供一个清晰且简洁的问题描述。
+      description: 请提供一个清晰且简洁的问题描述，若上述选项为`Other`，也请详细说明。
     validations:
       required: true
-  - type: textarea
-    attributes:
-      label: '🚦 期望结果'
-      description: 请提供一个清晰且简洁的描述，说明您期望发生什么。
   - type: textarea
     attributes:
       label: '📷 复现步骤'
       description: 请提供一个清晰且简洁的描述，说明如何复现问题。
+  - type: textarea
+    attributes:
+      label: '🚦 期望结果'
+      description: 请提供一个清晰且简洁的描述，说明您期望发生什么。
   - type: textarea
     attributes:
       label: '📝 补充信息'

package/CHANGELOG.md

@@ -2,6 +2,48 @@
 
 # Changelog
 
+### [Version 0.161.13](https://github.com/lobehub/lobe-chat/compare/v0.161.12...v0.161.13)
+
+<sup>Released on **2024-05-24**</sup>
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
+### [Version 0.161.12](https://github.com/lobehub/lobe-chat/compare/v0.161.11...v0.161.12)
+
+<sup>Released on **2024-05-23**</sup>
+
+#### ♻ Code Refactoring
+
+- **misc**: Refactor the home redirect implement.
+
+<br/>
+
+<details>
+<summary><kbd>Improvements and Fixes</kbd></summary>
+
+#### Code refactoring
+
+- **misc**: Refactor the home redirect implement, closes [#2626](https://github.com/lobehub/lobe-chat/issues/2626) ([ab4216e](https://github.com/lobehub/lobe-chat/commit/ab4216e))
+
+</details>
+
+<div align="right">
+
+[![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top)
+
+</div>
+
 ### [Version 0.161.11](https://github.com/lobehub/lobe-chat/compare/v0.161.10...v0.161.11)
 
 <sup>Released on **2024-05-23**</sup>

package/docs/self-hosting/environment-variables/model-provider.mdx

@@ -15,6 +15,13 @@ When deploying LobeChat, a rich set of environment variables related to model se
 
 ## OpenAI
 
+### `ENABLED_OPENAI`
+
+- Type：Optional
+- Description：Enables OpenAI as a model provider by default, turns off the OpenAI service when set to `0`
+- Default：`1`
+- Example：`0`
+
 ### `OPENAI_API_KEY`
 
 - Type: Required
@@ -189,6 +196,13 @@ If you need to use Azure OpenAI to provide model services, you can refer to the
 
 ## Ollama
 
+### `ENABLED_OLLAMA`
+
+- Type：Optional
+- Description：Enables Ollama as a model provider by default, turns off the Ollama service when set to `0`
+- Default：`1`
+- Example：`0`
+
 ### `OLLAMA_PROXY_URL`
 
 - Type: Required

package/docs/self-hosting/environment-variables/model-provider.zh-CN.mdx

@@ -15,6 +15,13 @@ LobeChat 在部署时提供了丰富的模型服务商相关的环境变量，
 
 ## OpenAI
 
+### `ENABLED_OPENAI`
+
+- 类型：可选
+- 描述：默认启用 OpenAI 作为模型供应商，当设为 0 时关闭 OpenAI 服务
+- 默认值：`1`
+- 示例：`0`
+
 ### `OPENAI_API_KEY`
 
 - 类型：必选
@@ -187,6 +194,13 @@ LobeChat 在部署时提供了丰富的模型服务商相关的环境变量，
 
 ## Ollama
 
+### `ENABLED_OLLAMA`
+
+- 类型：可选
+- 描述：默认启用 Ollama 作为模型供应商，当设为 0 时关闭 Ollama 服务
+- 默认值：`1`
+- 示例：`0`
+
 ### `OLLAMA_PROXY_URL`
 
 - 类型：必选

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lobehub/chat",
-  "version": "0.161.11",
+  "version": "0.161.13",
   "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",
@@ -158,6 +158,7 @@
     "remark": "^14.0.3",
     "remark-gfm": "^3.0.1",
     "remark-html": "^15.0.2",
+    "resolve-accept-language": "^3.1.4",
     "rtl-detect": "^1.1.2",
     "semver": "^7.6.2",
     "sharp": "^0.33.4",

package/src/app/(loading)/Redirect.tsx

@@ -3,35 +3,47 @@
 import { useRouter } from 'next/navigation';
 import { memo, useEffect } from 'react';
 
-import { messageService } from '@/services/message';
-import { sessionService } from '@/services/session';
 import { useUserStore } from '@/store/user';
 import { authSelectors } from '@/store/user/selectors';
 
-const checkHasConversation = async () => {
-  const hasMessages = await messageService.hasMessages();
-  const hasAgents = await sessionService.hasSessions();
-  return hasMessages || hasAgents;
-};
-
 const Redirect = memo(() => {
   const router = useRouter();
-  const isLogin = useUserStore(authSelectors.isLogin);
+  const [isLogin, isLoaded, isUserStateInit, isUserHasConversation, isOnboard] = useUserStore(
+    (s) => [
+      authSelectors.isLogin(s),
+      authSelectors.isLoaded(s),
+      s.isUserStateInit,
+      s.isUserHasConversation,
+      s.isOnboard,
+    ],
+  );
 
   useEffect(() => {
+    // if user auth state is not ready, wait for loading
+    if (!isLoaded) return;
+
+    // this mean user is definitely not login
     if (!isLogin) {
       router.replace('/welcome');
       return;
     }
 
-    checkHasConversation().then((hasData) => {
-      if (hasData) {
-        router.replace('/chat');
-      } else {
-        router.replace('/welcome');
-      }
-    });
-  }, []);
+    // if user state not init, wait for loading
+    if (!isUserStateInit) return;
+
+    // user need to onboard
+    if (!isOnboard) {
+      router.replace('/onboard');
+      return;
+    }
+
+    // finally check the conversation status
+    if (isUserHasConversation) {
+      router.replace('/chat');
+    } else {
+      router.replace('/welcome');
+    }
+  }, [isUserStateInit, isLoaded, isUserHasConversation, isOnboard, isLogin]);
 
   return null;
 });

package/src/layout/AuthProvider/NoAuth/index.tsx

@@ -0,0 +1,16 @@
+'use client';
+
+import { PropsWithChildren, memo } from 'react';
+import { createStoreUpdater } from 'zustand-utils';
+
+import { useUserStore } from '@/store/user';
+
+const NoAuthProvider = memo<PropsWithChildren>(({ children }) => {
+  const useStoreUpdater = createStoreUpdater(useUserStore);
+
+  useStoreUpdater('isLoaded', true);
+
+  return children;
+});
+
+export default NoAuthProvider;

package/src/layout/AuthProvider/index.tsx

@@ -4,13 +4,14 @@ import { authEnv } from '@/config/auth';
 
 import Clerk from './Clerk';
 import NextAuth from './NextAuth';
+import NoAuth from './NoAuth';
 
 const AuthProvider = ({ children }: PropsWithChildren) => {
   if (authEnv.NEXT_PUBLIC_ENABLE_CLERK_AUTH) return <Clerk>{children}</Clerk>;
 
   if (authEnv.NEXT_PUBLIC_ENABLE_NEXT_AUTH) return <NextAuth>{children}</NextAuth>;
 
-  return children;
+  return <NoAuth>{children}</NoAuth>;
 };
 
 export default AuthProvider;

package/src/layout/GlobalProvider/index.tsx

@@ -1,6 +1,7 @@
 import dynamic from 'next/dynamic';
-import { cookies } from 'next/headers';
-import { FC, ReactNode } from 'react';
+import { cookies, headers } from 'next/headers';
+import { FC, PropsWithChildren } from 'react';
+import { resolveAcceptLanguage } from 'resolve-accept-language';
 
 import { getDebugConfig } from '@/config/debug';
 import { getServerFeatureFlagsValue } from '@/config/featureFlags';
@@ -10,6 +11,7 @@ import {
   LOBE_THEME_NEUTRAL_COLOR,
   LOBE_THEME_PRIMARY_COLOR,
 } from '@/const/theme';
+import { locales } from '@/locales/resources';
 import { getServerGlobalConfig } from '@/server/globalConfig';
 import { ServerConfigStoreProvider } from '@/store/serverConfig';
 import { getAntdLocale } from '@/utils/locale';
@@ -31,11 +33,27 @@ if (process.env.NODE_ENV === 'development') {
   }
 }
 
-interface GlobalLayoutProps {
-  children: ReactNode;
-}
+const parserFallbackLang = () => {
+  /**
+   * The arguments are as follows:
+   *
+   * 1) The HTTP accept-language header.
+   * 2) The available locales (they must contain the default locale).
+   * 3) The default locale.
+   */
+  let fallbackLang: string = resolveAcceptLanguage(
+    headers().get('accept-language') || '',
+    //  Invalid locale identifier 'ar'. A valid locale should follow the BCP 47 'language-country' format.
+    locales.map((locale) => (locale === 'ar' ? 'ar-EG' : locale)),
+    'en-US',
+  );
+  // if match the ar-EG then fallback to ar
+  if (fallbackLang === 'ar-EG') fallbackLang = 'ar';
+
+  return fallbackLang;
+};
 
-const GlobalLayout = async ({ children }: GlobalLayoutProps) => {
+const GlobalLayout = async ({ children }: PropsWithChildren) => {
   // get default theme config to use with ssr
   const cookieStore = cookies();
   const appearance = cookieStore.get(LOBE_THEME_APPEARANCE);
@@ -44,7 +62,13 @@ const GlobalLayout = async ({ children }: GlobalLayoutProps) => {
 
   // get default locale config to use with ssr
   const defaultLang = cookieStore.get(LOBE_LOCALE_COOKIE);
-  const antdLocale = await getAntdLocale(defaultLang?.value);
+  const fallbackLang = parserFallbackLang();
+
+  // if it's a new user, there's no cookie
+  // So we need to use the fallback language parsed by accept-language
+  const userLocale = defaultLang?.value || fallbackLang;
+
+  const antdLocale = await getAntdLocale(userLocale);
 
   // get default feature flags to use with ssr
   const serverFeatureFlags = getServerFeatureFlagsValue();
@@ -52,7 +76,7 @@ const GlobalLayout = async ({ children }: GlobalLayoutProps) => {
   const isMobile = isMobileDevice();
   return (
     <StyleRegistry>
-      <Locale antdLocale={antdLocale} defaultLang={defaultLang?.value}>
+      <Locale antdLocale={antdLocale} defaultLang={userLocale}>
         <AppTheme
           defaultAppearance={appearance?.value}
           defaultNeutralColor={neutralColor?.value as any}

package/src/middleware.ts

@@ -41,16 +41,7 @@ const nextAuthMiddleware = auth((req) => {
 });
 
 export default authEnv.NEXT_PUBLIC_ENABLE_CLERK_AUTH
-  ? // can't lift to a function because if there is no clerk public key, it will throw error
-    clerkMiddleware((auth, request) => {
-      // if user is logged in and on the home page, redirect to chat
-      if (auth().userId && request.nextUrl.pathname === '/') {
-        request.nextUrl.pathname = '/chat';
-        return NextResponse.redirect(request.nextUrl);
-      }
-
-      return NextResponse.next();
-    })
+  ? clerkMiddleware()
   : authEnv.NEXT_PUBLIC_ENABLE_NEXT_AUTH
     ? nextAuthMiddleware
     : defaultMiddleware;

package/src/services/user/client.test.ts

@@ -46,6 +46,8 @@ describe('ClientService', () => {
     expect(userState).toEqual({
       avatar: mockUser.avatar,
       isOnboard: true,
+      canEnablePWAGuide: false,
+      hasConversation: false,
       canEnableTrace: false,
       preference: mockPreference,
       settings: mockUser.settings,

package/src/services/user/client.ts

@@ -1,6 +1,7 @@
 import { DeepPartial } from 'utility-types';
 
 import { MessageModel } from '@/database/client/models/message';
+import { SessionModel } from '@/database/client/models/session';
 import { UserModel } from '@/database/client/models/user';
 import { GlobalSettings } from '@/types/settings';
 import { UserInitializationState, UserPreference } from '@/types/user';
@@ -18,10 +19,13 @@ export class ClientService implements IUserService {
   async getUserState(): Promise<UserInitializationState> {
     const user = await UserModel.getUser();
     const messageCount = await MessageModel.count();
+    const sessionCount = await SessionModel.count();
 
     return {
       avatar: user.avatar,
+      canEnablePWAGuide: messageCount >= 2,
       canEnableTrace: messageCount >= 4,
+      hasConversation: messageCount > 0 || sessionCount > 0,
       isOnboard: true,
       preference: await this.preferenceStorage.getFromLocalStorage(),
       settings: user.settings as GlobalSettings,

package/src/services/user/type.ts

@@ -6,7 +6,6 @@ import { UserInitializationState, UserPreference } from '@/types/user';
 export interface IUserService {
   getUserState: () => Promise<UserInitializationState>;
   resetUserSettings: () => Promise<any>;
-  updateAvatar: (avatar: string) => Promise<any>;
   updatePreference: (preference: UserPreference) => Promise<any>;
   updateUserSettings: (patch: DeepPartial<GlobalSettings>) => Promise<any>;
 }

package/src/store/user/slices/auth/selectors.ts

@@ -41,6 +41,7 @@ const isLogin = (s: UserStore) => {
 };
 
 export const authSelectors = {
+  isLoaded: (s: UserStore) => s.isLoaded,
   isLogin,
   isLoginWithAuth: (s: UserStore) => s.isSignedIn,
   isLoginWithClerk: (s: UserStore): boolean => (s.isSignedIn && enableClerk) || false,

package/src/store/user/slices/common/action.test.ts

@@ -5,6 +5,7 @@ import { withSWR } from '~test-utils';
 
 import { DEFAULT_PREFERENCE } from '@/const/user';
 import { userService } from '@/services/user';
+import { ClientService } from '@/services/user/client';
 import { useUserStore } from '@/store/user';
 import { preferenceSelectors } from '@/store/user/selectors';
 import { GlobalServerConfig } from '@/types/serverConfig';
@@ -36,7 +37,7 @@ describe('createCommonSlice', () => {
       const avatar = 'new-avatar';
 
       const spyOn = vi.spyOn(result.current, 'refreshUserState');
-      const updateAvatarSpy = vi.spyOn(userService, 'updateAvatar');
+      const updateAvatarSpy = vi.spyOn(ClientService.prototype, 'updateAvatar');
 
       await act(async () => {
         await result.current.updateAvatar(avatar);

package/src/store/user/slices/common/action.ts

@@ -4,6 +4,7 @@ import type { StateCreator } from 'zustand/vanilla';
 
 import { DEFAULT_PREFERENCE } from '@/const/user';
 import { userService } from '@/services/user';
+import { ClientService } from '@/services/user/client';
 import type { UserStore } from '@/store/user';
 import type { GlobalServerConfig } from '@/types/serverConfig';
 import type { GlobalSettings } from '@/types/settings';
@@ -45,7 +46,9 @@ export const createCommonSlice: StateCreator<
     await mutate(GET_USER_STATE_KEY);
   },
   updateAvatar: async (avatar) => {
-    await userService.updateAvatar(avatar);
+    const clientService = new ClientService();
+
+    await clientService.updateAvatar(avatar);
     await get().refreshUserState();
   },
 
@@ -89,8 +92,12 @@ export const createCommonSlice: StateCreator<
               {
                 defaultSettings,
                 enabledNextAuth: serverConfig.enabledOAuthSSO,
+                isOnboard: data.isOnboard,
+                isShowPWAGuide: data.canEnablePWAGuide,
                 isUserCanEnableTrace: data.canEnableTrace,
+                isUserHasConversation: data.hasConversation,
                 isUserStateInit: true,
+
                 preference,
                 serverLanguageModel: serverConfig.languageModel,
                 settings: data.settings || {},

package/src/store/user/slices/common/initialState.ts

@@ -1,9 +1,15 @@
 export interface CommonState {
+  isOnboard: boolean;
+  isShowPWAGuide: boolean;
   isUserCanEnableTrace: boolean;
+  isUserHasConversation: boolean;
   isUserStateInit: boolean;
 }
 
 export const initialCommonState: CommonState = {
+  isOnboard: false,
+  isShowPWAGuide: false,
   isUserCanEnableTrace: false,
+  isUserHasConversation: false,
   isUserStateInit: false,
 };

package/src/types/user/index.ts

@@ -34,7 +34,9 @@ export interface UserPreference {
 
 export interface UserInitializationState {
   avatar?: string;
+  canEnablePWAGuide?: boolean;
   canEnableTrace?: boolean;
+  hasConversation?: boolean;
   isOnboard?: boolean;
   preference: UserPreference;
   settings: DeepPartial<GlobalSettings>;