add useLocalSessionId

Author: Regaddi

src/hooks/useLocalSessionId.ts

@@ -0,0 +1,11 @@
+import { useRecoilValue } from 'recoil';
+
+import { localIdState } from '../DailyParticipants';
+
+/**
+ * Returns the local participant's session_id or null,
+ * if the local participant doesn't exist.
+ */
+export const useLocalSessionId = () => {
+  return useRecoilValue(localIdState) || null;
+};

src/index.ts

@@ -9,6 +9,7 @@ export { StatefulDevice, useDevices } from './hooks/useDevices';
 export { useInputSettings } from './hooks/useInputSettings';
 export { useLiveStreaming } from './hooks/useLiveStreaming';
 export { useLocalParticipant } from './hooks/useLocalParticipant';
+export { useLocalSessionId } from './hooks/useLocalSessionId';
 export { useMediaTrack } from './hooks/useMediaTrack';
 export { useNetwork } from './hooks/useNetwork';
 export { useParticipant } from './hooks/useParticipant';

test/hooks/useLocalSessionId.test.tsx

@@ -0,0 +1,50 @@
+/// <reference types="@types/jest" />
+
+import DailyIframe, { DailyCall } from '@daily-co/daily-js';
+import { renderHook } from '@testing-library/react-hooks';
+import React from 'react';
+
+import { DailyProvider } from '../../src/DailyProvider';
+import { useLocalSessionId } from '../../src/hooks/useLocalSessionId';
+
+/**
+ * Mock DailyRoom.
+ * It's not required for useLocalSessionId and causes unwanted state updates.
+ */
+jest.mock('../../src/DailyRoom', () => ({
+  DailyRoom: (({ children }) => <>{children}</>) as React.FC,
+}));
+
+const createWrapper =
+  (callObject: DailyCall = DailyIframe.createCallObject()): React.FC =>
+  ({ children }) =>
+    <DailyProvider callObject={callObject}>{children}</DailyProvider>;
+
+describe('useLocalSessionId', () => {
+  it('returns null, if daily.participants() does not contain local user yet', async () => {
+    const daily = DailyIframe.createCallObject();
+    (daily.participants as jest.Mock).mockImplementation(() => ({}));
+    const { result, waitFor } = renderHook(() => useLocalSessionId(), {
+      wrapper: createWrapper(daily),
+    });
+    await waitFor(() => {
+      expect(result.current).toBeNull();
+    });
+  });
+  it('returns local user session_id', async () => {
+    const daily = DailyIframe.createCallObject();
+    (daily.participants as jest.Mock).mockImplementation(() => ({
+      local: {
+        local: true,
+        session_id: 'local',
+        user_name: '',
+      },
+    }));
+    const { result, waitFor } = renderHook(() => useLocalSessionId(), {
+      wrapper: createWrapper(daily),
+    });
+    await waitFor(() => {
+      expect(result.current).toEqual('local');
+    });
+  });
+});