Add simple plugin system, move events to plugin package

Author: CodeDoctorDE

plugin/lib/src/event.dart

@@ -4,34 +4,18 @@ import 'package:dart_mappable/dart_mappable.dart';
 import 'package:networker/networker.dart';
 import 'package:setonix_api/setonix_api.dart';
 
-import '../server.dart';
-
 part 'model.mapper.dart';
 
-mixin ServerReference {
-  SetonixServer get server;
-
-  void sendEvent(ServerWorldEvent event, [Channel target = kAnyChannel]) =>
-      server.sendEvent(event, target);
-
-  WorldState get state => server.state;
-
-  GameTable? getTable(String name) => state.getTable(name);
-  GameTable getTableOrDefault(String name) => state.getTableOrDefault(name);
-}
-
-base class Event<T> with ServerReference {
-  @override
-  final SetonixServer server;
+base class Event<T> {
   final T clientEvent;
   final Channel source;
   ServerWorldEvent serverEvent;
   Channel target;
   bool cancelled = false;
   Set<Channel>? needsUpdate;
 
-  Event(this.server, this.serverEvent, this.target, this.clientEvent,
-      this.source, this.needsUpdate);
+  Event(this.serverEvent, this.target, this.clientEvent, this.source,
+      this.needsUpdate);
 
   Event<C> castEvent<C extends WorldEvent>() {
     return _LinkedEvent<C>(this);
@@ -44,9 +28,7 @@ base class Event<T> with ServerReference {
 }
 
 // Allows casting an event to another
-final class _LinkedEvent<T extends WorldEvent?>
-    with ServerReference
-    implements Event<T> {
+final class _LinkedEvent<T extends WorldEvent?> implements Event<T> {
   final Event parent;
 
   _LinkedEvent(this.parent);
@@ -75,9 +57,6 @@ final class _LinkedEvent<T extends WorldEvent?>
   @override
   T get clientEvent => parent.clientEvent as T;
 
-  @override
-  SetonixServer get server => parent.server;
-
   @override
   Channel get source => parent.source;
 
@@ -98,14 +77,11 @@ final class ServerPing {
   });
 }
 
-final class UserLeaveCallback with ServerReference {
-  @override
-  final SetonixServer server;
+final class UserLeaveCallback {
   final Channel channel;
   final ConnectionInfo info;
 
   UserLeaveCallback({
-    required this.server,
     required this.channel,
     required this.info,
   });

server/lib/src/events/model.dart renamed to plugin/lib/src/events/model.dart

@@ -1,7 +1,9 @@
 import 'dart:async';
 import 'dart:io';
 
-import 'package:setonix_server/setonix_server.dart';
+import 'package:networker/networker.dart';
+import 'package:setonix_api/setonix_api.dart';
+import 'package:setonix_plugin/src/events/model.dart';
 
 final class EventSystem {
   final StreamController<Event> _controller =
@@ -36,10 +38,8 @@ final class EventSystem {
     return ping.response;
   }
 
-  void runLeaveCallback(
-      SetonixServer server, Channel channel, ConnectionInfo info) {
-    final callback =
-        UserLeaveCallback(server: server, channel: channel, info: info);
+  void runLeaveCallback(Channel channel, ConnectionInfo info) {
+    final callback = UserLeaveCallback(channel: channel, info: info);
     _leaveController.add(callback);
   }
 

server/lib/src/events/model.mapper.dart renamed to plugin/lib/src/events/model.mapper.dart

@@ -0,0 +1,76 @@
+import 'dart:async';
+
+import 'package:networker/networker.dart';
+import 'package:setonix_api/event.dart';
+import 'package:setonix_plugin/src/events/system.dart';
+
+typedef PluginProcessCallback = void Function(String, WorldEvent, [bool force]);
+typedef PluginSendEventCallback = void Function(
+    String, NetworkerPacket<PlayableWorldEvent>);
+
+final class PluginSystem {
+  final Map<String, SetonixPlugin> _plugins = {};
+  final PluginProcessCallback _onProcess;
+  final PluginSendEventCallback _onSendEvent;
+
+  PluginSystem(
+      {required PluginProcessCallback onProcess,
+      required PluginSendEventCallback onSendEvent})
+      : _onProcess = onProcess,
+        _onSendEvent = onSendEvent;
+
+  SetonixPlugin registerPlugin(String name) {
+    final plugin = SetonixPlugin._();
+    _register(name, plugin);
+    return plugin;
+  }
+
+  void _register(String name, SetonixPlugin plugin) {
+    _plugins[name] = plugin;
+    plugin.onProcess
+        .listen((message) => _onProcess(name, message.event, message.force));
+    plugin.onSendEvent.listen((event) => _onSendEvent(name, event));
+  }
+
+  void unregisterPlugin(String name) {
+    _plugins.remove(name)?.dispose();
+  }
+
+  void dispose() {
+    _plugins.values.forEach((plugin) => plugin.dispose());
+    _plugins.clear();
+  }
+}
+
+final class ProcessMessage {
+  final WorldEvent event;
+  final bool force;
+
+  ProcessMessage(this.event, this.force);
+}
+
+final class SetonixPlugin {
+  final EventSystem eventSystem = EventSystem();
+  final StreamController<ProcessMessage> _onProcessController =
+      StreamController.broadcast();
+  final StreamController<NetworkerPacket<PlayableWorldEvent>>
+      _onSendEventController = StreamController.broadcast();
+
+  SetonixPlugin._();
+
+  Stream<ProcessMessage> get onProcess => _onProcessController.stream;
+  Stream<NetworkerPacket<PlayableWorldEvent>> get onSendEvent =>
+      _onSendEventController.stream;
+
+  void process(WorldEvent event, {bool force = false}) =>
+      _onProcessController.add(ProcessMessage(event, force));
+
+  void sendEvent(PlayableWorldEvent event, [Channel target = kAnyChannel]) =>
+      _onSendEventController.add(NetworkerPacket(event, target));
+
+  void dispose() {
+    eventSystem.dispose();
+    _onProcessController.close();
+    _onSendEventController.close();
+  }
+}

server/lib/src/events/system.dart renamed to plugin/lib/src/events/system.dart

@@ -17,6 +17,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "6.4.1"
+  archive:
+    dependency: transitive
+    description:
+      name: archive
+      sha256: "6199c74e3db4fbfbd04f66d739e72fe11c8a8957d5f219f1f4482dbde6420b5a"
+      url: "https://pub.dev"
+    source: hosted
+    version: "4.0.2"
   args:
     dependency: transitive
     description:
@@ -157,10 +165,27 @@ packages:
     dependency: transitive
     description:
       name: crypto
-      sha256: ff625774173754681d66daaf4a448684fb04b78f902da9cb3d308c19cc5e8bab
+      sha256: "1e445881f28f22d6140f181e07737b22f1e099a5e1ff94b0af2f9e4a463f4855"
+      url: "https://pub.dev"
+    source: hosted
+    version: "3.0.6"
+  dart_leap:
+    dependency: transitive
+    description:
+      path: "packages/dart_leap"
+      ref: db69a03082e6811c58dc2d0e5c23d04305e1623f
+      resolved-ref: db69a03082e6811c58dc2d0e5c23d04305e1623f
+      url: "https://github.com/LinwoodDev/dart_pkgs.git"
+    source: git
+    version: "1.0.0"
+  dart_mappable:
+    dependency: transitive
+    description:
+      name: dart_mappable
+      sha256: f69a961ae8589724ebb542e588f228ae844c5f78028899cbe2cc718977c1b382
       url: "https://pub.dev"
     source: hosted
-    version: "3.0.3"
+    version: "4.3.0"
   dart_style:
     dependency: transitive
     description:
@@ -297,6 +322,15 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.2.0"
+  lw_file_system_api:
+    dependency: transitive
+    description:
+      path: "packages/lw_file_system_api"
+      ref: e4c17cb5e3a53c0cd02d4127458c2215f7c6e7d4
+      resolved-ref: e4c17cb5e3a53c0cd02d4127458c2215f7c6e7d4
+      url: "https://github.com/LinwoodDev/dart_pkgs.git"
+    source: git
+    version: "1.0.0"
   matcher:
     dependency: transitive
     description:
@@ -306,7 +340,7 @@ packages:
     source: hosted
     version: "0.12.16+1"
   meta:
-    dependency: transitive
+    dependency: "direct main"
     description:
       name: meta
       sha256: e3641ec5d63ebf0d9b41bd43201a66e3fc79a65db5f61fc181f04cd27aab950c
@@ -321,6 +355,15 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.4"
+  networker:
+    dependency: "direct main"
+    description:
+      path: "packages/networker/networker"
+      ref: "0bdc62d3af7f31e19a694d9cd39fe020dced8754"
+      resolved-ref: "0bdc62d3af7f31e19a694d9cd39fe020dced8754"
+      url: "https://github.com/LinwoodDev/dart_pkgs.git"
+    source: git
+    version: "1.0.0"
   package_config:
     dependency: transitive
     description:
@@ -345,6 +388,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.5.1"
+  posix:
+    dependency: transitive
+    description:
+      name: posix
+      sha256: a0117dc2167805aa9125b82eee515cc891819bac2f538c83646d355b16f58b9a
+      url: "https://pub.dev"
+    source: hosted
+    version: "6.0.1"
   pub_semver:
     dependency: transitive
     description:
@@ -369,6 +420,13 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "3.2.1"
+  setonix_api:
+    dependency: "direct main"
+    description:
+      path: "../api"
+      relative: true
+    source: path
+    version: "0.2.0"
   shelf:
     dependency: transitive
     description:
@@ -457,6 +515,14 @@ packages:
       url: "https://pub.dev"
     source: hosted
     version: "1.0.1"
+  type_plus:
+    dependency: transitive
+    description:
+      name: type_plus
+      sha256: d5d1019471f0d38b91603adb9b5fd4ce7ab903c879d2fbf1a3f80a630a03fcc9
+      url: "https://pub.dev"
+    source: hosted
+    version: "2.1.1"
   typed_data:
     dependency: transitive
     description:
@@ -506,4 +572,4 @@ packages:
     source: hosted
     version: "2.1.1"
 sdks:
-  dart: ">=3.4.0 <4.0.0"
+  dart: ">=3.5.1 <4.0.0"

plugin/lib/src/plugin.dart

@@ -9,6 +9,14 @@ dependencies:
   js: ^0.6.5
   collection: ^1.16.0
   freezed_annotation: ^2.2.0
+  setonix_api:
+    path: ../api
+  networker:
+    git:
+      url: https://github.com/LinwoodDev/dart_pkgs.git
+      ref: 0bdc62d3af7f31e19a694d9cd39fe020dced8754
+      path: packages/networker/networker
+  meta: ^1.16.0
 dev_dependencies:
   build_runner: ^2.4.4
   freezed: ^2.1.0+1

plugin/pubspec.lock

@@ -2,9 +2,8 @@
 library;
 
 export 'package:setonix_api/setonix_api.dart';
+export 'package:setonix_plugin/setonix_plugin.dart';
 export 'src/asset.dart';
-export 'src/events/model.dart';
-export 'src/events/system.dart';
 export 'src/main.dart';
 export 'src/server.dart';
 export 'src/programs/kick.dart';

plugin/pubspec.yaml

@@ -9,16 +9,14 @@ import 'package:networker/networker.dart';
 import 'package:networker_socket/server.dart';
 import 'package:setonix_api/setonix_api.dart';
 import 'package:setonix_server/src/asset.dart';
-import 'package:setonix_server/src/events/system.dart';
+import 'package:setonix_plugin/src/events/system.dart';
 import 'package:setonix_server/src/programs/packs.dart';
 import 'package:setonix_server/src/programs/players.dart';
 import 'package:setonix_server/src/programs/save.dart';
 import 'package:setonix_server/src/programs/say.dart';
 import 'package:setonix_server/src/programs/stop.dart';
 import 'package:setonix_plugin/setonix_plugin.dart';
 
-import 'events/model.dart';
-
 Future<ServerProcessed> _computeEvent(ServerWorldEvent event, WorldState state,
     List<SignatureMetadata> signature) {
   return Isolate.run(