feat: swipe to refresh calendars (#168)

williscool · web-flow · commit b5bb18a9eb6b · 2026-01-10T14:47:24.000-05:00
* docs: inital plan

* docs: tests

* feat: swipe to refresh calendar

* docs: handled calendars plan

* feat: handled calendars events visual indicator

* fix: build and bug bot

Test returns early without executing assertions
Medium Severity

The test testRefreshMenuItemTriggersRefresh attempts to find a menu item
using activity.findViewById(R.id.action_refresh_calendars), but menu
items are not part of the activity's view hierarchy, so findViewById
always returns null. This causes the ?.let block to be skipped and the
?: return clause to execute, making the test return early without ever
calling onOptionsItemSelected or reaching the final assertion. The test
silently passes without actually testing the refresh behavior. Compare
to testHelpMenuItemShowsDialog which correctly retrieves the menu item
from shadowActivity.optionsMenu.

* test: pass
diff --git a/android/app/src/androidTest/java/com/github/quarck/calnotify/testutils/MockCalendarProvider.kt b/android/app/src/androidTest/java/com/github/quarck/calnotify/testutils/MockCalendarProvider.kt
@@ -124,6 +124,10 @@ class MockCalendarProvider(
             DevLog.info(LOG_TAG, "Delegating updateEvent to real implementation: eventId=$eventId, calendarId=$calendarId")
             callOriginal()
         }
+        
+        every { CalendarProvider.getUpcomingEventCountsByCalendar(any(), any()) } answers {
+            callOriginal()
+        }
     }
     
     /**
diff --git a/android/app/src/main/java/com/github/quarck/calnotify/calendar/CalendarProvider.kt b/android/app/src/main/java/com/github/quarck/calnotify/calendar/CalendarProvider.kt
@@ -1840,4 +1840,38 @@ object CalendarProvider : CalendarProviderInterface {
     private fun checkPermissions(context: Context): Boolean {
         return PermissionsManager.hasAllCalendarPermissionsNoCache(context)
     }
+
+    override fun getUpcomingEventCountsByCalendar(context: Context, daysAhead: Int): Map<Long, Int> {
+        val counts = mutableMapOf<Long, Int>()
+
+        if (!PermissionsManager.hasReadCalendar(context)) {
+            DevLog.error(LOG_TAG, "getUpcomingEventCountsByCalendar: no permissions")
+            return counts
+        }
+
+        try {
+            val now = clock.currentTimeMillis()
+            val endTime = now + daysAhead * Consts.DAY_IN_MILLISECONDS
+
+            val uri = CalendarContract.Instances.CONTENT_URI.buildUpon()
+                .appendPath(now.toString())
+                .appendPath(endTime.toString())
+                .build()
+
+            val projection = arrayOf(CalendarContract.Events.CALENDAR_ID)
+
+            context.contentResolver.query(uri, projection, null, null, null)?.use { cursor ->
+                while (cursor.moveToNext()) {
+                    val calendarId = cursor.getLong(0)
+                    counts[calendarId] = (counts[calendarId] ?: 0) + 1
+                }
+            }
+
+            DevLog.info(LOG_TAG, "getUpcomingEventCountsByCalendar: found events in ${counts.size} calendars")
+        } catch (ex: SecurityException) {
+            DevLog.error(LOG_TAG, "getUpcomingEventCountsByCalendar: SecurityException ${ex.message}")
+        }
+
+        return counts
+    }
 }
diff --git a/android/app/src/main/java/com/github/quarck/calnotify/calendar/CalendarProviderInterface.kt b/android/app/src/main/java/com/github/quarck/calnotify/calendar/CalendarProviderInterface.kt
@@ -83,4 +83,6 @@ interface CalendarProviderInterface {
     fun getCalendarBackupInfo(context: Context, calendarId: Long): CalendarBackupInfo?
 
     fun findMatchingCalendarId(context: Context, backupInfo: CalendarBackupInfo): Long
+
+    fun getUpcomingEventCountsByCalendar(context: Context, daysAhead: Int = 7): Map<Long, Int>
 }
diff --git a/android/app/src/main/java/com/github/quarck/calnotify/prefs/CalendarsActivity.kt b/android/app/src/main/java/com/github/quarck/calnotify/prefs/CalendarsActivity.kt
@@ -1,6 +1,7 @@
 //
 //   Calendar Notifications Plus
 //   Copyright (C) 2016 Sergey Parshin (s.parshin.sc@gmail.com)
+//   Copyright (C) 2025 William Harris (wharris+cnplus@upscalews.com)
 //
 //   This program is free software; you can redistribute it and/or modify
 //   it under the terms of the GNU General Public License as published by
@@ -18,26 +19,34 @@
 //
 package com.github.quarck.calnotify.prefs
 
+import android.content.ActivityNotFoundException
+import android.content.ContentResolver
 import android.content.Context
+import android.content.Intent
 import android.graphics.drawable.ColorDrawable
 import android.os.Bundle
-import androidx.appcompat.app.AppCompatActivity
-import androidx.recyclerview.widget.RecyclerView
-import androidx.recyclerview.widget.StaggeredGridLayoutManager
-import androidx.appcompat.widget.Toolbar
+import android.provider.CalendarContract
+import android.provider.Settings
 import android.view.LayoutInflater
+import android.view.Menu
+import android.view.MenuItem
 import android.view.View
 import android.view.ViewGroup
 import android.widget.CheckBox
 import android.widget.LinearLayout
 import android.widget.TextView
+import androidx.appcompat.app.AlertDialog
+import androidx.appcompat.app.AppCompatActivity
+import androidx.appcompat.widget.Toolbar
+import androidx.recyclerview.widget.RecyclerView
+import androidx.recyclerview.widget.StaggeredGridLayoutManager
+import androidx.swiperefreshlayout.widget.SwipeRefreshLayout
 import com.github.quarck.calnotify.Consts
 import com.github.quarck.calnotify.R
-import com.github.quarck.calnotify.Settings
+import com.github.quarck.calnotify.Settings as AppSettings
 import com.github.quarck.calnotify.calendar.CalendarProvider
 import com.github.quarck.calnotify.calendar.CalendarRecord
 import com.github.quarck.calnotify.logs.DevLog
-//import com.github.quarck.calnotify.logs.Logger
 import com.github.quarck.calnotify.utils.background
 import com.github.quarck.calnotify.utils.find
 import com.github.quarck.calnotify.utils.findOrThrow
@@ -48,7 +57,8 @@ class CalendarListEntry(
         val type: CalendarListEntryType,
         val headerTitle: String? = null,
         val calendar: CalendarRecord? = null,
-        var isHandled: Boolean = true
+        var isHandled: Boolean = true,
+        val upcomingEventCount: Int = 0
 )
 
 
@@ -113,7 +123,14 @@ class CalendarListAdapter(val context: Context, var entries: Array<CalendarListE
                 }
 
                 CalendarListEntryType.Calendar -> {
-                    holder.checkboxCalendarName.text = entry.calendar?.name ?: ""
+                    val calendarName = entry.calendar?.name ?: ""
+                    // Show upcoming event count for unhandled calendars with events
+                    val displayText = if (!entry.isHandled && entry.upcomingEventCount > 0) {
+                        context.getString(R.string.calendar_name_with_event_count, calendarName, entry.upcomingEventCount)
+                    } else {
+                        calendarName
+                    }
+                    holder.checkboxCalendarName.text = displayText
                     holder.calendarAccountName.visibility = View.GONE
                     holder.calendarEntryLayout.visibility = View.VISIBLE
                     holder.colorView.background = ColorDrawable(entry.calendar?.color ?: Consts.DEFAULT_CALENDAR_EVENT_COLOR)
@@ -142,8 +159,9 @@ class CalendarsActivity : AppCompatActivity() {
     private lateinit var staggeredLayoutManager: StaggeredGridLayoutManager
     private lateinit var recyclerView: RecyclerView
     private lateinit var noCalendarsText: TextView
+    private lateinit var swipeRefreshLayout: SwipeRefreshLayout
 
-    private lateinit var settings: Settings
+    private lateinit var settings: AppSettings
 
     override fun onCreate(savedInstanceState: Bundle?) {
         super.onCreate(savedInstanceState)
@@ -155,7 +173,7 @@ class CalendarsActivity : AppCompatActivity() {
         supportActionBar?.setDisplayHomeAsUpEnabled(true)
         supportActionBar?.setDisplayShowHomeEnabled(true)
 
-        settings = Settings(this)
+        settings = AppSettings(this)
 
         adapter = CalendarListAdapter(this, arrayOf<CalendarListEntry>())
 
@@ -172,53 +190,126 @@ class CalendarsActivity : AppCompatActivity() {
         recyclerView.adapter = adapter;
 
         noCalendarsText = findOrThrow<TextView>(R.id.no_calendars_text)
+
+        swipeRefreshLayout = findOrThrow<SwipeRefreshLayout>(R.id.swipe_refresh_calendars)
+        swipeRefreshLayout.setOnRefreshListener {
+            requestCalendarSyncAndRefresh()
+        }
     }
 
-    override fun onResume() {
-        super.onResume()
+    override fun onCreateOptionsMenu(menu: Menu): Boolean {
+        menuInflater.inflate(R.menu.menu_calendars, menu)
+        return true
+    }
 
-        background {
-            // load the data here
-            val calendars = CalendarProvider.getCalendars(this).toTypedArray()
-
-            val entries = mutableListOf<CalendarListEntry>()
-
-            // Arrange entries by accountName calendar
-            for ((accountName, type) in calendars.map { Pair(it.accountName, it.accountType) }.toSet()) {
-
-                // Add group title
-                entries.add(CalendarListEntry(type = CalendarListEntryType.Header, headerTitle = accountName))
-
-                // Add all the calendars for this accountName
-                entries.addAll(
-                        calendars
-                                .filter { it.accountName == accountName && it.accountType == type }
-                                .sortedBy { it.calendarId }
-                                .map {
-                                    CalendarListEntry(
-                                            type = CalendarListEntryType.Calendar,
-                                            calendar = it,
-                                            isHandled = settings.getCalendarIsHandled(it.calendarId))
-                                })
-
-                // Add a divider
-                entries.add(CalendarListEntry(type = CalendarListEntryType.Divider))
+    override fun onOptionsItemSelected(item: MenuItem): Boolean {
+        return when (item.itemId) {
+            R.id.action_refresh_calendars -> {
+                swipeRefreshLayout.isRefreshing = true
+                requestCalendarSyncAndRefresh()
+                true
+            }
+            R.id.action_calendar_sync_help -> {
+                showCalendarSyncHelp()
+                true
             }
+            else -> super.onOptionsItemSelected(item)
+        }
+    }
 
-            // remove last divider
-            if (entries.size >= 1 && entries[entries.size - 1].type == CalendarListEntryType.Divider)
-                entries.removeAt(entries.size - 1)
+    private fun requestCalendarSyncAndRefresh() {
+        background {
+            try {
+                val extras = Bundle().apply {
+                    putBoolean(ContentResolver.SYNC_EXTRAS_MANUAL, true)
+                    putBoolean(ContentResolver.SYNC_EXTRAS_EXPEDITED, true)
+                }
+                ContentResolver.requestSync(null, CalendarContract.AUTHORITY, extras)
+                DevLog.info(LOG_TAG, "Requested calendar sync")
 
-            val entriesFinal = entries.toTypedArray()
+                // Wait for sync to start/complete
+                Thread.sleep(SYNC_WAIT_MS)
+            } catch (ex: SecurityException) {
+                DevLog.error(LOG_TAG, "SecurityException requesting sync: ${ex.message}")
+            }
 
-            runOnUiThread {
-                // update activity finally
+            loadCalendars()
 
-                noCalendarsText.visibility = if (entriesFinal.isNotEmpty()) View.GONE else View.VISIBLE
+            runOnUiThread {
+                swipeRefreshLayout.isRefreshing = false
+            }
+        }
+    }
 
-                adapter.entries = entriesFinal
-                adapter.notifyDataSetChanged();
+    private fun showCalendarSyncHelp() {
+        AlertDialog.Builder(this)
+            .setTitle(R.string.calendar_sync_help_title)
+            .setMessage(R.string.calendar_sync_help_message)
+            .setPositiveButton(android.R.string.ok, null)
+            .setNeutralButton(R.string.open_sync_settings) { _, _ ->
+                openSyncSettings()
             }
+            .show()
+    }
+
+    private fun openSyncSettings() {
+        try {
+            val intent = Intent(Settings.ACTION_SYNC_SETTINGS)
+            startActivity(intent)
+        } catch (ex: ActivityNotFoundException) {
+            DevLog.error(LOG_TAG, "Could not open sync settings: ${ex.message}")
+            startActivity(Intent(Settings.ACTION_SETTINGS))
+        }
+    }
+
+    private fun loadCalendars() {
+        val calendars = CalendarProvider.getCalendars(this).toTypedArray()
+        val upcomingCounts = CalendarProvider.getUpcomingEventCountsByCalendar(this, UPCOMING_EVENTS_DAYS)
+
+        val entries = mutableListOf<CalendarListEntry>()
+
+        // Arrange entries by accountName calendar
+        for ((accountName, type) in calendars.map { Pair(it.accountName, it.accountType) }.toSet()) {
+
+            // Add group title
+            entries.add(CalendarListEntry(type = CalendarListEntryType.Header, headerTitle = accountName))
+
+            // Add all the calendars for this accountName
+            entries.addAll(
+                    calendars
+                            .filter { it.accountName == accountName && it.accountType == type }
+                            .sortedBy { it.calendarId }
+                            .map {
+                                CalendarListEntry(
+                                        type = CalendarListEntryType.Calendar,
+                                        calendar = it,
+                                        isHandled = settings.getCalendarIsHandled(it.calendarId),
+                                        upcomingEventCount = upcomingCounts[it.calendarId] ?: 0)
+                            })
+
+            // Add a divider
+            entries.add(CalendarListEntry(type = CalendarListEntryType.Divider))
+        }
+
+        // remove last divider
+        if (entries.size >= 1 && entries[entries.size - 1].type == CalendarListEntryType.Divider)
+            entries.removeAt(entries.size - 1)
+
+        val entriesFinal = entries.toTypedArray()
+
+        runOnUiThread {
+            noCalendarsText.visibility = if (entriesFinal.isNotEmpty()) View.GONE else View.VISIBLE
+
+            adapter.entries = entriesFinal
+            adapter.notifyDataSetChanged();
+        }
+    }
+
+    override fun onResume() {
+        super.onResume()
+
+        background {
+            loadCalendars()
         }
     }
 
@@ -229,5 +320,7 @@ class CalendarsActivity : AppCompatActivity() {
 
     companion object {
         private const val LOG_TAG = "CalendarsActivity"
+        private const val SYNC_WAIT_MS = 2000L
+        private const val UPCOMING_EVENTS_DAYS = 7
     }
 }
diff --git a/android/app/src/main/res/drawable/ic_refresh_white_24dp.xml b/android/app/src/main/res/drawable/ic_refresh_white_24dp.xml
@@ -0,0 +1,10 @@
+<vector xmlns:android="http://schemas.android.com/apk/res/android"
+    android:width="24dp"
+    android:height="24dp"
+    android:viewportWidth="24"
+    android:viewportHeight="24"
+    android:tint="?attr/colorControlNormal">
+    <path
+        android:fillColor="@android:color/white"
+        android:pathData="M17.65,6.35C16.2,4.9 14.21,4 12,4c-4.42,0 -7.99,3.58 -7.99,8s3.57,8 7.99,8c3.73,0 6.84,-2.55 7.73,-6h-2.08c-0.82,2.33 -3.04,4 -5.65,4 -3.31,0 -6,-2.69 -6,-6s2.69,-6 6,-6c1.66,0 3.14,0.69 4.22,1.78L13,11h7V4l-2.35,2.35z"/>
+</vector>
diff --git a/android/app/src/main/res/layout/content_calendars.xml b/android/app/src/main/res/layout/content_calendars.xml
@@ -11,11 +11,18 @@
         tools:showIn="@layout/activity_calendars"
 	>
 
-    <androidx.recyclerview.widget.RecyclerView
-        android:id="@+id/list_calendars"
+    <androidx.swiperefreshlayout.widget.SwipeRefreshLayout
+        android:id="@+id/swipe_refresh_calendars"
         android:layout_width="match_parent"
-        android:layout_height="match_parent"
-        android:background="@color/cardview_light_background" />
+        android:layout_height="match_parent">
+
+        <androidx.recyclerview.widget.RecyclerView
+            android:id="@+id/list_calendars"
+            android:layout_width="match_parent"
+            android:layout_height="match_parent"
+            android:background="@color/cardview_light_background" />
+
+    </androidx.swiperefreshlayout.widget.SwipeRefreshLayout>
 
 	<TextView
 		android:id="@+id/no_calendars_text"
diff --git a/android/app/src/main/res/menu/menu_calendars.xml b/android/app/src/main/res/menu/menu_calendars.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" encoding="utf-8"?>
+<menu
+    xmlns:android="http://schemas.android.com/apk/res/android"
+    xmlns:app="http://schemas.android.com/apk/res-auto"
+    xmlns:tools="http://schemas.android.com/tools"
+    tools:context=".prefs.CalendarsActivity">
+
+    <item
+        android:id="@+id/action_refresh_calendars"
+        android:icon="@drawable/ic_refresh_white_24dp"
+        android:orderInCategory="100"
+        android:title="@string/refresh_calendars"
+        app:showAsAction="ifRoom" />
+
+    <item
+        android:id="@+id/action_calendar_sync_help"
+        android:orderInCategory="200"
+        android:title="@string/calendar_sync_help"
+        app:showAsAction="never" />
+
+</menu>
diff --git a/android/app/src/main/res/values/strings.xml b/android/app/src/main/res/values/strings.xml
@@ -624,4 +624,14 @@
 
     <!-- Bluetooth Permission (Car Mode) -->
     <string name="bluetooth_permission_required">Bluetooth permission is required to configure Car Mode devices</string>
+
+    <!-- Calendar Sync Refresh -->
+    <string name="refresh_calendars">Refresh calendars</string>
+    <string name="calendar_sync_help">Troubleshoot missing calendars</string>
+    <string name="calendar_sync_help_title">Missing calendars?</string>
+    <string name="calendar_sync_help_message">If some calendars aren\'t showing:\n\n1. Pull down to refresh this list\n\n2. Check that calendar sync is enabled in Android Settings → Accounts → Google → Calendar\n\n3. Open the Google Calendar app and verify your calendars appear there\n\n4. If calendars still don\'t appear, try restarting your device</string>
+    <string name="open_sync_settings">Open Sync Settings</string>
+
+    <!-- Unhandled Calendar Event Count -->
+    <string name="calendar_name_with_event_count">%1$s (%2$d upcoming)</string>
 </resources>
diff --git a/android/app/src/test/java/com/github/quarck/calnotify/prefs/CalendarsActivityRobolectricTest.kt b/android/app/src/test/java/com/github/quarck/calnotify/prefs/CalendarsActivityRobolectricTest.kt
diff --git a/android/app/src/test/java/com/github/quarck/calnotify/testutils/MockCalendarProvider.kt b/android/app/src/test/java/com/github/quarck/calnotify/testutils/MockCalendarProvider.kt
diff --git a/docs/dev_todo/calendar_sync_refresh.md b/docs/dev_todo/calendar_sync_refresh.md
diff --git a/docs/dev_todo/unhandled_calendar_event_count.md b/docs/dev_todo/unhandled_calendar_event_count.md

Original file line number	Diff line number	Diff line change
`@@ -124,6 +124,10 @@ class MockCalendarProvider(`
`124`	`124`	`DevLog.info(LOG_TAG, "Delegating updateEvent to real implementation: eventId=$eventId, calendarId=$calendarId")`
`125`	`125`	`callOriginal()`
`126`	`126`	`}`
	`127`	`+`
	`128`	`+ every { CalendarProvider.getUpcomingEventCountsByCalendar(any(), any()) } answers {`
	`129`	`+ callOriginal()`
	`130`	`+ }`
`127`	`131`	`}`
`128`	`132`
`129`	`133`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -83,4 +83,6 @@ interface CalendarProviderInterface {`
`83`	`83`	`fun getCalendarBackupInfo(context: Context, calendarId: Long): CalendarBackupInfo?`
`84`	`84`
`85`	`85`	`fun findMatchingCalendarId(context: Context, backupInfo: CalendarBackupInfo): Long`
	`86`	`+`
	`87`	`+ fun getUpcomingEventCountsByCalendar(context: Context, daysAhead: Int = 7): Map<Long, Int>`
`86`	`88`	`}`