ui-toolkit: Add VersionWidget to display the app and sdk version (#87)

Add a VersionWidget for the DynamicView and Sections to be able to
display the App and SDK version.

Co-authored-by: Fabian Bender <[email protected]>

Author: cmaier

kotlin-sample/src/main/assets/profileConfig.json

@@ -88,6 +88,11 @@
           "id": "4",
           "text": "Profile.licences",
           "padding": [16, 8]
+        },
+        {
+          "type": "snabble.version",
+          "id": "5",
+          "padding": [16, 8]
         }
       ]
     }

ui-toolkit/src/main/kotlin/io/snabble/sdk/dynamicview/data/dto/VersionDto.kt

@@ -0,0 +1,17 @@
+package io.snabble.sdk.dynamicview.data.dto
+
+import io.snabble.sdk.dynamicview.domain.model.VersionItem
+import kotlinx.serialization.SerialName
+import kotlinx.serialization.Serializable
+
+@Serializable
+@SerialName("snabble.version")
+internal data class VersionDto(
+    @SerialName("id") override val id: String,
+    @SerialName("padding") val padding: PaddingDto,
+) : WidgetDto
+
+internal fun VersionDto.toVersion(): VersionItem = VersionItem(
+    id = id,
+    padding = padding.toPadding()
+)

ui-toolkit/src/main/kotlin/io/snabble/sdk/dynamicview/data/dto/mapper/ConfigMapper.kt

@@ -16,6 +16,7 @@ import io.snabble.sdk.dynamicview.data.dto.SsidProvider
 import io.snabble.sdk.dynamicview.data.dto.StartShoppingDto
 import io.snabble.sdk.dynamicview.data.dto.TextDto
 import io.snabble.sdk.dynamicview.data.dto.ToggleDto
+import io.snabble.sdk.dynamicview.data.dto.VersionDto
 import io.snabble.sdk.dynamicview.data.dto.WidgetDto
 import io.snabble.sdk.dynamicview.data.dto.toButton
 import io.snabble.sdk.dynamicview.data.dto.toConnectWlan
@@ -29,6 +30,7 @@ import io.snabble.sdk.dynamicview.data.dto.toSeeAllStores
 import io.snabble.sdk.dynamicview.data.dto.toStartShopping
 import io.snabble.sdk.dynamicview.data.dto.toText
 import io.snabble.sdk.dynamicview.data.dto.toToggle
+import io.snabble.sdk.dynamicview.data.dto.toVersion
 import io.snabble.sdk.dynamicview.domain.model.Configuration
 import io.snabble.sdk.dynamicview.domain.model.DynamicConfig
 import io.snabble.sdk.dynamicview.domain.model.SectionItem
@@ -95,6 +97,8 @@ internal class ConfigMapperImpl(private val context: Context, private val ssidPr
                 )
 
                 is ToggleDto -> toToggle(text = "${context.resolveResourceString(text)}")
+
+                is VersionDto -> toVersion()
             }
         }
     }

ui-toolkit/src/main/kotlin/io/snabble/sdk/dynamicview/domain/model/VersionItem.kt

@@ -0,0 +1,6 @@
+package io.snabble.sdk.dynamicview.domain.model
+
+data class VersionItem(
+    override val id: String,
+    val padding: Padding,
+) : Widget

ui-toolkit/src/main/kotlin/io/snabble/sdk/dynamicview/ui/DynamicView.kt

@@ -19,6 +19,7 @@ import io.snabble.sdk.dynamicview.domain.model.SeeAllStoresItem
 import io.snabble.sdk.dynamicview.domain.model.StartShoppingItem
 import io.snabble.sdk.dynamicview.domain.model.TextItem
 import io.snabble.sdk.dynamicview.domain.model.ToggleItem
+import io.snabble.sdk.dynamicview.domain.model.VersionItem
 import io.snabble.sdk.dynamicview.domain.model.Widget
 import io.snabble.sdk.dynamicview.viewmodel.DynamicAction
 import io.snabble.sdk.widgets.ButtonWidget
@@ -32,6 +33,7 @@ import io.snabble.sdk.widgets.snabble.purchase.ui.PurchaseWidget
 import io.snabble.sdk.widgets.snabble.stores.ui.SeeAllStoresWidget
 import io.snabble.sdk.widgets.snabble.stores.ui.StartShoppingWidget
 import io.snabble.sdk.widgets.snabble.toggle.ui.ToggleWidget
