Skip to content

[REG-2222] Support creating and editing segments through the dashboard app #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
abeizer wants to merge 3 commits into from
Closed

[REG-2222] Support creating and editing segments through the dashboard app #376

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
92bf1c8
create, edit, delete segment. message frame fix
abeizer Dec 19, 2024
748f208
segment crud
abeizer Dec 20, 2024
8b38fda
overhaul tcp message decode
abeizer Dec 20, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 76 additions & 6 deletions src/gg.regression.unity.bots/Runtime/Scripts/ClientDashboard/RGTcpManager.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
using System;
using System.Collections.Generic;
using System.Diagnostics;
using System.IO;
Expand Down Expand Up @@ -236,6 +237,32 @@ private static void ProcessClientMessage(TcpClient client, TcpMessage message)
m_shouldStopReplay = true;
break;
}
case TcpMessageType.RequestSequenceJson:
{
var payload = (RequestResourceContentsTcpMessageData) message.payload;
SendSequenceJson(payload.resourcePath, client);
break;
}
case TcpMessageType.RequestSegmentJson:
{
var payload = (RequestResourceContentsTcpMessageData) message.payload;
SendSegmentJson(payload.resourcePath, client);
break;
}
case TcpMessageType.SaveSegment:
{
var payload = (SaveSegmentListTcpMessageData) message.payload;
BotSegment.SaveSegmentListAsJson(payload.segmentList, payload.resourcePath);
ProcessAndSendSegments();
break;
}
case TcpMessageType.DeleteSegment:
{
var payload = (DeleteSegmentTcpMessageData) message.payload;
BotSegment.Delete(payload.resourcePath);
ProcessAndSendSegments();
break;
}
}
}

Expand All @@ -253,12 +280,6 @@ private static void ProcessAndSendSequences(IDictionary<string, (string, BotSequ
SendAvailableSequences();
}

private static void ProcessAndSendSegments()
{
m_availableBotSegments = BotSegment.LoadAllSegments().Values.Select(seg => seg.Item2).ToList();
SendAvailableSegments();
}

/// <summary>
/// Returns the active bot sequence, if there is one
/// </summary>
Expand Down Expand Up @@ -298,6 +319,16 @@ private static ActiveSequence GetActiveBotSequence()

#endregion

#region Bot Segments

private static void ProcessAndSendSegments()
{
m_availableBotSegments = BotSegment.LoadAllSegments().Values.Select(seg => seg.Item2).ToList();
SendAvailableSegments();
}

#endregion

#region Send Messages

private static void SendAvailableSequences([CanBeNull] TcpClient client = null)
Expand Down Expand Up @@ -339,6 +370,45 @@ private static void SendActiveSequence([CanBeNull] TcpClient client = null)
RGTcpServer.QueueMessage(message, client);
}

private static void SendSequenceJson(string resourcePath, TcpClient client)
{
var botSequenceJson = BotSequence.LoadJsonResource(resourcePath).Item3;
var message = new TcpMessage
{
type = TcpMessageType.SendSequenceJson,
payload = new SendJsonTcpMessageData
{
jsonContent = botSequenceJson
}
};
RGTcpServer.QueueMessage(message, client);
}

private static void SendSegmentJson(string resourcePath, TcpClient client)
{
var botSegment = BotSequence.LoadBotSegmentOrBotSegmentListFromPath(resourcePath);

var jsonContent = "";
if (botSegment.Item3 is BotSegment segment)
{
jsonContent = segment.ToJsonString();
}
else if (botSegment.Item3 is BotSegmentList segmentList)
{
jsonContent = segmentList.ToJsonString();
}

var message = new TcpMessage
{
type = TcpMessageType.SendSegmentJson,
payload = new SendJsonTcpMessageData
{
jsonContent = jsonContent,
}
};
RGTcpServer.QueueMessage(message, client);
}

#endregion
}
}
Expand Down
175 changes: 114 additions & 61 deletions src/gg.regression.unity.bots/Runtime/Scripts/ClientDashboard/RGTcpServer.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
using System;
using System.Collections.Concurrent;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Net;
using System.Net.Sockets;
using System.Text;
Expand All @@ -8,6 +11,7 @@
using JetBrains.Annotations;
using Newtonsoft.Json;
using RegressionGames.StateRecorder;
using UnityEngine;

