From 910f9bbcdb7db7b67749d77bb19eea66d7ed2a39 Mon Sep 17 00:00:00 2001
From: Richard Tibbles <richard@learningequality.org>
Date: Thu, 19 Dec 2024 09:20:36 -0800
Subject: [PATCH] Remove use of checkCapability function in favour of more
 explicit checks.

---
 .../src/views/DeviceSettingsPage/index.vue    |  4 +--
 kolibri/plugins/device/kolibri_plugin.py      |  2 ++
 .../MeteredConnectionNotificationModal.vue    |  7 +++--
 .../assets/src/views/LibraryPage/index.vue    | 11 ++++----
 kolibri/plugins/learn/kolibri_plugin.py       |  2 ++
 .../assets/src/machines/wizardMachine.js      | 16 +++++++----
 .../assets/src/views/SetupWizardIndex.vue     | 11 ++++++--
 .../onboarding-forms/SettingUpKolibri.vue     | 11 ++++++--
 .../plugins/setup_wizard/kolibri_plugin.py    |  5 +++-
 .../utils/checkMeteredConnection.js           | 12 ++++++++
 packages/kolibri/utils/appCapabilities.js     | 28 -------------------
 11 files changed, 58 insertions(+), 51 deletions(-)
 rename {packages/kolibri-common/components => kolibri/plugins/learn/assets/src/views/LibraryPage}/MeteredConnectionNotificationModal.vue (95%)
 create mode 100644 packages/kolibri-common/utils/checkMeteredConnection.js

diff --git a/kolibri/plugins/device/assets/src/views/DeviceSettingsPage/index.vue b/kolibri/plugins/device/assets/src/views/DeviceSettingsPage/index.vue
index d0912e9dda2..45a4d549889 100644
--- a/kolibri/plugins/device/assets/src/views/DeviceSettingsPage/index.vue
+++ b/kolibri/plugins/device/assets/src/views/DeviceSettingsPage/index.vue
@@ -378,12 +378,12 @@
   import urls from 'kolibri/urls';
   import logger from 'kolibri-logging';
   import { ref, watch } from 'vue';
+  import pluginData from 'kolibri-plugin-data';
   import commonCoreStrings from 'kolibri/uiText/commonCoreStrings';
   import UiAlert from 'kolibri-design-system/lib/keen/UiAlert';
   import { availableLanguages, currentLanguage, sortLanguages } from 'kolibri/utils/i18n';
   import BottomAppBar from 'kolibri/components/BottomAppBar';
   import useKResponsiveWindow from 'kolibri-design-system/lib/composables/useKResponsiveWindow';
-  import { checkCapability } from 'kolibri/utils/appCapabilities';
   import useUser from 'kolibri/composables/useUser';
   import useSnackbar from 'kolibri/composables/useSnackbar';
   import commonDeviceStrings from '../commonDeviceStrings';
