tigerbeetle-node 0.16.78 → 0.17.0

package/src/translate.zig

@@ -10,7 +10,9 @@ pub fn register_function(
 ) !void {
     var napi_function: c.napi_value = undefined;
     if (c.napi_create_function(env, null, 0, function, null, &napi_function) != c.napi_ok) {
-        return throw(env, "Failed to create function " ++ name ++ "().");
+        return throw(env, .{
+            .message = "Failed to create function " ++ name ++ "().",
+        });
     }
 
     if (c.napi_set_named_property(
@@ -19,25 +21,87 @@ pub fn register_function(
         @as([*c]const u8, @ptrCast(name)),
         napi_function,
     ) != c.napi_ok) {
-        return throw(env, "Failed to add " ++ name ++ "() to exports.");
+        return throw(env, .{
+            .message = "Failed to add " ++ name ++ "() to exports.",
+        });
     }
 }
 
-const TranslationError = error{ExceptionThrown};
-pub fn throw(env: c.napi_env, comptime message: [:0]const u8) TranslationError {
-    const result = c.napi_throw_error(env, null, @as([*c]const u8, @ptrCast(message)));
+pub const Error = error{ExceptionThrown};
+pub fn throw(env: c.napi_env, comptime options: struct {
+    message: [:0]const u8,
+}) Error {
+    const result = c.napi_throw_error(
+        env,
+        null,
+        options.message,
+    );
     switch (result) {
         c.napi_ok, c.napi_pending_exception => {},
         else => unreachable,
     }
 
-    return TranslationError.ExceptionThrown;
+    return Error.ExceptionThrown;
+}
+
+pub fn throw_typed_error(
+    env: c.napi_env,
+    ctor_ref: c.napi_ref,
+    code: [:0]const u8,
+) Error {
+    var string: c.napi_value = undefined;
+    var ctor: c.napi_value = undefined;
+    var exception: c.napi_value = undefined;
+    if (c.napi_get_reference_value(
+        env,
+        ctor_ref,
+        &ctor,
+    ) != c.napi_ok) {
+        return throw(env, .{ .message = "Failed to get the constructor reference." });
+    }
+    assert(ctor != null);
+
+    if (c.napi_create_string_utf8(
+        env,
+        code,
+        code.len,
+        &string,
+    ) != c.napi_ok) {
+        return throw(env, .{ .message = "Failed to create string utf8." });
+    }
+    if (c.napi_new_instance(
+        env,
+        ctor,
+        1,
+        &[_]c.napi_value{string},
+        &exception,
+    ) != c.napi_ok) {
+        return throw(env, .{ .message = "Failed to create new instance." });
+    }
+
+    // Asserting the exception got the right type.
+    var is_instance_of: bool = false;
+    assert(c.napi_instanceof(
+        env,
+        exception,
+        ctor,
+        &is_instance_of,
+    ) == c.napi_ok);
+    assert(is_instance_of);
+
+    if (c.napi_throw(env, exception) != c.napi_ok) {
+        return throw(env, .{ .message = "Failed to throw typed error" });
+    }
+
+    return Error.ExceptionThrown;
 }
 
 pub fn capture_null(env: c.napi_env) !c.napi_value {
     var result: c.napi_value = undefined;
     if (c.napi_get_null(env, &result) != c.napi_ok) {
-        return throw(env, "Failed to capture the value of \"null\".");
+        return throw(env, .{
+            .message = "Failed to capture the value of \"null\".",
+        });
     }
 
     return result;
@@ -50,20 +114,21 @@ pub fn extract_args(env: c.napi_env, info: c.napi_callback_info, comptime args:
     var argc = args.count;
     var argv: [args.count]c.napi_value = undefined;
     if (c.napi_get_cb_info(env, info, &argc, &argv, null, null) != c.napi_ok) {
-        return throw(
-            env,
-            std.fmt.comptimePrint("Failed to get args for {s}()\x00", .{args.function}),
-        );
+        return throw(env, .{
+            .message = std.fmt.comptimePrint("Failed to get args for {s}()\x00", .{args.function}),
+        });
     }
 
     if (argc != args.count) {
-        return throw(
-            env,
-            std.fmt.comptimePrint("Function {s}() requires exactly {} arguments.\x00", .{
-                args.function,
-                args.count,
-            }),
-        );
+        return throw(env, .{
+            .message = std.fmt.comptimePrint(
+                "Function {s}() requires exactly {} arguments.\x00",
+                .{
+                    args.function,
+                    args.count,
+                },
+            ),
+        });
     }
 
     return argv;
@@ -72,7 +137,9 @@ pub fn extract_args(env: c.napi_env, info: c.napi_callback_info, comptime args:
 pub fn create_external(env: c.napi_env, context: *anyopaque) !c.napi_value {
     var result: c.napi_value = null;
     if (c.napi_create_external(env, context, null, null, &result) != c.napi_ok) {
-        return throw(env, "Failed to create external for client context.");
+        return throw(env, .{
+            .message = "Failed to create external for client context.",
+        });
     }
 
     return result;
@@ -85,7 +152,7 @@ pub fn value_external(
 ) !?*anyopaque {
     var result: ?*anyopaque = undefined;
     if (c.napi_get_value_external(env, value, &result) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 
     return result;
@@ -98,12 +165,28 @@ pub fn slice_from_object(
 ) ![]const u8 {
     var property: c.napi_value = undefined;
     if (c.napi_get_named_property(env, object, key, &property) != c.napi_ok) {
-        return throw(env, key ++ " must be defined");
+        return throw(env, .{
+            .message = key ++ " must be defined",
+        });
     }
 
     return slice_from_value(env, property, key);
 }
 
+pub fn get_object_property(
+    env: c.napi_env,
+    object: c.napi_value,
+    comptime key: [:0]const u8,
+) !c.napi_value {
+    var result: c.napi_value = undefined;
+    if (c.napi_get_named_property(env, object, key, &result) != c.napi_ok) {
+        return throw(env, .{
+            .message = key ++ " must be defined",
+        });
+    }
+    return result;
+}
+
 pub fn slice_from_value(
     env: c.napi_env,
     value: c.napi_value,
@@ -112,13 +195,17 @@ pub fn slice_from_value(
     var is_buffer: bool = undefined;
     assert(c.napi_is_buffer(env, value, &is_buffer) == c.napi_ok);
 
-    if (!is_buffer) return throw(env, key ++ " must be a buffer");
+    if (!is_buffer) return throw(env, .{
+        .message = key ++ " must be a buffer",
+    });
 
     var data: ?*anyopaque = null;
     var data_length: usize = undefined;
     assert(c.napi_get_buffer_info(env, value, &data, &data_length) == c.napi_ok);
 
-    if (data_length < 1) return throw(env, key ++ " must not be empty");
+    if (data_length < 1) return throw(env, .{
+        .message = key ++ " must not be empty",
+    });
 
     return @as([*]u8, @ptrCast(data.?))[0..data_length];
 }
@@ -126,7 +213,9 @@ pub fn slice_from_value(
 pub fn u128_from_object(env: c.napi_env, object: c.napi_value, comptime key: [:0]const u8) !u128 {
     var property: c.napi_value = undefined;
     if (c.napi_get_named_property(env, object, key, &property) != c.napi_ok) {
-        return throw(env, key ++ " must be defined");
+        return throw(env, .{
+            .message = key ++ " must be defined",
+        });
     }
 
     return u128_from_value(env, property, key);
@@ -135,7 +224,9 @@ pub fn u128_from_object(env: c.napi_env, object: c.napi_value, comptime key: [:0
 pub fn u64_from_object(env: c.napi_env, object: c.napi_value, comptime key: [:0]const u8) !u64 {
     var property: c.napi_value = undefined;
     if (c.napi_get_named_property(env, object, key, &property) != c.napi_ok) {
-        return throw(env, key ++ " must be defined");
+        return throw(env, .{
+            .message = key ++ " must be defined",
+        });
     }
 
     return u64_from_value(env, property, key);
@@ -144,7 +235,9 @@ pub fn u64_from_object(env: c.napi_env, object: c.napi_value, comptime key: [:0]
 pub fn u32_from_object(env: c.napi_env, object: c.napi_value, comptime key: [:0]const u8) !u32 {
     var property: c.napi_value = undefined;
     if (c.napi_get_named_property(env, object, key, &property) != c.napi_ok) {
-        return throw(env, key ++ " must be defined");
+        return throw(env, .{
+            .message = key ++ " must be defined",
+        });
     }
 
     return u32_from_value(env, property, key);
@@ -153,7 +246,9 @@ pub fn u32_from_object(env: c.napi_env, object: c.napi_value, comptime key: [:0]
 pub fn u16_from_object(env: c.napi_env, object: c.napi_value, comptime key: [:0]const u8) !u16 {
     const result = try u32_from_object(env, object, key);
     if (result > std.math.maxInt(u16)) {
-        return throw(env, key ++ " must be a u16.");
+        return throw(env, .{
+            .message = key ++ " must be a u16.",
+        });
     }
 
     return @as(u16, @intCast(result));
@@ -171,11 +266,17 @@ pub fn u128_from_value(env: c.napi_env, value: c.napi_value, comptime name: [:0]
     var word_count: usize = 2;
     switch (c.napi_get_value_bigint_words(env, value, &sign_bit, &word_count, words)) {
         c.napi_ok => {},
-        c.napi_bigint_expected => return throw(env, name ++ " must be a BigInt"),
+        c.napi_bigint_expected => return throw(env, .{
+            .message = name ++ " must be a BigInt",
+        }),
         else => unreachable,
     }
-    if (sign_bit != 0) return throw(env, name ++ " must be positive");
-    if (word_count > 2) return throw(env, name ++ " must fit in 128 bits");
+    if (sign_bit != 0) return throw(env, .{
+        .message = name ++ " must be positive",
+    });
+    if (word_count > 2) return throw(env, .{
+        .message = name ++ " must fit in 128 bits",
+    });
 
     return result;
 }
@@ -185,10 +286,14 @@ pub fn u64_from_value(env: c.napi_env, value: c.napi_value, comptime name: [:0]c
     var lossless: bool = undefined;
     switch (c.napi_get_value_bigint_uint64(env, value, &result, &lossless)) {
         c.napi_ok => {},
-        c.napi_bigint_expected => return throw(env, name ++ " must be an unsigned 64-bit BigInt"),
+        c.napi_bigint_expected => return throw(env, .{
+            .message = name ++ " must be an unsigned 64-bit BigInt",
+        }),
         else => unreachable,
     }
-    if (!lossless) return throw(env, name ++ " conversion was lossy");
+    if (!lossless) return throw(env, .{
+        .message = name ++ " conversion was lossy",
+    });
 
     return result;
 }
@@ -200,7 +305,9 @@ pub fn u32_from_value(env: c.napi_env, value: c.napi_value, comptime name: [:0]c
     // We want to make sure this is: unsigned, and an integer.
     switch (c.napi_get_value_uint32(env, value, &result)) {
         c.napi_ok => {},
-        c.napi_number_expected => return throw(env, name ++ " must be a number"),
+        c.napi_number_expected => return throw(env, .{
+            .message = name ++ " must be a number",
+        }),
         else => unreachable,
     }
     return result;
@@ -226,7 +333,7 @@ pub fn u128_into_object(
         @as(*const [2]u64, @ptrCast(&value)),
         &bigint,
     ) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 
     if (c.napi_set_named_property(
@@ -235,7 +342,7 @@ pub fn u128_into_object(
         @ptrCast(key),
         bigint,
     ) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 }
 
@@ -248,7 +355,7 @@ pub fn u64_into_object(
 ) !void {
     var result: c.napi_value = undefined;
     if (c.napi_create_bigint_uint64(env, value, &result) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 
     if (c.napi_set_named_property(
@@ -257,7 +364,7 @@ pub fn u64_into_object(
         @ptrCast(key),
         result,
     ) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 }
 
@@ -270,11 +377,11 @@ pub fn u32_into_object(
 ) !void {
     var result: c.napi_value = undefined;
     if (c.napi_create_uint32(env, value, &result) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 
     if (c.napi_set_named_property(env, object, @ptrCast(key), result) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 }
 
@@ -291,7 +398,7 @@ pub fn u16_into_object(
 pub fn create_object(env: c.napi_env, comptime error_message: [:0]const u8) !c.napi_value {
     var result: c.napi_value = undefined;
     if (c.napi_create_object(env, &result) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 
     return result;
@@ -304,7 +411,7 @@ pub fn create_array(
 ) !c.napi_value {
     var result: c.napi_value = undefined;
     if (c.napi_create_array_with_length(env, length, &result) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 
     return result;
@@ -318,14 +425,14 @@ pub fn set_array_element(
     comptime error_message: [:0]const u8,
 ) !void {
     if (c.napi_set_element(env, array, index, value) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 }
 
 pub fn array_element(env: c.napi_env, array: c.napi_value, index: u32) !c.napi_value {
     var element: c.napi_value = undefined;
     if (c.napi_get_element(env, array, index, &element) != c.napi_ok) {
-        return throw(env, "Failed to get array element.");
+        return throw(env, .{ .message = "Failed to get array element." });
     }
 
     return element;
@@ -334,7 +441,9 @@ pub fn array_element(env: c.napi_env, array: c.napi_value, index: u32) !c.napi_v
 pub fn array_length(env: c.napi_env, array: c.napi_value) !u32 {
     var is_array: bool = undefined;
     assert(c.napi_is_array(env, array, &is_array) == c.napi_ok);
-    if (!is_array) return throw(env, "Batch must be an Array.");
+    if (!is_array) return throw(env, .{
+        .message = "Batch must be an Array.",
+    });
 
     var length: u32 = undefined;
     assert(c.napi_get_array_length(env, array, &length) == c.napi_ok);
@@ -342,9 +451,32 @@ pub fn array_length(env: c.napi_env, array: c.napi_value) !u32 {
     return length;
 }
 
+pub fn create_reference(
+    env: c.napi_env,
+    object: c.napi_value,
+    reference_type: enum { strong, weak },
+    reference_out: *c.napi_ref,
+    comptime error_message: [:0]const u8,
+) !void {
+    const initial_ref_count: u32 = switch (reference_type) {
+        .weak => 0,
+        .strong => 1,
+    };
+    if (c.napi_create_reference(
+        env,
+        object,
+        initial_ref_count,
+        reference_out,
+    ) != c.napi_ok) {
+        return throw(env, .{ .message = error_message });
+    }
+}
+
 pub fn delete_reference(env: c.napi_env, reference: c.napi_ref) !void {
     if (c.napi_delete_reference(env, reference) != c.napi_ok) {
-        return throw(env, "Failed to delete callback reference.");
+        return throw(env, .{
+            .message = "Failed to delete callback reference.",
+        });
     }
 }
 
@@ -360,7 +492,9 @@ pub fn call_function(
         // the user's callback may throw a JS exception or call other functions that do so. We
         // therefore don't throw another error.
         c.napi_pending_exception => {},
-        else => return throw(env, "Failed to invoke results callback."),
+        else => return throw(env, .{
+            .message = "Failed to invoke results callback.",
+        }),
     }
     return result;
 }
@@ -372,7 +506,7 @@ pub fn reference_value(
 ) !c.napi_value {
     var result: c.napi_value = undefined;
     if (c.napi_get_reference_value(env, callback_reference, &result) != c.napi_ok) {
-        return throw(env, error_message);
+        return throw(env, .{ .message = error_message });
     }
 
     return result;