Per-widget server settings are not read for instance scopes (widgets with configuration parameters)

Abierto Apto para principiantes
#381 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Los mantenedores suelen responder en 1 día

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
2/5
Tiempo estimado
1-3 horas
Aptitud para principiantes
78/100
Tipo de issue
Error
Claridad
Bien especificado
Estado de actividad
Activo
Stack tecnológico
kotlin, swift
Área
mobile

Línea de trabajo

Empieza en Android con WidgetServerSettingsStore.kt y WidgetScope.kt: confirma que widgetKey/storageKey divergen para WidgetScope.Instance, y luego ajusta la capa de ajustes del widget para que lea mediante WidgetScope.of(scope.widgetId). Añade la prueba de Robolectric del issue en packages/android-client/android/src/test/java/voltra/widget/server/ y ejecuta el comando de prueba de Gradle indicado. Después replica el cambio en la ruta de iOS WidgetWidgetServerSettingsLayer.settings(for:) y revisa las pruebas existentes del store; hecho significa que una instancia hereda la URL, el intervalo, el método, las cabeceras y el body de su widget, mientras que ETag/status/props permanecen por instancia.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

Follow-up to #363. Found while reading the instance-scope code; confirmed on Android with a unit test, iOS from reading the code.

What happens

On main (b4b6e74), a widget that has configuration parameters resolves to WidgetScope.Instance. The per-widget settings layer then looks for settings under the instance's storage key (<widgetId>#<key>), but setWidgetServerUpdate with a widget id writes them under the widget id. So an instance does not see the URL, interval, method, headers or body set for its widget, and falls back to the global or config layers.

Expected

What WidgetScope and ADR 0007 say: "the settings layers keep resolving by widget id, so an instance inherits the widget's URL, interval, method, headers and body."

Cause

Android: the widget layer reads store.widgetKey(scope), and widgetKey uses scope.storageKey, which for an instance is "$widgetId#$key".

iOS has the same shape: WidgetWidgetServerSettingsLayer calls WidgetServerSettingsStore.settings(scope:), whose keychain account is built from scope.storageKey.

Repro (Android, Robolectric)

@RunWith(RobolectricTestRunner::class)
class WidgetSettingsInstanceScopeTest {
    private val url = "https://example.com/per-widget"

    @Test
    fun instanceScopeInheritsThePerWidgetSettingOfItsWidget() = runTest {
        val store = WidgetServerSettingsStore(RuntimeEnvironment.getApplication())
        store.set(WidgetServerUpdateSettings(url = url), WidgetScope.of("weather"))

        val resolved = WidgetWidgetServerSettingsLayer(store).settings(WidgetScope.Instance("weather", "k1"))

        assertEquals(url, resolved?.url)
    }
}

Placed in packages/android-client/android/src/test/java/voltra/widget/server/ and run with ./example/android/gradlew -p example/android :use-voltra_android-client:testDebugUnitTest --tests voltra.widget.server.WidgetSettingsInstanceScopeTest:

java.lang.AssertionError: expected:<https://example.com/per-widget> but was:<null>

The same test with WidgetScope.of("weather") on the read side passes.

Possible fix

Have the widget layer read by widget id on both platforms, e.g. on Android store.read(store.widgetKey(WidgetScope.of(scope.widgetId))) in WidgetWidgetServerSettingsLayer, and WidgetServerSettingsStore.settings(scope: .widget(id: scope.widgetId)) in WidgetWidgetServerSettingsLayer.settings(for:) on iOS. The ETag, status and props stores should keep using storageKey, since those are meant to be per instance.

Library version: 2.6.1 (main at b4b6e74). Not tied to a React Native, React or Expo version.

Lenguaje dominante
TypeScript
Estrellas
864
Forks
51
Merge medio
2 d 2 h
PR fusionados (30 d)
10

Preparar el entorno

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de callstackincubator/voltra

Todos los issues de callstackincubator/voltra

Issues similares

Más issues de TypeScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.