Pular para o conteúdo principal

Introdução

Gere erros de teste (404, 500) sob demanda para verificar se suas páginas de erro são renderizadas corretamente e leia a contagem de requisições da API do projeto.

Mais informações sobre a interface do usuário do módulo https://doc.oneentry.cloud/docs/category/system

🎯 O que este módulo faz?​

O módulo System fornece utilitários em nível de sistema. Ele permite que você teste o tratamento de páginas de erro - simule erros 404 e 500 para verificar se suas páginas de erro são exibidas corretamente antes que os usuários encontrem problemas reais - e expõe getApiStat() para ler a contagem de requisições da API do projeto.

Os métodos de erro (test404, test500) acionam um redirecionamento para a página de erro correspondente, para que você possa confirmar se o tratamento de erros está implementado corretamente. Use-os durante o desenvolvimento e testes, não no código de produção.

🚀 Início Rápido​

Inicialize o módulo a partir de defineOneEntry:


const { System } = defineOneEntry(
  "your-project-url", {
    "token": "your-app-token"
  }
);

Leia a contagem de requisições da API do projeto:

// Returns an object with the API request count for the project.
const stat = await System.getApiStat();

console.log('API usage:', stat);

test404() e test500() lançam erros intencionalmente para exercitar seu tratamento de erros, então chame-os dentro de um try/catch:

try {
  await System.test404();
} catch (error) {
  // Your 404 handling runs here.
  console.log('404 handler fired', error);
}

✨ Conceitos Chave​

O que é o Módulo System?​

O módulo System fornece utilitários de teste e diagnóstico:

  • Teste de erro - Simule erros 404 / 500 com test404() / test500()
  • Validação de página de erro - Confirme se suas páginas de erro personalizadas são renderizadas
  • Uso da API - Leia a contagem de requisições da API do projeto com getApiStat()
  • Ferramenta de desenvolvimento - Use os métodos de erro durante o desenvolvimento/testes, não em produção

Tipos de Erro​

Código de ErroNomeQuando OcorreCaso de Uso
404Não EncontradoRecurso solicitado não existePágina não encontrada, produto ausente
500Erro Interno do ServidorOcorreu um erro do lado do servidorFalha no banco de dados, erro de código

Fluxo de Trabalho de Teste​

1. Develop custom 404 and 500 pages
   ↓
2. Implement error handling (try/catch, error boundaries)
   ↓
3. Trigger errors with System.test404() / System.test500()
   ↓
4. Verify your error pages display correctly
   ↓
5. Remove the test calls before deploying to production

📋 O Que Você Precisa Saber​

Os métodos de erro são apenas para teste​

Use test404() e test500() apenas durante desenvolvimento e testes - eles lançam erros para exercitar sua lógica de tratamento. Execute-os em desenvolvimento/estágio e remova as chamadas de teste antes da produção. Erros reais 404/500 devem ser tratados com seu próprio try/catch e limites de erro.

Registro e monitoramento são sua responsabilidade​

O módulo System não registra ou monitora erros. O registro e monitoramento devem ser feitos em sua própria aplicação ou em ferramentas de terceiros - use os métodos de teste para acionar erros e confirmar que seu rastreamento funciona.

Páginas de erro personalizadas são suas para construir​

O módulo apenas aciona erros; você deve criar as páginas personalizadas de 404 e 500 e a lógica de tratamento em seu aplicativo.

📊 Tabela de Referência Rápida​

MétodoDescriçãoLançaCaso de Uso
test404()Simular erro 404 Não EncontradoErro 404Testar página de erro 404
test500()Simular Erro 500 do ServidorErro 500Testar página de erro 500
getApiStat()Obter a contagem de requisições da API—Monitorar uso da API

❓ Perguntas Comuns (FAQ)​

Quando devo usar os métodos de erro?​

Use test404() e test500() apenas durante o desenvolvimento e testes para verificar se suas páginas de erro funcionam corretamente. Nunca os use no código de produção - eles são puramente uma ferramenta de teste para validar o tratamento de erros.

Como faço para testar minhas páginas de erro personalizadas?​

Chame System.test404() ou System.test500() em seu ambiente de desenvolvimento, dentro de um try/catch. Esses métodos lançam erros, acionando sua lógica de tratamento de erros para que você possa verificar se as páginas de erro personalizadas são renderizadas corretamente.

Qual é a diferença entre test404() e test500()?​

test404() simula um erro "Não Encontrado" (recurso não existe), enquanto test500() simula um "Erro Interno do Servidor" (falha do lado do servidor). Teste ambos para garantir que todos os cenários de erro sejam tratados corretamente.

O que getApiStat() retorna?​

Ele retorna um objeto com a contagem de requisições da API do projeto, útil para monitorar o uso da API.

🎓 Melhores Práticas​

  • Use os métodos de erro apenas em ambientes de teste - Nunca acione erros de teste em produção.
  • Envolva chamadas de teste em try/catch - Tanto test404() quanto test500() lançam erros intencionalmente.
  • Implemente páginas de erro personalizadas - O módulo apenas aciona erros; as páginas são suas para construir.
  • Verifique o rastreamento de erros - Use os métodos de teste para confirmar que seu monitoramento/registro funciona.
  • Remova chamadas de teste antes da implantação - Limpe as chamadas test404() / test500() antes da produção.

🔗 Documentação Relacionada​