feat(gui): Conditionally hide the Landscape Config page based on registry

gui/packages/ubuntupro/integration_test/ubuntu_pro_for_wsl_test.dart

@@ -47,7 +47,7 @@ void main() {
       overrides: {
         'USERPROFILE': tmpHome!.path,
         'LOCALAPPDATA': tmpLocalAppData!.path,
-        'UP4W_ALLOW_STORE_PURCHASE': '1',
+        'UP4W_INTEGRATION_TESTING': 'true',
       },
     );
   });

gui/packages/ubuntupro/lib/app.dart

@@ -9,15 +9,17 @@ import 'package:yaru/yaru.dart';
 import 'core/agent_api_client.dart';
 import 'core/agent_connection.dart';
 import 'core/agent_monitor.dart';
+import 'core/settings.dart';
 import 'pages/landscape/landscape_page.dart';
 import 'pages/startup/startup_page.dart';
 import 'pages/subscribe_now/subscribe_now_page.dart';
 import 'pages/subscription_status/subscription_status_page.dart';
 import 'routes.dart';
 
 class Pro4WSLApp extends StatelessWidget {
-  const Pro4WSLApp(this.agentMonitor, {super.key});
+  const Pro4WSLApp(this.agentMonitor, this.settings, {super.key});
   final AgentStartupMonitor agentMonitor;
+  final Settings settings;
 
   @override
   Widget build(BuildContext context) {
@@ -62,6 +64,7 @@ class Pro4WSLApp extends StatelessWidget {
                   ),
                   Routes.subscribeNow: WizardRoute(
                     builder: SubscribeNowPage.create,
+                    userData: settings.isStorePurchaseAllowed,
                     onNext: (_) {
                       final src = context.read<ValueNotifier<ConfigSources>>();
                       final landscape = src.value.landscapeSource;
@@ -72,19 +75,29 @@ class Pro4WSLApp extends StatelessWidget {
                       return null;
                     },
                   ),
-                  Routes.configureLandscape:
-                      const WizardRoute(builder: LandscapePage.create),
-                  Routes.subscriptionStatus: WizardRoute(
-                    builder: SubscriptionStatusPage.create,
-                    onReplace: (_) => Routes.subscribeNow,
-                    onBack: (_) => Routes.subscribeNow,
-                  ),
-                  Routes.configureLandscapeLate: WizardRoute(
-                    builder: (context) => LandscapePage.create(
-                      context,
-                      isLate: true,
+                  if (settings.isLandscapeConfigurationEnabled) ...{
+                    Routes.configureLandscape:
+                        const WizardRoute(builder: LandscapePage.create),
+                    Routes.subscriptionStatus: WizardRoute(
+                      builder: SubscriptionStatusPage.create,
+                      onReplace: (_) => Routes.subscribeNow,
+                      onBack: (_) => Routes.subscribeNow,
+                      userData: true,
                     ),
-                  ),
+                    Routes.configureLandscapeLate: WizardRoute(
+                      builder: (context) => LandscapePage.create(
+                        context,
+                        isLate: true,
+                      ),
+                    ),
+                  } else ...{
+                    Routes.subscriptionStatus: WizardRoute(
+                      builder: SubscriptionStatusPage.create,
+                      onReplace: (_) => Routes.subscribeNow,
+                      onBack: (_) => Routes.subscribeNow,
+                      userData: false,
+                    ),
+                  },
                 },
               );
             },

gui/packages/ubuntupro/lib/core/settings.dart

@@ -0,0 +1,82 @@
+import 'package:flutter/foundation.dart';
+import 'package:win32/win32.dart';
+import 'package:win32_registry/win32_registry.dart';
+
+/// Manages the settings for the user interface.
+class Settings {
+  /// Creates a new instance of [Settings] initialized with options read from [repository],
+  /// which is loaded, read from and closed.
+  Settings(SettingsRepository repository) {
+    if (!repository.load()) return;
+
+    final purchase = repository.readInt(kAllowStorePurchase) == 1
+        ? Options.withStorePurchase
+        : Options.none;
+    final landscape = repository.readInt(kShowLandscapeConfig) == 1
+        ? Options.withLandscapeConfiguration
+        : Options.none;
+
+    repository.close();
+
+    _options = purchase | landscape;
+  }
+
+  /// Creates a new instance of [Settings] with the specified [options], thus no need to read from the repository.
+  /// Useful for integration testing.
+  Settings.withOptions(this._options);
+
+  Options _options = Options.none;
+
+  bool get isLandscapeConfigurationEnabled =>
+      _options & Options.withLandscapeConfiguration;
+  bool get isStorePurchaseAllowed => _options & Options.withStorePurchase;
+
+// constants for the key names only exposed for testing.
+  @visibleForTesting
+  static const kAllowStorePurchase = 'AllowStorePurchase';
+  @visibleForTesting
+  static const kShowLandscapeConfig = 'ShowLandscapeConfig';
+}
+
+/// Settings options modelled as an enum with bitwise operations, i.e. flags.
+enum Options {
+  none(0x00),
+  withLandscapeConfiguration(0x01),
+  withStorePurchase(0x02),
+  // all optionss above or'ed.
+  withAll(0x03);
+
+  final int options;
+  const Options(this.options);
+  factory Options._fromInt(int options) =>
+      Options.values.firstWhere((e) => e.options == options);
+
+  bool operator &(Options other) => options & other.options != 0;
+  Options operator |(Options other) =>
+      Options._fromInt(options | other.options);
+}
+
+// "Abstracts" reading the settings storage (a.k.a the Windows registry).
+class SettingsRepository {
+  RegistryKey? _key;
+
+  void close() => _key?.close();
+  int? readInt(String name) {
+    if (_key == null) return null;
+    return _key!.getValueAsInt(name);
+  }
+
+  bool load() {
+    try {
+      _key = Registry.openPath(RegistryHive.currentUser, path: _keyPath);
+      return true;
+    } on WindowsException {
+      // missing key is not an error since we expect them to be set in very few cases.
+      // TODO: Log error cases other than ERROR_FILE_NOT_FOUND.
+      return false;
+    }
+  }
+}
+
+// The registry key we want to read from.
+const _keyPath = r'SOFTWARE\Canonical\UbuntuPro\';

gui/packages/ubuntupro/lib/main.dart

@@ -6,6 +6,8 @@ import 'app.dart';
 import 'constants.dart';
 import 'core/agent_api_client.dart';
 import 'core/agent_monitor.dart';
+import 'core/environment.dart';
+import 'core/settings.dart';
 import 'launch_agent.dart';
 
 Future<void> main() async {
@@ -20,7 +22,12 @@ Future<void> main() async {
     clientFactory: AgentApiClient.new,
     onClient: registerServiceInstance<AgentApiClient>,
   );
-  runApp(Pro4WSLApp(agentMonitor));
+
+  final settings = Environment()['UP4W_INTEGRATION_TESTING'] != null
+      ? Settings.withOptions(Options.withAll)
+      : Settings(SettingsRepository());
+
+  runApp(Pro4WSLApp(agentMonitor, settings));
 }
 
 Future<bool> launch() => launchAgent(kAgentRelativePath);

gui/packages/ubuntupro/lib/pages/landscape/landscape_page.dart

@@ -131,7 +131,7 @@ class LandscapeInput extends StatelessWidget {
           ],
         ),
         const SizedBox(
-          height: 32.0,
+          height: 16.0,
         ),
         Row(
           crossAxisAlignment: CrossAxisAlignment.start,
@@ -314,7 +314,7 @@ class _FileFormState extends State<_FileForm> {
           style: widget.sectionBodyStyle,
         ),
         const SizedBox(
-          height: 16.0,
+          height: 8.0,
         ),
         Row(
           crossAxisAlignment: CrossAxisAlignment.start,

gui/packages/ubuntupro/lib/pages/subscribe_now/subscribe_now_model.dart

@@ -4,13 +4,13 @@ import 'package:flutter/foundation.dart';
 import 'package:p4w_ms_store/p4w_ms_store.dart';
 import 'package:url_launcher/url_launcher.dart';
 import '/core/agent_api_client.dart';
-import '/core/environment.dart';
 import '/core/pro_token.dart';
 
 class SubscribeNowModel {
   final AgentApiClient client;
-  bool? _isPurchaseAllowed;
-  SubscribeNowModel(this.client);
+  final bool _isPurchaseAllowed;
+  SubscribeNowModel(this.client, {bool isPurchaseAllowed = false})
+      : _isPurchaseAllowed = isPurchaseAllowed;
 
   Future<SubscriptionInfo> applyProToken(ProToken token) {
     return client.applyProToken(token.value);
@@ -43,8 +43,5 @@ class SubscribeNowModel {
   /// Returns true if the environment variable 'UP4W_ALLOW_STORE_PURCHASE' has been set.
   /// Since this reading won't change during the app lifetime, even if the user changes
   /// it's value from outside, the value is cached so we don't check the environment more than once.
-  bool purchaseAllowed() {
-    return _isPurchaseAllowed ??= ['true', '1', 'on']
-        .contains(Environment()['UP4W_ALLOW_STORE_PURCHASE']?.toLowerCase());
-  }
+  bool get purchaseAllowed => _isPurchaseAllowed;
 }

gui/packages/ubuntupro/lib/pages/subscribe_now/subscribe_now_page.dart

@@ -31,11 +31,10 @@ class SubscribeNowPage extends StatelessWidget {
           mainAxisAlignment: MainAxisAlignment.start,
           children: [
             Tooltip(
-              message: model.purchaseAllowed()
-                  ? ''
-                  : lang.subscribeNowTooltipDisabled,
+              message:
+                  model.purchaseAllowed ? '' : lang.subscribeNowTooltipDisabled,
               child: ElevatedButton(
-                onPressed: model.purchaseAllowed()
+                onPressed: model.purchaseAllowed
                     ? () async {
                         final subs = await model.purchaseSubscription();
 
@@ -99,8 +98,14 @@ class SubscribeNowPage extends StatelessWidget {
 
   static Widget create(BuildContext context) {
     final client = getService<AgentApiClient>();
+    final storePurchaseIsAllowed =
+        Wizard.of(context).routeData as bool? ?? false;
+
     return Provider<SubscribeNowModel>(
-      create: (context) => SubscribeNowModel(client),
+      create: (context) => SubscribeNowModel(
+        client,
+        isPurchaseAllowed: storePurchaseIsAllowed,
+      ),
       child: SubscribeNowPage(
         onSubscriptionUpdate: (info) {
           final src = context.read<ValueNotifier<ConfigSources>>();

gui/packages/ubuntupro/lib/pages/subscription_status/subscription_status_model.dart

@@ -8,27 +8,37 @@ sealed class SubscriptionStatusModel {
   /// Returns the appropriate view-model subclass based on the subscription source type that was passed.
   factory SubscriptionStatusModel(
     ConfigSources src,
-    AgentApiClient client,
-  ) {
+    AgentApiClient client, {
+    bool canConfigureLandscape = false,
+  }) {
+    // Enforce this business logic here, as defaults may change in the future:
+    //   - Org-managed Landscape configurations don't allow user changes via GUI.
+    if (src.landscapeSource.hasOrganization()) {
+      canConfigureLandscape = false;
+    }
+
     final info = src.proSubscription;
     switch (info.whichSubscriptionType()) {
       case SubscriptionType.organization:
-        return OrgSubscriptionStatusModel(src);
+        return OrgSubscriptionStatusModel()
+          .._canConfigureLandscape = canConfigureLandscape;
       case SubscriptionType.user:
-        return UserSubscriptionStatusModel(src, client);
+        return UserSubscriptionStatusModel(client)
+          .._canConfigureLandscape = canConfigureLandscape;
       case SubscriptionType.microsoftStore:
-        return StoreSubscriptionStatusModel(src, info.productId);
+        return StoreSubscriptionStatusModel(info.productId)
+          .._canConfigureLandscape = canConfigureLandscape;
       case SubscriptionType.none:
       case SubscriptionType.notSet:
         throw UnimplementedError('Unknown subscription type');
     }
   }
 
-  SubscriptionStatusModel._(ConfigSources src)
-      : _canConfigureLandscape = !src.landscapeSource.hasOrganization();
+  SubscriptionStatusModel._();
 
-  final bool _canConfigureLandscape;
+  /// Tells whether we can invoke the Landscape configuration page or not.
   bool get canConfigureLandscape => _canConfigureLandscape;
+  bool _canConfigureLandscape = false;
 }
 
 /// Represents an active subscription through Microsoft Store.
@@ -37,7 +47,7 @@ class StoreSubscriptionStatusModel extends SubscriptionStatusModel {
   @visibleForTesting
   final Uri uri;
 
-  StoreSubscriptionStatusModel(super.src, String productID)
+  StoreSubscriptionStatusModel(String productID)
       : uri = Uri.https(
           'account.microsoft.com',
           '/services/${productID.toLowerCase()}/details#billing',
@@ -51,7 +61,7 @@ class StoreSubscriptionStatusModel extends SubscriptionStatusModel {
 /// Represents a subscription in which the user manually provided the Pro token.
 /// The only action supported is Pro-detaching all instances.
 class UserSubscriptionStatusModel extends SubscriptionStatusModel {
-  UserSubscriptionStatusModel(super.src, this._client) : super._();
+  UserSubscriptionStatusModel(this._client) : super._();
 
   final AgentApiClient _client;
 
@@ -62,5 +72,5 @@ class UserSubscriptionStatusModel extends SubscriptionStatusModel {
 /// Represents a subscription provided by the user's Organization.
 /// There is no action supported.
 class OrgSubscriptionStatusModel extends SubscriptionStatusModel {
-  OrgSubscriptionStatusModel(super.src) : super._();
+  OrgSubscriptionStatusModel() : super._();
 }

gui/packages/ubuntupro/lib/pages/subscription_status/subscription_status_page.dart

@@ -85,8 +85,14 @@ class SubscriptionStatusPage extends StatelessWidget {
   /// Initializes the view-model and inject it in the widget tree so the child page can access it via the BuildContext.
   static Widget create(BuildContext context) {
     final client = getService<AgentApiClient>();
+    final landscapeFeatureIsEnabled =
+        Wizard.of(context).routeData as bool? ?? false;
     return ProxyProvider<ValueNotifier<ConfigSources>, SubscriptionStatusModel>(
-      update: (context, src, _) => SubscriptionStatusModel(src.value, client),
+      update: (context, src, _) => SubscriptionStatusModel(
+        src.value,
+        client,
+        canConfigureLandscape: landscapeFeatureIsEnabled,
+      ),
       child: const SubscriptionStatusPage(),
     );
   }