Merge pull request twilio#172 from twilio/feature/2-x-betterments

Merge Feature/2 x betterments

.circleci/config.yml

@@ -64,7 +64,7 @@ commands:
           key: dependency-cache-{{ checksum "package.json" }}
       - run:
           name: Installing dependencies
-          command: node -v && npm install --legacy-peer-deps
+          command: node -v && npm install
       - save_cache:
           key: dependency-cache-{{ checksum "package.json" }}
           paths:

.circleci/images/docker-compose.yml

@@ -30,7 +30,7 @@ services:
       - /opt/app/node_modules
   integrationTests: # runs integration tets. Expects that sources are mounted.
     <<: *runtimeDefaults
-    command: bash -c "npm install --legacy-peer-deps && npm run build && ls -la /root && ls -la /root/.npm && npm run test:network"
+    command: bash -c "npm install && npm run build && ls -la /root && ls -la /root/.npm && npm run test:network"
   bash: # runs bash shell inside container. helpful for debugging
     <<: *runtimeDefaults
     command: bash

CHANGELOG.md

@@ -4,9 +4,12 @@
 Changes
 -------
 
+- The SDK now builds on NodeJS versions 16 and above without the `--legacy-peer-deps` flag.
 - Removed usage of NodeJS modules from the SDK and some dependencies. With this change, the SDK should now work with some of the latest frameworks that use the latest versions of bundlers such as Vite and Webpack.
 - Removed unnecessary files from the generated npm package.
 - Links to source maps are now included in the generated npm package.
+- The `ws` package has been moved to `devDependencies`.
+- The SDK no longer depends on the `xmlhttprequest` npm package.
 - Migrated the `AudioPlayer` dependency and is now part of the SDK. This change fixes an issue where source maps are not properly loaded.
 
 2.5.0 (May 9, 2023)

lib/twilio/errors/generated.ts

@@ -2,8 +2,7 @@
 /**
  * @packageDocumentation
  * @module Voice
- * @publicapi
- * @internal
+ * @internalapi
  */
 
 /**

lib/twilio/request.ts

@@ -4,30 +4,18 @@
  * @internalapi
  */
 // @ts-nocheck
-import { XMLHttpRequest as XHR } from 'xmlhttprequest';
 
 function request(method, params, callback) {
-  const options = {};
-  options.XMLHttpRequest = options.XMLHttpRequest || XHR;
-  const xhr = new options.XMLHttpRequest();
+  const body = JSON.stringify(params.body || {});
+  const headers = new Headers();
 
-  xhr.open(method, params.url, true);
-  xhr.onreadystatechange = function onreadystatechange() {
-    if (xhr.readyState !== 4) { return; }
+  params.headers = params.headers || [];
+  Object.entries(params.headers).forEach(([headerName, headerBody]) =>
+    headers.append(headerName, headerBody));
 
-    if (200 <= xhr.status && xhr.status < 300) {
-      callback(null, xhr.responseText);
-      return;
-    }
-
-    callback(new Error(xhr.responseText));
-  };
-  // tslint:disable-next-line
-  for (const headerName in params.headers) {
-    xhr.setRequestHeader(headerName, params.headers[headerName]);
-  }
-
-  xhr.send(JSON.stringify(params.body));
+  fetch(params.url, { body, headers, method })
+    .then(response => response.text(), callback)
+    .then(responseText => callback(null, responseText), callback);
 }
 /**
  * Use XMLHttpRequest to get a network resource.

lib/twilio/statsMonitor.ts

@@ -170,7 +170,7 @@ class StatsMonitor extends EventEmitter {
   /**
    * The setInterval id for fetching samples.
    */
-  private _sampleInterval: NodeJS.Timer;
+  private _sampleInterval?: NodeJS.Timer;
 
   /**
    * Keeps track of supplemental sample values.
@@ -232,9 +232,10 @@ class StatsMonitor extends EventEmitter {
    * @returns The current {@link StatsMonitor}.
    */
   disable(): this {
-    clearInterval(this._sampleInterval);
-    delete this._sampleInterval;
-
+    if (this._sampleInterval) {
+      clearInterval(this._sampleInterval);
+      delete this._sampleInterval;
+    }
     return this;
   }
 

lib/twilio/wstransport.ts

@@ -5,11 +5,12 @@
  */
 
 import { EventEmitter } from 'events';
-import * as WebSocket from 'ws';
 import Backoff from './backoff';
 import { SignalingErrors } from './errors';
 import Log from './log';
 
+const WebSocket = globalThis.WebSocket;
+
 const CONNECT_SUCCESS_TIMEOUT = 10000;
 const CONNECT_TIMEOUT = 5000;
 const HEARTBEAT_TIMEOUT = 15000;