Refactor file handling and update file names

Author: Andreas-Kreuz

.gitignore

@@ -25,8 +25,21 @@ __pycache__
 
 # @ak/web-app
 /apps/web-app/VERSION
-/apps/web-app/cypress/io-empty/LUA/ce/databridge/exchange/ak*
+/apps/web-app/cypress/io-empty/LUA/ce/databridge/exchange/ce-*
+/apps/web-app/cypress/io-empty/LUA/ce/databridge/exchange/events-from-ce
+/apps/web-app/cypress/io-empty/LUA/ce/databridge/exchange/events-from-ce.pending
+/apps/web-app/cypress/io-empty/LUA/ce/databridge/exchange/log-from-ce
+/apps/web-app/cypress/io-empty/LUA/ce/databridge/exchange/commands-to-ce
+/apps/web-app/cypress/io-empty/LUA/ce/databridge/exchange/server-is-running
+/apps/web-app/cypress/io-empty/LUA/ce/databridge/exchange/server-state.*
 /apps/web-app/cypress/io/LUA/ce/databridge/exchange/ak*
+/apps/web-app/cypress/io/LUA/ce/databridge/exchange/ce-*
+/apps/web-app/cypress/io/LUA/ce/databridge/exchange/events-from-ce
+/apps/web-app/cypress/io/LUA/ce/databridge/exchange/events-from-ce.pending
+/apps/web-app/cypress/io/LUA/ce/databridge/exchange/log-from-ce
+/apps/web-app/cypress/io/LUA/ce/databridge/exchange/commands-to-ce
+/apps/web-app/cypress/io/LUA/ce/databridge/exchange/server-is-running
+/apps/web-app/cypress/io/LUA/ce/databridge/exchange/server-state.*
 /apps/web-app/cypress/io/ak*
 /apps/web-app/cypress/screenshots
 /apps/web-app/cypress/videos
@@ -39,9 +52,21 @@ __pycache__
 /apps/web-shared/resources/public
 
 # compiled output
-/web-app/cypress/io/ak*
-/web-app/cypress/io/LUA/ce/databridge/exchange/ak*
+/web-app/cypress/io/LUA/ce/databridge/exchange/ce-*
+/web-app/cypress/io/LUA/ce/databridge/exchange/events-from-ce
+/web-app/cypress/io/LUA/ce/databridge/exchange/events-from-ce.pending
+/web-app/cypress/io/LUA/ce/databridge/exchange/log-from-ce
+/web-app/cypress/io/LUA/ce/databridge/exchange/commands-to-ce
+/web-app/cypress/io/LUA/ce/databridge/exchange/server-is-running
+/web-app/cypress/io/LUA/ce/databridge/exchange/server-state.*
 /web-app/cypress/io-empty/LUA/ce/databridge/exchange/ak*
+/web-app/cypress/io-empty/LUA/ce/databridge/exchange/ce-*
+/web-app/cypress/io-empty/LUA/ce/databridge/exchange/events-from-ce
+/web-app/cypress/io-empty/LUA/ce/databridge/exchange/events-from-ce.pending
+/web-app/cypress/io-empty/LUA/ce/databridge/exchange/log-from-ce
+/web-app/cypress/io-empty/LUA/ce/databridge/exchange/commands-to-ce
+/web-app/cypress/io-empty/LUA/ce/databridge/exchange/server-is-running
+/web-app/cypress/io-empty/LUA/ce/databridge/exchange/server-state.*
 /web-app/cypress/videos
 /web-app/cypress/screenshots
 /web-app/dist
@@ -76,7 +101,14 @@ __pycache__
 /lua/LUA/StorageUtilityValues.txt
 /lua/LUA/ce/anlagen
 /lua/LUA/ce/VERSION
-/lua/LUA/ce/databridge/exchange/ak*
+/lua/LUA/ce/databridge/exchange/ce-*
+/lua/LUA/ce/databridge/exchange/events-from-ce
+/lua/LUA/ce/databridge/exchange/events-from-ce.pending
+/lua/LUA/ce/databridge/exchange/log-from-ce
+/lua/LUA/ce/databridge/exchange/commands-to-ce
+/lua/LUA/ce/databridge/exchange/ce-version.txt
+/lua/LUA/ce/databridge/exchange/server-is-running
+/lua/LUA/ce/databridge/exchange/server-state.*
 /lua/LUA/comm_*
 /lua/modell-pakete
 

