ci: instrument being able to run leaksanitizer

misctools/lldb/init.lldb

@@ -19,3 +19,6 @@ command script import -c bun_pretty_printer.py
 
 command script delete btjs
 command alias btjs p {printf("gathering btjs trace...\n");printf("%s\n", (char*)dumpBtjsTrace())}
+
+# do not pass SIGHUP on to child process. it is often not the real error and the stop point will be nonsensical.
+process handle -p false -s false -n true SIGHUP

scripts/runner.node.mjs

@@ -298,7 +298,7 @@ function getTestExpectations() {
   return expectations;
 }
 
-const skipArray = (() => {
+const skipsForExceptionValidation = (() => {
   const path = join(cwd, "test/no-validate-exceptions.txt");
   if (!existsSync(path)) {
     return [];
@@ -309,13 +309,32 @@ const skipArray = (() => {
     .filter(line => !line.startsWith("#") && line.length > 0);
 })();
 
+const skipsForLeaksan = (() => {
+  const path = join(cwd, "test/no-validate-leaksan.txt");
+  if (!existsSync(path)) {
+    return [];
+  }
+  return readFileSync(path, "utf-8")
+    .split("\n")
+    .filter(line => !line.startsWith("#") && line.length > 0);
+})();
+
 /**
  * Returns whether we should validate exception checks running the given test
  * @param {string} test
  * @returns {boolean}
  */
 const shouldValidateExceptions = test => {
-  return !(skipArray.includes(test) || skipArray.includes("test/" + test));
+  return !(skipsForExceptionValidation.includes(test) || skipsForExceptionValidation.includes("test/" + test));
+};
+
+/**
+ * Returns whether we should validate exception checks running the given test
+ * @param {string} test
+ * @returns {boolean}
+ */
+const shouldValidateLeakSan = test => {
+  return !(skipsForLeaksan.includes(test) || skipsForLeaksan.includes("test/" + test));
 };
 
 /**
@@ -400,7 +419,9 @@ async function runTests() {
 
   const okResults = [];
   const flakyResults = [];
+  const flakyResultsTitles = [];
   const failedResults = [];
+  const failedResultsTitles = [];
   const maxAttempts = 1 + (parseInt(options["retries"]) || 0);
 
   const parallelism = options["parallel"] ? availableParallelism() : 1;
@@ -436,6 +457,7 @@ async function runTests() {
       if (ok) {
         if (failure) {
           flakyResults.push(failure);
+          flakyResultsTitles.push(title);
         } else {
           okResults.push(result);
         }
@@ -455,6 +477,7 @@ async function runTests() {
       if (attempt >= maxAttempts || isAlwaysFailure(error)) {
         flaky = false;
         failedResults.push(failure);
+        failedResultsTitles.push(title);
         break;
       }
     }
@@ -567,6 +590,12 @@ async function runTests() {
               env.BUN_JSC_validateExceptionChecks = "1";
               env.BUN_JSC_dumpSimulatedThrows = "1";
             }
+            if ((basename(execPath).includes("asan") || !isCI) && shouldValidateLeakSan(testPath)) {
+              env.BUN_DESTRUCT_VM_ON_EXIT = "1";
+              env.ASAN_OPTIONS = "allow_user_segv_handler=1:disable_coredump=0:detect_leaks=1";
+              // prettier-ignore
+              env.LSAN_OPTIONS = `malloc_context_size=100:print_suppressions=0:suppressions=${process.cwd()}/test/leaksan.supp`;
+            }
             return runTest(title, async () => {
               const { ok, error, stdout, crashes } = await spawnBun(execPath, {
                 cwd: cwd,
@@ -809,14 +838,14 @@ async function runTests() {
 
     if (failedResults.length) {
       console.log(`${getAnsi("red")}Failing Tests:${getAnsi("reset")}`);
-      for (const { testPath } of failedResults) {
+      for (const testPath of failedResultsTitles) {
         console.log(`${getAnsi("red")}- ${testPath}${getAnsi("reset")}`);
       }
     }
 
     if (flakyResults.length) {
       console.log(`${getAnsi("yellow")}Flaky Tests:${getAnsi("reset")}`);
-      for (const { testPath } of flakyResults) {
+      for (const testPath of flakyResultsTitles) {
         console.log(`${getAnsi("yellow")}- ${testPath}${getAnsi("reset")}`);
       }
     }
@@ -1094,7 +1123,7 @@ async function spawnBun(execPath, { args, cwd, timeout, env, stdout, stderr }) {
       : { BUN_ENABLE_CRASH_REPORTING: "0" }),
   };
 
-  if (basename(execPath).includes("asan")) {
+  if (basename(execPath).includes("asan") && bunEnv.ASAN_OPTIONS === undefined) {
     bunEnv.ASAN_OPTIONS = "allow_user_segv_handler=1:disable_coredump=0";
   }
 
@@ -1250,17 +1279,17 @@ async function spawnBun(execPath, { args, cwd, timeout, env, stdout, stderr }) {
  *
  * @param {string} execPath
  * @param {string} testPath
- * @param {object} [options]
- * @param {string} [options.cwd]
- * @param {string[]} [options.args]
+ * @param {object} [opts]
+ * @param {string} [opts.cwd]
+ * @param {string[]} [opts.args]
  * @returns {Promise<TestResult>}
  */
-async function spawnBunTest(execPath, testPath, options = { cwd }) {
+async function spawnBunTest(execPath, testPath, opts = { cwd }) {
   const timeout = getTestTimeout(testPath);
   const perTestTimeout = Math.ceil(timeout / 2);
-  const absPath = join(options["cwd"], testPath);
+  const absPath = join(opts["cwd"], testPath);
   const isReallyTest = isTestStrict(testPath) || absPath.includes("vendor");
-  const args = options["args"] ?? [];
+  const args = opts["args"] ?? [];
 
   const testArgs = ["test", ...args, `--timeout=${perTestTimeout}`];
 
@@ -1291,10 +1320,16 @@ async function spawnBunTest(execPath, testPath, options = { cwd }) {
     env.BUN_JSC_validateExceptionChecks = "1";
     env.BUN_JSC_dumpSimulatedThrows = "1";
   }
+  if ((basename(execPath).includes("asan") || !isCI) && shouldValidateLeakSan(relative(cwd, absPath))) {
+    env.BUN_DESTRUCT_VM_ON_EXIT = "1";
+    env.ASAN_OPTIONS = "allow_user_segv_handler=1:disable_coredump=0:detect_leaks=1";
+    // prettier-ignore
+    env.LSAN_OPTIONS = `malloc_context_size=100:print_suppressions=0:suppressions=${process.cwd()}/test/leaksan.supp`;
+  }
 
   const { ok, error, stdout, crashes } = await spawnBun(execPath, {
     args: isReallyTest ? testArgs : [...args, absPath],
-    cwd: options["cwd"],
+    cwd: opts["cwd"],
     timeout: isReallyTest ? timeout : 30_000,
     env,
     stdout: options.stdout,
@@ -1528,7 +1563,11 @@ function isNodeTest(path) {
     return false;
   }
   const unixPath = path.replaceAll(sep, "/");
-  return unixPath.includes("js/node/test/parallel/") || unixPath.includes("js/node/test/sequential/");
+  return (
+    unixPath.includes("js/node/test/parallel/") ||
+    unixPath.includes("js/node/test/sequential/") ||
+    unixPath.includes("js/bun/test/parallel/")
+  );
 }
 
 /**

scripts/utils.mjs

@@ -2808,6 +2808,7 @@ export function endGroup() {
   } else {
     console.groupEnd();
   }
+  console.log();
 }
 
 export function printEnvironment() {

src/allocators.zig

@@ -229,6 +229,11 @@ pub fn BSSList(comptime ValueType: type, comptime _count: anytype) type {
                 this.data[index] = item;
                 return &this.data[index];
             }
+
+            pub fn deinit(this: *OverflowBlock) void {
+                if (this.prev) |p| p.deinit();
+                bun.default_allocator.destroy(this);
+            }
         };
 
         const Self = @This();
@@ -264,6 +269,12 @@ pub fn BSSList(comptime ValueType: type, comptime _count: anytype) type {
             return instance;
         }
 
+        pub fn deinit(self: *Self) void {
+            self.head.deinit();
+            bun.default_allocator.destroy(instance);
+            loaded = false;
+        }
+
         pub fn isOverflowing() bool {
             return instance.used >= @as(u16, count);
         }
@@ -350,6 +361,12 @@ pub fn BSSStringList(comptime _count: usize, comptime _item_length: usize) type
             return instance;
         }
 
+        pub fn deinit(self: *const Self) void {
+            _ = self;
+            bun.default_allocator.destroy(instance);
+            loaded = false;
+        }
+
         pub inline fn isOverflowing() bool {
             return instance.slice_buf_used >= @as(u16, count);
         }
@@ -530,6 +547,12 @@ pub fn BSSMap(comptime ValueType: type, comptime count: anytype, comptime store_
             return instance;
         }
 
+        pub fn deinit(self: *Self) void {
+            self.index.deinit(self.allocator);
+            bun.default_allocator.destroy(instance);
+            loaded = false;
+        }
+
         pub fn isOverflowing() bool {
             return instance.backing_buf_used >= @as(u16, count);
         }
@@ -653,6 +676,10 @@ pub fn BSSMap(comptime ValueType: type, comptime count: anytype, comptime store_
             // }
 
         }
+
+        pub fn values(self: *Self) []ValueType {
+            return (&self.backing_buf)[0..self.backing_buf_used];
+        }
     };
     if (!store_keys) {
         return BSSMapType;
@@ -684,6 +711,12 @@ pub fn BSSMap(comptime ValueType: type, comptime count: anytype, comptime store_
             return instance;
         }
 
+        pub fn deinit(self: *Self) void {
+            self.map.deinit();
+            bun.default_allocator.destroy(instance);
+            instance_loaded = false;
+        }
+
         pub fn isOverflowing() bool {
             return instance.map.backing_buf_used >= count;
         }

src/bun.js.zig

@@ -47,7 +47,7 @@ pub const Run = struct {
         vm.preload = ctx.preloads;
         vm.argv = ctx.passthrough;
         vm.arena = &run.arena;
-        vm.allocator = arena.allocator();
+        vm.allocator = vm.arena.allocator();
 
         b.options.install = ctx.install;
         b.resolver.opts.install = ctx.install;
@@ -185,7 +185,7 @@ pub const Run = struct {
         vm.preload = ctx.preloads;
         vm.argv = ctx.passthrough;
         vm.arena = &run.arena;
-        vm.allocator = arena.allocator();
+        vm.allocator = vm.arena.allocator();
 
         if (ctx.runtime_options.eval.script.len > 0) {
             const script_source = try bun.default_allocator.create(logger.Source);

src/bun.js/VirtualMachine.zig

@@ -838,7 +838,10 @@ extern fn Zig__GlobalObject__destructOnExit(*JSGlobalObject) void;
 
 pub fn globalExit(this: *VirtualMachine) noreturn {
     if (this.shouldDestructMainThreadOnExit()) {
+        if (this.eventLoop().forever_timer) |t| t.deinit(true);
         Zig__GlobalObject__destructOnExit(this.global);
+        this.transpiler.deinit();
+        this.gc_controller.deinit();
         this.deinit();
     }
     bun.Global.exit(this.exit_handler.exit_code);
@@ -1915,7 +1918,6 @@ pub fn processFetchLog(globalThis: *JSGlobalObject, specifier: bun.String, refer
     }
 }
 
-// TODO:
 pub fn deinit(this: *VirtualMachine) void {
     this.auto_killer.deinit();
 

src/bun.js/api/BunObject.zig

@@ -1814,7 +1814,7 @@ pub const JSZstd = struct {
             output = try allocator.realloc(output, compressed_size);
         }
 
-        return jsc.JSValue.createBuffer(globalThis, output, bun.default_allocator);
+        return jsc.JSValue.createBuffer(globalThis, output);
     }
 
     pub fn decompressSync(globalThis: *JSGlobalObject, callframe: *jsc.CallFrame) bun.JSError!JSValue {
@@ -1849,7 +1849,7 @@ pub const JSZstd = struct {
         // mimalloc doesn't care about the self-reported size of the slice.
         output.len = actual_size;
 
-        return jsc.JSValue.createBuffer(globalThis, output, bun.default_allocator);
+        return jsc.JSValue.createBuffer(globalThis, output);
     }
 
     // --- Async versions ---
@@ -1951,7 +1951,7 @@ pub const JSZstd = struct {
             }
 
             const output_slice = this.output;
-            const buffer_value = jsc.JSValue.createBuffer(globalThis, output_slice, bun.default_allocator);
+            const buffer_value = jsc.JSValue.createBuffer(globalThis, output_slice);
             this.output = &[_]u8{};
             promise.resolve(globalThis, buffer_value);
         }

src/bun.js/api/FFIObject.zig

@@ -582,7 +582,7 @@ pub fn toBuffer(
                 return jsc.JSValue.createBufferWithCtx(globalThis, slice, ctx, callback);
             }
 
-            return jsc.JSValue.createBuffer(globalThis, slice, null);
+            return jsc.JSValue.createBuffer(globalThis, slice);
         },
     }
 }

src/bun.js/api/JSTranspiler.zig

@@ -1014,7 +1014,7 @@ fn namedExportsToJS(global: *JSGlobalObject, named_exports: *JSAst.Ast.NamedExpo
     });
     var i: usize = 0;
     while (named_exports_iter.next()) |entry| {
-        names[i] = bun.String.cloneUTF8(entry.key_ptr.*);
+        names[i] = bun.String.fromBytes(entry.key_ptr.*);
         i += 1;
     }
     return bun.String.toJSArray(global, names);

src/bun.js/api/bun/socket.zig

@@ -830,7 +830,7 @@ pub fn NewSocket(comptime ssl: bool) type {
             };
         }
 
-        pub fn getRemoteAddress(this: *This, globalThis: *jsc.JSGlobalObject) JSValue {
+        pub fn getRemoteAddress(this: *This, globalThis: *jsc.JSGlobalObject) bun.JSError!JSValue {
             if (this.socket.isDetached()) {
                 return .js_undefined;
             }
@@ -846,7 +846,7 @@ pub fn NewSocket(comptime ssl: bool) type {
             };
 
             const text = bun.fmt.formatIp(address, &text_buf) catch unreachable;
-            return ZigString.init(text).toJS(globalThis);
+            return bun.String.createUTF8ForJS(globalThis, text);
         }
 
         pub fn getRemotePort(this: *This, _: *jsc.JSGlobalObject) JSValue {

src/bun.js/api/bun/socket/tls_socket_functions.zig

@@ -623,7 +623,7 @@ noinline fn getSSLException(globalThis: *jsc.JSGlobalObject, defaultMessage: []c
         const message = output_buf[0..written];
         zig_str = ZigString.init(bun.handleOom(std.fmt.allocPrint(bun.default_allocator, "OpenSSL {s}", .{message})));
         var encoded_str = zig_str.withEncoding();
-        encoded_str.mark();
+        encoded_str.markGlobal();
 
         // We shouldn't *need* to do this but it's not entirely clear.
         BoringSSL.ERR_clear_error();

src/bun.js/api/crypto/PBKDF2.zig

@@ -77,7 +77,7 @@ pub const Job = struct {
 
         const output_slice = this.output;
         assert(output_slice.len == @as(usize, @intCast(this.pbkdf2.length)));
-        const buffer_value = jsc.JSValue.createBuffer(globalThis, output_slice, bun.default_allocator);
+        const buffer_value = jsc.JSValue.createBuffer(globalThis, output_slice);
         this.output = &[_]u8{};
         promise.resolve(globalThis, buffer_value);
     }