feat: improve embedding sys.user_id and conversion id info usage

[ModyQyW]

Summary

This PR improves embedding sys.user_id and conversation id info usage. Remove getPublicToken method as it is not used.

Close #17870.

Screenshots

Before	After

Checklist

Important

Please review the checklist below before submitting your pull request.

• This change requires a documentation update, included: Dify Document
• I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
• I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
• I've updated the documentation accordingly.
• I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

[asrguru20]

Summary

This PR improves embedding sys.user_id and conversation id info usage. Remove getPublicToken method as it is not used. Please review carefully, thank you 🙏

Close #17870.

Screenshots

Before After

Checklist

Important

Please review the checklist below before submitting your pull request.

• This change requires a documentation update, included: Dify Document
• I understand that this PR may be closed in case there was no previous discussion or issues. (This doesn't apply to typos!)
• I've added a test for each change that was introduced, and I tried as much as possible to make a single atomic change.
• I've updated the documentation accordingly.
• I ran dev/reformat(backend) and cd web && npx lint-staged(frontend) to appease the lint gods

very useful fix then we can create chatbot that aware if WordPress user is logged in or not

[asrguru20]

Please approve this pull because I need this issue to fixed so my chatbot iframe can pass logged in user information from my WordPress site

[Copilot]

Copilot reviewed 5 out of 5 changed files in this pull request and generated 3 comments.

[asrguru20]

will this pull be merged ? is there anyone answer me please

[vivianxe-ifast]

Hi @asrguru20 , would like to check with you, do we have documentation on how to implement in the difyChatbotConfig so that user_id is passed dynamically according to the logged in user? Thanks in advanced.

[ModyQyW]

So far, I have initiated two PRs to handle the custom sys.user_id issue, one landed in v1.2 #16062, and the other landed in v1.3 #18035.

The following are my personal suggestions based on v1.3:

If you do not need to customize sys.user_id, or you do not need to dynamically handle custom sys.user_id, just follow the steps described in your dify app Publish / Embed Into Site to embed the iframe yourself or use embed.min.js to create a chatbot.

If you need to dynamically handle sys.user_id, please handle it according to the situation:

For the case of directly loading the iframe, please try to destroy the iframe and then create a new iframe using the new URL;

For the case of using embed.min.js, please set window.difyChatbotConfig.dynamicScript to true, set window.systemVariables.user_id to the corresponding user id, and reload the page to destroy the iframe and then create a new iframe using the new URL.

If there are any problems, please open a new issue and use a new app to specifically describe the reproduction steps.

[vivianxe-ifast]

For the case of using embed.min.js, please set window.difyChatbotConfig.dynamicScript to true, set window.systemVariables.user_id to the corresponding user id, and reload the page to destroy the iframe and then create a new iframe using the new URL.

Hi @ModyQyW , the URL you meant is the public URL (as attached)?

1. As in, for every change of user_id, the public URL also need to regenerate?

2. Based on your enhancement, are we able to achieve something like this:-

a) user A login

window.difyChatbotConfig = {
token: 'N8oUKetDAUmhAUhU',
baseUrl: 'http://xxxxx',
systemVariables: {
user_id: 'userA',
},
}

b) user B login

window.difyChatbotConfig = {
token: 'N8oUKetDAUmhAUhU',
baseUrl: 'http://xxxxx',
systemVariables: {
user_id: 'userB',
},
}

c) when user A login again, still able to view own previous conversation
window.difyChatbotConfig = {
token: 'N8oUKetDAUmhAUhU',
baseUrl: 'http://xxxxx',
systemVariables: {
user_id: 'userA',
},
}

[jason-lee-x]

So far, I have initiated two PRs to handle the custom sys.user_id issue, one landed in v1.2 #16062, and the other landed in v1.3 #18035.

The following are my personal suggestions based on v1.3:

If you do not need to customize sys.user_id, or you do not need to dynamically handle custom sys.user_id, just follow the steps described in your dify app Publish / Embed Into Site to embed the iframe yourself or use embed.min.js to create a chatbot.

