lib: add EventSource Client

Uzlopak · targos · commit ee56aecced2f · 2024-06-01T10:54:53.000+02:00
PR-URL: #51575 Reviewed-By: Benjamin Gruenbaum <benjamingr@gmail.com> Reviewed-By: Matthew Aitken <maitken033380023@gmail.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -350,6 +350,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
@@ -851,6 +851,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
@@ -2706,6 +2714,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`
@@ -3216,6 +3225,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
@@ -185,6 +185,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/.eslintrc.yaml b/lib/.eslintrc.yaml
@@ -154,6 +154,8 @@ rules:
       message: Use `const { Crypto } = require('internal/crypto/webcrypto');` instead of the global.
     - name: CryptoKey
       message: Use `const { CryptoKey } = require('internal/crypto/webcrypto');` instead of the global.
+    - name: EventSource
+      message: Use `const { EventSource } = require('internal/deps/undici/undici');` instead of the global.
     - name: fetch
       message: Use `const { fetch } = require('internal/deps/undici/undici');` instead of the global.
     - name: global
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', 'MessageEvent',
 ]);
 
+// 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
@@ -107,6 +107,7 @@ function prepareExecution(options) {
   setupUndici();
   setupWebCrypto();
   setupCustomEvent();
+  setupEventsource();
   setupCodeCoverage();
   setupDebugEnv();
   // Process initial diagnostic reporting configuration, if present.
@@ -321,6 +322,13 @@ function setupUndici() {
   }
 }
 
+// https://html.spec.whatwg.org/multipage/server-sent-events.html
+function setupEventsource() {
+  if (!getOptionValue('--experimental-eventsource')) {
+    delete globalThis.EventSource;
+  }
+}
+
 // TODO(aduh95): move this to internal/bootstrap/web/* when the CLI flag is
 //               removed.
 function setupNavigator() {
diff --git a/src/node_options.cc b/src/node_options.cc
@@ -398,6 +398,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
@@ -115,6 +115,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
@@ -325,6 +325,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');

Original file line number	Diff line number	Diff line change
`@@ -185,6 +185,9 @@ Use this flag to enable ShadowRealm support.`
`185`	`185`	`.It Fl -experimental-test-coverage`
`186`	`186`	`Enable code coverage in the test runner.`
`187`	`187`	`.`
	`188`	`+.It Fl -experimental-eventsource`
	`189`	`+Enable experimental support for the EventSource Web API.`
	`190`	`+.`
`188`	`191`	`.It Fl -no-experimental-fetch`
`189`	`192`	`Disable experimental support for the Fetch API.`
`190`	`193`	`.`
Original file line number	Diff line number	Diff line change
`@@ -325,6 +325,10 @@ if (global.structuredClone) {`
`325`	`325`	`knownGlobals.push(global.structuredClone);`
`326`	`326`	`}`
`327`	`327`
	`328`	`+if (global.EventSource) {`
	`329`	`+ knownGlobals.push(EventSource);`
	`330`	`+}`
	`331`	`+`
`328`	`332`	`if (global.fetch) {`
`329`	`333`	`knownGlobals.push(fetch);`
`330`	`334`	`}`