fix init of global vars, make MapTile DTO more concise, and version bump

build.gradle.kts

@@ -8,7 +8,7 @@ plugins {
 }
 
 group = "dev.adamko.kafkatorio"
-version = "0.3.0"
+version = "0.3.2"
 
 val licenseFile: RegularFile by extra(layout.projectDirectory.file("LICENSE"))
 

modules/events-mod/src/main/typescript/control.ts

@@ -1,15 +1,44 @@
-import {handleConfigurationUpdate} from "./main/config-update/handleConfigurationUpdate";
+import {emitConfigurationUpdate} from "./main/config-update/handleConfigurationUpdate";
 import {emitPrototypes} from "./main/config-update/prototypes";
 import {Queue} from "./main/queue/queue";
 import {EventDataCache} from "./main/cache/EventDataCache";
 
 require("./main/events/registerHandlers")
 require("./main/commands/kafkatorioCommands")
+require("./main/cache/cacheChecker")
+
+script.on_configuration_changed((data: ConfigurationChangedData) => {
+  // runs whenever the version of the base game, or a mod, changes
+
+  reInitGlobal()
+  emitConfigurationUpdate(data)
+  emitPrototypes()
+})
 
-script.on_configuration_changed(handleConfigurationUpdate)
 
 script.on_init(() => {
-  Queue.reset()
+  // runs only once (when the mod is first added to the save)
-  emitPrototypes()
+  initGlobal()
-  EventDataCache.init()
 })
+
+
+function initGlobal() {
+  log("Initialising Kafkatorio Global variables...")
+
+  Queue.init()
+  EventDataCache.init()
+
+  log("Finished initialising Kafkatorio Global variables")
+}
+
+function reInitGlobal() {
+  log("Re-initialising Kafkatorio Global variables...")
+
+  global.MOD_VERSION = script.active_mods[script.mod_name]
+  global.FACTORIO_VERSION = script.active_mods["base"]
+
+  Queue.reset()
+  EventDataCache.reset()
+
+  log("Finished re-initialising Kafkatorio Global variables")
+}

modules/events-mod/src/main/typescript/generated/kafkatorio-schema/schema.d.ts

