Actualmente, la API REST se ha convertido en el estándar para el desarrollo de aplicaciones web, permitiendo dividir el desarrollo en partes independientes. Para la interfaz de usuario, se utilizan varios marcos populares como Angular, React, Vue y otros. Por su parte, los desarrolladores de backend pueden elegir entre una gran variedad de lenguajes y marcos. Hoy, me gustaría hablar sobre un marco llamado NestJS. En TestMace lo utilizamos activamente para proyectos internos. Usando nest y el paquete @nestjsx/crud, crearemos una simple aplicación CRUD.

Por qué elegir NestJS

Últimamente, han surgido bastantes marcos de backend en la comunidad de JavaScript. Y aunque en términos de funcionalidad ofrecen capacidades similares a las de Nest, hay un aspecto en el que definitivamente destaca: su arquitectura. Las siguientes características de NestJS permiten crear aplicaciones industriales y escalar el desarrollo a grandes equipos:

• uso de TypeScript como el lenguaje de desarrollo principal. Aunque NestJS también admite JavaScript, parte de la funcionalidad puede no funcionar, especialmente cuando se trata de paquetes de terceros;
• la disponibilidad de un contenedor DI, lo que permite crear componentes débilmente acoplados;
• la funcionalidad del marco en sí se divide en componentes independientes y reemplazables. Por ejemplo, bajo el capó, el marco puede utilizar tanto express, como fastify, y para trabajar con bases de datos, nest ofrece de manera predeterminada vínculos a typeorm, mongoose, sequelize;
• NestJS no depende de la plataforma y admite REST, GraphQL, Websockets, gRPC, etc.

El propio marco se inspira en el marco de frontend Angular y conceptualmente tiene mucho en común con él.

Instalación de NestJS y despliegue del proyecto

Nest contiene el paquete nest/cli, который позволяет быстро развернуть базовый каркас приложения. Установим глобально данный пакет:

npm install --global @nest/cli

Después de la instalación, generaremos la estructura básica de nuestra aplicación con el nombre nest-rest. Esto se hace utilizando el comando nest new nest-rest.

nest new nest-rest

dmitrii@dmitrii-HP-ZBook-17-G3:~\/projects $ nest new nest-rest
  Vamos a crear tu aplicación en unos segundos..

CREAR \/nest-rest\/.prettierrc (51 bytes)
CREAR \/nest-rest\/README.md (3370 bytes)
CREAR \/nest-rest\/nest-cli.json (84 bytes)
CREAR \/nest-rest\/nodemon-debug.json (163 bytes)
CREAR \/nest-rest\/nodemon.json (67 bytes)
CREAR \/nest-rest\/package.json (1805 bytes)
CREAR \/nest-rest\/tsconfig.build.json (97 bytes)
CREAR \/nest-rest\/tsconfig.json (325 bytes)
CREAR \/nest-rest\/tslint.json (426 bytes)
CREAR \/nest-rest\/src\/app.controller.spec.ts (617 bytes)
CREAR \/nest-rest\/src\/app.controller.ts (274 bytes)
CREAR \/nest-rest\/src\/app.module.ts (249 bytes)
CREAR \/nest-rest\/src\/app.service.ts (142 bytes)
CREAR \/nest-rest\/src\/main.ts (208 bytes)
CREAR \/nest-rest\/test\/app.e2e-spec.ts (561 bytes)
CREAR \/nest-rest\/test\/jest-e2e.json (183 bytes)

? ¿Qué gestor de paquetes te gustaría usar? yarn
 Instalación en progreso... 

  Proyecto nest-rest creado con éxito
  Comienza con los siguientes comandos:

$ cd nest-rest
$ yarn run start

                          Gracias por instalar Nest 
                 Por favor, considera donar a nuestro colectivo abierto
                        para ayudarnos a mantener este paquete.

                 Dona: https://opencollective.com/nest

Como gestor de paquetes, elegiremos yarn.
Por el momento puedes iniciar el servidor con el comando npm start y luego puedes acceder a la dirección http://localhost:3000 puedes ver la página de inicio. Sin embargo, no estamos aquí para eso y avanzamos.

Configurando la conexión con la base de datos

Como SGBD para este artículo, he elegido PostgreSQL. Sobre gustos no hay disputas, en mi opinión, es el SGBD más maduro, que posee todas las funcionalidades necesarias. Como ya se mencionó, para trabajar con bases de datos, Nest proporciona integración con varios paquetes. Dado que mi elección fue PostgreSQL, será lógico optar por TypeORM como ORM. Instalemos los paquetes necesarios para la integración con la base de datos:

yarn add typeorm @nestjs\/typeorm pg

En orden, para qué sirve cada paquete:

1. typeorm — paquete directamente con la misma ORM;
2. @nestjs\/typeorm — paquete TypeORM para NestJS. Agrega módulos para importar en los módulos del proyecto, así como un conjunto de decoradores auxiliares;
3. pg — driver para trabajar con PostgreSQL.

Bien, los paquetes están instalados, ahora es necesario iniciar la base de datos. Para desplegar la base usaré docker-compose.yml con el siguiente contenido:

docker-compose.yml

version: '3.1'

services:
  db:
    image: postgres:11.2
    restart: always
    environment:
      POSTGRES_PASSWORD: example
    volumes:
      - ..\/db:\/var\/lib\/postgresql\/data
      - .\/postgresql.conf:\/etc\/postgresql\/postgresql.conf
    ports:
      - 5432:5432
  adminer:
    image: adminer
    restart: always
    ports:
      - 8080:8080

Como puedes ver, este archivo configura el lanzamiento de 2 contenedores:

1. db — este es el contenedor directamente con la base de datos. En nuestro caso se utiliza postgresql versión 11.2;
2. adminer — gestor de la base de datos. Proporciona una interfaz web para ver y administrar la base.

Para trabajar con conexiones tcp, he añadido una configuración de este contenido.

postgresql.conf

