Merge pull request #581 from shiguredo/feature/e2e-tests

Feature/e2e tests
shiguredo · Dec 25, 2024 · 504acbb · 504acbb
2 parents cb8b81a + da4af90
commit 504acbb
Show file tree

Hide file tree

Showing 57 changed files with 22 additions and 30 deletions.
diff --git a/.env.template b/.env.template
@@ -1,14 +1,14 @@
 # サンプルやテストに利用する Sora の Signaling URL を指定してください
 VITE_SORA_SIGNALING_URL=wss://sora.example.com/signaling
-# サンプルやテストに利用する Sora の ChannelID のプレフィックスを指定してください
-VITE_SORA_CHANNEL_ID_PREFIX=sora-js-sdk-examples__
+# サンプルやテストに利用する Sora の ChannelID を指定してください
+VITE_SORA_CHANNEL_ID=sora-js-sdk
 # サンプルやテストに利用するアクセストークンを指定してください、不要であれば空欄で大丈夫です
 VITE_ACCESS_TOKEN=access_token
 
 
 # サンプルやテストに利用する Sora の API URL を指定ください、不要であれば空欄で大丈夫です
 VITE_SORA_API_URL=https://sora.example.com/api
-# サンプルやテストに利用する Sora の WHIP のエンドポイント URL を指定してください
+# サンプルやテストに利用する Sora の WHIP のエンドポイント URL を指定してください、不要であれば空欄で大丈夫です
 VITE_SORA_WHIP_ENDPOINT_URL=https://sora.example.com/whip
-# サンプルやテストに利用する Sora の WHEP のエンドポイント URL を指定してください
-VITE_SORA_WHEP_ENDPOINT_URL=https://sora.example.com/whep
+# サンプルやテストに利用する Sora の WHEP のエンドポイント URL を指定してください、不要であれば空欄で大丈夫です
+VITE_SORA_WHEP_ENDPOINT_URL=https://sora.example.com/whep
diff --git a/.github/workflows/npm-pkg-e2e-test.yml b/.github/workflows/npm-pkg-e2e-test.yml
@@ -57,7 +57,7 @@ jobs:
       - run: pnpm --version
       - run: pnpm install
       - run: pnpm add -E sora-js-sdk@${{ matrix.sdk_version }}
-        working-directory: ./examples
+        working-directory: ./e2e-tests
       # pnpm run build しない
       - run: pnpm exec playwright install ${{ matrix.browser }} --with-deps
       - run: pnpm exec playwright test --project=${{ matrix.browser }}

diff --git a/CHANGES.md b/CHANGES.md
@@ -25,6 +25,8 @@
   - @voluntas
 - [ADD] .markdownlint.yaml ファイルを追加する
   - @voluntas
+- [CHANGE] examples を e2e-tests に変更する
+  - @voluntas
 - [CHANGE] tsconfig.json の moduleResolution を Bundler に変更する
   - @voluntas
 - [CHANGE] tsconfig.json の target と module を ES2022 に変更する

diff --git a/README.md b/README.md
@@ -46,16 +46,6 @@ pnpm add sora-js-sdk
 > - Firefox 113 以降
 > - Safari 16.4 以降
 
-## サンプル集
-
-```bash
-# .env.local を作成して適切な値を設定してください
-$ cp .env.template .env.local
-$ pnpm install
-$ pnpm run build
-$ pnpm run dev
-```
-
 ## E2E (End to End) テスト
 
 Playwright を利用した E2E テストを実行できます。

diff --git a/examples/README.md → e2e-tests/README.md b/examples/README.md → e2e-tests/README.md
@@ -1,4 +1,4 @@
-# Sora JavaScript SDK サンプル
+# Sora JavaScript SDK E2E テスト
 
 ## 使い方
 
@@ -9,12 +9,14 @@ $ cd sora-js-sdk
 $ cp .env.template .env.local
 $ pnpm install
 $ pnpm build
