DeepSeek Harness Nettoyage automatique et ctx.effect()

Chapitre précédentDeepSeek Harness : chargement des plugins locauxAfficher une ligne de log est tout ce qu'il fait, mais les vrais plugins enregistrent des écouteurs, des outils et des minuteurs.

Cette section résout un problème : quand le plugin est déchargé, qui nettoie ces ressources ?

L'enregistrement est délégué à ctx, et le nettoyage est également délégué à ctx.


Mécanisme de nettoyage automatique

Tout ce qui est enregistré via ctx—écouteurs d'événements, outils, minuteurs—est automatiquement nettoyé lorsque le plugin est déchargé.

Vous n'avez pas besoin d'appeler manuellement removeListener ou clearInterval.

Le framework peut automatiquement nettoyer car tous les enregistrements effectués via ctx sont consignés dans la portée Fiber du plugin.

Lors du déchargement, le framework les révoque dans l'ordre inverse d'enregistrement.


Quelles opérations sont automatiquement suivies

Les opérations suivantes sont automatiquement suivies et nettoyées.

Opération d'enregistrementComportement lors de la désinstallation
ctx.on(event, handler)Les écouteurs d'événements sont automatiquement supprimés
ctx.tools.register(tool)Révocation automatique de l'enregistrement de l'outil
ctx.llm.registerAdapter(names, adapter)Révocation automatique de l'enregistrement de l'adaptateur LLM
ctx.effect(() => cleanup)Exécutez la fonction de nettoyage du disposer renvoyée.

注册与卸载的自动清理时序


ctx.effect() : confiez les ressources manuelles au framework.

Certaines ressources ne figurent pas dans la liste ci-dessus, comme une connexion réseau.

Utilisez ctx.effect() pour indiquer au framework comment la nettoyer.

ctx.effect accepte une fonction de rappel. Dans la fonction de rappel, créez des ressources et renvoyez une fonction de nettoyage (disposer).

Ce disposer sera exécuté lorsque le plugin sera déchargé.

disposer(La fonction de nettoyage) est la valeur de retour de la fonction de rappel ctx.effect.

Il décrit "comment détruire les ressources créées cette fois-ci".

Lorsque le plugin est déchargé, le framework l'appellera.

Voici un exemple de minuterie heartbeat :

Exemple

// Chemin du fichier : scratch-plugin/src/heartbeat.ts
import type { Context } from '@deepseek-ai/cordis'

export function apply(ctx: Context) {
  ctx.effect(() => {
    // Créer une minuterie : afficher heartbeat toutes les 5 secondes
    const timer = setInterval(() => {
      console.log('heartbeat')
    }, 5000)

    // La fonction de nettoyage retournée est exécutée lorsque le plugin est déchargé
    // Équivalent à : vous n'avez pas besoin d'appeler clearInterval manuellement dans la logique de déchargement
    return () => clearInterval(timer)
  })
}

Si rien ne doit être fait lors du déchargement, le disposer peut être omis.

Mais une fois que des ressources telles que des minuteurs et des connexions sont créées, veillez à renvoyer la fonction de nettoyage correspondante.


Détails de l'ordre d'exécution

Lorsque le plugin est déchargé, les fonctions de nettoyage sont invoquées dans l'ordre inverse d'enregistrement.

Plusieurs fonctions de nettoyage asynchrones s'exécutent en parallèle ; rien ne garantit qu'elles se termineront une par une.

Les étapes de nettoyage qui ont des dépendances d'ordre doivent être placées dans la même fonction de nettoyage renvoyée par un seul ctx.effect(), et cette fonction de nettoyage est responsable de l'attente sérialisée.

Remarque : cette règle signifie enregistrer d'abord, nettoyer ensuite — les ressources enregistrées plus tard sont nettoyées en premier.


Résumé et auto-test

Les ressources enregistrées via ctx sont automatiquement nettoyées lors du déchargement ; pour les ressources manuelles, utilisez ctx.effect() pour fournir une fonction de nettoyage.

  • 1. Les minuteurs enregistrés via ctx nécessitent-ils un clearInterval manuel ?

  • 2. Quand la fonction de nettoyage de ctx.effect(() => disposer) est-elle exécutée ?

  • 3. Pourquoi le nettoyage dépendant de l'ordre doit-il être placé dans le même effet ?

autres extensions