From 1428df8567a0a3ce354c8371aeb7b342e3960b86 Mon Sep 17 00:00:00 2001
From: Robin <robin@robin.town>
Date: Wed, 3 Sep 2025 16:52:40 +0200
Subject: [PATCH] Tentatively rename URL parameter to waitForCallPickup

---
 src/UrlParams.ts                | 10 +++++-----
 src/state/CallViewModel.test.ts | 14 +++++++-------
 src/state/CallViewModel.ts      |  4 ++--
 3 files changed, 14 insertions(+), 14 deletions(-)

diff --git a/src/UrlParams.ts b/src/UrlParams.ts
index a26045b5..5f43b17f 100644
--- a/src/UrlParams.ts
+++ b/src/UrlParams.ts
@@ -226,7 +226,7 @@ export interface UrlConfiguration {
    *  - play a sound that indicates that it is awaiting an answer
    *  - auto-dismiss the call widget once the notification lifetime expires on the receivers side.
    */
-  shouldWaitForCallPickup: boolean;
+  waitForCallPickup: boolean;
 }
 
 // If you need to add a new flag to this interface, prefer a name that describes
@@ -358,7 +358,7 @@ export const getUrlParams = (
     returnToLobby: false,
     sendNotificationType: "notification" as RTCNotificationType,
     autoLeaveWhenOthersLeft: false,
-    shouldWaitForCallPickup: false,
+    waitForCallPickup: false,
   };
   switch (intent) {
     case UserIntent.StartNewCall:
@@ -378,7 +378,7 @@ export const getUrlParams = (
         ...inAppDefault,
         skipLobby: true,
         autoLeaveWhenOthersLeft: true,
-        shouldWaitForCallPickup: true,
+        waitForCallPickup: true,
       };
       break;
     case UserIntent.JoinExistingCallDM:
@@ -404,7 +404,7 @@ export const getUrlParams = (
         returnToLobby: false,
         sendNotificationType: undefined,
         autoLeaveWhenOthersLeft: false,
-        shouldWaitForCallPickup: false,
+        waitForCallPickup: false,
       };
   }
 
@@ -456,7 +456,7 @@ export const getUrlParams = (
       "ring",
       "notification",
     ]),
-    shouldWaitForCallPickup: parser.getFlag("shouldWaitForCallPickup"),
+    waitForCallPickup: parser.getFlag("waitForCallPickup"),
     autoLeaveWhenOthersLeft: parser.getFlag("autoLeave"),
   };
 
diff --git a/src/state/CallViewModel.test.ts b/src/state/CallViewModel.test.ts
index 75b5e5c4..c30624ae 100644
--- a/src/state/CallViewModel.test.ts
+++ b/src/state/CallViewModel.test.ts
@@ -1193,7 +1193,7 @@ test("autoLeave$ emits when autoLeaveWhenOthersLeft option is enabled and all ot
   });
 });
 
-describe("shouldWaitForCallPickup$", () => {
+describe("waitForCallPickup$", () => {
   test("unknown -> ringing -> timeout when notified and nobody joins", () => {
     withTestScheduler(({ schedule, expectObservable }) => {
       // No one ever joins (only local user)
@@ -1220,7 +1220,7 @@ describe("shouldWaitForCallPickup$", () => {
           });
         },
         {
-          shouldWaitForCallPickup: true,
+          waitForCallPickup: true,
           encryptionSystem: { kind: E2eeType.PER_PARTICIPANT },
         },
       );
@@ -1264,7 +1264,7 @@ describe("shouldWaitForCallPickup$", () => {
           });
         },
         {
-          shouldWaitForCallPickup: true,
+          waitForCallPickup: true,
           encryptionSystem: { kind: E2eeType.PER_PARTICIPANT },
         },
       );
@@ -1305,7 +1305,7 @@ describe("shouldWaitForCallPickup$", () => {
           });
         },
         {
-          shouldWaitForCallPickup: true,
+          waitForCallPickup: true,
           encryptionSystem: { kind: E2eeType.PER_PARTICIPANT },
         },
       );
@@ -1336,14 +1336,14 @@ describe("shouldWaitForCallPickup$", () => {
           });
         },
         {
-          shouldWaitForCallPickup: true,
+          waitForCallPickup: true,
           encryptionSystem: { kind: E2eeType.PER_PARTICIPANT },
         },
       );
     });
   });
 
-  test("stays null when shouldWaitForCallPickup=false", () => {
+  test("stays null when waitForCallPickup=false", () => {
     withTestScheduler(({ behavior, schedule, expectObservable }) => {
       withCallViewModel(
         {
@@ -1375,7 +1375,7 @@ describe("shouldWaitForCallPickup$", () => {
           });
         },
         {
-          shouldWaitForCallPickup: false,
+          waitForCallPickup: false,
           encryptionSystem: { kind: E2eeType.PER_PARTICIPANT },
         },
       );
diff --git a/src/state/CallViewModel.ts b/src/state/CallViewModel.ts
index d4b9537e..9112954f 100644
--- a/src/state/CallViewModel.ts
+++ b/src/state/CallViewModel.ts
@@ -120,7 +120,7 @@ export interface CallViewModelOptions {
    * If the call is started in a way where we want it to behave like a telephone usecase
    * If we sent a notification event, we want the ui to show a ringing state
    */
-  shouldWaitForCallPickup?: boolean;
+  waitForCallPickup?: boolean;
 }
 
 // How long we wait after a focus switch before showing the real participant
@@ -916,7 +916,7 @@ export class CallViewModel extends ViewModel {
    *  - "success": Someone else joined. The call is in a normal state. No audiovisual feedback.
    *  - null: EC is configured to never show any waiting for answer state.
    */
-  public readonly callPickupState$ = this.options.shouldWaitForCallPickup
+  public readonly callPickupState$ = this.options.waitForCallPickup
     ? this.scope.behavior<"unknown" | "ringing" | "timeout" | "success">(
         concat(
           concat(