♻️ refactor: Move next-auth hooks to user store actions #2364

cy948 · 2024-05-04T09:01:38Z

💻 变更类型 | Change Type

🔀 变更说明 | Description of Change

fix [Bug] 通用设置里的访问密码及登录按钮消失 #2391
✨ src/store/user/slices/auth/action.ts: 增加 next-auth 的登陆、登出 Hooks；
♻️ src/features/Conversation/Error/OAuthForm.tsx：改为使用 UserStore 的登陆方法和用户信息获取方法；
♻️ src/app/(main)/settings/common/features/Common.tsx：同上；
🏷️ src/libs/next-auth/index.ts：类型定义移动到 -> src/types/next-auth.d.ts；
🔥 删除 src/hooks/useOAuthSession.ts
📝 docs/self-hosting/advanced/authentication*：补充新环境变量 NEXT_PUBLIC_ENABLE_NEXT_AUTH 及变量 NEXT_AUTH_SECRECT 变更；
♻️ src/config/auth.ts：补充新环境变量 NEXT_PUBLIC_ENABLE_NEXT_AUTH 用于判断是否启用 next-auth
🧪 src/store/user/slices/auth/action.test.ts：补充对 next-auth hook 调用的测试；

== 05/08/2024 更新 ==

✨ src/app/(main)/settings/common/features/Common.tsx：使用 serverConfigStore 的值决定是否隐藏 ACCES_CODE 输入框和 OAuth 登陆按钮；
🔥 src/app/(main)/settings/common/index.tsx：因上述原因，移除 <Common /> 的 props；

== 05/12/2024 更新 ==

🔥 src/config/auth.ts：去除环境变量 NEXT_PUBLIC_ENABLE_NEXT_AUTH 及其提示

== 05/13/2024 更新==

🔥 src/store/user/slices/auth/action.ts：去除openUserProfile 中与 NextAuth 相关的内容

📝 补充信息 | Additional Information

💥 src/store/user/slices/auth/action.ts：~~中依靠环境变量 NEXT_PUBLIC_ENABLE_NEXTAUTH 判定是否使用 next-auth 登陆。对直接使用官方镜像的 next-auth 用户造成 breaking change。~~
💄 style: add user panel and refactor the next-auth #2349
✨ feat: support clerk as auth provider #2374

vercel · 2024-05-04T09:01:42Z

@cy948 is attempting to deploy a commit to the LobeHub Team on Vercel.

A member of the Team first needs to authorize it.

lobehubbot · 2024-05-04T09:01:49Z

👍 @cy948

Thank you for raising your pull request and contributing to our Community
Please make sure you have followed our contributing guidelines. We will review it as soon as possible.
If you encounter any problems, please feel free to connect with us.
非常感谢您提出拉取请求并为我们的社区做出贡献，请确保您已经遵循了我们的贡献指南，我们会尽快审查它。
如果您遇到任何问题，请随时与我们联系。

codecov · 2024-05-04T09:05:19Z

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 93.21%. Comparing base (54524ab) to head (4006a59).
Report is 4 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main    #2364      +/-   ##
==========================================
+ Coverage   93.16%   93.21%   +0.05%     
==========================================
  Files         321      321              
  Lines       19372    19377       +5     
  Branches     1451     2280     +829     
==========================================
+ Hits        18047    18062      +15     
+ Misses       1325     1315      -10

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

src/features/Conversation/Error/OAuthForm.tsx

src/store/user/slices/auth/action.ts

arvinxx · 2024-05-06T05:49:43Z

src/store/user/slices/auth/action.ts

