@lobehub/chat 1.39.2 → 1.40.0

package/src/features/User/UserPanel/useMenu.tsx

@@ -7,6 +7,7 @@ import {
   Cloudy,
   Download,
   Feather,
+  FileClockIcon,
   HardDriveDownload,
   HardDriveUpload,
   LifeBuoy,
@@ -174,15 +175,38 @@ export const useMenu = () => {
         },
       ].filter(Boolean) as ItemType[]);
 
-  const helps: MenuProps['items'] = hideDocs
-    ? []
-    : ([
-        showCloudPromotion && {
-          icon: <Icon icon={Cloudy} />,
-          key: 'cloud',
+  const helps: MenuProps['items'] = [
+    showCloudPromotion && {
+      icon: <Icon icon={Cloudy} />,
+      key: 'cloud',
+      label: (
+        <Link href={`${OFFICIAL_URL}?utm_source=${UTM_SOURCE}`} target={'_blank'}>
+          {t('userPanel.cloud', { name: LOBE_CHAT_CLOUD })}
+        </Link>
+      ),
+    },
+    {
+      icon: <Icon icon={FileClockIcon} />,
+      key: 'changelog',
+      label: <Link href={'/changelog'}>{t('changelog')}</Link>,
+    },
+    {
+      children: [
+        {
+          icon: <Icon icon={Book} />,
+          key: 'docs',
           label: (
-            <Link href={`${OFFICIAL_URL}?utm_source=${UTM_SOURCE}`} target={'_blank'}>
-              {t('userPanel.cloud', { name: LOBE_CHAT_CLOUD })}
+            <Link href={DOCUMENTS_REFER_URL} target={'_blank'}>
+              {t('userPanel.docs')}
+            </Link>
+          ),
+        },
+        {
+          icon: <Icon icon={Feather} />,
+          key: 'feedback',
+          label: (
+            <Link href={GITHUB_ISSUES} target={'_blank'}>
+              {t('userPanel.feedback')}
             </Link>
           ),
         },
@@ -196,56 +220,36 @@ export const useMenu = () => {
           ),
         },
         {
-          children: [
-            {
-              icon: <Icon icon={Book} />,
-              key: 'docs',
-              label: (
-                <Link href={DOCUMENTS_REFER_URL} target={'_blank'}>
-                  {t('userPanel.docs')}
-                </Link>
-              ),
-            },
-            {
-              icon: <Icon icon={Feather} />,
-              key: 'feedback',
-              label: (
-                <Link href={GITHUB_ISSUES} target={'_blank'}>
-                  {t('userPanel.feedback')}
-                </Link>
-              ),
-            },
-            {
-              icon: <Icon icon={Mail} />,
-              key: 'email',
-              label: (
-                <Link href={mailTo(EMAIL_SUPPORT)} target={'_blank'}>
-                  {t('userPanel.email')}
-                </Link>
-              ),
-            },
-          ],
-          icon: <Icon icon={LifeBuoy} />,
-          key: 'help',
-          label: t('userPanel.help'),
-        },
-        {
-          type: 'divider',
+          icon: <Icon icon={Mail} />,
+          key: 'email',
+          label: (
+            <Link href={mailTo(EMAIL_SUPPORT)} target={'_blank'}>
+              {t('userPanel.email')}
+            </Link>
+          ),
         },
-      ].filter(Boolean) as ItemType[]);
+      ],
+      icon: <Icon icon={LifeBuoy} />,
+      key: 'help',
+      label: t('userPanel.help'),
+    },
+    {
+      type: 'divider',
+    },
+  ].filter(Boolean) as ItemType[];
 
   const mainItems = [
     {
       type: 'divider',
     },
-    ...(isLogin ? settings : []),
     ...(isLoginWithClerk ? profile : []),
+    ...(isLogin ? settings : []),
     /* ↓ cloud slot ↓ */
 
     /* ↑ cloud slot ↑ */
     ...(canInstall ? pwa : []),
     ...data,
-    ...helps,
+    ...(!hideDocs ? helps : []),
   ].filter(Boolean) as MenuProps['items'];
 
   const logoutItems: MenuProps['items'] = isLoginWithAuth

