tabshift/payload
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

fix(ui): switching languages does not update cached client config (#11725)

Browse Source 
### What?
Fixed client config caching to properly update when switching languages
in the admin UI.

### Why?
Currently, switching languages doesn't fully update the UI because
client config stays cached with previous language translations.

### How?
Created a language-aware caching system that stores separate configs for
each language and only uses cached config when it matches the active
language.

Before:
```typescript
let cachedClientConfig: ClientConfig | null = global._payload_clientConfig

if (!cachedClientConfig) {
  cachedClientConfig = global._payload_clientConfig = null
}

export const getClientConfig = cache(
  (args: { config: SanitizedConfig; i18n: I18nClient; importMap: ImportMap }): ClientConfig => {
    if (cachedClientConfig && !global._payload_doNotCacheClientConfig) {
      return cachedClientConfig
    }
    // ... create new config ...
  }
);
```

After:
```typescript
let cachedClientConfigs: Record<string, ClientConfig> = global._payload_localizedClientConfigs

if (!cachedClientConfigs) {
  cachedClientConfigs = global._payload_localizedClientConfigs = {}
}

export const getClientConfig = cache(
  (args: { config: SanitizedConfig; i18n: I18nClient; importMap: ImportMap }): ClientConfig => {
    const { config, i18n, importMap } = args
    const currentLocale = i18n.language

    if (!global._payload_doNotCacheClientConfig && cachedClientConfigs[currentLocale]) {
      return cachedClientConfigs[currentLocale]
    }
    // ... create new config with correct translations ...
  }
);
```

Also added handling for cache clearing during HMR to ensure
compatibility with the existing system.

Fixes #11406

---------

Co-authored-by: Jacob Fletcher <jacobsfletch@gmail.com>
This commit is contained in:
Maxim Seshuk
2025-03-29 00:49:28 +03:00
committed by GitHub
parent 62c4e81a1f
commit 4a0bc869dd
3 changed files with 47 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files

23
test/i18n/e2e.spec.ts
View File

@@ -82,4 +82,27 @@ describe('i18n', () => {
page.locator('.componentWithCustomI18n .componentWithCustomI18nCustomValidI18nT'),
).toHaveText('My custom translation')
})
test('ensure translations update correctly when switching language', async () => {
await page.goto(serverURL + '/admin/account')
await page.locator('div.rs__control').click()
await page.locator('div.rs__option').filter({ hasText: 'English' }).click()
await expect(page.locator('div.payload-settings h3')).toHaveText('Payload Settings')
await page.goto(serverURL + '/admin/collections/collection1/create')
await expect(page.locator('label[for="field-fieldDefaultI18nValid"]')).toHaveText(
'Add {{label}}',
)
await page.goto(serverURL + '/admin/account')
await page.locator('div.rs__control').click()
await page.locator('div.rs__option').filter({ hasText: 'Español' }).click()
await expect(page.locator('div.payload-settings h3')).toHaveText('Configuración de la carga')
await page.goto(serverURL + '/admin/collections/collection1/create')
await expect(page.locator('label[for="field-fieldDefaultI18nValid"]')).toHaveText(
'Añadir {{label}}',
)
})
})