@@ -41,6 +42,11 @@ export const createAuthSlice: StateCreator<
  login: async () => {


login 方法移除吧，都换到 openLogin 里

src/store/user/slices/auth/action.ts

src/config/auth.ts

docs/self-hosting/advanced/authentication.zh-CN.mdx

arvinxx · 2024-05-06T05:53:16Z

另外需要补充下单测~

lobehubbot · 2024-05-06T05:53:26Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

In addition, you need to place an additional order for testing~

arvinxx · 2024-05-06T06:21:02Z

src/store/user/slices/auth/action.ts

@@ -76,6 +72,7 @@ export const createAuthSlice: StateCreator<

    if (enableNextAuth) {


感觉这一个判断可以移除了？

既然 next-auth 没有 profile，那是否应该在左上角的model里隐藏“账户管理”呢？

是的要隐藏

cy948 · 2024-05-06T10:18:48Z

另外需要补充下单测~

已在 0eaf64b 补充

docs/self-hosting/advanced/authentication.mdx

src/app/(main)/settings/common/index.tsx

vercel · 2024-05-10T07:30:56Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
lobe-chat-community	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 14, 2024 4:11am

lobehubbot · 2024-05-10T07:44:41Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

@cy948 After reading from serverConfigStore, do I still need the NEXT_PUBLIC variable?

cy948 · 2024-05-10T07:54:55Z

@cy948 换成从 serverConfigStore 读了以后，还需要 NEXT_PUBLIC 变量吗？

src/store/user/slices/auth/action.ts 这块还在用这个变量，也需要换成从 serverConfigStore 读吗？

arvinxx · 2024-05-10T09:51:18Z

src/store/user/slices/auth/action.ts 这块还在用这个变量，也需要换成从 serverConfigStore 读吗？

感觉如果可以的话，换成 serverConfigStore 读更好，这样 docker 估计就不会有 BreakingChange 了。

可以在 auth Slice 里加个方法：

 get enabledNextAuth: ()=>{ 
   return  serverConfigSelectors.enableOAuth(userServerConfigStore.getState())
}

lobehubbot · 2024-05-10T09:51:29Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

src/store/user/slices/auth/action.ts is still using this variable. Does it need to be read from serverConfigStore instead?

I feel that if possible, it would be better to switch to serverConfigStore for reading, so that docker will probably not have BreakingChange.

You can add a method to the store:

 get enabledNextAuth: ()=>{
   return serverConfigSelectors.enableOAuth(userServerConfigStore.getState())
}

cy948 · 2024-05-10T10:20:20Z

src/store/user/slices/auth/action.ts 这块还在用这个变量，也需要换成从 serverConfigStore 读吗？

感觉如果可以的话，换成 serverConfigStore 读更好，这样 docker 估计就不会有 BreakingChange 了。

可以在 auth Slice 里加个方法：
 get enabledNextAuth: ()=>{ 
   return  serverConfigSelectors.enableOAuth(userServerConfigStore.getState())
}

serverConfigSelectors 里有个 enabledOAuthSSO 可以进行判断，好像不需要新加方法

cy948 · 2024-05-10T11:40:00Z

@arvinxx 在这个Commit中。我把前台的 enableAuth, enableNextAuth 的判断都从 serverConfigStore 里读。后台保持不变，仍然从环境变量读。

lobehubbot · 2024-05-10T11:40:11Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

@arvinxx in this Commit. I read the front-end enableAuth and enableNextAuth judgments from serverConfigStore. The background remains unchanged and still reads from environment variables.

arvinxx · 2024-05-12T02:34:56Z

src/config/auth.ts

@@ -52,7 +53,7 @@ declare global {
 export const getAuthConfig = () => {
  if (process.env.ENABLE_OAUTH_SSO) {
    console.warn(
-      '`ENABLE_OAUTH_SSO` is deprecated and will be removed in LobeChat 1.0. just set `NEXT_AUTH_SECRET` enough',
+      '`ENABLE_OAUTH_SSO` is deprecated and will be removed in LobeChat 1.0. Please set `NEXT_PUBLIC_ENABLE_NEXT_AUTH` instead.',


这里也不需要 NEXT_PUBLIC_ENABLE_NEXT_AUTH 了吧？

确实，我改一下。

arvinxx · 2024-05-12T17:24:06Z

src/store/user/slices/auth/action.ts

+    return enableClerk || get()?.enabledNextAuth();
+  },
+  enabledNextAuth: () => {
+    return !!get()?.serverConfig.enabledOAuthSSO;


这里是不是有问题？userStore 里没有 serverConfig 的吧?

应该是下面这一块里包含的，IDE有提示，实测也能正常控制开关：

export type UserStore = SyncAction & UserState & SettingsAction & PreferenceAction & UserAuthAction & CommonAction;

arvinxx · 2024-05-13T12:13:33Z

@cy948 同步下 main，之前说的 profile 隐藏的逻辑已经实现好了，store里那部分代码可以删了

lobehubbot · 2024-05-13T12:13:44Z

Bot detected the issue body's language is not English, translate it automatically. 👯👭🏻🧑‍🤝‍🧑👫🧑🏿‍🤝‍🧑🏻👩🏾‍🤝‍👨🏿👬🏿

@cy948 Synchronize the main. The logic hidden by the profile mentioned before has been implemented. That part of the code in the store can be deleted.

lobehubbot · 2024-05-14T04:42:28Z

❤️ Great PR @cy948 ❤️

The growth of project is inseparable from user feedback and contribution, thanks for your contribution! If you are interesting with the lobehub developer community, please join our discord and then dm @arvinxx or @canisminor1990. They will invite you to our private developer channel. We are talking about the lobe-chat development or sharing ai newsletter around the world.
项目的成长离不开用户反馈和贡献，感谢您的贡献! 如果您对 LobeHub 开发者社区感兴趣，请加入我们的 discord，然后私信 @arvinxx 或 @canisminor1990。他们会邀请您加入我们的私密开发者频道。我们将会讨论关于 Lobe Chat 的开发，分享和讨论全球范围内的 AI 消息。

### [Version 0.159.1](v0.159.0...v0.159.1) <sup>Released on **2024-05-14**</sup> #### ♻ Code Refactoring - **misc**: Move next-auth hooks to user store actions. #### 🐛 Bug Fixes - **misc**: Pin `antd@5.17.0` to fix build error. <br/> <details> <summary><kbd>Improvements and Fixes</kbd></summary> #### Code refactoring * **misc**: Move next-auth hooks to user store actions, closes [#2364](#2364) ([6dbcd70](6dbcd70)) #### What's fixed * **misc**: Pin `antd@5.17.0` to fix build error, closes [#2483](#2483) ([aa03833](aa03833)) </details> <div align="right"> [![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top) </div>

lobehubbot · 2024-05-14T05:00:59Z

🎉 This PR is included in version 0.159.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

## [Version 1.39.0](v1.38.1...v1.39.0) <sup>Released on **2024-05-14**</sup> #### ♻ Code Refactoring - **misc**: Move next-auth hooks to user store actions. #### ✨ Features - **misc**: Support DeepSeek as new model provider. #### 🐛 Bug Fixes - **misc**: Dragging text mistakenly as image, pin `antd@5.17.0` to fix build error. <br/> <details> <summary><kbd>Improvements and Fixes</kbd></summary> #### Code refactoring * **misc**: Move next-auth hooks to user store actions, closes [lobehub#2364](https://github.com/bentwnghk/lobe-chat/issues/2364) ([6dbcd70](6dbcd70)) #### What's improved * **misc**: Support DeepSeek as new model provider, closes [lobehub#2446](https://github.com/bentwnghk/lobe-chat/issues/2446) ([18028f3](18028f3)) #### What's fixed * **misc**: Dragging text mistakenly as image, closes [lobehub#2111](https://github.com/bentwnghk/lobe-chat/issues/2111) ([3c047ef](3c047ef)) * **misc**: Pin `antd@5.17.0` to fix build error, closes [lobehub#2483](https://github.com/bentwnghk/lobe-chat/issues/2483) ([aa03833](aa03833)) </details> <div align="right"> [![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top) </div>

* ♻️ refactor: move next-auth hooks to store acitons * 🔥 refactor: remove redundant files * ♻️ refactor: add next-auth hooks * ♻️ refactor: add env `NEXT_PUBLIC_ENABLE_NEXT_AUTH` * 📝 docs: update docs for new NextAuth env * ♻️ refactor: remove `login` in auth actions * 🐛fix: login buttion not shown on settings * ✅ test: hooks in auth actions * ♻️ refactor: change button show condition * ♻️ refactor: use server config to show oauth button * 🐛fix: context error in settings * ♻️ refactor: use server config store to enable auth * 💬 refactor: remove tips * ♻️ refactor: remove env `NEXT_PUBLIC_ENABLE_NEXT_AUTH` * 🔥 refactor: remove open profile in store auth actions * ✅ test(useMenu): change states

### [Version 0.159.1](lobehub/lobe-chat@v0.159.0...v0.159.1) <sup>Released on **2024-05-14**</sup> #### ♻ Code Refactoring - **misc**: Move next-auth hooks to user store actions. #### 🐛 Bug Fixes - **misc**: Pin `antd@5.17.0` to fix build error. <br/> <details> <summary><kbd>Improvements and Fixes</kbd></summary> #### Code refactoring * **misc**: Move next-auth hooks to user store actions, closes [lobehub#2364](lobehub#2364) ([6dbcd70](lobehub@6dbcd70)) #### What's fixed * **misc**: Pin `antd@5.17.0` to fix build error, closes [lobehub#2483](lobehub#2483) ([aa03833](lobehub@aa03833)) </details> <div align="right"> [![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top) </div>

* ♻️ refactor: move next-auth hooks to store acitons * 🔥 refactor: remove redundant files * ♻️ refactor: add next-auth hooks * ♻️ refactor: add env `NEXT_PUBLIC_ENABLE_NEXT_AUTH` * 📝 docs: update docs for new NextAuth env * ♻️ refactor: remove `login` in auth actions * 🐛fix: login buttion not shown on settings * ✅ test: hooks in auth actions * ♻️ refactor: change button show condition * ♻️ refactor: use server config to show oauth button * 🐛fix: context error in settings * ♻️ refactor: use server config store to enable auth * 💬 refactor: remove tips * ♻️ refactor: remove env `NEXT_PUBLIC_ENABLE_NEXT_AUTH` * 🔥 refactor: remove open profile in store auth actions * ✅ test(useMenu): change states

### [Version 0.159.1](lobehub/lobe-chat@v0.159.0...v0.159.1) <sup>Released on **2024-05-14**</sup> #### ♻ Code Refactoring - **misc**: Move next-auth hooks to user store actions. #### 🐛 Bug Fixes - **misc**: Pin `antd@5.17.0` to fix build error. <br/> <details> <summary><kbd>Improvements and Fixes</kbd></summary> #### Code refactoring * **misc**: Move next-auth hooks to user store actions, closes [lobehub#2364](lobehub#2364) ([6dbcd70](lobehub@6dbcd70)) #### What's fixed * **misc**: Pin `antd@5.17.0` to fix build error, closes [lobehub#2483](lobehub#2483) ([aa03833](lobehub@aa03833)) </details> <div align="right"> [![](https://img.shields.io/badge/-BACK_TO_TOP-151515?style=flat-square)](#readme-top) </div>

cy948 added 2 commits May 4, 2024 16:44

♻️ refactor: move next-auth hooks to store acitons

c4df8e2

Merge branch 'main' into refactor/next-auth-hooks

db9557f

arvinxx reviewed May 4, 2024

View reviewed changes

src/features/Conversation/Error/OAuthForm.tsx Show resolved Hide resolved

src/store/user/slices/auth/action.ts Outdated Show resolved Hide resolved

cy948 added 7 commits May 5, 2024 14:34

🔥 refactor: remove redundant files

992e82c

Merge branch 'main' into refactor/next-auth-hooks

c48f100

Merge branch 'main' into refactor/next-auth-hooks

550bde4

♻️ refactor: add next-auth hooks

599c601

♻️ refactor: add env NEXT_PUBLIC_ENABLE_NEXT_AUTH

da3600a

📝 docs: update docs for new NextAuth env

dcd2c31

Merge branch 'main' into refactor/next-auth-hooks

1a839ca

arvinxx reviewed May 6, 2024

View reviewed changes

♻️ refactor: remove login in auth actions

5eac550

arvinxx reviewed May 6, 2024

View reviewed changes

cy948 mentioned this pull request May 6, 2024

[Bug] 通用设置里的访问密码及登录按钮消失 #2391

Closed

cy948 added 2 commits May 6, 2024 16:24

🐛fix: login buttion not shown on settings

8b692d7

✅ test: hooks in auth actions

0eaf64b

♻️ refactor: change button show condition

e1a5fec

arvinxx reviewed May 7, 2024

View reviewed changes

docs/self-hosting/advanced/authentication.mdx Show resolved Hide resolved

src/app/(main)/settings/common/index.tsx Outdated Show resolved Hide resolved

cy948 added 4 commits May 8, 2024 19:19

♻️ refactor: use server config to show oauth button

ce7491c

Merge branch 'main' into refactor/next-auth-hooks

f1b9977

🐛fix: context error in settings

17cc3ee

Merge branch 'main' into refactor/next-auth-hooks

259c075

vercel bot deployed to Preview May 10, 2024 07:37 View deployment

♻️ refactor: use server config store to enable auth

d8da7f8

arvinxx reviewed May 12, 2024

View reviewed changes

cy948 added 3 commits May 12, 2024 10:50

💬 refactor: remove tips

dde83fc

Merge branch 'main' into refactor/next-auth-hooks

ed85d64

♻️ refactor: remove env NEXT_PUBLIC_ENABLE_NEXT_AUTH

23a3a13

arvinxx reviewed May 12, 2024

View reviewed changes

cy948 added 3 commits May 13, 2024 23:10

Merge branch 'main' into refactor/next-auth-hooks

1184a8e

🔥 refactor: remove open profile in store auth actions

d5a07d4

✅ test(useMenu): change states

4006a59

arvinxx approved these changes May 14, 2024

View reviewed changes

vercel bot deployed to Preview May 14, 2024 04:11 View deployment

arvinxx merged commit 6dbcd70 into lobehub:main May 14, 2024
6 checks passed

lobehubbot added the released label May 14, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

♻️ refactor: Move next-auth hooks to user store actions #2364

♻️ refactor: Move next-auth hooks to user store actions #2364

cy948 commented May 4, 2024 •

edited

vercel bot commented May 4, 2024

lobehubbot commented May 4, 2024

codecov bot commented May 4, 2024 •

edited

arvinxx May 6, 2024

cy948 May 6, 2024

arvinxx commented May 6, 2024

lobehubbot commented May 6, 2024

arvinxx May 6, 2024

cy948 May 6, 2024

arvinxx May 6, 2024

cy948 commented May 6, 2024

vercel bot commented May 10, 2024 •

edited

lobehubbot commented May 10, 2024

cy948 commented May 10, 2024

arvinxx commented May 10, 2024 •

edited

lobehubbot commented May 10, 2024

cy948 commented May 10, 2024

cy948 commented May 10, 2024

lobehubbot commented May 10, 2024

arvinxx May 12, 2024

cy948 May 12, 2024

arvinxx May 12, 2024

cy948 May 13, 2024

arvinxx commented May 13, 2024

lobehubbot commented May 13, 2024

lobehubbot commented May 14, 2024

lobehubbot commented May 14, 2024

		@@ -41,6 +42,11 @@ export const createAuthSlice: StateCreator<
		login: async () => {

		@@ -76,6 +72,7 @@ export const createAuthSlice: StateCreator<

		if (enableNextAuth) {

♻️ refactor: Move next-auth hooks to user store actions #2364

♻️ refactor: Move next-auth hooks to user store actions #2364

Conversation

cy948 commented May 4, 2024 • edited

💻 变更类型 | Change Type

🔀 变更说明 | Description of Change

📝 补充信息 | Additional Information

vercel bot commented May 4, 2024

lobehubbot commented May 4, 2024

codecov bot commented May 4, 2024 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arvinxx commented May 6, 2024

lobehubbot commented May 6, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

cy948 commented May 6, 2024

vercel bot commented May 10, 2024 • edited

lobehubbot commented May 10, 2024

cy948 commented May 10, 2024

arvinxx commented May 10, 2024 • edited

lobehubbot commented May 10, 2024

cy948 commented May 10, 2024

cy948 commented May 10, 2024

lobehubbot commented May 10, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

arvinxx commented May 13, 2024

lobehubbot commented May 13, 2024

lobehubbot commented May 14, 2024

lobehubbot commented May 14, 2024

cy948 commented May 4, 2024 •

edited

codecov bot commented May 4, 2024 •

edited

vercel bot commented May 10, 2024 •

edited

arvinxx commented May 10, 2024 •

edited