+import io.snabble.sdk.widgets.snabble.version.ui.VersionWidget
 import io.snabble.sdk.widgets.snabble.wlan.ui.ConnectWlanWidget
 
 typealias OnDynamicAction = (action: DynamicAction) -> Unit
@@ -86,4 +88,6 @@ internal fun Widget(
     is ToggleItem -> ToggleWidget(model = widget, onAction = onAction)
 
     is SectionItem -> SectionWidget(model = widget, onAction = onAction)
+
+    is VersionItem -> VersionWidget(model = widget, onAction = onAction)
 }

ui-toolkit/src/main/kotlin/io/snabble/sdk/widgets/SectionWidget.kt

@@ -20,6 +20,7 @@ import io.snabble.sdk.dynamicview.domain.model.Padding
 import io.snabble.sdk.dynamicview.domain.model.SectionItem
 import io.snabble.sdk.dynamicview.domain.model.TextItem
 import io.snabble.sdk.dynamicview.domain.model.ToggleItem
+import io.snabble.sdk.dynamicview.domain.model.VersionItem
 import io.snabble.sdk.dynamicview.domain.model.toPaddingValues
 import io.snabble.sdk.dynamicview.theme.properties.Elevation
 import io.snabble.sdk.dynamicview.theme.properties.LocalElevation
@@ -30,6 +31,7 @@ import io.snabble.sdk.dynamicview.theme.properties.padding
 import io.snabble.sdk.dynamicview.ui.OnDynamicAction
 import io.snabble.sdk.utils.isNotNullOrBlank
 import io.snabble.sdk.widgets.snabble.toggle.ui.ToggleWidget
+import io.snabble.sdk.widgets.snabble.version.ui.VersionWidget
 import io.snabble.sdk.dynamicview.theme.properties.Padding as OuterPadding
 
 @Composable
@@ -70,6 +72,12 @@ fun SectionWidget(
                         modifier = Modifier.heightIn(min = 36.dp)
                     )
 
+                    is VersionItem -> VersionWidget(
+                        model = widget,
+                        onAction = onAction,
+                        modifier = Modifier.heightIn(min = 36.dp)
+                    )
+
                     else -> Unit
                 }
                 Divider(modifier = modifier.fillMaxWidth(), thickness = Dp.Hairline)

ui-toolkit/src/main/kotlin/io/snabble/sdk/widgets/snabble/version/ui/VersionWidget.kt

@@ -0,0 +1,91 @@
+package io.snabble.sdk.widgets.snabble.version.ui
+
+import android.content.Context
+import android.content.pm.PackageManager
+import android.os.Build
+import androidx.compose.foundation.clickable
+import androidx.compose.foundation.interaction.MutableInteractionSource
+import androidx.compose.foundation.layout.Column
+import androidx.compose.foundation.layout.Spacer
+import androidx.compose.foundation.layout.fillMaxWidth
+import androidx.compose.foundation.layout.height
+import androidx.compose.foundation.layout.padding
+import androidx.compose.material.Text
+import androidx.compose.material3.MaterialTheme
+import androidx.compose.runtime.Composable
+import androidx.compose.ui.Modifier
+import androidx.compose.ui.platform.LocalContext
+import androidx.compose.ui.platform.LocalInspectionMode
+import androidx.compose.ui.tooling.preview.Preview
+import androidx.compose.ui.unit.dp
+import io.snabble.sdk.Snabble
+import io.snabble.sdk.dynamicview.domain.model.Padding
+import io.snabble.sdk.dynamicview.domain.model.VersionItem
+import io.snabble.sdk.dynamicview.domain.model.toPaddingValues
+import io.snabble.sdk.dynamicview.ui.OnDynamicAction
+import io.snabble.sdk.dynamicview.viewmodel.DynamicAction
+
+@Composable
+fun VersionWidget(
+    modifier: Modifier = Modifier,
+    model: VersionItem,
+    onAction: OnDynamicAction,
+) {
+    val appVersion: String
+    val sdkVersion: String
+
+    if (!LocalInspectionMode.current) {
+        appVersion = provideAppVersion(LocalContext.current)
+        sdkVersion = Snabble.version
+    } else {
+        appVersion = "1.0"
+        sdkVersion = "0.10.0"
+    }
+
+    Column(
+        modifier = Modifier
+            .fillMaxWidth()
+            .clickable(
+                interactionSource = MutableInteractionSource(),
+                indication = null,
+            ) {
+                onAction(DynamicAction(model))
+            }
+            .padding(model.padding.toPaddingValues())
+            .then(modifier)
+    ) {
+        Text(
+            text = "Version",
+            color = MaterialTheme.colorScheme.onSurface,
+            style = MaterialTheme.typography.bodyLarge
+        )
+        Spacer(modifier = Modifier.height(4.dp))
+        Text(
+            text = "$appVersion, SDK $sdkVersion",
+            color = MaterialTheme.colorScheme.onSurface,
+            style = MaterialTheme.typography.bodyMedium
+        )
+    }
+}
+
+private fun provideAppVersion(context: Context): String {
+    val packageInfo = if (Build.VERSION.SDK_INT >= Build.VERSION_CODES.TIRAMISU) {
+        context.packageManager.getPackageInfo(context.packageName, PackageManager.PackageInfoFlags.of(0L))
+    } else {
+        @Suppress("DEPRECATION")
+        context.packageManager.getPackageInfo(context.packageName, 0)
+    }
+    return packageInfo.versionName
+}
+
+@Preview
+@Composable
+fun VersionWidgetPreview() {
+    VersionWidget(
+        model = VersionItem(
+            id = "a.version",
+            padding = Padding(0)
+        ),
+        onAction = {}
+    )
+}

