tigerbeetle-node 0.9.0 → 0.9.143

package/src/node.zig

@@ -3,7 +3,7 @@ const assert = std.debug.assert;
 
 const c = @import("c.zig");
 const translate = @import("translate.zig");
-const tb = @import("tigerbeetle/src/tigerbeetle.zig");
+const tb = @import("../../../tigerbeetle.zig");
 
 const Account = tb.Account;
 const AccountFlags = tb.AccountFlags;
@@ -12,17 +12,22 @@ const TransferFlags = tb.TransferFlags;
 const CreateAccountsResult = tb.CreateAccountsResult;
 const CreateTransfersResult = tb.CreateTransfersResult;
 
-const StateMachine = @import("tigerbeetle/src/state_machine.zig").StateMachine;
+const Storage = @import("../../../storage.zig").Storage;
+const StateMachine = @import("../../../state_machine.zig").StateMachineType(Storage, constants.state_machine_config);
 const Operation = StateMachine.Operation;
-const MessageBus = @import("tigerbeetle/src/message_bus.zig").MessageBusClient;
-const IO = @import("tigerbeetle/src/io.zig").IO;
-const config = @import("tigerbeetle/src/config.zig");
+const MessageBus = @import("../../../message_bus.zig").MessageBusClient;
+const MessagePool = @import("../../../message_pool.zig").MessagePool;
+const IO = @import("../../../io.zig").IO;
+const constants = @import("../../../constants.zig");
 
-const vsr = @import("tigerbeetle/src/vsr.zig");
+const vsr = @import("../../../vsr.zig");
 const Header = vsr.Header;
 const Client = vsr.Client(StateMachine, MessageBus);
 
-pub const log_level: std.log.Level = .info;
+pub const std_options = struct {
+    // Since this is running in application space, log only critical messages to reduce noise.
+    pub const log_level: std.log.Level = .err;
+};
 
 /// N-API will call this constructor automatically to register the module.
 export fn napi_register_module_v1(env: c.napi_env, exports: c.napi_value) c.napi_value {
@@ -36,7 +41,7 @@ export fn napi_register_module_v1(env: c.napi_env, exports: c.napi_value) c.napi
         env,
         exports,
         "tick_ms",
-        config.tick_ms,
+        constants.tick_ms,
         "failed to add tick_ms to exports",
     ) catch return null;
 
