test: add maxCount and gcOptions to gcUntil()

PR-URL: #56522 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>

Author: joyeecheung

test/common/gc.js

@@ -3,6 +3,8 @@
 constwait=require('timers/promises').setTimeout;
 constassert=require('assert');
 constcommon=require('../common');
+// TODO(joyeecheung): rewrite checkIfCollectable to use this too.
+const{setImmediate: setImmediatePromisified}=require('timers/promises');
 constgcTrackerMap=newWeakMap();
 constgcTrackerTag='NODE_TEST_COMMON_GC_TRACKER';
 
@@ -40,32 +42,26 @@ function onGC(obj, gcListener){
 
 /**
  * Repeatedly triggers garbage collection until a specified condition is met or a maximum number of attempts is reached.
+ * This utillity must be run in a Node.js instance that enables --expose-gc.
  * @param{string|Function} [name] - Optional name, used in the rejection message if the condition is not met.
  * @param{Function} condition - A function that returns true when the desired condition is met.
+ * @param{number} maxCount - Maximum number of garbage collections that should be tried.
+ * @param{object} gcOptions - Options to pass into the global gc() function.
  * @returns{Promise} A promise that resolves when the condition is met, or rejects after 10 failed attempts.
  */
-functiongcUntil(name,condition){
-if(typeofname==='function'){
-condition=name;
-name=undefined;
-}
-returnnewPromise((resolve,reject)=>{
-letcount=0;
-functiongcAndCheck(){
-setImmediate(()=>{
-count++;
-global.gc();
-if(condition()){
-resolve();
-}elseif(count<10){
-gcAndCheck();
-}else{
-reject(name===undefined ? undefined : 'Test '+name+' failed');
-}
-});
+asyncfunctiongcUntil(name,condition,maxCount=10,gcOptions){
+for(letcount=0;count<maxCount;++count){
+awaitsetImmediatePromisified();
+if(gcOptions){
+awaitglobal.gc(gcOptions);
+}else{
+awaitglobal.gc();// Passing in undefined is not the same as empty.
 }
-gcAndCheck();
-});
+if(condition()){
+return;
+}
+}
+thrownewError(`Test ${name} failed`);
 }
 
 // This function can be used to check if an object factor leaks or not,