chore: Add GA to check circular deps (#324)

* chore: Add GA to check circular deps * fix: Resolve circular deps
inworld-ai · Jan 6, 2025 · 6b03682 · 6b03682
1 parent f1b2cf0
commit 6b03682
Show file tree

Hide file tree

Showing 20 changed files with 1,077 additions and 203 deletions.
diff --git a/.github/workflows/reviewdog.yml b/.github/workflows/reviewdog.yml
@@ -42,3 +42,14 @@ jobs:
       - name: Linelint
         uses: fernandrone/linelint@master
         id: linelint
+
+  circular-deps:
+    runs-on: ubuntu-latest
+    name: Check for circular dependencies
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Build node env
+        uses: ./.github/actions/build_package
+      - name: Check for circular dependencies
+        run: yarn circular-deps
diff --git a/package.json b/package.json
@@ -22,7 +22,8 @@
     "prettier:format": "yarn workspaces foreach -A run prettier:format && yarn prettier --write \"./examples/**/*.{js,jsx,ts,tsx}\" --ignore-path .eslintignore --config .prettierrc.json",
     "prepare": "husky",
     "test": "yarn workspace @inworld/web-core run test",
-    "test:coverage": "yarn workspace @inworld/web-core run test:coverage"
+    "test:coverage": "yarn workspace @inworld/web-core run test:coverage",
+    "circular-deps": "yarn workspaces foreach -A run circular-deps"
   },
   "devDependencies": {
     "@release-it/keep-a-changelog": "^5.0.0",
@@ -39,6 +40,7 @@
     "jest": "^29.7.0",
     "jest-environment-jsdom": "^29.7.0",
     "jest-websocket-mock": "^2.5.0",
+    "madge": "^8.0.0",
     "prettier": "^3.3.2",
     "release-it": "^17.1.1",
     "rollup": "^4.16.1",

diff --git a/packages/web-core/__tests__/components/history.spec.ts b/packages/web-core/__tests__/components/history.spec.ts
@@ -3,20 +3,22 @@ import '../mocks/window.mock';
 import { v4 } from 'uuid';
 
 import {
-  ConversationMapItem,
   ConversationState,
-  Extension,
   InworlControlAction,
   InworldConversationEventType,
   InworldPacketType,
   User,
 } from '../../src/common/data_structures';
-import { protoTimestamp } from '../../src/common/helpers';
+import {
+  ConvesationInterface,
+  Extension,
+} from '../../src/common/data_structures/extension';
 import {
   CHAT_HISTORY_TYPE,
   HistoryItemActor,
-  InworldHistory,
-} from '../../src/components/history';
+} from '../../src/common/data_structures/history';
+import { protoTimestamp } from '../../src/common/helpers';
+import { InworldHistory } from '../../src/components/history';
 import { GrpcAudioPlayback } from '../../src/components/sound/grpc_audio.playback';
 import { ControlEvent } from '../../src/entities/packets/control.entity';
 import { InworldPacket } from '../../src/entities/packets/inworld_packet.entity';
@@ -113,7 +115,13 @@ const createHistoryWithPacket = (
     user,
     scene: SCENE,
     audioEnabled,
-    conversations: new Map<string, ConversationMapItem>(),
+    conversations: new Map<
+      string,
+      {
+        service: ConvesationInterface;
+        state: ConversationState;
+      }
+    >(),
   });
 
   history.addOrUpdate({ characters, grpcAudioPlayer, packet, fromHistory });
