@kubohiroya/turbowarp-webrtc-qrcode-pairing 0.2.2 → 0.2.3

package/README.ja.md

@@ -15,7 +15,7 @@ QRコードを使ってWebRTCの接続情報を交換するTurboWarp拡張です
 - Answerがどの Offer への応答かを追跡し、2台のカメラ側端末の接続情報が入れ替わらないようにします。
 - 搬送の進捗と接続状態を別々の状態として報告します。エラー、取消、再試行、期限にも対応します。
 
-`0.2.0`では、メッセージを連結QRコードで運び、1枚のQRを既定でOfferはversion 15、Answerはversion 20までに抑え、読んだペアリング用のQRをすべて報告します。`turbowarp-jsqr` 0.4.0以降が必要です。`0.2.1`では、QRがカメラに写り続けている間の読取りがページの処理を止めてしまう不具合を直しました。`0.2.2`では、1枚目に収まらないheaderを先頭から続くQRで読み、読取りを1つずつ処理して接続情報を一度だけ渡し、規格に合わないQRを読んでも集めていたものを消さないようにしました。
+`0.2.0`では、メッセージを連結QRコードで運び、1枚のQRを既定でOfferはversion 15、Answerはversion 20までに抑え、読んだペアリング用のQRをすべて報告します。`turbowarp-jsqr` 0.4.0以降が必要です。`0.2.1`では、QRがカメラに写り続けている間の読取りがページの処理を止めてしまう不具合を直しました。`0.2.2`では、1枚目に収まらないheaderを先頭から続くQRで読み、読取りを1つずつ処理して接続情報を一度だけ渡し、規格に合わないQRを読んでも集めていたものを消さないようにしました。`0.2.3`では、交換が接続・失敗・取消のどれかで終わった時点で、接続情報を含むQRのデータを捨てます。
 
 > [!NOTE]
 > ペアリング用ブロックは起動時固定のフィーチャーフラグの内側にあり、既定は無効です。

package/README.md

@@ -15,7 +15,7 @@ A TurboWarp extension for exchanging WebRTC connection information through QR co
 - Tracks which offer an answer replies to, so two camera machines never receive each other's connection.
 - Reports transport progress and connection state as separate states, plus errors, cancellation, retry and deadlines.
 
-Version 0.2.0 carries messages as Structured Append sequences, caps Offer codes at QR version 15 and Answer codes at 20, and reports every pairing code read. It needs `turbowarp-jsqr` 0.4.0 or later. 0.2.1 fixes a camera scan that starved the page while a code stayed in view. 0.2.2 reads a header that runs past the first code, takes reads one at a time so a code is handed over once, and keeps a sequence when a malformed code is read.
+Version 0.2.0 carries messages as Structured Append sequences, caps Offer codes at QR version 15 and Answer codes at 20, and reports every pairing code read. It needs `turbowarp-jsqr` 0.4.0 or later. 0.2.1 fixes a camera scan that starved the page while a code stayed in view. 0.2.2 reads a header that runs past the first code, takes reads one at a time so a code is handed over once, and keeps a sequence when a malformed code is read. 0.2.3 forgets the QR codes, which carry the pairing codes, as soon as an exchange connects, fails or is cancelled.
 
 > [!NOTE]
 > The pairing blocks are behind a startup feature flag that is off by default. See
@@ -116,7 +116,7 @@ pnpm run dev
 
 Build output: `dist/webrtc-qrcode-pairing.js` and `dist/extension-manifest.json`. Load the JavaScript file as a custom TurboWarp extension. The manifest always records every declared block, including blocks the feature flag hides at runtime: it is the build-time contract, not the runtime state.
 
-Package name and version: `@kubohiroya/turbowarp-webrtc-qrcode-pairing@0.2.2`.
+Package name and version: `@kubohiroya/turbowarp-webrtc-qrcode-pairing@0.2.3`.
 
 ## Block reference
 

package/dist/webrtc-qrcode-pairing.js

@@ -3989,7 +3989,7 @@
   	* Moves a session to a terminal phase and releases what it owns.
   	*
   	* Everything but an established RTCPeerConnection is released: timers, the
