feat(sandbox): added audit example (#172)

README.md

@@ -22,7 +22,8 @@ This repository also contains a set of example projects in the [sandbox](sandbox
 * [auth-multitenant-example](sandbox/auth-multitenant-example)
 * [auth-ms-basic-example](sandbox/auth-ms-basic-example)
 * [notification-socket-example](sandbox/notification-socket-example)
-* [workflow-helloworld](sandbox/workflow-helloworld)
+* [workflow-ms-example](sandbox/workflow-ms-example)
+* [audit-ms-example](sandbox/audit-ms-example)
 
 ## Table of Contents
 

sandbox/audit-ms-example/.dockerignore

@@ -0,0 +1,5 @@
+node_modules
+npm-debug.log
+/dist
+# Cache used by TypeScript's incremental build
+*.tsbuildinfo

sandbox/audit-ms-example/.env.example

@@ -0,0 +1,11 @@
+DB_HOST=
+DB_PORT=
+DB_USER=
+DB_PASSWORD=
+DB_DATABASE=
+REDIS_HOST=
+REDIS_PORT=
+REDIS_PASSWORD=
+REDIS_DB=
+JWT_SECRET=
+JWT_ISSUER=

sandbox/audit-ms-example/.eslintignore

@@ -0,0 +1,6 @@
+node_modules/
+dist/
+coverage/
+migrations/
+migration.js
+.eslintrc.js

sandbox/audit-ms-example/.eslintrc.js

@@ -0,0 +1,8 @@
+module.exports = {
+  extends: '@loopback/eslint-config',
+  rules: {
+    'no-extra-boolean-cast': 'off',
+    '@typescript-eslint/interface-name-prefix': 'off',
+    'no-prototype-builtins': 'off',
+  },
+};

sandbox/audit-ms-example/.gitignore

@@ -0,0 +1,64 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# Transpiled JavaScript files from Typescript
+/dist
+
+# Cache used by TypeScript's incremental build
+*.tsbuildinfo

sandbox/audit-ms-example/.mocharc.json

@@ -0,0 +1,5 @@
+{
+  "exit": true,
+  "recursive": true,
+  "require": "source-map-support/register"
+}

sandbox/audit-ms-example/.npmrc

@@ -0,0 +1,2 @@
+package-lock=true
+scripts-prepend-node-path=true

sandbox/audit-ms-example/.prettierignore

@@ -0,0 +1,2 @@
+dist
+*.json

sandbox/audit-ms-example/.prettierrc

@@ -0,0 +1,7 @@
+{
+  "bracketSpacing": false,
+  "singleQuote": true,
+  "printWidth": 80,
+  "trailingComma": "all",
+  "arrowParens": "avoid"
+}

sandbox/audit-ms-example/.vscode/launch.json

@@ -0,0 +1,38 @@
+{
+  "configurations": [
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Launch Program",
+      "skipFiles": [
+        "<node_internals>/**"
+      ],
+      "program": "${workspaceFolder}/dist/index.js",
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Run Mocha tests",
+      "program": "${workspaceRoot}/node_modules/mocha/bin/_mocha",
+      "runtimeArgs": [
+        "-r",
+        "${workspaceRoot}/node_modules/source-map-support/register"
+      ],
+      "cwd": "${workspaceRoot}",
+      "autoAttachChildProcesses": true,
+      "args": [
+        "--config",
+        "${workspaceRoot}/.mocharc.json",
+        "${workspaceRoot}/dist/__tests__/**/*.js",
+        "-t",
+        "0"
+      ]
+    },
+    {
+      "type": "node",
+      "request": "attach",
+      "name": "Attach to Process",
+      "port": 5858
+    }
+  ]
+}

sandbox/audit-ms-example/.vscode/settings.json

@@ -0,0 +1,32 @@
+{
+  "editor.rulers": [80],
+  "editor.tabCompletion": "on",
+  "editor.tabSize": 2,
+  "editor.trimAutoWhitespace": true,
+  "editor.formatOnSave": true,
+  "editor.codeActionsOnSave": {
+    "source.organizeImports": true,
+    "source.fixAll.eslint": true
+  },
+
+  "files.exclude": {
+    "**/.DS_Store": true,
+    "**/.git": true,
+    "**/.hg": true,
+    "**/.svn": true,
+    "**/CVS": true,
+    "dist": true,
+  },
+  "files.insertFinalNewline": true,
+  "files.trimTrailingWhitespace": true,
+
+  "typescript.tsdk": "./node_modules/typescript/lib",
+  "typescript.format.insertSpaceAfterOpeningAndBeforeClosingNonemptyBraces": false,
+  "typescript.preferences.quoteStyle": "single",
+  "eslint.run": "onSave",
+  "eslint.nodePath": "./node_modules",
+  "eslint.validate": [
+    "javascript",
+    "typescript"
+  ]
+}

sandbox/audit-ms-example/.vscode/tasks.json

@@ -0,0 +1,29 @@
+{
+  // See https://go.microsoft.com/fwlink/?LinkId=733558
+  // for the documentation about the tasks.json format
+  "version": "2.0.0",
+  "tasks": [
+    {
+      "label": "Watch and Compile Project",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "build:watch"],
+      "group": {
+        "kind": "build",
+        "isDefault": true
+      },
+      "problemMatcher": "$tsc-watch"
+    },
+    {
+      "label": "Build, Test and Lint",
+      "type": "shell",
+      "command": "npm",
+      "args": ["--silent", "run", "test:dev"],
+      "group": {
+        "kind": "test",
+        "isDefault": true
+      },
+      "problemMatcher": ["$tsc", "$eslint-compact", "$eslint-stylish"]
+    }
+  ]
+}