@@ -125,7 +133,13 @@ test('should be empty by default', () => {
   const history = new InworldHistory({
     scene: SCENE,
     audioEnabled: false,
-    conversations: new Map<string, ConversationMapItem>(),
+    conversations: new Map<
+      string,
+      {
+        service: ConvesationInterface;
+        state: ConversationState;
+      }
+    >(),
   });
 
   expect(history.get().length).toEqual(0);
@@ -371,7 +385,13 @@ describe('text', () => {
       const history = new InworldHistory({
         scene: SCENE,
         audioEnabled: true,
-        conversations: new Map<string, ConversationMapItem>(),
+        conversations: new Map<
+          string,
+          {
+            service: ConvesationInterface;
+            state: ConversationState;
+          }
+        >(),
       });
 
       const transcript = history.getTranscript();
@@ -807,7 +827,13 @@ describe('conversation', () => {
         },
       }),
     });
-    const conversations = new Map<string, ConversationMapItem>();
+    const conversations = new Map<
+      string,
+      {
+        service: ConvesationInterface;
+        state: ConversationState;
+      }
+    >();
     conversations.set(conversationId, {
       service: new ConversationService(new ConnectionService(), {
         participants: [characters[0].resourceName],

diff --git a/packages/web-core/__tests__/helpers/extension.ts b/packages/web-core/__tests__/helpers/extension.ts
@@ -1,5 +1,5 @@
 import { InworldPacket as ProtoPacket } from '../../proto/ai/inworld/packets/packets.pb';
-import { Extension } from '../../src/common/data_structures';
+import { Extension } from '../../src/common/data_structures/extension';
 import { InworldPacket } from '../../src/entities/packets/inworld_packet.entity';
 import { ExtendedHistoryItem, ExtendedInworldPacket } from '../data_structures';
 

diff --git a/packages/web-core/__tests__/services/connection.service.spec.ts b/packages/web-core/__tests__/services/connection.service.spec.ts
@@ -12,15 +12,15 @@ import {
 } from '../../proto/ai/inworld/packets/packets.pb';
 import {
   ConversationState,
-  HistoryChangedProps,
   LoadedScene,
 } from '../../src/common/data_structures';
-import { protoTimestamp } from '../../src/common/helpers';
 import {
   CHAT_HISTORY_TYPE,
+  HistoryChangedProps,
   HistoryItem,
-  InworldHistory,
-} from '../../src/components/history';
+} from '../../src/common/data_structures/history';
+import { protoTimestamp } from '../../src/common/helpers';
+import { InworldHistory } from '../../src/components/history';
 import { GrpcAudioPlayback } from '../../src/components/sound/grpc_audio.playback';
 import { GrpcWebRtcLoopbackBiDiSession } from '../../src/components/sound/grpc_web_rtc_loopback_bidi.session';
 import { Player } from '../../src/components/sound/player';

diff --git a/packages/web-core/__tests__/services/inworld_connection.service.spec.ts b/packages/web-core/__tests__/services/inworld_connection.service.spec.ts
@@ -11,24 +11,24 @@ import {
 } from '../../proto/ai/inworld/packets/packets.pb';
 import {
   AudioSessionState,
-  ConversationMapItem,
   ConversationState,
   InworldPacketType,
   LoadedScene,
   MicrophoneMode,
   TtsPlaybackAction,
   UnderstandingMode,
 } from '../../src/common/data_structures';
+import { ConvesationInterface } from '../../src/common/data_structures/extension';
+import {
+  CHAT_HISTORY_TYPE,
+  HistoryItem,
+} from '../../src/common/data_structures/history';
 import {
   CHARACTER_HAS_INVALID_FORMAT,
   SCENE_HAS_INVALID_FORMAT,
 } from '../../src/common/errors';
 import { protoTimestamp } from '../../src/common/helpers';
-import {
-  CHAT_HISTORY_TYPE,
-  HistoryItem,
-  InworldHistory,
-} from '../../src/components/history';
+import { InworldHistory } from '../../src/components/history';
 import { GrpcAudioPlayback } from '../../src/components/sound/grpc_audio.playback';
 import { GrpcAudioRecorder } from '../../src/components/sound/grpc_audio.recorder';
 import { GrpcWebRtcLoopbackBiDiSession } from '../../src/components/sound/grpc_web_rtc_loopback_bidi.session';
@@ -176,7 +176,13 @@ describe('history', () => {
     const history = new InworldHistory({
       scene: SCENE,
       audioEnabled: true,
-      conversations: new Map<string, ConversationMapItem>(),
+      conversations: new Map<
+        string,
+        {
+          service: ConvesationInterface;
+          state: ConversationState;
+        }
+      >(),
     });
     const packetId = getPacketId();
     const routing: Routing = {

diff --git a/packages/web-core/__tests__/services/session_state.service.spec.ts b/packages/web-core/__tests__/services/session_state.service.spec.ts
@@ -3,8 +3,11 @@ import '../mocks/window.mock';
 import { v4 } from 'uuid';
 
 import { DEFAULT_SESSION_STATE_KEY } from '../../src/common/constants';
+import {
+  CHAT_HISTORY_TYPE,
+  HistoryItem,
+} from '../../src/common/data_structures/history';
 import { protoTimestamp } from '../../src/common/helpers';
-import { CHAT_HISTORY_TYPE, HistoryItem } from '../../src/components/history';
 import { ConnectionService } from '../../src/services/connection.service';
 import { SessionStateService } from '../../src/services/session_state.service';
 import { StateSerializationService } from '../../src/services/wrappers/state_serialization.service';

diff --git a/packages/web-core/package.json b/packages/web-core/package.json
@@ -34,7 +34,8 @@
     "prettier:format": "prettier --write \"./**/*.{js,jsx,ts,tsx}\" --ignore-path ../../.eslintignore --config ../../.prettierrc.json",
     "test": "jest --no-cache --reporters=default",
     "test:coverage": "jest --coverage",
-    "minify": "rollup --config rollup.config.mjs"
+    "minify": "rollup --config rollup.config.mjs",
+    "circular-deps": "madge --circular --extensions ts,tsx src"
   },
   "devDependencies": {
     "@types/defer-promise": "^1.0.0",

diff --git a/packages/web-core/src/clients/inworld.client.ts b/packages/web-core/src/clients/inworld.client.ts
@@ -4,20 +4,22 @@ import {
   Awaitable,
   Client,
   ClientConfiguration,
-  Extension,
   Gateway,
   GenerateSessionTokenFn,
-  HistoryChangedProps,
   InternalClientConfiguration,
   OnPhomeneFn,
   User,
 } from '../common/data_structures';
+import { Extension } from '../common/data_structures/extension';
+import {
+  HistoryChangedProps,
+  HistoryItem,
+} from '../common/data_structures/history';
 import {
   SCENE_HAS_INVALID_FORMAT,
   STOP_DURATION_NATURAL_NUMBER,
   STOP_TICKS_NATURAL_NUMBER,
 } from '../common/errors';
-import { HistoryItem } from '../components/history';
 import { GrpcAudioPlayback } from '../components/sound/grpc_audio.playback';
 import { GrpcAudioRecorder } from '../components/sound/grpc_audio.recorder';
 import { GrpcWebRtcLoopbackBiDiSession } from '../components/sound/grpc_web_rtc_loopback_bidi.session';

diff --git a/packages/web-core/src/common/data_structures/extension.ts b/packages/web-core/src/common/data_structures/extension.ts
@@ -0,0 +1,53 @@
+import {
+  CurrentSceneStatus,
+  InworldPacket as ProtoPacket,
+} from '../../../proto/ai/inworld/packets/packets.pb';
+import { Character } from '../../entities/character.entity';
+import { InworldPacket } from '../../entities/packets/inworld_packet.entity';
+import { HistoryItem } from './history';
+import {
+  AudioSessionStartPacketParams,
+  CancelResponsesProps,
+  SendPacketParams,
+  TriggerParameter,
+} from './index';
+
+export interface Extension<
+  InworldPacketT extends InworldPacket = InworldPacket,
+  HistoryItemT extends HistoryItem = HistoryItem,
+> {
+  convertPacketFromProto?: (proto: ProtoPacket) => InworldPacketT;
+  beforeLoadScene?: (packets: ProtoPacket[]) => ProtoPacket[];
+  afterLoadScene?: (res: CurrentSceneStatus) => void;
+  historyItem?: (packet: InworldPacketT, item: HistoryItem) => HistoryItemT;
+}
+
+export interface ConvesationInterface<
+  InworldPacketT extends InworldPacket = InworldPacket,
+> {
+  getConversationId(): string;
+  getParticipants(): string[];
+  getCharacters(): Character[];
+  changeParticipants(participants: string[]): void;
+  updateParticipants(
+    participants: string[],
+  ): Promise<ConvesationInterface<InworldPacketT>> | void;
+  sendText: (text: string) => Promise<InworldPacketT>;
+  sendAudio: (chunk: string) => Promise<InworldPacketT>;
+  sendTrigger: (
+    name: string,
+    parameters?: { parameters?: TriggerParameter[]; character?: Character },
+  ) => Promise<InworldPacketT>;
+  sendAudioSessionStart(
+    params?: AudioSessionStartPacketParams,
+  ): Promise<InworldPacketT>;
+  sendAudioSessionEnd(): Promise<InworldPacketT>;
+  sendCancelResponse(
+    cancelResponses?: CancelResponsesProps,
+  ): Promise<InworldPacketT>;
+  sendTTSPlaybackMute(isMuted: boolean): Promise<InworldPacketT>;
+  sendNarratedAction(text: string): Promise<InworldPacketT>;
+  sendCustomPacket(
+    getPacket: (params: SendPacketParams) => ProtoPacket,
+  ): Promise<InworldPacketT>;
+}