Skip to content

fix: missing translations of remote built-in extensions #249430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jun 27, 2025

Conversation

hyrious
Copy link
Contributor

@hyrious hyrious commented May 21, 2025

@BlackHole1 noticed that some translations are missing when develop in remote mode. After digging a bit, we found that only built-in extensions' NLS messages are missing. For example, the Source Control view (contributed by the built-in 'Git' extension) and built-in extensions' configurations are in English.

Despite that the remote server will download and install the corresponding language pack extension, it does not pick the language pack up because of 2 problems:

  1. There's no nls.keys.json in the server build, causing clp/{hash}.{lang}/* failed to generate.
  2. When scanning built-in extensions, the UI language was not passed correctly to the backend.

This PR fixes the 2 problems.

Note about problem 1: The original code Promise.all([mkdir, read keys, read messages]) will fail when the keys file is missing, but the mkdir task would succeed and leave an empty folder which prevents it regenerate in the next calling. So I changed the testing logic from the folder to the file in it.

Fixes #250579

@hyrious
Copy link
Contributor Author

hyrious commented May 21, 2025

@microsoft-github-policy-service agree

@sandy081
Copy link
Member

sandy081 commented Jun 3, 2025

Can you please share more information here - what is the bug? Are there steps to reproduce? Any screenshots would be helpful. Before that please file an issue first with all this information. Thanks

@hyrious
Copy link
Contributor Author

hyrious commented Jun 4, 2025

@sandy081 Hi thanks for showing up. I have created an issue linked to this PR: #250579

@sandy081 sandy081 self-requested a review June 4, 2025 11:27
@sandy081 sandy081 assigned TylerLeonhardt and unassigned sandy081 Jun 4, 2025
@sandy081 sandy081 removed their request for review June 4, 2025 11:28
@TylerLeonhardt
Copy link
Member

TylerLeonhardt commented Jun 11, 2025

@hyrious how did you test this change, because I just tested it (by building a local build of VS Code) and it sadly does not work (I'm using a pseudolanguage pack since I know only English)

image

@TylerLeonhardt
Copy link
Member

@sandy081 your guidance would be nice here. The steps are easy to reproduce:

  • Install a language pack
  • Do any Remote connection (like Dev Containers)
  • Check the source control view for localization

These strings are localized in the manifest so I'm not sure why, when there's a remote, the manifest strings would stick to English.

@hyrious
Copy link
Contributor Author

hyrious commented Jun 11, 2025

@TylerLeonhardt A little tricky to test because the remote host should also be built by yourself. If you're using the official reh build in the remote host it wouldn't work.

I actually tested it by manually port changes to the code-server. You may have a try:

  1. Find the code server's source code in the remote OS, it should be inside ~/.vscode-server.
  2. Copy the nls.keys.json from your local vscode to the same folder as nls.messages.json in the remote OS.
  3. Delete the clp folder from the remote OS if it was generated before.
  4. Port changes to the server's source code. If you're just lazy, you can hard code a language option in the scan extensions method (see this pr's diff).
  5. Reconnect to it, this means a full restart of the code-server process. The client should have been modified to send correct IPC messages. Note that in this step, you have to make sure the local commit does not change otherwise the server may refuse to connect.

@BlackHole1
Copy link
Contributor

Delete the clp folder from the remote OS if it was generated before.

clp location: ~/.vscode-server-insiders/data/clp

@TylerLeonhardt
Copy link
Member

I built an Insiders build off of this branch and can confirm that this fixes the problem :)

TylerLeonhardt
TylerLeonhardt previously approved these changes Jun 12, 2025
@vs-code-engineering vs-code-engineering bot added this to the June 2025 milestone Jun 12, 2025
@bpasero bpasero requested a review from dbaeumer June 13, 2025 10:18
TylerLeonhardt
TylerLeonhardt previously approved these changes Jun 13, 2025
try {
const userScanOptions: UserExtensionsScanOptions = { includeInvalid: true, profileLocation, productVersion };
let scannedExtensions: IScannedExtension[] = [];
if (type === null || type === ExtensionType.System) {
let scanAllExtensionsPromise = this.scanAllExtensionPromise.get(profileLocation);
if (!scanAllExtensionsPromise) {
scanAllExtensionsPromise = this.extensionsScannerService.scanAllExtensions({}, userScanOptions)
scanAllExtensionsPromise = this.extensionsScannerService.scanAllExtensions({ language }, userScanOptions)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is not this promise should be cached by language?

Copy link
Contributor Author

@hyrious hyrious Jun 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh.. yes. Maybe I will just use ${profileLocation}?${language} for key of the scanAllExtensionPromise map?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, you need to change both scanned extensions promises map

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sandy081 Sorry, just noticed the comment. Code updated.

roblourens
roblourens previously approved these changes Jun 13, 2025
TylerLeonhardt
TylerLeonhardt previously approved these changes Jun 14, 2025
@TylerLeonhardt
Copy link
Member

@sandy081 I defer to you for final approval

@hyrious hyrious dismissed stale reviews from TylerLeonhardt and roblourens via 22708b9 June 17, 2025 12:10
@sandy081
Copy link
Member

@TylerLeonhardt Approved from my side. Should we merge?

Copy link
Member

@TylerLeonhardt TylerLeonhardt left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉

@TylerLeonhardt TylerLeonhardt enabled auto-merge (squash) June 27, 2025 13:14
@TylerLeonhardt TylerLeonhardt merged commit 7dd2343 into microsoft:main Jun 27, 2025
7 checks passed
@TylerLeonhardt
Copy link
Member

@hyrious this fix is going to make a lot of devs happy. Thank you for contributing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Translations for built-in extensions are missing in remote mode
9 participants