Как типизировать сервисы для node-postgres?

Question

[Gahoy]

У меня есть такой код:

Express:

// file: '/src/index.ts'

import express, { Application } from "express";

import UserRoutes from "./routes"

const PORT = 3000;
const app: Application = express()

app.use(express.json())
app.use(express.urlencoded({ extended: true }))
app.use('/api/', UserRoutes)

app.listen(PORT, () => console.log('Server started'))

Инициализация node-postgres: [UPDATED]

// file: '/src/db.ts'

import {
  Pool,
  type PoolClient,
  type QueryResult,
  type QueryResultRow
} from 'pg';

const pool = new Pool();

export type DatabaseType = {
  query: (text: string, params?: unknown[]) => Promise<QueryResult<QueryResultRow>>;
  getClient: () => Promise<PoolClient>;
}

const db: DatabaseType = {
  query: (text, params) => pool.query(text, params),
  getClient: () => pool.connect()
};

export default db;

Services:

// file: '/src/services.ts'

import db from './db'

export default {
  getAllUsers: function getAllUsers() {
    return db
      .query('SELECT * FROM users ORDER BY user_id ASC')
      .then((result) => result.rows)
      .catch((error) => error);
  },

  getUserById: function getUserById(userId) {
    return db
      .query('SELECT * FROM users WHERE user_id = $1', [userId])
      .then((result) => result.rows)
      .catch((error) => error);
  },

  updateUser: function updateUser(username, email, userId) {
    return db
      .query(`
        UPDATE users
        SET username = $1, email = $2
        WHERE user_id = $3
        RETURNING *
      `,
        [username, email, userId]
      )
      .then((result) => result.rows)
      .catch((error) => error);
  },

  deleteUser: function deleteUser(userId) {
    return db
      .query('DELETE FROM users WHERE user_id = $1 RETURNING user_id', [userId])
      .then((result) => result.rows)
      .catch((error) => error);
  },

  createUser: function createUser(username, email) {
    return db
      .query(`
        INSERT INTO users (username, email)
        VALUES ($1, $2)
        RETURNING *
      `,
        [username, email]
      )
      .then((result) => result.rows)
      .catch((error) => error);
  },
};

Routes: (не все)

// file: '/src/routes.ts'

import {
  Request,
  Response,
  NextFunction,
  Router
} from "express"

import usersServices from "./services";

async function getAllUsers(
  req: Request,
  res: Response,
  next: NextFunction
) {
  const result = await usersServices.getAllUsers();

  if (result instanceof Error) {
    return next(result);
  }

  res
    .status(200)
    .json({
      data: result,
    });
}

const routes = Router()

routes.get('/users/', getAllUsers);

export default routes

Помогите типизировать db, result, error

ps: здесь использую CJS модули, знаю что TS использует ESM.

Comments

[Дмитрий Беляев]

Помогите типизировать db, result, error

Думаю стоит начать с того, что переписать все на TypeScript.
А так это выглядит как задание, а не вопрос.

[Gahoy]

Дмитрий Беляев, не подумал об этом, спасибо, сейчас перепишу.

[Дмитрий Беляев]

Gahoy, ну и кстати, TypeScript вполне может превратить import в require

[Дмитрий Беляев]

Gahoy, а еще стоит поставить такой пакет:
https://www.npmjs.com/package/@types/pg
так как пакет pg не имеет встроенной типизации, но люди написали ее отдельно

[Gahoy]

Дмитрий Беляев, круто, это уже меняет кое-что.... Сейчас попрбую

[Gahoy]

Дмитрий Беляев, обновил.

не смог типизировать этот код

export default {
  query: (text, params?) => pool.query(text, params),
  getClient: (): Promise<PoolClient> => pool.connect()
}

дальше она у меня используется как db. в сервисах, пока это не протипизирую остальные не смогу, так как не знаю как сделать чтобы промисы принимали верные данные.

[Дмитрий Беляев]

Gahoy, можно так:

import { Pool, type QueryResult, type QueryResultRow } from 'pg';

const pool = new Pool();

export const query = (text: string, params?: unknown[]): Promise<QueryResult<QueryResultRow>> => pool.query(text, params);
export const getClient = () => pool.connect();

заодно разбил объект на отдельные экспорты

[Gahoy]

Дмитрий Беляев, почти все, не нашел, или его там нету.

