fix: localization panel freeze if too many translations

Only create form for inputs to be displayed and limit the number of translation shown on the panel. Encourage the user to use the search bar to find their translation.
AmadeusITGroup · Jun 19, 2024 · f37bb63 · f37bb63
1 parent 2390a8d
commit f37bb63
Show file tree

Hide file tree

Showing 12 changed files with 102 additions and 70 deletions.
diff --git a/.../chrome-devtools/src/app-devtools/localization-panel/localization-panel-pres.component.ts b/.../chrome-devtools/src/app-devtools/localization-panel/localization-panel-pres.component.ts
@@ -1,17 +1,28 @@
-import { AsyncPipe } from '@angular/common';
-import { ChangeDetectionStrategy, Component, computed, effect, inject, type OnDestroy, type Signal, untracked, viewChild, ViewEncapsulation } from '@angular/core';
-import { toSignal } from '@angular/core/rxjs-interop';
-import { FormControl, FormGroup, FormsModule, ReactiveFormsModule } from '@angular/forms';
-import { DfTooltipModule } from '@design-factory/design-factory';
-import { NgbAccordionDirective, NgbAccordionModule } from '@ng-bootstrap/ng-bootstrap';
+import {AsyncPipe} from '@angular/common';
+import {
+  ChangeDetectionStrategy,
+  Component,
+  computed,
+  effect,
+  inject,
+  type OnDestroy,
+  type Signal,
+  untracked,
+  viewChild,
+  ViewEncapsulation
+} from '@angular/core';
+import {toSignal} from '@angular/core/rxjs-interop';
+import {FormControl, FormGroup, FormsModule, ReactiveFormsModule} from '@angular/forms';
+import {DfTooltipModule} from '@design-factory/design-factory';
+import {NgbAccordionDirective, NgbAccordionModule} from '@ng-bootstrap/ng-bootstrap';
 import type {
   JSONLocalization,
   LocalizationMetadata
 } from '@o3r/localization';
-import { Subscription } from 'rxjs';
-import { map, throttleTime } from 'rxjs/operators';
-import { ChromeExtensionConnectionService } from '../../services/connection.service';
-import { LocalizationService, StateService } from '../../services';
+import {Subscription} from 'rxjs';
+import {map, throttleTime} from 'rxjs/operators';
+import {ChromeExtensionConnectionService} from '../../services/connection.service';
+import {LocalizationService, StateService} from '../../services';
 
 const THROTTLE_TIME = 100;
 
