Merge branch 'release/2024.1.0'

.env.template

@@ -0,0 +1,6 @@
+# テストに利用する Sora の Signaling URL を指定してください
+VITE_SORA_SIGNALING_URL=ws://127.0.0.1:5000/signaling
+# テストに利用する Sora の ChannelID のプレフィックスを指定してください
+VITE_SORA_CHANNEL_ID_PREFIX=sora-js-sdk-e2e-test_
+# テストに利用するアクセストークンを指定してください、不要であれば何の値でも問題ありません
+VITE_ACCESS_TOKEN=access_token

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm"
+    directory: "/"
+    schedule:
+      interval: "weekly"

.github/workflows/ci.yaml

@@ -12,19 +12,18 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: ["18", "20", "21"]
+        node: ["18", "20", "22"]
     steps:
       - uses: actions/checkout@v4
       - uses: actions/setup-node@v4
         with:
           node-version: ${{ matrix.node }}
-      - uses: pnpm/action-setup@v2
-        with:
-          version: 8
+      - uses: pnpm/action-setup@v4
       - run: pnpm --version
       - run: pnpm install
       - run: pnpm run build
       - run: pnpm run lint
+      - run: pnpm run check
       - run: pnpm run test
       - name: Slack Notification
         if: failure()

.github/workflows/codeql.yml

@@ -42,7 +42,7 @@ jobs:
 
     # Initializes the CodeQL tools for scanning.
     - name: Initialize CodeQL
-      uses: github/codeql-action/init@v2
+      uses: github/codeql-action/init@v3
       with:
         languages: ${{ matrix.language }}
         # If you wish to specify custom queries, you can do so here or in a config file.
@@ -56,7 +56,7 @@ jobs:
     # Autobuild attempts to build any compiled languages  (C/C++, C#, or Java).
     # If this step fails, then you should remove it and run the build manually (see below)
     - name: Autobuild
-      uses: github/codeql-action/autobuild@v2
+      uses: github/codeql-action/autobuild@v3
 
     # ℹ️ Command-line programs to run using the OS shell.
     # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
@@ -69,6 +69,6 @@ jobs:
     #   ./location_of_script_within_repo/buildscript.sh
 
     - name: Perform CodeQL Analysis
-      uses: github/codeql-action/analyze@v2
+      uses: github/codeql-action/analyze@v3
       with:
         category: "/language:${{matrix.language}}"

.github/workflows/dependency-review.yml

@@ -17,4 +17,4 @@ jobs:
       - name: 'Checkout Repository'
         uses: actions/checkout@v4
       - name: 'Dependency Review'
-        uses: actions/dependency-review-action@v3
+        uses: actions/dependency-review-action@v4

.github/workflows/e2e-test.yml

