Vize

vize:croquis/cf/watcheffect-async

Proteja o trabalho assíncrono de watchEffect contra invalidação e respostas desatualizadas.

Severidade padrão Correção automática Opções
error Nenhuma; revise os arquivos relacionados e aplique a correção Sem opções por código; os diagnósticos suportados pela CLI aceitam substituições de severidade

Aplicável a: Grafo de componentes analisado e fatos suportados descritos abaixo

Escopo e limitações

O watchEffect assíncrono mostrado aqui não tem limpeza na invalidação nem proteção contra respostas desatualizadas. O Vue oferece limpeza para watchEffect; o exemplo correto usa uma origem de watch explícita e cancela o trabalho invalidado.

Arquivos compartilhados do projeto

Use estes arquivos sem alterações nos exemplos incorreto e correto. Instale os pacotes importados no projeto: Vue, além de vue-router ou Pinia onde indicado. Siga as notas de suporte específicas de versão. A raiz de entrada torna explícita a relação entre os componentes.

main.ts

import { createApp } from "vue";
import Root from "./SearchPage.vue";
createApp(Root).mount("#app");

index.html

<div id="app"></div>
<script type="module" src="/main.ts"></script>

api.ts

export interface Result { items: string[]; }
export async function load(query: string, options?: { signal?: AbortSignal }): Promise<Result> {
  const response = await fetch(`/search?q=${encodeURIComponent(query)}`, options);
  return response.json();
}

Incorreto

O watchEffect assíncrono mostrado aqui não tem limpeza na invalidação nem proteção contra uma resposta desatualizada. O watchEffect assíncrono mistura a coleta implícita de dependências com uma requisição aguardada e sem uma proteção contra invalidação.

SearchPage.vue

<script setup lang="ts">
import { ref } from "vue";
import SearchResults from "./SearchResults.vue";

const query = ref("");
</script>

<template>
  <SearchResults :query="query" />
</template>

SearchResults.vue

<script setup lang="ts">
import { load, type Result } from "./api";
import { ref, watchEffect } from "vue";

const props = defineProps<{ query: string }>();
const result = ref<Result | null>(null);

watchEffect(async () => {
  result.value = await load(props.query);
});
</script>

Correto

Um watch(() => props.query, ...) explícito declara a origem, registra a limpeza da requisição e recusa uma resposta desatualizada após a invalidação.

SearchPage.vue

<script setup lang="ts">
import { ref } from "vue";
import SearchResults from "./SearchResults.vue";

const query = ref("");
</script>

<template>
  <SearchResults :query="query" />
</template>

SearchResults.vue

<script setup lang="ts">
import { load, type Result } from "./api";
import { ref, watch } from "vue";

const props = defineProps<{ query: string }>();
const result = ref<Result | null>(null);

watch(
  () => props.query,
  async (value, _oldValue, onCleanup) => {
    const controller = new AbortController();
    let active = true;

    onCleanup(() => {
      active = false;
      controller.abort();
    });

    const next = await load(value, { signal: controller.signal });
    if (active) result.value = next;
  },
);
</script>

Configuração (Vite+)

import { defineConfig } from "@vizejs/vite-plugin/vite-plus";

export default defineConfig({}).withVue({
  linter: { preset: "incremental", crossFile: true,
    rules: { "croquis/cf/watcheffect-async": "warn" },
  },
});
vp run lint

Páginas relacionadas

Explicação pública

Produtor

Índice de verificações entre arquivos