crystal-ball/node-service-prototype

🔮Projects - Prototypical Node.js service

node-service-prototype's Issues

Feat: Environment variables?

Summary

How should environment variables be accessed?

Details

When deployed how is environment variables, (eg POSTGRES_PASSWORD) supposed to be accessed?

Use JSON API conventions

Conventions are important!

Update Dependencies (Renovate Bot)

This master issue contains a list of Renovate updates and their statuses.

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Upgrade: Update all non-major dependencies (@babel/plugin-proposal-class-properties, @crystal-ball/prettier-base, @types/jest, argon2, eslint-config-eloquence, helmet, husky, nanoid, node, node-pg-migrate, nodemon, pino, pino-pretty)
• Upgrade: Update dependency @crystal-ball/commit-semantics to v2

---

Advanced

• Check this box to trigger a request for Renovate to run again on this repository

Docker images continuous deployment workflow

Create an continuous development pipeline for the project that:

• Builds and tests images on change to repo
• Pushes built image to registry after tests pass
• Uses proper image tagging with git commit or semver tags for versioning.

Feat: Aqua MicroScanner scan

Summary

Include a security scan in the image build workflow

Details

Something like...

ARG TOKEN
ADD https://get.aquasec.com/microscanner .
RUN chmod +x microscanner
RUN ./microscanner $TOKEN

Renovate Bot - Dependencies Management

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Rate-Limited

These updates are currently rate-limited. Click on a checkbox below to force their creation now.

• Chore: Update devDependencies 🆙 (@babel/preset-env, nodemon)
• Update node Docker tag to v20
• 🔐 Create all rate-limited PRs at once 🔐

Edited/Blocked

These updates have been manually edited so Renovate will no longer make changes. To discard all commits and start over, click on a checkbox.

• Update: Project nanoid to v3.1.31 [SECURITY]
• Update actions/checkout action to v3
• Update actions/setup-node action to v3
• Update github/codeql-action action to v2

Open

These updates have all been created already. Click a checkbox below to force a retry/rebase of any.

• Update: Project jsonwebtoken to v9 [SECURITY]
• Update node Docker tag to v14.21
• Update postgres Docker tag to v12.16
• Update: dependencies 🆙 (@opentelemetry/api, @opentelemetry/exporter-collector, @opentelemetry/instrumentation-express, @opentelemetry/instrumentation-http, @opentelemetry/node, @opentelemetry/resources, @opentelemetry/tracing, ajv, ajv-formats, argon2, body-parser, cookie-parser, express, node-pg-migrate, pg, pino)
• Chore: Update devDependencies 🆙 (major) (@types/jest, eslint-config-eloquence, jest, nodemon)
• Update Node.js to v18
• Update postgres Docker tag to v15
• Update: dependencies 🆙 (major) (@opentelemetry/resources, dotenv, helmet, node-pg-migrate, pino, pino-pretty)
• Click on this checkbox to rebase all open PRs at once

Detected dependencies

docker-compose

docker-compose.ci.yml

• postgres 12.7

docker-compose.test.yml

• postgres 12.7

docker-compose.yml

• postgres 12.7

dockerfile

Dockerfile

• node 14.17-alpine

github-actions

.github/workflows/ci-cd.yml

• actions/checkout v2
• actions/setup-node v2

.github/workflows/codeql-analysis.yml

• actions/checkout v2
• github/codeql-action v1
• github/codeql-action v1
• github/codeql-action v1

npm

package.json

