ts-safeql / safeql

Validate and auto-generate TypeScript types from raw SQL queries in PostgreSQL.
https://safeql.dev
MIT License
1.34k stars 22 forks source link

Selecting arrays yields nullable type #235

Closed timvandam closed 3 months ago

timvandam commented 3 months ago

Describe the bug A clear and concise description of what the bug is.

When selecting an array column (eg VARCHAR(255)[]) the inferred type is nullable, even when the column is non nullable.

To Reproduce Steps to reproduce the behavior:

await sql`
    CREATE TABLE users
    (
        id         SERIAL PRIMARY KEY,
        public_id  VARCHAR(255) UNIQUE NOT NULL,
        username   VARCHAR(255) UNIQUE NOT NULL,
        roles      VARCHAR(255)[]      NOT NULL,
        created_at TIMESTAMPTZ         NOT NULL DEFAULT NOW(),
        updated_at TIMESTAMPTZ         NOT NULL DEFAULT NOW()
    );`;
// this is the inferred type, but it should be string[]
const [user] = await sql<{ public_id: string; username: string; roles: string[] | null }>`
    SELECT public_id, username, roles
    FROM users
    WHERE public_id = ${publicId}
    LIMIT 1;`;

Expected behavior A clear and concise description of what you expected to happen.

It should yield roles: string[]

Screenshots If applicable, add screenshots to help explain your problem.

Desktop (please complete the following information):

Additional context Add any other context about the problem here.

I've checked whether postgres can somehow return NULL here, but it seems not. Inserting NULL is also not possible, i.e.

insert into users (public_id, username, roles)
VALUES ('test', 'test', NULL);

fails

timvandam commented 3 months ago

Closing for now since this seems to have fixed itself

Newbie012 commented 3 months ago

Technically, it is possible that an array would contain null values:

CREATE TEMP TABLE example_table (
    id SERIAL PRIMARY KEY,
    array_column TEXT[]
);

INSERT INTO example_table (array_column) VALUES
('{"element1", NULL, "element3"}'),
('{"element4", "element5", NULL}'),
(NULL);

select * from example_table;

maybe I should add a strict.* options

timvandam commented 3 months ago

In your table you do not have a NOT NULL on array_column. If I add that the insert fails

Newbie012 commented 3 months ago

Oh you're right... my bad

Newbie012 commented 3 months ago

Oh wait, I wasn't wrong:

DROP TABLE IF EXISTS example_table;

CREATE TEMP TABLE example_table (
    id SERIAL PRIMARY KEY,
    array_column TEXT[] NOT NULL
);

INSERT INTO example_table (array_column) VALUES
('{"element1", NULL, "element3"}'),
('{"element4", "element5", NULL}');

select * from example_table;
timvandam commented 3 months ago

A I see what you mean now, but then the type would is still wrong. I got roles: string[] | null instead of roles: (string | null)[]. However I'm getting string[] now

Newbie012 commented 3 months ago

Yeah, the original issue was probably due to a caching issue, restarting ESLint would fix that.

In any case, As I wrote previously, I might consider adding strict flags, or change the behavior with a major version