Track consent explicitly.

Instead of relying on the location consent, track whether the user
has seen the consent screens explicitly.

This change includes a migration from the old mechanism to the new
one. To facilitate the migration, the version is bumped here.

Signed-off-by: Katharine Berry <ktbry@google.com>

Author: Katharine

app/package.json

@@ -1,7 +1,7 @@
 {
   "name": "Bobby",
   "author": "Rebble",
-  "version": "1.1.0",
+  "version": "1.2.0",
   "keywords": [
     "pebble-app"
   ],

app/src/c/assistant.c

@@ -30,7 +30,8 @@
 static RootWindow* s_root_window = NULL;
 
 static void prv_init(void) {
-  version_store_current();
+  version_init();
+  consent_migrate();
   settings_init();
   conversation_manager_init();
   events_app_message_open();

app/src/c/consent/consent.c

@@ -17,11 +17,13 @@
 #include "consent.h"
 #include "../util/persist_keys.h"
 #include "../util/style.h"
+#include "../version/version.h"
 #include "../root_window.h"
 
 #include <pebble.h>
 #include <pebble-events/pebble-events.h>
 
+
 #define STAGE_LLM_WARNING 0
 #define STAGE_GEMINI_CONSENT 1
 #define STAGE_LOCATION_CONSENT 2
@@ -51,6 +53,7 @@ static void prv_present_consent_menu(Window* window);
 static void prv_consent_menu_select_callback(ActionMenu *action_menu, const ActionMenuItem *action, void *context);
 static void prv_action_menu_close(ActionMenu* action_menu, const ActionMenuItem* item, void* context);
 static void prv_app_message_handler(DictionaryIterator *iter, void *context);
+static void prv_mark_consents_complete();
 
 void consent_window_push() {
   Window* window = window_create();
@@ -66,7 +69,24 @@ void consent_window_push() {
 }
 
 bool must_present_consent() {
-  return !persist_exists(PERSIST_KEY_LOCATION_ENABLED);
+  return persist_read_int(PERSIST_KEY_CONSENTS_COMPLETED) < 1;
+}
+
+void consent_migrate() {
+  if (version_is_updated() && !version_is_first_launch()) {
+    // If we're updating from version 1.1 or older, consent agreement was implied by LOCATION_ENABLED being set
+    // (either true or false).
+    if (version_info_compare(version_get_last_launch(), (VersionInfo) {1, 1}) <= 0) {
+      APP_LOG(APP_LOG_LEVEL_INFO, "Performing consent migration from version 1.1.");
+      // If the location enabled state is set, that's equivalent to consent agreement version 1.
+      if (persist_exists(PERSIST_KEY_LOCATION_ENABLED)) {
+        APP_LOG(APP_LOG_LEVEL_INFO, "Marking consent as 1.");;
+        persist_write_int(PERSIST_KEY_CONSENTS_COMPLETED, 1);
+      } else {
+        APP_LOG(APP_LOG_LEVEL_INFO, "Not marking consent.");;
+      }
+    }
+  }
 }
 
 static void prv_window_load(Window *window) {
@@ -242,6 +262,7 @@ static void prv_app_message_handler(DictionaryIterator *iter, void *context) {
   events_app_message_unsubscribe(data->app_message_handle);
   bool location_enabled = tuple->value->int16;
   persist_write_bool(PERSIST_KEY_LOCATION_ENABLED, location_enabled);
+  prv_mark_consents_complete();
   RootWindow *root_window = root_window_create();
   action_menu_set_result_window(data->action_menu, root_window_get_window(root_window));
   action_menu_close(data->action_menu, true);
@@ -251,3 +272,7 @@ static void prv_app_message_handler(DictionaryIterator *iter, void *context) {
 static void prv_action_menu_close(ActionMenu* action_menu, const ActionMenuItem* item, void* context) {
   action_menu_hierarchy_destroy(action_menu_get_root_level(action_menu), NULL, NULL);
 }
+
+static void prv_mark_consents_complete() {
+  persist_write_int(PERSIST_KEY_CONSENTS_COMPLETED, 1);
+}

app/src/c/consent/consent.h

@@ -21,5 +21,6 @@
 
 bool must_present_consent();
 void consent_window_push();
+void consent_migrate();
 
 #endif //APP_CONSENT_H

app/src/c/util/persist_keys.h

@@ -20,7 +20,7 @@
 // These keys are stored centrally so we can avoid accidental collisions.
 // Remember: these numbers can *never* be changed.
 
-// next key: 12
+// next key: 13
 
 // We write the alarm count twice - once before doing any work, and once after.
 // If they disagree we assume the lower number is correct.
@@ -34,6 +34,9 @@
 // Store whether we have successfully requested location consent.
 #define PERSIST_KEY_LOCATION_ENABLED 6
 
+// Store whether the user has accepted the consents
+#define PERSIST_KEY_CONSENTS_COMPLETED 12
+
 // Contains the version we were running the last time we were launched
 #define PERSIST_KEY_VERSION 7
 

app/src/c/version/version.c

@@ -25,18 +25,21 @@ extern const PebbleProcessInfo __pbl_app_info;
 
 static bool s_is_first_launch = false;
 static bool s_is_update = false;
+static VersionInfo s_last_launch;
 
-void version_store_current() {
+VersionInfo prv_read_last_launch();
+
+void version_init() {
     VersionInfo version_info = version_get_current();
-    VersionInfo last_version = version_get_last_launch();
-    s_is_first_launch = last_version.major == 0 && last_version.minor == 0;
-    if (version_info_compare(version_info, last_version) != 0) {
+    s_last_launch = prv_read_last_launch();
+    s_is_first_launch = s_last_launch.major == 0 && s_last_launch.minor == 0;
+    if (version_info_compare(version_info, s_last_launch) != 0) {
         s_is_update = true;
         int status = persist_write_data(PERSIST_KEY_VERSION, &version_info, sizeof(VersionInfo));
         if (status < 0) {
             APP_LOG(APP_LOG_LEVEL_ERROR, "Failed to write version info: %d", status);
         } else {
-            APP_LOG(APP_LOG_LEVEL_INFO, "Current version (v%d.%d) stored (previous: v%d.%d)", version_info.major, version_info.minor, last_version.major, last_version.minor);
+            APP_LOG(APP_LOG_LEVEL_INFO, "Current version (v%d.%d) stored (previous: v%d.%d)", version_info.major, version_info.minor, s_last_launch.major, s_last_launch.minor);
         }
     } else {
         APP_LOG(APP_LOG_LEVEL_DEBUG, "Version (v%d.%d) unchanged since last launch.", version_info.major, version_info.minor);
@@ -52,16 +55,7 @@ bool version_is_updated() {
 }
 
 VersionInfo version_get_last_launch() {
-    VersionInfo version_info;
-    int status = persist_read_data(PERSIST_KEY_VERSION, &version_info, sizeof(VersionInfo));
-    if (status < 0) {
-        APP_LOG(APP_LOG_LEVEL_WARNING, "Failed to read version info: %d", status);
-        return (VersionInfo) {
-            .major = 0,
-            .minor = 0,
-        };
-    }
-    return version_info;
+    return s_last_launch;
 }
 
 VersionInfo version_get_current() {
@@ -86,3 +80,16 @@ int version_info_compare(VersionInfo a, VersionInfo b) {
     }
     return 0;
 }
+
+VersionInfo prv_read_last_launch() {
+    VersionInfo version_info;
+    int status = persist_read_data(PERSIST_KEY_VERSION, &version_info, sizeof(VersionInfo));
+    if (status < 0) {
+        APP_LOG(APP_LOG_LEVEL_WARNING, "Failed to read version info: %d", status);
+        return (VersionInfo) {
+            .major = 0,
+            .minor = 0,
+        };
+    }
+    return version_info;
+}

app/src/c/version/version.h

@@ -24,7 +24,7 @@ typedef struct __attribute__((__packed__)) {
     uint8_t minor;
 } VersionInfo;
 
-void version_store_current();
+void version_init();
 bool version_is_first_launch();
 bool version_is_updated();
 VersionInfo version_get_last_launch();