@@ -603,7 +603,7 @@
         }
       },
       canCheckMeteredConnection() {
-        return checkCapability('check_is_metered');
+        return pluginData.canCheckMeteredConnection;
       },
       showDisabledAlert() {
         return this.isRemoteContent || !this.canRestart;
diff --git a/kolibri/plugins/device/kolibri_plugin.py b/kolibri/plugins/device/kolibri_plugin.py
index 9945202c4d3..af5cda87131 100644
--- a/kolibri/plugins/device/kolibri_plugin.py
+++ b/kolibri/plugins/device/kolibri_plugin.py
@@ -1,4 +1,5 @@
 from kolibri.core.auth.constants.user_kinds import SUPERUSER
+from kolibri.core.device.hooks import CheckIsMeteredHook
 from kolibri.core.hooks import NavigationHook
 from kolibri.core.hooks import RoleBasedRedirectHook
 from kolibri.core.webpack.hooks import WebpackBundleHook
@@ -28,6 +29,7 @@ def plugin_data(self):
         return {
             "isRemoteContent": OPTIONS["Deployment"]["REMOTE_CONTENT"],
             "canRestart": bool(OPTIONS["Deployment"]["RESTART_HOOKS"]),
+            "canCheckMeteredConnection": CheckIsMeteredHook.is_registered,
             "deprecationWarnings": {
                 "ie11": any_ie11_users(),
             },
diff --git a/packages/kolibri-common/components/MeteredConnectionNotificationModal.vue b/kolibri/plugins/learn/assets/src/views/LibraryPage/MeteredConnectionNotificationModal.vue
similarity index 95%
rename from packages/kolibri-common/components/MeteredConnectionNotificationModal.vue
rename to kolibri/plugins/learn/assets/src/views/LibraryPage/MeteredConnectionNotificationModal.vue
index 9e83bdc511b..6b53cc1828e 100644
--- a/packages/kolibri-common/components/MeteredConnectionNotificationModal.vue
+++ b/kolibri/plugins/learn/assets/src/views/LibraryPage/MeteredConnectionNotificationModal.vue
@@ -35,12 +35,13 @@
 
 <script>
 
+  import pluginData from 'kolibri-plugin-data';
   import urls from 'kolibri/urls';
   import client from 'kolibri/client';
   import commonCoreStrings from 'kolibri/uiText/commonCoreStrings';
-  import appCapabilities, { checkCapability } from 'kolibri/utils/appCapabilities';
   import logger from 'kolibri-logging';
   import useUser from 'kolibri/composables/useUser';
+  import checkMeteredConnection from 'kolibri-common/utils/checkMeteredConnection';
 
   const logging = logger.getLogger(__filename);
 
@@ -85,10 +86,10 @@
       },
     },
     mounted() {
-      if (checkCapability('check_is_metered')) {
+      if (pluginData.canCheckMeteredConnection) {
         this.loading = true;
 
-        appCapabilities.checkIsMetered().then(isMetered => {
+        checkMeteredConnection().then(isMetered => {
           this.activeConnectionIsMetered = isMetered;
 
           // Fetch the DeviceSettings#extra_settings value
diff --git a/kolibri/plugins/learn/assets/src/views/LibraryPage/index.vue b/kolibri/plugins/learn/assets/src/views/LibraryPage/index.vue
index b0499ab0f87..6b9ad30caf7 100644
--- a/kolibri/plugins/learn/assets/src/views/LibraryPage/index.vue
+++ b/kolibri/plugins/learn/assets/src/views/LibraryPage/index.vue
@@ -178,14 +178,14 @@
   import { get, set } from '@vueuse/core';
 
   import { onMounted, getCurrentInstance, ref, watch } from 'vue';
+  import pluginData from 'kolibri-plugin-data';
   import commonCoreStrings from 'kolibri/uiText/commonCoreStrings';
   import useKResponsiveWindow from 'kolibri-design-system/lib/composables/useKResponsiveWindow';
   import useUser from 'kolibri/composables/useUser';
   import samePageCheckGenerator from 'kolibri-common/utils/samePageCheckGenerator';
   import ContentNodeResource from 'kolibri-common/apiResources/ContentNodeResource';
   import { mapState } from 'vuex';
-  import MeteredConnectionNotificationModal from 'kolibri-common/components/MeteredConnectionNotificationModal.vue';
-  import appCapabilities, { checkCapability } from 'kolibri/utils/appCapabilities';
+  import checkMeteredConnection from 'kolibri-common/utils/checkMeteredConnection';
   import LearningActivityChip from 'kolibri-common/components/ResourceDisplayAndSearch/LearningActivityChip.vue';
   import { searchKeys } from 'kolibri-common/composables/useBaseSearch';
   import SidePanelModal from 'kolibri-common/components/SidePanelModal';
@@ -209,6 +209,7 @@
   import SearchResultsGrid from '../SearchResultsGrid';
   import LearnAppBarPage from '../LearnAppBarPage';
   import PostSetupModalGroup from '../../../../../device/assets/src/views/PostSetupModalGroup.vue';
+  import MeteredConnectionNotificationModal from './MeteredConnectionNotificationModal';
   import ResumableContentGrid from './ResumableContentGrid';
   import OtherLibraries from './OtherLibraries';
 
@@ -453,7 +454,7 @@
         if (!validUser) {
           return false;
         }
-        if (!checkCapability('check_is_metered')) {
+        if (!pluginData.canCheckMeteredConnection) {
           return true;
         }
         if (this.allowDownloadOnMeteredConnection) {
@@ -531,9 +532,9 @@
         !this.deviceId &&
         this.isUserLoggedIn &&
         !this.allowDownloadOnMeteredConnection &&
-        checkCapability('check_is_metered')
+        pluginData.canCheckMeteredConnection
       ) {
-        appCapabilities.checkIsMetered().then(isMetered => {
+        checkMeteredConnection().then(isMetered => {
           this.usingMeteredConnection = isMetered;
         });
       }
diff --git a/kolibri/plugins/learn/kolibri_plugin.py b/kolibri/plugins/learn/kolibri_plugin.py
index 4d14875b3e7..90ceeb3b2fb 100644
--- a/kolibri/plugins/learn/kolibri_plugin.py
+++ b/kolibri/plugins/learn/kolibri_plugin.py
@@ -3,6 +3,7 @@
 from kolibri.core.auth.constants.user_kinds import ANONYMOUS
 from kolibri.core.auth.constants.user_kinds import LEARNER
 from kolibri.core.content.hooks import ContentNodeDisplayHook
+from kolibri.core.device.hooks import CheckIsMeteredHook
 from kolibri.core.device.utils import allow_learner_unassigned_resource_access
 from kolibri.core.device.utils import get_device_setting
 from kolibri.core.device.utils import is_landing_page
@@ -63,6 +64,7 @@ def plugin_data(self):
             "allowDownloadOnMeteredConnection": get_device_setting(
                 "allow_download_on_metered_connection"
             ),
+            "canCheckMeteredConnection": CheckIsMeteredHook.is_registered,
             "allowGuestAccess": get_device_setting("allow_guest_access"),
             "allowLearnerDownloads": get_device_setting(
                 "allow_learner_download_resources"
diff --git a/kolibri/plugins/setup_wizard/assets/src/machines/wizardMachine.js b/kolibri/plugins/setup_wizard/assets/src/machines/wizardMachine.js
index 5cf8cffde48..10274b8fcca 100644
--- a/kolibri/plugins/setup_wizard/assets/src/machines/wizardMachine.js
+++ b/kolibri/plugins/setup_wizard/assets/src/machines/wizardMachine.js
@@ -1,6 +1,8 @@
 import uniq from 'lodash/uniq';
-import { checkCapability } from 'kolibri/utils/appCapabilities';
+import { get } from '@vueuse/core';
+import pluginData from 'kolibri-plugin-data';
 import { Presets } from 'kolibri/constants';
+import useUser from 'kolibri/composables/useUser';
 import { DeviceTypePresets, FacilityTypePresets, LodTypePresets, UsePresets } from '../constants';
 
 /**
@@ -23,8 +25,8 @@ import { DeviceTypePresets, FacilityTypePresets, LodTypePresets, UsePresets } fr
  *    OR
  *    Know that we will need to directly copy and paste them into the visualizer
  *
- * For now, this means copying the imports from `../constants` and writing a
- * function in place of `checkCapability`.
+ * For now, this means copying the imports from `../constants` and writing an
+ * object in place of `pluginData`.
  */
 
 /**
@@ -46,8 +48,10 @@ import { DeviceTypePresets, FacilityTypePresets, LodTypePresets, UsePresets } fr
 /* eslint-disable-next-line */
 import { assign, createMachine } from 'xstate';
 
-// NOTE: Uncomment the following function if you're using the visualizer
-// const checkCapability = capabilityToCheck => ["get_os_user"].includes(capabilityToCheck);
+// NOTE: Uncomment the following object if you're using the visualizer
+// const pluginData = { canGetOsUser: true };
+
+const { isAppContext } = useUser();
 
 const initialContext = {
   onMyOwnOrGroup: null,
@@ -553,7 +557,7 @@ export const wizardMachine = createMachine(
       isGroupSetup: context => {
         return context.onMyOwnOrGroup === UsePresets.GROUP;
       },
-      canGetOsUser: () => checkCapability('get_os_user'),
+      canGetOsUser: () => get(isAppContext) && pluginData.canGetOSUser,
       isNewFacility: context => {
         return context.facilityNewOrImport === FacilityTypePresets.NEW;
       },
diff --git a/kolibri/plugins/setup_wizard/assets/src/views/SetupWizardIndex.vue b/kolibri/plugins/setup_wizard/assets/src/views/SetupWizardIndex.vue
index 117f9b235e2..7f6e5717fcd 100644
--- a/kolibri/plugins/setup_wizard/assets/src/views/SetupWizardIndex.vue
+++ b/kolibri/plugins/setup_wizard/assets/src/views/SetupWizardIndex.vue
@@ -25,9 +25,10 @@
 
   import { interpret } from 'xstate';
   import { mapState } from 'vuex';
+  import pluginData from 'kolibri-plugin-data';
   import commonCoreStrings from 'kolibri/uiText/commonCoreStrings';
+  import useUser from 'kolibri/composables/useUser';
   import useKResponsiveWindow from 'kolibri-design-system/lib/composables/useKResponsiveWindow';
-  import { checkCapability } from 'kolibri/utils/appCapabilities';
   import Lockr from 'lockr';
   import { wizardMachine } from '../machines/wizardMachine';
   import LoadingPage from './submission-states/LoadingPage';
@@ -47,7 +48,8 @@
     mixins: [commonCoreStrings],
     setup() {
       const { windowIsLarge } = useKResponsiveWindow();
-      return { windowIsLarge };
+      const { isAppContext } = useUser();
+      return { isAppContext, windowIsLarge };
     },
     data() {
       return {
@@ -112,7 +114,10 @@
         synchronizeRouteAndMachine(savedState);
       } else {
         // Or set the app context state on the machine and proceed to the first state
-        this.service.send({ type: 'CONTINUE', value: checkCapability('get_os_user') });
+        this.service.send({
+          type: 'CONTINUE',
+          value: this.isAppContext && pluginData.canGetOSUser,
+        });
       }
 
       this.service.start(savedState);
diff --git a/kolibri/plugins/setup_wizard/assets/src/views/onboarding-forms/SettingUpKolibri.vue b/kolibri/plugins/setup_wizard/assets/src/views/onboarding-forms/SettingUpKolibri.vue
index f989c86b3ad..7bab74e6d0f 100644
--- a/kolibri/plugins/setup_wizard/assets/src/views/onboarding-forms/SettingUpKolibri.vue
+++ b/kolibri/plugins/setup_wizard/assets/src/views/onboarding-forms/SettingUpKolibri.vue
@@ -38,9 +38,10 @@
 
   import omitBy from 'lodash/omitBy';
   import get from 'lodash/get';
+  import pluginData from 'kolibri-plugin-data';
   import AppError from 'kolibri/components/error/AppError';
+  import useUser from 'kolibri/composables/useUser';
   import { currentLanguage } from 'kolibri/utils/i18n';
-  import { checkCapability } from 'kolibri/utils/appCapabilities';
   import redirectBrowser from 'kolibri/utils/redirectBrowser';
   import KolibriLoadingSnippet from 'kolibri-common/components/KolibriLoadingSnippet';
   import commonCoreStrings from 'kolibri/uiText/commonCoreStrings';
@@ -55,6 +56,10 @@
     components: { AppError, KolibriLoadingSnippet },
     inject: ['wizardService'],
     mixins: [commonCoreStrings],
+    setup() {
+      const { isAppContext } = useUser();
+      return { isAppContext };
+    },
     computed: {
       coreError() {
         if (this.$store) {
@@ -111,7 +116,7 @@
           // Learner cannot edit a password they cannot set
           this.learnerCanLoginWithNoPassword ||
           // OS on my own users don't use password to sign in
-          (this.isOnMyOwnSetup && checkCapability('get_os_user'))
+          (this.isOnMyOwnSetup && this.isAppContext && pluginData.canGetOSUser)
         ) {
           return false; // Learner cannot edit a password they cannot set
         } else {
@@ -123,7 +128,7 @@
         let superuser = null;
         // We need the superuser information unless the superuser will be created at login,
         // based on the os user - this is only the case for on my own setup.
-        if (!(this.isOnMyOwnSetup && checkCapability('get_os_user'))) {
+        if (!(this.isOnMyOwnSetup && this.isAppContext && pluginData.canGetOSUser)) {
           // Here we see if we've set a firstImportedLodUser -- if they exist, they must be the
           // superuser as they were the first imported user.
           if (this.wizardContext('firstImportedLodUser')) {
diff --git a/kolibri/plugins/setup_wizard/kolibri_plugin.py b/kolibri/plugins/setup_wizard/kolibri_plugin.py
index b560975fbd8..46bc8c80c8b 100644
--- a/kolibri/plugins/setup_wizard/kolibri_plugin.py
+++ b/kolibri/plugins/setup_wizard/kolibri_plugin.py
@@ -1,3 +1,4 @@
+from kolibri.core.device.hooks import GetOSUserHook
 from kolibri.core.device.hooks import SetupHook
 from kolibri.core.webpack import hooks as webpack_hooks
 from kolibri.plugins import KolibriPluginBase
@@ -20,7 +21,9 @@ def name(self, lang):
 
     @property
     def plugin_data(self):
-        return {}
+        return {
+            "canGetOSUser": GetOSUserHook.is_registered,
+        }
 
 
 @register_hook
diff --git a/packages/kolibri-common/utils/checkMeteredConnection.js b/packages/kolibri-common/utils/checkMeteredConnection.js
new file mode 100644
index 00000000000..f9e83e41474
--- /dev/null
+++ b/packages/kolibri-common/utils/checkMeteredConnection.js
@@ -0,0 +1,12 @@
+import client from 'kolibri/client';
+import urls from 'kolibri/urls';
+
+/**
+ * @returns Promise<Boolean>
+ * Returns a function that returns a Promise that resolves to something responding to
+ * `data.value` whether it succeeds or fails.
+ */
+export default function checkIsMetered() {
+  const urlFunction = urls['kolibri:core:check_metered_connection'];
+  return client({ url: urlFunction() }).then(response => response.data);
+}
diff --git a/packages/kolibri/utils/appCapabilities.js b/packages/kolibri/utils/appCapabilities.js
index 06f596f06de..363b65e0f82 100644
--- a/packages/kolibri/utils/appCapabilities.js
+++ b/packages/kolibri/utils/appCapabilities.js
@@ -1,22 +1,9 @@
 import client from 'kolibri/client';
 import logger from 'kolibri-logging';
 import urls from 'kolibri/urls';
-import useUser from 'kolibri/composables/useUser';
-import { get } from '@vueuse/core';
-import plugin_data from 'kolibri-plugin-data';
 
 const logging = logger.getLogger(__filename);
 
-const appCapabilities = plugin_data.appCapabilities || {};
-
-// Check that we are in an appcontext, if not disable all capabilities
-// this means that consumers of this API can rely solely on the existence
-// check of methods in this API to know if they can call these or not.
-export const checkCapability = key => {
-  const { isAppContext } = useUser();
-  return get(isAppContext) && appCapabilities[key];
-};
-
 // Use a janky getter to return a method here to only expose functions
 // that are available so that we have a single API for both existence
 // checks and exposing the functions.
@@ -27,22 +14,7 @@ export default {
    * Returns a function that returns a Promise that resolves to something responding to
    * `data.value` whether it succeeds or fails.
    */
-  checkIsMetered() {
-    if (!checkCapability('check_is_metered')) {
-      return Promise.resolve(null);
-    }
-
-    const urlFunction = urls['kolibri:core:check_metered_connection'];
-    if (!urlFunction || !checkCapability('check_is_metered')) {
-      logging.warn('Checking if the device is metered is not supported on this platform');
-      return Promise.resolve(null);
-    }
-    return client({ url: urlFunction(), method: 'GET' }).then(response => response.data);
-  },
   get shareFile() {
-    if (!checkCapability('share_file')) {
-      return; // eslint-disable-line getter-return
-    }
     // Deliberately using an options object here for the function signature,
     // rather than positional arguments, so that we can evolve the API but
     // maintain backwards compatibility.