porsager/postgres

Incorrect constructor parameter types for class `PostgresError`

Open

#703 aberto em 19 de out. de 2023

Ver no GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (6.221 stars) (230 forks)batch import
Typescripthelp wanted

Description

According to the types, to construct a new PostgresError the first argument is a message string:

With this code:

import postgres from "postgres";

const error = new postgres.PostgresError("Error message.");

console.log(Object.entries(error));

What actually logs is:

[
  [ '0', 'E' ],
  [ '1', 'r' ],
  [ '2', 'r' ],
  [ '3', 'o' ],
  [ '4', 'r' ],
  [ '5', ' ' ],
  [ '6', 'm' ],
  [ '7', 'e' ],
  [ '8', 's' ],
  [ '9', 's' ],
  [ '10', 'a' ],
  [ '11', 'g' ],
  [ '12', 'e' ],
  [ '13', '.' ],
  [ 'name', 'PostgresError' ]
]

That's because actually the first argument it seems is supposed to be an Error instance:

https://github.com/porsager/postgres/blob/0428b30937400a7dadc8ed09587c44ef917052a6/src/errors.js#L1-L7

Guia do colaborador

Pilha de tecnologia
javascriptnodejspostgresqltypescript
Domain
backenddatabase
Tipo Issue
bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
under 1 hour
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
fresh
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
clear
Prerequisites
Basic JavaScriptUnderstanding of Postgres.js error handling
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
90
Direção de pesquisa
The issue is in the constructor of PostgresError class in src/errors.js (lines 1-7). Currently, the constructor expects an Error instance as the first argument, but the TypeScript types indicate it should accept a string. The fix likely involves either adjusting the constructor to accept a string and create an Error internally, or updating the type definitions to match the actual implementation. Check the existing tests for PostgresError to ensure the change is consistent.