sandbox/audit-ms-example/.yo-rc.json

@@ -0,0 +1,6 @@
+{
+  "@loopback/cli": {
+    "packageManager": "npm",
+    "version": "2.18.0"
+  }
+}

sandbox/audit-ms-example/DEVELOPING.md

@@ -0,0 +1,36 @@
+# Developer's Guide
+
+We use Visual Studio Code for developing LoopBack and recommend the same to our
+users.
+
+## VSCode setup
+
+Install the following extensions:
+
+ - [eslint](https://marketplace.visualstudio.com/items?itemName=dbaeumer.vscode-eslint)
+ - [prettier](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)
+
+## Development workflow
+
+### Visual Studio Code
+
+1. Start the build task (Cmd+Shift+B) to run TypeScript compiler in the
+   background, watching and recompiling files as you change them. Compilation
+   errors will be shown in the VSCode's "PROBLEMS" window.
+
+2. Execute "Run Rest Task" from the Command Palette (Cmd+Shift+P) to re-run the
+   test suite and lint the code for both programming and style errors. Linting
+   errors will be shown in VSCode's "PROBLEMS" window. Failed tests are printed
+   to terminal output only.
+
+### Other editors/IDEs
+
+1. Open a new terminal window/tab and start the continuous build process via
+   `npm run build:watch`. It will run TypeScript compiler in watch mode,
+   recompiling files as you change them. Any compilation errors will be printed
+   to the terminal.
+
+2. In your main terminal window/tab, run `npm run test:dev` to re-run the test
+   suite and lint the code for both programming and style errors. You should run
+   this command manually whenever you have new changes to test. Test failures
+   and linter errors will be printed to the terminal.

sandbox/audit-ms-example/Dockerfile

@@ -0,0 +1,28 @@
+# Check out https://hub.docker.com/_/node to select a new base image
+FROM node:10-slim
+
+# Set to a non-root built-in user `node`
+USER node
+
+# Create app directory (with user `node`)
+RUN mkdir -p /home/node/app
+
+WORKDIR /home/node/app
+
+# Install app dependencies
+# A wildcard is used to ensure both package.json AND package-lock.json are copied
+# where available (npm@5+)
+COPY --chown=node package*.json ./
+
+RUN npm install
+
+# Bundle app source code
+COPY --chown=node . .
+
+RUN npm run build
+
+# Bind to all network interfaces so that it can be mapped to the host OS
+ENV HOST=0.0.0.0 PORT=3000
+
+EXPOSE ${PORT}
+CMD [ "node", "." ]

sandbox/audit-ms-example/README.md

@@ -0,0 +1,3 @@
+# auth-multitenant-example
+
+[![LoopBack](https://github.com/strongloop/loopback-next/raw/master/docs/site/imgs/branding/Powered-by-LoopBack-Badge-(blue)[email protected])](http://loopback.io/)

sandbox/audit-ms-example/migration.js

@@ -0,0 +1,22 @@
+const dotenv = require('dotenv');
+const fs = require('fs');
+const DBMigrate = require('db-migrate');
+const path = require('path');
+let isLocal = false;
+dotenv.config({path: `${process.env.INIT_CWD}/.env`});
+
+try {
+  if (fs.existsSync('.infolder')) {
+    isLocal = true;
+  }
+} catch (err) {
+  console.info('\n');
+}
+if (isLocal) {
+  console.info(`Skipping migrations`);
+} else {
+  const dbmigrate = DBMigrate.getInstance(true, {
+    config: './migrations/database.json',
+  });
+  dbmigrate.up();
+}

sandbox/audit-ms-example/migrations/20210423140543-init.js

@@ -0,0 +1,50 @@
+'use strict';
+
+var dbm;
+var type;
+var seed;
+var fs = require('fs');
+var path = require('path');
+var Promise;
+
+/**
+ * We receive the dbmigrate dependency from dbmigrate initially.
+ * This enables us to not have to rely on NODE_PATH.
+ */
+
+function handleFile(filePath, resolve, reject) {
+  fs.readFile(filePath, {encoding: 'utf-8'}, function (err, data) {
+    if (err) return reject(err);
+    console.log('received data: ' + data);
+
+    resolve(data);
+  });
+}
+exports.setup = function (options, seedLink) {
+  dbm = options.dbmigrate;
+  type = dbm.dataType;
+  seed = seedLink;
+  Promise = options.Promise;
+};
+
+exports.up = function (db) {
+  var filePath = path.join(__dirname, 'sqls', '20210423140543-init-up.sql');
+  return new Promise(function (resolve, reject) {
+    handleFile(filePath, resolve, reject);
+  }).then(function (data) {
+    return db.runSql(data);
+  });
+};
+
+exports.down = function (db) {
+  var filePath = path.join(__dirname, 'sqls', '20210423140543-init-down.sql');
+  return new Promise(function (resolve, reject) {
+    handleFile(filePath, resolve, reject);
+  }).then(function (data) {
+    return db.runSql(data);
+  });
+};
+
+exports._meta = {
+  version: 1,
+};