If you need to dynamically handle sys.user_id, please handle it according to the situation:

For the case of directly loading the iframe, please try to destroy the iframe and then create a new iframe using the new URL;

For the case of using embed.min.js, please set window.difyChatbotConfig.dynamicScript to true, set window.systemVariables.user_id to the corresponding user id, and reload the page to destroy the iframe and then create a new iframe using the new URL.

If there are any problems, please open a new issue and use a new app to specifically describe the reproduction steps.

It's better to have a prefix on the local storage that the embed iframes produced,so that we can remove them easily instead destroying iframe and reload the page.

[ModyQyW]

For the case of using embed.min.js, please set window.difyChatbotConfig.dynamicScript to true, set window.systemVariables.user_id to the corresponding user id, and reload the page to destroy the iframe and then create a new iframe using the new URL.

Hi @ModyQyW , the URL you meant is the public URL (as attached)?

**1. As in, for every change of user_id, the public URL also need to regenerate?**

2. Based on your enhancement, are we able to achieve something like this:-

a) user A login

window.difyChatbotConfig = { token: 'N8oUKetDAUmhAUhU', baseUrl: 'http://xxxxx', systemVariables: { user_id: 'userA', }, }

b) user B login

window.difyChatbotConfig = { token: 'N8oUKetDAUmhAUhU', baseUrl: 'http://xxxxx', systemVariables: { user_id: 'userB', }, }

c) when user A login again, still able to view own previous conversation window.difyChatbotConfig = { token: 'N8oUKetDAUmhAUhU', baseUrl: 'http://xxxxx', systemVariables: { user_id: 'userA', }, }

👋 Hi @vivianxe-ifast

1. I'm not referring to regenerating the Public URL, but specifically the URL Search Params part.

User A with userA as user_id should have https://udify.app/chat/N8oUKetDAUmhAUhU?sys.user_id=H4sIAAAAAAAAAystTi1yBABp9FTcBQAAAA== (visit https://dify-ce-dd.modyqyw.top/ce?value=userA to get the final value), and User B with userB as user_id should have https://udify.app/chat/N8oUKetDAUmhAUhU?sys.user_id=H4sIAAAAAAAAAystTi1yAgDTpV1FBQAAAA== (visit https://dify-ce-dd.modyqyw.top/ce?value=userB to get the final value).

The core difference can be seen in the part after the ?.

If you update window.difyChatbotConfig after creating an iframe, embed.js or your own managed iframe will not update the already created iframe. That's why I said you need to destroy the original iframe first and then create a new iframe, just to ensure that the URL Search Params used by the iframe are correct.

2. Yes! The last conversation id is attached to both app id and user id now.

My English is a bit poor, I hope I can explain everything clearly to you. Thanks, hope this helps! 🙏

[ModyQyW]

So far, I have initiated two PRs to handle the custom sys.user_id issue, one landed in v1.2 #16062, and the other landed in v1.3 #18035.
The following are my personal suggestions based on v1.3:
If you do not need to customize sys.user_id, or you do not need to dynamically handle custom sys.user_id, just follow the steps described in your dify app Publish / Embed Into Site to embed the iframe yourself or use embed.min.js to create a chatbot.
If you need to dynamically handle sys.user_id, please handle it according to the situation:
For the case of directly loading the iframe, please try to destroy the iframe and then create a new iframe using the new URL;
For the case of using embed.min.js, please set window.difyChatbotConfig.dynamicScript to true, set window.systemVariables.user_id to the corresponding user id, and reload the page to destroy the iframe and then create a new iframe using the new URL.
If there are any problems, please open a new issue and use a new app to specifically describe the reproduction steps.

It's better to have a prefix on the local storage that the embed iframes produced,so that we can remove them easily instead destroying iframe and reload the page.

Sorry but I don't get your point. Could you provide an example to further illustrate please? Thank you! 🙏