# -----------------------------
# PostgreSQL configuration file
# -----------------------------
#
# This file consists of lines of the form:
#
#   name = value
#
# (The "=" is optional.)  Whitespace may be used.  Comments are introduced with
# "#" anywhere on a line.  The complete list of parameter names and allowed
# values can be found in the PostgreSQL documentation.
#
# The commented-out settings shown in this file represent the default values.
# Re-commenting a setting is NOT sufficient to revert it to the default value;
# you need to reload the server.
#
# This file is read on server startup and when the server receives a SIGHUP
# signal.  If you edit the file on a running system, you have to SIGHUP the
# server for the changes to take effect, run "pg_ctl reload", or execute
# "SELECT pg_reload_conf()".  Some parameters, which are marked below,
# require a server shutdown and restart to take effect.
#
# Any parameter can also be given as a command-line option to the server, e.g.,
# "postgres -c log_connections=on".  Some parameters can be changed at run time
# with the "SET" SQL command.
#
# Memory units:  kB = kilobytes        Time units:  ms  = milliseconds
#                MB = megabytes                     s   = seconds
#                GB = gigabytes                     min = minutes
#                TB = terabytes                     h   = hours
#                                                   d   = days

#------------------------------------------------------------------------------
# FILE LOCATIONS
#------------------------------------------------------------------------------

# The default values of these variables are driven from the -D command-line
# option or PGDATA environment variable, represented here as ConfigDir.

#data_directory = 'ConfigDir'       # use data in another directory
                    # (change requires restart)
#hba_file = 'ConfigDir/pg_hba.conf' # host-based authentication file
                    # (change requires restart)
#ident_file = 'ConfigDir/pg_ident.conf' # ident configuration file
                    # (change requires restart)

# If external_pid_file is not explicitly set, no extra PID file is written.
#external_pid_file = ''         # write an extra PID file
                    # (change requires restart)

#------------------------------------------------------------------------------
# CONNECTIONS AND AUTHENTICATION
#------------------------------------------------------------------------------

# - Connection Settings -
listen_addresses = '*'
#listen_addresses = 'localhost'     # what IP address(es) to listen on;
                    # comma-separated list of addresses;
                    # defaults to 'localhost'; use '*' for all
                    # (change requires restart)
#port = 5432                # (change requires restart)
#max_connections = 100          # (change requires restart)
#superuser_reserved_connections = 3 # (change requires restart)
#unix_socket_directories = '/tmp'   # comma-separated list of directories
                    # (change requires restart)
#unix_socket_group = ''         # (change requires restart)
#unix_socket_permissions = 0777     # begin with 0 to use octal notation
                    # (change requires restart)
#bonjour = off              # advertise server via Bonjour
                    # (change requires restart)
#bonjour_name = ''          # defaults to the computer name
                    # (change requires restart)

# - TCP Keepalives -
# see "man 7 tcp" for details

#tcp_keepalives_idle = 0        # TCP_KEEPIDLE, in seconds;
                    # 0 selects the system default
#tcp_keepalives_interval = 0        # TCP_KEEPINTVL, in seconds;
                    # 0 selects the system default
#tcp_keepalives_count = 0       # TCP_KEEPCNT;
                    # 0 selects the system default

# - Authentication -

#authentication_timeout = 1min      # 1s-600s
#password_encryption = md5      # md5 or scram-sha-256
#db_user_namespace = off

# GSSAPI using Kerberos
#krb_server_keyfile = ''
#krb_caseins_users = off

# - SSL -

#ssl = off
#ssl_ca_file = ''
#ssl_cert_file = 'server.crt'
#ssl_crl_file = ''
#ssl_key_file = 'server.key'
#ssl_ciphers = 'HIGH:MEDIUM:+3DES:!aNULL' # allowed SSL ciphers
#ssl_prefer_server_ciphers = on
#ssl_ecdh_curve = 'prime256v1'
#ssl_min_protocol_version = 'TLSv1'
#ssl_max_protocol_version = ''
#ssl_dh_params_file = ''
#ssl_passphrase_command = ''
#ssl_passphrase_command_supports_reload = off

#------------------------------------------------------------------------------
# RESOURCE USAGE (except WAL)
#------------------------------------------------------------------------------

# - Memory -

#shared_buffers = 32MB          # min 128kB
                    # (change requires restart)
#huge_pages = try           # on, off, or try
                    # (change requires restart)
#temp_buffers = 8MB         # min 800kB
#max_prepared_transactions = 0      # zero disables the feature
                    # (change requires restart)
# Caution: it is not advisable to set max_prepared_transactions nonzero unless
# you actively intend to use prepared transactions.
#work_mem = 4MB             # min 64kB
#maintenance_work_mem = 64MB        # min 1MB
#autovacuum_work_mem = -1       # min 1MB, or -1 to use maintenance_work_mem
#max_stack_depth = 2MB          # min 100kB
#shared_memory_type = mmap      # the default is the first option
                    # supported by the operating system:
                    #   mmap
                    #   sysv
                    #   windows
                    # (change requires restart)
#dynamic_shared_memory_type = posix # the default is the first option
                    # supported by the operating system:
                    #   posix
                    #   sysv
                    #   windows
                    #   mmap
                    # (change requires restart)

# - Disk -

#temp_file_limit = -1           # limits per-process temp file space
                    # in kB, or -1 for no limit

# - Kernel Resources -

#max_files_per_process = 1000       # min 25
                    # (change requires restart)

# - Cost-Based Vacuum Delay -

#vacuum_cost_delay = 0          # 0-100 milliseconds (0 disables)
#vacuum_cost_page_hit = 1       # 0-10000 credits
#vacuum_cost_page_miss = 10     # 0-10000 credits
#vacuum_cost_page_dirty = 20        # 0-10000 credits
#vacuum_cost_limit = 200        # 1-10000 credits

# - Background Writer -

#bgwriter_delay = 200ms         # 10-10000ms between rounds
#bgwriter_lru_maxpages = 100        # max buffers written/round, 0 disables
#bgwriter_lru_multiplier = 2.0      # 0-10.0 multiplier on buffers scanned/round
#bgwriter_flush_after = 0       # measured in pages, 0 disables

# - Asynchronous Behavior -

#effective_io_concurrency = 1       # 1-1000; 0 disables prefetching
#max_worker_processes = 8       # (change requires restart)
#max_parallel_maintenance_workers = 2   # taken from max_parallel_workers
#max_parallel_workers_per_gather = 2    # taken from max_parallel_workers
#parallel_leader_participation = on
#max_parallel_workers = 8       # maximum number of max_worker_processes that
                    # can be used in parallel operations
#old_snapshot_threshold = -1        # 1min-60d; -1 disables; 0 is immediate
                    # (change requires restart)
