Bring back check for unavailable functions

Author: cknitt

.github/workflows/ci.yml

@@ -313,7 +313,8 @@ jobs:
         run: node scripts/test.js -all
 
       - name: Docstrings tests
-        run: node tests/docstrings_examples/DocTest.res.mjs
+        # Ignore functions that are not available on Node 18
+        run: node tests/docstrings_examples/DocTest.res.mjs --ignore-runtime-tests "Array.toReversed, Array.toSorted, Promise.withResolvers, Set.union, Set.isSupersetOf, Set.isSubsetOf, Set.isDisjointFrom, Set.intersection, Set.symmetricDifference, Set.difference"
 
       - name: Check for diffs in tests folder
         run: git diff --ignore-cr-at-eol --exit-code tests

scripts/test.js

@@ -138,7 +138,7 @@ async function runTests() {
       });
       // Ignore some tests not supported by node v18
       // cp.execSync(
-      //   `node ${path.join("tests", "docstrings_examples", "DocTest.res.mjs")}"`,
+      //   `node ${path.join("tests", "docstrings_examples", "DocTest.res.mjs")} --ignore-runtime-tests "Array.toReversed, Array.toSorted, Promise.withResolvers, Set.union, Set.isSupersetOf, Set.isSubsetOf, Set.isDisjointFrom, Set.intersection, Set.symmetricDifference, Set.difference"`,
       //   {
       //     cwd: path.join(__dirname, ".."),
       //     stdio: [0, 1, 2],

tests/docstrings_examples/DocTest.res

@@ -15,6 +15,19 @@ type error =
 
 let bscBin = Path.join(["cli", "bsc"])
 
+let parsed = Util.parseArgs({
+  args: Process.argv->Array.sliceToEnd(~start=2),
+  options: dict{"ignore-runtime-tests": {Util.type_: "string"}},
+})
+
+let ignoreRuntimeTests = switch parsed.values->Dict.get("ignore-runtime-tests") {
+| Some(v) =>
+  v
+  ->String.split(",")
+  ->Array.map(s => s->String.trim)
+| None => []
+}
+
 let getOutput = buffer =>
   buffer
   ->Array.map(e => e->Buffer.toString)
@@ -172,7 +185,7 @@ let compileExamples = async examples => {
   (compiled, compilationErrors)
 }
 
-let runtimeTests = async code => {
+let runTest = async code => {
   let {stdout, stderr, code: exitCode} = await SpawnAsync.run(
     ~command="node",
     ~args=["-e", code, "--input-type", "commonjs"],
@@ -196,11 +209,13 @@ let runtimeTests = async code => {
 let runExamples = async compiled => {
   Console.log(`Running ${compiled->Array.length->Int.toString} compiled examples...`)
 
+  let tests = compiled->Array.filter((({id}, _, _)) => !(ignoreRuntimeTests->Array.includes(id)))
+
   let runtimeErrors = []
-  await compiled->ArrayUtils.forEachAsyncInBatches(~batchSize, async compiled => {
+  await tests->ArrayUtils.forEachAsyncInBatches(~batchSize, async compiled => {
     let (example, rescriptCode, jsCode) = compiled
 
-    switch await runtimeTests(jsCode) {
+    switch await runTest(jsCode) {
     | Ok(_) => ()
     | Error(error) =>
       let runtimeError = RuntimeError({rescript: rescriptCode, js: jsCode, error})

tests/docstrings_examples/DocTest.res.mjs

@@ -8,6 +8,7 @@ import * as Path from "path";
 import * as $$Array from "rescript/lib/es6/Array.js";
 import * as $$Error from "rescript/lib/es6/Error.js";
 import * as Belt_List from "rescript/lib/es6/Belt_List.js";
+import * as Nodeutil from "node:util";
 import * as ArrayUtils from "./ArrayUtils.res.mjs";
 import * as Belt_Array from "rescript/lib/es6/Belt_Array.js";
 import * as Pervasives from "rescript/lib/es6/Pervasives.js";
@@ -17,6 +18,19 @@ import * as RescriptTools_Docgen from "rescript/lib/es6/RescriptTools_Docgen.js"
 
 let bscBin = Path.join("cli", "bsc");
 
+let parsed = Nodeutil.parseArgs({
+  args: process.argv.slice(2),
+  options: {
+    "ignore-runtime-tests": {
+      type: "string"
+    }
+  }
+});
+
+let v = parsed.values["ignore-runtime-tests"];
+
+let ignoreRuntimeTests = v !== undefined ? v.split(",").map(s => s.trim()) : [];
+
 function getOutput(buffer) {
   return buffer.map(e => e.toString()).join("");
 }
@@ -38,7 +52,7 @@ async function extractDocFromFile(file) {
       RE_EXN_ID: "Assert_failure",
       _1: [
         "DocTest.res",
-        35,
+        48,
         9
       ],
       Error: new Error()
@@ -250,7 +264,7 @@ async function compileExamples(examples) {
   ];
 }
 
-async function runtimeTests(code) {
+async function runTest(code) {
   let match = await SpawnAsync.run("node", [
     "-e",
     code,
@@ -303,10 +317,11 @@ async function runtimeTests(code) {
 
 async function runExamples(compiled) {
   console.log("Running " + compiled.length.toString() + " compiled examples...");
+  let tests = compiled.filter(param => !ignoreRuntimeTests.includes(param[0].id));
   let runtimeErrors = [];
-  await ArrayUtils.forEachAsyncInBatches(compiled, batchSize, async compiled => {
+  await ArrayUtils.forEachAsyncInBatches(tests, batchSize, async compiled => {
     let jsCode = compiled[2];
-    let error = await runtimeTests(jsCode);
+    let error = await runTest(jsCode);
     if (error.TAG === "Ok") {
       return;
     }