Métadonnées des tâches

Attention

Vitest expose une API privée expérimentale. Des changements majeurs peuvent ne pas suivre SemVer, veuillez épingler la version de Vitest lors de son utilisation.

Si vous développez un reporter personnalisé ou utilisez l’API Node.js de Vitest, il peut être utile de passer des données depuis les tests qui sont exécutés dans divers contextes à votre reporter ou gestionnaire personnalisé de Vitest.

Pour ce faire, s’appuyer sur le contexte de test n’est pas faisable car il ne peut pas être sérialisé. Cependant, avec Vitest, vous pouvez utiliser la propriété meta disponible sur chaque tâche (suite ou test) pour partager des données entre vos tests et le processus Node.js. Il est important de noter que cette communication est unidirectionnelle, car la propriété meta ne peut être modifiée que depuis le contexte de test. Les modifications apportées dans le contexte Node.js ne seront pas visibles dans vos tests.

Vous pouvez remplir la propriété meta dans le contexte de test ou à l’intérieur des hooks beforeAll/afterAll pour les tâches de suite.

afterAll((suite) => {
  suite.meta.done = true
})

test('personnalisé', ({ task }) => {
  task.meta.custom = 'certain-handler-personnalisé'
})

Une fois qu’un test est terminé, Vitest enverra une tâche comprenant le résultat et meta au processus Node.js en utilisant RPC. Pour intercepter et traiter cette tâche, vous pouvez utiliser la méthode onTaskUpdate disponible dans votre implémentation de reporter :

custom-reporter.js

export default {
  // vous pouvez intercepter des paquets si nécessaire
  onTaskUpdate(packs) {
    const [id, result, meta] = packs[0]
  },
  // meta est situé sur chaque tâche à l'intérieur de "onFinished"
  onFinished(files) {
    files[0].meta.done === true
    files[0].tasks[0].meta.custom === 'certain-handler-personnalisé'
  }
}

Attention

Vitest peut envoyer plusieurs tâches en même temps si plusieurs tests sont terminés dans un court laps de temps.

ATTENTION

Vitest utilise différentes méthodes pour communiquer avec le processus Node.js.

• Si Vitest exécute des tests dans des fils de travail, il enverra des données via message port
• Si Vitest utilise un processus enfant, les données seront envoyées sous forme de Buffer sérialisé via l’API process.send
• Si Vitest exécute des tests dans le navigateur, les données seront converties en chaîne à l’aide du package flatted

Cette propriété est également présente sur chaque test dans le reporter json, donc assurez-vous que les données peuvent être sérialisées en JSON.

Assurez-vous également de sérialiser les propriétés d’erreur avant de les définir.

Vous pouvez également obtenir cette information à partir de l’état de Vitest lorsque les tests ont terminé de s’exécuter :

const vitest = await createVitest('test')
await vitest.start()
vitest.state.getFiles()[0].meta.done === true
vitest.state.getFiles()[0].tasks[0].meta.custom === 'certain-handler-personnalisé'

Il est également possible d’étendre les définitions de type lors de l’utilisation de TypeScript :

declare module 'vitest' {
  interface TaskMeta {
    done?: boolean
    custom?: string
  }
}