#backend_flush_after = 0        # measured in pages, 0 disables

#------------------------------------------------------------------------------
# WRITE-AHEAD LOG
#------------------------------------------------------------------------------

# - Settings -

#wal_level = replica            # minimal, replica, or logical
                    # (change requires restart)
#fsync = on             # flush data to disk for crash safety
                    # (turning this off can cause
                    # unrecoverable data corruption)
#synchronous_commit = on        # synchronization level;
                    # off, local, remote_write, remote_apply, or on
#wal_sync_method = fsync        # the default is the first option
                    # supported by the operating system:
                    #   open_datasync
                    #   fdatasync (default on Linux)
                    #   fsync
                    #   fsync_writethrough
                    #   open_sync
#full_page_writes = on          # recover from partial page writes
#wal_compression = off          # enable compression of full-page writes
#wal_log_hints = off            # also do full page writes of non-critical updates
                    # (change requires restart)
#wal_buffers = -1           # min 32kB, -1 sets based on shared_buffers
                    # (change requires restart)
#wal_writer_delay = 200ms       # 1-10000 milliseconds
#wal_writer_flush_after = 1MB       # measured in pages, 0 disables

#commit_delay = 0           # range 0-100000, in microseconds
#commit_siblings = 5            # range 1-1000

# - Checkpoints -

#checkpoint_timeout = 5min      # range 30s-1d
#max_wal_size = 1GB
#min_wal_size = 80MB
#checkpoint_completion_target = 0.5 # checkpoint target duration, 0.0 - 1.0
#checkpoint_flush_after = 0     # measured in pages, 0 disables
#checkpoint_warning = 30s       # 0 disables

# - Archiving -

#archive_mode = off     # enables archiving; off, on, or always
                # (change requires restart)
#archive_command = ''       # command to use to archive a logfile segment
                # placeholders: %p = path of file to archive
                #               %f = file name only
                # e.g. 'test ! -f /mnt/server/archivedir/%f && cp %p /mnt/server/archivedir/%f'
#archive_timeout = 0        # force a logfile segment switch after this
                # number of seconds; 0 disables

# - Archive Recovery -

# These are only used in recovery mode.

#restore_command = ''       # command to use to restore an archived logfile segment
                # placeholders: %p = path of file to restore
                #               %f = file name only
                # e.g. 'cp /mnt/server/archivedir/%f %p'
                # (change requires restart)
#archive_cleanup_command = ''   # command to execute at every restartpoint
#recovery_end_command = ''  # command to execute at completion of recovery

# - Recovery Target -

# Set these only when performing a targeted recovery.

#recovery_target = ''       # 'immediate' to end recovery as soon as a
                                # consistent state is reached
                # (change requires restart)
#recovery_target_name = ''  # the named restore point to which recovery will proceed
                # (change requires restart)
#recovery_target_time = ''  # the time stamp up to which recovery will proceed
                # (change requires restart)
#recovery_target_xid = ''   # the transaction ID up to which recovery will proceed
                # (change requires restart)
#recovery_target_lsn = ''   # the WAL LSN up to which recovery will proceed
                # (change requires restart)
#recovery_target_inclusive = on # Specifies whether to stop:
                # just after the specified recovery target (on)
                # just before the recovery target (off)
                # (change requires restart)
#recovery_target_timeline = 'latest'    # 'current', 'latest', or timeline ID
                # (change requires restart)
#recovery_target_action = 'pause'   # 'pause', 'promote', 'shutdown'
                # (change requires restart)

#------------------------------------------------------------------------------
# REPLICATION
#------------------------------------------------------------------------------

# - Sending Servers -

# Set these on the master and on any standby that will send replication data.

#max_wal_senders = 10       # max number of walsender processes
                # (change requires restart)
#wal_keep_segments = 0      # in logfile segments; 0 disables
#wal_sender_timeout = 60s   # in milliseconds; 0 disables

#max_replication_slots = 10 # max number of replication slots
                # (change requires restart)
#track_commit_timestamp = off   # collect timestamp of transaction commit
                # (change requires restart)

# - Master Server -

# These settings are ignored on a standby server.

#synchronous_standby_names = '' # standby servers that provide sync rep
                # method to choose sync standbys, number of sync standbys,
                # and comma-separated list of application_name
                # from standby(s); '*' = all
#vacuum_defer_cleanup_age = 0   # number of xacts by which cleanup is delayed

# - Standby Servers -

# These settings are ignored on a master server.

#primary_conninfo = ''          # connection string to sending server
                    # (change requires restart)
#primary_slot_name = ''         # replication slot on sending server
                    # (change requires restart)
#promote_trigger_file = ''      # file name whose presence ends recovery
#hot_standby = on           # "off" disallows queries during recovery
                    # (change requires restart)
#max_standby_archive_delay = 30s    # max delay before canceling queries
                    # when reading WAL from archive;
                    # -1 allows indefinite delay
#max_standby_streaming_delay = 30s  # max delay before canceling queries
                    # when reading streaming WAL;
                    # -1 allows indefinite delay
#wal_receiver_status_interval = 10s # send replies at least this often
                    # 0 disables
#hot_standby_feedback = off     # send info from standby to prevent
                    # query conflicts
#wal_receiver_timeout = 60s     # time that receiver waits for
                    # communication from master
                    # in milliseconds; 0 disables
#wal_retrieve_retry_interval = 5s   # time to wait before retrying to
                    # retrieve WAL after a failed attempt
#recovery_min_apply_delay = 0       # minimum delay for applying changes during recovery

# - Subscribers -

# These settings are ignored on a publisher.

#max_logical_replication_workers = 4    # taken from max_worker_processes
                    # (change requires restart)
#max_sync_workers_per_subscription = 2  # taken from max_logical_replication_workers

#------------------------------------------------------------------------------
# QUERY TUNING
#------------------------------------------------------------------------------

# - Planner Method Configuration -

#enable_bitmapscan = on
#enable_hashagg = on
#enable_hashjoin = on
#enable_indexscan = on
#enable_indexonlyscan = on
#enable_material = on
#enable_mergejoin = on
#enable_nestloop = on
#enable_parallel_append = on
#enable_seqscan = on
#enable_sort = on
#enable_tidscan = on
#enable_partitionwise_join = off
#enable_partitionwise_aggregate = off
#enable_parallel_hash = on
#enable_partition_pruning = on