-  	* receive buffer, and the peer connection when it never connected.
+  	* QR codes sent and received, and the peer connection when it never connected.
   	*/
   	finish(session, phase, errorCode, errorMessage) {
   		if (isTerminalPhase(session.phase) && session.phase !== "connected") return;
@@ -4001,9 +4001,8 @@
   		this.clearTimer(session);
   		session.scanAbort?.abort();
   		this.releaseDisplay(session);
+  		this.dropCodes(session);
   		if (!connected) {
-  			session.assembler.clear();
-  			session.candidate.clear();
   			if (session.peerCreated) {
   				try {
   					this.webrtc().closePeer(session.remotePeerId);
@@ -4015,6 +4014,14 @@
   		for (const waiter of waiters) if (connected) waiter.resolve();
   		else waiter.reject(this.terminalError(session));
   	}
+  	/** Forgets the codes this session made and the codes it received. */
+  	dropCodes(session) {
+  		session.outgoing = void 0;
+  		session.outgoingSvgs = [];
+  		session.outgoingCurrentIndex = -1;
+  		session.assembler.clear();
+  		session.candidate.clear();
+  	}
   	failFrom(session, error) {
   		const code = error instanceof QrPairingError ? error.code : "webrtc-rejected";
   		const message = error instanceof Error ? error.message : "Pairing failed.";

package/docs/integration-guide.ja.md

@@ -235,6 +235,10 @@ start offer pairing [pairing-B] as [studio] to [cam-B]
 
 停止ボタンは表示とカメラを解放し、進行中の交換を取り消します。成立済みの接続は切断しません。
 
+QRには接続情報そのものが入っています。交換が終わると（接続、失敗、取消、期限切れのいずれでも）、作ったQRと
+受け取ったQRのデータを捨てます。そのため、その後は`pairing QR part count`と`received parts`が0になり、
+QRのSVGとdata URIを返すブロックは空の文字列を返します。
+
 ## 10. うまくいかないとき
 
 `pairing error code of [SESSION]`が安定したコードを、`pairing error message of [SESSION]`が

package/docs/integration-guide.md

@@ -246,6 +246,10 @@ session names.
 Pressing the stop button releases displays and cameras and cancels exchanges in progress. It does
 not disconnect an established connection.
 
+The QR codes carry the pairing code itself. When an exchange ends — connected, failed, cancelled or
+expired — the codes it made and the codes it received are forgotten, so `pairing QR part count` and
+`received parts` read 0 afterwards and the part SVG and data URI reporters return an empty string.
+
 ## 10. When something goes wrong
 
 `pairing error code of [SESSION]` gives a stable code; `pairing error message of [SESSION]` gives a

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubohiroya/turbowarp-webrtc-qrcode-pairing",
-  "version": "0.2.2",
+  "version": "0.2.3",
   "description": "TurboWarp extension that pairs WebRTC peers by carrying offers and answers as QR codes.",
   "author": "Hiroya Kubo <hiroya@cuc.ac.jp>",
   "license": "MPL-2.0",

package/src/pairing/controller.ts

@@ -914,7 +914,7 @@ export class PairingController {
    * Moves a session to a terminal phase and releases what it owns.
    *
    * Everything but an established RTCPeerConnection is released: timers, the
-   * receive buffer, and the peer connection when it never connected.
+   * QR codes sent and received, and the peer connection when it never connected.
    */
   private finish(
     session: PairingSessionState,
@@ -931,9 +931,10 @@ export class PairingController {
     this.clearTimer(session);
     session.scanAbort?.abort();
     this.releaseDisplay(session);
+    // The codes carry the pairing code, SDP and all. Once the exchange is over,
+    // connected or not, nothing reads them again, so they are not kept.
+    this.dropCodes(session);
     if (!connected) {
-      session.assembler.clear();
-      session.candidate.clear();
       if (session.peerCreated) {
         try {
           this.webrtc().closePeer(session.remotePeerId);
@@ -950,6 +951,15 @@ export class PairingController {
     }
   }
 
+  /** Forgets the codes this session made and the codes it received. */
+  private dropCodes(session: PairingSessionState): void {
+    session.outgoing = undefined;
+    session.outgoingSvgs = [];
+    session.outgoingCurrentIndex = -1;
+    session.assembler.clear();
+    session.candidate.clear();
+  }
+
   private failFrom(session: PairingSessionState, error: unknown): void {
     const code: PairingErrorCode =
       error instanceof QrPairingError ? error.code : 'webrtc-rejected';