From aa74f8594106c32b2fbd3e1f4f769fd75070b8eb Mon Sep 17 00:00:00 2001
From: Andrea Gottardo <andrea@gottardo.me>
Date: Fri, 4 Oct 2024 13:45:23 -0700
Subject: [PATCH] ui: hide commit hashes in user-facing version string

We currently show the full version number everywhere. This pointlessly causes confusion for users, and is only really useful for Tailscale employees. Let's show the marketing version everywhere instead.

Users can still tap on the version number to copy the full version string. The extended version is also available in the Android settings, when inspecting Tailscale from the Apps list.

Signed-off-by: Andrea Gottardo <andrea@gottardo.me>
---
 .../com/tailscale/ipn/ui/util/AppVersion.kt   | 20 +++++++++++++++++++
 .../com/tailscale/ipn/ui/view/AboutView.kt    |  8 +++++++-
 .../com/tailscale/ipn/ui/view/SettingsView.kt |  3 ++-
 3 files changed, 29 insertions(+), 2 deletions(-)
 create mode 100644 android/src/main/java/com/tailscale/ipn/ui/util/AppVersion.kt

diff --git a/android/src/main/java/com/tailscale/ipn/ui/util/AppVersion.kt b/android/src/main/java/com/tailscale/ipn/ui/util/AppVersion.kt
new file mode 100644
index 0000000000..fb042fb489
--- /dev/null
+++ b/android/src/main/java/com/tailscale/ipn/ui/util/AppVersion.kt
@@ -0,0 +1,20 @@
+// Copyright (c) Tailscale Inc & AUTHORS
+// SPDX-License-Identifier: BSD-3-Clause
+
+package com.tailscale.ipn.ui.util
+
+import com.tailscale.ipn.BuildConfig
+
+class AppVersion {
+  companion object {
+    // Returns the short version of the build version, which is what users typically expect.
+    // For instance, if the build version is "1.75.80-t8fdffb8da-g2daeee584df",
+    // this function returns "1.75.80".
+    fun Short(): String {
+      // Split the full version string by hyphen (-)
+      val parts = BuildConfig.VERSION_NAME.split("-")
+      // Return only the part before the first hyphen
+      return parts[0]
+    }
+  }
+}
diff --git a/android/src/main/java/com/tailscale/ipn/ui/view/AboutView.kt b/android/src/main/java/com/tailscale/ipn/ui/view/AboutView.kt
index 7640b6cc9d..fb0c098976 100644
--- a/android/src/main/java/com/tailscale/ipn/ui/view/AboutView.kt
+++ b/android/src/main/java/com/tailscale/ipn/ui/view/AboutView.kt
@@ -33,6 +33,7 @@ import com.tailscale.ipn.BuildConfig
 import com.tailscale.ipn.R
 import com.tailscale.ipn.ui.Links
 import com.tailscale.ipn.ui.theme.logoBackground
+import com.tailscale.ipn.ui.util.AppVersion
 
 @Composable
 fun AboutView(backToSettings: BackNavigation) {
@@ -69,9 +70,14 @@ fun AboutView(backToSettings: BackNavigation) {
                 Text(
                     modifier =
                         Modifier.clickable {
+                          // When users tap on the version number, the extended version string
+                          // (including commit hashes) is copied to the clipboard.
+                          // This may be useful for debugging purposes...
                           localClipboardManager.setText(AnnotatedString(BuildConfig.VERSION_NAME))
                         },
-                    text = "${stringResource(R.string.version)} ${BuildConfig.VERSION_NAME}",
+                    // ... but we always display the short version in the UI to avoid user
+                    // confusion.
+                    text = "${stringResource(R.string.version)} ${AppVersion.Short()}",
                     fontWeight = MaterialTheme.typography.bodyMedium.fontWeight,
                     fontSize = MaterialTheme.typography.bodyMedium.fontSize)
               }
diff --git a/android/src/main/java/com/tailscale/ipn/ui/view/SettingsView.kt b/android/src/main/java/com/tailscale/ipn/ui/view/SettingsView.kt
index d83f50d8ff..c4254177f7 100644
--- a/android/src/main/java/com/tailscale/ipn/ui/view/SettingsView.kt
+++ b/android/src/main/java/com/tailscale/ipn/ui/view/SettingsView.kt
@@ -39,6 +39,7 @@ import com.tailscale.ipn.ui.viewModel.SettingsNav
 import com.tailscale.ipn.ui.viewModel.SettingsViewModel
 import com.tailscale.ipn.ui.viewModel.VpnViewModel
 import com.tailscale.ipn.ui.notifier.Notifier
+import com.tailscale.ipn.ui.util.AppVersion
 
 @Composable
 fun SettingsView(settingsNav: SettingsNav, viewModel: SettingsViewModel = viewModel(), vpnViewModel: VpnViewModel = viewModel()) {
@@ -112,7 +113,7 @@ fun SettingsView(settingsNav: SettingsNav, viewModel: SettingsViewModel = viewMo
           Lists.ItemDivider()
           Setting.Text(
               R.string.about_tailscale,
-              subtitle = "${stringResource(id = R.string.version)} ${BuildConfig.VERSION_NAME}",
+              subtitle = "${stringResource(id = R.string.version)} ${AppVersion.Short()}",
               onClick = settingsNav.onNavigateToAbout)
 
           // TODO: put a heading for the debug section