# - Planner Cost Constants -

#seq_page_cost = 1.0            # measured on an arbitrary scale
#random_page_cost = 4.0         # same scale as above
#cpu_tuple_cost = 0.01          # same scale as above
#cpu_index_tuple_cost = 0.005       # same scale as above
#cpu_operator_cost = 0.0025     # same scale as above
#parallel_tuple_cost = 0.1      # same scale as above
#parallel_setup_cost = 1000.0   # same scale as above

#jit_above_cost = 100000        # perform JIT compilation if available
                    # and query more expensive than this;
                    # -1 disables
#jit_inline_above_cost = 500000     # inline small functions if query is
                    # more expensive than this; -1 disables
#jit_optimize_above_cost = 500000   # use expensive JIT optimizations if
                    # query is more expensive than this;
                    # -1 disables

#min_parallel_table_scan_size = 8MB
#min_parallel_index_scan_size = 512kB
#effective_cache_size = 4GB

# - Genetic Query Optimizer -

#geqo = on
#geqo_threshold = 12
#geqo_effort = 5            # range 1-10
#geqo_pool_size = 0         # selects default based on effort
#geqo_generations = 0           # selects default based on effort
#geqo_selection_bias = 2.0      # range 1.5-2.0
#geqo_seed = 0.0            # range 0.0-1.0

# - Other Planner Options -

#default_statistics_target = 100    # range 1-10000
#constraint_exclusion = partition   # on, off, or partition
#cursor_tuple_fraction = 0.1        # range 0.0-1.0
#from_collapse_limit = 8
#join_collapse_limit = 8        # 1 disables collapsing of explicit
                    # JOIN clauses
#force_parallel_mode = off
#jit = on               # allow JIT compilation
#plan_cache_mode = auto         # auto, force_generic_plan or
                    # force_custom_plan

#------------------------------------------------------------------------------
# REPORTING AND LOGGING
#------------------------------------------------------------------------------

# - Where to Log -

#log_destination = 'stderr'     # Valid values are combinations of
                    # stderr, csvlog, syslog, and eventlog,
                    # depending on platform.  csvlog
                    # requires logging_collector to be on.

# This is used when logging to stderr:
#logging_collector = off        # Enable capturing of stderr and csvlog
                    # into log files. Required to be on for
                    # csvlogs.
                    # (change requires restart)

# These are only used if logging_collector is on:
#log_directory = 'log'          # directory where log files are written,
                    # can be absolute or relative to PGDATA
#log_filename = 'postgresql-%Y-%m-%d_%H%M%S.log'    # log file name pattern,
                    # can include strftime() escapes
#log_file_mode = 0600           # creation mode for log files,
                    # begin with 0 to use octal notation
#log_truncate_on_rotation = off     # If on, an existing log file with the
                    # same name as the new log file will be
                    # truncated rather than appended to.
                    # But such truncation only occurs on
                    # time-driven rotation, not on restarts
                    # or size-driven rotation.  Default is
                    # off, meaning append to existing files
                    # in all cases.
#log_rotation_age = 1d          # Automatic rotation of logfiles will
                    # happen after that time.  0 disables.
#log_rotation_size = 10MB       # Automatic rotation of logfiles will
                    # happen after that much log output.
                    # 0 disables.

# These are relevant when logging to syslog:
#syslog_facility = 'LOCAL0'
#syslog_ident = 'postgres'
#syslog_sequence_numbers = on
#syslog_split_messages = on

# This is only relevant when logging to eventlog (win32):
# (change requires restart)
#event_source = 'PostgreSQL'

# - When to Log -

#log_min_messages = warning     # values in order of decreasing detail:
                    #   debug5
                    #   debug4
                    #   debug3
                    #   debug2
                    #   debug1
                    #   info
                    #   notice
                    #   warning
                    #   error
                    #   log
                    #   fatal
                    #   panic

#log_min_error_statement = error    # values in order of decreasing detail:
                    #   debug5
                    #   debug4
                    #   debug3
                    #   debug2
                    #   debug1
                    #   info
                    #   notice
                    #   warning
                    #   error
                    #   log
                    #   fatal
                    #   panic (effectively off)

#log_min_duration_statement = -1    # logs statements and their durations
                    # according to log_statement_sample_rate. -1 is disabled,
                    # 0 logs all statement, > 0 logs only statements running at
                    # least this number of milliseconds.

#log_statement_sample_rate = 1  # Fraction of logged statements over
                    # log_min_duration_statement. 1.0 logs all statements,
                    # 0 never logs.

# - What to Log -

#debug_print_parse = off
#debug_print_rewritten = off
#debug_print_plan = off
#debug_pretty_print = on
#log_checkpoints = off
#log_connections = off
#log_disconnections = off
#log_duration = off
#log_error_verbosity = default      # terse, default, or verbose messages
#log_hostname = off
#log_line_prefix = '%m [%p] '       # special values:
                    #   %a = application name
                    #   %u = user name
                    #   %d = database name
                    #   %r = remote host and port
                    #   %h = remote host
                    #   %p = process ID
                    #   %t = timestamp without milliseconds
                    #   %m = timestamp with milliseconds
                    #   %n = timestamp with milliseconds (as a Unix epoch)
                    #   %i = command tag
                    #   %e = SQL state
                    #   %c = session ID
                    #   %l = session line number
                    #   %s = session start timestamp
                    #   %v = virtual transaction ID
                    #   %x = transaction ID (0 if none)
                    #   %q = stop here in non-session
                    #        processes
                    #   %% = '%'
                    # e.g. '<%u%%%d> '
#log_lock_waits = off           # log lock waits >= deadlock_timeout
#log_statement = 'none'         # none, ddl, mod, all
#log_replication_commands = off
#log_temp_files = -1            # log temporary files equal or larger
                    # than the specified size in kilobytes;
                    # -1 disables, 0 logs all temp files
#log_timezone = 'GMT'

#------------------------------------------------------------------------------
# PROCESS TITLE
#------------------------------------------------------------------------------

#cluster_name = ''          # added to process titles if nonempty
                    # (change requires restart)
#update_process_title = on

#------------------------------------------------------------------------------
# STATISTICS
#------------------------------------------------------------------------------

# - Query and Index Statistics Collector -

#track_activities = on
#track_counts = on
#track_io_timing = off
#track_functions = none         # none, pl, all
#track_activity_query_size = 1024   # (change requires restart)
#stats_temp_directory = 'pg_stat_tmp'