@@ -89,8 +89,9 @@ interface MapChunkPosition {
 }
 
 interface MapTile {
-  position: MapTilePosition;
+  proto: string;
-  prototypeName: string;
+  x: int;
+  y: int;
 }
 
 interface EntityIdentifiers {

modules/events-mod/src/main/typescript/main/cache/EventDataCache.ts

@@ -5,20 +5,20 @@ export namespace EventDataCache {
 
   declare const global: {
     cache: LuaTable<CacheKey<FactorioEventUpdateType>, CacheEntry<FactorioEventUpdateType>>,
-    DEFAULT_CACHE_DURATION_TICKS: LuaTable<FactorioEventUpdateType, uint>,
     DEFAULT_CACHE_DURATION_TICKS2: Record<FactorioEventUpdateType | "default", uint>,
-    MAP_CHUNK_CACHE_DURATION_TICKS: uint,
+  }
+
+
+  export function reset() {
+    log("Resetting EventDataCache")
+    global.cache = new LuaTable<CacheKey<FactorioEventUpdateType>, CacheEntry<FactorioEventUpdateType>>()
   }
 
 
   export function init() {
     if (typeof global.cache == undefined) {
-      global.cache = new LuaTable<CacheKey<FactorioEventUpdateType>, CacheEntry<FactorioEventUpdateType>>()
+      log("Initialising EventDataCache")
-
+      reset()
-      global.DEFAULT_CACHE_DURATION_TICKS = new LuaTable<FactorioEventUpdateType, uint>()
-      global.DEFAULT_CACHE_DURATION_TICKS.set("PLAYER", 30)         //  0.5 seconds
-      global.DEFAULT_CACHE_DURATION_TICKS.set("MAP_CHUNK", 60 * 15) // ~ 15 seconds
-      global.DEFAULT_CACHE_DURATION_TICKS.set("ENTITY", 60 * 2)     //   ~2 seconds
 
       global.DEFAULT_CACHE_DURATION_TICKS2 = {
         "PLAYER": 30, //  0.5 seconds

modules/events-mod/src/main/typescript/main/cache/cacheChecker.ts

@@ -6,16 +6,20 @@ script.on_nth_tick(6, (nthTick: NthTickEventData) => {
 
   const cachedEvents: Array<EventDataCache.CacheData<any>> = EventDataCache.extractExpired()
 
-  for (const event of cachedEvents) {
+  if (cachedEvents.length > 0) {
+    log(`nth tick ${nthTick.tick} has ${cachedEvents.length} events`)
 
-    const packet: FactorioEventUpdatePacket = {
+    for (const event of cachedEvents) {
-      tick: nthTick.tick,
+
-      modVersion: global.MOD_VERSION,
+      const packet: FactorioEventUpdatePacket = {
-      packetType: "UPDATE",
+        tick: nthTick.tick,
-      update: event,
+        modVersion: global.MOD_VERSION,
+        packetType: "UPDATE",
+        update: event,
+      }
+
+      emitPacket(packet)
     }
-
-    emitPacket(packet)
   }
 })
 

modules/events-mod/src/main/typescript/main/config-update/handleConfigurationUpdate.ts

@@ -1,10 +1,6 @@
 import {emitPacket} from "../emitKafkatorioPacket";
-import {updateGlobal} from "./updateGlobal";
-import {emitPrototypes} from "./prototypes";
-import {Queue} from "../queue/queue";
 
-export function handleConfigurationUpdate(changeData: ConfigurationChangedData) {
+export function emitConfigurationUpdate(changeData: ConfigurationChangedData) {
-  updateGlobal()
 
   emitPacket<FactorioConfigurationUpdate>({
     modVersion: global.MOD_VERSION,
@@ -13,8 +9,6 @@ export function handleConfigurationUpdate(changeData: ConfigurationChangedData)
     factorioData: factorioData(changeData)
   })
 
-  Queue.reset()
-  emitPrototypes()
 }
 
 function factorioData(changeData: ConfigurationChangedData): FactorioGameDataUpdate {

modules/events-mod/src/main/typescript/main/config-update/prototypes.ts

@@ -1,6 +1,6 @@
 import {Converters} from "../events/converters";
 import {emitPacket} from "../emitKafkatorioPacket";
-// import { global } from "../global";
+
 
 export function emitPrototypes() {
   emitPacket<FactorioPrototypes>({
@@ -20,7 +20,7 @@ function prototypes(): FactorioPrototype[] {
 
 function getMapTilePrototypes(): MapTilePrototype[] {
   let tiles: MapTilePrototype[] = []
-  for (let [, tile] of pairs(game.tile_prototypes)) {
+  for (let [, tile] of game.tile_prototypes) {
     tiles.push(
         <MapTilePrototype>{
           prototypeObjectName: tile.object_name,

modules/events-mod/src/main/typescript/main/config-update/updateGlobal.ts

@@ -1,4 +0,0 @@
-export function updateGlobal() {
-  global.MOD_VERSION = script.active_mods[script.mod_name]
-  global.FACTORIO_VERSION = script.active_mods["base"]
-}

modules/events-mod/src/main/typescript/main/events/converters.ts

@@ -99,8 +99,9 @@ export namespace Converters {
 
   export function convertTile(tile: LuaTile): MapTile {
     return {
-      position: mapTilePosition(tile.position),
+      x: tile.position.x,
-      prototypeName: tile.prototype.name,
+      y: tile.position.y,
+      proto: tile.prototype.name,
     }
   }
 

modules/events-mod/src/main/typescript/main/events/handlers.ts

@@ -92,8 +92,9 @@ export function handleTilesUpdate(
 
     let convertedTiles: MapTile[] = updatedTiles.map((it) => {
       return {
-        position: it.position, // TODO use converters for LuaTile
+        x: it.position.x,
-        prototypeName: newTileType.name,
+        y: it.position.y,
+        proto: newTileType.name
       }
     })
 

modules/events-mod/src/main/typescript/main/events/registerHandlers.ts

@@ -2,9 +2,8 @@ import {
   handleChunkUpdate,
   handleConsoleChat,
   handleEntityUpdate,
-  // handlePlayerUpdate,
   handleSurfaceUpdate,
-  handleTilesUpdate
+  // handleTilesUpdate
 } from "./handlers";
 import {Queue} from "../queue/queue";
 import {EventName} from "../types";
@@ -15,18 +14,6 @@ for (const [eventName, eventId] of pairs(defines.events)) {
   mapEventIdToName.set(eventId, eventName)
 }
 
-// const mapEventIdToDefinedType = new LuaTable<EventId<EventData>, EventId<EventData>>()
-// for (const [eventName, eventId] of pairs(defines.events)) {
-//   let definedType = defines.events[eventName]
-//   mapEventIdToDefinedType.set(eventId, definedType)
-// }
-
-// script.on_event(
-//     [defines.events.on_pre_build, defines.events.on_player_dropped_item],
-//     (e: OnPreBuildEvent | OnPlayerDroppedItemEvent) => {
-//       game.print("player " + e.player_index + " dropped item, tick:" + e.tick)
-//     }
-// );
 
 script.on_event(
     defines.events.on_player_mined_entity,
@@ -91,25 +78,25 @@ script.on_event(
     }
 )
 
-script.on_event(
+// script.on_event(
-    defines.events.on_chunk_generated,
+//     defines.events.on_chunk_generated,
-    (e: OnChunkGeneratedEvent) => {
+//     (e: OnChunkGeneratedEvent) => {
-      handleChunkUpdate(e.tick, mapEventIdToName.get(e.name), e.surface.index, e.position, e.area)
+//       handleChunkUpdate(e.tick, mapEventIdToName.get(e.name), e.surface.index, e.position, e.area)
-    }
+//     }
-)
+// )
-
+//
-script.on_event(
+// script.on_event(
-    [
+//     [
-      defines.events.on_player_built_tile,
+//       defines.events.on_player_built_tile,
-      defines.events.on_robot_built_tile,
+//       defines.events.on_robot_built_tile,
-    ],
+//     ],
-    (builtTilesEvent) => {
+//     (builtTilesEvent) => {
-      handleTilesUpdate(
+//       handleTilesUpdate(
-          builtTilesEvent.tick,
+//           builtTilesEvent.tick,
-          mapEventIdToName.get(builtTilesEvent.name),
+//           mapEventIdToName.get(builtTilesEvent.name),
-          builtTilesEvent.surface_index,
+//           builtTilesEvent.surface_index,
-          builtTilesEvent.tile,
+//           builtTilesEvent.tile,
-          builtTilesEvent.tiles,
+//           builtTilesEvent.tiles,
-      )
+//       )
-    }
+//     }
-)
+// )

modules/events-mod/src/main/typescript/package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "kafkatorio-events-mod",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "lockfileVersion": 1,
   "requires": true,
   "dependencies": {

modules/events-mod/src/main/typescript/package.json

@@ -1,6 +1,6 @@
 {
   "name": "kafkatorio-events-mod",
-  "version": "0.3.0",
+  "version": "0.3.2",
   "private": true,
   "scripts": {
     "build": "tstl",
@@ -9,7 +9,8 @@
   "engines": {
     "node": ">=10.13.0"
   },
-  "devDependencies": {},
+  "devDependencies": {
+  },
   "dependencies": {
     "lua-types": "^2.11.0",
     "@types/node": "^12.0.8",
@@ -18,7 +19,10 @@
     "typescript": "4.5.5"
   },
   "license": "UNLICENSED",
-  "peerDependencies": {},
+  "peerDependencies": {
-  "optionalDependencies": {},
+  },
-  "bundledDependencies": []
+  "optionalDependencies": {
+  },
+  "bundledDependencies": [
+  ]
 }

modules/events-mod/src/main/typescript/tsconfig.json

@@ -34,6 +34,6 @@
     "tstlVerbose": true,
     "noHeader": true,
     "noImplicitSelf": true,
-    "luaLibImport": "inline"
+    "luaLibImport": "require"
   }
 }

modules/events-schema/src/commonMain/kotlin/dev/adamko/kafkatorio/events/schema/factorioCommonData.kt

@@ -98,8 +98,9 @@ data class ColourHex(
 
 @Serializable
 data class MapTile(
-  val prototypeName: PrototypeName,
+  val x: Int,
-  val position: MapTilePosition,
+  val y: Int,
+  val proto: PrototypeName,
 )
 
 

modules/events-schema/src/commonMain/kotlin/dev/adamko/kafkatorio/events/schema/factorioPrototypes.kt

@@ -64,7 +64,7 @@ object FactorioPrototypeJsonSerializer : JsonContentPolymorphicSerializer<Factor
 
 @Serializable
 data class MapTilePrototype(
-  val name: String,
+  val name: PrototypeName,
   val layer: UInt,
   val mapColour: Colour,
 //  @Serializable(with = FactorioJsonListSerializer::class)

modules/events-schema/src/commonTest/kotlin/dev/adamko/kafkatorio/events/schema/FactorioEventTest.kt

@@ -209,32 +209,24 @@ class FactorioEventTest : FunSpec({
           "surfaceIndex": 1,
           "tiles": [
             {
-              "position": {
+              "y": 10,
-                "y": 10,
+              "x": -65,
-                "x": -65
+              "proto": "refined-concrete"
-              },
-              "prototypeName": "refined-concrete"
             },
             {
-              "position": {
+              "y": 11,
-                "y": 11,
+              "x": -65,
-                "x": -65
+              "proto": "red-earth"
-              },
-              "prototypeName": "red-earth"
             },
             {
-              "position": {
+              "y": 10,
-                "y": 10,
+              "x": -64,
-                "x": -64
+              "proto": "blue-cheese"
-              },
-              "prototypeName": "blue-cheese"
             },
             {
-              "position": {
+              "y": 11,
-                "y": 11,
+              "x": -64,
-                "x": -64
+              "proto": "refined-concrete"
-              },
-              "prototypeName": "refined-concrete"
             }
           ]
         },
@@ -254,20 +246,24 @@ class FactorioEventTest : FunSpec({
             surfaceIndex = SurfaceIndex(1u),
             tiles = listOf(
               MapTile(
-                prototypeName = PrototypeName("refined-concrete"),
+                proto = PrototypeName("refined-concrete"),
-                position = MapTilePosition(-65, 10)
+                x = -65,
+                y = 10,
               ),
               MapTile(
-                prototypeName = PrototypeName("red-earth"),
+                proto = PrototypeName("red-earth"),
-                position = MapTilePosition(-65, 11)
+                x = -65,
+                y = 11,
               ),
               MapTile(
-                prototypeName = PrototypeName("blue-cheese"),
+                proto = PrototypeName("blue-cheese"),
-                position = MapTilePosition(-64, 10)
+                x = -64,
+                y = 10,
               ),
               MapTile(
-                prototypeName = PrototypeName("refined-concrete"),
+                proto = PrototypeName("refined-concrete"),
-                position = MapTilePosition(-64, 11)
+                x = -64,
+                y = 11,
               ),
             )
           ),

modules/events-server/src/main/kotlin/dev/adamko/kafkatorio/processor/topology/groupMapChunks.kt

@@ -4,6 +4,7 @@ import dev.adamko.kafkatorio.events.schema.ColourHex
 import dev.adamko.kafkatorio.events.schema.FactorioEvent
 import dev.adamko.kafkatorio.events.schema.MapChunk
 import dev.adamko.kafkatorio.events.schema.MapChunkPosition
+import dev.adamko.kafkatorio.events.schema.MapTile
 import dev.adamko.kafkatorio.events.schema.MapTilePosition
 import dev.adamko.kafkatorio.events.schema.MapTiles
 import dev.adamko.kafkatorio.events.schema.SurfaceIndex
@@ -141,3 +142,6 @@ fun groupTilesIntoChunksWithColours(
   return colourisedChunkTable
 
 }
+
+val MapTile.position
+  get() = MapTilePosition(x, y)

modules/events-server/src/main/kotlin/dev/adamko/kafkatorio/processor/topology/prototypes.kt

@@ -17,19 +17,12 @@ import org.apache.kafka.streams.kstream.KStream
 import org.apache.kafka.streams.kstream.KTable
 
 
-@Serializable
-@JvmInline
-value class PrototypeName(val name: String) {
-  override fun toString() = name
-}
-
-
 /** Use the hashcode of Prototypes names as keys - more efficient storage */
 @JvmInline
 @Serializable
 value class TileProtoHashCode private constructor(val code: Int) {
   constructor(prototype: MapTilePrototype) : this(prototype.name.hashCode())
-  constructor(tile: MapTile) : this(tile.prototypeName.hashCode())
+  constructor(tile: MapTile) : this(tile.proto.hashCode())
 }
 
 

modules/infra-factorio-server/src/.env

@@ -1,4 +1,4 @@
 # Do not edit manually. This file was created with task 'dockerEnv'
 COMPOSE_PROJECT_NAME=kafkatorio
 FACTORIO_VERSION=1.1.53
-KAFKATORIO_VERSION=0.3.0
+KAFKATORIO_VERSION=0.3.2

modules/infra-kafka-cluster/src/.env

@@ -1,3 +1,3 @@
 # Do not edit manually. This file was created with task 'dockerEnv'
 COMPOSE_PROJECT_NAME=kafkatorio
-KAFKATORIO_VERSION=0.3.0
+KAFKATORIO_VERSION=0.3.2

modules/infra-kafka-pipe/src/.env

@@ -1,3 +1,3 @@
 # Do not edit manually. This file was created with task 'dockerEnv'
 COMPOSE_PROJECT_NAME=kafkatorio
-KAFKATORIO_VERSION=0.3.0
+KAFKATORIO_VERSION=0.3.2