INFRASTRUCTURE: Logging System Basics, Error Manager Libraries - [merged] #706

Closed benloh closed 1 year ago

In GitLab by @daveseah on Jul 27, 2022, 15:47

Merges dev-sri/system-updates -> dev-next

(incorporates !257, which can be closed if this succceeds)

This merge request adds to major infrastructure systems: Event Logging and Error Management supporting code. These features have not, however, been activated anywhere in the codebase. Both these feature require surgical placement in the code, and is best handled in a careful pair programming session.

TESTING

With luck, this merge request doesn't change anything in the existing projects, as it just adds some features that are not yet used. There are some cosmetic fixes here and there, and MAIN will now throw up a big error overlay so users know the system crashed before it could even draw anything.

NEW: EVENT LOGGING

The system event logger that is part of URSYS has been hooked back in with a new call UR.LogEvent('eventName',itemsList).

The eventName is a researcher-chosen string that identifies the kind of information being captures
The itemList is an array of strings and numbers that will be logged in order they are defined

The logged data goes into the gem_srv/runtime folder and is tagged with the UADDR (address) of the webapp that is sending the log. The line begins with the UADDR and eventName, and is followed by TAB-DELIMITED items. This makes it easy to copy/paste into a spreadsheet like Excel and have the fields line up. The delimiter character can be changed to whatever is necessary, though be aware that choosing ',' means that you will have to make sure your itemsList strings don't have commas either.

NEW: ERROR MANAGER

The error manager has not been able to be merged until now because the approach it takes requires a careful structured of how errors cascade throughout the system; to have done so earlier would have broken the prototype for the workshop because it was handling errors in a different way.

Currently the error manager is now back in the library. It's enabled for Main when it is calling PROJSERVER.ProjectDataPreInit(this, projId) to detect bad project files and pop-up an alert to let users know something is wrong.

In all other cases, error catching traps are in place, but are commented out. The affected modules are:

ac-blueprints / m_CompileBlueprint() - catch TextToScript, SymbolizeBlueprint, CompileBlueprint, and RegisterBlueprint
ac-editmgr / m_AddSlotsValidation() - catch ValidateStatement()
ac-instances / SetInstances() - catch STORE.updateAndPublish(instances)
ac-metadata / SetMetadata() - catch DCPROJECT.UpdateProjectData() and STORE.updateAndPublish()
ac-rounds / SetRounds() - catch DCPROJECT.UpdateProjectData() and STORE.updateAndPublish()
ac-wizcore / InitSetState() - catch script_tokens interceptState()
conditions MakeAgentExprTest() - catch ParseExpression
conditions MakePairAgentExprTest() - catch ParseExpression
class-expr-evaluator-v2 - catch Evaluate
class-symbol-intepreter anyExpr() - catch ParseExpression
script-compiler DecodeStatement() - catch DecodeToken which potentially recurses
script-tokenizer TextToScript() - catch tokenize()
transpiler-v2 ValidateLineText() - catch TextToScript, ValidateStatement
sim-agents MakeAgent() - catch OpenBundle, CompileText, GetAgentById, MakeAgent, agent.exec(initScript)
sim-conditions m_ProcessInteractions - retrieve results from SIMCOND.PairAgentFilter()
sim-rounds RoundInit() - catch m_RunScript(round.initScript)
sim-rounds RoundStop() - catch m_RunScript(round.endScript)

This is not a complete trap strategy, but is good enough to start the discussion on how to trap errors in a way that they can be reported by the GUI. One error can cascade through the entire system under very different contexts; is a script error occurring during compile time or runtime? Is it a script defined as an initScript or roundScript causing the compiler to crash? Is the error due to a missing symbol or syntax error? This will require considerable guidance to outline the system in terms of user operations mapped to underlying technical pathways so we know where to insert the error traps.

OTHER MISCELLANEOUS FIXES

The duplicate libraries for expression parsing and evaluation have been eliminated
various linter fixes
somewhat improved phasemachine error reporting when an error occurs during a promise

In GitLab by @daveseah on Jul 27, 2022, 17:56

added 25 commits

