Infrastructure: Module Architecture Stage 2

[dsriseah]

This pull request contains example addons that build on the core URSYS library. We're pushing it now to serve as the foundation for implementing the new comment system.

• [ ] The build system does not yet do the environment checking that NetCreate does for detecting node version
• [ ] Still missing is the complete server-based URSYS client registration. The difficult part has been done (see Test 4 below) but the registration and authorization protocols are not yet complete.
• [ ] Once URSYS messaging in shape, we can adapt GEMSTEP concepts into the system (e.g. appcore, utility classes, etc)

WHAT IS IT?

Collectively, the contents of the _ur directory is an independent build system for developing new system features from the command line without disrupting the main application. Once tested, they can be selected exported from @ursys/addons package for both server and client environments for import.

Creating new addons is as simple as creating a new folder in the _ur_addons folder and adding a @file.mts to it that will run. The system will automatically add it to the command list. Each addon directory can be its own standalone 'server' that is spawned by the ur <addon> command line.

More information about the URSYS build features will be available once we started implementing the COMMENT addon for our first real test of the new system

TESTING

We're largely testing to make sure there are no missing dependencies or weird crashes happening to your NetCreate build.

1. Test Build

open terminal at project root

• pull the repo
• npm run clean
• npm ci to update all workspaces

2. Check NetCreate Function

still in project root

• npm run dev and open http://localhost:3000 in a browser
• open the javascript browser console and look for the UR and UR/ADD messages by opening the console group.

3. Test Addons for Errors

_cd _ur from project root_

These do not do anything amazing, but they demonstrate the use of different packages and use URSYS core in some cases.

• cd _ur - you will run all commands here
• Type ./ur and see the list of commands
• ./ur parse - experimental parser for line-based documents
• ./ur graph - uses parser to convert document into a netgraph object
• ./ur sqlite - reads a sqldump into sqlite
• ./ur loki - reads a lokijs database into a lokijs object (see below for instructions)

To run ./ur loki, first create a folder called _data_nocommit in the loki folder and copy a NetCreate .lokijs file into it. Rename the file to netcreate-graph.loki.

[!TIP] If you are using the netcreate-itest.code-workspace file to open the project files in Visual Studio Code, the script adds ./ to the end of your PATH for integrated terminal windows. Otherwise, you can go into your ~/.bashrc or ~/.zshrc to add ./ to the end of your PATH variable with export PATH=$PATH:./

4. Test Network Process Controllers

_still in _ur directory_

For this we'll use the ur net command, which has several subcommands. You'll need to open two terminal windows for this test.

• In terminal one: type ur net start

• In terminal two: type ur net send

• you should see the two instances talking to each other

• in either terminal: type ur net stop

• in either terminal, type ur net test to see proof of concept unit testing, which will be important in maintenance of tricky code.

5. Test Standalone Appserver

_still in _ur directory_

This addon builds a webapp that can read input from a connected MIDI keyboard and play piano notes. You can also click on them. It imports the @ursys/core library to format the browser console output.

• type ur midi
• browse to http://localhost:8888
• open the javascript browser console and look at the various output messages
• if you have a MIDI keyboard plugged-in, try pressing keys

[benloh]

One minor issue:

1. Need to update path?

   bash-3.2$ ur
   bash: ur: command not found

   But ./ur works.

I'm using the VSC Workspace. Not sure where path is set.

Everything else seems to work. Doing a general Net.Create test next.

[dsriseah]

Oh, I have my PATH set to include ./ at the end so I don't have to type that extra dot-slash. Will update instructions. I just set it in my ~/.zshrc file. I could probably modify the workspace to include it

[dsriseah]

I've added an extra detection method to the .vscode/check_env script that runs from the netcreate-itest.code-workspace project which will add it only to shells inside of the integrated VSCODE environment. You'll have to KILL the existing terminals (trash can icon in upper right of terminal panel) and reopen the terminal after you do this pull to test.

[benloh]

Confirmed path fix works. Merging.