# - Monitoring -

#log_parser_stats = off
#log_planner_stats = off
#log_executor_stats = off
#log_statement_stats = off

#------------------------------------------------------------------------------
# AUTOVACUUM
#------------------------------------------------------------------------------

#autovacuum = on            # Enable autovacuum subprocess?  'on'
                    # requires track_counts to also be on.
#log_autovacuum_min_duration = -1   # -1 disables, 0 logs all actions and
                    # their durations, > 0 logs only
                    # actions running at least this number
                    # of milliseconds.
#autovacuum_max_workers = 3     # max number of autovacuum subprocesses
                    # (change requires restart)
#autovacuum_naptime = 1min      # time between autovacuum runs
#autovacuum_vacuum_threshold = 50   # min number of row updates before
                    # vacuum
#autovacuum_analyze_threshold = 50  # min number of row updates before
                    # analyze
#autovacuum_vacuum_scale_factor = 0.2   # fraction of table size before vacuum
#autovacuum_analyze_scale_factor = 0.1  # fraction of table size before analyze
#autovacuum_freeze_max_age = 200000000  # maximum XID age before forced vacuum
                    # (change requires restart)
#autovacuum_multixact_freeze_max_age = 400000000    # maximum multixact age
                    # before forced vacuum
                    # (change requires restart)
#autovacuum_vacuum_cost_delay = 2ms # default vacuum cost delay for
                    # autovacuum, in milliseconds;
                    # -1 means use vacuum_cost_delay
#autovacuum_vacuum_cost_limit = -1  # default vacuum cost limit for
                    # autovacuum, -1 means use
                    # vacuum_cost_limit

#------------------------------------------------------------------------------
# CLIENT CONNECTION DEFAULTS
#------------------------------------------------------------------------------

# - Statement Behavior -

#client_min_messages = notice       # values in order of decreasing detail:
                    #   debug5
                    #   debug4
                    #   debug3
                    #   debug2
                    #   debug1
                    #   log
                    #   notice
                    #   warning
                    #   error
#search_path = '"$user", public'    # schema names
#row_security = on
#default_tablespace = ''        # a tablespace name, '' uses the default
#temp_tablespaces = ''          # a list of tablespace names, '' uses
                    # only default tablespace
#check_function_bodies = on
#default_transaction_isolation = 'read committed'
#default_transaction_read_only = off
#default_transaction_deferrable = off
#session_replication_role = 'origin'
#statement_timeout = 0          # in milliseconds, 0 is disabled
#lock_timeout = 0           # in milliseconds, 0 is disabled
#idle_in_transaction_session_timeout = 0    # in milliseconds, 0 is disabled
#vacuum_freeze_min_age = 50000000
#vacuum_freeze_table_age = 150000000
#vacuum_multixact_freeze_min_age = 5000000
#vacuum_multixact_freeze_table_age = 150000000
#vacuum_cleanup_index_scale_factor = 0.1    # fraction of total number of tuples
                        # before index cleanup, 0 always performs
                        # index cleanup
#bytea_output = 'hex'           # hex, escape
#xmlbinary = 'base64'
#xmloption = 'content'
#gin_fuzzy_search_limit = 0
#gin_pending_list_limit = 4MB

# - Locale and Formatting -

#datestyle = 'iso, mdy'
#intervalstyle = 'postgres'
#timezone = 'GMT'
#timezone_abbreviations = 'Default'     # Select the set of available time zone
                    # abbreviations.  Currently, there are
                    #   Default
                    #   Australia (historical usage)
                    #   India
                    # You can create your own file in
                    # share/timezonesets/.
#extra_float_digits = 1         # min -15, max 3; any value >0 actually
                    # selects precise output mode
#client_encoding = sql_ascii        # actually, defaults to database
                    # encoding

# These settings are initialized by initdb, but they can be changed.
#lc_messages = 'C'          # locale for system error message
                    # strings
#lc_monetary = 'C'          # locale for monetary formatting
#lc_numeric = 'C'           # locale for number formatting
#lc_time = 'C'              # locale for time formatting

# default configuration for text search
#default_text_search_config = 'pg_catalog.simple'

# - Shared Library Preloading -

#shared_preload_libraries = ''  # (change requires restart)
#local_preload_libraries = ''
#session_preload_libraries = ''
#jit_provider = 'llvmjit'       # JIT library to use

# - Other Defaults -

#dynamic_library_path = '$libdir'

#------------------------------------------------------------------------------
# LOCK MANAGEMENT
#------------------------------------------------------------------------------

#deadlock_timeout = 1s
#max_locks_per_transaction = 64     # min 10
                    # (change requires restart)
#max_pred_locks_per_transaction = 64    # min 10
                    # (change requires restart)
#max_pred_locks_per_relation = -2   # negative values mean
                    # (max_pred_locks_per_transaction
                    #  / -max_pred_locks_per_relation) - 1
#max_pred_locks_per_page = 2            # min 0

#------------------------------------------------------------------------------
# VERSION AND PLATFORM COMPATIBILITY
#------------------------------------------------------------------------------

# - Previous PostgreSQL Versions -

#array_nulls = on
#backslash_quote = safe_encoding    # on, off, or safe_encoding
#escape_string_warning = on
#lo_compat_privileges = off
#operator_precedence_warning = off
#quote_all_identifiers = off
#standard_conforming_strings = on
#synchronize_seqscans = on

# - Other Platforms and Clients -

#transform_null_equals = off

#------------------------------------------------------------------------------
# ERROR HANDLING
#------------------------------------------------------------------------------

#exit_on_error = off            # terminate session on any error?
#restart_after_crash = on       # reinitialize after backend crash?
#data_sync_retry = off          # retry or panic on failure to fsync
                    # data?
                    # (change requires restart)

#------------------------------------------------------------------------------
# CONFIG FILE INCLUDES
#------------------------------------------------------------------------------

# These options allow settings to be loaded from files other than the
# default postgresql.conf.

#include_dir = 'conf.d'         # include files ending in '.conf' from
                    # directory 'conf.d'
#include_if_exists = 'exists.conf'  # include file only if it exists
#include = 'special.conf'       # include file

#------------------------------------------------------------------------------
# CUSTOMIZED OPTIONS
#------------------------------------------------------------------------------