@@ -54,7 +59,7 @@ export fn napi_register_module_v1(env: c.napi_env, exports: c.napi_value) c.napi
     // state.
     translate.set_instance_data(
         env,
-        @ptrCast(*anyopaque, @alignCast(@alignOf(u8), global)),
+        @ptrCast(@alignCast(global)),
         Globals.destroy,
     ) catch {
         global.deinit();
@@ -112,14 +117,14 @@ const Globals = struct {
 };
 
 fn globalsCast(globals_raw: *anyopaque) *Globals {
-    return @ptrCast(*Globals, @alignCast(@alignOf(Globals), globals_raw));
+    return @ptrCast(@alignCast(globals_raw));
 }
 
 const Context = struct {
     io: *IO,
     addresses: []std.net.Address,
-    message_bus: MessageBus,
     client: Client,
+    message_pool: MessagePool,
 
     fn create(
         env: c.napi_env,
@@ -132,39 +137,33 @@ const Context = struct {
         errdefer allocator.destroy(context);
 
         context.io = io;
+        context.message_pool = try MessagePool.init(allocator, .client);
+        errdefer context.message_pool.deinit(allocator);
 
-        context.addresses = try vsr.parse_addresses(allocator, addresses_raw);
+        context.addresses = try vsr.parse_addresses(allocator, addresses_raw, constants.replicas_max);
         errdefer allocator.free(context.addresses);
         assert(context.addresses.len > 0);
 
         const client_id = std.crypto.random.int(u128);
-
-        context.message_bus = try MessageBus.init(
-            allocator,
-            cluster,
-            context.addresses,
-            client_id,
-            context.io,
-        );
-        errdefer context.message_bus.deinit();
-
         context.client = try Client.init(
             allocator,
             client_id,
             cluster,
-            @intCast(u8, context.addresses.len),
-            &context.message_bus,
+            @as(u8, @intCast(context.addresses.len)),
+            &context.message_pool,
+            .{
+                .configuration = context.addresses,
+                .io = context.io,
+            },
         );
-        errdefer context.client.deinit();
-
-        context.message_bus.set_on_message(*Client, &context.client, Client.on_message);
+        errdefer context.client.deinit(allocator);
 
         return try translate.create_external(env, context);
     }
 };
 
 fn contextCast(context_raw: *anyopaque) !*Context {
-    return @ptrCast(*Context, @alignCast(@alignOf(Context), context_raw));
+    return @ptrCast(@alignCast(context_raw));
 }
 
 fn validate_timestamp(env: c.napi_env, object: c.napi_value) !u64 {
@@ -185,27 +184,30 @@ fn decode_from_object(comptime T: type, env: c.napi_env, object: c.napi_value) !
             .id = try translate.u128_from_object(env, object, "id"),
             .debit_account_id = try translate.u128_from_object(env, object, "debit_account_id"),
             .credit_account_id = try translate.u128_from_object(env, object, "credit_account_id"),
-            .user_data = try translate.u128_from_object(env, object, "user_data"),
-            .reserved = try translate.u128_from_object(env, object, "reserved"),
+            .amount = try translate.u128_from_object(env, object, "amount"),
             .pending_id = try translate.u128_from_object(env, object, "pending_id"),
-            .timeout = try translate.u64_from_object(env, object, "timeout"),
+            .user_data_128 = try translate.u128_from_object(env, object, "user_data_128"),
+            .user_data_64 = try translate.u64_from_object(env, object, "user_data_64"),
+            .user_data_32 = try translate.u32_from_object(env, object, "user_data_32"),
+            .timeout = try translate.u32_from_object(env, object, "timeout"),
             .ledger = try translate.u32_from_object(env, object, "ledger"),
             .code = try translate.u16_from_object(env, object, "code"),
-            .flags = @bitCast(TransferFlags, try translate.u16_from_object(env, object, "flags")),
-            .amount = try translate.u64_from_object(env, object, "amount"),
+            .flags = @as(TransferFlags, @bitCast(try translate.u16_from_object(env, object, "flags"))),
             .timestamp = try validate_timestamp(env, object),
         },
         Account => Account{
             .id = try translate.u128_from_object(env, object, "id"),
-            .user_data = try translate.u128_from_object(env, object, "user_data"),
-            .reserved = try translate.bytes_from_object(env, object, 48, "reserved"),
+            .debits_pending = try translate.u128_from_object(env, object, "debits_pending"),
+            .debits_posted = try translate.u128_from_object(env, object, "debits_posted"),
+            .credits_pending = try translate.u128_from_object(env, object, "credits_pending"),
+            .credits_posted = try translate.u128_from_object(env, object, "credits_posted"),
+            .user_data_128 = try translate.u128_from_object(env, object, "user_data_128"),
+            .user_data_64 = try translate.u64_from_object(env, object, "user_data_64"),
+            .user_data_32 = try translate.u32_from_object(env, object, "user_data_32"),
+            .reserved = try translate.u32_from_object(env, object, "reserved"),
             .ledger = try translate.u32_from_object(env, object, "ledger"),
             .code = try translate.u16_from_object(env, object, "code"),
-            .flags = @bitCast(AccountFlags, try translate.u16_from_object(env, object, "flags")),
-            .debits_pending = try translate.u64_from_object(env, object, "debits_pending"),
-            .debits_posted = try translate.u64_from_object(env, object, "debits_posted"),
-            .credits_pending = try translate.u64_from_object(env, object, "credits_pending"),
-            .credits_posted = try translate.u64_from_object(env, object, "credits_posted"),
+            .flags = @bitCast(try translate.u16_from_object(env, object, "flags")),
             .timestamp = try validate_timestamp(env, object),
         },
         u128 => try translate.u128_from_value(env, object, "lookup"),
@@ -224,7 +226,6 @@ pub fn decode_events(
         .create_transfers => try decode_events_from_array(env, array, Transfer, output),
         .lookup_accounts => try decode_events_from_array(env, array, u128, output),
         .lookup_transfers => try decode_events_from_array(env, array, u128, output),
-        else => unreachable,
     };
 }
 
@@ -238,7 +239,7 @@ fn decode_events_from_array(
     if (array_length < 1) return translate.throw(env, "Batch must contain at least one event.");
 
     const body_length = @sizeOf(T) * array_length;
-    if (@sizeOf(Header) + body_length > config.message_size_max) {
+    if (@sizeOf(Header) + body_length > constants.message_size_max) {
         return translate.throw(env, "Batch is larger than the maximum message size.");
     }
 
@@ -263,7 +264,7 @@ fn encode_napi_results_array(
     const results = std.mem.bytesAsSlice(Result, data);
     const napi_array = try translate.create_array(
         env,
-        @intCast(u32, results.len),
+        @as(u32, @intCast(results.len)),
         "Failed to allocate array for results.",
     );
 
@@ -288,9 +289,9 @@ fn encode_napi_results_array(
                 try translate.u32_into_object(
                     env,
                     napi_object,
-                    "code",
-                    @enumToInt(result.result),
-                    "Failed to set property \"code\" of result.",
+                    "result",
+                    @intFromEnum(result.result),
+                    "Failed to set property \"result\" of result.",
                 );
 
                 try translate.set_array_element(
@@ -322,73 +323,89 @@ fn encode_napi_results_array(
                 try translate.u128_into_object(
                     env,
                     napi_object,
-                    "user_data",
-                    result.user_data,
-                    "Failed to set property \"user_data\" of account lookup result.",
+                    "debits_pending",
+                    result.debits_pending,
+                    "Failed to set property \"debits_pending\" of account lookup result.",
                 );
 
-                try translate.byte_slice_into_object(
+                try translate.u128_into_object(
                     env,
                     napi_object,
-                    "reserved",
-                    &result.reserved,
-                    "Failed to set property \"reserved\" of account lookup result.",
+                    "debits_posted",
+                    result.debits_posted,
+                    "Failed to set property \"debits_posted\" of account lookup result.",
                 );
 
-                try translate.u32_into_object(
+                try translate.u128_into_object(
                     env,
                     napi_object,
-                    "ledger",
-                    @intCast(u32, result.ledger),
-                    "Failed to set property \"ledger\" of account lookup result.",
+                    "credits_pending",
+                    result.credits_pending,
+                    "Failed to set property \"credits_pending\" of account lookup result.",
                 );
 
-                try translate.u16_into_object(
+                try translate.u128_into_object(
                     env,
                     napi_object,
-                    "code",
-                    @intCast(u16, result.code),
-                    "Failed to set property \"code\" of account lookup result.",
+                    "credits_posted",
+                    result.credits_posted,
+                    "Failed to set property \"credits_posted\" of account lookup result.",
                 );
 
-                try translate.u16_into_object(
+                try translate.u128_into_object(
                     env,
                     napi_object,
-                    "flags",
-                    @bitCast(u16, result.flags),
-                    "Failed to set property \"flags\" of account lookup result.",
+                    "user_data_128",
+                    result.user_data_128,
+                    "Failed to set property \"user_data_128\" of account lookup result.",
                 );
 
                 try translate.u64_into_object(
                     env,
                     napi_object,
-                    "debits_pending",
-                    result.debits_pending,
-                    "Failed to set property \"debits_pending\" of account lookup result.",
+                    "user_data_64",
+                    result.user_data_64,
+                    "Failed to set property \"user_data_64\" of account lookup result.",
                 );
 
-                try translate.u64_into_object(
+                try translate.u32_into_object(
                     env,
                     napi_object,
-                    "debits_posted",
-                    result.debits_posted,
-                    "Failed to set property \"debits_posted\" of account lookup result.",
+                    "user_data_32",
+                    result.user_data_32,
+                    "Failed to set property \"user_data_32\" of account lookup result.",
                 );
 
-                try translate.u64_into_object(
+                try translate.u32_into_object(
                     env,
                     napi_object,
-                    "credits_pending",
-                    result.credits_pending,
-                    "Failed to set property \"credits_pending\" of account lookup result.",
+                    "reserved",
+                    result.reserved,
+                    "Failed to set property \"reserved\" of account lookup result.",
                 );
 
-                try translate.u64_into_object(
+                try translate.u32_into_object(
                     env,
                     napi_object,
-                    "credits_posted",
-                    result.credits_posted,
-                    "Failed to set property \"credits_posted\" of account lookup result.",
+                    "ledger",
+                    @as(u32, @intCast(result.ledger)),
+                    "Failed to set property \"ledger\" of account lookup result.",
+                );
+
+                try translate.u16_into_object(
+                    env,
+                    napi_object,
+                    "code",
+                    @as(u16, @intCast(result.code)),
+                    "Failed to set property \"code\" of account lookup result.",
+                );
+
+                try translate.u16_into_object(
+                    env,
+                    napi_object,
+                    "flags",
+                    @as(u16, @bitCast(result.flags)),
+                    "Failed to set property \"flags\" of account lookup result.",
                 );
 
                 try translate.u64_into_object(
@@ -444,28 +461,44 @@ fn encode_napi_results_array(
                 try translate.u128_into_object(
                     env,
                     napi_object,
-                    "user_data",
-                    result.user_data,
-                    "Failed to set property \"user_data\" of transfer lookup result.",
+                    "amount",
+                    result.amount,
+                    "Failed to set property \"amount\" of transfer lookup result.",
                 );
 
                 try translate.u128_into_object(
                     env,
                     napi_object,
-                    "reserved",
-                    result.reserved,
-                    "Failed to set property \"reserved\" of transfer lookup result.",
+                    "pending_id",
+                    result.pending_id,
+                    "Failed to set property \"pending_id\" of transfer lookup result.",
                 );
 
                 try translate.u128_into_object(
                     env,
                     napi_object,
-                    "pending_id",
-                    result.pending_id,
-                    "Failed to set property \"pending_id\" of transfer lookup result.",
+                    "user_data_128",
+                    result.user_data_128,
+                    "Failed to set property \"user_data_128\" of transfer lookup result.",
                 );
 
                 try translate.u64_into_object(
+                    env,
+                    napi_object,
+                    "user_data_64",
+                    result.user_data_64,
+                    "Failed to set property \"user_data_64\" of transfer lookup result.",
+                );
+
+                try translate.u32_into_object(
+                    env,
+                    napi_object,
+                    "user_data_32",
+                    result.user_data_32,
+                    "Failed to set property \"user_data_32\" of transfer lookup result.",
+                );
+
+                try translate.u32_into_object(
                     env,
                     napi_object,
                     "timeout",
@@ -477,7 +510,7 @@ fn encode_napi_results_array(
                     env,
                     napi_object,
                     "ledger",
-                    @intCast(u32, result.ledger),
+                    @as(u32, @intCast(result.ledger)),
                     "Failed to set property \"ledger\" of transfer lookup result.",
                 );
 
@@ -485,7 +518,7 @@ fn encode_napi_results_array(
                     env,
                     napi_object,
                     "code",
-                    @intCast(u16, result.code),
+                    @as(u16, @intCast(result.code)),
                     "Failed to set property \"code\" of transfer lookup result.",
                 );
 
@@ -493,18 +526,10 @@ fn encode_napi_results_array(
                     env,
                     napi_object,
                     "flags",
-                    @bitCast(u16, result.flags),
+                    @as(u16, @bitCast(result.flags)),
                     "Failed to set property \"flags\" of transfer lookup result.",
                 );
 
-                try translate.u64_into_object(
-                    env,
-                    napi_object,
-                    "amount",
-                    result.amount,
-                    "Failed to set property \"amount\" of transfer lookup result.",
-                );
-
                 try translate.u64_into_object(
                     env,
                     napi_object,
@@ -582,14 +607,20 @@ fn request(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_valu
     const context = contextCast(context_raw.?) catch return null;
     const operation_int = translate.u32_from_value(env, argv[1], "operation") catch return null;
 
-    if (operation_int >= @typeInfo(Operation).Enum.fields.len) {
+    if (!@as(vsr.Operation, @enumFromInt(operation_int)).valid(StateMachine)) {
         translate.throw(env, "Unknown operation.") catch return null;
     }
 
+    if (context.client.messages_available == 0) {
+        translate.throw(
+            env,
+            "Too many outstanding requests - message pool exhausted.",
+        ) catch return null;
+    }
     const message = context.client.get_message();
-    defer context.client.unref(message);
+    errdefer context.client.release(message);
 
-    const operation = @intToEnum(Operation, @intCast(u8, operation_int));
+    const operation = @as(Operation, @enumFromInt(@as(u8, @intCast(operation_int))));
     const body_length = decode_events(
         env,
         argv[2],
@@ -603,7 +634,7 @@ fn request(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_valu
     // free in order to avoid a leak. We therefore do this last to ensure we cannot fail after
     // taking this reference.
     const user_data = translate.user_data_from_value(env, argv[3]) catch return null;
-    context.client.request(@bitCast(u128, user_data), on_result, operation, message, body_length);
+    context.client.request(@as(u128, @bitCast(user_data)), on_result, operation, message, body_length);
 
     return null;
 }
@@ -631,13 +662,19 @@ fn raw_request(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_
     const context = contextCast(context_raw.?) catch return null;
     const operation_int = translate.u32_from_value(env, argv[1], "operation") catch return null;
 
-    if (operation_int >= @typeInfo(Operation).Enum.fields.len) {
+    if (!@as(vsr.Operation, @enumFromInt(operation_int)).valid(StateMachine)) {
         translate.throw(env, "Unknown operation.") catch return null;
     }
-    const operation = @intToEnum(Operation, @intCast(u8, operation_int));
+    const operation = @as(Operation, @enumFromInt(@as(u8, @intCast(operation_int))));
 
+    if (context.client.messages_available == 0) {
+        translate.throw(
+            env,
+            "Too many outstanding requests - message pool exhausted.",
+        ) catch return null;
+    }
     const message = context.client.get_message();
-    defer context.client.unref(message);
+    errdefer context.client.release(message);
 
     const body_length = translate.bytes_from_buffer(
         env,
@@ -652,25 +689,16 @@ fn raw_request(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_
     // free in order to avoid a leak. We therefore do this last to ensure we cannot fail after
     // taking this reference.
     const user_data = translate.user_data_from_value(env, argv[3]) catch return null;
-    context.client.request(@bitCast(u128, user_data), on_result, operation, message, body_length);
+    context.client.request(@as(u128, @bitCast(user_data)), on_result, operation, message, body_length);
 
     return null;
 }
 
-fn create_client_error(env: c.napi_env, client_error: Client.Error) !c.napi_value {
-    return switch (client_error) {
-        error.TooManyOutstandingRequests => try translate.create_error(
-            env,
-            "Too many outstanding requests - message pool exhausted.",
-        ),
-    };
-}
-
-fn on_result(user_data: u128, operation: Operation, results: Client.Error![]const u8) void {
+fn on_result(user_data: u128, operation: Operation, results: []const u8) void {
     // A reference to the user's JS callback was made in `request` or `raw_request`. This MUST be
     // cleaned up regardless of the result of this function.
-    const env = @bitCast(translate.UserData, user_data).env;
-    const callback_reference = @bitCast(translate.UserData, user_data).callback_reference;
+    const env = @as(translate.UserData, @bitCast(user_data)).env;
+    const callback_reference = @as(translate.UserData, @bitCast(user_data)).callback_reference;
     defer translate.delete_reference(env, callback_reference) catch {
         std.log.warn("on_result: Failed to delete reference to user's JS callback.", .{});
     };
@@ -689,33 +717,23 @@ fn on_result(user_data: u128, operation: Operation, results: Client.Error![]cons
     const argc: usize = 2;
     var argv: [argc]c.napi_value = undefined;
 
-    if (results) |value| {
-        const napi_results = switch (operation) {
-            .reserved, .root, .register => {
-                translate.throw(env, "Reserved operation.") catch return;
-            },
-            .create_accounts => encode_napi_results_array(
-                CreateAccountsResult,
-                env,
-                value,
-            ) catch return,
-            .create_transfers => encode_napi_results_array(
-                CreateTransfersResult,
-                env,
-                value,
-            ) catch return,
-            .lookup_accounts => encode_napi_results_array(Account, env, value) catch return,
-            .lookup_transfers => encode_napi_results_array(Transfer, env, value) catch return,
-        };
+    const napi_results = switch (operation) {
+        .create_accounts => encode_napi_results_array(
+            CreateAccountsResult,
+            env,
+            results,
+        ) catch return,
+        .create_transfers => encode_napi_results_array(
+            CreateTransfersResult,
+            env,
+            results,
+        ) catch return,
+        .lookup_accounts => encode_napi_results_array(Account, env, results) catch return,
+        .lookup_transfers => encode_napi_results_array(Transfer, env, results) catch return,
+    };
 
-        argv[0] = globals.napi_undefined;
-        argv[1] = napi_results;
-    } else |err| {
-        argv[0] = create_client_error(env, err) catch {
-            translate.throw(env, "Failed to create Node Error.") catch return;
-        };
-        argv[1] = globals.napi_undefined;
-    }
+    argv[0] = globals.napi_undefined;
+    argv[1] = napi_results;
 
     translate.call_function(env, scope, napi_callback, argc, argv[0..]) catch {
         translate.throw(env, "Failed to call JS results callback.") catch return;
@@ -769,8 +787,11 @@ fn deinit(env: c.napi_env, info: c.napi_callback_info) callconv(.C) c.napi_value
         "Failed to get Client Context pointer.",
     ) catch return null;
     const context = contextCast(context_raw.?) catch return null;
-    context.client.deinit();
-    context.message_bus.deinit();
+
+    const allocator = std.heap.c_allocator;
+    context.client.deinit(allocator);
+    context.message_pool.deinit(allocator);
+    allocator.free(context.addresses);
 
     return null;
 }