@@ -44,6 +55,7 @@ export class LocalizationPanelPresComponent implements OnDestroy {
   public readonly filteredLocalizations: Signal<LocalizationMetadata>;
   public readonly languages = this.localizationService.languages;
   public readonly hasSeveralLanguages: Signal<boolean>;
+  public readonly isTruncated: Signal<boolean>;
   public readonly localizationActiveStateOverridesForCurrentLang = computed(() => {
     const lang = this.currentLanguage();
     if (!lang) {
@@ -89,18 +101,24 @@ export class LocalizationPanelPresComponent implements OnDestroy {
     const search = toSignal(
       this.form.controls.search.valueChanges.pipe(
         map((text) => text?.toLowerCase() || ''),
-        throttleTime(THROTTLE_TIME, undefined, { trailing: true })
+        throttleTime(THROTTLE_TIME, undefined, {trailing: true})
       ),
-      { initialValue: '' }
+      {initialValue: ''}
     );
+    const searchMatch = computed(() => {
+      const searchText = search();
+      return searchText ?
+        this.localizations().filter(({ key, description, tags, ref }) =>
+          [key, description, ...(tags || []), ref].some((value) => value?.toLowerCase().includes(searchText))
+        ) : this.localizations();
+    });
 
     this.filteredLocalizations = computed(() => {
-      const searchText = search();
-      return searchText
-        ? this.localizations().filter(({ key, description, tags, ref }) => [key, description, ...(tags || []), ref].some((value) => value?.toLowerCase().includes(searchText)))
-        : this.localizations();
+      return searchMatch().slice(0, 20);
     });
 
+    this.isTruncated = computed(() => this.filteredLocalizations().length < searchMatch().length);
+
     effect(() => {
       const lang = this.currentLanguage();
       if (lang) {
@@ -120,34 +138,13 @@ export class LocalizationPanelPresComponent implements OnDestroy {
       })
     );
     effect(() => {
-      const translations = this.localizationService.translationsForCurrentLanguage();
+      const translations = this.filteredLocalizations();
       const lang = untracked(this.currentLanguage);
       if (!lang) {
         return;
       }
-      let langControl = this.form.controls.translations.controls[lang];
-      if (!langControl) {
-        langControl = new FormGroup<Record<string, TranslationControl>>({});
-        this.form.controls.translations.addControl(lang, langControl);
-      }
-      Object.entries(translations).forEach(([key, value]) => {
-        const control = langControl.controls[key];
-        const initialValue =
-          untracked(this.stateService.localState).localizations?.[this.form.value.lang || '']?.[key]
-          || value
-          || untracked(this.localizationService.localizationsMetadata).find((loc) => loc.key === key)?.value
-          || '';
-        if (!control) {
-          const newControl = new FormControl<string>(initialValue);
-          langControl.addControl(key, newControl);
-          this.subscription.add(
-            newControl.valueChanges.pipe(
-              throttleTime(THROTTLE_TIME, undefined, { trailing: true })
-            ).subscribe((newValue) => this.onLocalizationChange(key, newValue ?? ''))
-          );
-        } else {
-          control.setValue(initialValue);
-        }
+      translations.forEach(({key}) => {
+        this.upsertKeyForm(key, lang);
       });
     });
     effect(() => {
@@ -166,14 +163,33 @@ export class LocalizationPanelPresComponent implements OnDestroy {
         control.disable();
       }
     });
-    const locOverride = computed(() => this.stateService.localState().localizations || {});
-    effect(() => {
-      Object.entries(locOverride()).forEach(([lang, overridePerLang]) =>
-        Object.entries(overridePerLang).forEach(([key, value]) =>
-          this.form.controls.translations.controls[lang]?.controls[key]?.setValue(value)
-        )
+  }
+
+  private upsertKeyForm(key: string, lang: string) {
+    let langControl = this.form.controls.translations.controls[lang];
+    if (!langControl) {
+      langControl = new FormGroup<Record<string, TranslationControl>>({});
+      this.form.controls.translations.addControl(lang, langControl);
+    }
+    const control = langControl.controls[key];
+    const controlValue =
+      this.stateService.localState().localizations?.[this.form.value.lang || '']?.[key]
+      || untracked(this.localizationService.localizationsMetadata).find((loc) => loc.key === key)?.value
+      || '';
+    if (!control) {
+      const newControl = new FormControl<string>(controlValue);
+      langControl.addControl(key, newControl);
+      this.subscription.add(
+        newControl.valueChanges.pipe(
+          throttleTime(THROTTLE_TIME, undefined, {trailing: true})
+        ).subscribe((newValue) => {
+          this.onLocalizationChange(key, newValue ?? '');
+        })
       );
-    });
+    } else if (control.value !== controlValue) {
+      control.setValue(controlValue);
+    }
+
   }
 
   /**

diff --git a/...chrome-devtools/src/app-devtools/localization-panel/localization-panel-pres.template.html b/...chrome-devtools/src/app-devtools/localization-panel/localization-panel-pres.template.html
@@ -78,6 +78,9 @@ <h3 ngbAccordionHeader>
         } @empty {
           <h3>No localization found for your search.</h3>
         }
+        @if (isTruncated()) {
+          <span>Too many matches for this filter, please be more specific in your search.</span>
+        }
       </div>
     </ng-container>
   } @else {

diff --git a/apps/chrome-devtools/src/services/localization.service.ts b/apps/chrome-devtools/src/services/localization.service.ts
@@ -56,8 +56,11 @@ export class LocalizationService {
 
   constructor() {
     effect(() => {
-      this.connectionService.sendMessage('switchLanguage', { language: this.currentLanguage() });
-      this.connectionService.sendMessage('requestMessages', { only: ['getTranslationValuesContentMessage'] });
+      const currentLanguage = this.currentLanguage();
+      if (currentLanguage) {
+        this.connectionService.sendMessage('switchLanguage', { language: this.currentLanguage() });
+        this.connectionService.sendMessage('requestMessages', { only: ['getTranslationValuesContentMessage'] });
+      }
     });
     const externalSwitchLanguage = toSignal(
       this.connectionService.message$.pipe(

diff --git a/apps/chrome-devtools/src/services/state.service.ts b/apps/chrome-devtools/src/services/state.service.ts
@@ -75,26 +75,21 @@ export class StateService {
 
     effect(() => {
       const state = this.activeState();
+      const languages = untracked(this.languages);
       this.updateLocalState(state || {}, true);
       // TODO reset configuration (is it possible? based on default value from metadata if present?)
-      // Reset all languages before applying override of the new state
-      untracked(this.languages).forEach((lang) => this.connectionService.sendMessage('reloadLocalizationKeys', { lang }));
       // Reset all styling variables before applying override of the new state
       this.connectionService.sendMessage('resetStylingVariables', {});
       if (!state) {
+        languages.forEach((lang) => this.connectionService.sendMessage('reloadLocalizationKeys', { lang }));
         this.connectionService.sendMessage('unselectState', {});
         return;
       }
+      languages.forEach((lang) => this.connectionService.sendMessage('reloadLocalizationKeys',
+        { lang, ...state.localizations && state.localizations[lang] ? {overrides: state.localizations[lang]} : {} }));
       Object.entries(state.configurations || {}).forEach(([id, configValue]) => {
         this.connectionService.sendMessage('updateConfig', { id, configValue });
       });
-      Object.entries(state.localizations || {}).forEach(([lang, overrides]) => {
-        Object.entries(overrides).forEach(([key, value]) => {
-          this.connectionService.sendMessage('updateLocalization', {
-            key, value, lang
-          });
-        });
-      });
       if (state.stylingVariables && Object.keys(state.stylingVariables).length) {
         this.connectionService.sendMessage('updateStylingVariables', {
           variables: state.stylingVariables

diff --git a/packages/@o3r/localization/src/devkit/localization-devkit.interface.ts b/packages/@o3r/localization/src/devkit/localization-devkit.interface.ts
@@ -51,6 +51,7 @@ export interface UpdateLocalizationContentMessage extends OtterMessageContent<'u
 export interface ReloadLocalizationKeysContentMessage extends OtterMessageContent<'reloadLocalizationKeys'> {
   /** Lang */
   lang?: string;
+  overrides?: {[key: string]: string};
 }
 
 export interface IsTranslationDeactivationEnabledContentMessage extends OtterMessageContent<'isTranslationDeactivationEnabled'> {

diff --git a/packages/@o3r/localization/src/devkit/localization-devtools.console.service.ts b/packages/@o3r/localization/src/devkit/localization-devtools.console.service.ts
@@ -91,7 +91,7 @@ export class LocalizationDevtoolsConsoleService implements DevtoolsServiceInterf
   /**
    * @inheritdoc
    */
-  public reloadLocalizationKeys(language?: string) {
-    return this.localizationDevtools.reloadLocalizationKeys(language);
+  public reloadLocalizationKeys(language?: string, overrides?: {[key: string]: string}) {
+    return this.localizationDevtools.reloadLocalizationKeys(language, overrides);
   }
 }
diff --git a/packages/@o3r/localization/src/devkit/localization-devtools.message.service.ts b/packages/@o3r/localization/src/devkit/localization-devtools.message.service.ts
@@ -107,7 +107,7 @@ export class LocalizationDevtoolsMessageService implements OnDestroy {
         break;
       }
       case 'reloadLocalizationKeys': {
-        void this.localizationDevTools.reloadLocalizationKeys(message.lang);
+        void this.localizationDevTools.reloadLocalizationKeys(message.lang, message.overrides);
         break;
       }
       default: {

diff --git a/packages/@o3r/localization/src/devkit/localization-devtools.service.ts b/packages/@o3r/localization/src/devkit/localization-devtools.service.ts
@@ -82,7 +82,7 @@ export class OtterLocalizationDevtools {
    * @see https://github.com/ngx-translate/core/blob/master/packages/core/lib/translate.service.ts#L490
    * @param language language to reload
    */
-  public async reloadLocalizationKeys(language?: string) {
+  public async reloadLocalizationKeys(language?: string, overrides?: {[key: string]: string}) {
     const lang = language || this.getCurrentLanguage();
     if ((this.translateCompiler as TranslateMessageFormatLazyCompiler).clearCache) {
       (this.translateCompiler as TranslateMessageFormatLazyCompiler).clearCache();
@@ -96,6 +96,9 @@ export class OtterLocalizationDevtools {
       language || this.getCurrentLanguage(),
       initialLocs
     );
+    Object.entries(overrides || {}).forEach(([key, value]) => {
+      this.localizationService.getTranslateService().set(key, value, lang);
+    });
     this.appRef.tick();
   }
 }
diff --git a/packages/@o3r/styling/builders/style-extractor/index.ts b/packages/@o3r/styling/builders/style-extractor/index.ts
@@ -92,7 +92,6 @@ export default createBuilder(createBuilderWithMetricsIfInstalled<StyleExtractorB
       cssVarList
         .forEach((item) => {
           acc.variables[item.name] = item;
-          delete (acc.variables[item.name] as any).name;
         });
       return acc;
     }, previousMetadata);

diff --git a/packages/@o3r/styling/scss/theming/otter-theme/_functions.scss b/packages/@o3r/styling/scss/theming/otter-theme/_functions.scss
@@ -17,7 +17,8 @@
 
     @each $key, $value in $meta-theme {
       $new-key: if($root-name != '', '#{$root-name}-#{$key}', $key);
-      $new-value: _meta-theme-to-otter($value, $new-key);
+      // We do not extract the metadata as (variable, value) pair
+      $new-value: if($key != details, _meta-theme-to-otter($value, $new-key), $value);
       $ret: map.merge($ret, ($key: $new-value));
     }
 

diff --git a/packages/@o3r/styling/scss/theming/otter-theme/_material.scss b/packages/@o3r/styling/scss/theming/otter-theme/_material.scss
@@ -140,7 +140,9 @@
 
     @return $meta-theme;
   }
-
+  @if (map.has-key($meta-theme, value) and map.has-key($meta-theme, details)) {
+    @return _meta-theme-to-material(map.get($meta-theme, value), $root-name, $enable-css-var);
+  }
   @else {
     $ret: $meta-theme;
 

diff --git a/packages/@o3r/styling/src/devkit/styling-devtools.message.service.ts b/packages/@o3r/styling/src/devkit/styling-devtools.message.service.ts
@@ -18,11 +18,20 @@ const isStylingMessage = (message: any): message is AvailableStylingMessageConte
 
 const getCSSRulesAppliedOnRoot = () => Array.from(document.styleSheets)
   .reverse()
-  .reduce((acc: CSSStyleRule[], styleSheet) => acc.concat(
-    Array.from(styleSheet.cssRules || styleSheet.rules)
-      .reverse()
-      .filter((rule): rule is CSSStyleRule => rule instanceof CSSStyleRule && /\b:root\b/.test(rule.selectorText))
-  ), []);
+  .reduce((acc: CSSStyleRule[], styleSheet) => {
+    let rules;
+    try {
+      rules = styleSheet.cssRules || styleSheet.rules;
+    } catch {
+      console.debug(`Could not access CSS rule for ${JSON.stringify(styleSheet.href)}`);
+    }
+
+    return acc.concat(
+      Array.from(rules || [])
+        .reverse()
+        .filter((rule): rule is CSSStyleRule => rule instanceof CSSStyleRule && /\b:root\b/.test(rule.selectorText))
+    );
+  }, []);
 
 const getCSSVariableValueInCSSStyleDeclaration = (variableName: string, style: CSSStyleDeclaration) =>
   style.getPropertyValue(variableName).trim();