Release/0.1.0

.dockerignore

@@ -1,12 +1,14 @@
+# Note .dockerignore syntax is a bit different than .gitignore
+
 .git/
 .github/
 node_modules/
 
-watcher_trigger/
+watcher_trigger/*
 !watcher_trigger/.gitkeep
 
-data/
-!data/.gitkeep
+data/metadata-history/*
+!data/metadata-history/.gitkeep
 
 metadata_tmp/
 

.env.example

@@ -3,9 +3,13 @@
 NODE_ENV="development"
 
 # Constant reference in code: ENV_DISABLE_COLORS_IN_STDOUT | Default value: false
-# Set to true if you want to disable colorful output to stdout, it helps if you use AWS CloudWatch
+# Set to true if you want to disable colorful output to stdout, it helps if you use AWS CloudWatch.
 DISABLE_COLORS_IN_STDOUT="false"
 
+# Constant reference in code: ENV_JSON_STDOUT | Default value: false
+# Set to true if you want to get JSON output to stdout, it helps if you use AWS CloudWatch.
+JSON_STDOUT="false"
+
 # Constant reference in code: ENV_LOG_LEVELS | Default value: critical,normal,verbose
 # Sets up logging level: critical, normal, verbose
 LOG_LEVELS="critical,normal,verbose"

.gitignore

@@ -1,11 +1,10 @@
 node_modules/
-metadata/
 
-watcher_trigger/
+watcher_trigger/*
 !watcher_trigger/.gitkeep
 
-data/
-!data/.gitkeep
+data/metadata-history/*
+!data/metadata-history/.gitkeep
 
 # development
 metadata_tmp/

CHANGELOG.md

@@ -1,6 +1,10 @@
-# (Future) Release 0.0.10
+# Release 0.1.0
 
-- undefined
+- Added support for JSON output to stdout, new env variable `JSON_STDOUT` default:false
+- Restructured metadata example location, moved examples to `./data/metadata-examples`
+- Added ability to reset metadata, which will reset metadata to initial image example metadata.
+- Updated UI
+- Bugfixes
 
 # Release 0.0.9
 

Dockerfile

@@ -28,6 +28,9 @@ COPY . .
 # Install node_modules in metadata folder on build
 RUN cd ./metadata && npm install --only=production 
 
+# At the point of building image we also want to move metadata folder with npm modules to data/metadata-examples
+RUN cp -r ./metadata/* ./data/metadata-examples
+
 CMD ["npm", "run", "start"]
 
 # This is not ready, there are known bugs with cluster mode (state management between nodes, like path in remote shell etc...)

metadata/apps/example-demo-app/errors.demo.js

@@ -0,0 +1,21 @@
+import { createErrorDescriptor } from 'hlambda';
+
+// --- START SAFE TO EDIT ---
+
+export const errorsGroupName = 'demo-hlambda-app';
+
+export const errors = {
+  FUNCTIONALITY_NOT_IMPLEMENTED: {
+    message:
+      'Specific functionality is still in development. (It should be available soon, thank you for understanding.)',
+  },
+  SOMETHING_WENT_TERRIBLY_WRONG: {
+    message: 'Description of an error message...',
+  },
+};
+
+// --- STOP SAFE TO EDIT ---
+
+export const ed = createErrorDescriptor(errors, errorsGroupName);
+
+export default errors;

metadata/apps/example-demo-app/hasura-request-logger.js

@@ -0,0 +1,14 @@
+import 'colors';
+
+const hasuraRequestLogger = (req, res, next) => {
+  console.log(`[${req.originalUrl}] Request hit!`);
+  // --------------------------------------------------------------------------------
+  // Get variables
+  console.log('This is what we received from Hasura when calling the hook');
+  console.log(req.body);
+  console.log(Array(80 + 1).join('-'));
+  // --------------------------------------------------------------------------------
+  next();
+};
+
+export default hasuraRequestLogger;

metadata/apps/example-demo-app/hlambda-config.yaml

@@ -0,0 +1,24 @@
+# Defines if the app is enabled or not, disabled apps are skipped from importing
+enabled: true
+# # Defines if we want to use namespace or not
+# use_namespace: true # NOT IN USE!
+# # Define the namespace name
+# namespace_name: 'demo_app' # NOT IN USE!
+# Custom environment variables override for our app
+env:
+  HASURA_GRAPHQL_API_ENDPOINT: "http://graphql-engine:8099/v1/graphql"
+  HASURA_GRAPHQL_ADMIN_SECRET: "hlambda-test"
+  HLAMBDA_DISABLE_CONSOLE: "false"
+
+  #HLAMBDA_ENABLE_ENVIRONMENT_BANNER: "true"
+  #HLAMBDA_ENVIRONMENT_BANNER_NAME: "Local Hlambda Demo Development"
+  #HLAMBDA_ENVIRONMENT_BANNER_MESSAGE: "Hello Hlambda Env Banner!"
+  #HLAMBDA_ENABLE_ENVIRONMENT_BANNER_COLOR: "#eeFF22"
+
+  #JSON_STDOUT: true
+
+envForce:
+  HASURA_GRAPHQL_API_ENDPOINT: "http://graphql-engine:8099/v1/graphql"
+  HASURA_GRAPHQL_ADMIN_SECRET: "real-password"
+  SPECIAL_PASSWORD: "value-from-env"
+  HLAMBDA_DISABLE_CONSOLE: "false"

metadata/apps/example-demo-app/router.demo.js

@@ -0,0 +1,34 @@
+import express from 'express';
+import asyncHandler from 'express-async-handler';
+
+import { DateTime } from 'luxon';
+
+import hasuraRequestLogger from './hasura-request-logger.js';
+
+import errors from './errors.demo.js';
+
+import requestTimeLogger from '../../../src/utils/requestTimer.js';
+
+// Create express router
+const router = express.Router();
+
+router.use('/demo*', hasuraRequestLogger);
+router.use('/demo*', requestTimeLogger);
+
+router.get(
+  '/demo',
+  asyncHandler((req, res) => {
+    res.send(`Demo app works: ${DateTime.now()} ${process.env.SPECIAL_PASSWORD}`);
+  })
+);
+
+router.get(
+  '/demo-error',
+  asyncHandler((req, res) => {
+    // res.send(`Demo app works: ${DateTime.now()} ${process.env.SPECIAL_PASSWORD}`);
+    throw new Error(errors.SOMETHING_WENT_TERRIBLY_WRONG);
+    // res.send(`Demo app works: ${DateTime.now()} ${process.env.SPECIAL_PASSWORD}`);
+  })
+);
+
+export default router;

metadata/apps/example-hasura/errors.demo.js

@@ -0,0 +1,21 @@
+import { createErrorDescriptor } from 'hlambda';
+
+// --- START SAFE TO EDIT ---
+
+export const errorsGroupName = 'example-hasura-app';
+
+export const errors = {
+  FUNCTIONALITY_NOT_IMPLEMENTED: {
+    message:
+      'Specific functionality is still in development. (It should be available soon, thank you for understanding.)',
+  },
+  SOMETHING_WENT_TERRIBLY_WRONG: {
+    message: 'Description of an error message...',
+  },
+};
+
+// --- STOP SAFE TO EDIT ---
+
+export const ed = createErrorDescriptor(errors, errorsGroupName);
+
+export default errors;

metadata/apps/example-hasura/hasura-request-logger.js

@@ -0,0 +1,14 @@
+// import 'colors'; // This is known issue with this package...
+
+const hasuraRequestLogger = (req, res, next) => {
+  console.log(`[${req.originalUrl}] Request hit!`);
+  // --------------------------------------------------------------------------------
+  // Get variables
+  console.log('This is what we received from Hasura when calling the hook');
+  console.log(req.body);
+  console.log(Array(80 + 1).join('-'));
+  // --------------------------------------------------------------------------------
+  next();
+};
+
+export default hasuraRequestLogger;

metadata/apps/example-hasura/hlambda-config.yaml

@@ -0,0 +1,4 @@
+env:
+  APP_VERSION: "v1.0.0"
+envForce:
+  APP_VERSION: "v1.0.0"

metadata/apps/example-hasura/router.demo.js

@@ -0,0 +1,26 @@
+import express from 'express';
+import asyncHandler from 'express-async-handler';
+
+// Import our custom request logger
+import hasuraRequestLogger from './hasura-request-logger.js';
+
+// Import our errors definition
+import errors from './errors.demo.js';
+
+// Create express router
+const router = express.Router();
+
+router.use('/hasura-*', hasuraRequestLogger);
+
+router.post(
+  '/hasura-version',
+  asyncHandler((req, res) => {
+    console.log(`${process.env.APP_VERSION}`);
+    throw new Error(errors.SOMETHING_WENT_TERRIBLY_WRONG);
+    // res.json({
+    //   version: `${process.env.APP_VERSION}`,
+    // });
+  })
+);
+
+export default router;

metadata/apps/socket-io-app/errors.socket-io.js

@@ -0,0 +1,17 @@
+import { createErrorDescriptor } from 'hlambda';
+
+// --- START SAFE TO EDIT ---
+
+export const errorsGroupName = 'socket-io';
+
+export const errors = {
+  SOCKET_SERVER_NOT_RUNNING: {
+    message: 'Socket server is not available.',
+  },
+};
+
+// --- STOP SAFE TO EDIT ---
+
+export const ed = createErrorDescriptor(errors, errorsGroupName);
+
+export default errors;

metadata/apps/socket-io-app/public/index.html

@@ -0,0 +1,60 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <title>Socket.IO chat</title>
+    <style>
+        html {
+            color-scheme: dark !important;
+        }
+        html, body {
+           background-color:#181a1b;
+        }
+        body { margin: 0; padding-bottom: 3rem; font-family: -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif; }
+        body {
+            border-color: #736b5e;
+            color: #e8e6e3;
+        }
+
+        #form { background: rgba(0, 0, 0, 0.15); padding: 0.25rem; position: fixed; bottom: 0; left: 0; right: 0; display: flex; height: 3rem; box-sizing: border-box; backdrop-filter: blur(10px); }
+        #input { border: none; padding: 0 1rem; flex-grow: 1; border-radius: 2rem; margin: 0.25rem; }
+        #input:focus { outline: none; }
+        #form > button { background: #333; border: none; padding: 0 1rem; margin: 0.25rem; border-radius: 3px; outline: none; color: #fff; }
+
+
+        #messages { list-style-type: none; margin: 0; padding: 0; }
+        #messages > li { padding: 0.5rem 1rem; }
+        #messages > li:nth-child(odd) { background: #212425; }
+    </style>
+  </head>
+  <body>
+    <ul id="messages"></ul>
+    <form id="form" action="">
+      <input id="input" autocomplete="off" /><button>Send</button>
+    </form>
+    <!-- <script src="https://cdn.socket.io/4.5.0/socket.io.min.js" integrity="sha384-7EyYLQZgWBi67fBtVxw60/OWl1kjsfrPFcaU0pp0nAh+i8FD068QogUvg85Ewy1k" crossorigin="anonymous"></script> -->
+    <script src="/socket.io/socket.io.js"></script>
+
+    <script>
+      var socket = io();
+
+      var messages = document.getElementById('messages');
+      var form = document.getElementById('form');
+      var input = document.getElementById('input');
+
+      form.addEventListener('submit', function(e) {
+        e.preventDefault();
+        if (input.value) {
+          socket.emit('chat message', input.value);
+          input.value = '';
+        }
+      });
+
+      socket.on('chat message', function(msg) {
+        var item = document.createElement('li');
+        item.textContent = msg;
+        messages.appendChild(item);
+        window.scrollTo(0, document.body.scrollHeight);
+      });
+    </script>
+  </body>
+</html>

metadata/apps/socket-io-app/router.static.js

@@ -0,0 +1,71 @@
+/* eslint-disable no-underscore-dangle */
+import { fileURLToPath } from 'url';
+import path, { dirname } from 'path';
+
+import express from 'express';
+import asyncHandler from 'express-async-handler';
+import { Server } from 'socket.io';
+
+import { executeWithAdminRights, getEnvValue, isEnvTrue } from 'hlambda';
+
+// // Define constants & errors
+// import constants from "./../../constants/constants.index.js";
+import errors from './errors.socket-io.js';
+
+const __filename = fileURLToPath(import.meta.url);
+const __dirname = dirname(__filename);
+
+// Pull from global scope hlambdaEventEmitter
+const { hlambdaEventEmitter } = global;
+// --------------------------------------------------------------------------------
+// Why do we do this?
+// Hlambda emitts event 'server-ready' when the server starts to listen. In that event we have reference to server instance.
+// Socket.io needs that server instance reference to work. This is not necessary if you want to run another server on different port.
+let io;
+const attachSocketIoServer = async (server) => {
+  // const server = await global.HLAMBDA_SERVER_INSTANCE;
+  // const io = new Server(server, {});
+  io = new Server(server, {}); // We want to use io from router.
+
+  io.on('connection', (socket) => {
+    console.log('Socket connected!');
+
+    socket.on('chat message', (msg) => {
+      io.emit('chat message', msg);
+    });
+
+    socket.on('disconnect', () => {
+      console.log('Socket disconnected!');
+    });
+  });
+};
+
+// Listen for event.
+hlambdaEventEmitter.on('server-ready', (server) => {
+  console.log(`[hlambdaEventEmitter] 'server-ready' event occurred!`.green);
+  attachSocketIoServer(server);
+});
+// --------------------------------------------------------------------------------
+
+// Create express router
+const router = express.Router();
+
+// Example of serving static files on route /io
+router.use('/io', express.static(path.resolve(__dirname, './public')));
+
+router.get(
+  '/io/msg',
+  asyncHandler((req, res) => {
+    if (typeof io === 'undefined') {
+      throw new Error(errors.SOCKET_SERVER_NOT_RUNNING);
+    }
+
+    io.emit('chat message', 'Server message!');
+
+    res.json({
+      done: true,
+    });
+  })
+);
+
+export default router;

metadata/apps/static-app-root/hlambda-config.yaml

@@ -0,0 +1,4 @@
+#Uncomment this for static serving.
+
+#envForce:
+#  HLAMBDA_DISABLE_INITIAL_ROUTE_REDIRECT: true

metadata/apps/static-app-root/public/index.html

@@ -0,0 +1 @@
+x