# Add settings for extensions here

Eso es todo, ahora puedes iniciar los contenedores con el comando docker-compose up -d. O en una consola separada con el comando docker-compose up.

Así que hemos instalado los paquetes, hemos iniciado la base de datos, solo queda conectarlos entre sí. Para ello, es necesario agregar un archivo ormconfig.js en la raíz del proyecto con el siguiente contenido:

ormconfig.js

const process = require('process');

const username = process.env.POSTGRES_USER || "postgres";
const password = process.env.POSTGRES_PASSWORD || "example";

module.exports = {
  "type": "postgres",
  "host": "localhost",
  "port": 5432,
  username,
  password,
  "database": "postgres",
  "synchronize": true,
  "dropSchema": false,
  "logging": true,
  "entities": [__dirname + "\/src\/**\/*.entity.ts", __dirname + "\/dist\/**\/*.entity.js"],
  "migrations": ["migrations\/**\/*.ts"],
  "subscribers": ["subscriber\/**\/*.ts", "dist\/subscriber\/**\/*.js"],
  "cli": {
    "entitiesDir": "src",
    "migrationsDir": "migrations",
    "subscribersDir": "subscriber"
  }
}

Esta configuración será utilizada para cli typeorm.

Detengámonos en esta configuración más detalladamente. En las líneas 3 y 4 obtenemos el nombre de usuario y la contraseña de las variables de entorno. Esto es conveniente cuando tienes varios entornos (dev, stage, prod, etc.). Por defecto, el nombre de usuario es postgres y la contraseña es example. El resto de la configuración es trivial, por lo que solo nos centraremos en los parámetros más interesantes:

• synchronize — indica si el esquema de la base de datos debe crearse automáticamente al iniciar la aplicación. Ten cuidado con esta opción y no la uses en producción, de lo contrario, podrías perder datos. Esta opción es conveniente durante el desarrollo y la depuración de la aplicación. Como alternativa a esta opción, puedes usar el comando schema:sync desde CLI TypeORM.
• dropSchema — restablecer el esquema cada vez que se establece una conexión. Al igual que la anterior, esta opción solo debe usarse en el proceso de desarrollo y depuración de la aplicación.
• entities — las rutas donde buscar descripciones de modelos. Ten en cuenta que se admite la búsqueda por patrón.
• cli.entitiesDir — el directorio donde, por defecto, deben guardarse los modelos creados desde CLI TypeORM.

Para que podamos utilizar todas las funcionalidades de TypeORM en nuestra aplicación Nest, es necesario importar el módulo TypeOrmModule en AppModule. Es decir, tu AppModule se verá de la siguiente manera:

app.module.ts

import { Module } from '@nestjs/common';
import { AppController } from './app.controller';
import { AppService } from './app.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import * as process from "process";

const username = process.env.POSTGRES_USER || 'postgres';
const password = process.env.POSTGRES_PASSWORD || 'example';

@Module({
  imports: [
    TypeOrmModule.forRoot({
      type: 'postgres',
      host: 'localhost',
      port: 5432,
      username,
      password,
      database: 'postgres',
      entities: [__dirname + '/**/*.entity{.ts,.js}'],
      synchronize: true,
    }),
  ],
  controllers: [AppController],
  providers: [AppService],
})
export class AppModule {}

Como habrán notado, en el método forRoot se pasa la misma configuración para trabajar con la base de datos que en el archivo ormconfig.ts

Queda el toque final: agregar algunas tareas para trabajar con TypeORM en package.json. El hecho es que el CLI está escrito en JavaScript y se ejecuta en un entorno de nodejs. Sin embargo, todos nuestros modelos y migraciones estarán escritos en TypeScript. Por lo tanto, es necesario llevar a cabo la transpilación de nuestras migraciones y modelos antes de usar el CLI. Para ello, necesitaremos el paquete ts-node:

yarn add -D ts-node

Después de eso, añadiremos los comandos necesarios en package.json:

"typeorm": "ts-node -r tsconfig-paths/register ./node_modules/typeorm/cli.js",
"migration:generate": "yarn run typeorm migration:generate -n",
"migration:create": "yarn run typeorm migration:create -n",
"migration:run": "yarn run typeorm migration:run"

El primer comando, typeorm, añade una envoltura en forma de ts-node para ejecutar el cli de TypeORM. Los otros comandos son atajos útiles que como desarrollador usarás prácticamente todos los días:
migration:generate — crear una migración basada en los cambios en tus modelos.
migration:create — crear una migración vacía.
migration:run — ejecutar migraciones.
Bueno, ahora sí, hemos añadido los paquetes necesarios, configurado la aplicación para trabajar con la base tanto desde el CLI como desde la propia aplicación y también hemos iniciado la base de datos. Es hora de agregar lógica a nuestra aplicación.

Instalación de paquetes para crear CRUD

Usando solo Nest se puede crear una API que permite crear, leer, actualizar y eliminar una entidad. Esta solución será máxima flexible, sin embargo, en algunos casos puede ser excesiva. Por ejemplo, si necesitas crear un prototipo rápidamente, a menudo se puede sacrificar flexibilidad por velocidad de desarrollo. Muchos marcos ofrecen funcionalidades de generación de CRUD a partir de la descripción del modelo de datos de una entidad determinada. ¡Y Nest no es la excepción! Esta funcionalidad la proporciona el paquete @nestjsx/crud. Sus capacidades son bastante interesantes:

• fácil instalación y configuración;
• independencia de la base de datos;
• un potente lenguaje de consultas con capacidades de filtrado, paginación, ordenación, carga de relaciones y entidades anidadas, almacenamiento en caché, etc.;
• un paquete para formar consultas en el front-end;
• una fácil sobreescritura de los métodos del controlador;
• una pequeña configuración;
• soporte para la documentación de Swagger.

La funcionalidad se divide en varios paquetes:

• @nestjsx/crud — un paquete base que proporciona el decorador Crud() para generar rutas, configurar y validar;
• @nestjsx/crud-request — un paquete que proporciona un constructor/parser de consultas para usar en el lado del frontend;
• @nestjsx/crud-typeorm — un paquete para integración con TypeORM, que proporciona el servicio base TypeOrmCrudService con métodos CRUD para trabajar con entidades en la base de datos.

En esta guía, necesitaremos los paquetes nestjsx/crud y nestjsx/crud-typeorm. Primero, instalémoslos

