Rewrite networking (#15)

Rewrite networking to use remotes instead of relying on value instances
seaofvoices · Nov 20, 2024 · 74f2686 · 74f2686
1 parent 9249479
commit 74f2686
Show file tree

Hide file tree

Showing 23 changed files with 557 additions and 547 deletions.
diff --git a/.darklua-bundle-dev.json b/.darklua-bundle-dev.json
@@ -5,7 +5,8 @@
       "sources": {
         "@pkg": "node_modules/.luau-aliases"
       }
-    }
+    },
+    "excludes": ["@lune/**"]
   },
   "rules": [
     "remove_types",

diff --git a/.darklua-bundle.json b/.darklua-bundle.json
@@ -5,7 +5,8 @@
       "sources": {
         "@pkg": "node_modules/.luau-aliases"
       }
-    }
+    },
+    "excludes": ["@lune/**"]
   },
   "rules": [
     "remove_types",

diff --git a/.darklua-dev.json b/.darklua-dev.json
@@ -1,7 +1,5 @@
 {
   "rules": [
-    "remove_comments",
-    "remove_spaces",
     {
       "rule": "convert_require",
       "current": {

diff --git a/.darklua-tests.json b/.darklua-tests.json
@@ -1,7 +1,5 @@
 {
   "rules": [
-    "remove_comments",
-    "remove_spaces",
     {
       "rule": "convert_require",
       "current": {

diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml
@@ -36,7 +36,7 @@ jobs:
         run: yarn run prepare
 
       - name: Run linter
-        run: yarn run lint:selene
+        run: yarn run lint
 
       - name: Verify code style
         run: yarn run style-check

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,8 @@
 
 ## Unreleased Changes
 
+- rewrite data syncing logic ([#15](https://github.com/seaofvoices/crosswalk-channels/pull/15))
+
 ## 0.1.3
 
 - fix data sync issues with arrays ([#11](https://github.com/seaofvoices/crosswalk-channels/pull/11))

diff --git a/foreman.toml b/foreman.toml
@@ -1,7 +1,7 @@
 [tools]
-rojo = { github = "rojo-rbx/rojo", version = "=7.4.1"}
+rojo = { github = "rojo-rbx/rojo", version = "=7.4.4"}
 selene = { github = "Kampfkarren/selene", version = "=0.27.1"}
 stylua = { github = "JohnnyMorganz/StyLua", version = "=0.20.0"}
-darklua = { github = "seaofvoices/darklua", version = "=0.13.0"}
-luau-lsp = { github = "JohnnyMorganz/luau-lsp", version = "=1.29.0"}
+darklua = { github = "seaofvoices/darklua", version = "=0.14.0"}
+luau-lsp = { github = "JohnnyMorganz/luau-lsp", version = "=1.35.0"}
 run-in-roblox = { github = "rojo-rbx/run-in-roblox", version = "=0.3.0" }
diff --git a/model.project.json b/model.project.json
@@ -3,9 +3,12 @@
   "tree": {
     "$path": "./channels.lua",
     "impl": {
-      "$path": "./src",
-      "__modules__": {
-        "$path": "./node_modules"
+      "$className": "Folder",
+      "src": {
+        "$path": "src"
+      },
+      "node_modules": {
+        "$path": "node_modules"
       }
     }
   }

diff --git a/scripts/analyze.sh b/scripts/analyze.sh
@@ -9,5 +9,6 @@ if [ ! -f "$TYPES_FILE" ]; then
 fi
 
 luau-lsp analyze --base-luaurc=.luaurc --settings=.luau-analyze.json \
+    --ignore '**/node_modules/**' --ignore 'node_modules/**' \
     --definitions=$TYPES_FILE \
     src
diff --git a/scripts/build-roblox-model.sh b/scripts/build-roblox-model.sh
@@ -5,13 +5,8 @@ set -e
 DARKLUA_CONFIG=$1
 BUILD_OUTPUT=$2
 
-if [ ! -d node_modules ]; then
-    rm -rf temp
-    yarn install
-fi
-if [ ! -d node_modules/.luau-aliases ]; then
-    yarn run prepare
-fi
+yarn workspaces focus --production
+yarn dlx npmluau
 
 rm -rf temp
 mkdir -p temp

diff --git a/src/__tests__/Channels.test.lua b/src/__tests__/Channels.test.lua
@@ -7,26 +7,19 @@ local afterEach = jestGlobals.afterEach
 local beforeEach = jestGlobals.beforeEach
 
 local ChannelsBuilder = require('..')
-
-local function mockInstance<T>(tableValue, fallbackInstance): T
-    return setmetatable(tableValue, {
-        __index = function(_, index)
-            local result = (fallbackInstance :: any)[index]
-            if type(result) == 'function' then
-                return function(_self, ...)
-                    return result(fallbackInstance, ...)
-                end
-            else
-                return result
-            end
+local Constants = require('../impl/Constants')
+local mockInstance = require('./mockInstance')
+
+local function mockEvent()
+    local bindable = Instance.new('BindableEvent')
+    return mockInstance({
+        Fire = function(_self, ...)
+            bindable:Fire(...)
         end,
-        __newindex = function(_, index, value)
-            fallbackInstance[index] = value
-        end,
-    }) :: any
+    }, bindable.Event)
 end
 
-local function mockServices()
+local function mockServices(remote, unreliableRemote)
     local playerGuiMock = Instance.new('Folder')
     playerGuiMock.Name = 'PlayerGui'
     local playerInstanceMock = Instance.new('Folder')
@@ -42,8 +35,24 @@ local function mockServices()
     playerGuiMock.Parent = playerInstanceMock
     playerInstanceMock.Parent = players
     return {
-        ReplicatedStorage = Instance.new('Folder') :: Instance,
-        Players = mockInstance({ LocalPlayer = player }, players),
+        ReplicatedStorage = mockInstance({
+            WaitForChild = function(_self, name)
+                if name == Constants.EventName then
+                    return remote
+                elseif name == Constants.FastEventName then
+                    return unreliableRemote
+                end
+                error(`unable to find child {name}`)
+            end,
+        }, Instance.new('Folder')),
+        Players = mockInstance({
+            LocalPlayer = player,
+            PlayerAdded = mockEvent(),
+            PlayerRemoving = mockEvent(),
+            GetPlayers = function()
+                return { player }
+            end,
+        }, players),
     }
 end
 
@@ -108,12 +117,34 @@ for caseName, value in valueCases do
                 local services
                 local serverChannels
                 local clientChannels
+                local flushSignal
+                local remoteMock
+                local unreliableRemoteMock
 
                 local channelName = 'one'
 
                 beforeEach(function()
-                    services = mockServices()
+                    flushSignal = mockEvent()
+                    local newRemoteMock = {
+                        FireClient = jest.fn(function(self, _player, ...)
+                            self.OnClientEvent:Fire(...)
+                        end),
+                        OnClientEvent = mockEvent(),
+                    }
+                    local newUnreliableRemoteMock = {
+                        FireClient = jest.fn(function(self, ...)
+                            self.OnClientEvent:Fire(...)
+                        end),
+                        OnClientEvent = mockEvent(),
+                    }
+                    unreliableRemoteMock = newUnreliableRemoteMock
+                    remoteMock = newRemoteMock
+                    services = mockServices(remoteMock, unreliableRemoteMock)
                     serverChannels = ChannelsBuilder({}, services, true)
+                    serverChannels.configure({
+                        flushSignal = flushSignal,
+                        remote = remoteMock,
+                    })
                     clientChannels = ChannelsBuilder({}, services, false)
                 end)
 
@@ -135,13 +166,14 @@ for caseName, value in valueCases do
                     it(
                         'sends the value, initializes the player, bind to channel and the value is received',
                         function()
-                            serverChannels.Init()
+                            serverChannels.Start()
                             serverChannels.Send(channelName, value)
-                            clientChannels.Init()
+                            clientChannels.Start()
 
                             local fn, fnFunction = jest.fn()
                             teardown = bindToChannel(channelName, fnFunction)
 
+                            flushSignal:Fire(0.02)
                             task.wait()
 
                             expect(fn).toHaveBeenCalledTimes(1)
@@ -152,14 +184,15 @@ for caseName, value in valueCases do
                     it(
                         'initializes the player, bind to channel, sends the value and the value is received',
                         function()
-                            serverChannels.Init()
-                            clientChannels.Init()
+                            serverChannels.Start()
+                            clientChannels.Start()
 
                             local fn, fnFunction = jest.fn()
                             teardown = bindToChannel(channelName, fnFunction)
 
                             serverChannels.Send(channelName, value)
 
+                            flushSignal:Fire(0.02)
                             task.wait()
 
                             expect(fn).toHaveBeenCalledTimes(1)
@@ -170,14 +203,15 @@ for caseName, value in valueCases do
                     it(
                         'initializes the player, sends the value, bind to channel, and the value is received',
                         function()
-                            serverChannels.Init()
-                            clientChannels.Init()
+                            serverChannels.Start()
+                            clientChannels.Start()
 
                             serverChannels.Send(channelName, value)
                             local fn, fnFunction = jest.fn()
 
                             teardown = bindToChannel(channelName, fnFunction)
 
+                            flushSignal:Fire(0.02)
                             task.wait()
 
                             expect(fn).toHaveBeenCalledTimes(1)
@@ -207,17 +241,18 @@ for caseName, value in valueCases do
                     it(
                         'sends the value, initializes the player, bind to channel and the value is received',
                         function()
-                            serverChannels.Init()
+                            serverChannels.Start()
                             serverChannels.SendLocal(
                                 services.Players.LocalPlayer,
                                 channelName,
                                 value
                             )
-                            clientChannels.Init()
+                            clientChannels.Start()
 
                             local fn, fnFunction = jest.fn()
                             teardown = bindToChannel(channelName, fnFunction)
 
+                            flushSignal:Fire(0.02)
                             task.wait()
 
                             expect(fn).toHaveBeenCalledTimes(1)
@@ -228,8 +263,8 @@ for caseName, value in valueCases do
                     it(
                         'initializes the player, bind to channel, sends the value and the value is received',
                         function()
-                            serverChannels.Init()
-                            clientChannels.Init()
+                            serverChannels.Start()
+                            clientChannels.Start()
 
                             local fn, fnFunction = jest.fn()
                             teardown = bindToChannel(channelName, fnFunction)
@@ -239,6 +274,7 @@ for caseName, value in valueCases do
                                 channelName,
                                 value
                             )
+                            flushSignal:Fire(0.02)
 
                             task.wait()
 
@@ -250,14 +286,16 @@ for caseName, value in valueCases do
                     it(
                         'initializes the player, sends the value, bind to channel, and the value is received',
                         function()
-                            serverChannels.Init()
-                            clientChannels.Init()
+                            serverChannels.Start()
+                            clientChannels.Start()
 
                             serverChannels.SendLocal(
                                 services.Players.LocalPlayer,
                                 channelName,
                                 value
                             )
+                            flushSignal:Fire(0.02)
+
                             local fn, fnFunction = jest.fn()
 
                             teardown = bindToChannel(channelName, fnFunction)

diff --git a/src/__tests__/mockInstance.lua b/src/__tests__/mockInstance.lua
@@ -0,0 +1,27 @@
+local jestGlobals = require('@pkg/@jsdotlua/jest-globals')
+
+local jest = jestGlobals.jest
+
+local function mockInstance<T>(tableValue, fallbackInstance): T
+    return setmetatable(tableValue, {
+        __index = function(_, index)
+            local result = (fallbackInstance :: any)[index]
+
+            if type(result) == 'function' then
+                local mockInstance = jest.fn(function(_self, ...)
+                    return result(fallbackInstance, ...)
+                end)
+                rawset(tableValue, index, mockInstance)
+
+                return mockInstance
+            else
+                return result
+            end
+        end,
+        __newindex = function(_, index, value)
+            fallbackInstance[index] = value
+        end,
+    }) :: any
+end
+
+return mockInstance