Comportement de mise à jour

Lorsque vous publiez une mise à jour pour votre application Capgo, vous souhaitez probablement que vos utilisateurs reçoivent cette mise à jour le plus rapidement possible. Mais vous ne voulez pas non plus perturber leur expérience en leur forçant à attendre la téléchargement ou à redémarrer l'application au milieu d'une session.

Le comportement de mise à jour de Capgo est conçu pour trouver un équilibre entre la livraison des mises à jour rapidement et la minimisation de la perturbation pour vos utilisateurs.

Flux de mise à jour par défaut

Par défaut, voici comment Capgo gère les mises à jour des applications :

1. Lorsque l'application passe en avant-plan, le plugin Capgo vérifie si une nouvelle mise à jour est disponible. Alors que l'application reste ouverte, il vérifie à nouveau à intervalles réguliers contrôlés par periodCheckDelay (défaut 10 minutes).

2. Si une mise à jour est trouvée, elle est téléchargée en arrière-plan tandis que l'utilisateur continue à utiliser la version actuelle de l'application.

3. Une fois le téléchargement terminé, Capgo attend que l'utilisateur mette l'application en arrière-plan.

4. Lorsque l'utilisateur ramène ensuite l'application en avant-plan, ils exécuteront la version mise à jour.

Cette progression garantit que les utilisateurs exécutent toujours la dernière version de votre application, sans jamais être interrompus par des invitations à mettre à jour ou contraints de attendre des téléchargements.

Conseil

Capgo vérifie les mises à jour chaque fois que l'application passe en avant-plan et sur un horloge répétitive tout en restant ouverte. periodCheckDelay Contrôle de cet intervalle (par défaut 10 minutes).

Pourquoi Cette Approche ?

La mise à jour d'une application sur un événement de fond ou de suppression présente quelques avantages clés pour l'expérience utilisateur :

• Les utilisateurs ne sont pas interrompus par des invitations à mettre à jour ou contraints d'attendre des téléchargements au milieu d'une session.

• Les mises à jour sont appliquées de manière fluide entre les sessions, de sorte que l'expérience de lancement de l'application est toujours fraîche.

• Vous pouvez livrer des mises à jour fréquentes sans vous soucier de perturber les utilisateurs actifs.

Le principal inconvénient est que si un utilisateur met son application en arrière-plan et la reprend rapidement, il peut perdre tout l'état non enregistré depuis que la mise à jour a été appliquée entre ces actions.

Pour atténuer cela, nous recommandons :

• Enregistrez l'état fréquemment et restaurez-le de manière gracieuse lorsque l'application reprend.

• Évitez les mises à jour très fréquentes qui modifient de grandes parties de l'état de l'application.

• Considérez la personnalisation du comportement de mise à jour pour les flux sensibles (voir ci-dessous).

Personnaliser Lorsque les Mises à Jour Sont Appliquées

Dans certains cas, vous pourriez vouloir avoir plus de contrôle sur l'exécution exacte d'une mise à jour. Par exemple, vous pourriez vouloir vous assurer que l'utilisateur termine un flux en cours avant de mettre à jour, ou coordonner une mise à jour d'application avec une modification côté serveur.

Capgo fournit une setDelay fonction qui vous permet de spécifier des conditions qui doivent être remplies avant que la mise à jour soit installée :

import { CapacitorUpdater } from '@capgo/capacitor-updater';

await CapacitorUpdater.setMultiDelay({
  delayConditions: [
    {
      kind: 'date',
      value: '2023-06-01T00:00:00.000Z',
    },
    {
      kind: 'background',
      value: '60000',
    },
  ],
});

Cet exemple retarderait l'installation d'une mise à jour jusqu'après le 1er juin 2023 ET l'application aurait été mis en arrière-plan pendant au moins 60 secondes.

Les conditions de retard disponibles sont :

• date : Attendre après une date et heure spécifique pour appliquer la mise à jour.
• background : Attendre une durée minimale après que l'application est mise en arrière-plan pour appliquer la mise à jour.
• nativeVersion : Attendre que soit installé un fichier binaire natif avec une version minimale avant d'appliquer la mise à jour.
• kill : Attendre jusqu'au prochain événement de mort de l'application pour appliquer la mise à jour.

Vous pouvez combiner ces conditions pour contrôler précisément quand une mise à jour est installée.

Danger

Notez que la kill condition déclenche actuellement la mise à jour après le premier événement de mort, et non l'événement de background suivant comme les autres conditions. Cette incohérence sera corrigée dans une prochaine version.

Appliquer les Mises à Jour Immédiatement

Pour les mises à jour critiques ou les applications avec un état très simple, vous pouvez souhaitez appliquer une mise à jour dès qu'elle est téléchargée, sans attendre un événement de fond ou de fermeture. Capgo prend en charge cela via la autoUpdate politique dans votre Capacitor config.

Recommandé : Utilisez les Mises à jour Delta (Manifeste) avec l'application instantanée

