A home screen widget: latest runs, unread, reviews waiting (closes #28) b610bc6eeab7

package io.oxygenhub.android.widget

import android.content.Context

import androidx.compose.runtime.Composable

import androidx.compose.ui.graphics.Color

import androidx.compose.ui.unit.dp

import androidx.compose.ui.unit.sp

import androidx.glance.GlanceId

import androidx.glance.GlanceModifier

import androidx.glance.GlanceTheme

import androidx.glance.action.actionStartActivity

import androidx.glance.action.clickable

import androidx.glance.appwidget.GlanceAppWidget

import androidx.glance.appwidget.GlanceAppWidgetReceiver

import androidx.glance.appwidget.cornerRadius

import androidx.glance.appwidget.provideContent

import androidx.glance.background

import androidx.glance.color.ColorProvider

import androidx.glance.layout.Alignment

import androidx.glance.layout.Box

import androidx.glance.layout.Column

import androidx.glance.layout.Row

import androidx.glance.layout.Spacer

import androidx.glance.layout.fillMaxSize

import androidx.glance.layout.fillMaxWidth

import androidx.glance.layout.height

import androidx.glance.layout.padding

import androidx.glance.layout.size

import androidx.glance.layout.width

import androidx.glance.material3.ColorProviders

import androidx.glance.text.FontWeight

import androidx.glance.text.Text

import androidx.glance.text.TextStyle

import io.oxygenhub.android.MainActivity

import io.oxygenhub.android.OxygenHubApp

import io.oxygenhub.android.api.HubApi

import io.oxygenhub.android.api.UserFlowRun

import io.oxygenhub.android.ui.theme.DarkBad

import io.oxygenhub.android.ui.theme.DarkColorScheme

import io.oxygenhub.android.ui.theme.DarkOk

import io.oxygenhub.android.ui.theme.DarkWarn

import io.oxygenhub.android.ui.theme.LightBad

import io.oxygenhub.android.ui.theme.LightColorScheme

import io.oxygenhub.android.ui.theme.LightOk

import io.oxygenhub.android.ui.theme.LightWarn

import kotlinx.coroutines.CancellationException

import kotlinx.coroutines.async

import kotlinx.coroutines.coroutineScope

/** What the widget shows (#28); `signedIn` false asks for a sign-in instead. */

data class WidgetData(

    val signedIn: Boolean,

    val runs: List<UserFlowRun> = emptyList(),

    val unread: Long? = null,

    val reviews: Int? = null,

) {

    companion object {

        /** Each part on its own: one the hub cannot give is left out, not the whole widget. */

        suspend fun load(api: HubApi?): WidgetData = coroutineScope {

            if (api == null) return@coroutineScope WidgetData(signedIn = false)

            suspend fun <T> quietly(f: suspend () -> T): T? = try {

                f()

            } catch (e: CancellationException) {

                throw e

            } catch (_: Exception) {

                null

            }

            val runs = async { quietly { api.userFlowRuns() } }

            val unread = async { quietly { api.inbox(limit = 1).unread } }

            val reviews = async { quietly { api.userProposals().review.size } }

            WidgetData(true, runs.await().orEmpty().take(MAX_RUNS), unread.await(), reviews.await())

        }

        const val MAX_RUNS = 3

    }

}

/** A home screen widget (#28): your latest runs, unread notifications and reviews waiting; a tap opens the app. */

class HubWidget : GlanceAppWidget() {

    override suspend fun provideGlance(context: Context, id: GlanceId) {

        val api = (context.applicationContext as OxygenHubApp).container.sessions.api()

        val data = WidgetData.load(api)

        provideContent {

            GlanceTheme(colors = ColorProviders(light = LightColorScheme, dark = DarkColorScheme)) { Content(data) }

        }

    }

}

class HubWidgetReceiver : GlanceAppWidgetReceiver() {

    override val glanceAppWidget: GlanceAppWidget = HubWidget()

}

private val ok = ColorProvider(LightOk, DarkOk)

private val bad = ColorProvider(LightBad, DarkBad)

private val warn = ColorProvider(LightWarn, DarkWarn)

@Composable

private fun Content(d: WidgetData) {

    val title = TextStyle(color = GlanceTheme.colors.primary, fontSize = 15.sp, fontWeight = FontWeight.Bold)

    val body = TextStyle(color = GlanceTheme.colors.onSurface, fontSize = 13.sp)

    val mute = TextStyle(color = GlanceTheme.colors.onSurfaceVariant, fontSize = 12.sp)

    Column(

        GlanceModifier.fillMaxSize().cornerRadius(16.dp).background(GlanceTheme.colors.surfaceVariant).padding(12.dp)

            .clickable(actionStartActivity<MainActivity>()),

    ) {

        Text("OxygenHub", style = title)

        Spacer(GlanceModifier.height(6.dp))

        if (!d.signedIn) {

            Text("Sign in to see your runs, inbox and reviews.", style = mute)

            return@Column

        }

        if (d.runs.isEmpty()) Text("No runs yet.", style = mute)

        d.runs.forEach { r ->

            Row(GlanceModifier.fillMaxWidth().padding(vertical = 2.dp), verticalAlignment = Alignment.CenterVertically) {

                Box(GlanceModifier.size(10.dp).cornerRadius(5.dp).background(colourOf(r.run.status))) {}

                Spacer(GlanceModifier.width(8.dp))

                Text("${r.repository} #${r.run.number}", style = body, maxLines = 1, modifier = GlanceModifier.defaultWeight())

                Text(r.run.status, style = mute)

            }

        }

        Spacer(GlanceModifier.height(6.dp))

        Row {

            d.unread?.let { Text(if (it == 0L) "Inbox clear" else "$it unread", style = mute) }

            if (d.unread != null && d.reviews != null) Text("  ·  ", style = mute)

            d.reviews?.let { Text(if (it == 0) "no reviews waiting" else "$it to review", style = mute) }

        }

    }

}

private fun colourOf(status: String) = when (status) {

    "passed" -> ok

    "failed", "error" -> bad

    "running", "queued" -> warn

    else -> ColorProvider(Color.Gray, Color.Gray)

}

<?xml version="1.0" encoding="utf-8"?>

<!-- The home screen widget (#28): refreshed every half hour, and whenever the app comes to the front. -->

<appwidget-provider xmlns:android="http://schemas.android.com/apk/res/android"

    android:description="@string/widget_description"

    android:initialLayout="@layout/glance_default_loading_layout"

    android:minWidth="250dp"

    android:minHeight="110dp"

    android:resizeMode="horizontal|vertical"

    android:targetCellWidth="4"

    android:targetCellHeight="2"

    android:updatePeriodMillis="1800000"

    android:widgetCategory="home_screen" />

package io.oxygenhub.android.ui

import io.oxygenhub.android.FakeHubApi

import io.oxygenhub.android.api.FlowRun

import io.oxygenhub.android.api.HubException

import io.oxygenhub.android.api.UserFlowRun

import io.oxygenhub.android.widget.WidgetData

import kotlinx.coroutines.test.runTest

import org.junit.Assert.assertEquals

import org.junit.Assert.assertFalse

import org.junit.Assert.assertNull

import org.junit.Test

class WidgetDataTest {

    @Test

    fun theWidgetShowsTheLatestRunsAndCountsAndAsksForASignInWithoutOne() = runTest {

        val api = FakeHubApi()

        api.userFlowRuns = { (1L..5L).map { UserFlowRun("andy/a", FlowRun(number = it, status = "passed")) } }

        val d = WidgetData.load(api)

        assertEquals(listOf(1L, 2L, 3L), d.runs.map { it.run.number })

        assertEquals(1, d.reviews)

        assertFalse(WidgetData.load(null).signedIn)

    }

    @Test

    fun aPartTheHubCannotGiveIsLeftOutNotTheWholeWidget() = runTest {

        val api = FakeHubApi()

        api.userFlowRuns = { throw HubException.Http(404, "no such API route") }

        val d = WidgetData.load(api)

        assertEquals(emptyList<UserFlowRun>(), d.runs)

        assertEquals(1, d.reviews)

        api.userProposals = { throw HubException.Http(500, "down") }

        assertNull(WidgetData.load(api).reviews)

    }

}

    rootfs "cas://blob/d5dabda3166dee2a2fdaca1b245c6e677aa95066beff8b8bb829987cb2fcacd7"

- **A home screen widget (#28):** your latest three runs with their status, unread notifications and proposals waiting for your review, in OxygenHub's colours; a tap opens the app. It refreshes every half hour and whenever the app comes to the front, and asks for a sign-in when there is none. (Jetpack Glance 1.1.1.)

    implementation(libs.androidx.glance.appwidget)

    implementation(libs.androidx.glance.material3)

        <!-- The home screen widget (#28): latest runs, unread, reviews waiting. -->

        <receiver

            android:name=".widget.HubWidgetReceiver"

            android:exported="true"

            android:label="@string/widget_name">

            <intent-filter>

                <action android:name="android.appwidget.action.APPWIDGET_UPDATE" />

            </intent-filter>

            <meta-data

                android:name="android.appwidget.provider"

                android:resource="@xml/hub_widget_info" />

        </receiver>

import androidx.glance.appwidget.updateAll

import androidx.lifecycle.compose.collectAsStateWithLifecycle

import androidx.lifecycle.lifecycleScope

import io.oxygenhub.android.widget.HubWidget

import kotlinx.coroutines.launch

    }

    /** The widget (#28) shows what the app knows now, whenever the app comes to the front. */

    override fun onResume() {

        super.onResume()

        lifecycleScope.launch { runCatching { HubWidget().updateAll(this@MainActivity) } }

internal val DarkColorScheme = darkColorScheme(

internal val LightColorScheme = lightColorScheme(

    <string name="widget_name">OxygenHub</string>

    <string name="widget_description">Your latest Flow runs, unread notifications and reviews waiting</string>

# The home screen widget (#28): Jetpack Glance, Compose for app widgets.

glance = "1.1.1"

androidx-glance-appwidget = { group = "androidx.glance", name = "glance-appwidget", version.ref = "glance" }

androidx-glance-material3 = { group = "androidx.glance", name = "glance-material3", version.ref = "glance" }