apps/web-app/cypress.config.mjs

@@ -1,5 +1,24 @@
 import { defineConfig } from 'cypress';
 import { rm } from 'node:fs';
+import { access } from 'node:fs/promises';
+
+async function waitForFileMissing(fileName, timeoutMs = 5000) {
+  const start = Date.now();
+
+  while (Date.now() - start < timeoutMs) {
+    try {
+      await access(fileName);
+    } catch (error) {
+      if (error && typeof error === 'object' && 'code' in error && error.code === 'ENOENT') {
+        return true;
+      }
+    }
+
+    await new Promise((resolve) => setTimeout(resolve, 50));
+  }
+
+  throw new Error(`Timed out waiting for file to disappear: ${fileName}`);
+}
 
 export default defineConfig({
   projectId: 'g5rj4e',
@@ -12,6 +31,9 @@ export default defineConfig({
           rm(fileName, () => {});
           return null;
         },
+        waitForFileMissing(fileName) {
+          return waitForFileMissing(fileName);
+        },
       });
     },
   },

apps/web-app/cypress/e2e/modules/log/log_spec.cy.ts

@@ -28,7 +28,7 @@ describe('Logger', () => {
   it('has no initial log', () => {
     cy.visit('/');
     cy.wait(500).then(() => {
-      cy.readFile(simulator.fileNames.eepOutLog).then((a) => cy.log(a));
+      cy.readFile(simulator.fileNames.logFromCe).then((a) => cy.log(a));
       getLogList().children().should('have.length', 0);
     });
   });
@@ -38,7 +38,7 @@ describe('Logger', () => {
       simulator.writeLogLine('Let us test something');
       cy.visit('/');
       cy.wait(500).then(() => {
-        cy.readFile(simulator.fileNames.eepOutLog).then((a) => cy.log(a));
+        cy.readFile(simulator.fileNames.logFromCe).then((a) => cy.log(a));
         getLogList().children().should('have.length', 1).first().contains('Let us test something');
       });
     });
@@ -47,7 +47,7 @@ describe('Logger', () => {
       simulator.writeLogLine('Äpfel, Überschuss, ÖPNV');
       cy.visit('/');
       cy.wait(500).then(() => {
-        cy.readFile(simulator.fileNames.eepOutLog).then((a) => cy.log(a));
+        cy.readFile(simulator.fileNames.logFromCe).then((a) => cy.log(a));
         getLogList().children().should('have.length', 1).first().contains('Äpfel, Überschuss, ÖPNV');
       });
     });
@@ -56,7 +56,7 @@ describe('Logger', () => {
       simulator.writeLogLine('Line 1\nLine 2\nLine 3');
       cy.visit('/');
       cy.wait(500).then(() => {
-        cy.readFile(simulator.fileNames.eepOutLog).then((a) => cy.log(a));
+        cy.readFile(simulator.fileNames.logFromCe).then((a) => cy.log(a));
         getLogList()
           .children()
           .should('have.length', 3)
@@ -73,7 +73,7 @@ describe('Logger', () => {
       simulator.writeLogLine('Line 1\nLine 2\nLine 3\nLine 4');
       cy.visit('/');
       cy.wait(500).then(() => {
-        cy.readFile(simulator.fileNames.eepOutLog).then((a) => cy.log(a));
+        cy.readFile(simulator.fileNames.logFromCe).then((a) => cy.log(a));
         getLogList()
           .children()
           .should('have.length', 4)
@@ -90,13 +90,13 @@ describe('Logger', () => {
   });
   describe('action', () => {
     it('"Reset Button" sends "clearlog" command to EEP', () => {
-      cy.writeFile(simulator.fileNames.serverOutCommands, '');
+      cy.writeFile(simulator.fileNames.commandsToCe, '');
       cy.visit('/');
       cy.wait(500).then(() => {
         cy.get('#open-log').click();
         cy.get('#delete-log').click();
       });
-      cy.readFile(simulator.fileNames.serverOutCommands, 'latin1').should('eq', 'clearlog\n');
+      cy.readFile(simulator.fileNames.commandsToCe, 'latin1').should('eq', 'clearlog\n');
     });
   });
 

apps/web-app/cypress/fixtures/map-01-events/README.md

@@ -9,8 +9,8 @@ Created with:
 
 1. **Close EEP-Web-Server** if running
 
-2. **Create watching file** in the game folder of EEP to simulate the server  
-   `lua\ak\io\exchange\ak-server.iswatching`
+2. **Create server indicator file** in the game folder of EEP to simulate the server  
+   `lua\ce\databridge\exchange\server-is-running`
 
 3. **Start EEP or reload the Lua Script**
    so EEP can write the event file
@@ -19,13 +19,12 @@ Created with:
    `cd web-server`  
    `npm run persist-eep-state`
 
-   This will read the file `ak-eep-out.json` and write the output to the folder
+   This will read the file `events-from-ce` and write the output to the folder
    `../web-app/cypress/fixtures/from-eep`
 
 5. **Follow-up events can be parsed** with the following chain:
-
    1. Let EEP run until the desired state is reached
-   2. Remove the file `ak-eep-out-json.ready` in `lua\ak\io\exchange\`  
+   2. Remove the file `events-from-ce.pending` in `lua\ce\databridge\exchange\`  
       (This will tell EEP to write events in the next cycle.)
    3. Let EEP run - so it can write the eventlog.
    4. Run `npm run persist-eep-state` in the `web-server` directory.

apps/web-app/cypress/test-helpers/eep-simulator.ts

@@ -1,11 +1,11 @@
 import { version } from '../../package.json';
 
 export enum FileNames {
-  eepOutJsonOut = 'cypress/io/LUA/ce/databridge/exchange/ak-eep-out.json',
-  eepOutJsonOutFinished = 'cypress/io/LUA/ce/databridge/exchange/ak-eep-out-json.isfinished',
-  eepOutLog = 'cypress/io/LUA/ce/databridge/exchange/ak-eep-out.log',
-  serverOutCommands = 'cypress/io/LUA/ce/databridge/exchange/ak-eep-in.commands',
-  serverWatching = 'cypress/io/LUA/ce/databridge/exchange/ak-server.iswatching',
+  eventsFromCe = 'cypress/io/LUA/ce/databridge/exchange/events-from-ce',
+  eventsFromCePending = 'cypress/io/LUA/ce/databridge/exchange/events-from-ce.pending',
+  logFromCe = 'cypress/io/LUA/ce/databridge/exchange/log-from-ce',
+  commandsToCe = 'cypress/io/LUA/ce/databridge/exchange/commands-to-ce',
+  serverIsRunning = 'cypress/io/LUA/ce/databridge/exchange/server-is-running',
 }
 
 const resetMarker = '@@CE_LOG_RESET@@';
@@ -18,19 +18,19 @@ export default class EepSimulator {
 
   reset = () => {
     this.eventCounter = 0;
-    cy.task('deleteEepLogFile', FileNames.eepOutLog);
-    cy.readFile(FileNames.eepOutLog).should('not.exist');
-    cy.readFile(FileNames.serverWatching).should('exist');
-    cy.writeFile(FileNames.eepOutLog, '', 'latin1');
-    cy.writeFile(FileNames.serverOutCommands, '');
+    cy.task('deleteEepLogFile', FileNames.logFromCe);
+    cy.readFile(FileNames.logFromCe).should('not.exist');
+    cy.readFile(FileNames.serverIsRunning).should('exist');
+    cy.writeFile(FileNames.logFromCe, '', 'latin1');
+    cy.writeFile(FileNames.commandsToCe, '');
     this.eepEvent('reset.json');
   };
 
-  loadFixtures = (fixtures: string[]) => {
-    const res = <any>[];
+  loadFixtures = (fixtures: string[]): Cypress.Chainable<any[]> => {
+    const res: any[] = [];
     // could also use `res.push(f)` they should be equivalent
     fixtures.map((name, i) => cy.fixture(name).then((f) => (res[i] = f)));
-    return cy.wrap(res);
+    return cy.wrap<any[]>(res);
   };
 
   simulateMap(mapName: string, startEvent: number, endEvent: number) {
@@ -41,7 +41,7 @@ export default class EepSimulator {
     }
     const eventJsons = this.loadFixtures(eventFileNames).then((jsons) => {
       cy.log(jsons.length.toLocaleString());
-      cy.writeFile(FileNames.serverOutCommands, '');
+      cy.writeFile(FileNames.commandsToCe, '');
       this.writeNewEepEventFile(jsons.map((x) => JSON.stringify(x)).join('\n'));
     });
   }
@@ -61,10 +61,10 @@ export default class EepSimulator {
 
   // Append complete log lines like LogOutputFileWriter does.
   writeLogLine(line: string) {
-    cy.readFile(FileNames.eepOutLog, 'latin1').then((oldLines) => {
+    cy.readFile(FileNames.logFromCe, 'latin1').then((oldLines) => {
       cy.log(oldLines);
       const prefix = oldLines.length > 0 && !oldLines.endsWith('\n') ? oldLines + '\n' : oldLines;
-      cy.writeFile(FileNames.eepOutLog, prefix + line + '\n', 'latin1');
+      cy.writeFile(FileNames.logFromCe, prefix + line + '\n', 'latin1');
       cy.wait(100); // Give the web server some time to read new log lines
     });
   }
@@ -74,8 +74,8 @@ export default class EepSimulator {
   }
 
   private writeNewEepEventFile(eventLines: string) {
-    cy.writeFile(FileNames.eepOutJsonOut, eventLines, 'latin1');
-    cy.writeFile(FileNames.eepOutJsonOutFinished, '');
-    cy.readFile(FileNames.eepOutJsonOutFinished).should('not.exist');
+    cy.writeFile(FileNames.eventsFromCe, eventLines, 'latin1');
+    cy.writeFile(FileNames.eventsFromCePending, '');
+    cy.task('waitForFileMissing', FileNames.eventsFromCePending);
   }
 }

apps/web-server/src/server/eep/helpers/EepStateReader.ts

@@ -2,7 +2,7 @@ import fs from 'fs';
 import path from 'path';
 
 const persistState = () => {
-  const jsonFile = path.resolve('../lua/LUA/ce/databridge/exchange/ak-eep-out.json');
+  const jsonFile = path.resolve('../lua/LUA/ce/databridge/exchange/events-from-ce');
   const data: string = fs.readFileSync(jsonFile, { encoding: 'latin1' });
   const eventLines: string[] = data.split('\n');
   for (const line of eventLines) {

apps/web-server/src/server/eep/service/EepService.ts

@@ -49,15 +49,15 @@ export default class EepService implements CacheService {
   }
 
   private connectToFiles(): void {
-    this.attachAkEepOutJsonFile();
-    this.attachAkEepOutLogFile();
-    this.createAkServerFile();
+    this.attachEventsFromCeFile();
+    this.attachLogFromCeFile();
+    this.createServerIsRunningFile();
     this.deleteFileOnExit(FileNames.serverEventCounter);
   }
 
   private disconnectFromFiles(): void {
     if (this.dir) {
-      this.deleteFileIfExists(path.resolve(this.dir, FileNames.serverWatching));
+      this.deleteFileIfExists(path.resolve(this.dir, FileNames.serverIsRunning));
     }
 
     this.logFileMonitor.detach();
@@ -125,9 +125,9 @@ export default class EepService implements CacheService {
     }
   }
 
-  private attachAkEepOutJsonFile(): void {
-    const jsonFile = path.resolve(this.dir, FileNames.eepOutJsonOut);
-    const jsonReadyFile = path.resolve(this.dir, FileNames.eepOutJsonOutFinished);
+  private attachEventsFromCeFile(): void {
+    const jsonFile = path.resolve(this.dir, FileNames.eventsFromCe);
+    const jsonReadyFile = path.resolve(this.dir, FileNames.eventsFromCePending);
 
     // First start: Read the JSON file - ignore if EEP is ready
     if (!this.jsonFileWatcher) {
@@ -141,7 +141,7 @@ export default class EepService implements CacheService {
     // Watch in the directory, if the file is recreated
     this.jsonFileWatcher = fs.watch(this.dir, {}, (eventType: string, filename: string) => {
       // If the jsonReadyFile exists: Read the data and remove the file
-      if (filename === FileNames.eepOutJsonOutFinished && fs.existsSync(jsonReadyFile)) {
+      if (filename === FileNames.eventsFromCePending && fs.existsSync(jsonReadyFile)) {
         // console.log('Reading: ', jsonFile);
         this.readJsonFile(jsonFile, jsonReadyFile);
       }
@@ -174,19 +174,19 @@ export default class EepService implements CacheService {
     }
   }
 
-  private attachAkEepOutLogFile(): void {
-    this.logFileMonitor.attach(path.resolve(this.dir, FileNames.eepOutLog));
+  private attachLogFromCeFile(): void {
+    this.logFileMonitor.attach(path.resolve(this.dir, FileNames.logFromCe));
   }
 
   getCurrentLogLines = (): string => {
     return this.logFileMonitor.readCurrentLogLines();
   }
 
-  public createAkServerFile() {
-    const watchFile = path.resolve(this.dir, FileNames.serverWatching);
-    // Create the serverWatchingFile
+  public createServerIsRunningFile() {
+    const watchFile = path.resolve(this.dir, FileNames.serverIsRunning);
+    // Create the server-is-running marker file
     fs.closeSync(fs.openSync(watchFile, 'w'));
-    this.deleteFileOnExit(FileNames.serverWatching);
+    this.deleteFileOnExit(FileNames.serverIsRunning);
   }
 
   private deleteFileOnExit(fileName: string) {
@@ -219,7 +219,7 @@ export default class EepService implements CacheService {
   }
 
   queueCommand = (command: string) => {
-    const file = path.resolve(this.dir, FileNames.serverOutCommands);
+    const file = path.resolve(this.dir, FileNames.commandsToCe);
     try {
       if (this.debug) console.log('Queuing: ' + command);
       fs.appendFileSync(file, command + '\n', { encoding: 'latin1' });

apps/web-server/src/server/eep/service/FileNames.ts

@@ -1,10 +1,9 @@
 export enum FileNames {
-  // TODO: rename all of these files to remove the ak- prefix and may be find a good pattern for the direction (from-ce, to-ce)
-  eepOutJsonOut = 'ak-eep-out.json',
-  eepOutJsonOutFinished = 'ak-eep-out-json.isfinished',
-  eepOutLog = 'ak-eep-out.log',
-  serverOutCommands = 'ak-eep-in.commands',
-  serverWatching = 'ak-server.iswatching',
-  serverCache = 'ak-eep-web-server-state.json',
-  serverEventCounter = 'ak-eep-web-server-state.counter',
+  eventsFromCe = 'events-from-ce',
+  eventsFromCePending = 'events-from-ce.pending',
+  logFromCe = 'log-from-ce',
+  commandsToCe = 'commands-to-ce',
+  serverIsRunning = 'server-is-running',
+  serverCache = 'server-state.json',
+  serverEventCounter = 'server-state.counter',
 }

apps/web-server/src/server/eep/service/LogFileMonitor.test.ts

@@ -5,7 +5,7 @@ import * as path from 'node:path';
 import { setTimeout as delay } from 'node:timers/promises';
 import { LogFileMonitor } from './LogFileMonitor';
 
-const logFileName = 'ak-eep-out.log';
+const logFileName = 'log-from-ce';
 const resetMarker = '@@CE_LOG_RESET@@';
 
 async function waitFor(check: () => void, timeoutMs = 2000): Promise<void> {

docs/_anleitungen-installation/installation2-einrichten-von-eep-web.md

@@ -40,7 +40,7 @@ date: 2017-09-08
 
 3. **Einrichtung in Lua prüfen**
 
-   Prüfe in der EEP-Installation, ob die Datei `LUA\ce\databridge\exchange\ak-eep-out.json` geschrieben wird.
+   Prüfe in der EEP-Installation, ob die Datei `LUA\ce\databridge\exchange\events-from-ce` geschrieben wird.
 
    _Hinweis_: Diese Datei wird angelegt wenn die Anlage im 3D-Modus läuft.