feat!: remove useLegacyWDSSocket option (#498)

pmmmwh · web-flow · commit b3199647a850 · 2021-09-05T02:07:34.000+02:00
diff --git a/client/LegacyWDSSocketEntry.js b/client/LegacyWDSSocketEntry.js
diff --git a/docs/API.md b/docs/API.md
@@ -154,7 +154,6 @@ interface ErrorOverlayOptions {
   sockPath?: string;
   sockPort?: number;
   sockProtocol?: 'http' | 'https' | 'ws' | 'wss';
-  useLegacyWDSSockets?: boolean;
   useURLPolyfill?: boolean;
 }
 ```
@@ -269,29 +268,6 @@ Type: `http`, `https`, `ws` or `wss`
 Force a protocol for the error overlay to listen for Webpack build messages.
 Useful if you want to enforce https communication, or if you're working under a non-HTTP path.
 
-#### `useLegacyWDSSockets`
-
-Default: `undefined`
-
-Type: `boolean`
-
-**This is relevant for `webpack-dev-server` only.**
-
-Wraps the `SockJS` client from `webpack-dev-server` prior to version `3.7.0` to make it compatible with the plugin.
-
-You will also need to install `sockjs-client@1.3.0` as a peer dependency with one of the commands below:
-
-```sh
-# if you prefer npm
-npm install -D sockjs-client@1.3.0
-
-# if you prefer yarn
-yarn add -D sockjs-client@1.3.0
-
-# if you prefer pnpm
-pnpm add -D sockjs-client@1.3.0
-```
-
 #### `useURLPolyfill`
 
 Default: Detected from availability in the global scope
diff --git a/lib/options.json b/lib/options.json
@@ -50,7 +50,6 @@
         "sockPath": { "type": "string" },
         "sockPort": { "type": "number", "minimum": 0 },
         "sockProtocol": { "enum": ["http", "https", "ws", "wss"] },
-        "useLegacyWDSSockets": { "type": "boolean" },
         "useURLPolyfill": { "type": "boolean" }
       }
     }
diff --git a/lib/types.js b/lib/types.js
@@ -7,7 +7,6 @@
  * @property {string} [sockPath] The socket path to use (WDS only).
  * @property {number} [sockPort] The socket port to use (WDS only).
  * @property {'http' | 'https' | 'ws' | 'wss'} [sockProtocol] The socket protocol to use (WDS only).
- * @property {boolean} [useLegacyWDSSockets] Uses a custom SocketJS implementation for older versions of WDS.
  * @property {boolean} [useURLPolyfill] Uses a polyfill for the DOM URL API (WDS only).
  */
 
diff --git a/lib/utils/getAdditionalEntries.js b/lib/utils/getAdditionalEntries.js
@@ -50,10 +50,6 @@ function getAdditionalEntries({ devServer, options }) {
   ];
 
   const overlayEntries = [
-    // Legacy WDS SockJS integration
-    options.overlay &&
-      options.overlay.useLegacyWDSSockets &&
-      require.resolve('../../client/LegacyWDSSocketEntry'),
     // Error overlay runtime
     options.overlay &&
       options.overlay.entry &&
diff --git a/lib/utils/normalizeOptions.js b/lib/utils/normalizeOptions.js
@@ -33,7 +33,6 @@ const normalizeOptions = (options) => {
     d(overlay, 'sockPath');
     d(overlay, 'sockPort');
     d(overlay, 'sockProtocol');
-    d(options, 'useLegacyWDSSockets');
     d(options, 'useURLPolyfill');
 
     return overlay;
diff --git a/test/unit/getAdditionalEntries.test.js b/test/unit/getAdditionalEntries.test.js
@@ -24,22 +24,6 @@ describe('getAdditionalEntries', () => {
     });
   });
 
-  it('should append legacy WDS entry when required', () => {
-    expect(
-      getAdditionalEntries({
-        options: {
-          overlay: {
-            entry: ErrorOverlayEntry,
-            useLegacyWDSSockets: true,
-          },
-        },
-      })
-    ).toStrictEqual({
-      overlayEntries: [require.resolve('../../client/LegacyWDSSocketEntry'), ErrorOverlayEntry],
-      prependEntries: [ReactRefreshEntry],
-    });
-  });
-
   it('should append resource queries to the overlay entry when specified in overlay options', () => {
     expect(
       getAdditionalEntries({
diff --git a/test/unit/normalizeOptions.test.js b/test/unit/normalizeOptions.test.js
@@ -31,7 +31,6 @@ describe('normalizeOptions', () => {
           sockPath: '/socket',
           sockPort: 9000,
           sockProtocol: 'https',
-          useLegacyWDSSockets: true,
           useURLPolyfill: true,
         },
       })
@@ -48,7 +47,6 @@ describe('normalizeOptions', () => {
         sockPath: '/socket',
         sockPort: 9000,
         sockProtocol: 'https',
-        useLegacyWDSSockets: true,
         useURLPolyfill: true,
       },
     });
diff --git a/test/unit/validateOptions.test.js b/test/unit/validateOptions.test.js
@@ -145,11 +145,11 @@ describe('validateOptions', () => {
     }).toThrowErrorMatchingInlineSnapshot(`
       "Invalid options object. React Refresh Plugin has been initialized using an options object that does not match the API schema.
        - options.overlay should be one of these:
-         boolean | object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useLegacyWDSSockets?, useURLPolyfill? }
+         boolean | object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useURLPolyfill? }
          Details:
           * options.overlay should be a boolean.
           * options.overlay should be an object:
