MOBILE-4842 network: Simplify network type management

Author: crazyserver

local_moodleappbehat/tests/behat/behat_app.php

@@ -1179,15 +1179,16 @@ public function i_switch_offline_mode(string $offline) {
     public function i_switch_network_connection(string $mode) {
         switch ($mode) {
             case 'wifi':
-                $this->runtime_js("network.setForceConnectionMode('$mode');");
+                $this->runtime_js("network.setForceConnectionMode('wifi');");
                 break;
             case 'cellular':
-                $this->runtime_js("network.setForceConnectionMode('$mode');");
+                $this->runtime_js("network.setForceConnectionMode('cellular');");
                 break;
             case 'offline':
-                $this->runtime_js("network.setForceConnectionMode('none');");
+                $this->runtime_js("network.setForceConnectionMode('offline');");
                 break;
             default:
+                $this->runtime_js("network.setForceConnectionMode('unknown');");
                 break;
         }
     }

src/core/classes/sites/authenticated-site.ts

@@ -1592,7 +1592,7 @@ export class CoreAuthenticatedSite extends CoreUnauthenticatedSite {
         let expirationDelay = CoreAuthenticatedSite.UPDATE_FREQUENCIES[updateFrequency] ||
         CoreAuthenticatedSite.UPDATE_FREQUENCIES[CoreCacheUpdateFrequency.USUALLY];
 
-        if (CoreNetwork.isNetworkAccessLimited()) {
+        if (CoreNetwork.isCellular()) {
             // Not WiFi, increase the expiration delay a 50% to decrease the data usage in this case.
             expirationDelay *= 1.5;
         }

src/core/directives/external-content.ts

@@ -518,7 +518,8 @@ export class CoreExternalContentDirective implements AfterViewInit, OnChanges, O
             clickableEl.addEventListener(eventName, () => {
                 // User played media or opened a downloadable link.
                 // Download the file if in wifi and it hasn't been downloaded already (for big files).
-                if (state !== DownloadStatus.DOWNLOADED && state !== DownloadStatus.DOWNLOADING && CoreNetwork.isWifi()) {
+                if (state !== DownloadStatus.DOWNLOADED && state !== DownloadStatus.DOWNLOADING &&
+                    CoreNetwork.isWifi()) {
                     // We aren't using the result, so it doesn't matter which of the 2 functions we call.
                     CoreFilepool.getUrlByUrl(site.getId(), url, this.component, this.componentId, 0, false);
                 }

src/core/features/fileuploader/services/fileuploader-helper.ts

@@ -140,7 +140,7 @@ export class CoreFileUploaderHelperProvider {
 
         if (size < 0) {
             return CoreAlerts.confirm(Translate.instant('core.fileuploader.confirmuploadunknownsize'));
-        } else if (size >= wifiThreshold || (CoreNetwork.isNetworkAccessLimited() && size >= limitedThreshold)) {
+        } else if (size >= wifiThreshold || (CoreNetwork.isCellular() && size >= limitedThreshold)) {
             const readableSize = CoreText.bytesToSize(size, 2);
 
             return CoreAlerts.confirm(Translate.instant('core.fileuploader.confirmuploadfile', { size: readableSize }));

src/core/features/settings/pages/deviceinfo/deviceinfo.ts

@@ -25,7 +25,7 @@ import { CoreConfig } from '@services/config';
 import { CoreToasts } from '@services/overlays/toasts';
 import { CoreNavigator } from '@services/navigator';
 import { CorePlatform } from '@services/platform';
-import { CoreNetwork, CoreNetworkConnection } from '@services/network';
+import { CoreNetwork, CoreNetworkConnectionType } from '@services/network';
 import { CoreLoginHelper } from '@features/login/services/login-helper';
 import { CoreSitesFactory } from '@services/sites-factory';
 import { CoreText } from '@singletons/text';
@@ -96,7 +96,7 @@ export default class CoreSettingsDeviceInfoPage {
             compilationTime: CoreConstants.BUILD.compilationTime || 0,
             lastCommit: CoreConstants.BUILD.lastCommitHash || '',
             isOnline: CoreNetwork.onlineSignal(),
-            wifiConnection: computed(() => CoreNetwork.connectionTypeSignal()() === CoreNetworkConnection.WIFI),
+            wifiConnection: computed(() => CoreNetwork.connectionTypeSignal()() === CoreNetworkConnectionType.WIFI),
             localNotifAvailable: CoreLocalNotifications.isPluginAvailable() ? 'yes' : 'no',
             pushId: CorePushNotifications.getPushId(),
             deviceType: '',

src/core/features/settings/pages/site/site.ts

@@ -73,13 +73,13 @@ export default class CoreSitePreferencesPage implements AfterViewInit, OnDestroy
         }, this.siteId);
 
         this.isOnline = CoreNetwork.isOnline();
-        this.limitedConnection = this.isOnline && CoreNetwork.isNetworkAccessLimited();
+        this.limitedConnection = CoreNetwork.isCellular();
 
         this.networkObserver = CoreNetwork.onChange().subscribe(() => {
             // Execute the callback in the Angular zone, so change detection doesn't stop working.
             NgZone.run(() => {
                 this.isOnline = CoreNetwork.isOnline();
-                this.limitedConnection = this.isOnline && CoreNetwork.isNetworkAccessLimited();
+                this.limitedConnection = CoreNetwork.isCellular();
             });
         });
     }

src/core/features/settings/pages/synchronization/synchronization.ts

@@ -93,13 +93,13 @@ export default class CoreSettingsSynchronizationPage implements OnInit, OnDestro
         });
 
         this.isOnline = CoreNetwork.isOnline();
-        this.limitedConnection = this.isOnline && CoreNetwork.isNetworkAccessLimited();
+        this.limitedConnection = CoreNetwork.isCellular();
 
         this.networkObserver = CoreNetwork.onChange().subscribe(() => {
             // Execute the callback in the Angular zone, so change detection doesn't stop working.
             NgZone.run(() => {
                 this.isOnline = CoreNetwork.isOnline();
-                this.limitedConnection = this.isOnline && CoreNetwork.isNetworkAccessLimited();
+                this.limitedConnection = CoreNetwork.isCellular();
             });
         });
 

src/core/features/settings/services/settings-helper.ts

@@ -241,7 +241,7 @@ export class CoreSettingsHelperProvider {
         } else if (hasSyncHandlers && !CoreNetwork.isOnline()) {
             // We need connection to execute sync.
             throw new CoreError(Translate.instant('core.settings.cannotsyncoffline'));
-        } else if (hasSyncHandlers && syncOnlyOnWifi && CoreNetwork.isNetworkAccessLimited()) {
+        } else if (hasSyncHandlers && syncOnlyOnWifi && CoreNetwork.isCellular()) {
             throw new CoreError(Translate.instant('core.settings.cannotsyncwithoutwifi'));
         }
 

src/core/services/network.ts

@@ -12,14 +12,14 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import { computed, effect, Injectable, Signal, signal } from '@angular/core';
+import { effect, Injectable, Signal, signal } from '@angular/core';
 import { CorePlatform } from '@services/platform';
 import { Network } from '@awesome-cordova-plugins/network/ngx';
 import { makeSingleton } from '@singletons';
 import { Observable, Subject, merge } from 'rxjs';
 import { CoreHTMLClasses } from '@singletons/html-classes';
 
-export enum CoreNetworkConnection {
+enum CoreNetworkConnection {
     UNKNOWN = 'unknown',
     ETHERNET = 'ethernet',
     WIFI = 'wifi',
@@ -30,6 +30,13 @@ export enum CoreNetworkConnection {
     NONE = 'none',
 }
 
+export enum CoreNetworkConnectionType {
+    UNKNOWN = 'unknown',
+    WIFI = 'wifi', // Usually a non-metered connection.
+    CELL = 'cellular', // Usually a metered connection.
+    OFFLINE = 'offline',
+}
+
 /**
  * Service to manage network connections.
  */
@@ -41,11 +48,10 @@ export class CoreNetworkService extends Network {
     protected connectObservable = new Subject<'connected'>();
     protected connectStableObservable = new Subject<'connected'>();
     protected disconnectObservable = new Subject<'disconnected'>();
-    protected forceConnectionMode?: CoreNetworkConnection;
-    protected readonly online = signal(false);
+    protected forceConnectionMode?: CoreNetworkConnectionType;
     protected connectStableTimeout?: number;
-    private readonly _connectionType = signal(CoreNetworkConnection.UNKNOWN);
-    private readonly _limitedConnection = computed(() => this.online() && CoreNetwork.isNetworkAccessLimited());
+    protected readonly online = signal(false);
+    private readonly _connectionType = signal(CoreNetworkConnectionType.UNKNOWN);
 
     constructor() {
         super();
@@ -69,7 +75,7 @@ export class CoreNetworkService extends Network {
         });
     }
 
-    get connectionType(): CoreNetworkConnection {
+    get connectionType(): CoreNetworkConnectionType {
         CoreNetwork.updateConnectionType();
 
         return this._connectionType();
@@ -91,6 +97,7 @@ export class CoreNetworkService extends Network {
                 this.fireObservable();
             });
         } else {
+            // Match the Cordova constants to the ones used in the app.
             // eslint-disable-next-line @typescript-eslint/no-explicit-any
             (<any> window).Connection = {
                 UNKNOWN: CoreNetworkConnection.UNKNOWN, // eslint-disable-line @typescript-eslint/naming-convention
@@ -130,7 +137,7 @@ export class CoreNetworkService extends Network {
      *
      * @param value Value to set.
      */
-    setForceConnectionMode(value: CoreNetworkConnection): void {
+    setForceConnectionMode(value: CoreNetworkConnectionType): void {
         this.forceConnectionMode = value;
         this.fireObservable();
     }
@@ -151,7 +158,7 @@ export class CoreNetworkService extends Network {
         // Recalculate connection type.
         CoreNetwork.updateConnectionType();
 
-        if (this.forceConnectionMode === CoreNetworkConnection.NONE) {
+        if (this.forceConnectionMode === CoreNetworkConnectionType.OFFLINE) {
             this.online.set(false);
 
             return;
@@ -166,7 +173,7 @@ export class CoreNetworkService extends Network {
         }
 
         const type = this._connectionType();
-        let online = type !== null && type !== CoreNetworkConnection.NONE && type !== CoreNetworkConnection.UNKNOWN;
+        let online = type !== null && type !== CoreNetworkConnectionType.OFFLINE && type !== CoreNetworkConnectionType.UNKNOWN;
 
         // Double check we are not online because we cannot rely 100% in Cordova APIs.
         if (!online && navigator.onLine) {
@@ -187,12 +194,32 @@ export class CoreNetworkService extends Network {
         }
 
         if (CorePlatform.isMobile()) {
-            this._connectionType.set(this.type as CoreNetworkConnection);
-
-            return;
+            switch (this.type) {
+                case CoreNetworkConnection.WIFI:
+                case CoreNetworkConnection.ETHERNET:
+                    this._connectionType.set(CoreNetworkConnectionType.WIFI);
+
+                    return;
+                case CoreNetworkConnection.CELL:
+                case CoreNetworkConnection.CELL_2G:
+                case CoreNetworkConnection.CELL_3G:
+                case CoreNetworkConnection.CELL_4G:
+                    this._connectionType.set(CoreNetworkConnectionType.CELL);
+
+                    return;
+                case CoreNetworkConnection.NONE:
+                    this._connectionType.set(CoreNetworkConnectionType.OFFLINE);
+
+                    return;
+                default:
+                case CoreNetworkConnection.UNKNOWN:
+                    this._connectionType.set(CoreNetworkConnectionType.UNKNOWN);
+
+                    return;
+            }
         }
 
-        this._connectionType.set(this.online() ? CoreNetworkConnection.WIFI : CoreNetworkConnection.NONE);
+        this._connectionType.set(this.online() ? CoreNetworkConnectionType.WIFI : CoreNetworkConnectionType.OFFLINE);
     }
 
     /**
@@ -213,21 +240,12 @@ export class CoreNetworkService extends Network {
         return this.online.asReadonly();
     }
 
-    /**
-     * Returns a signal to watch limited connection status.
-     *
-     * @returns Signal.
-     */
-    limitedConnectionSignal(): Signal<boolean> {
-        return this._limitedConnection;
-    }
-
     /**
      * Returns a signal to watch connection type.
      *
      * @returns Signal.
      */
-    connectionTypeSignal(): Signal<CoreNetworkConnection> {
+    connectionTypeSignal(): Signal<CoreNetworkConnectionType> {
         return this._connectionType.asReadonly();
     }
 
@@ -284,18 +302,10 @@ export class CoreNetworkService extends Network {
      * Check if device uses a limited connection.
      *
      * @returns Whether the device uses a limited connection.
+     * @deprecated since 5.1. Use isCellular instead.
      */
     isNetworkAccessLimited(): boolean {
-        const limited: CoreNetworkConnection[] = [
-            CoreNetworkConnection.CELL_2G,
-            CoreNetworkConnection.CELL_3G,
-            CoreNetworkConnection.CELL_4G,
-            CoreNetworkConnection.CELL,
-        ];
-
-        const type = this.connectionType;
-
-        return limited.indexOf(type) > -1;
+        return this.isCellular();
     }
 
     /**
@@ -304,7 +314,16 @@ export class CoreNetworkService extends Network {
      * @returns Whether the device uses a wifi connection.
      */
     isWifi(): boolean {
-        return this.isOnline() && !this.isNetworkAccessLimited();
+        return this.connectionType === CoreNetworkConnectionType.WIFI;
+    }
+
+    /**
+     * Check if device uses a limited connection.
+     *
+     * @returns Whether the device uses a limited connection.
+     */
+    isCellular(): boolean {
+        return this.connectionType === CoreNetworkConnectionType.CELL;
     }
 
 }

src/core/services/overlays/alerts.ts

@@ -186,7 +186,7 @@ export class CoreAlertsService {
         const limitedThreshold = options.limitedThreshold ?? CoreConstants.DOWNLOAD_THRESHOLD;
 
         let wifiPrefix = '';
-        if (CoreNetwork.isNetworkAccessLimited()) {
+        if (CoreNetwork.isCellular()) {
             wifiPrefix = Translate.instant('core.course.confirmlimiteddownload');
         }
 
@@ -203,7 +203,7 @@ export class CoreAlertsService {
                 { size: readableSize, availableSpace: availableSpace },
             ));
         } else if (options.alwaysConfirm || size.size >= wifiThreshold ||
-                (CoreNetwork.isNetworkAccessLimited() && size.size >= limitedThreshold)) {
+                (CoreNetwork.isCellular() && size.size >= limitedThreshold)) {
 
             return this.confirm(wifiPrefix + Translate.instant(
                 options.message ?? (size.size === 0 ? 'core.course.confirmdownloadzerosize' : 'core.course.confirmdownload'),