fix: add integration tests for commonjs and enhance entrypoint discovery (#503)

* chore: add/update integration tests for import_map feature

* fix: check main field in package.json as well if byonm is enabled

* chore: add integration tests for commonjs

* chore: add examples for commonjs

Author: nyannyacha

crates/base/src/runtime/mod.rs

@@ -35,6 +35,7 @@ use deno::deno_http;
 use deno::deno_http::DefaultHttpPropertyExtractor;
 use deno::deno_io;
 use deno::deno_net;
+use deno::deno_package_json;
 use deno::deno_telemetry;
 use deno::deno_tls;
 use deno::deno_tls::deno_native_certs::load_native_certs;
@@ -528,7 +529,7 @@ where
           }
         }
         if !is_some_entry_point && !found {
-          bail!("could not find an appropriate entrypoint");
+          main_module_url = Some(base_dir_url.clone());
         }
       }
       if is_some_entry_point {
@@ -561,11 +562,22 @@ where
 
       let mut builder = DenoOptionsBuilder::new();
 
-      if let Some(module_url) = main_module_url {
+      if let Some(module_url) = main_module_url.as_ref() {
         builder.set_entrypoint(Some(module_url.to_file_path().unwrap()));
       }
       emitter_factory.set_deno_options(builder.build()?);
 
+      let deno_options = emitter_factory.deno_options()?;
+      if !is_some_entry_point
+        && main_module_url.is_some_and(|it| it == base_dir_url)
+        && deno_options
+          .workspace()
+          .root_pkg_json()
+          .and_then(|it| it.main(deno_package_json::NodeModuleKind::Cjs))
+          .is_none()
+      {
+        bail!("could not find an appropriate entrypoint");
+      }
       let mut metadata = Metadata::default();
       let eszip = generate_binary_eszip(
         &mut metadata,

crates/base/src/utils/test_utils.rs

@@ -1,44 +1,45 @@
 #![allow(dead_code)]
 
 use std::marker::PhantomPinned;
+use std::path::Path;
 use std::path::PathBuf;
 use std::sync::Arc;
 use std::task::ready;
 use std::task::Poll;
 use std::time::Duration;
 
-use crate::server::ServerFlags;
-use crate::worker::pool::SupervisorPolicy;
-use crate::worker::pool::WorkerPoolPolicy;
-use crate::worker::TerminationToken;
-use crate::worker::{self};
-
 use anyhow::bail;
 use anyhow::Context;
 use anyhow::Error;
 use either::Either::Right;
 use ext_event_worker::events::WorkerEventWithMetadata;
+use ext_workers::context::MainWorkerRuntimeOpts;
+use ext_workers::context::Timing;
+use ext_workers::context::UserWorkerRuntimeOpts;
+use ext_workers::context::WorkerContextInitOpts;
+use ext_workers::context::WorkerRequestMsg;
+use ext_workers::context::WorkerRuntimeOpts;
 use futures_util::future::BoxFuture;
 use futures_util::Future;
 use futures_util::FutureExt;
 use http_v02::Request;
 use http_v02::Response;
 use hyper_v014::Body;
 use pin_project::pin_project;
-
-use ext_workers::context::MainWorkerRuntimeOpts;
-use ext_workers::context::Timing;
-use ext_workers::context::UserWorkerRuntimeOpts;
-use ext_workers::context::WorkerContextInitOpts;
-use ext_workers::context::WorkerRequestMsg;
-use ext_workers::context::WorkerRuntimeOpts;
 use scopeguard::ScopeGuard;
+use tokio::process::Command;
 use tokio::sync::mpsc;
 use tokio::sync::oneshot;
 use tokio::sync::Notify;
 use tokio::time::timeout;
 use tokio_util::sync::CancellationToken;
 
+use crate::server::ServerFlags;
+use crate::worker;
+use crate::worker::pool::SupervisorPolicy;
+use crate::worker::pool::WorkerPoolPolicy;
+use crate::worker::TerminationToken;
+
 pub struct CreateTestUserWorkerArgs(
   WorkerContextInitOpts,
   Option<SupervisorPolicy>,
@@ -372,6 +373,31 @@ pub fn test_user_runtime_opts() -> UserWorkerRuntimeOpts {
   }
 }
 
+pub async fn ensure_npm_package_installed<P>(path: P)
+where
+  P: AsRef<Path>,
+{
+  let cwd = std::env::current_dir().unwrap();
+  let path = cwd.join(path);
+
+  assert!(path.is_dir());
+
+  let output = Command::new("npm")
+    .current_dir(path)
+    .arg("i")
+    .output()
+    .await
+    .unwrap();
+
+  if !output.status.success() {
+    let stdout = String::from_utf8_lossy(&output.stdout);
+    let stderr = String::from_utf8_lossy(&output.stderr);
+    panic!(
+      "failed to execute npm command\n\nSTDOUT: ${stdout}\n\nSTDERR: ${stderr}"
+    );
+  }
+}
+
 async fn wait_termination(token: TerminationToken) {
   token.outbound.cancelled().await;
 }

crates/base/test_cases/commonjs-custom-main/meow.js

@@ -0,0 +1,13 @@
+const http = require("http");
+
+console.log(require);
+
+const server = http.createServer((_, resp) => {
+  resp.writeHead(200, {
+    "content-type": "text-plain",
+  });
+  resp.write("meow");
+  resp.end();
+});
+
+server.listen(8080);

crates/base/test_cases/commonjs-custom-main/package.json

@@ -0,0 +1,5 @@
+{
+  "workspaces": [],
+  "type": "commonjs",
+  "main": "meow.js"
+}

crates/base/test_cases/commonjs-express-websocket/index.js

@@ -0,0 +1,15 @@
+const express = require("express");
+const app = express();
+const expressWs = require("express-ws")(app);
+const port = 8080;
+
+expressWs.app.ws("/commonjs-express-websocket", (ws) => {
+  ws.send("meow");
+  ws.on("message", (msg) => {
+    ws.send(msg);
+  });
+});
+
+app.listen(port, () => {
+  console.log(`app listening on port ${port}`);
+});

crates/base/test_cases/commonjs-express-websocket/package.json

@@ -0,0 +1,12 @@
+{
+  "workspaces": [],
+  "type": "commonjs",
+  "main": "index.js",
+  "dependencies": {
+    "express": "^4.21.2",
+    "express-ws": "^5.0.2"
+  },
+  "devDependencies": {
+    "@types/express-ws": "^3.0.5"
+  }
+}

crates/base/test_cases/commonjs-express/index.js

@@ -0,0 +1,13 @@
+const express = require("express");
+const app = express();
+const port = 8080;
+
+console.log(require);
+
+app.get("/commonjs-express", (_, res) => {
+  res.send("meow");
+});
+
+app.listen(port, () => {
+  console.log(`app listening on port ${port}`);
+});

crates/base/test_cases/commonjs-express/package.json

@@ -0,0 +1,8 @@
+{
+  "workspaces": [],
+  "type": "commonjs",
+  "main": "index.js",
+  "dependencies": {
+    "express": "^4.21.2"
+  }
+}

crates/base/test_cases/commonjs-hono-websocket/index.js

@@ -0,0 +1,29 @@
+const { serve } = require("@hono/node-server");
+const { Hono } = require("hono");
+const { createNodeWebSocket } = require("@hono/node-ws");
+
+const app = new Hono();
+const { upgradeWebSocket, injectWebSocket } = createNodeWebSocket({ app });
+const port = 8080;
+
+app.get(
+  "/commonjs-hono-websocket",
+  upgradeWebSocket(() => {
+    return {
+      onOpen(_evt, ws) {
+        ws.send("meow");
+      },
+      onMessage(evt, ws) {
+        ws.send(evt.data);
+      },
+    };
+  }),
+);
+
+const server = serve({
+  fetch: app.fetch,
+  port,
+  overrideGlobalObjects: false,
+});
+
+injectWebSocket(server);

crates/base/test_cases/commonjs-hono-websocket/package.json

@@ -0,0 +1,9 @@
+{
+  "workspaces": [],
+  "type": "commonjs",
+  "dependencies": {
+    "@hono/node-server": "^1.13.8",
+    "@hono/node-ws": "^1.1.0",
+    "hono": "^4.7.2"
+  }
+}