yarn add @nestjsx/crud class-transformer class-validator

Paquetes class-transformer y class-validator en esta aplicación son necesarios para la descripción declarativa de las reglas de transformación de instancias de modelos y la validación de las solicitudes entrantes, respectivamente. Estos paquetes son del mismo autor, por lo que las interfaces son similares.

Implementación directa de CRUD

Como ejemplo de modelo, tomaremos una lista de usuarios. Los usuarios tendrán los siguientes campos: id, username, displayName, correo electrónico. id — un campo de auto-incremento, correo electrónico y username — campos únicos. ¡Es muy simple! Solo nos queda llevar nuestra idea a la práctica en forma de una aplicación Nest.
Primero, necesitamos crear un módulo usuarios, que se encargará de trabajar con los usuarios. Usaremos el cli de NestJS, y en el directorio raíz de nuestro proyecto ejecutaremos el comando nest g module users.

nest g module users

dmitrii@dmitrii-HP-ZBook-17-G3:~/projects/nest-rest git:(master*)$ nest g module users
CREATE /src/users/users.module.ts (82 bytes)
UPDATE /src/app.module.ts (312 bytes)

En este módulo, agregaremos una carpeta entities, donde estarán los modelos de este módulo. En particular, añadiremos aquí el archivo user.entity.ts con la descripción del modelo de usuarios:

user.entity.ts

import { Column, Entity, PrimaryGeneratedColumn } from 'typeorm';

@Entity()
export class User {
  @PrimaryGeneratedColumn()
  id: string;

  @Column({unique: true})
  email: string;

  @Column({unique: true})
  username: string;

  @Column({nullable: true})
  displayName: string;
}

Para que esta modelo sea 'visto' por nuestra aplicación, es necesario importar en el módulo UsersModule el siguiente contenido: TypeOrmModule users.module.ts

users.module.ts

import { Module } from '@nestjs/common';
import { UsersController } from './controllers/users/users.controller';
import { UsersService } from './services/users/users.service';
import { TypeOrmModule } from '@nestjs/typeorm';
import { User } from './entities/user.entity';

@Module({
  controllers: [UsersController],
  providers: [UsersService],
  imports: [
    TypeOrmModule.forFeature([User])
  ]
})
export class UsersModule {}

Es decir, aquí importamos TypeOrmModule, donde como parámetro del método forFeature especificamos la lista de modelos relacionados con este módulo.

Queda crear la entidad correspondiente en la base de datos. Para ello se utiliza el mecanismo de migraciones. Para crear una migración basada en cambios en los modelos, es necesario ejecutar el comando npm run migration:generate -- CreateUserTable:

Título del spoiler

$ npm run migration:generate -- CreateUserTable
La migración /home/dmitrii/projects/nest-rest/migrations/1563346135367-CreateUserTable.ts ha sido generada con éxito.
Hecho en 1.96s.

No tuvimos que escribir la migración manualmente, todo ocurrió como por arte de magia. ¡No es un milagro! Sin embargo, esto aún no es todo. Veamos el archivo de migración creado:

1563346135367-CreateUserTable.ts

import {MigrationInterface, QueryRunner} from "typeorm";

export class CreateUserTable1563346816726 implements MigrationInterface {

    public async up(queryRunner: QueryRunner): Promise {
        await queryRunner.query(`CREATE TABLE "user" ("id" SERIAL NOT NULL, "email" character varying NOT NULL, "username" character varying NOT NULL, "displayName" character varying, CONSTRAINT "UQ_e12875dfb3b1d92d7d7c5377e22" UNIQUE ("email"), CONSTRAINT "UQ_78a916df40e02a9deb1c4b75edb" UNIQUE ("username"), CONSTRAINT "PK_cace4a159ff9f2512dd42373760" PRIMARY KEY ("id"))`);
    }

    public async down(queryRunner: QueryRunner): Promise {
        await queryRunner.query(`DROP TABLE "user"`);
    }

}

Como se puede notar, se generó automáticamente no solo el método para ejecutar la migración, sino también el método para revertirla. ¡Fantástico!
Solo queda ejecutar esta migración. Esto se hace con el siguiente comando:

npm run migration:run.

Listo, ahora los cambios en el esquema han sido aplicados a la base de datos.
A continuación, crearemos un servicio que se encargará de trabajar con los usuarios y heredaremos de TypeOrmCrudService. En el parámetro del constructor padre es necesario pasar el repositorio de la entidad de interés, en nuestro caso User repositorio.

users.service.ts

import { Injectable } from '@nestjs/common';
import { TypeOrmCrudService } from '@nestjsx/crud-typeorm';
import { User } from '../..//entities/user.entity';
import { InjectRepository } from '@nestjs/typeorm';
import { Repository } from 'typeorm';

@Injectable()
export class UsersService extends TypeOrmCrudService {
  constructor(@InjectRepository(User) usersRepository: Repository){
    super(usersRepository);
  }
}

Este servicio lo necesitaremos en el controlador usuarios. Para crear un controlador, escribe en la consola nest g controller users/controllers/users

nest g controller users/controllers/users

dmitrii@dmitrii-HP-ZBook-17-G3:~\/projects\/nest-rest git:(master*)$ nest g controller users\/controllers\/users
CREAR \/src\/users\/controllers\/users\/users.controller.spec.ts (486 bytes)
CREAR \/src\/users\/controllers\/users\/users.controller.ts (99 bytes)
ACTUALIZAR \/src\/users\/users.module.ts (188 bytes)

Abramos este controlador y editemos para agregar un poco de magia. nestjsx\/crud. En clase UsersController agregaremos un decorador del siguiente tipo:

@Crud({
  model: {
    type: User
  }
})

Crud — este es un decorador que agrega los métodos necesarios para trabajar con el modelo en el controlador. El tipo de modelo se indica en el campo model.type de la configuración del decorador.
El segundo paso es implementar la interfaz CrudController<User>. En conjunto, el código del controlador se ve de la siguiente manera:

import { Controller } from '@nestjs\/common';
import { Crud, CrudController } from '@nestjsx\/crud';
import { User } from '..\/..\/entities\/user.entity';
import { UsersService } from '..\/..\/services\/users\/users.service';

@Crud({
  model: {
    type: User
  }
})
@Controller('users')
export class UsersController implements CrudController<User>{
  constructor(public service: UsersService){}
}