• @opentelemetry/api 1.0.0-rc.0
• @opentelemetry/exporter-collector 0.19.0
• @opentelemetry/instrumentation-express 0.16.0
• @opentelemetry/instrumentation-http 0.19.0
• @opentelemetry/node 0.19.0
• @opentelemetry/resources 0.19.0
• @opentelemetry/tracing 0.19.0
• ajv 8.4.0
• ajv-formats 2.1.0
• argon2 0.27.2
• body-parser 1.19.0
• cookie-parser 1.4.5
• dotenv 9.0.2
• express 4.17.1
• helmet 4.6.0
• jsonwebtoken 8.5.1
• nanoid 3.1.23
• node-pg-migrate 5.9.0
• pg 8.6.0
• pino 6.11.3
• pino-pretty 4.8.0
• @babel/preset-env 7.20.2
• @crystal-ball/commitizen-base 2.12.0
• @crystal-ball/prettier-base 2.13.0
• @types/jest 27.5.2
• eslint-config-eloquence 19.1.0
• jest 27.5.1
• nodemon 2.0.20
• supertest 6.3.3
• node 14

---

• Check this box to trigger a request for Renovate to run again on this repository

Add Traefik proxy to project

Setup a reverse proxy using Traefik - that dashboard is 💖🔮🦄

The Docker for Node.js Udemy course has examples of setting up Traefik

Feat: Try `node-dev` for restarts

Summary

_Try out the node-dev package for restarts.

Details

Looks faster, and can be hooked into node-notifier

Feat: Enhanced errors

💥 Error handling improvements

• Don't catch UniqueConstraintError, add it to switch statement in error handlers
• PG specific errors should be mapped in the db layer to custom service errors
• Create a util for extending an error message so that context can be layered on it as it bubbles up the service stack

Action Required: Fix Renovate Configuration

There is an error with this repository's Renovate configuration that needs to be fixed. As a precaution, Renovate will stop PRs until it is resolved.

Location: package.json
Error type: The renovate configuration file contains some invalid settings
Message: Configuration option 'packageRules[0].node' should be a json object, Invalid configuration option: config, Invalid configuration option: contributors, Invalid configuration option: keywords, Invalid configuration option: license, Invalid configuration option: main, Invalid configuration option: name, Invalid configuration option: packageRules[1].@opentelemetry/api, Invalid configuration option: packageRules[1].@opentelemetry/exporter-collector, Invalid configuration option: packageRules[1].@opentelemetry/instrumentation-express, Invalid configuration option: packageRules[1].@opentelemetry/instrumentation-http, Invalid configuration option: packageRules[1].@opentelemetry/node, Invalid configuration option: packageRules[1].@opentelemetry/resources, Invalid configuration option: packageRules[1].@opentelemetry/tracing, Invalid configuration option: packageRules[1].ajv, Invalid configuration option: packageRules[1].ajv-formats, Invalid configuration option: packageRules[1].argon2, Invalid configuration option: packageRules[1].body-parser, Invalid configuration option: packageRules[1].cookie-parser, Invalid configuration option: packageRules[1].dotenv, Invalid configuration option: packageRules[1].express, Invalid configuration option: packageRules[1].helmet, Invalid configuration option: packageRules[1].jsonwebtoken, Invalid configuration option: packageRules[1].nanoid, Invalid configuration option: packageRules[1].node-pg-migrate, Invalid configuration option: packageRules[1].pg, Invalid configuration option: packageRules[1].pino, Invalid configuration option: packageRules[1].pino-pretty, Invalid configuration option: packageRules[2].@babel/preset-env, Invalid configuration option: packageRules[2].@crystal-ball/commitizen-base, Invalid configuration option: packageRules[2].@crystal-ball/prettier-base, Invalid configuration option: packageRules[2].@types/jest, Invalid configuration option: packageRules[2].eslint-config-eloquence, Invalid configuration option: packageRules[2].jest, Invalid configuration option: packageRules[2].nodemon, Invalid configuration option: packageRules[2].supertest, Invalid configuration option: renovate, Invalid configuration option: scripts, Invalid configuration option: type, Invalid configuration option: version, The "node" object can only be configured at the top level of a config but was found inside "packageRules[0]"

Feat: use `pino-pretty` fn `messagFormat`

Summary

Update to use the messageFormat function for log formatting.

Details

See: https://github.com/pinojs/pino-pretty#options

Feat: Database tools

Check out Prisma and Slonik for possible upgrades to working with Postgres.

• https://www.prisma.io/
• https://github.com/gajus/slonik#readme