retold-harness 1.0.2 → 1.0.4

package/.config/configstore/update-notifier-npm-check-updates.json

@@ -1,4 +1,4 @@
 {
 	"optOut": false,
-	"lastUpdateCheck": 1648097783781
+	"lastUpdateCheck": 1699199612265
 }

package/.config/configstore/update-notifier-npm.json

@@ -1,4 +1,4 @@
 {
 	"optOut": false,
-	"lastUpdateCheck": 1698350609982
-}
+	"lastUpdateCheck": 1698771786960
+}

package/.config/vscode-sqltools/runningInfo.json

@@ -0,0 +1,13 @@
+{
+  "numericVersion": 10000,
+  "releaseNotes": "https://vscode-sqltools.mteixeira.dev/changelog#v-1-0-0",
+  "run": 1699199484050,
+  "updated": false,
+  "version": "1.0.0",
+  "lastNotificationDate": 0,
+  "installedExtPlugins": {
+    "driver": [
+      "mtxr.sqltools-driver-mysql"
+    ]
+  }
+}

package/README.md

@@ -1,7 +1,90 @@
-# retold-harness
+# Retold Harness
 
-Easy start with pm2:
+A basic set of API endpoints that contains Books, Authors, Joins and links to 
+images for the cover of each book.  Useful for more complex harnesses.  
 
-`pm2 start /home/coder/retold-harness/source/Retold-Harness.js --restart-delay 100 --name retold-harness`
+Entirely self-contained.
 
