lib: add EventSource Client

nodejs · Apr 14, 2024 · c06cd4c · c06cd4c
1 parent f8e325e
commit c06cd4c
Show file tree

Hide file tree

Showing 11 changed files with 45 additions and 1 deletion.
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -341,6 +341,7 @@ module.exports = {
     Crypto: 'readable',
     CryptoKey: 'readable',
     DecompressionStream: 'readable',
+    EventSource: 'readable',
     fetch: 'readable',
     FormData: 'readable',
     navigator: 'readable',

diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -808,6 +808,14 @@ CommonJS. This includes the following:
 * Lexical redeclarations of the CommonJS wrapper variables (`require`, `module`,
   `exports`, `__dirname`, `__filename`).
 
+### `--experimental-eventsource`
+
+<!-- YAML
+added: REPLACEME
+-->
+
+Enable exposition of [EventSource Web API][] on the global scope.
+
 ### `--experimental-import-meta-resolve`
 
 <!-- YAML
@@ -2603,6 +2611,7 @@ one is included in the list below.
 * `--experimental-abortcontroller`
 * `--experimental-default-type`
 * `--experimental-detect-module`
+* `--experimental-eventsource`
 * `--experimental-import-meta-resolve`
 * `--experimental-json-modules`
 * `--experimental-loader`
@@ -3113,6 +3122,7 @@ node --stack-trace-limit=12 -p -e "Error.stackTraceLimit" # prints 12
 [CustomEvent Web API]: https://dom.spec.whatwg.org/#customevent
 [DEP0025 warning]: deprecations.md#dep0025-requirenodesys
 [ECMAScript module]: esm.md#modules-ecmascript-modules
+[EventSource Web API]: https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events
 [ExperimentalWarning: `vm.measureMemory` is an experimental feature]: vm.md#vmmeasurememoryoptions
 [Fetch API]: https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API
 [File System Permissions]: permissions.md#file-system-permissions

diff --git a/doc/node.1 b/doc/node.1
@@ -183,6 +183,9 @@ Use this flag to enable ShadowRealm support.
 .It Fl -experimental-test-coverage
 Enable code coverage in the test runner.
 .
+.It Fl -experimental-eventsource
+Enable experimental support for the EventSource Web API.
+.
 .It Fl -no-experimental-fetch
 Disable experimental support for the Fetch API.
 .

diff --git a/lib/internal/bootstrap/web/exposed-window-or-worker.js b/lib/internal/bootstrap/web/exposed-window-or-worker.js
@@ -81,8 +81,9 @@ exposeLazyInterfaces(globalThis, 'internal/deps/undici/undici', [
   'FormData', 'Headers', 'Request', 'Response',
 ]);
 
+// https://html.spec.whatwg.org/multipage/server-sent-events.html#server-sent-events.org/
 // https://websockets.spec.whatwg.org/
-exposeLazyInterfaces(globalThis, 'internal/deps/undici/undici', ['WebSocket']);
+exposeLazyInterfaces(globalThis, 'internal/deps/undici/undici', ['EventSource', 'WebSocket']);
 
 // The WebAssembly Web API which relies on Response.
 // https:// webassembly.github.io/spec/web-api/#streaming-modules

diff --git a/lib/internal/process/pre_execution.js b/lib/internal/process/pre_execution.js
@@ -312,9 +312,14 @@ function setupWarningHandler() {
   }
 }
 
+// https://html.spec.whatwg.org/multipage/server-sent-events.html
 // https://fetch.spec.whatwg.org/
 // https://websockets.spec.whatwg.org/
 function setupUndici() {
+  if (!getOptionValue('--experimental-eventsource')) {
+    delete globalThis.EventSource;
+  }
+
   if (getOptionValue('--no-experimental-fetch')) {
     delete globalThis.fetch;
     delete globalThis.FormData;

diff --git a/src/node_options.cc b/src/node_options.cc
@@ -390,6 +390,11 @@ EnvironmentOptionsParser::EnvironmentOptionsParser() {
             &EnvironmentOptions::enable_source_maps,
             kAllowedInEnvvar);
   AddOption("--experimental-abortcontroller", "", NoOp{}, kAllowedInEnvvar);
+  AddOption("--experimental-eventsource",
+            "experimental EventSource API",
+            &EnvironmentOptions::experimental_eventsource,
+            kAllowedInEnvvar,
+            false);
   AddOption("--experimental-fetch",
             "experimental Fetch API",
             &EnvironmentOptions::experimental_fetch,

diff --git a/src/node_options.h b/src/node_options.h
@@ -109,6 +109,7 @@ class EnvironmentOptions : public Options {
   bool require_module = false;
   std::string dns_result_order;
   bool enable_source_maps = false;
+  bool experimental_eventsource = false;
   bool experimental_fetch = true;
   bool experimental_websocket = true;
   bool experimental_global_customevent = true;

diff --git a/test/common/globals.js b/test/common/globals.js
@@ -125,6 +125,7 @@ const webIdlExposedWindow = new Set([
   'Request',
   'Response',
   'WebSocket',
+  'EventSource',
 ]);
 
 const nodeGlobals = new Set([

diff --git a/test/common/index.js b/test/common/index.js
@@ -336,6 +336,10 @@ if (global.structuredClone) {
   knownGlobals.push(global.structuredClone);
 }
 
+if (global.EventSource) {
+  knownGlobals.push(EventSource);
+}
+
 if (global.fetch) {
   knownGlobals.push(fetch);
 }

diff --git a/test/parallel/test-eventsource-disabled.js b/test/parallel/test-eventsource-disabled.js
@@ -0,0 +1,6 @@
+'use strict';
+
+require('../common');
+const assert = require('assert');
+
+assert.strictEqual(typeof EventSource, 'undefined');
diff --git a/test/parallel/test-eventsource.js b/test/parallel/test-eventsource.js
@@ -0,0 +1,7 @@
+// Flags: --experimental-eventsource
+'use strict';
+
+require('../common');
+const assert = require('assert');
+
+assert.strictEqual(typeof EventSource, 'function');