getAllUsers: function getAllUsers(): Promise<QueryResult<UsersType>> | тут промис с ошибкой, но его не нашел в @types/pg {
    return db
      .query('SELECT * FROM users ORDER BY user_id ASC')
      .then((result) => result)
      .catch((error) => error);
  },

Теперь не могу найти интерфейс ошибки, знаю что типа так нужно вернуть Promise но какой интрфес должен быть у Error не знаю, стандартный Error не те типы возвращает.

[Дмитрий Беляев]

Gahoy, у ошибок всегда неизвестный тип (unknown), так как источник ошибки непредсказуем

.then((result) => result)

эта конструкция бесполезна

.catch((error) => error)

а эта конструкция поймает ошибку и вернет ее туда же где ожидается результат, возможно лучше ее здесь не ловить, либо как-то обернуть возвращаемое значение, чтоб было понятно ошибка это или результат

[Gahoy]

Дмитрий Беляев, я ошибку в маршрутах ловлю, потом передаю next

Вот так:

if (result instanceof Error) {
    return next(result);
  }

так и понимаю что ошибка.

.then((result) => result)
А вот с этим не понял, почему она бесполезна ?

Походу отдельного интерфейса для ошибок нету.

[Gahoy]

Дмитрий Беляев, можете еще объяснить, почему вы использовали

import { Pool, type QueryResult, type QueryResultRow } from 'pg';

а не так

import { Pool, QueryResult,  QueryResultRow } from 'pg';

В этом есть какая-нибудь разница?

[Дмитрий Беляев]

.then((result) => result)
А вот с этим не понял, почему она бесполезна ?

Gahoy, метод then возвращает новый промис, который зарезолвится с результатом колбэка, но в колбэке результат никак не меняется, просто возвращается как есть - греем процессор на бесполезной работе.
https://developer.mozilla.org/en-US/docs/Web/JavaS...

можете еще объяснить, почему вы использовали

import { Pool, type QueryResult, type QueryResultRow } from 'pg';

https://www.typescriptlang.org/docs/handbook/modul...
https://www.typescriptlang.org/tsconfig#isolatedModules
Это позволяет сильно ускорить сборку в некоторых моментах, ничего при этом не сломав.

[Gahoy]

Дмитрий Беляев, кажись понял.

Нужно бы так сделать ?

getAllUsers: function getAllUsers(): Promise<QueryResult<UsersType>> | Error
    return db.query('SELECT * FROM users ORDER BY user_id ASC')
  },

За ссылки спасибо.

[Дмитрий Беляев]

Gahoy, не нужно | Error

[Gahoy]

Дмитрий Беляев, но база может вернуть ошибку. Как мне объект ошибки получить ?

[Дмитрий Беляев]

Gahoy, через catch, просто его в принципе невозможно типизировать, так как эксепшены в js/ts непредсказуемы
В случае express +/- адекватный способ ловить ошибки - это оборачивать все мидлвары в что-то вроде:

import type {
  Request,
  Response,
  NextFunction,
} from 'express';

type Middleware = (req: Request, res: Response, next: NextFunction) => void | Promise<void>;

export function wrapMiddleware(middleware: Middleware) {
  return (async (req, res, next) => {
    try {
      await middleware(req, res, next);
    } catch (e) {
      next(e);
    }
  }) satisfies Middleware;
}

[Gahoy]

Дмитрий Беляев, во как, спасибо Вам за все!

[Gahoy]

Дмитрий Беляев, можете пример показать, как мне wrapMiddleware использовать (выше несколько ответов, вы пример приводили).

Я нашел пример похожий на ваш, но не понимаю как использовать его в роутах:

export type PromiseMiddleware = (req: Request, res: Response) => Promise<any>

export const promisify = (middleware: PromiseMiddleware) =>
  async (req: Request, res: Response, next: NextFunction) => {
    try {
      const result = await middleware(req, res)

      if (result) {
        res.json(result)
      } else {
        next()
      }
    } catch (err) {
      next(err)
    }
  }

и судя по коду, я так понимаю каждый промис всегда обязан возваращать объект, но не понятно как вернуть статус кода тогда, заголовки.

[Дмитрий Беляев]

Gahoy, что-то вроде такого:

const getAllUsers = wrapMiddleware(async (
  req: Request,
  res: Response,
  next: NextFunction
) => {
  const result = await usersServices.getAllUsers();

  res
    .status(200)
    .json({
      data: result,
    });
});