Update React enum options on i18n changes

We use a custom caching for enum options in the React bindings
to enable enum renderer memoization. This caching didn't take the
new internationalization mechanism into account, leading to enum
labels not being updated on 'translate' change.

Also enables cachings for multi-enums which were not cached at
all before.

Co-authored-by: Stefan Dirix <sdirix@eclipsesource.com>

Author: TheZoker

packages/material/test/renderers/MaterialEnumControl.test.tsx

@@ -0,0 +1,75 @@
+/*
+  The MIT License
+
+  Copyright (c) 2017-2019 EclipseSource Munich
+  https://github.com/eclipsesource/jsonforms
+
+  Permission is hereby granted, free of charge, to any person obtaining a copy
+  of this software and associated documentation files (the "Software"), to deal
+  in the Software without restriction, including without limitation the rights
+  to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+  copies of the Software, and to permit persons to whom the Software is
+  furnished to do so, subject to the following conditions:
+
+  The above copyright notice and this permission notice shall be included in
+  all copies or substantial portions of the Software.
+
+  THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+  IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+  FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+  AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+  LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+  OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+  THE SOFTWARE.
+*/
+import './MatchMediaMock';
+import * as React from 'react';
+import {
+  ControlElement
+} from '@jsonforms/core';
+import { materialRenderers, MuiSelect } from '../../src';
+
+import Enzyme, { mount } from 'enzyme';
+import Adapter from '@wojtekmaj/enzyme-adapter-react-17';
+import { JsonFormsStateProvider } from '@jsonforms/react';
+import { initCore } from './util';
+import { MaterialEnumControl } from '../../src';
+
+Enzyme.configure({ adapter: new Adapter() });
+
+const data = { nationality: 'JP' };
+const schema = {
+  type: 'string',
+  enum: ['DE', 'IT', 'JP', 'US', 'RU', 'Other']
+};
+const uischema: ControlElement = {
+  type: 'Control',
+  scope: '#/properties/nationality',
+  options: {
+    autocomplete: false
+  }
+};
+
+describe('Material enum control', () => {
+  it('enum options should change when translation changes', () => {
+    const core = initCore(schema, uischema, data);
+    const translate = () => 'Translated';
+    const changedTranslate = () => 'OtherTranslation';
+    const wrapper = mount(
+      <JsonFormsStateProvider initState={{ renderers: materialRenderers, core, i18n: {translate} }}>
+        <MaterialEnumControl
+          schema={schema}
+          uischema={uischema}
+          path='nationality'
+        />
+      </JsonFormsStateProvider>
+    );
+
+    expect(wrapper.find(MuiSelect).props().options[0].label).toBe('Translated');
+
+    wrapper.setProps({ initState: { renderers: materialRenderers, core, i18n: {translate: changedTranslate} }} );
+    wrapper.update();
+
+    expect(wrapper.find(MuiSelect).props().options[0].label).toBe('OtherTranslation');
+  });
+});

packages/react/src/JsonFormsContext.tsx

@@ -225,7 +225,7 @@ export const ctxToEnumControlProps = (ctx: JsonFormsStateContext, props: OwnProp
    * Make sure, that options are memoized as otherwise the component will rerender for every change, 
    * as the options array is recreated every time.
    */
-  const options = useMemo(() => enumProps.options, [props.options, enumProps.schema]);
+  const options = useMemo(() => enumProps.options, [props.options, enumProps.schema, ctx.i18n?.translate]);
   return {...enumProps, options}
 }
 
@@ -235,12 +235,19 @@ export const ctxToOneOfEnumControlProps = (ctx: JsonFormsStateContext, props: Ow
    * Make sure, that options are memoized as otherwise the component will rerender for every change, 
    * as the options array is recreated every time.
    */
-  const options = useMemo(() => enumProps.options, [props.options, enumProps.schema]);
+  const options = useMemo(() => enumProps.options, [props.options, enumProps.schema, ctx.i18n?.translate]);
   return {...enumProps, options}
 }
 
-export const ctxToMultiEnumControlProps = (ctx: JsonFormsStateContext, props: OwnPropsOfControl) =>
-  mapStateToMultiEnumControlProps({ jsonforms: { ...ctx } }, props);
+export const ctxToMultiEnumControlProps = (ctx: JsonFormsStateContext, props: OwnPropsOfControl) => {
+  const enumProps = mapStateToMultiEnumControlProps({ jsonforms: { ...ctx } }, props);
+  /**
+   * Make sure, that options are memoized as otherwise the component will rerender for every change, 
+   * as the options array is recreated every time.
+   */
+  const options = useMemo(() => enumProps.options, [enumProps.schema, ctx.i18n?.translate]);
+  return {...enumProps, options}
+}
 
 export const ctxToControlWithDetailProps = (
   ctx: JsonFormsStateContext,
@@ -318,7 +325,7 @@ export const ctxToEnumCellProps = (
    * Make sure, that options are memoized as otherwise the cell will rerender for every change, 
    * as the options array is recreated every time.
    */
-  const options = useMemo(() => cellProps.options, [ownProps.options, cellProps.schema]);
+  const options = useMemo(() => cellProps.options, [ownProps.options, cellProps.schema, ctx.i18n?.translate]);
   return {...cellProps, options}
 };
 
@@ -331,7 +338,7 @@ export const ctxToOneOfEnumCellProps = (
    * Make sure, that options are memoized as otherwise the cell will rerender for every change, 
    * as the options array is recreated every time.
    */
-  const options = useMemo(() => enumCellProps.options, [props.options, enumCellProps.schema])
+  const options = useMemo(() => enumCellProps.options, [props.options, enumCellProps.schema, ctx.i18n?.translate])
   return {...enumCellProps, options};
 };