@@ -0,0 +1,66 @@
+name: e2e-test
+
+on:
+  push:
+    branches:
+      - develop
+      - feature/*
+    paths-ignore:
+      - "**.md"
+      - "LICENSE"
+      - "NOTICE"
+  schedule:
+    # UTC 時間で毎日 2:00 (JST で 11:00) に実行、月曜日から金曜日
+    - cron: "0 2 * * 1-5"
+
+jobs:
+  e2e-test:
+    timeout-minutes: 20
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        # node: ["18", "20", "22"]
+        node: ["20"]
+        # browser: ["chromium", "firefox", "webkit"]
+        browser: ["chromium"]
+    env:
+      VITE_SORA_SIGNALING_URL: ${{ secrets.TEST_SIGNALING_URL }}
+      VITE_SORA_CHANNEL_ID_PREFIX: ${{ secrets.TEST_CHANNEL_ID_PREFIX }}
+      VITE_ACCESS_TOKEN: ${{ secrets.TEST_SECRET_KEY }}
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: ${{ matrix.node }}
+      - uses: pnpm/action-setup@v4
+      - run: pnpm --version
+      - run: pnpm install
+      - run: pnpm run build
+      - run: pnpm exec playwright install ${{ matrix.browser }} --with-deps
+      - run: pnpm exec playwright test --project=${{ matrix.browser }}
+        env:
+          VITE_SORA_CHANNEL_ID_SUFFIX: _${{ matrix.node }}
+      # - uses: actions/upload-artifact@v4
+      #   if: always()
+      #   with:
+      #     name: playwright-report
+      #     path: playwright-report/
+      #     retention-days: 30
+      - name: Slack Notification
+        if: success()
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: sora-js-sdk
+          SLACK_COLOR: good
+          SLACK_TITLE: Succeeded
+          SLACK_ICON_EMOJI: ":star-struck:"
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}
+      - name: Slack Notification
+        if: failure()
+        uses: rtCamp/action-slack-notify@v2
+        env:
+          SLACK_CHANNEL: sora-js-sdk
+          SLACK_COLOR: danger
+          SLACK_TITLE: Failed
+          SLACK_ICON_EMOJI: ":japanese_ogre:"
+          SLACK_WEBHOOK: ${{ secrets.SLACK_WEBHOOK }}

.gitignore

@@ -6,3 +6,13 @@ packages/e2ee/_worker
 apidoc/
 .log/
 dist/
+
+# .env
+.env*
+!.env.template
+
+# playwright
+/test-results/
+/playwright-report/
+/blob-report/
+/playwright/.cache/

.vscode/settings.json

@@ -16,5 +16,6 @@
   "editor.codeActionsOnSave": {
     "quickfix.biome": "explicit",
     "source.organizeImports.biome": "explicit"
-  }
+  },
+  "cSpell.words": ["remotevideo"]
 }

CHANGES.md

@@ -11,6 +11,49 @@
 
 ## develop
 
+## 2024.1.0
+
+**2024-06-07**
+
+- [UPDATE] tsconfig.json を統一する
+  - @voluntas
+- [UPDATE] CI の pnpm を 9 に上げる
+  - @voluntas
+- [UPDATE] Biome 1.8.0 に上げる
+  - @voluntas
+- [ADD] `tsc --noEmit` で型チェックを行うようにする
+  - @voluntas
+- [CHANGE] オーディオコーデック `LYRA` のサポートを削除する
+  - @tnamao
+- [CHANGE] シグナリングオプションの `multistream` は false の時のみレガシーストリームを使用する
+  - レガシーストリームを使用したい場合は `multistream: false` の指定が必須となる
+  - @tnamao
+- [CHANGE] stopAudioTrack と stopVideoTrack を非推奨にする
+  - 代わりに名前を変えただけの removeAudioTrack と removeVideoTrack を用意する
+  - @voluntas
+- [CHANGE] examples を Vite を利用して動かすように変更する
+  - serve を削除
+  - Vite を追加
+    - vite.config.mts を追加
+  - @voluntas
+- [CHANGE] deploy-pages.yml を削除する
+  - E2E テストで実行できるようになったので
+  - @voluntas
+- [CHANGE] サンプルを class ベースに変更する
+  - @voluntas
+- [ADD] サンプル用の .env.template を用意する
+  - @voluntas
+- [ADD] tests に Playwright を利用した E2E テストを追加する
+  - e2ee と messaging は一旦 skip で追加
+  - @voluntas
+- [ADD] .github/workflows/e2e-test.yml を追加する
+  - Node.js {18,20,22} で E2E テストを実行する
+  - Chromium で E2E テストを実行する
+  - @voluntas
+- [FIX] examples 実行時に環境変数が設定されていない場合は空文字にする
+  - 対象項目は SORA_CHANNEL_ID_PREFIX, VITE_SORA_CHANNEL_ID_PREFIX, VITE_ACCESS_TOKEN
+  - @miosakuma
+
 ## 2023.2.0
 
 **2023-12-08**
@@ -153,8 +196,8 @@
 ## 2021.2.2
 
 - [FIX] fflate package のバージョンを 0.7.1 から 0.7.3 に更新する
-  - 0.7.3 https://github.com/101arrowz/fflate/blob/master/CHANGELOG.md#073
-  - 0.7.2 https://github.com/101arrowz/fflate/blob/master/CHANGELOG.md#072
+  - 0.7.3 <https://github.com/101arrowz/fflate/blob/master/CHANGELOG.md#073>
+  - 0.7.2 <https://github.com/101arrowz/fflate/blob/master/CHANGELOG.md#072>
   - @yuitowest
 
 ## 2021.2.1
@@ -367,7 +410,7 @@
 - [UPDATE] sora-e2ee のバージョンを 2020.3.0 に更新する
   - @yuitowest
 - [FIX] `package.json` に定義されている `module` の向き先を `dist/sora.mjs` に変更し、対象ファイルがビルドされるよう Rollup の設定を追加する
-  - https://github.com/shiguredo/sora-js-sdk/pull/44
+  - <https://github.com/shiguredo/sora-js-sdk/pull/44>
   - @rosylilly
 - [UPDATE] simulcast で active パラメーターを有効にするための実装を追加する
   - @yuitowest
@@ -441,7 +484,7 @@
   - `_callbacks` を `callbacks` に名前変更してアクセス制限を protected に変更
   - @yuitowest
 - [CHANGE] method 名の変更とアクセス制限の追加する
-  - _ がついているメソッド名から _ を削除してアクセス制限を追加する
+  - _がついているメソッド名から_ を削除してアクセス制限を追加する
   - @yuitowest
 
 ## 1.16.0