package/src/features/User/__tests__/useMenu.test.tsx

@@ -1,13 +1,14 @@
 import { act, renderHook } from '@testing-library/react';
 import { describe, expect, it, vi } from 'vitest';
 
-import { useUserStore } from '@/store/user';
 import { ServerConfigStoreProvider } from '@/store/serverConfig';
+import { useUserStore } from '@/store/user';
 
 import { useMenu } from '../UserPanel/useMenu';
 
-const wrapper: React.JSXElementConstructor<{ children: React.ReactNode }> = ({ children }) =>
+const wrapper: React.JSXElementConstructor<{ children: React.ReactNode }> = ({ children }) => (
   <ServerConfigStoreProvider>{children}</ServerConfigStoreProvider>
+);
 
 // Mock dependencies
 vi.mock('next/link', () => ({
@@ -81,7 +82,7 @@ describe('useMenu', () => {
       expect(mainItems?.some((item) => item?.key === 'setting')).toBe(true);
       expect(mainItems?.some((item) => item?.key === 'import')).toBe(true);
       expect(mainItems?.some((item) => item?.key === 'export')).toBe(true);
-      expect(mainItems?.some((item) => item?.key === 'discord')).toBe(true);
+      expect(mainItems?.some((item) => item?.key === 'changelog')).toBe(true);
       expect(logoutItems.some((item) => item?.key === 'logout')).toBe(true);
     });
   });
@@ -101,7 +102,7 @@ describe('useMenu', () => {
       expect(mainItems?.some((item) => item?.key === 'setting')).toBe(true);
       expect(mainItems?.some((item) => item?.key === 'import')).toBe(true);
       expect(mainItems?.some((item) => item?.key === 'export')).toBe(true);
-      expect(mainItems?.some((item) => item?.key === 'discord')).toBe(true);
+      expect(mainItems?.some((item) => item?.key === 'changelog')).toBe(true);
       expect(logoutItems.some((item) => item?.key === 'logout')).toBe(true);
     });
   });
@@ -120,7 +121,7 @@ describe('useMenu', () => {
       expect(mainItems?.some((item) => item?.key === 'setting')).toBe(true);
       expect(mainItems?.some((item) => item?.key === 'import')).toBe(true);
       expect(mainItems?.some((item) => item?.key === 'export')).toBe(true);
-      expect(mainItems?.some((item) => item?.key === 'discord')).toBe(true);
+      expect(mainItems?.some((item) => item?.key === 'changelog')).toBe(true);
       expect(logoutItems.some((item) => item?.key === 'logout')).toBe(false);
     });
   });
@@ -139,7 +140,7 @@ describe('useMenu', () => {
       expect(mainItems?.some((item) => item?.key === 'setting')).toBe(false);
       expect(mainItems?.some((item) => item?.key === 'import')).toBe(false);
       expect(mainItems?.some((item) => item?.key === 'export')).toBe(false);
-      expect(mainItems?.some((item) => item?.key === 'discord')).toBe(true);
+      expect(mainItems?.some((item) => item?.key === 'changelog')).toBe(true);
       expect(logoutItems.some((item) => item?.key === 'logout')).toBe(false);
     });
   });

package/src/hooks/useInterceptingRoutes.ts

@@ -1,7 +1,6 @@
-import { useContext, useMemo } from 'react';
+import { useMemo } from 'react';
 import urlJoin from 'url-join';
 
-import { InterceptContext } from '@/app/@modal/features/InterceptingContext';
 import { INBOX_SESSION_ID } from '@/const/session';
 import { useIsMobile } from '@/hooks/useIsMobile';
 import { useQueryRoute } from '@/hooks/useQueryRoute';
@@ -45,7 +44,3 @@ export const useOpenChatSettings = (tab: ChatSettingsTabs = ChatSettingsTabs.Met
     }
   }, [openSettings, mobile, activeId, router, tab]);
 };
