fixing db

Author: ais-one

CHANGELOG.md

@@ -10,7 +10,14 @@
 - [js-node/expressjs] webpush push notification sample [sample](js-node/expressjs/public/demo-express/pn.html)
 - [js-node/expressjs] SSO (OAuth, OIDC, SAML) sample [sample](js-node/expressjs/public/demo-express/sso.html)
 - [js-node/expressjs] try to removed passport & passport-saml, use @node-saml/node-saml
-- [wip] to use Typescript and tsoa ? or use JSDoc?
+- [js-node/expressjs] remove sentry, APM for userland to choose and implement
+- [@es-labs/node] SSO for oidc to opt to use IDP or issue own token
+- [@es-labs/node] make APP_NAME and NODE_ENV from env var only
+- [js-node/dbdeploy] db might be shared... so create a seperate project for it (move existing deploy/db folder)
+- [tbd] work to remove APP_NAME in @es-labs/node
+- [tbd] clean up auth in @es-labs/node
+- [tbd] move error handling to @ss-labs/node/express/init or preRoute
+- [tbd] to use Typescript and tsoa ? or use JSDoc?
 
 ### Version 0.6.11
 - [chore] update packages & cleanup & work on improving documentation

README.md

@@ -52,43 +52,35 @@ AMP Website | [removed](https://plausible.io/blog/google-amp) | -
 npm i -g npm@latest
 
 
-## Install And Migrate DB And Seed DB
+## Getting Started
+### Install
 
 ```bash
 # clone repo
 git clone https://github.com/ais-one/cookbook.git
 cd cookbook
 
 # install dependencies for all workspace projects
-npm i
+# see package.json for shortcut scripts
+npm i --workspace=js-node/expressjs
+npm i --workspace=js-node/dbdeploy
 
 # OR install only for express backend
 npm run ex:build # see ./package.json scripts
-
-# seed data for the express backend
-# create and seed relational db on SQLite, (delete the dev.sqlite file each time before you run this)
-# command: npm run knex -- <development / uat / production> <custom app name> <seed / migrate>
-npm run ex:migrate # see ./package.json scripts
-npm run ex:seed # see ./package.json scripts
-
-# create and seed MongoDB requires MongoDB - you can skip this but MongoDB examples will not work
-# command: npm run mongo -- <development / uat / production> <custom app name> <seed / update>
-# npm run mongo --workspace=js-node/expressjs -- development app-template seed
 ```
 
-## Run ExpressJS Backend - development environment
+### Migrate DB And Seed DB
 
-```bash
-npm run ex:start # see ./package.json scripts
+Go to [dbdeploy](../dbdeploy/README.md) project and follow instructions for creating local development db on sqlite
 
-# OR
-# command: npm run app --workspace=js-node/expressjs -- <development / uat / production> <custom app name, default = app-template>
-npm run app --workspace=js-node/expressjs -- development
-npm run app --workspace=js-node/expressjs -- development app-template # app name specified
+### Run ExpressJS Backend - development environment
 
+```bash
+npm run ex:start # NODE_ENV=development npm run app --workspace=js-node/expressjs in package.json
+# use ex:start:win for Windows OS
 
 # OR to include eslint checks
-npm run app:lint --workspace=js-node/expressjs -- development app-template
+NODE_ENV=development npm run app:lint --workspace=js-node/expressjs
 ```
 
 **NOTES**
@@ -144,7 +136,7 @@ Why No SSR or SSG:
 - SAML & OIDC: requires keycloak to be setup and express server to be run
   - Setup and Configure [Keycloak](docker-devenv/keycloak/README.md)
 - You can test out on [sso.html](http://127.0.0.1:3000/sso.html). The file source is [js-node/expressjs/public/demo-express/sso.html]()
-- for SAML and OIDC... credentials is `user` / `user`, redirect to the keycloak IDP
+- for SAML and OIDC... credentials is `test` / `test`, redirect to the keycloak IDP
 - Refer also to the following files
   - ./js-node/expressjs/router/saml.js
   - ./js-node/expressjs/router/oidc.js

docker-devenv/keycloak/README.md

@@ -29,8 +29,8 @@ Add new realm with import using the file  [realm-export.json](realm-export.json)
 
 ### Realm User
 
-- Create User named: user
-- Add password credentials named: user
+- Create User named: test
+- Add password credentials named: test
 
 ### Realm Client - OIDC
 

docker-devenv/keycloak/realm-export.json

@@ -426,9 +426,9 @@
   "otpPolicyPeriod": 30,
   "otpPolicyCodeReusable": false,
   "otpSupportedApplications": [
-    "totpAppFreeOTPName",
     "totpAppGoogleName",
-    "totpAppMicrosoftAuthenticatorName"
+    "totpAppMicrosoftAuthenticatorName",
+    "totpAppFreeOTPName"
   ],
   "webAuthnPolicyRpEntityName": "keycloak",
   "webAuthnPolicySignatureAlgorithms": [

js-node/README.md

@@ -2,6 +2,8 @@
 
 Below are a list of NodeJS applications
 
+- dbdeploy
+  - see [dbdeploy/README.md](expressjs/README.md)
 - expressjs
   - see [expressjs/README.md](expressjs/README.md)
 - jsdoc-ts

js-node/expressjs/app.js

@@ -48,7 +48,7 @@ const server = HTTPS_CERTIFICATE ? https.createServer(https_opts, app) : http.cr
 
 require('@es-labs/node/express/preRoute')(app, express)
 const graphqlWsServer = require('@es-labs/node/express/graphql')(app, server)
-const Sentry = require('@es-labs/node/express/sentry')(app)
+// add APM tool here
 
 // CLEANUP
 const cleanup = async (message, exitCode = 0, coreDump = false, timeOutMs = 1000) => {
@@ -101,8 +101,6 @@ server.on('upgrade', (request, socket, head) => {
 
 require('@es-labs/node/express/postRoute')(app, express)
 
-if (Sentry) app.use(Sentry.Handlers.errorHandler())
-
 // https://developer.mozilla.org/en-US/docs/Web/HTTP/Status
 // 'Bad Request': 400, 'Unauthorized': 401, 'Forbidden': 403, 'Not Found': 404, 'Conflict': 409, 'Unprocessable Entity': 422, 'Internal Server Error': 500,
 app.use((error, req, res, next) => { // error middleware - 200s should not reach here

js-node/expressjs/apps/app-template/.env.sample

@@ -361,12 +361,6 @@ GRAPHQL_SCHEMA_PATH=
 GRAPHQL_URL=/graphql
 GRAPHQL_SUB_URL=/subscriptions
 
-# sentry.io
-SENTRY_DSN=
-# SENTRY_DSN=https://[email protected]/5868141
-SENTRY_SAMPLE_RATE=1.0
-SENTRY_REQOPTS=
-
 
 JWT_PRIVATE_KEY="-----BEGIN RSA PRIVATE KEY-----
 MIICXgIBAAKBgQDQIwMrGPHdUNJJaZaPCtU+mD+/4C3WVuYpHUdUKWc1BBX4/FPo