-            object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useLegacyWDSSockets?, useURLPolyfill? }"
+            object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useURLPolyfill? }"
     `);
   });
 
@@ -185,7 +185,7 @@ describe('validateOptions', () => {
     }).toThrowErrorMatchingInlineSnapshot(`
       "Invalid options object. React Refresh Plugin has been initialized using an options object that does not match the API schema.
        - options.overlay should be one of these:
-         boolean | object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useLegacyWDSSockets?, useURLPolyfill? }
+         boolean | object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useURLPolyfill? }
          Details:
           * options.overlay.entry should be one of these:
             false | string
@@ -227,7 +227,7 @@ describe('validateOptions', () => {
     }).toThrowErrorMatchingInlineSnapshot(`
       "Invalid options object. React Refresh Plugin has been initialized using an options object that does not match the API schema.
        - options.overlay should be one of these:
-         boolean | object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useLegacyWDSSockets?, useURLPolyfill? }
+         boolean | object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useURLPolyfill? }
          Details:
           * options.overlay.module should be one of these:
             false | string
@@ -293,7 +293,7 @@ describe('validateOptions', () => {
     }).toThrowErrorMatchingInlineSnapshot(`
       "Invalid options object. React Refresh Plugin has been initialized using an options object that does not match the API schema.
        - options.overlay should be one of these:
-         boolean | object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useLegacyWDSSockets?, useURLPolyfill? }
+         boolean | object { entry?, module?, sockIntegration?, sockHost?, sockPath?, sockPort?, sockProtocol?, useURLPolyfill? }
          Details:
           * options.overlay.sockIntegration should be one of these:
             false | \\"wds\\" | \\"whm\\" | \\"wps\\" | string
@@ -409,33 +409,6 @@ describe('validateOptions', () => {
     `);
   });
 
-  it('should accept "overlay.useLegacyWDSSockets" when it is true', () => {
-    expect(() => {
-      new ReactRefreshPlugin({
-        overlay: { useLegacyWDSSockets: true },
-      });
-    }).not.toThrow();
-  });
-
-  it('should accept "overlay.useLegacyWDSSockets" when it is false', () => {
-    expect(() => {
-      new ReactRefreshPlugin({
-        overlay: { useLegacyWDSSockets: false },
-      });
-    }).not.toThrow();
-  });
-
-  it('should reject "overlay.useLegacyWDSSockets" when it is not a boolean', () => {
-    expect(() => {
-      new ReactRefreshPlugin({
-        overlay: { useLegacyWDSSockets: 1 },
-      });
-    }).toThrowErrorMatchingInlineSnapshot(`
-      "Invalid options object. React Refresh Plugin has been initialized using an options object that does not match the API schema.
-       - options.overlay.useLegacyWDSSockets should be a boolean."
-    `);
-  });
-
   it('should reject any unknown options', () => {
     expect(() => {
       new ReactRefreshPlugin({ unknown: true });
diff --git a/types/lib/types.d.ts b/types/lib/types.d.ts
@@ -29,10 +29,6 @@ export type ErrorOverlayOptions = {
    * The socket protocol to use (WDS only).
    */
   sockProtocol?: 'http' | 'https' | 'ws' | 'wss' | undefined;
-  /**
-   * Uses a custom SocketJS implementation for older versions of WDS.
-   */
-  useLegacyWDSSockets?: boolean | undefined;
   /**
    * Uses a polyfill for the DOM URL API (WDS only).
    */

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,6 @@`
`50`	`50`	`"sockPath": { "type": "string" },`
`51`	`51`	`"sockPort": { "type": "number", "minimum": 0 },`
`52`	`52`	`"sockProtocol": { "enum": ["http", "https", "ws", "wss"] },`
`53`		`- "useLegacyWDSSockets": { "type": "boolean" },`
`54`	`53`	`"useURLPolyfill": { "type": "boolean" }`
`55`	`54`	`}`
`56`	`55`	`}`