82989a42 - sri/412-error-mgr: update api-error manager prior to directory move
cb95d1b1 - sri/412-error-mgr: rename api-error to modules/error-mgr
7c082eb6 - sri/412-error-mgr: WIP add version number settings, import SystemShell.css...
6b1eeda8 - sri/412-error-mgr: URSYS changes to suppress/intercept PHASE MACHINE errors, server errors
3ff17a6e - sri/412-error-mgr: error manager module! w/ examples of using top-level...
1078b98c - sri/412-error-mgr: first pass attempt to intercept system-crashing errors...
e1fe7001 - 412-error-mgr: sim-agents was missing ERROR module
9eb2e591 - Merge branch 'dev-next-gui' into dev-sri/412-error-mgr
6e753a70 - sri/412-error-mgr: convert old js modules to typescript
07f56adb - sri/412-error-mgr: remove redundant expr libraries and standardize names and locations, fix ts bugs
fb862652 - sri/412-error-mgr: correct parameters for error reporting
16077f29 - build-system: fix .eslintrc false lint error
ffa8b057 - build-system: fix linting errors in gem_run due to change in eslint
1df07757 - merge next-gui-dirty into 412-error-mgr to check compatibiloity
9fddaf60 - 412-error-mgr: add missing catch
375d0a76 - Merge branch 'dev-sri/360-default-sprite' into dev-sri/412-error-mgr
2fcd3c7c - Merge branch 'dev-sri/412-error-mgr' into dev-next-gui-errhelp
e0939ca4 - gui-errhelp: main needs to check ERR_MGR flag properly
31d2fd1a - gui-errhelp: PROGRAM INIT is now default
6528a6cc - dev-next-gui-errhelp: remove bundler warning if program-out already is set to same out
ad292fde - Merge branch 'dev-next' into dev-next-gui-errhelp
360c9663 - Merge branch 'dev-next-gui-errhelp' into dev-sri/system-updates
a4080d94 - system-updates: remove useless devcode versioning, replace with trial versioning
2e817cdd - system-updates: make "boolean" text coloring match other values "string" and "number"
7c49939e - system-updates: remove extraneous code from symbol-interpreter

Compare with previous version

In GitLab by @daveseah on Jul 27, 2022, 19:00

added 2 commits

c8559521 - system-updates: fix regression to old library import
d6ac8c3d - system-updates-error-manager: placeholder try/catch code in place, commented out for now.

Compare with previous version

In GitLab by @daveseah on Jul 27, 2022, 19:04

marked this merge request as ready

In GitLab by @daveseah on Jul 28, 2022, 10:04

added 1 commit

12e36bfc - system-updates: uncommitted wizcore ERROR capture

Compare with previous version

QA Testing Log

Jotting notes on testing for future reference.

CAUGHT

Errors clearly caught by the existing Error Manager, showing an error on the Main screen.

Non-existent project file -- e.g. http://localhost/app/main?project=starter_991 to open a project, but starter_991 doesn't exist. Error caught. Useful message in dev console: "logging error from project-loader could not load and initialize project starter_991". Page is unresponsive. Need to change URL and reload to start.
Project File Error: Bad json in project file -- e.g. missing comma in rounds. Error caught. Useful message in dev console: "logging error from assets: could not load resources for starter_fresh" and "logging error from project-loader: could not load and initialize project starter_fresh"

NOT CAUGHT

These are not necessarily problems...just noting where Error Manager is not catching stuff.

Script Error: GEMSCRIPT reference to non-existing blueprint name -- Rename an existing Foo blueprint that has references to featCall Foo.Costume... to Bar and save changes to server. Server reports SimPlaces Error -- bad script? Error: context missing 'Foo' (Ben's workshoptry...catch` that is not integrated into Error Mgr).
Script Error: Unclosed Blocks -- Added [[ without closing blocks. ScriptEditor dev console shows error: "Uncaught Error: EOF without 1 unclosed blocks @13:16". Error Mgr does not engage.
Script Error: Missing open blocks -- Added ]] without opening blocks. ScriptEditor dev console shows error: "Uncaught Error: GobbleIdentifier: Unexpected ] @9:0"
Round InitScript Error: Malformed script -- Added featCall with no parameters to Round 1 init script. Error shows up only after clicking "Prep Round". Error Mgr does not engage. Main dev console says: "Uncaught TypeError: Cannot read properties of undefined (reading 'objref') at featCall.compile"
Script Error: "Else" block -- In Moths-Activity-Dont-Know line 38, the "if" statement has an "else" block. Load this activity, and hit "Prep Round". This will generate an error: "class-gscript-tokenizer-v2.ts:828 Uncaught Error: KeywordFromToken: tok 'block' is not decodeable as a keyword at Module.KeywordFromToken". Dumping kwTok will show the script for the line the error is on. Main dev console error only, no Error Manaager.

OTHERS

Confirmed that UR.LogEvent('eventName',itemsList') does log to runtime.
General Bug? "Uncaught Error: AddToProgramOut: call OpenBundle() before this call" at script-bundler:31 -- NOTE this does not have to do with the error manager per se, but does represent an interesting error condition. Art asset is 298c4af4b01c3b906b7c5489bd2cc5fdfa933890.
- Load Moths-Activity-Migration
- Click "Prep Round"
- After RoundInit
- The specific problem is the round init script has a addFeature AgentWidgets for the global agent.
- But this actually has many layers of issues:
- addFeature in a round init script -- who's the target agent? global?
- addFeature AgentWidgets to global agent
- Do we need to catch the use of addFeature?
- Is there a bug in script-bundler?

Tested opening and running and editing multiple projects. Things seem to run for the most part, so merging.

mentioned in commit 977e2cdcaa145c1c253c348be74f1878e668593e

theRAPTLab / gsgo