Skip to content

Commit 24a045d

Browse files
hughnshughns
committed
Make default be v1
1 parent 3120ab5 commit 24a045d

File tree

4 files changed

+35
-16
lines changed

4 files changed

+35
-16
lines changed

‎spec/unit/rendezvous/rendezvousv1.spec.ts‎

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -127,7 +127,7 @@ describe("RendezvousV1", function () {
127127
fetchFn,
128128
});
129129
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport);
130-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, true);
130+
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
131131

132132
expect(aliceRz.code).toBeUndefined();
133133

@@ -183,7 +183,7 @@ describe("RendezvousV1", function () {
183183
msc3886Enabled: false,
184184
});
185185
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
186-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, true);
186+
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
187187
aliceTransport.onCancelled = aliceOnFailure;
188188
await aliceRz.generateCode();
189189
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;
@@ -237,7 +237,7 @@ describe("RendezvousV1", function () {
237237
msc3886Enabled: false,
238238
});
239239
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
240-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, true);
240+
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
241241
aliceTransport.onCancelled = aliceOnFailure;
242242
await aliceRz.generateCode();
243243
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;
@@ -298,7 +298,7 @@ describe("RendezvousV1", function () {
298298
msc3886Enabled: false,
299299
});
300300
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
301-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, true);
301+
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
302302
aliceTransport.onCancelled = aliceOnFailure;
303303
await aliceRz.generateCode();
304304
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;
@@ -358,7 +358,7 @@ describe("RendezvousV1", function () {
358358
msc3886Enabled: false,
359359
});
360360
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
361-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, true);
361+
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
362362
aliceTransport.onCancelled = aliceOnFailure;
363363
await aliceRz.generateCode();
364364
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;
@@ -416,7 +416,7 @@ describe("RendezvousV1", function () {
416416
msc3886Enabled: false,
417417
});
418418
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
419-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, true);
419+
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
420420
aliceTransport.onCancelled = aliceOnFailure;
421421
await aliceRz.generateCode();
422422
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;
@@ -474,7 +474,7 @@ describe("RendezvousV1", function () {
474474
msc3886Enabled: false,
475475
});
476476
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
477-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, true);
477+
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
478478
aliceTransport.onCancelled = aliceOnFailure;
479479
await aliceRz.generateCode();
480480
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;
@@ -534,7 +534,7 @@ describe("RendezvousV1", function () {
534534
msc3886Enabled: false,
535535
});
536536
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
537-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, true);
537+
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
538538
aliceTransport.onCancelled = aliceOnFailure;
539539
await aliceRz.generateCode();
540540
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;
@@ -608,7 +608,12 @@ describe("RendezvousV1", function () {
608608
},
609609
});
610610
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
611-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice, undefined, startInV1FallbackMode);
611+
const aliceRz = new MSC3906Rendezvous(
612+
aliceEcdh,
613+
alice,
614+
undefined,
615+
startInV1FallbackMode ? "org.matrix.msc3906.v1" : "org.matrix.msc3906.setup.additional_device.v2",
616+
);
612617
aliceTransport.onCancelled = aliceOnFailure;
613618
await aliceRz.generateCode();
614619
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;

‎spec/unit/rendezvous/rendezvousv2.spec.ts‎

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -130,7 +130,12 @@ describe("RendezvousV2", function () {
130130
...aliceOpts,
131131
});
132132
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport, undefined, aliceOnFailure);
133-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
133+
const aliceRz = new MSC3906Rendezvous(
134+
aliceEcdh,
135+
alice,
136+
undefined,
137+
"org.matrix.msc3906.setup.additional_device.v2",
138+
);
134139
aliceTransport.onCancelled = aliceOnFailure;
135140
await aliceRz.generateCode();
136141
const code = JSON.parse(aliceRz.code!) as ECDHRendezvousCode;
@@ -219,7 +224,12 @@ describe("RendezvousV2", function () {
219224
fetchFn,
220225
});
221226
const aliceEcdh = new MSC3903ECDHRendezvousChannel(aliceTransport);
222-
const aliceRz = new MSC3906Rendezvous(aliceEcdh, alice);
227+
const aliceRz = new MSC3906Rendezvous(
228+
aliceEcdh,
229+
alice,
230+
undefined,
231+
"org.matrix.msc3906.setup.additional_device.v2",
232+
);
223233

224234
expect(aliceRz.code).toBeUndefined();
225235

‎src/rendezvous/MSC3906Rendezvous.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,7 @@ import {
2222
RendezvousFailureReason,
2323
RendezvousFlow,
2424
RendezvousIntent,
25+
SETUP_ADDITIONAL_DEVICE_FLOW_V1,
2526
SETUP_ADDITIONAL_DEVICE_FLOW_V2,
2627
} from ".";
2728
import { MatrixClient } from "../client";
@@ -94,23 +95,22 @@ export class MSC3906Rendezvous {
9495
private newDeviceId?: string;
9596
private newDeviceKey?: string;
9697
private ourIntent: RendezvousIntent = RendezvousIntent.RECIPROCATE_LOGIN_ON_EXISTING_DEVICE;
97-
private flow: RendezvousFlow = SETUP_ADDITIONAL_DEVICE_FLOW_V2.name;
9898
private v1FallbackEnabled: boolean;
9999
private _code?: string;
100100

101101
/**
102102
* @param channel - The secure channel used for communication
103103
* @param client - The Matrix client in used on the device already logged in
104104
* @param onFailure - Callback for when the rendezvous fails
105-
* @param startInV1FallbackMode - Whether to start in v1 fallback mode
105+
* @param flow - The flow to use. Defaults to MSC3906 v1 for backwards compatibility.
106106
*/
107107
public constructor(
108108
private channel: RendezvousChannel<MSC3906RendezvousPayload>,
109109
private client: MatrixClient,
110110
public onFailure?: RendezvousFailureListener,
111-
startInV1FallbackMode = false,
111+
private flow: RendezvousFlow = SETUP_ADDITIONAL_DEVICE_FLOW_V1,
112112
) {
113-
this.v1FallbackEnabled = startInV1FallbackMode ?? false;
113+
this.v1FallbackEnabled = flow === SETUP_ADDITIONAL_DEVICE_FLOW_V1;
114114
}
115115

116116
/**

‎src/rendezvous/RendezvousFlow.ts‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,15 @@ limitations under the License.
1616

1717
import { UnstableValue } from "../NamespacedValue";
1818

19+
export const SETUP_ADDITIONAL_DEVICE_FLOW_V1 = "org.matrix.msc3906.v1";
20+
1921
export const SETUP_ADDITIONAL_DEVICE_FLOW_V2 = new UnstableValue(
2022
"m.setup.additional_device.v2",
2123
"org.matrix.msc3906.setup.additional_device.v2",
2224
);
2325

26+
// v1 is never included in the JSON, but we give it a name for the sake of determining the flow to use
2427
export type RendezvousFlow =
2528
| typeof SETUP_ADDITIONAL_DEVICE_FLOW_V2.name
26-
| typeof SETUP_ADDITIONAL_DEVICE_FLOW_V2.altName;
29+
| typeof SETUP_ADDITIONAL_DEVICE_FLOW_V2.altName
30+
| typeof SETUP_ADDITIONAL_DEVICE_FLOW_V1;

0 commit comments

Comments
 (0)