field.onValueChanged does not trigger for non-default locales

[prateem]

Using 4.25.0, I'm experiencing the same problem as @vctrivas from their comment in #166 . Since that issue has been closed and this issue / description seems to be different, I'm opening this new one.

Seeing an issue when expecting field.onValueChanged to be triggered when using a different locale than the fallback on setValue.

Here a simplified example:

With fallback en-US locale:

field.onValueChanged('en-US', () => {console.log('updated')}) // works as expected
field.setValue('some value', 'en-US')

With es as locale:

field.onValueChanged('es', () => {console.log('updated')}) // will not be triggered
field.setValue('some value', 'es')

You can see here when the locale is set to a different locale than the fallback the onValueChanged will not be triggered.

Any suggestions?

Originally posted by @vctrivas in https://github.com/contentful/ui-extensions-sdk/issues/166#issuecomment-1908246852

[prateem]

One guess I have for why this might be the case is found in field-locale.ts#75 where the sdk executes call('setValue', ...).

I'm not sure that there is any handler for that method... or at least, searching the contentful org for "addHandler('setValue'" doesn't yield any results, and nothing relevant comes up when searching for "setValue" and looking for it as an argument to any "addHandler" calls (compare to searching the org for "addHandler('valueChanged'").

In field-locale.ts on line 42 we see a handler created for "valueChanged" which does trigger the field's underlying valueSignal when called upon.

So: is the issue just a typo at the setValue function on line 75 of field-locale.ts? Should it call valueChanged on the channel instead of setValue?

    return await this._channel.call<SerializedJSONValue | undefined>(
      'valueChanged',
      this.id,
      this.locale,
      value,
    )

A reason I have to question my supposition is that this would imply that it shouldn't work with the default locale either (or else how is the valueSignal being triggered for the default locale..?), but it does. 🤔

Just some preliminary digging I did to try to figure the situation out. Cheers!