…view/data/dto/mapper/ConfigMapperTest.kt …/data/dto/mapper/ConfigMapperImplTest.ktui-toolkit/src/test/kotlin/io/snabble/sdk/dynamicview/data/dto/mapper/ConfigMapperTest.kt renamed to ui-toolkit/src/test/kotlin/io/snabble/sdk/dynamicview/data/dto/mapper/ConfigMapperImplTest.kt ui-toolkit/src/test/kotlin/io/snabble/sdk/dynamicview/data/dto/mapper/ConfigMapperTest.kt renamed to ui-toolkit/src/test/kotlin/io/snabble/sdk/dynamicview/data/dto/mapper/ConfigMapperImplTest.kt

@@ -21,6 +21,7 @@ import io.snabble.sdk.dynamicview.data.dto.SectionDto
 import io.snabble.sdk.dynamicview.data.dto.SeeAllStoresDto
 import io.snabble.sdk.dynamicview.data.dto.StartShoppingDto
 import io.snabble.sdk.dynamicview.data.dto.TextDto
+import io.snabble.sdk.dynamicview.data.dto.VersionDto
 import io.snabble.sdk.dynamicview.data.dto.WidgetDto
 import io.snabble.sdk.dynamicview.domain.model.ButtonItem
 import io.snabble.sdk.dynamicview.domain.model.ConnectWlanItem
@@ -33,12 +34,13 @@ import io.snabble.sdk.dynamicview.domain.model.SectionItem
 import io.snabble.sdk.dynamicview.domain.model.SeeAllStoresItem
 import io.snabble.sdk.dynamicview.domain.model.StartShoppingItem
 import io.snabble.sdk.dynamicview.domain.model.TextItem
+import io.snabble.sdk.dynamicview.domain.model.VersionItem
 import io.snabble.sdk.utils.getComposeColor
 import io.snabble.sdk.utils.getResourceString
 import io.snabble.sdk.utils.resolveColorId
 import io.snabble.sdk.utils.resolveImageId
 
-internal class ConfigMapperTest : FreeSpec({
+internal class ConfigMapperImplTest : FreeSpec({
 
     val context = mockk<Context>(relaxed = true)
 
@@ -391,6 +393,27 @@ internal class ConfigMapperTest : FreeSpec({
                 }
             }
 
+            "VersionDto to VersionItem" - {
+
+                val versionDto = VersionDto(
+                    id = "a.version",
+                    padding = PaddingDto(0, 0, 0, 0)
+                )
+
+                val rootDto = setupSutDto(versionDto)
+                every { context.resolveImageId(rootDto.configuration.image) } returns 1
+
+                val sut = createMapper().mapDtoToItems(rootDto)
+
+                val startShoppingItem = sut.widgets.first().shouldBeTypeOf<VersionItem>()
+
+                "id" {
+                    startShoppingItem.id shouldBe "a.version"
+                }
+                "padding" {
+                    startShoppingItem.padding shouldBe Padding(0, 0, 0, 0)
+                }
+            }
         }
     }
 })