-$ pnpm dev
+$ pnpm e2e-test
 ```
 
 ## WHIP/WHEP
 
-SDK では対応していない WHIP/WHEP のサンプルを用意しています。
+SDK では対応していないブラウザレベルでの WHIP/WHEP の E2E テストを用意しています。
+
+このサンプルは Chrome / Edge でのみ動作します。
 
 WHIP/WHEP を利用するには whip/whep が有効になっており、
 whip_turn/whep_turn も有効になっている必要があります。

diff --git a/examples/check_stereo/index.html → e2e-tests/check_stereo/index.html b/examples/check_stereo/index.html → e2e-tests/check_stereo/index.html
diff --git a/examples/check_stereo/main.mts → e2e-tests/check_stereo/main.mts b/examples/check_stereo/main.mts → e2e-tests/check_stereo/main.mts
diff --git a/examples/check_stereo_multi/index.html → e2e-tests/check_stereo_multi/index.html b/examples/check_stereo_multi/index.html → e2e-tests/check_stereo_multi/index.html
diff --git a/examples/check_stereo_multi/main.mts → e2e-tests/check_stereo_multi/main.mts b/examples/check_stereo_multi/main.mts → e2e-tests/check_stereo_multi/main.mts
diff --git a/...es/data_channel_signaling_only/index.html → ...ts/data_channel_signaling_only/index.html b/...es/data_channel_signaling_only/index.html → ...ts/data_channel_signaling_only/index.html
diff --git a/...ples/data_channel_signaling_only/main.mts → ...ests/data_channel_signaling_only/main.mts b/...ples/data_channel_signaling_only/main.mts → ...ests/data_channel_signaling_only/main.mts
diff --git a/examples/index.html → e2e-tests/index.html b/examples/index.html → e2e-tests/index.html
diff --git a/examples/messaging/index.html → e2e-tests/messaging/index.html b/examples/messaging/index.html → e2e-tests/messaging/index.html
diff --git a/examples/messaging/main.mts → e2e-tests/messaging/main.mts b/examples/messaging/main.mts → e2e-tests/messaging/main.mts
diff --git a/examples/package.json → e2e-tests/package.json b/examples/package.json → e2e-tests/package.json
diff --git a/examples/recvonly/index.html → e2e-tests/recvonly/index.html b/examples/recvonly/index.html → e2e-tests/recvonly/index.html
diff --git a/examples/recvonly/main.mts → e2e-tests/recvonly/main.mts b/examples/recvonly/main.mts → e2e-tests/recvonly/main.mts
diff --git a/examples/replace_track/index.html → e2e-tests/replace_track/index.html b/examples/replace_track/index.html → e2e-tests/replace_track/index.html
diff --git a/examples/replace_track/main.mts → e2e-tests/replace_track/main.mts b/examples/replace_track/main.mts → e2e-tests/replace_track/main.mts
diff --git a/examples/sendonly/index.html → e2e-tests/sendonly/index.html b/examples/sendonly/index.html → e2e-tests/sendonly/index.html
diff --git a/examples/sendonly/main.mts → e2e-tests/sendonly/main.mts b/examples/sendonly/main.mts → e2e-tests/sendonly/main.mts
diff --git a/examples/sendonly_audio/index.html → e2e-tests/sendonly_audio/index.html b/examples/sendonly_audio/index.html → e2e-tests/sendonly_audio/index.html
diff --git a/examples/sendonly_audio/main.mts → e2e-tests/sendonly_audio/main.mts b/examples/sendonly_audio/main.mts → e2e-tests/sendonly_audio/main.mts
diff --git a/examples/sendrecv/index.html → e2e-tests/sendrecv/index.html b/examples/sendrecv/index.html → e2e-tests/sendrecv/index.html
diff --git a/examples/sendrecv/main.mts → e2e-tests/sendrecv/main.mts b/examples/sendrecv/main.mts → e2e-tests/sendrecv/main.mts
@@ -97,7 +97,9 @@ class SoraClient {
     videoCodecType: VideoCodecType | undefined,
   ) {
     this.sora = Sora.connection(signalingUrl, this.debug)
+
     this.channelId = `${channelIdPrefix}${channelName}${channelIdSuffix}`
+
     this.metadata = { access_token: accessToken }
     this.options = {}
 

diff --git a/examples/simulcast/index.html → e2e-tests/simulcast/index.html b/examples/simulcast/index.html → e2e-tests/simulcast/index.html
diff --git a/examples/simulcast/main.mts → e2e-tests/simulcast/main.mts b/examples/simulcast/main.mts → e2e-tests/simulcast/main.mts
diff --git a/examples/spotlight_recvonly/index.html → e2e-tests/spotlight_recvonly/index.html b/examples/spotlight_recvonly/index.html → e2e-tests/spotlight_recvonly/index.html
diff --git a/examples/spotlight_recvonly/main.mts → e2e-tests/spotlight_recvonly/main.mts b/examples/spotlight_recvonly/main.mts → e2e-tests/spotlight_recvonly/main.mts
diff --git a/examples/spotlight_sendonly/index.html → e2e-tests/spotlight_sendonly/index.html b/examples/spotlight_sendonly/index.html → e2e-tests/spotlight_sendonly/index.html
diff --git a/examples/spotlight_sendonly/main.mts → e2e-tests/spotlight_sendonly/main.mts b/examples/spotlight_sendonly/main.mts → e2e-tests/spotlight_sendonly/main.mts
diff --git a/examples/spotlight_sendrecv/index.html → e2e-tests/spotlight_sendrecv/index.html b/examples/spotlight_sendrecv/index.html → e2e-tests/spotlight_sendrecv/index.html
diff --git a/examples/spotlight_sendrecv/main.mts → e2e-tests/spotlight_sendrecv/main.mts b/examples/spotlight_sendrecv/main.mts → e2e-tests/spotlight_sendrecv/main.mts
diff --git a/tests/playwright/helper.ts → e2e-tests/tests/helper.ts b/tests/playwright/helper.ts → e2e-tests/tests/helper.ts
diff --git a/tests/playwright/message_header.spec.ts → e2e-tests/tests/message_header.spec.ts b/tests/playwright/message_header.spec.ts → e2e-tests/tests/message_header.spec.ts
diff --git a/tests/playwright/messaging.spec.ts → e2e-tests/tests/messaging.spec.ts b/tests/playwright/messaging.spec.ts → e2e-tests/tests/messaging.spec.ts
diff --git a/tests/playwright/sendonly_audio.spec.ts → e2e-tests/tests/sendonly_audio.spec.ts b/tests/playwright/sendonly_audio.spec.ts → e2e-tests/tests/sendonly_audio.spec.ts
diff --git a/tests/playwright/sendonly_recvonly.spec.ts → e2e-tests/tests/sendonly_recvonly.spec.ts b/tests/playwright/sendonly_recvonly.spec.ts → e2e-tests/tests/sendonly_recvonly.spec.ts
diff --git a/tests/playwright/sendrecv.spec.ts → e2e-tests/tests/sendrecv.spec.ts b/tests/playwright/sendrecv.spec.ts → e2e-tests/tests/sendrecv.spec.ts
diff --git a/tests/playwright/simulcast.spec.ts → e2e-tests/tests/simulcast.spec.ts b/tests/playwright/simulcast.spec.ts → e2e-tests/tests/simulcast.spec.ts
diff --git a/...right/spotlight_sendonly_recvonly.spec.ts → ...tests/spotlight_sendonly_recvonly.spec.ts b/...right/spotlight_sendonly_recvonly.spec.ts → ...tests/spotlight_sendonly_recvonly.spec.ts
diff --git a/tests/playwright/spotlight_sendrecv.spec.ts → e2e-tests/tests/spotlight_sendrecv.spec.ts b/tests/playwright/spotlight_sendrecv.spec.ts → e2e-tests/tests/spotlight_sendrecv.spec.ts
diff --git a/tests/playwright/type_close.spec.ts → e2e-tests/tests/type_close.spec.ts b/tests/playwright/type_close.spec.ts → e2e-tests/tests/type_close.spec.ts
diff --git a/tests/playwright/type_switched.spec.ts → e2e-tests/tests/type_switched.spec.ts b/tests/playwright/type_switched.spec.ts → e2e-tests/tests/type_switched.spec.ts
diff --git a/tests/playwright/whip_whep.spec.ts → e2e-tests/tests/whip_whep.spec.ts b/tests/playwright/whip_whep.spec.ts → e2e-tests/tests/whip_whep.spec.ts
diff --git a/examples/tsconfig.json → e2e-tests/tsconfig.json b/examples/tsconfig.json → e2e-tests/tsconfig.json
diff --git a/examples/vite-env.d.ts → e2e-tests/vite-env.d.ts b/examples/vite-env.d.ts → e2e-tests/vite-env.d.ts
diff --git a/examples/vite.config.mjs → e2e-tests/vite.config.mjs b/examples/vite.config.mjs → e2e-tests/vite.config.mjs
@@ -32,6 +32,8 @@ export default defineConfig({
         sendonly_audio: resolve(__dirname, 'sendonly_audio/index.html'),
         messaging: resolve(__dirname, 'messaging/index.html'),
         data_channel_signaling_only: resolve(__dirname, 'data_channel_signaling_only/index.html'),
+        whip: resolve(__dirname, 'whip/index.html'),
+        whep: resolve(__dirname, 'whep/index.html'),
       },
     },
   },

diff --git a/examples/whep/index.html → e2e-tests/whep/index.html b/examples/whep/index.html → e2e-tests/whep/index.html
diff --git a/examples/whep/main.mts → e2e-tests/whep/main.mts b/examples/whep/main.mts → e2e-tests/whep/main.mts
diff --git a/examples/whip/index.html → e2e-tests/whip/index.html b/examples/whip/index.html → e2e-tests/whip/index.html
diff --git a/examples/whip/main.mts → e2e-tests/whip/main.mts b/examples/whip/main.mts → e2e-tests/whip/main.mts
diff --git a/package.json b/package.json
@@ -14,7 +14,7 @@
   "scripts": {
     "build": "vite build",
     "watch": "vite build --watch",
-    "dev": "vite --config examples/vite.config.mjs",
+    "dev": "vite --config e2e-tests/vite.config.mjs",
     "e2e-test": "pnpm build && playwright test --project=chromium",
     "lint": "biome lint",
     "fmt": "biome format --write",

diff --git a/playwright.config.mts b/playwright.config.mts
@@ -3,7 +3,7 @@ import { defineConfig, devices } from '@playwright/test'
 // pnpm exec playwright test --ui
 
 export default defineConfig({
-  testDir: 'tests/playwright',
+  testDir: 'e2e-tests/tests',
   // fullyParallel: true,
   reporter: 'html',
   use: {

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/tests/vitest/utils.test.ts → tests/utils.test.ts b/tests/vitest/utils.test.ts → tests/utils.test.ts
@@ -1,6 +1,6 @@
 import { expect, test } from 'vitest'
-import type { AudioCodecType, DataChannelDirection, VideoCodecType } from '../../src/types'
-import { createSignalingMessage } from '../../src/utils'
+import type { AudioCodecType, DataChannelDirection, VideoCodecType } from '../src/types'
+import { createSignalingMessage } from '../src/utils'
 
 const channelId = '7N3fsMHob'
 const metadata = 'PG9A6RXgYqiqWKOVO'

diff --git a/vitest.config.mjs b/vitest.config.mjs
@@ -8,7 +8,7 @@ export default mergeConfig(
   defineConfig({
     test: {
       environment: 'jsdom',
-      include: ['tests/vitest/**/*.ts'],
+      include: ['tests/**/*.ts'],
     },
   }),
 )