[DO NOT MERGE] Tracking PR for refactoring and architecture overhaul

.babelrc

@@ -1,3 +1,5 @@
 {
-    "plugins": ["transform-decorators-legacy"]
-}
+    "plugins": [
+        ["@babel/plugin-proposal-decorators", { "legacy": true }]
+    ]
+}

.dockerignore

@@ -1,10 +1,11 @@
-node_modules
-npm-debug.log
+node_modules/*
+*.md
+*.swp
+*.log
+*.yml
+*.cmd
+.*
+!.babelrc
 Dockerfile*
 docker-compose*
-.dockerignore
-.git
-.gitignore
-README.md
 LICENSE
-.vscode

.gitmodules

@@ -1,6 +1,6 @@
 [submodule "src/data/lw.machines"]
 	path = src/data/lw.machines
-	url = https://github.com/LaserWeb/lw.machines
+	url = https://github.com/easytarget-org/lw.machines.git
 [submodule "src/data/lw.materials"]
 	path = src/data/lw.materials
-	url = https://github.com/LaserWeb/lw.materials.git
+	url = https://github.com/easytarget-org/lw.materials.git

DOCKER.md

@@ -0,0 +1,62 @@
+# LaserWeb (4.1.x) Docker Builds
+
+This guide assumes some familiarity with [Docker](https://www.docker.com/), if you are new to Docker please start at: https://docs.docker.com/get-started/
+
+Docker user targets:
+- release
+- dev
+
+## Dev (development snapshot)
+You can run the current developement version of the app in Docker using the commands below.
+- build development image:
+```
+docker build --target dev -t laserweb4:dev .
+```
+- run image:
+```
+docker run -it --device=/dev/ttyUSB0 --rm -p 8000:8000 laserweb4:dev
+```
+- connect to app: http://localhost:8000
+
+## Release
+You can run the current lw.comm-server version of the app in Docker using the commands below.
+
+**Warning:** This will bundle the current (head) [lw.comm-server head](https://github.com/LaserWeb/lw.comm-server/) Git version + the LW app bundled with that, it *does not* build the latest LW app from this repo! Use the 'dev' target for that.
+
+- build release image:
+```
+docker build --target release -t laserweb4:release .
+```
+- run image:
+```
+docker run -it --device=/dev/ttyUSB0 --rm -p 8000:8000 laserweb4:release
+```
+- connect to app: http://localhost:8000
+
+## Options
+- Change the `--device=` to point to the correct USB device if necesscary, eg `--device=/dev/ttyACM0` etc.
+- To use a different port change the port mapping in the `docker run` command to `<port number>:8000` and adjust the url you connect to appropriately.
+
+## Stopping
+Stopping the running container can be tricky, it wont respond to conventional stop commands (ctrl-c, etc.)
+Start a new shell and stop the attached container with `docker stop <uuid>`
+To list running docker containers use: `docker ps`
+
+## Run in background
+If you add `-d` to the docker run command it will start the container in detached mode.
+You can use `docker logs -f <uuid>` to follow the output of this.
+
+## Clean build
+If you plan to release the docker build it is suggested you clean the dist folder first to avoid bundling obsolete build artifacts:
+`rm dist/* && git checkout dist`
+
+## Allow hot plugging & selection of connected devices
+**This is NOT recommended, since it involves running the container in `--privileged` mode, which is a [potential security risk](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities).**
+
+_..you have been warned.._
+
+- run image:
+```
+docker run -it -v /dev:/dev --rm -p 8000:8000 --cap-add=sys_nice --privileged laserweb4:dev (or relese)
+```
+- when you connect the app you should be able to see all USB devices in the selection list

Dockerfile

@@ -1,36 +1,57 @@
 #
 # ---- Base Node ----
-FROM node:10-alpine AS base
+FROM node:16-bullseye AS base
 # set working directory
 WORKDIR /usr/src/app
-
-# copy project file
-COPY package*.json ./
+# Set up Apt, install build tooling and udev
+RUN apt update
+RUN apt install -y build-essential udev
+# Upgrade npm and set node options
+RUN npm install -g npm
+RUN npm set progress=false
+# Set the port the container serves on
 EXPOSE 8000
-# copy app sources
-COPY . .
+
+#
+# ---- comm-server ----
+FROM base AS comm-server
+# Run npm install and add nodemon + lw comm server from Git
+#  (Currently use --force to allow for broken deps, this should be removed once the dep tree is fixed
+RUN npm install -g nodemon && npm install --force lw.comm-server@git+https://github.com/LaserWeb/lw.comm-server.git
+
+# ---- Release ----
+# This will use the git head version of lw.comm-server + the LW app version bundled with that.
+#  it DOES NOT build and serve the version of LaserWeb in this repo
+#
+FROM comm-server AS release
+WORKDIR /usr/src/app
+# define CMD
+CMD [ "node", "node_modules/lw.comm-server/server.js"]
 
 #
 # ---- Dependencies ----
 FROM base AS dependencies
-RUN apk add --no-cache make gcc g++ python python3 linux-headers udev git
-RUN git config --global url."https://github.com".insteadOf "ssh://git@github.com"
 # install node packages
-RUN npm set progress=false && npm config set depth 0
-RUN npm ci
+# Run npm install and add nodemon + lw comm server from Git
+#  (Currently use --force to allow for broken deps, this should be removed once the dep tree is fixed
+# copy app sources
+COPY . .
+RUN npm -force install && npm install --force lw.comm-server@git+https://github.com/LaserWeb/lw.comm-server.git
 
 #
-# ---- Test ----
-# run linters, setup and tests
-FROM dependencies AS test
-#RUN  npm run lint && npm run setup && npm run test
-RUN  npm run test
+# ---- Bash (helpful for debug) ----
+FROM dependencies AS bash
+WORKDIR /usr/src/app
+# define CMD
+CMD [ "bash" ]
 
 #
 # ---- Dev ----
 FROM dependencies AS dev
-RUN npm install && npm install -g nodemon
-# copy production node_modules
-COPY --from=dependencies /usr/src/app/node_modules node_modules
+WORKDIR /usr/src/app
+# Bundle the development build
+RUN npm run bundle-dev
+# Install into lw-comm-server
+RUN rm -rfv node_modules/lw.comm-server/app/* && cp -prv dist/* node_modules/lw.comm-server/app/
 # define CMD
-CMD [ "npm", "run", "start-server" ]
+CMD [ "node", "node_modules/lw.comm-server/server.js"]

FRONTEND-DEVELOPMENT.md

@@ -0,0 +1,153 @@
+# LaserWeb4 Frontend Developers HowTo & Guide
+This guide is aimed at anybody wishing to contribute to LaserWeb4 frontend development. It shows how to setup a development machine, and how to build the Fontend using webpack (+ webpack devserver).
+
+The Frontend is highly integrated with the backend `lw.comm-server`, which serves the Frontend via HTTP and has firmware-aware routines for many control actions (jogging, etc).
+* The frontend itself is delivered as a self-contained java webapp in a folder that is deployed into the comm-server, or run standalone. 
+* Building and deploying `lw.comm-server` is not covered here. (TODO: Link to relevant docs for this)
+
+## Machine Prep
+This is still a WIP!
+
+For support please go to the MakerForums at: https://forum.makerforums.info/c/laserweb-cncweb/
+
+### Supported systems
+The basic requirement is Node >= 12, and npm >= 7.
+
+However; the 'real' requirement is node 16; several of the modules we use sitll work with Node12, but no longer formally support it and can be expected to fail sometime in the future.
+
+I use Fedora 35, node 16 and npm 8 on a fast laptop as my primary development environment, but I test and deploy my previews on a Pi 4 running Bullseye.
+
+These Instructions should work for all Pi 3 and 4 models running the Buster and Bullseye releases. Also see the [wiki](https://github.com/LaserWeb/lw.comm-server/wiki/Manual-Installation-(RasPi)) page about Pi installation for more info and notes on how to run LaserWeb4 as a service.
+
+## Raspbian/Debian Bullseye
+This is nice and easy; node 12 is part of the RPI OS release.
+
+    pi@lwserver:~ $ uname -a
+    Linux lwserver.easytarget.org 5.10.63-v8+ #1488 SMP PREEMPT Thu Nov 18 16:16:16 GMT 2021 aarch64 GNU/Linux
+
+    pi@lwserver:~ $ lsb_release -a
+    No LSB modules are available.
+    Distributor ID: Raspbian
+    Description:    Raspbian GNU/Linux 11 (bullseye)
+    Release:        11
+    Codename:       bullseye
+
+    pi@lwserver:~ $ sudo apt update
+    ...
+    All packages are up to date.
+
+### Install build tools, NodeJS and NPM on Bullseye
+*Note: if you have previously followed instructions given here showing you how to install Node10 and hold to that version, you should unpin node with `sudo apt-mark unhold nodejs` and then remove the node repos with `sudo rm /etc/apt/sources.list.d/nodesource.list`*
+
+    pi@lwserver:~ $ sudo apt install build-essential nodejs npm
+    ... lots of output, on my test system 180'ish small packages are installed.. should result in success
+
+    pi@lwserver:~ $ node -v
+    v12.22.5
+
+    pi@lwserver:~ $ npm -v
+    7.5.2
+
+## Raspbian/Debian running Buster
+Unfortunately, Node 12 is not part of the RPI OS release (Node 10 is the standard, but we are not compatible with that) and so we need to use node 12 from nodesource.org
+
+    pi@buster:~ $ uname -a
+    Linux buster.easytarget.org 5.10.63-v7+ #1496 SMP Wed Dec 1 15:58:11 GMT 2021 armv7l GNU/Linux
+
+    pi@buster:~ $ lsb_release -a
+    No LSB modules are available.
+    Distributor ID: Raspbian
+    Description:    Raspbian GNU/Linux 10 (buster)
+    Release:        10
+    Codename:       buster
+
+    pi@buster:~ $ sudo apt update
+    ...
+    All packages are up to date.
+
+### Install build tools, NodeJS and NPM on Buster
+We will ensure some required tools are in place, then run the setup script from nodesource.com, once that is done we can install nodejs and npm using apt in the same manner as for bullseye
+
+    pi@buster:~ $ sudo apt install curl dirmngr apt-transport-https lsb-release ca-certificates
+    ... it's quite liklely that these are already installed
+
+    pi@buster:~ $ curl -sL https://deb.nodesource.com/setup_12.x | sudo -E bash -
+    ... the script will run, and configure apt to use the node12 repositories
+
+    pi@buster:~ $ sudo apt install build-essential nodejs
+    ... should only install a few packages and result in success
+
+    pi@buster:~ $ node -v
+    v12.22.8
+
+    pi@buster:~ $ npm -v
+    6.14.15
+
+# Download the repos from GitHub
+These repos are somewhat large, the clone operations may be slow
+
+    pi@lwserver:~ $ git clone https://github.com/LaserWeb/LaserWeb4.git
+    OR, if you have a GitHub account: git clone git@github.com:LaserWeb/LaserWeb4.git
+    Cloning into 'LaserWeb4'...
+
+    pi@lwserver:~ $ ls LaserWeb4/
+    dist        docs  jsdoc.json      LICENSE.md   package.json       README.md  webpack.config.js
+    Dockerfile  git   laserweb@0.4.0  logfile.txt  package-lock.json  src        win.shell.cmd
+
+    pi@lwserver:~ $ cd LaserWeb4/
+    pi@lwserver:~/LaserWeb4 $ git branch
+    * dev-es6
+
+    Now we must initilise and update the LW4 submodules
+    pi@lwserver:~/LaserWeb4 $ git submodule init
+    Submodule 'src/data/lw.machines' (https://github.com/LaserWeb/lw.machines) registered for path 'src/data/lw.machines'
+    Submodule 'src/data/lw.materials' (https://github.com/LaserWeb/lw.materials.git) registered for path 'src/data/lw.materials'
+
+    pi@lwserver:~/LaserWeb4 $ git submodule update
+    Cloning into '/home/pi/LaserWeb/LaserWeb4/src/data/lw.machines'...
+    Cloning into '/home/pi/LaserWeb/LaserWeb4/src/data/lw.materials'...
+    Submodule path 'src/data/lw.machines': checked out '685d9de193400a7bcf35d921eda21e4bedfbdc7b'
+    Submodule path 'src/data/lw.materials': checked out 'dce9f9ae104030e192a9716f095988dc33c0c0cd'
+
+## Build LaserWeb4 frontend
+First we install laserweb4's dependencies
+
+    pi@lwserver:~ $ cd ~/LaserWeb4/
+
+    pi@lwserver:~/LaserWeb4 $ npm install
+
+If you have failures here the first thing to do is 'reset' the package lock with `rm package-list.json` and trying again.
+
+## Build and Generate a distribution (aka Bundle) the frontend build
+The results end up in the `dist` folder of the repo
+
+    pi@lwserver:~/LaserWeb4 $ npm run bundle-dev
+
+The results of the build will go into the `./dist` folder in the repo.
+* You can serve them directly from there with `python3 -m http.server 8000` and connect to port 8000 in your browser
+* You can 'clean' the `dist` folder with `cd dist && rm * && git checkout .` (TODO: npm run clean-dist)
+
+## CI
+WebPack allows handy ways of continuously integrating/building your local code.
+
+    pi@lwserver:~/LaserWeb4 $ npm run watch-dev
+
+Will continually and quickly re-build LW4 to the `dist` folder but I prefer:
+
+    pi@lwserver:~/LaserWeb4 $ npm run start-dev
+
+* This is great; it builds the app, then serves it on a local port (8080 by default)
+* It then monitors the repo and fast re-builds as needed when you modify files
+* The served app is restarted whenever it rebuilds, and errors get shown in the browser as well as the cli
+
+## Production Builds
+Production builds (`npm run bundle-prod`) are smaller & faster, but slower to compile, and lack debug mappings etc. They are intended to be used during releasing/deployment and are not of much interest here unless you are planning on releasing
+
+# Notes:
+
+## Not the end
+I'm still working on this... I want to add an architecture overview, style and contributing guide. I intend to have a seperate 'releasing' guide that references this.
+
+## Caveat for Pi3 model A (and Pi2's ?)
+You can no longer build the frontend with a Pi3+ model A; with only 512Mb of memory it cannot compile without encountering out of memory errors.
+

README.md

@@ -9,12 +9,7 @@ Releases are made available on https://github.com/LaserWeb/LaserWeb4-Binaries/
 For more documentation, go to the [Wiki](https://github.com/LaserWeb/LaserWeb4/wiki) or our website https://laserweb.yurl.ch
 
 ## Docker
-
-- run image:
-```sh
-docker run -device=/dev/ttyUSB0 -p 8000:8000 joesantos/laserweb:latest
-```
-- connect to app: http://localhost:8000
+See the separate [Docker Guide](DOCKER.md).
 
 ### Development
 
@@ -51,11 +46,12 @@ Note: Ever changing. See the Issues tab above for details.
 | Grbl > v1.1f (ATmega328)  | Yes        | Good                |   Great      | Yes - improvements                |
 | Grbl-Mega (ATmega2560)    | Yes        | Good                |   Great      | Yes - improvements                |
 | Grbl-LPC (LPC176x)        | Yes        | Great               |   Great      | Yes - improvements                |
-| Grbl_ESP32 (ESP32)        | Yes        | Great               |   Great      | Yes - improvements                |
+| Grbl_ESP32 (ESP32)        | Yes        | Great               |   Great      | No  - Superseded by FluuidNC      |
+| FluidNC (ESP32)           | Yes        | Great               |   Great      | Yes - improvements                |
 | Smoothieware              | Yes *      | Okayish             |   Okayish    | Yes - improvements                |
 | TinyG                     | Yes        | Unknown             |   Good       | Yes - improvements                |
-| Marlin                    | Yes        | Unknown             |   No         | Yes - improvements                | 
-| MarlinKimbra              | Yes        | Unknown             |   No         | Yes - improvements                | 
+| Marlin                    | Yes        | Unknown             |   No         | Yes - improvements                |
+| MarlinKimbra              | Yes        | Unknown             |   No         | Yes - improvements                |
 | Repetier                  | Yes        | Unknown             |   No         | Yes - improvements                |
 | RepRapFirmware            | Yes        | Unknown             |   Yes        | Yes - improvements                |
 
@@ -73,5 +69,6 @@ If you want to contribute, below are long standing community-requested enhanceme
 
 ## How to contribute ?
 
-Details on [https://github.com/LaserWeb/LaserWeb4/wiki/How-to-Contribute](https://github.com/LaserWeb/LaserWeb4/wiki/How-to-Contribute)
+To set up a development environment see the [Developer HowTo](FRONTEND-DEVELOPMENT.md) in the repo.
+Further details are on [https://github.com/LaserWeb/LaserWeb4/wiki/How-to-Contribute](https://github.com/LaserWeb/LaserWeb4/wiki/How-to-Contribute)