-Other option is to login and just run `npm start` but that requires you to stay logged in.
+## Getting up and Running
+
+This package requires Docker to be installed on your workstation.  You can get 
+things running by typing the following commands:
+
+### 1) Clone the code from github:
+
+```
+git clone https://github.com/stevenvelozo/retold-harness
+```
+
+
+### 2) Build the docker image:
+
+_This can take a bit of time, depending on your connection speed and resources._
+
+```
+npm run docker-dev-build
+```
+
+![Building the docker image](./images/Docker-Build-Image.png)
+
+### 3) Create and launch the docker container:
+
+_This can also take a bit of time....._
+
+```
+npm run docker-dev-run
+```
+
+![Launching the docker container](./images/Docker-Run-Container.png)
+
+![The launched container in the Docker UI](./images/Docker-Container-Launched.png)
+
+
+## After the docker container is running there is quite a bit available:
+
+* a REST web API serving JSON on port 8086
+* a browser-based visual studio code environment ready to run node applications
+* a mariadb instance, preloaded with 10,000 Book records joined to their Author records
+* a partridge
+* a pear tree
+
+### This all fits in less than 500 meg of RAM, and uses virtually no processor power
+
+![Docker statistics after a few minutes of running](./images/Docker-Container-Resources.png)
+
+## Some REST API Examples
+
+The REST endpoints are provided by the [meadow-endpoints](https://www.npmjs.com/package/meadow-endpoints) library on NPM.  Some examples of queries you can make:
+
+### List the first 100 Books in the database: (http://localhost:8086/1.0/Books/0/100)
+
+![The first 100 Books](./images/API-Book-List.png)
+### Get the book with `IDBook` 1: (http://localhost:8086/1.0/Book/1)
+
+You will notice that when requesting a single book, there is an `Authors` array populated with the connected authors for the particular book.  But in the list, the array was not filled out.  This is because in meadow-endpoints there is a post-operation behavior hook only attached to the read single record endpoint.  This is reflected in the `/source/Retold-Harness.js` code file in lines 14-41.
+
+![Book 1](./images/API-Book-First.png)
+
+### List the first 10 Authors in the database whose name begins with `Susan`:  (http://localhost:8086/1.0/Authors/FilteredTo/FBV~Name~LK~Susan%25/0/10)
+
+![The first 10 Susans](./images/API-Author-Susans.png)
+
+## Luxury Code
+
+Luxury code is a set of tools to provide easy debugging and test running regardless of environment.  These tools leverage the code-server browser implementation of the Visual Studio Code editor.  The first time you launch the browser editor, you will be asked for a password.  The password is: `luxury`
+
+![Launching Luxury Code requires a Password: luxury](./images/vscode-Login.png)
+
+![Visual Studio Code Editor with Config and Source](./images/vscode-Editor.png)
+
+## MySQL
+
+The docker image also exposes a MySQL server (it's actually MariaDB but nobody is the wiser).  You can connect to and query this database directly from your tool of choice or other applications.  The user is: `root`, the port is `3306` and the password is: `123456789`
+
+![MySQL Connection Info](./images/SQL-Connection.png)
+
+![MySQL Query](./images/SQL-Query.png)
+
+## Customizing your Environment
+
+If you dislike the ports, passwords or anything else about this configuration all the code is readily available.  In the `package.json` file, the two convenience docker spin-up commands are there.  This is where you would change the port mapping for the API server, SQL server and other services.  Remember.... you broke it, you bought it.

package/docker_scripts/MySQL-Laden-Entry.sh

@@ -27,13 +27,15 @@ done
 
 echo "=> MySQL service startup finished. <="
 
-# Install the latest pm2 process manager
-# This is *quite complex* because we want to run as the synthesized user pulled in to match the user in our environment
+# This junk below is *quite complex* because we want to run as the synthesized user pulled in to match the user in our environment
 #    FOR POSTERITY: Running bash in interactive mode, trying to manually source the bashrc, etc. all failed due to
 #                   the complex way docker and the base image set the user (we have an explicit user ID).  This method
 #                   works but is ugly as heck.
+# Install the latest pm2 process manager
 export HOME=/home/coder
 bash -i <(echo "npm install pm2 -g")
+# Install the dependencies for node
+bash -i <(echo "npm install")
 # Now run the harness API within the pm2 process manager
 # Twiddling for posterity (these didn't work)
 #bash -c "pm2 start /home/coder/retold-harness/source/Retold-Harness.js"

package/package.json

@@ -1,13 +1,17 @@
 {
     "name": "retold-harness",
-    "version": "1.0.2",
+    "version": "1.0.4",
     "description": "Restful API harness.  Serves on 8086.",
     "main": "source/Retold-Harness.js",
     "scripts": {
-        "test": "./node_modules/.bin/mocha -u tdd -R spec",
         "start": "node source/Retold-Harness.js",
-        "coverage": "./node_modules/.bin/nyc --reporter=lcov --reporter=text-lcov ./node_modules/mocha/bin/_mocha -- -u tdd -R spec",
+
+        "test": "npx mocha -u tdd -R spec",
+        "tests": "npx mocha -u tdd --exit -R spec --grep",
+        "coverage": "npx nyc --reporter=lcov --reporter=text-lcov npx mocha -- -u tdd -R spec",
+
         "build": "npx quack build",
+
         "docker-dev-build": "docker build ./ -f Dockerfile_LUXURYCode -t retold-harness-image:local",
         "docker-dev-run": "docker run -it -d --name retold-harness-dev -p 20001:8080 -p 8086:8086 -p 3306:3306 -v \"$PWD/.config:/home/coder/.config\"  -v \"$PWD:/home/coder/retold-harness\" -u \"$(id -u):$(id -g)\" -e \"DOCKER_USER=$USER\" retold-harness-image:local",
         "docker-dev-shell": "docker exec -it retold-harness-dev /bin/bash"
@@ -23,10 +27,10 @@
     },
     "homepage": "https://github.com/stevenvelozo/retold-harness#readme",
     "dependencies": {
-        "retold-data-service": "^1.0.3"
+        "retold-data-service": "^1.0.4"
     },
     "devDependencies": {
-        "quackage": "^1.0.7"
+        "quackage": "^1.0.24"
     },
     "mocha": {
         "diff": true,

package/source/Retold-Harness.js

@@ -2,40 +2,62 @@ const _Settings = require('./configuration-bookstore-serve-api.js');
 
 const libFable = require('fable');
 
+// Initialize fable
 _Fable = new libFable(_Settings);
+
+// Add the data service type and initialize it
 _Fable.serviceManager.addServiceType('RetoldDataService', require('retold-data-service'));
-// The RetoldDataService defaults to process.cwd() but we want to run this from wherever.
-_Fable.serviceManager.instantiateServiceProvider('RetoldDataService',
+// Initialize it with relative paths for the model from this code folder, regardless of where we run this from
+let libRetoldDataService = _Fable.serviceManager.instantiateServiceProvider('RetoldDataService',
     {
         "FullMeadowSchemaPath": `${__dirname}/model/`,
 		"DALMeadowSchemaPath": `${__dirname}/model/meadow/`
     });
 
-_Fable.MeadowEndpoints.Book.controller.BehaviorInjection.setBehavior('Read-PostOperation',
-    (pRequest, pRequestState, fComplete) =>
+
+libRetoldDataService.onAfterInitializeAsync =
+    (fAfterInitializeComplete) =>
     {
-        // Get the join records
-        _Fable.DAL.BookAuthorJoin.doReads(_Fable.DAL.BookAuthorJoin.query.addFilter('IDBook', pRequestState.Record.IDBook),
-            (pJoinReadError, pJoinReadQuery, pJoinRecords)=>
+        // Create a post operation behavior for the book Read singular record endpoint only
+        _Fable.MeadowEndpoints.Book.controller.BehaviorInjection.setBehavior('Read-PostOperation',
+            (pRequest, pRequestState, fRequestComplete) =>
             {
-                let tmpAuthorList = [];
-                for (let j = 0; j < pJoinRecords.length; j++)
-                {
-                    tmpAuthorList.push(pJoinRecords[j].IDAuthor);
-                }
-                if (tmpAuthorList.length < 1)
-                {
-                    pRequestState.Record.Authors = [];
-                    return fComplete();
-                }
-                else
-                {
-                    _Fable.DAL.Author.doReads(_Fable.DAL.Author.query.addFilter('IDAuthor', tmpAuthorList, 'IN'),
-                        (pReadsError, pReadsQuery, pAuthors)=>
+                // Get the join records
+                _Fable.DAL.BookAuthorJoin.doReads(_Fable.DAL.BookAuthorJoin.query.addFilter('IDBook', pRequestState.Record.IDBook),
+                    (pJoinReadError, pJoinReadQuery, pJoinRecords)=>
+                    {
+                        let tmpAuthorList = [];
+                        for (let j = 0; j < pJoinRecords.length; j++)
+                        {
+                            tmpAuthorList.push(pJoinRecords[j].IDAuthor);
+                        }
+                        if (tmpAuthorList.length < 1)
+                        {
+                            _Fable.log.trace(`Found no authors for IDBook ${pRequestState.Record.IDBook} (${pRequestState.Record.Title}).  What even is a book without authors?`)
+                            pRequestState.Record.Authors = [];
+                            return fRequestComplete();
+                        }
+                        else
                         {
-                            pRequestState.Record.Authors = pAuthors;
-                            return fComplete();
-                        });
-                }
+                            _Fable.DAL.Author.doReads(_Fable.DAL.Author.query.addFilter('IDAuthor', tmpAuthorList, 'IN'),
+                                (pReadsError, pReadsQuery, pAuthors)=>
+                                {
+                                    pRequestState.Record.Authors = pAuthors;
+                                    _Fable.log.info(`Found ${pAuthors.length} authors for IDBook ${pRequestState.Record.IDBook} (${pRequestState.Record.Title}).`)
+                                    return fRequestComplete();
+                                });
+                        }
+                    });
             });
+
+        return fAfterInitializeComplete();
+    };
+
+libRetoldDataService.initializeAsync(
+    (pError) =>
+    {
+        if (pError)
+        {
+            _Fable.log.error(`Error initializing `)
+        }
     });