namespace RegressionGames.ClientDashboard
{
Expand Down Expand Up @@ -310,72 +314,120 @@ private static void SendMessage(TcpClient client, TcpMessage message)

/// <summary>
/// Decode message from client so we can process it
/// https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_servers#exchanging_data_frames
/// https://developer.mozilla.org/en-US/docs/Web/API/WebSockets_API/Writing_WebSocket_server#decoding_messages
/// </summary>
private static string DecodeReceivedMessage(TcpClient client)
{
byte[] bytes = new byte[client.Available];
client.GetStream().Read(bytes, 0, bytes.Length);

// whether the full message has been sent from the client
// currently not used here, but may need to consider partial frames
// if we end up accepting large messages from client
bool fin = (bytes[0] & 0b10000000) != 0;

// must be true, "All messages from the client to the server have this bit set"
bool mask = (bytes[1] & 0b10000000) != 0;
int opcode = bytes[0] & 0b00001111;
var clientStream = client.GetStream();
var decodedBytes = new List<byte>();

if (opcode == 8)
while (client.Connected)
{
// this is a close frame
if (m_connectedClients.TryGetValue(client, out var clientActions))
if (client.Available == 0)
{
clientActions.ShouldClose = true;
// we check this condition before calling this method,
// but we may be waiting on a continuation frame here
continue;
}
return null;
}

if (opcode != 1)
{
// not a text message
return null;
}

ulong offset = 2;
ulong msglen = bytes[1] & (ulong)0b01111111;

// read the first byte of the message
// bit 0 -> fin, whether the full message has been received
// bit 1-3 -> reserved, we don't care about this right now
// bit 4-7 -> opcode, the type of message
var firstByte = (byte)clientStream.ReadByte();
bool fin = (firstByte & 0b10000000) != 0;
int frameOpcode = firstByte & 0b00001111;

switch (frameOpcode)
{
case 0x0: // Continuation Frame
case 0x1: // Text
case 0x2: // Binary
break;
case 0x8: // Connection close
{
if (m_connectedClients.TryGetValue(client, out var clientActions))
{
clientActions.ShouldClose = true;
}
return null;
}
default: // Ping/Pong/Reserved
continue;
}

// read the second byte of the message
// bit 0 -> mask, should be true for client > server messages
// bit 1-7 -> payload length
var secondByte = (byte)clientStream.ReadByte();
bool mask = (secondByte & 0b10000000) != 0;
var psuedoLength = secondByte - 128;

if (msglen == 126)
{
// bytes are reversed because websocket will print them in Big-Endian, whereas
// BitConverter will want them arranged in little-endian on windows
msglen = BitConverter.ToUInt16(new byte[] { bytes[3], bytes[2] }, 0);
offset = 4;
}
else if (msglen == 127)
{
// To test the below code, we need to manually buffer larger messages — since the NIC's autobuffering
// may be too latency-friendly for this code to run (that is, we may have only some of the bytes in this
// websocket frame available through client.Available).
msglen = BitConverter.ToUInt64(new byte[] {
bytes[9], bytes[8], bytes[7], bytes[6], bytes[5], bytes[4], bytes[3], bytes[2]
}, 0);
offset = 10;
}
// to get the actual length of the payload, we need to interpret the psuedo length from the header
int payloadLength = 0;

if (msglen > 0 && mask)
{
byte[] decoded = new byte[msglen];
byte[] masks = new byte[4] { bytes[offset], bytes[offset + 1], bytes[offset + 2], bytes[offset + 3] };
offset += 4;
if (psuedoLength > 0 && psuedoLength <= 125)
{
// if length doesn't exceed 125,
// then this is the actual length of the payload
payloadLength = psuedoLength;
}
else if (psuedoLength == 126)
{
// Actual length will be the next 2 bytes
var lengthBytes = new byte[2];
clientStream.Read(lengthBytes, 0, lengthBytes.Length);

// bytes are reversed because websocket will print them in Big-Endian, whereas
// BitConverter will want them arranged in little-endian on windows
payloadLength = BitConverter.ToUInt16(new byte[] { lengthBytes[1], lengthBytes[0] }, 0);
}
else if (psuedoLength == 127)
{
// Actual length will be the next 8 bytes
var lengthBytes = new byte[8];
clientStream.Read(lengthBytes, 0, lengthBytes.Length);

// bytes are reversed because websocket will print them in Big-Endian, whereas
// BitConverter will want them arranged in little-endian on windows
payloadLength = (int)BitConverter.ToUInt64(new byte[] {
lengthBytes[7], lengthBytes[6], lengthBytes[5], lengthBytes[4],
lengthBytes[3], lengthBytes[2], lengthBytes[1], lengthBytes[0]
}, 0);
}

for (ulong i = 0; i < msglen; ++i)
// for now we're assuming client-sent messages are masked
// determine the masking key from the next 4 bytes
// this will be used to decode the message
var maskingKey = new byte[4];
clientStream.Read(maskingKey, 0, maskingKey.Length);

if (payloadLength == 0)
{
// no payload, so we're done
return null;
}

// read the payload
// and decode it using the masking key
var payload = new byte[payloadLength];
clientStream.Read(payload, 0, payloadLength);

for (int i = 0; i < payload.Length; ++i)
{
decoded[i] = (byte)(bytes[offset + i] ^ masks[i % 4]);
decodedBytes.Add((byte)(payload[i] ^ maskingKey[i % 4]));
}

string decodedMessage = Encoding.UTF8.GetString(decoded);
return decodedMessage;
if (!fin)
{
// if this isn't the complete message,
// then we need to wait for the continuation frame
continue;
}

// we have the full message, so return it as a string
return Encoding.UTF8.GetString(decodedBytes.ToArray());
}

return null;
Expand Down Expand Up @@ -408,15 +460,16 @@ private static byte[] EncodeMessageToSend(string message)
}
else
{
frame[1] = (byte)127;
frame[2] = (byte)((length >> 56) & 255);
frame[3] = (byte)((length >> 48) & 255);
frame[4] = (byte)((length >> 40) & 255);
frame[5] = (byte)((length >> 32) & 255);
frame[6] = (byte)((length >> 24) & 255);
frame[7] = (byte)((length >> 16) & 255);
frame[8] = (byte)((length >> 8) & 255);
frame[9] = (byte)(length & 255);
var lengthAsULong = Convert.ToUInt64(length);
frame[1] = 127;
frame[2] = (byte)((lengthAsULong >> 56) & 255);
frame[3] = (byte)((lengthAsULong >> 48) & 255);
frame[4] = (byte)((lengthAsULong >> 40) & 255);
frame[5] = (byte)((lengthAsULong >> 32) & 255);
frame[6] = (byte)((lengthAsULong >> 24) & 255);
frame[7] = (byte)((lengthAsULong >> 16) & 255);
frame[8] = (byte)((lengthAsULong >> 8) & 255);
frame[9] = (byte)(lengthAsULong & 255);
indexStartRawData = 10;
}

Expand Down
Loading
Loading