Standardize HF_ACCESS_TOKEN -> HF_TOKEN

[Wauplin]

Same as huggingface/transformers.js#431 and huggingface/huggingface.js#391.
Related to slack thread (internal).

This PR standardizes the name of the environment variable used to make requests with a HF API token. The goal is to harmonize it across the HF ecosystem. For what I've seen, both HF_TOKEN and HF_ACCESS_TOKEN are defined in this repo. What this PR does is:

• rename HF_ACCESS_TOKEN to HF_TOKEN => the token used for api request
• rename HF_TOKEN to HF_DEPLOYMENT_TOKEN => the token used to deploy chat-ui to production. This looks like an internal secret.

Given this switch, there is a chance that we mismatch an old HF_TOKEN (for deployment) with a new HF_TOKEN (for api requests). Do we only need to change github secrets or is there a possibility that users conifgured chat-ui in their own environment with the old HF_TOKEN as environment variable? In that case, do you have an idea how to solve this? In any case, please let me know if there's anytime to change.

TODO before merging update HF_TOKEN => HF_DEPLOYMENT_TOKEN and HF_ACCESS_TOKEN => HF_TOKEN in Github repo secrets.

cc @xenova @julien-c

[nsarrazin]

Hi @Wauplin thanks for the PR, I'll handle the change to the secrets 👍

[nsarrazin]

I think for legacy support, we should check HF_ACCESS_TOKEN and HF_TOKEN (with HF_TOKEN taking precedence) before pushing those changes. Would this be ok or is this intended to be a breaking change ? @Wauplin

The old HF_TOKEN (new HF_DEPLOYMENT_TOKEN) is only used for HuggingChat CI and will not be impacting users.

[Wauplin]

Thanks @nsarrazin. I'm looking at the failed CI and I'm getting Error: Module '"$env/static/private"' has no exported member 'HF_TOKEN'. . Is this because github secrets are not updated or should I update $env/static/private? If I need to update static/private, where should it be done?

I think for legacy support, we should check HF_ACCESS_TOKEN and HF_TOKEN (with HF_TOKEN taking precedence) before pushing those changes. Would this be ok or is this intended to be a breaking change ?

Yes it was my intention to keep backward compatibility. I've done it in scripts/updateProdEnv.ts but maybe it's not enough?

const HF_TOKEN = process.env.HF_TOKEN ?? process.env.HF_ACCESS_TOKEN;

Feel free to directly push on my branch if it's easier.

[nsarrazin]

No problem, the CI failed because the .env was still using HF_ACCESS_TOKEN.

I added legacy support for HF_ACCESS_TOKEN in the code itself, see 89f2d96 @Wauplin

[Wauplin]

Thanks @nsarrazin! I did not see the .env file 🙈
And thanks for adding legacy support as well, it'll definitely be important for some already-deployed spaces. Feel free to merge once reviewed/approved!

[nsarrazin]

LGTM in the current state!

[gary149]

ok

[nsarrazin]

Updated the secrets, merging this!