Merge pull request #171 from whereby/kevinhanna/test-node-core-export

kevinwhereby · web-flow · commit 821908f798d4 · 2024-01-30T19:19:32.000Z
Add Core SDK export for Node client
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
     "name": "@whereby.com/browser-sdk",
-    "version": "2.1.0-beta2",
+    "version": "2.1.0-beta3",
     "description": "Modules for integration Whereby video in web apps",
     "author": "Whereby AS",
     "license": "MIT",
@@ -11,6 +11,10 @@
     "browserslist": "> 0.5%, last 2 versions, not dead",
     "source": "src/index.js",
     "exports": {
+        "./core": {
+            "import": "./dist/core/index.js",
+            "types": "./dist/core/index.d.ts"
+        },
         "./react": {
             "import": "./dist/react/index.esm.js",
             "types": "./dist/react/index.d.ts"
@@ -26,6 +30,9 @@
     },
     "typesVersions": {
         "*": {
+            "core": [
+                "dist/core/index.d.ts"
+            ],
             "react": [
                 "dist/react/index.d.ts"
             ],
@@ -109,7 +116,7 @@
     "dependencies": {
         "@reduxjs/toolkit": "^2.0.1",
         "@swc/helpers": "^0.3.13",
-        "@whereby/jslib-media": "whereby/jslib-media.git#1.4.1",
+        "@whereby/jslib-media": "whereby/jslib-media.git#1.7.2",
         "axios": "^1.2.3",
         "btoa": "^1.2.1",
         "events": "^3.3.0",
diff --git a/rollup.config.js b/rollup.config.js
@@ -1,3 +1,5 @@
+const dotenv = require("dotenv");
+dotenv.config();
 const nodeResolve = require("@rollup/plugin-node-resolve");
 const commonjs = require("@rollup/plugin-commonjs");
 const json = require("@rollup/plugin-json");
@@ -65,6 +67,24 @@ const plugins = [
 ];
 
 module.exports = [
+    {
+        input: "src/lib/core/index.ts",
+        output: {
+            exports: "named",
+            file: "dist/core/index.js",
+            format: "cjs",
+        },
+        plugins: [
+            nodeResolve({
+                browser: false,
+                preferBuiltins: true,
+            }),
+            commonjs(),
+            json(),
+            replace(replaceValues),
+            typescript(),
+        ],
+    },
     // Esm build of lib, to be used with bundlers
     {
         input: "src/lib/react/index.ts",
@@ -96,7 +116,6 @@ module.exports = [
         external: ["heresy", ...peerDependencies],
         plugins,
     },
-
     // CDN builds
     {
         input: "src/lib/embed/index.ts",
@@ -136,6 +155,12 @@ module.exports = [
     },
 
     // Type definitions
+    {
+        input: "src/lib/core/index.ts",
+        output: [{ file: "dist/core/index.d.ts", format: "es" }],
+        external: ["@whereby/jslib-media/src/webrtc/RtcManager"],
+        plugins: [dts()],
+    },
     {
         input: "src/lib/react/index.ts",
         output: [{ file: "dist/react/index.d.ts", format: "es" }],
diff --git a/src/lib/core/index.ts b/src/lib/core/index.ts
@@ -0,0 +1,10 @@
+export * from "./redux/thunk";
+export * from "./redux/store";
+export * from "./redux/listenerMiddleware";
+export * from "../services";
+export * from "./redux/slices/roomConnection";
+export * from "./redux/slices/app";
+export * from "./redux/slices/remoteParticipants";
+export * from "./redux/slices/rtcConnection";
+export * from "./redux/slices/signalConnection";
+export * from "../version";
diff --git a/src/lib/core/redux/slices/__tests__/app.unit.ts b/src/lib/core/redux/slices/__tests__/app.unit.ts
@@ -22,6 +22,7 @@ describe("appSlice", () => {
                 displayName: "displayName",
                 sdkVersion: "sdkVersion",
                 externalId: "externalId",
+                isNodeSdk: true,
             });
         });
 
diff --git a/src/lib/core/redux/slices/__tests__/localMedia.unit.ts b/src/lib/core/redux/slices/__tests__/localMedia.unit.ts
@@ -4,21 +4,23 @@ describe("localMediaSlice", () => {
     describe("reactors", () => {
         describe("reactLocalMediaStart", () => {
             it.each`
-                appWantsToJoin | localMediaStatus | localMediaOptions               | expected
-                ${false}       | ${""}            | ${undefined}                    | ${undefined}
-                ${false}       | ${"started"}     | ${undefined}                    | ${undefined}
-                ${false}       | ${"started"}     | ${{ audio: true, video: true }} | ${undefined}
-                ${true}        | ${"started"}     | ${{ audio: true, video: true }} | ${undefined}
-                ${true}        | ${""}            | ${undefined}                    | ${undefined}
-                ${true}        | ${""}            | ${{ audio: true, video: true }} | ${{ audio: true, video: true }}
+                appWantsToJoin | localMediaStatus | localMediaOptions               | isNodeSdk | expected
+                ${false}       | ${""}            | ${undefined}                    | ${false}  | ${undefined}
+                ${false}       | ${"started"}     | ${undefined}                    | ${false}  | ${undefined}
+                ${false}       | ${"started"}     | ${{ audio: true, video: true }} | ${false}  | ${undefined}
+                ${true}        | ${"started"}     | ${{ audio: true, video: true }} | ${false}  | ${undefined}
+                ${true}        | ${""}            | ${undefined}                    | ${false}  | ${undefined}
+                ${true}        | ${""}            | ${{ audio: true, video: true }} | ${true}   | ${undefined}
+                ${true}        | ${""}            | ${{ audio: true, video: true }} | ${false}  | ${{ audio: true, video: true }}
             `(
-                "expected $expected when appWantsToJoin=$appWantsToJoin, localMediaStatus=$localMediaStatus, localMediaOptions=$localMediaOptions",
-                ({ appWantsToJoin, localMediaStatus, localMediaOptions, expected }) => {
+                "expected $expected when appWantsToJoin=$appWantsToJoin, localMediaStatus=$localMediaStatus, localMediaOptions=$localMediaOptions, isNodeSdk=$isNodeSdk",
+                ({ appWantsToJoin, localMediaStatus, localMediaOptions, isNodeSdk, expected }) => {
                     expect(
                         selectLocalMediaShouldStartWithOptions.resultFunc(
                             appWantsToJoin,
                             localMediaStatus,
-                            localMediaOptions
+                            localMediaOptions,
+                            isNodeSdk
                         )
                     ).toEqual(expected);
                 }
diff --git a/src/lib/core/redux/slices/__tests__/roomConnection.unit.ts b/src/lib/core/redux/slices/__tests__/roomConnection.unit.ts
@@ -46,21 +46,23 @@ describe("roomConnectionSlice", () => {
             const x = () => oneOf(true, false);
 
             it.each`
-                organizationId | roomConnectionStatus | signalIdentified | localMediaStatus | expected
-                ${undefined}   | ${"initializing"}    | ${x()}           | ${"started"}     | ${false}
-                ${"orgId"}     | ${"initializing"}    | ${true}          | ${"started"}     | ${true}
-                ${"orgId"}     | ${"connected"}       | ${x()}           | ${"started"}     | ${false}
-                ${"orgId"}     | ${"initializing"}    | ${false}         | ${"starting"}    | ${false}
-                ${"orgId"}     | ${"initializing"}    | ${x()}           | ${"error"}       | ${false}
+                organizationId | roomConnectionStatus | signalIdentified | localMediaStatus | isNodeSdk | expected
+                ${undefined}   | ${"initializing"}    | ${x()}           | ${"started"}     | ${x()}    | ${false}
+                ${"orgId"}     | ${"initializing"}    | ${true}          | ${"started"}     | ${false}  | ${true}
+                ${"orgId"}     | ${"connected"}       | ${x()}           | ${"started"}     | ${x()}    | ${false}
+                ${"orgId"}     | ${"initializing"}    | ${false}         | ${"starting"}    | ${x()}    | ${false}
+                ${"orgId"}     | ${"initializing"}    | ${x()}           | ${"error"}       | ${false}  | ${false}
+                ${"orgId"}     | ${"initializing"}    | ${true}          | ${"error"}       | ${true}   | ${true}
             `(
-                "should return $expected when hasOrganizationIdFetched=$hasOrganizationIdFetched, roomConnectionStatus=$roomConnectionStatus, signalIdentified=$signalIdentified, localMediaStatus=$localMediaStatus",
-                ({ organizationId, roomConnectionStatus, signalIdentified, localMediaStatus, expected }) => {
+                "Should return $expected when organizationId=$organizationId, roomConnectionStatus=$roomConnectionStatus, signalIdentified=$signalIdentified, localMediaStatus=$localMediaStatus, isNodeSdk=$isNodeSdk",
+                ({ organizationId, roomConnectionStatus, signalIdentified, localMediaStatus, isNodeSdk, expected }) => {
                     expect(
                         selectShouldConnectRoom.resultFunc(
                             organizationId,
                             roomConnectionStatus,
                             signalIdentified,
-                            localMediaStatus
+                            localMediaStatus,
+                            isNodeSdk
                         )
                     ).toEqual(expected);
                 }
diff --git a/src/lib/core/redux/slices/app.ts b/src/lib/core/redux/slices/app.ts
@@ -13,6 +13,7 @@ export interface AppState {
     displayName: string | null;
     sdkVersion: string | null;
     externalId: string | null;
+    isNodeSdk: boolean;
 }
 
 const initialState: AppState = {
@@ -23,6 +24,7 @@ const initialState: AppState = {
     displayName: null,
     sdkVersion: null,
     externalId: null,
+    isNodeSdk: typeof process !== "undefined" && process.release.name === "node",
 };
 
 export const appSlice = createSlice({
@@ -77,3 +79,4 @@ export const selectAppRoomKey = (state: RootState) => state.app.roomKey;
 export const selectAppDisplayName = (state: RootState) => state.app.displayName;
 export const selectAppSdkVersion = (state: RootState) => state.app.sdkVersion;
 export const selectAppExternalId = (state: RootState) => state.app.externalId;
+export const selectAppIsNodeSdk = (state: RootState) => state.app.isNodeSdk;
diff --git a/src/lib/core/redux/slices/localMedia.ts b/src/lib/core/redux/slices/localMedia.ts
@@ -3,10 +3,11 @@ import { getStream, getUpdatedDevices, getDeviceData } from "@whereby/jslib-medi
 import { createAppAsyncThunk, createAppThunk } from "../../redux/thunk";
 import { RootState } from "../../redux/store";
 import { createReactor, startAppListening } from "../../redux/listenerMiddleware";
-import { doAppJoin, selectAppWantsToJoin } from "./app";
+import { doAppJoin, selectAppIsNodeSdk, selectAppWantsToJoin } from "./app";
 import debounce from "../../../utils/debounce";
 
 export type LocalMediaOptions = {
+    disabled?: boolean;
     audio: boolean;
     video: boolean;
 };
@@ -606,7 +607,11 @@ export const selectLocalMediaShouldStartWithOptions = createSelector(
     selectAppWantsToJoin,
     selectLocalMediaStatus,
     selectLocalMediaOptions,
-    (appWantsToJoin, localMediaStatus, localMediaOptions) => {
+    selectAppIsNodeSdk,
+    (appWantsToJoin, localMediaStatus, localMediaOptions, isNodeSdk) => {
+        if (isNodeSdk) {
+            return;
+        }
         if (appWantsToJoin && localMediaStatus === "" && localMediaOptions) {
             return localMediaOptions;
         }
diff --git a/src/lib/core/redux/slices/roomConnection.ts b/src/lib/core/redux/slices/roomConnection.ts
@@ -10,6 +10,7 @@ import {
     selectAppSdkVersion,
     selectAppExternalId,
     setRoomKey,
+    selectAppIsNodeSdk,
 } from "./app";
 
 import { selectOrganizationId } from "./organization";
@@ -189,10 +190,16 @@ export const selectRoomConnectionStatus = (state: RootState) => state.roomConnec
  */
 
 export const selectShouldConnectRoom = createSelector(
-    [selectOrganizationId, selectRoomConnectionStatus, selectSignalConnectionDeviceIdentified, selectLocalMediaStatus],
-    (hasOrganizationIdFetched, roomConnectionStatus, signalConnectionDeviceIdentified, localMediaStatus) => {
+    [
+        selectOrganizationId,
+        selectRoomConnectionStatus,
+        selectSignalConnectionDeviceIdentified,
+        selectLocalMediaStatus,
+        selectAppIsNodeSdk,
+    ],
+    (hasOrganizationIdFetched, roomConnectionStatus, signalConnectionDeviceIdentified, localMediaStatus, isNodeSdk) => {
         if (
-            localMediaStatus === "started" &&
+            (localMediaStatus === "started" || isNodeSdk) && // the node SDK doesn't use LocalMedia, so we can join without
             signalConnectionDeviceIdentified &&
             !!hasOrganizationIdFetched &&
             ["initializing", "reconnect"].includes(roomConnectionStatus)
diff --git a/src/lib/core/redux/slices/rtcConnection/index.ts b/src/lib/core/redux/slices/rtcConnection/index.ts
@@ -11,7 +11,7 @@ import RtcManagerDispatcher, {
 import { createReactor, startAppListening } from "../../listenerMiddleware";
 import { selectRemoteParticipants, streamStatusUpdated } from "../remoteParticipants";
 import { StreamState } from "../../../../../lib/RoomParticipant";
-import { selectAppWantsToJoin } from "../app";
+import { selectAppIsNodeSdk, selectAppWantsToJoin } from "../app";
 import {
     selectIsCameraEnabled,
     selectIsMicrophoneEnabled,
@@ -23,6 +23,7 @@ import { rtcEvents } from "./actions";
 import { StreamStatusUpdate } from "./types";
 import { signalEvents } from "../signalConnection/actions";
 import { doStartScreenshare, stopScreenshare } from "../localScreenshare";
+import { Chrome111 as MediasoupDeviceHandler } from "mediasoup-client/lib/handlers/Chrome111";
 
 export const createWebRtcEmitter = (dispatch: AppDispatch) => {
     return {
@@ -165,6 +166,7 @@ export const doConnectRtc = createAppThunk(() => (dispatch, getState) => {
     const dispatcher = selectRtcConnectionRaw(state).rtcManagerDispatcher;
     const isCameraEnabled = selectIsCameraEnabled(state);
     const isMicrophoneEnabled = selectIsMicrophoneEnabled(state);
+    const isNodeSdk = selectAppIsNodeSdk(state);
 
     if (dispatcher) {
         return;
@@ -193,6 +195,7 @@ export const doConnectRtc = createAppThunk(() => (dispatch, getState) => {
             vp9On: false,
             h264On: false,
             simulcastScreenshareOn: false,
+            deviceHandlerFactory: isNodeSdk ? MediasoupDeviceHandler.createFactory() : undefined,
         },
     });
 
diff --git a/src/types.d.ts b/src/types.d.ts
@@ -20,6 +20,7 @@ declare module "heresy" {
 }
 
 declare module "@whereby/jslib-media/src/webrtc/RtcManagerDispatcher" {
+    import { type HandlerFactory } from "mediasoup-client/lib/handlers/HandlerInterface";
     enum RtcEventNames {
         rtc_manager_created = "rtc_manager_created",
         stream_added = "stream_added",
@@ -57,6 +58,7 @@ declare module "@whereby/jslib-media/src/webrtc/RtcManagerDispatcher" {
             vp9On: boolean;
             h264On: boolean;
             simulcastScreenshareOn: boolean;
+            deviceHandlerFactory?: HandlerFactory;
         };
         logger: {
             debug: (message: string) => void;
diff --git a/yarn.lock b/yarn.lock
