Merge pull request #122 from Raiden1411/websocket

feat: implement custom websocket client

Author: Raiden1411

build.zig

@@ -312,10 +312,8 @@ fn addDependencies(
         .target = target,
         .optimize = optimize,
     });
-    const ws = b.dependency("ws", .{ .target = target, .optimize = optimize });
 
     mod.addImport("c-kzg-4844", c_kzg_4844_dep.module("c-kzg-4844"));
-    mod.addImport("ws", ws.module("websocket"));
     mod.linkLibrary(c_kzg_4844_dep.artifact("c-kzg-4844"));
 }
 /// Builds and runs the benchmarks

build.zig.zon

@@ -2,7 +2,7 @@
     .name = "zabi",
     // This is a [Semantic Version](https://semver.org/).
     // In a future version of Zig it will be used for package deduplication.
-    .version = "0.15.1",
+    .version = "0.15.4",
 
     // This field is optional.
     // This is currently advisory only; Zig does not yet do anything
@@ -15,10 +15,6 @@
     // Once all dependencies are fetched, `zig build` no longer requires
     // Internet connectivity.
     .dependencies = .{
-        .ws = .{
-            .url = "git+https://github.com/karlseguin/websocket.zig.git#ba14f387b22210667a2941c1e5e4170eb1854957",
-            .hash = "1220276bfd080f184d931f7fbd63769151100abfaf047472cb9c09da5a03af3a2b21",
-        },
         .@"c-kzg-4844" = .{ .path = "./pkg/c-kzg-4844" },
     },
     .paths = .{

examples/autobahn/autobahn.zig

@@ -0,0 +1,133 @@
+const std = @import("std");
+const clients = @import("zabi-clients");
+
+const Allocator = std.mem.Allocator;
+const WebSocketClient = clients.WebSocketClient;
+
+pub fn main() !void {
+    var gpa = std.heap.GeneralPurposeAllocator(.{}){};
+    defer _ = gpa.detectLeaks();
+
+    const allocator = gpa.allocator();
+
+    const cases = [_][]const u8{
+        "1.1.1",   "1.1.2",   "1.1.3",   "1.1.4",   "1.1.5",   "1.1.6",   "1.1.7",   "1.1.8",   "1.2.1",   "1.2.2",   "1.2.3",   "1.2.4",   "1.2.5",   "1.2.6",   "1.2.7",   "1.2.8",
+        "2.1",     "2.10",    "2.11",    "2.2",     "2.3",     "2.4",     "2.5",     "2.6",     "2.7",     "2.8",     "2.9",     "3.1",     "3.2",     "3.3",     "3.4",     "3.5",
+        "3.6",     "3.7",     "4.1.1",   "4.1.2",   "4.1.3",   "4.1.4",   "4.1.5",   "4.2.1",   "4.2.2",   "4.2.3",   "4.2.4",   "4.2.5",   "5.1",     "5.2",     "5.3",     "5.4",
+        "5.5",     "5.6",     "5.7",     "5.8",     "5.9",     "5.10",    "5.11",    "5.12",    "5.13",    "5.14",    "5.15",    "5.16",    "5.17",    "5.18",    "5.19",    "5.20",
+        "6.1.1",   "6.1.2",   "6.1.3",   "6.2.1",   "6.2.2",   "6.2.3",   "6.2.4",   "6.3.1",   "6.3.2",   "6.4.1",   "6.4.2",   "6.4.3",   "6.4.4",   "6.5.1",   "6.5.2",   "6.5.3",
+        "6.5.4",   "6.5.5",   "6.6.1",   "6.6.2",   "6.6.3",   "6.6.4",   "6.6.5",   "6.6.6",   "6.6.7",   "6.6.8",   "6.6.9",   "6.6.10",  "6.6.11",  "6.7.1",   "6.7.2",   "6.7.3",
+        "6.7.4",   "6.8.1",   "6.8.2",   "6.9.1",   "6.9.2",   "6.9.3",   "6.9.4",   "6.10.1",  "6.10.2",  "6.10.3",  "6.11.1",  "6.11.2",  "6.11.3",  "6.11.4",  "6.11.5",  "6.12.1",
+        "6.12.2",  "6.12.3",  "6.12.4",  "6.12.5",  "6.12.6",  "6.12.7",  "6.12.8",  "6.13.1",  "6.13.2",  "6.13.3",  "6.13.4",  "6.13.5",  "6.14.1",  "6.14.2",  "6.14.3",  "6.14.4",
+        "6.14.5",  "6.14.6",  "6.14.7",  "6.14.8",  "6.14.9",  "6.14.10", "6.15.1",  "6.16.1",  "6.16.2",  "6.16.3",  "6.17.1",  "6.17.2",  "6.17.3",  "6.17.4",  "6.17.5",  "6.18.1",
+        "6.18.2",  "6.18.3",  "6.18.4",  "6.18.5",  "6.19.1",  "6.19.2",  "6.19.3",  "6.19.4",  "6.19.5",  "6.20.1",  "6.20.2",  "6.20.3",  "6.20.4",  "6.20.5",  "6.20.6",  "6.20.7",
+        "6.21.1",  "6.21.2",  "6.21.3",  "6.21.4",  "6.21.5",  "6.21.6",  "6.21.7",  "6.21.8",  "6.22.1",  "6.22.10", "6.22.11", "6.22.12", "6.22.13", "6.22.14", "6.22.15", "6.22.16",
+        "6.22.17", "6.22.18", "6.22.19", "6.22.2",  "6.22.20", "6.22.21", "6.22.22", "6.22.23", "6.22.24", "6.22.25", "6.22.26", "6.22.27", "6.22.28", "6.22.29", "6.22.3",  "6.22.30",
+        "6.22.31", "6.22.32", "6.22.33", "6.22.34", "6.22.4",  "6.22.5",  "6.22.6",  "6.22.7",  "6.22.8",  "6.22.9",  "6.23.1",  "6.23.2",  "6.23.3",  "6.23.4",  "6.23.5",  "6.23.6",
+        "6.23.7",  "7.1.1",   "7.1.2",   "7.1.3",   "7.1.4",   "7.1.5",   "7.1.6",   "7.3.1",   "7.3.2",   "7.3.3",   "7.3.4",   "7.3.5",   "7.3.6",   "7.5.1",   "7.7.1",   "7.7.2",
+        "7.7.3",   "7.7.4",   "7.7.5",   "7.7.6",   "7.7.7",   "7.7.8",   "7.7.9",   "7.7.10",  "7.7.11",  "7.7.12",  "7.7.13",  "7.9.1",   "7.9.2",   "7.9.3",   "7.9.4",   "7.9.5",
+        "7.9.6",   "7.9.7",   "7.9.8",   "7.9.9",   "7.13.1",  "7.13.2",  "9.1.1",   "9.1.2",   "9.1.3",   "9.1.4",   "9.1.5",   "9.1.6",   "9.2.1",   "9.2.2",   "9.2.3",   "9.2.4",
+        "9.2.5",   "9.2.6",   "9.3.1",   "9.3.2",   "9.3.3",   "9.3.4",   "9.3.5",   "9.3.6",   "9.3.7",   "9.3.8",   "9.3.9",   "9.4.1",   "9.4.2",   "9.4.3",   "9.4.4",   "9.4.5",
+        "9.4.6",   "9.4.7",   "9.4.8",   "9.4.9",   "9.5.1",   "9.5.2",   "9.5.3",   "9.5.4",   "9.5.5",   "9.5.6",   "9.6.1",   "9.6.2",   "9.6.3",   "9.6.4",   "9.6.5",   "9.6.6",
+        "9.7.1",   "9.7.2",   "9.7.3",   "9.7.4",   "9.7.5",   "9.7.6",   "9.8.1",   "9.8.2",   "9.8.3",   "9.8.4",   "9.8.5",   "9.8.6",   "10.1.1",
+    };
+
+    // wait 5 seconds for autobanh server to be up
+    std.time.sleep(std.time.ns_per_s * 1);
+
+    for (cases, 0..) |case, i| {
+        std.debug.print("running case: {s}\n", .{case});
+
+        {
+            var auto = try AutoBanh.init(allocator, case);
+            defer auto.deinit();
+
+            auto.readLoop() catch |err| switch (err) {
+                error.UnnegociatedReservedBits,
+                error.ControlFrameTooBig,
+                error.UnfragmentedContinue,
+                error.MessageSizeOverflow,
+                error.UnsupportedOpcode,
+                error.UnexpectedFragment,
+                error.MaskedServerMessage,
+                error.InvalidUtf8Payload,
+                error.FragmentedControl,
+                => {},
+                else => return err,
+            };
+        }
+
+        if (@rem(i, 10) == 0) {
+            try updateReport(allocator);
+        }
+    }
+    try updateReport(allocator);
+}
+
+fn updateReport(allocator: Allocator) !void {
+    const uri = try std.Uri.parse("http://localhost:9001/updateReports?agent=zabi.zig");
+    var client = try WebSocketClient.connect(allocator, uri);
+    defer client.deinit();
+
+    try client.handshake("localhost:9001");
+    try client.writeCloseFrame(0);
+}
+
+const AutoBanh = struct {
+    client: WebSocketClient,
+
+    pub fn init(allocator: Allocator, case: []const u8) !AutoBanh {
+        const path = try std.fmt.allocPrint(allocator, "http://localhost:9001/runCase?casetuple={s}&agent=zabi.zig", .{case});
+        defer allocator.free(path);
+
+        const uri = try std.Uri.parse(path);
+        var client = try WebSocketClient.connect(allocator, uri);
+
+        try client.handshake("localhost:9001");
+
+        return .{
+            .client = client,
+        };
+    }
+
+    pub fn deinit(self: *AutoBanh) void {
+        self.client.deinit();
+    }
+
+    pub fn readLoop(self: *AutoBanh) !void {
+        while (true) {
+            const message = self.client.readMessage() catch |err| switch (err) {
+                error.BrokenPipe,
+                error.ConnectionResetByPeer,
+                error.NotOpenForReading,
+                => {
+                    @atomicStore(bool, &self.client.closed_connection, true, .release);
+                    return error.ConnectionClosed;
+                },
+                error.InvalidUtf8Payload => {
+                    self.client.close(1007);
+                    return err;
+                },
+                else => {
+                    self.client.close(1002);
+                    return err;
+                },
+            };
+
+            switch (message.opcode) {
+                .binary,
+                => try self.client.writeFrame(message.data, .binary),
+                .text,
+                => try self.client.writeFrame(message.data, .text),
+                .ping,
+                => try self.client.writeFrame(message.data, .pong),
+                .connection_close,
+                => return self.client.close(0),
+                // Ignore unsolicited pong messages.
+                .pong,
+                => continue,
+                else => return error.UnexpectedOpcode,
+            }
+        }
+    }
+};

examples/autobahn/build.zig

@@ -0,0 +1,32 @@
+const std = @import("std");
+
+pub fn build(b: *std.Build) void {
+    const target = b.standardTargetOptions(.{});
+    const optimize = b.standardOptimizeOption(.{});
+
+    _ = b.addModule("autobahn_client", .{
+        .root_source_file = b.path("autobahn.zig"),
+    });
+
+    const exe = b.addExecutable(.{
+        .name = "autobahn_client",
+        .root_source_file = b.path("autobahn.zig"),
+        .target = target,
+        .optimize = optimize,
+    });
+
+    addDependencies(b, exe);
+    b.installArtifact(exe);
+}
+
+fn addDependencies(b: *std.Build, step: *std.Build.Step.Compile) void {
+    const target = step.root_module.resolved_target.?;
+    const optimize = step.root_module.optimize.?;
+
+    const zabi = b.dependency("zabi", .{
+        .target = target,
+        .optimize = optimize,
+    });
+
+    step.root_module.addImport("zabi-clients", zabi.module("zabi-clients"));
+}

examples/autobahn/build.zig.zon

@@ -0,0 +1,27 @@
+.{
+    .name = "examples",
+    // This is a [Semantic Version](https://semver.org/).
+    // In a future version of Zig it will be used for package deduplication.
+    .version = "0.1.0",
+
+    // This field is optional.
+    // This is currently advisory only; Zig does not yet do anything
+    // with this value.
+    //.minimum_zig_version = "0.11.0",
+
+    // This field is optional.
+    // Each dependency must either provide a `url` and `hash`, or a `path`.
+    // `zig build --fetch` can be used to fetch all dependencies of a package, recursively.
+    // Once all dependencies are fetched, `zig build` no longer requires
+    // Internet connectivity.
+    .dependencies = .{ .zabi = .{ .path = "../../" } },
+    .paths = .{
+        // This makes *all* files, recursively, included in this package. It is generally
+        // better to explicitly list the files and directories instead, to insure that
+        // fetching from tarballs, file system paths, and version control all result
+        // in the same contents hash.
+        "build.zig",
+        "build.zig.zon",
+        "autobahn.zig",
+    },
+}

examples/watch/watch.zig

@@ -29,9 +29,6 @@ pub fn main() !void {
     defer id.deinit();
 
     std.debug.print("Sub id: 0x{x}\n", .{id.response});
-    // There is currently a bug on the tls client that will cause index out of bound errors
-    // https://github.com/ziglang/zig/issues/15226
-    // Make sure that for now the data you are using is not big enough to cause these crashes.
     while (true) {
         const event = try socket.getPendingTransactionsSubEvent();
         defer event.deinit();