Lorsque vous utilisez un mode d'application instantanée, nous fortement recommandons d'activer Mises à jour Delta (manifeste) pour minimiser les temps de téléchargement et améliorer l'expérience utilisateur. Les mises à jour delta (manifeste) téléchargent uniquement les fichiers modifiés au lieu du bundle entier, ce qui est particulièrement important lorsque les mises à jour sont appliquées immédiatement tout en utilisant votre application.

Pourquoi cela compte pour les modes d'application instantanée :

• Actualisations rapides: Les téléchargements plus petits signifient que les mises à jour se terminent rapidement, réduisant le temps pendant lequel les utilisateurs voient les écrans de chargement.
• Une meilleure expérience mobile.: Les utilisateurs sur les réseaux cellulaires ou les connexions plus lentes ne seront pas confrontés à des temps d'attente longs.
• Une utilisation de bande passante inférieure.: Seuls les fichiers modifiés sont téléchargés, ce qui économise des données pour vous et vos utilisateurs.

Lorsque autoUpdate est défini sur "atInstall", "onLaunch", ou "always" dans votre capacitor.config, le CLI le détecte. Dans les environnements non interactifs, il envoie automatiquement les mises à jour Delta (manifeste), et dans les environnements interactifs, il vous demande de confirmer avant de télécharger. La version legacy de directUpdate config est toujours détectée. Utilisez --no-delta pour forcer une mise à jour de l'ensemble du bundle.

To enable Delta (manifest) updates, simply use le --delta flag when uploading bundles:

npx @capgo/cli@latest bundle upload --delta

En savoir plus dans la documentation sur les mises à jour Delta (manifest) est défini dans votre .

autoUpdate fichier, pas dans JavaScript __CAPGO_KEEP_0__. Il prend en charge ces valeurs: capacitor.config.ts file, not in JavaScript code. It supports these values:

• false ou 'off': Désactiver les vérifications automatiques de mise à jour
• true ou 'atBackground' (par défaut) : Vérifiez et téléchargez automatiquement à chaque vérification en avant-plan, puis appliquez la mise à jour la prochaine fois que l'application passe en arrière-plan
• 'atInstall': Appliquer immédiatement uniquement après une installation fraîche ou une mise à jour de l'application native ; sinon utilisez "atBackground" comportement
• 'onLaunch': Appliquer immédiatement uniquement lorsque l'application est ramenée à l'avant-plan à partir d'un état tué (démarrage froid). Après cette première vérification, reculez sur "atBackground" comportement
• 'always': Vérifiez à chaque transition en avant-plan et appliquez immédiatement dès que des mises à jour sont disponibles
• 'onlyDownload': Vérifiez et téléchargez automatiquement, émettez updateAvailable, et n'installez jamais le prochain bundle ou appliquez une mise à jour automatiquement

Tester une Build Native Sans Mises à Jour en Ligne

Voir Tester les Builds Native Sans Mises à Jour pour les garanties de configuration de version native, de politique de canal et de CI.

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'always', // or 'atInstall' for updates only on app install/update
      autoSplashscreen: true,
      keepUrlPathAfterReload: true,
    },
    SplashScreen: {
      launchAutoHide: false, // Required when using instant apply with autoSplashscreen
    },
  },
};

export default config;

Note

Important: les modes d'application instantanée n'appliquent les mises à jour que lorsque le plugin effectue effectivement des vérifications. Par défaut, les vérifications sont exécutées lorsque l'application passe en arrière-plan et sur un horloge répétitive pendant que l'application reste ouverte. periodCheckDelay contrôlez cette intervalle (par défaut 10 minutes).

Avec autoUpdate: 'always', Capgo effectue des vérifications à chaque transition en avant-plan et applique une mise à jour immédiate dès que le téléchargement est terminé pendant cette vérification, même si l'utilisateur utilise actuellement l'application. Les vérifications périodiques contrôlées par periodCheckDelay peuvent déclencher le même comportement d'application immédiate pendant que l'application reste ouverte.

Notez que puisque autoUpdate est une configuration native, les modes d'application instantanée nécessitent une gestion supplémentaire dans votre code JavaScript.

Attention

Lorsque vous utilisez un mode d'application instantané avec autoSplashscreen, vous devez définir launchAutoHide: false en configuration de SplashScreen (comme montré ci-dessus) pour empêcher l'écran de splash de se cacher automatiquement. Cela vous permet de contrôler pleinement quand l'écran de splash est masqué après la fin du processus de mise à jour.

Téléchargement Automatique Sans Application

Si vous souhaitez que Capgo vérifie et télécharge les mises à jour automatiquement mais ne les applique jamais automatiquement, utilisez autoUpdate: 'onlyDownload':

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'onlyDownload',
    },
  },
};

Dans ce mode, le plugin émet updateAvailable après téléchargement d'un bundle. Votre application peut ensuite décider de lancer CapacitorUpdater.set() ou afficher son propre prompt de mise à jour.