¡Y eso es todo! Ahora el controlador soporta todo el conjunto de operaciones con el modelo. ¿No lo crees? ¡Probemos nuestra aplicación en acción!

Creación de escenarios de solicitudes en TestMace

Para probar nuestro servicio, utilizaremos un IDE para trabajar con API. TestMace¿Por qué TestMace? En comparación con productos similares, tiene las siguientes ventajas:

• potente manejo de variables. Actualmente, existen varios tipos de variables, cada una de las cuales cumple una función específica: variables incorporadas, variables dinámicas, variables de entorno. Cada variable pertenece a un nodo que soporta un mecanismo de herencia;
• fácil creación de escenarios sin programación. De esto hablaremos a continuación;
• formato legible por humanos que permite guardar el proyecto en sistemas de control de versiones;
• autocompletar, resaltado de sintaxis, resaltado de valores de variables;
• soporte para la descripción de API con la posibilidad de importación desde Swagger.

Iniciemos nuestro servidor con el comando npm start y probemos acceder a la lista de usuarios. La lista de usuarios, según nuestra configuración del controlador, se puede obtener a través de la URL localhost:3000\/users. Haremos una solicitud a esta URL.
Después de iniciar TestMace, podrás ver esta interfaz:

En la parte superior izquierda se encuentra el árbol de proyectos con el nodo raíz. ProyectoIntentemos crear nuestra primera solicitud para obtener la lista de usuarios. Para esto, crearemos un RequestStep nodo. Esto se hace en el menú contextual del nodo Project. Agregar nodo -> RequestStep.

En el campo URL, inserta localhost:3000/users y realiza la solicitud. Obtendremos un código 200 con un array vacío en el cuerpo de la respuesta. Es comprensible, aún no hemos añadido a nadie.
Vamos a crear un script que incluya los siguientes pasos:

1. creación de un usuario;
2. petición por id del usuario recién creado;
3. eliminación por id del usuario creado en el paso 1.

Así que, empecemos. Para mayor comodidad, crearemos un nodo de tipo Carpeta. En esencia, esto es simplemente una carpeta donde guardaremos todo el guion. Para crear un nodo de Carpeta, es necesario seleccionar en el menú contextual del nodo del Proyecto Agregar nodo -> Carpeta. Nombramos el nodo check-create. Dentro del nodo check-create crearemos nuestra primera solicitud para crear un usuario. Nombramos el nodo recién creado create-user. Por lo tanto, en este momento, la jerarquía de nodos se verá de la siguiente manera:

Pasemos a la pestaña del nodo abierto. create-user Ingresaremos los siguientes parámetros para la solicitud:

• Tipo de solicitud — POST
• URL — localhost:3000/users
• Cuerpo — JSON con el valor {"email": "user@user.com", "displayName": "Nuevo usuario", "username": "user"}

Realizaremos esta solicitud. Nuestra aplicación indica que el registro ha sido creado.

Bien, verifiquemos este hecho. Para utilizar el id del usuario creado en los pasos posteriores, es necesario guardar este parámetro. Un mecanismo adecuado para esto son variables dinámicas. Veamos en nuestro ejemplo cómo funciona esto. En la pestaña de respuesta analizada del nodo id, en el menú contextual, debemos seleccionar la opción Asignar a variable. En el cuadro de diálogo, es necesario establecer los siguientes parámetros:

• Nodo — en cuál de los ancestros crear la variable dinámica. seleccionamos check-create
• Nombre de la variable — el nombre de esta variable. Nombraremos userId.

Así es como se ve el proceso de creación de una variable dinámica:

Ahora, cada vez que se ejecute esta solicitud, el valor de la variable dinámica se actualizará. Y dado que las variables dinámicas soportan el mecanismo de herencia jerárquica, la variable userId estará disponible en descendientes check-create de cualquier nivel de anidamiento de nodos.
En la siguiente solicitud, esta variable nos será útil. Específicamente, solicitaremos el usuario recién creado. Como descendiente del nodo check-create crearemos la solicitud check-if exists con el parámetro url igual a localhost:3000/users/${$dynamicVar.userId}. La construcción de tipo ${variable_name} es la obtención del valor de la variable. Dado que tenemos una variable dinámica, para obtenerla es necesario referirse al objeto $dynamicVar, es decir, acceso completo a la variable dinámica userId se verá de la siguiente manera ${$dynamicVar.userId}. Realizaremos una solicitud y nos aseguraremos de que los datos se soliciten correctamente.
Solo queda un último toque: hacer una solicitud para eliminar. No solo lo necesitamos para verificar el funcionamiento de la eliminación, sino también, por así decirlo, para limpiar detrás de nosotros en la base de datos, ya que los campos de email y nombre de usuario son únicos. Entonces, en el nodo check-create, crearemos la solicitud delete-user con los siguientes parámetros

• Tipo de solicitud: DELETE
• URL: localhost:3000/users/${$dynamicVar.userId}

Ejecutamos. Esperamos. Disfrutamos el resultado)

Y ahora podemos ejecutar completamente este escenario en cualquier momento. Para ejecutar el escenario, es necesario seleccionar en el menú contextual check-create el ítem del nodo Ejecutar.

Los nodos en el escenario se ejecutarán uno tras otro
Este escenario puedes guardarlo en tu proyecto, ejecutando Archivo -> Guardar proyecto.

Conclusión

El formato de este artículo simplemente no pudo incluir todas las características de las herramientas utilizadas. En cuanto al principal culpable, el paquete nestjsx/crud, quedaron sin abordar los siguientes temas:

• validación y transformación de modelos personalizados;
• un poderoso lenguaje de consultas y su uso conveniente en el frontend;
• sobrescribir y agregar nuevos métodos en los controladores CRUD;
• soporte para swagger;
• gestión de caching.

Sin embargo, incluso lo descrito en el artículo es suficiente para entender que incluso un framework empresarial como NestJS tiene herramientas en la manga para prototipar aplicaciones rápidamente. Y una IDE tan genial como TestMace permite mantener el ritmo establecido.

El código fuente de este artículo, junto con el proyecto TestMace, está disponible en el repositorio https://github.com/TestMace/nest-rest. Para abrir el proyecto TestMace basta con ejecutar en la aplicación Archivo -> Abrir proyecto.

Fuente: habr.com