zig: assert there is an exception when .zero is returned (#15362)

Co-authored-by: Jarred Sumner <[email protected]>
oven-sh · Nov 25, 2024 · bb3d570 · bb3d570
1 parent a6f37b3
commit bb3d570
Show file tree

Hide file tree

Showing 21 changed files with 167 additions and 179 deletions.
diff --git a/src/bun.js/api/BunObject.zig b/src/bun.js/api/BunObject.zig
@@ -263,7 +263,7 @@ pub fn shellEscape(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) b
     const arguments = callframe.arguments_old(1);
     if (arguments.len < 1) {
         globalThis.throw("shell escape expected at least 1 argument", .{});
-        return .undefined;
+        return .zero;
     }
 
     const jsval = arguments.ptr[0];
@@ -277,11 +277,11 @@ pub fn shellEscape(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) b
     if (bun.shell.needsEscapeBunstr(bunstr)) {
         const result = bun.shell.escapeBunStr(bunstr, &outbuf, true) catch {
             globalThis.throwOutOfMemory();
-            return .undefined;
+            return .zero;
         };
         if (!result) {
             globalThis.throw("String has invalid utf-16: {s}", .{bunstr.byteSlice()});
-            return .undefined;
+            return .zero;
         }
         var str = bun.String.createUTF8(outbuf.items[0..]);
         return str.transferToJS(globalThis);
@@ -297,7 +297,7 @@ pub fn braces(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) bun.JS
 
     const brace_str_js = arguments.nextEat() orelse {
         globalThis.throw("braces: expected at least 1 argument, got 0", .{});
-        return .undefined;
+        return .zero;
     };
     const brace_str = brace_str_js.toBunString(globalThis);
     defer brace_str.deref();
@@ -337,7 +337,7 @@ pub fn braces(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) bun.JS
     if (tokenize) {
         const str = std.json.stringifyAlloc(globalThis.bunVM().allocator, lexer_output.tokens.items[0..], .{}) catch {
             globalThis.throwOutOfMemory();
-            return JSValue.undefined;
+            return .zero;
         };
         defer globalThis.bunVM().allocator.free(str);
         var bun_str = bun.String.fromBytes(str);
@@ -350,7 +350,7 @@ pub fn braces(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) bun.JS
         };
         const str = std.json.stringifyAlloc(globalThis.bunVM().allocator, ast_node, .{}) catch {
             globalThis.throwOutOfMemory();
-            return JSValue.undefined;
+            return .zero;
         };
         defer globalThis.bunVM().allocator.free(str);
         var bun_str = bun.String.fromBytes(str);
@@ -363,7 +363,7 @@ pub fn braces(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) bun.JS
 
     var expanded_strings = arena.allocator().alloc(std.ArrayList(u8), expansion_count) catch {
         globalThis.throwOutOfMemory();
-        return .undefined;
+        return .zero;
     };
 
     for (0..expansion_count) |i| {
@@ -377,12 +377,12 @@ pub fn braces(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) bun.JS
         lexer_output.contains_nested,
     ) catch {
         globalThis.throwOutOfMemory();
-        return .undefined;
+        return .zero;
     };
 
     var out_strings = arena.allocator().alloc(bun.String, expansion_count) catch {
         globalThis.throwOutOfMemory();
-        return .undefined;
+        return .zero;
     };
     for (0..expansion_count) |i| {
         out_strings[i] = bun.String.fromBytes(expanded_strings[i].items[0..]);
@@ -398,7 +398,7 @@ pub fn which(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) bun.JSE
     defer arguments.deinit();
     const path_arg = arguments.nextEat() orelse {
         globalThis.throw("which: expected 1 argument, got 0", .{});
-        return .undefined;
+        return .zero;
     };
 
     var path_str: ZigString.Slice = ZigString.Slice.empty;
@@ -421,7 +421,7 @@ pub fn which(globalThis: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) bun.JSE
 
     if (bin_str.len >= bun.MAX_PATH_BYTES) {
         globalThis.throw("bin path is too long", .{});
-        return .undefined;
+        return .zero;
     }
 
     if (bin_str.len == 0) {
@@ -611,7 +611,7 @@ pub fn registerMacro(globalObject: *JSC.JSGlobalObject, callframe: *JSC.CallFram
     if (!arguments[1].isCell() or !arguments[1].isCallable(globalObject.vm())) {
         // TODO: add "toTypeOf" helper
         globalObject.throw("Macro must be a function", .{});
-        return .undefined;
+        return .zero;
     }
 
     const get_or_put_result = VirtualMachine.get().macros.getOrPut(id) catch unreachable;
@@ -755,7 +755,7 @@ pub fn openInEditor(globalThis: js.JSContextRef, callframe: *JSC.CallFrame) bun.
                     if (editor_choice == null) {
                         edit.* = prev;
                         globalThis.throw("Could not find editor \"{s}\"", .{sliced.slice()});
-                        return .undefined;
+                        return .zero;
                     } else if (edit.name.ptr == edit.path.ptr) {
                         edit.name = arguments.arena.allocator().dupe(u8, edit.path) catch unreachable;
                         edit.path = edit.path;
@@ -858,7 +858,7 @@ pub fn sleepSync(globalObject: *JSC.JSGlobalObject, callframe: *JSC.CallFrame) b
     // The argument must be a number
     if (!arg.isNumber()) {
         globalObject.throwInvalidArgumentType("sleepSync", "milliseconds", "number");
-        return .undefined;
+        return .zero;
     }
 
     //NOTE: if argument is > max(i32) then it will be truncated
@@ -2078,7 +2078,7 @@ pub const Crypto = struct {
                     .err => {
                         const error_instance = value.toErrorInstance(globalObject);
                         globalObject.throwValue(error_instance);
-                        return JSC.JSValue.undefined;
+                        return .zero;
                     },
                     .pass => |pass| {
                         return JSC.JSValue.jsBoolean(pass);
@@ -2316,7 +2316,7 @@ pub const Crypto = struct {
             if (arguments.len > 2 and !arguments[2].isEmptyOrUndefinedOrNull()) {
                 if (!arguments[2].isString()) {
                     globalObject.throwInvalidArgumentType("verify", "algorithm", "string");
-                    return JSC.JSValue.undefined;
+                    return .zero;
                 }
 
                 const algorithm_string = arguments[2].getZigString(globalObject);
@@ -2325,23 +2325,23 @@ pub const Crypto = struct {
                     if (!globalObject.hasException()) {
                         globalObject.throwInvalidArgumentType("verify", "algorithm", unknown_password_algorithm_message);
                     }
-                    return JSC.JSValue.undefined;
+                    return .zero;
                 };
             }
 
             var password = JSC.Node.StringOrBuffer.fromJS(globalObject, bun.default_allocator, arguments[0]) orelse {
                 if (!globalObject.hasException()) {
                     globalObject.throwInvalidArgumentType("verify", "password", "string or TypedArray");
                 }
-                return JSC.JSValue.undefined;
+                return .zero;
             };
 
             var hash_ = JSC.Node.StringOrBuffer.fromJS(globalObject, bun.default_allocator, arguments[1]) orelse {
                 password.deinit();
                 if (!globalObject.hasException()) {
                     globalObject.throwInvalidArgumentType("verify", "hash", "string or TypedArray");
                 }
-                return JSC.JSValue.undefined;
+                return .zero;
             };
 
             defer password.deinit();
@@ -3225,7 +3225,7 @@ pub export fn Bun__escapeHTML16(globalObject: *JSC.JSGlobalObject, input_value:
     const input_slice = ptr[0..len];
     const escaped = strings.escapeHTMLForUTF16Input(globalObject.bunVM().allocator, input_slice) catch {
         globalObject.vm().throwError(globalObject, bun.String.static("Out of memory").toJS(globalObject));
-        return .undefined;
+        return .zero;
     };
 
     switch (escaped) {
@@ -3248,7 +3248,7 @@ pub export fn Bun__escapeHTML8(globalObject: *JSC.JSGlobalObject, input_value: J
 
     const escaped = strings.escapeHTMLForLatin1Input(allocator, input_slice) catch {
         globalObject.vm().throwError(globalObject, bun.String.static("Out of memory").toJS(globalObject));
-        return .undefined;
+        return .zero;
     };
 
     switch (escaped) {

diff --git a/src/bun.js/api/JSBundler.zig b/src/bun.js/api/JSBundler.zig
@@ -858,7 +858,7 @@ pub const JSBundler = struct {
         ) JSValue {
             if (this.called_defer) {
                 globalObject.throw("can't call .defer() more than once within an onLoad plugin", .{});
-                return .undefined;
+                return .zero;
             }
             this.called_defer = true;
 

diff --git a/src/bun.js/api/bun/h2_frame_parser.zig b/src/bun.js/api/bun/h2_frame_parser.zig
@@ -3254,7 +3254,7 @@ pub const H2FrameParser = struct {
         const args_list = callframe.arguments_old(1);
         if (args_list.len < 1) {
             globalObject.throw("Expected error argument", .{});
-            return .undefined;
+            return .zero;
         }
 
         var it = StreamResumableIterator.init(this);

diff --git a/src/bun.js/api/bun/socket.zig b/src/bun.js/api/bun/socket.zig
@@ -3465,11 +3465,13 @@ fn NewSocket(comptime ssl: bool) type {
                 // If BoringSSL gave us an error code, let's use it.
                 if (err != 0 and !globalObject.hasException()) {
                     globalObject.throwValue(BoringSSL.ERR_toJS(globalObject, err));
+                    return .zero;
                 }
 
                 // If BoringSSL did not give us an error code, let's throw a generic error.
                 if (!globalObject.hasException()) {
                     globalObject.throw("Failed to upgrade socket from TCP -> TLS. Is the TLS config correct?", .{});
+                    return .zero;
                 }
 
                 return JSValue.jsUndefined();

diff --git a/src/bun.js/api/filesystem_router.zig b/src/bun.js/api/filesystem_router.zig
@@ -287,7 +287,7 @@ pub const FileSystemRouter = struct {
 
         const url_path = URLPath.parse(path.slice()) catch |err| {
             globalThis.throw("{s} parsing path: {s}", .{ @errorName(err), path.slice() });
-            return JSValue.zero;
+            return .zero;
         };
         var params = Router.Param.List{};
         defer params.deinit(globalThis.allocator());

diff --git a/src/bun.js/api/glob.zig b/src/bun.js/api/glob.zig
@@ -113,7 +113,7 @@ const ScanOpts = struct {
                 return out;
             }
             globalThis.throw("{s}: expected first argument to be an object", .{fnName});
-            return null;
+            return error.JSError;
         }
 
         if (try optsObj.getTruthy(globalThis, "onlyFiles")) |only_files| {
@@ -135,7 +135,7 @@ const ScanOpts = struct {
         if (try optsObj.getTruthy(globalThis, "cwd")) |cwdVal| {
             if (!cwdVal.isString()) {
                 globalThis.throw("{s}: invalid `cwd`, not a string", .{fnName});
-                return null;
+                return error.JSError;
             }
 
             {
@@ -428,12 +428,12 @@ pub fn match(this: *Glob, globalThis: *JSGlobalObject, callframe: *JSC.CallFrame
     defer arguments.deinit();
     const str_arg = arguments.nextEat() orelse {
         globalThis.throw("Glob.matchString: expected 1 arguments, got 0", .{});
-        return .undefined;
+        return .zero;
     };
 
     if (!str_arg.isString()) {
         globalThis.throw("Glob.matchString: first argument is not a string", .{});
-        return .undefined;
+        return .zero;
     }
 
     var str = str_arg.toSlice(globalThis, arena.allocator());
@@ -446,13 +446,13 @@ pub fn match(this: *Glob, globalThis: *JSGlobalObject, callframe: *JSC.CallFrame
 
         var codepoints = std.ArrayList(u32).initCapacity(alloc, this.pattern.len * 2) catch {
             globalThis.throwOutOfMemory();
-            return .undefined;
+            return .zero;
         };
         errdefer codepoints.deinit();
 
         convertUtf8(&codepoints, this.pattern) catch {
             globalThis.throwOutOfMemory();
-            return .undefined;
+            return .zero;
         };
 
         this.pattern_codepoints = codepoints;

diff --git a/src/bun.js/api/server.zig b/src/bun.js/api/server.zig
@@ -5070,7 +5070,7 @@ pub const ServerWebSocket = struct {
 
         if (result.isAnyError()) {
             globalThis.throwValue(result);
-            return JSValue.jsUndefined();
+            return .zero;
         }
 
         return result;

diff --git a/src/bun.js/bindings/bindings.zig b/src/bun.js/bindings/bindings.zig
@@ -737,7 +737,7 @@ pub const ZigString = extern struct {
         if (len > String.max_length()) {
             bun.default_allocator.free(ptr[0..len]);
             global.ERR_STRING_TOO_LONG("Cannot create a string longer than 2^32-1 characters", .{}).throw();
-            return JSValue.zero;
+            return .zero;
         }
         return shim.cppFn("toExternalU16", .{ ptr, len, global });
     }
@@ -5723,8 +5723,10 @@ pub const JSValue = enum(i64) {
     }
 
     /// same as `JSValue.deepEquals`, but with jest asymmetric matchers enabled
-    pub fn jestDeepEquals(this: JSValue, other: JSValue, global: *JSGlobalObject) bool {
-        return cppFn("jestDeepEquals", .{ this, other, global });
+    pub fn jestDeepEquals(this: JSValue, other: JSValue, global: *JSGlobalObject) bun.JSError!bool {
+        const result = cppFn("jestDeepEquals", .{ this, other, global });
+        if (global.hasException()) return error.JSError;
+        return result;
     }
 
     pub fn strictDeepEquals(this: JSValue, other: JSValue, global: *JSGlobalObject) bool {
@@ -6483,7 +6485,7 @@ pub const VM = extern struct {
     // TODO: rewrite all `throwError` to use `JSError`
     pub fn throwError2(vm: *VM, global_object: *JSGlobalObject, value: JSValue) JSError {
         vm.throwError(global_object, value);
-        return JSError.JSError;
+        return error.JSError;
     }
 
     pub fn releaseWeakRefs(vm: *VM) void {
@@ -6770,6 +6772,14 @@ pub fn toJSHostFunction(comptime Function: JSHostZigFunction) JSC.JSHostFunction
             globalThis: *JSC.JSGlobalObject,
             callframe: *JSC.CallFrame,
         ) callconv(JSC.conv) JSC.JSValue {
+            if (bun.Environment.allow_assert and bun.Environment.is_canary) {
+                const value = Function(globalThis, callframe) catch |err| switch (err) {
+                    error.JSError => .zero,
+                    error.OutOfMemory => globalThis.throwOutOfMemoryValue(),
+                };
+                bun.assert((value == .zero) == globalThis.hasException());
+                return value;
+            }
             return @call(.always_inline, Function, .{ globalThis, callframe }) catch |err| switch (err) {
                 error.JSError => .zero,
                 error.OutOfMemory => globalThis.throwOutOfMemoryValue(),
@@ -6778,8 +6788,15 @@ pub fn toJSHostFunction(comptime Function: JSHostZigFunction) JSC.JSHostFunction
     }.function;
 }
 
-// XXX: temporary
 pub fn toJSHostValue(globalThis: *JSGlobalObject, value: error{ OutOfMemory, JSError }!JSValue) JSValue {
+    if (bun.Environment.allow_assert and bun.Environment.is_canary) {
+        const normal = value catch |err| switch (err) {
+            error.JSError => .zero,
+            error.OutOfMemory => globalThis.throwOutOfMemoryValue(),
+        };
+        bun.assert((normal == .zero) == globalThis.hasException());
+        return normal;
+    }
     return value catch |err| switch (err) {
         error.JSError => .zero,
         error.OutOfMemory => globalThis.throwOutOfMemoryValue(),