-
-export const useInterceptingRoutes = () => {
-  return useContext(InterceptContext);
-};

package/src/hooks/useShare.tsx

@@ -15,6 +15,7 @@ const stringifyHashtags = (hashtags: string[], joinfix: string = ',', prefix?: s
   if (prefix) hashtags = hashtags.map((tag) => prefix + camelCase(tag));
   return hashtags.filter(Boolean).join(joinfix);
 };
+
 export const useShare = ({
   url,
   title,

package/src/locales/default/changelog.ts

@@ -0,0 +1,18 @@
+export default {
+  actions: {
+    followOnX: '在 X 上关注我们',
+    subscribeToUpdates: '订阅更新',
+    versions: '版本详情',
+  },
+  addedWhileAway: '在您离开期间，我们带来了新的特性。',
+  allChangelog: '查看所有更新日志',
+  description: '持续追踪 {{appName}} 的新功能和改进',
+  pagination: {
+    older: '查看历史变更',
+    prev: '上一页',
+  },
+  readDetails: '阅读详情',
+  title: '更新日志',
+  versionDetails: '版本详情',
+  welcomeBack: '欢迎回来!',
+};

package/src/locales/default/common.ts

@@ -220,6 +220,7 @@ export default {
   pinOff: '取消置顶',
   privacy: '隐私政策',
   regenerate: '重新生成',
+  releaseNotes: '版本详情',
   rename: '重命名',
   reset: '重置',
   retry: '重试',

package/src/locales/default/index.ts

@@ -1,4 +1,5 @@
 import auth from './auth';
+import changelog from './changelog';
 import chat from './chat';
 import clerk from './clerk';
 import common from './common';
@@ -23,6 +24,7 @@ import welcome from './welcome';
 
 const resources = {
   auth,
+  changelog,
   chat,
   clerk,
   common,

package/src/locales/default/metadata.ts

@@ -1,4 +1,8 @@
 export default {
+  changelog: {
+    description: '持续追踪 {{appName}} 的新功能和改进',
+    title: '更新日志',
+  },
   chat: {
     description: '{{appName}} 带给你最好的 ChatGPT, Claude , Gemini, OLLaMA WebUI 使用体验',
     title: '{{appName}}：个人 AI 效能工具，给自己一个更聪明的大脑',

package/src/server/metadata.ts

@@ -18,8 +18,10 @@ export class Meta {
     tags,
     alternate,
     locale = DEFAULT_LANG,
+    canonical,
   }: {
     alternate?: boolean;
+    canonical?: string;
     description?: string;
     image?: string;
     locale?: Locales;
@@ -35,9 +37,9 @@ export class Meta {
     const siteTitle = title.includes(BRANDING_NAME) ? title : title + ` · ${BRANDING_NAME}`;
     return {
       alternates: {
-        canonical: getCanonicalUrl(
-          alternate ? qs.stringifyUrl({ query: { hl: locale }, url }) : url,
-        ),
+        canonical:
+          canonical ||
+          getCanonicalUrl(alternate ? qs.stringifyUrl({ query: { hl: locale }, url }) : url),
         languages: alternate ? this.genAlternateLocales(locale, url) : undefined,
       },
       description: formatedDescription,

package/src/server/routers/edge/appStatus.ts

@@ -0,0 +1,3 @@
+import { router } from '@/libs/trpc';
+
+export const appStatusRouter = router({});

package/src/server/routers/edge/index.ts

@@ -3,10 +3,12 @@
  */
 import { publicProcedure, router } from '@/libs/trpc';
 
+import { appStatusRouter } from './appStatus';
 import { configRouter } from './config';
 import { uploadRouter } from './upload';
 
 export const edgeRouter = router({
+  appStatus: appStatusRouter,
   config: configRouter,
   healthcheck: publicProcedure.query(() => "i'm live!"),
   upload: uploadRouter,

package/src/server/routers/lambda/agent.ts

@@ -101,7 +101,7 @@ export const agentRouter = router({
       if (!session) throw new Error('Session not found');
       const sessionId = session.id;
 
-      return await ctx.agentModel.findBySessionId(sessionId);
+      return ctx.agentModel.findBySessionId(sessionId);
     }),
 
   getKnowledgeBasesAndFiles: agentProcedure

package/src/server/services/changelog/index.test.ts

@@ -0,0 +1,310 @@
+// @vitest-environment node
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+
+import { ChangelogIndexItem } from '@/types/changelog';
+
+import { ChangelogService } from './index';
+
+// Mock external dependencies
+vi.mock('dayjs', () => ({
+  default: (date: string) => ({
+    format: vi.fn().mockReturnValue(date),
+  }),
+}));
+
+vi.mock('gray-matter', () => ({
+  default: vi.fn().mockImplementation((text) => ({
+    data: { date: '2023-01-01' },
+    content: text,
+  })),
+}));
+
+vi.mock('markdown-to-txt', () => ({
+  markdownToTxt: vi.fn().mockImplementation((text) => text),
+}));
+
+vi.mock('semver', async (importOriginal) => {
+  const actual: any = await importOriginal();
+  return {
+    ...actual,
+    rcompare: vi.fn().mockImplementation((a, b) => b.localeCompare(a)),
+    lt: vi.fn().mockImplementation((a, b) => a < b),
+    gt: vi.fn().mockImplementation((a, b) => a > b),
+    parse: vi.fn().mockImplementation((v) => ({ toString: () => v })),
+  };
+});
+
+vi.mock('url-join', () => ({
+  default: vi.fn((...args) => args.join('/')),
+}));
+
+// 模拟 process.env
+const originalEnv = process.env;
+
+beforeEach(() => {
+  vi.resetModules();
+  process.env = { ...originalEnv };
+});
+
+afterEach(() => {
+  process.env = originalEnv;
+});
+
+describe('ChangelogService', () => {
+  let service: ChangelogService;
+
+  beforeEach(() => {
+    service = new ChangelogService();
+    // Mock fetch globally
+    global.fetch = vi.fn();
+  });
+
+  describe('getLatestChangelogId', () => {
+    it('should return the id of the first changelog item', async () => {
+      const mockIndex = [{ id: 'latest' }, { id: 'older' }];
+      vi.spyOn(service, 'getChangelogIndex').mockResolvedValue(mockIndex as ChangelogIndexItem[]);
+
+      const result = await service.getLatestChangelogId();
+      expect(result).toBe('latest');
+    });
+
+    it('should return undefined if the index is empty', async () => {
+      vi.spyOn(service, 'getChangelogIndex').mockResolvedValue([]);
+
+      const result = await service.getLatestChangelogId();
+      expect(result).toBeUndefined();
+    });
+  });
+
+  describe('getChangelogIndex', () => {
+    it('should fetch and merge changelog data', async () => {
+      const mockResponse = {
+        json: vi.fn().mockResolvedValue({
+          cloud: [{ id: 'cloud1', date: '2023-01-01', versionRange: ['1.0.0'] }],
+          community: [{ id: 'community1', date: '2023-01-02', versionRange: ['1.1.0'] }],
+        }),
+      };
+      (global.fetch as any).mockResolvedValue(mockResponse);
+
+      const result = await service.getChangelogIndex();
+      expect(result).toHaveLength(2);
+      expect(result[0].id).toBe('community1');
+      expect(result[1].id).toBe('cloud1');
+    });
+
+    it('should handle fetch errors', async () => {
+      (global.fetch as any).mockRejectedValue(new Error('Fetch failed'));
+
+      const result = await service.getChangelogIndex();
+      expect(result).toBe(false);
+    });
+
+    it('should return only community items when config type is community', async () => {
+      service.config.type = 'community';
+      const mockResponse = {
+        json: vi.fn().mockResolvedValue({
+          cloud: [{ id: 'cloud1', date: '2023-01-01', versionRange: ['1.0.0'] }],
+          community: [{ id: 'community1', date: '2023-01-02', versionRange: ['1.1.0'] }],
+        }),
+      };
+      (global.fetch as any).mockResolvedValue(mockResponse);
+
+      const result = await service.getChangelogIndex();
+      expect(result).toHaveLength(1);
+      expect(result[0].id).toBe('community1');
+    });
+  });
+
+  describe('getIndexItemById', () => {
+    it('should return the correct item by id', async () => {
+      const mockIndex = [
+        { id: 'item1', date: '2023-01-01', versionRange: ['1.0.0'] },
+        { id: 'item2', date: '2023-01-02', versionRange: ['1.1.0'] },
+      ];
+      vi.spyOn(service, 'getChangelogIndex').mockResolvedValue(mockIndex as ChangelogIndexItem[]);
+
+      const result = await service.getIndexItemById('item2');
+      expect(result).toEqual({ id: 'item2', date: '2023-01-02', versionRange: ['1.1.0'] });
+    });
+
+    it('should return undefined for non-existent id', async () => {
+      vi.spyOn(service, 'getChangelogIndex').mockResolvedValue([]);
+
+      const result = await service.getIndexItemById('nonexistent');
+      expect(result).toBeUndefined();
+    });
+  });
+
+  describe('getPostById', () => {
+    it('should fetch and parse post content', async () => {
+      vi.spyOn(service, 'getIndexItemById').mockResolvedValue({
+        id: 'post1',
+        date: '2023-01-01',
+        versionRange: ['1.0.0'],
+      } as ChangelogIndexItem);
+
+      const mockResponse = {
+        text: vi.fn().mockResolvedValue('# Post Title\nPost content'),
+      };
+      (global.fetch as any).mockResolvedValue(mockResponse);
+
+      const result = await service.getPostById('post1');
+      expect(result).toMatchObject({
+        content: 'Post content',
+        date: expect.any(String), // 改为期望字符串而不是 Date 对象
+        description: 'Post content',
+        image: undefined,
+        rawTitle: 'Post Title',
+        tags: ['changelog'],
+        title: 'Post Title',
+      });
+
+      // 额外检查日期格式
+      expect(result.date).toMatch(/^\d{4}-\d{2}-\d{2}$/);
+    });
+
+    it('should handle fetch errors', async () => {
+      vi.spyOn(service, 'getIndexItemById').mockResolvedValue({} as ChangelogIndexItem);
+      (global.fetch as any).mockRejectedValue(new Error('Fetch failed'));
+
+      const result = await service.getPostById('error');
+      expect(result).toBe(false);
+    });
+
+    it('should use the correct locale for fetching content', async () => {
+      vi.spyOn(service, 'getIndexItemById').mockResolvedValue({
+        id: 'post1',
+        date: '2023-01-01',
+        versionRange: ['1.0.0'],
+      } as ChangelogIndexItem);
+
+      const mockResponse = {
+        text: vi.fn().mockResolvedValue('# Chinese Title\n中文内容'),
+      };
+      (global.fetch as any).mockResolvedValue(mockResponse);
+
+      const result = await service.getPostById('post1', { locale: 'zh-CN' });
+      expect(result).toEqual({
+        content: '中文内容',
+        date: '2023-01-01',
+        description: '中文内容',
+        image: undefined,
+        rawTitle: 'Chinese Title',
+        tags: ['changelog'],
+        title: 'Chinese Title',
+      });
+    });
+  });
+
+  describe('private methods', () => {
+    describe('mergeChangelogs', () => {
+      it('should merge and sort changelogs correctly', () => {
+        const cloud = [{ id: 'cloud1', date: '2023-01-01', versionRange: ['1.0.0'] }];
+        const community = [{ id: 'community1', date: '2023-01-02', versionRange: ['1.1.0'] }];
+
+        // @ts-ignore - accessing private method for testing
+        const result = service.mergeChangelogs(cloud, community);
+        expect(result).toHaveLength(2);
+        expect(result[0].id).toBe('community1');
+        expect(result[1].id).toBe('cloud1');
+      });
+
+      it('should override community items with cloud items when ids match', () => {
+        const cloud = [{ id: 'item1', date: '2023-01-01', versionRange: ['1.0.0'], type: 'cloud' }];
+        const community = [
+          { id: 'item1', date: '2023-01-01', versionRange: ['1.0.0'], type: 'community' },
+        ];
+
+        // @ts-ignore - accessing private method for testing
+        const result = service.mergeChangelogs(cloud, community);
+        expect(result).toHaveLength(1);
+        // @ts-ignore
+        expect(result[0].type).toBe('cloud');
+      });
+    });
+
+    describe('formatVersionRange', () => {
+      it('should format version range correctly', () => {
+        // @ts-ignore - accessing private method for testing
+        const result = service.formatVersionRange(['1.0.0', '1.1.0']);
+        expect(result).toEqual(['1.1.0', '1.0.0']);
+      });
+
+      it('should return single version as is', () => {
+        // @ts-ignore - accessing private method for testing
+        const result = service.formatVersionRange(['1.0.0']);
+        expect(result).toEqual(['1.0.0']);
+      });
+    });
+
+    describe('genUrl', () => {
+      it('should generate correct URL', () => {
+        // @ts-ignore - accessing private method for testing
+        const result = service.genUrl('test/path');
+        expect(result).toBe('https://raw.githubusercontent.com/lobehub/lobe-chat/main/test/path');
+      });
+    });
+
+    describe('extractHttpsLinks', () => {
+      it('should extract HTTPS links from text', () => {
+        const text = 'Text with https://example.com and https://test.com/image.jpg links';
+        // @ts-ignore - accessing private method for testing
+        const result = service.extractHttpsLinks(text);
+        expect(result).toEqual(['https://example.com', 'https://test.com/image.jpg']);
+      });
+    });
+
+    describe('cdnInit', () => {
+      it('should initialize CDN URLs if docCdnPrefix is set', async () => {
+        // 设置环境变量
+        process.env.DOC_S3_PUBLIC_DOMAIN = 'https://cdn.example.com';
+
+        // 重新导入模块以确保环境变量生效
+        const { ChangelogService } = await import('./index');
+        const service = new ChangelogService();
+
+        const mockData = { 'https://example.com/image.jpg': 'image-hash.jpg' };
+        const mockResponse = {
+          json: vi.fn().mockResolvedValue(mockData),
+        };
+        global.fetch = vi.fn().mockResolvedValue(mockResponse);
+
+        // @ts-ignore - accessing private method for testing
+        await service.cdnInit();
+
+        expect(service.cdnUrls).toEqual(mockData);
+      });
+    });
+
+    describe('replaceCdnUrl', () => {
+      it('should replace URL with CDN URL if available', async () => {
+        // 设置环境变量
+        process.env.DOC_S3_PUBLIC_DOMAIN = 'https://cdn.example.com';
+
+        // 重新导入模块以确保环境变量生效
+        const { ChangelogService } = await import('./index');
+        const service = new ChangelogService();
+
+        service.cdnUrls = { 'https://example.com/image.jpg': 'image-hash.jpg' };
+
+        // @ts-ignore - accessing private method for testing
+        const result = service.replaceCdnUrl('https://example.com/image.jpg');
+
+        expect(result).toBe('https://cdn.example.com/image-hash.jpg');
+      });
+
+      it('should return original URL if CDN URL is not available', () => {
+        const originalDocCdnPrefix = process.env.DOC_S3_PUBLIC_DOMAIN;
+        process.env.DOC_S3_PUBLIC_DOMAIN = 'https://cdn.example.com';
+        service.cdnUrls = {};
+
+        // @ts-ignore - accessing private method for testing
+        const result = service.replaceCdnUrl('https://example.com/image.jpg');
+        expect(result).toBe('https://example.com/image.jpg');
+
+        // Restore original value
+        process.env.DOC_S3_PUBLIC_DOMAIN = originalDocCdnPrefix;
+      });
+    });
+  });
+});