Gestion Automatique de l'Ecran de Splash

Pour rendre les modes d'application instantanée plus faciles à utiliser, Capgo fournit une autoSplashscreen option qui gère automatiquement la suppression de l'écran de démarrage pour vous (disponible depuis la version 7.6.0) :

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      autoUpdate: 'always', // or 'atInstall'
      autoSplashscreen: true, // Automatically hide splashscreen
      keepUrlPathAfterReload: true,
    },
    SplashScreen: {
      launchAutoHide: false,
    },
  },
};

Lorsque autoSplashscreen est activé :

• Le plugin cache automatiquement l'écran de démarrage lorsqu'une mise à jour est appliquée
• Le plugin cache automatiquement l'écran de démarrage lorsqu'aucune mise à jour n'est nécessaire
• Vous n'avez pas besoin de vous tenir à l'écoute des appReady événements ou d'appeler SplashScreen.hide()

Gestion manuelle de l'écran de démarrage

Si vous préférez un contrôle manuel ou avez besoin de logique personnalisée, vous pouvez désactiver autoSplashscreen et le gérer vous-même :

import { CapacitorUpdater } from '@capgo/capacitor-updater';
import { SplashScreen } from '@capacitor/splash-screen';

CapacitorUpdater.addListener('appReady', () => {
  // Hide splash screen
  SplashScreen.hide();
});

CapacitorUpdater.notifyAppReady();

Le appReady L'événement se déclenche une fois l'application terminée d'être initialisée et d'appliquer les mises à jour en attente. C'est le point auquel il est sécurisé de montrer l'interface utilisateur de votre application, car il s'assure que l'utilisateur verra la dernière version.

En plus de gérer l'événement appReady nous recommandons de définir la keepUrlPathAfterReload option de configuration sur true lorsque vous utilisez un mode d'application instantanée. Cela préserve l'actuelle chemin d'URL lorsque l'application est rechargée en raison d'une mise à jour, ce qui aide à maintenir la position de l'utilisateur dans l'application et à réduire la désorientation.

Si vous n'avez pas géré l'événement appReady et défini keepUrlPathAfterReload lorsque vous utilisez un mode d'application instantanée, l'utilisateur peut brièvement voir une version périmée de l'application, être renvoyé vers la route initiale ou voir un clignotement pendant l'application de la mise à jour.

En utilisant un mode d'application instantanée, vous pouvez livrer des correctifs de bogues critiques ou des mises à jour de sécurité, mais cela comporte quelques compromis :

• L’utilisateur peut voir un bref éclat ou un état de chargement pendant l'application de la mise à jour si vous n'avez pas géré correctement l'écran de splash (soit avec autoSplashscreen ou le traitement manuel appReady des événements).
• Si la mise à jour modifie l'état de l'application ou l'interface utilisateur, l’utilisateur peut voir un changement disruptif au milieu d'une session.
• La localisation de l'utilisateur dans l'application peut être perdue si keepUrlPathAfterReload n'est pas défini, ce qui peut les dérouter.
• Vous devrez gérer soigneusement la sauvegarde et la restauration de l'état pour assurer une transition fluide.

Si vous activez l'application instantanée, nous vous recommandons :

• Utiliser autoSplashscreen: true pour la configuration la plus simple, ou gérer manuellement l'événement appReady si vous avez besoin de logique personnalisée.
• Paramètres keepUrlPathAfterReload à true contexte : Page/zone : Page de produit de mises à jour en direct. Rôle : Étiquette de navigation ou élément de l'interface utilisateur court. Clé de message `live_update_dynamic_label_to` (Étiquette de mise à jour en direct dynamique To).
• pour conserver l'emplacement de l'utilisateur dans l'application.
• Enregistrement et restauration de l'état de l'application au besoin pour éviter la perte de progression de l'utilisateur.

In most cases, the default update behavior provides the best balance of delivering updates quickly and minimizing disruption. But for apps with specific needs, Capgo provides the flexibility to customize when and how updates are applied.

Dans la plupart des cas, le comportement de mise à jour par défaut fournit la meilleure balance entre la livraison rapide des mises à jour et la minimisation de la perturbation. Mais pour les applications ayant des besoins spécifiques, __CAPGO_KEEP_0__ offre la flexibilité de personnaliser quand et comment les mises à jour sont appliquées.

Titre de la section « Continuez de la section Comportement de mise à jour » Si vous utilisez Comportement de mise à jour pour planifier la livraison de mises à jour en direct, connectez-l’à la mise à jour en direct Capgo pour le flux de travail du produit dans les mises à jour en direct de Capgo Vue d'ensemble pour le détail d'implémentation dans Vue d'ensemble Fonctionnalités pour le détail d'implémentation dans Fonctionnalités Types de mise à jour pour le détail d'implémentation dans Types de mise à jour, et Démarrage pour le détail d'implémentation dans Démarrage