s-hirano-ist / rss-dumper

Sample REST server

RSS Dumper

Sample Express server for studying backend REST server.

👌 Known Issues and checkpoints

• Bundle with Webpack or Vite then use pm2 for auto restart.
• Await is not supposed to be used.

  https://qiita.com/yukin01/items/1a36606439123525dc6d

• More tests, especially unit tests. Better if parallelized.
• Security issues.
• Add huskey/pre-commit to run "tsoa" and validate swagger.json before commit.
• Easy validation using a library like express-validator.
• Want to introduce absolute imports and ESModule.
• Tsoa is not enough for generating OpenAPI document api responses on errors.

See GitHub issue 186 for more details(?).

💻 Tech Stack

Language - TypeScript
Main Framework - Express
ORM - Prisma
Database - PostgreSQL
Test - Jest
Authentication - Passport
Code Formatting - Prettier
Linting - ESLint
Validation - Joi
Generate Swagger - Tsoa
Validate Swagger - openapi-schema-validator

Render settings

Add following environments

POSTGRES_PRISMA_URL=
POSTGRES_URL_NON_POOLING=
NODE_VERSION=18.17.1
PORT=8080

https://render.com/docs/node-version

Build command (This should change to webpack & pm2 or vite for bundling)

pnpm i

Start command

NODE_ENV=production pnpm start

Use docker

docker compose --profile app up -d

🍾 Initial setups

git clone https://github.com/s-hirano-ist/rss-dumper.git
cd rss-dumper
docker compose up --build -d
pnpm i
pnpm prisma:dev
pnpm tsoa:swagger
pnpm tsoa:routes

API path

• /api/docs: Swagger UI
• /health: health
• /v1/news: Pure REST API
• /v1/news-detail: REST API with Swagger auto generation with Tsoa

Tests

pnpm test

Curl commands

# GET
curl -s https://rss-dumper.onrender.com/v1/news/
curl -s https://rss-dumper.onrender.com/v1/news/test-a

# POST
curl -s -d '{"heading": "test-a", "description": "test description A"}' -H 'Content-Type: application/json' https://rss-dumper.onrender.com/v1/news/create

# PATCH
curl -s -d '{"description": "updated description"}' -H 'Content-Type: application/json' -X PATCH https://rss-dumper.onrender.com/v1/news/update/test-a

# DELETE
curl -s -X DELETE https://rss-dumper.onrender.com/v1/news/delete/test-a
curl -s -X DELETE https://rss-dumper.onrender.com/v1/news/delete

🪝 Tags & Realease

gh release create --generate-notes

Notes

Sanitization to prevent XSS is done by sanitize-html

No sanitization to prevent SQL injection is needed due to Prisma's prevention.

https://www.prisma.io/docs/concepts/components/prisma-client/raw-database-access#sql-injection

rss-dumper's Issues

自動でtable等を作成してくれるスクリプト? スキーマを作成

Dependency Dashboard

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

Awaiting Schedule

These updates are awaiting their schedule. Click on a checkbox to get an update now.

• chore(deps): lock file maintenance

Ignored or Blocked

These are blocked by an existing closed PR and will not be recreated unless you click a checkbox below.

• chore(deps): update postgres docker tag to v16

Detected dependencies

docker-compose

compose.yml

dockerfile

db.Dockerfile

• postgres 15-alpine

server.Dockerfile

• node 20-slim

github-actions

.github/workflows/build.yaml

• actions/checkout v4
• actions/setup-node v4
• pnpm/action-setup v2
• actions/cache v3

npm

package.json

• @prisma/client ^5.7.1
• @tsoa/runtime ^6.0.0
• body-parser ^1.20.2
• cors ^2.8.5
• dotenv ^16.3.1
• express ^4.18.2
• joi ^17.11.0
• passport ^0.7.0
• passport-http ^0.3.0
• sanitize-html ^2.11.0
• swagger-ui-express ^5.0.0
• tsoa ^6.0.0
• @types/cors ^2.8.17
• @types/express ^4.17.21
• @types/jest ^29.5.11
• @types/node ^20.10.7
• @types/passport ^1.0.16
• @types/passport-http ^0.3.11
• @types/sanitize-html ^2.9.5
• @types/supertest ^6.0.2
• @types/swagger-ui-express ^4.1.6
• @typescript-eslint/eslint-plugin ^6.18.0
• @typescript-eslint/parser ^6.18.0
• eslint ^8.56.0
• eslint-config-prettier ^9.1.0
• eslint-plugin-import ^2.29.1
• jest ^29.7.0
• nodemon ^3.0.2
• npm-run-all ^4.1.5
• openapi-schema-validator ^12.1.3
• prettier ^3.1.1
• prisma ^5.7.1
• supertest ^6.3.3
• ts-jest ^29.1.1
• ts-node ^10.9.2
• typescript ^5.3.3
• pnpm 8.14.0

---

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

Node.js

sanitize

json to sql, sql to jsonにてbackup作成 毎週定期dump

STRAPI ledefi 解読

懸念点: newsを削除はnews detailに依存

hasura

Schemaについての理解 public以外

https://www.prisma.io/docs/concepts/database-connectors/postgresql#connection-details

boilerplate

• https://dev.to/rhuzaifa/top-5-node-express-boilerplates-for-building-restful-api-s-1ehl
• https://github.com/danielfsousa/express-rest-boilerplate
• https://github.com/hagopj13/node-express-boilerplate
• https://medium.com/codechef-vit/a-better-project-structure-with-express-and-node-js-c23abc2d736f

SQLで制約入れることができそうなところはそうする

Apollo Server + GraphQL

db initial をサブレポジトリとして管理

trpc

https://trpc.io/

セキュリティ対策

• SQLインジェクション --> サニタイズ
• XSS
  等。

zodみたいなバリデーション導入

eslint update

swaggerみたいなもの

DB vercel 作成

tsconfig再考

eslint any 系の設定 off to error

relationあるときのseed等の動作

postgreSQL settings ENV LANG ja_JP.utf8

PrismaみたいなSQL操作系を導入

graphQL

importをabsoluteに+eslint設定

Strapi

ヘッドレスCMS

test充実化 (単体テスト)+ jest 並列実行

rest API

技術記事stockはdb経由でやりたい。毎週dump。json or csv

test cover率確認

Strapi

sqlのidの制約についての理解

BFF

backendはtypescript

urlはURLの制約

ledefi Backend 解読

more secure settings on passport JWT

Prisma Backend for Node.js

middleware auth

https://github.com/danielfsousa/express-rest-boilerplate/blob/main/src/api/middlewares/auth.js

Admin.js

https://dev.classmethod.jp/articles/create-admin-app-by-adminjs/

Express, Prisma, PostgreSQL

# TODO: for PostgreSQL introduce.

version: "3"

services:
  db:
    container_name: stock-db
    image: postgres
    volumes:
      - stock-db-data:/var/lib/postgresql/data
    ports:
      - 5555:5432
    environment:
      POSTGRES_USER: ${USERNAME}
      POSTGRES_PASSWORD: ${PASSWORD}
      POSTGRES_DB: stock-db

volumes:
  stock-db-data:

Express

importをrelativeにする+tsconfigのpathを記述

postgreSQL

jest とりあえず直列実行

JEST テスト 充実化（cover率求める）

news detailとnewsを同時に作成するapiも作成

relationについての理解

https://zenn.dev/tsucchiiinoko/articles/f222dbbfa23325