Assert console.log messages

Author: kraenhansen

apps/test-app/App.tsx

@@ -8,7 +8,7 @@ import {
   StatusText,
 } from "mocha-remote-react-native";
 
-import nodeAddonExamples from "@react-native-node-api/node-addon-examples";
+import { examples as nodeAddonExamples } from "@react-native-node-api/node-addon-examples";
 
 function loadTests() {
   for (const [suiteName, examples] of Object.entries(nodeAddonExamples)) {

apps/test-app/package.json

@@ -21,6 +21,7 @@
     "@react-native/metro-config": "0.79.0",
     "@react-native/typescript-config": "0.79.0",
     "@rnx-kit/metro-config": "^2.0.1",
+    "@types/mocha": "^10.0.10",
     "@types/react": "^19.0.0",
     "concurrently": "^9.1.2",
     "ferric-example": "^0.1.0",

apps/test-app/tsconfig.json

@@ -1,3 +1,8 @@
 {
-  "extends": "@react-native/typescript-config/tsconfig.json"
+  "extends": "@react-native/typescript-config/tsconfig.json",
+  "compilerOptions": {
+    "types": ["react-native", "mocha"]
+  },
+  "files": ["App.tsx", "index.ts"],
+  "references": [{ "path": "./tsconfig.node-scripts.json" }]
 }

package-lock.json

@@ -1,6 +1,7 @@
 {
   "name": "@react-native-node-api/node-addon-examples",
   "type": "commonjs",
+  "main": "dist/index.js",
   "private": true,
   "homepage": "https://github.com/callstackincubator/react-native-node-api",
   "repository": {

packages/node-addon-examples/index.js

@@ -5,7 +5,7 @@ export const EXAMPLES_DIR = path.resolve(import.meta.dirname, "../examples");
 export const TESTS_DIR = path.resolve(import.meta.dirname, "../tests");
 export const DIRS = [EXAMPLES_DIR, TESTS_DIR];
 
-export function findCMakeProjectsRecursively(dir): string[] {
+export function findCMakeProjectsRecursively(dir: string): string[] {
   let results: string[] = [];
   const files = readdirSync(dir);
 

packages/node-addon-examples/package.json

@@ -0,0 +1,102 @@
+/* eslint-disable @typescript-eslint/no-require-imports */
+
+function assertLogs(cb: () => void, expectedMessages: string[]) {
+  const errors: Error[] = [];
+  // Spying on the console.log function, as the examples don't assert anything themselves
+  const originalLog = console.log;
+  console.log = (message: string, ...args: unknown[]) => {
+    const nextMessage = expectedMessages.shift();
+    const combinedMessage = [message, ...args].map(String).join(" ");
+    if (nextMessage !== combinedMessage) {
+      errors.push(new Error(`Unexpected log message '${combinedMessage}'`));
+    }
+  };
+  try {
+    cb();
+    if (expectedMessages.length > 0) {
+      errors.push(
+        new Error(`Missing expected message(s): ${expectedMessages.join(", ")}`)
+      );
+    }
+  } finally {
+    console.log = originalLog;
+  }
+  // Throw and first error
+  const [firstError] = errors;
+  if (firstError) {
+    throw firstError;
+  }
+}
+
+export const examples: Record<string, Record<string, () => void>> = {
+  "1-getting-started": {
+    "1_hello_world/napi": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/1_hello_world/napi/hello.js"),
+        ["world"]
+      ),
+    "1_hello_world/node-addon-api": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/1_hello_world/node-addon-api/hello.js"),
+        ["world"]
+      ),
+    "1_hello_world/node-addon-api-addon-class": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/1_hello_world/node-addon-api-addon-class/hello.js"),
+        ["world"]
+      ),
+    "2_function_arguments/napi": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/2_function_arguments/napi/addon.js"),
+        ["This should be eight: 8"]
+      ),
+    "2_function_arguments/node-addon-api": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/2_function_arguments/node-addon-api/addon.js"),
+        ["This should be eight: 8"]
+      ),
+    "3_callbacks/napi": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/3_callbacks/napi/addon.js"),
+        ["hello world"]
+      ),
+    "3_callbacks/node-addon-api": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/3_callbacks/node-addon-api/addon.js"),
+        ["hello world"]
+      ),
+    "4_object_factory/napi": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/4_object_factory/napi/addon.js"),
+        ["hello world"]
+      ),
+    "4_object_factory/node-addon-api": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/4_object_factory/node-addon-api/addon.js"),
+        ["hello world"]
+      ),
+    "5_function_factory": () =>
+      assertLogs(
+        () =>
+          require("../examples/1-getting-started/5_function_factory/napi/addon.js"),
+        ["hello world"]
+      ),
+  },
+  "5-async-work": {
+    // TODO: This crashes (SIGABRT)
+    // "async_work_thread_safe_function": () => require("../examples/5-async-work/async_work_thread_safe_function/napi/index.js"),
+  },
+  tests: {
+    buffers: () => require("../tests/buffers/addon.js"),
+    async: () => require("./tests/async/addon.js"),
+  },
+};

packages/node-addon-examples/scripts/cmake-projects.mts

@@ -1,8 +1,7 @@
 {
-  "extends": "@tsconfig/node22/tsconfig.json",
-  "compilerOptions": {
-    "module": "node16",
-    "moduleResolution": "node16"
-  },
-  "include": ["scripts"]
+  "files": [],
+  "references": [
+    { "path": "./tsconfig.tests.json" },
+    { "path": "./tsconfig.node-scripts.json" }
+  ]
 }

packages/node-addon-examples/src/index.ts

@@ -0,0 +1,12 @@
+{
+  "extends": "@tsconfig/node22/tsconfig.json",
+  "compilerOptions": {
+    "composite": true,
+    "emitDeclarationOnly": true,
+    "outDir": "dist",
+    "rootDir": "scripts",
+    "types": ["node", "read-pkg"]
+  },
+  "include": ["scripts/**/*.mts"],
+  "exclude": []
+}