summaryrefslogtreecommitdiffstats
path: root/browser/components/payments/content/paymentDialogWrapper.js
blob: c72068961d78e77bbbee1394f735dce888ccf7b6 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
/* This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

/**
 * Runs in the privileged outer dialog. Each dialog loads this script in its
 * own scope.
 */

/* exported paymentDialogWrapper */

"use strict";

const paymentSrv = Cc[
  "@mozilla.org/dom/payments/payment-request-service;1"
].getService(Ci.nsIPaymentRequestService);

const paymentUISrv = Cc[
  "@mozilla.org/dom/payments/payment-ui-service;1"
].getService(Ci.nsIPaymentUIService);

const { AppConstants } = ChromeUtils.import(
  "resource://gre/modules/AppConstants.jsm"
);
const { Services } = ChromeUtils.import("resource://gre/modules/Services.jsm");
const { XPCOMUtils } = ChromeUtils.import(
  "resource://gre/modules/XPCOMUtils.jsm"
);

ChromeUtils.defineModuleGetter(
  this,
  "BrowserWindowTracker",
  "resource:///modules/BrowserWindowTracker.jsm"
);
ChromeUtils.defineModuleGetter(
  this,
  "FormAutofillUtils",
  "resource://formautofill/FormAutofillUtils.jsm"
);
ChromeUtils.defineModuleGetter(
  this,
  "OSKeyStore",
  "resource://gre/modules/OSKeyStore.jsm"
);
ChromeUtils.defineModuleGetter(
  this,
  "PrivateBrowsingUtils",
  "resource://gre/modules/PrivateBrowsingUtils.jsm"
);

XPCOMUtils.defineLazyGetter(this, "formAutofillStorage", () => {
  let storage;
  try {
    storage = ChromeUtils.import(
      "resource://formautofill/FormAutofillStorage.jsm",
      {}
    ).formAutofillStorage;
    storage.initialize();
  } catch (ex) {
    storage = null;
    Cu.reportError(ex);
  }

  return storage;
});

XPCOMUtils.defineLazyGetter(this, "reauthPasswordPromptMessage", () => {
  const brandShortName = FormAutofillUtils.brandBundle.GetStringFromName(
    "brandShortName"
  );
  // The string name for Mac is changed because the value needed updating.
  const platform = AppConstants.platform.replace("macosx", "macos");
  return FormAutofillUtils.stringBundle.formatStringFromName(
    `useCreditCardPasswordPrompt.${platform}`,
    [brandShortName]
  );
});

/**
 * Temporary/transient storage for address and credit card records
 *
 * Implements a subset of the FormAutofillStorage collection class interface, and delegates to
 * those classes for some utility methods
 */
class TempCollection {
  constructor(type, data = {}) {
    /**
     * The name of the collection. e.g. 'addresses' or 'creditCards'
     * Used to access methods from the FormAutofillStorage collections
     */
    this._type = type;
    this._data = data;
  }

  get _formAutofillCollection() {
    // lazy getter for the formAutofill collection - to resolve on first access
    Object.defineProperty(this, "_formAutofillCollection", {
      value: formAutofillStorage[this._type],
      writable: false,
      configurable: true,
    });
    return this._formAutofillCollection;
  }

  get(guid) {
    return this._data[guid];
  }

  async update(guid, record, preserveOldProperties) {
    let recordToSave = Object.assign(
      preserveOldProperties ? this._data[guid] : {},
      record
    );
    await this._formAutofillCollection.computeFields(recordToSave);
    return (this._data[guid] = recordToSave);
  }

  async add(record) {
    let guid = "temp-" + Math.abs((Math.random() * 0xffffffff) | 0);
    let timeLastModified = Date.now();
    let recordToSave = Object.assign({ guid, timeLastModified }, record);
    await this._formAutofillCollection.computeFields(recordToSave);
    this._data[guid] = recordToSave;
    return guid;
  }

  getAll() {
    return this._data;
  }
}

var paymentDialogWrapper = {
  componentsLoaded: new Map(),
  frameWeakRef: null,
  mm: null,
  request: null,
  temporaryStore: null,

  QueryInterface: ChromeUtils.generateQI([
    "nsIObserver",
    "nsISupportsWeakReference",
  ]),

  /**
   * @param {string} guid
   * @returns {object} containing only the requested payer values.
   */
  async _convertProfileAddressToPayerData(guid) {
    let addressData =
      this.temporaryStore.addresses.get(guid) ||
      (await formAutofillStorage.addresses.get(guid));
    if (!addressData) {
      throw new Error(`Payer address not found: ${guid}`);
    }

    let {
      requestPayerName,
      requestPayerEmail,
      requestPayerPhone,
    } = this.request.paymentOptions;

    let payerData = {
      payerName: requestPayerName ? addressData.name : "",
      payerEmail: requestPayerEmail ? addressData.email : "",
      payerPhone: requestPayerPhone ? addressData.tel : "",
    };

    return payerData;
  },

  /**
   * @param {string} guid
   * @returns {nsIPaymentAddress}
   */
  async _convertProfileAddressToPaymentAddress(guid) {
    let addressData =
      this.temporaryStore.addresses.get(guid) ||
      (await formAutofillStorage.addresses.get(guid));
    if (!addressData) {
      throw new Error(`Address not found: ${guid}`);
    }

    let address = this.createPaymentAddress({
      addressLines: addressData["street-address"].split("\n"),
      city: addressData["address-level2"],
      country: addressData.country,
      dependentLocality: addressData["address-level3"],
      organization: addressData.organization,
      phone: addressData.tel,
      postalCode: addressData["postal-code"],
      recipient: addressData.name,
      region: addressData["address-level1"],
      // TODO (bug 1474905), The regionCode will be available when bug 1474905 is fixed
      // and the region text box is changed to a dropdown with the regionCode being the
      // value of the option and the region being the label for the option.
      // A regionCode should be either the empty string or one to three code points
      // that represent a region as the code element of an [ISO3166-2] country subdivision
      // name (i.e., the characters after the hyphen in an ISO3166-2 country subdivision
      // code element, such as "CA" for the state of California in the USA, or "11" for
      // the Lisbon district of Portugal).
      regionCode: "",
    });

    return address;
  },

  /**
   * @param {string} guid The GUID of the basic card record from storage.
   * @param {string} cardSecurityCode The associated card security code (CVV/CCV/etc.)
   * @throws If there is an error decrypting
   * @returns {nsIBasicCardResponseData?} returns response data or null (if the
   *                                      master password dialog was cancelled);
   */
  async _convertProfileBasicCardToPaymentMethodData(guid, cardSecurityCode) {
    let cardData =
      this.temporaryStore.creditCards.get(guid) ||
      (await formAutofillStorage.creditCards.get(guid));
    if (!cardData) {
      throw new Error(`Basic card not found in storage: ${guid}`);
    }

    let cardNumber;
    try {
      cardNumber = await OSKeyStore.decrypt(
        cardData["cc-number-encrypted"],
        reauthPasswordPromptMessage
      );
    } catch (ex) {
      if (ex.result != Cr.NS_ERROR_ABORT) {
        throw ex;
      }
      // User canceled master password entry
      return null;
    }

    let billingAddressGUID = cardData.billingAddressGUID;
    let billingAddress;
    try {
      billingAddress = await this._convertProfileAddressToPaymentAddress(
        billingAddressGUID
      );
    } catch (ex) {
      // The referenced address may not exist if it was deleted or hasn't yet synced to this profile
      Cu.reportError(ex);
    }
    let methodData = this.createBasicCardResponseData({
      cardholderName: cardData["cc-name"],
      cardNumber,
      expiryMonth: cardData["cc-exp-month"].toString().padStart(2, "0"),
      expiryYear: cardData["cc-exp-year"].toString(),
      cardSecurityCode,
      billingAddress,
    });

    return methodData;
  },

  init(requestId, frame) {
    if (!requestId || typeof requestId != "string") {
      throw new Error("Invalid PaymentRequest ID");
    }

    // The Request object returned by the Payment Service is live and
    // will automatically get updated if event.updateWith is used.
    this.request = paymentSrv.getPaymentRequestById(requestId);

    if (!this.request) {
      throw new Error(`PaymentRequest not found: ${requestId}`);
    }

    this._attachToFrame(frame);
    this.mm.loadFrameScript(
      "chrome://payments/content/paymentDialogFrameScript.js",
      true
    );
    // Until we have bug 1446164 and bug 1407418 we use form autofill's temporary
    // shim for data-localization* attributes.
    this.mm.loadFrameScript("chrome://formautofill/content/l10n.js", true);
    frame.setAttribute("src", "resource://payments/paymentRequest.xhtml");

    this.temporaryStore = {
      addresses: new TempCollection("addresses"),
      creditCards: new TempCollection("creditCards"),
    };
  },

  uninit() {
    try {
      Services.obs.removeObserver(this, "message-manager-close");
      Services.obs.removeObserver(this, "formautofill-storage-changed");
    } catch (ex) {
      // Observers may not have been added yet
    }
  },

  /**
   * Code here will be re-run at various times, e.g. initial show and
   * when a tab is detached to a different window.
   *
   * Code that should only run once belongs in `init`.
   * Code to only run upon detaching should be in `changeAttachedFrame`.
   *
   * @param {Element} frame
   */
  _attachToFrame(frame) {
    this.frameWeakRef = Cu.getWeakReference(frame);
    this.mm = frame.frameLoader.messageManager;
    this.mm.addMessageListener("paymentContentToChrome", this);
    Services.obs.addObserver(this, "message-manager-close", true);
  },

  /**
   * Called only when a frame is changed from one to another.
   *
   * @param {Element} frame
   */
  changeAttachedFrame(frame) {
    this.mm.removeMessageListener("paymentContentToChrome", this);
    this._attachToFrame(frame);
    // This isn't in `attachToFrame` because we only want to do it once we've sent records.
    Services.obs.addObserver(this, "formautofill-storage-changed", true);
  },

  createShowResponse({
    acceptStatus,
    methodName = "",
    methodData = null,
    payerName = "",
    payerEmail = "",
    payerPhone = "",
  }) {
    let showResponse = this.createComponentInstance(
      Ci.nsIPaymentShowActionResponse
    );

    showResponse.init(
      this.request.requestId,
      acceptStatus,
      methodName,
      methodData,
      payerName,
      payerEmail,
      payerPhone
    );
    return showResponse;
  },

  createBasicCardResponseData({
    cardholderName = "",
    cardNumber,
    expiryMonth = "",
    expiryYear = "",
    cardSecurityCode = "",
    billingAddress = null,
  }) {
    const basicCardResponseData = Cc[
      "@mozilla.org/dom/payments/basiccard-response-data;1"
    ].createInstance(Ci.nsIBasicCardResponseData);
    basicCardResponseData.initData(
      cardholderName,
      cardNumber,
      expiryMonth,
      expiryYear,
      cardSecurityCode,
      billingAddress
    );
    return basicCardResponseData;
  },

  createPaymentAddress({
    addressLines = [],
    city = "",
    country = "",
    dependentLocality = "",
    organization = "",
    postalCode = "",
    phone = "",
    recipient = "",
    region = "",
    regionCode = "",
    sortingCode = "",
  }) {
    const paymentAddress = Cc[
      "@mozilla.org/dom/payments/payment-address;1"
    ].createInstance(Ci.nsIPaymentAddress);
    const addressLine = Cc["@mozilla.org/array;1"].createInstance(
      Ci.nsIMutableArray
    );
    for (let line of addressLines) {
      const address = Cc["@mozilla.org/supports-string;1"].createInstance(
        Ci.nsISupportsString
      );
      address.data = line;
      addressLine.appendElement(address);
    }
    paymentAddress.init(
      country,
      addressLine,
      region,
      regionCode,
      city,
      dependentLocality,
      postalCode,
      sortingCode,
      organization,
      recipient,
      phone
    );
    return paymentAddress;
  },

  createComponentInstance(componentInterface) {
    let componentName;
    switch (componentInterface) {
      case Ci.nsIPaymentShowActionResponse: {
        componentName =
          "@mozilla.org/dom/payments/payment-show-action-response;1";
        break;
      }
      case Ci.nsIGeneralResponseData: {
        componentName = "@mozilla.org/dom/payments/general-response-data;1";
        break;
      }
    }
    let component = this.componentsLoaded.get(componentName);

    if (!component) {
      component = Cc[componentName];
      this.componentsLoaded.set(componentName, component);
    }

    return component.createInstance(componentInterface);
  },

  async fetchSavedAddresses() {
    let savedAddresses = {};
    for (let address of await formAutofillStorage.addresses.getAll()) {
      savedAddresses[address.guid] = address;
    }
    return savedAddresses;
  },

  async fetchSavedPaymentCards() {
    let savedBasicCards = {};
    for (let card of await formAutofillStorage.creditCards.getAll()) {
      savedBasicCards[card.guid] = card;
      // Filter out the encrypted card number since the dialog content is
      // considered untrusted and runs in a content process.
      delete card["cc-number-encrypted"];

      // ensure each card has a methodName property
      if (!card.methodName) {
        card.methodName = "basic-card";
      }
    }
    return savedBasicCards;
  },

  fetchTempPaymentCards() {
    let creditCards = this.temporaryStore.creditCards.getAll();
    for (let card of Object.values(creditCards)) {
      // Ensure each card has a methodName property.
      if (!card.methodName) {
        card.methodName = "basic-card";
      }
    }
    return creditCards;
  },

  async onAutofillStorageChange() {
    let [savedAddresses, savedBasicCards] = await Promise.all([
      this.fetchSavedAddresses(),
      this.fetchSavedPaymentCards(),
    ]);

    this.sendMessageToContent("updateState", {
      savedAddresses,
      savedBasicCards,
    });
  },

  sendMessageToContent(messageType, data = {}) {
    this.mm.sendAsyncMessage("paymentChromeToContent", {
      data,
      messageType,
    });
  },

  updateRequest() {
    // There is no need to update this.request since the object is live
    // and will automatically get updated if event.updateWith is used.
    let requestSerialized = this._serializeRequest(this.request);

    this.sendMessageToContent("updateState", {
      request: requestSerialized,
    });
  },

  /**
   * Recursively convert and filter input to the subset of data types supported by JSON
   *
   * @param {*} value - any type of input to serialize
   * @param {string?} name - name or key associated with this input.
   *                         E.g. property name or array index.
   * @returns {*} serialized deep copy of the value
   */
  _serializeRequest(value, name = null) {
    // Primitives: String, Number, Boolean, null
    let type = typeof value;
    if (
      value === null ||
      type == "string" ||
      type == "number" ||
      type == "boolean"
    ) {
      return value;
    }
    if (name == "topLevelPrincipal") {
      // Manually serialize the nsIPrincipal.
      let displayHost = value.URI.displayHost;
      return {
        URI: {
          displayHost,
        },
      };
    }
    if (type == "function" || type == "undefined") {
      return undefined;
    }
    // Structures: nsIArray
    if (value instanceof Ci.nsIArray) {
      let iface;
      let items = [];
      switch (name) {
        case "displayItems": // falls through
        case "additionalDisplayItems":
          iface = Ci.nsIPaymentItem;
          break;
        case "shippingOptions":
          iface = Ci.nsIPaymentShippingOption;
          break;
        case "paymentMethods":
          iface = Ci.nsIPaymentMethodData;
          break;
        case "modifiers":
          iface = Ci.nsIPaymentDetailsModifier;
          break;
      }
      if (!iface) {
        throw new Error(
          `No interface associated with the members of the ${name} nsIArray`
        );
      }
      for (let i = 0; i < value.length; i++) {
        let item = value.queryElementAt(i, iface);
        let result = this._serializeRequest(item, i);
        if (result !== undefined) {
          items.push(result);
        }
      }
      return items;
    }
    // Structures: Arrays
    if (Array.isArray(value)) {
      let items = value
        .map(item => this._serializeRequest(item))
        .filter(item => item !== undefined);
      return items;
    }
    // Structures: Objects
    let obj = {};
    for (let [key, item] of Object.entries(value)) {
      let result = this._serializeRequest(item, key);
      if (result !== undefined) {
        obj[key] = result;
      }
    }
    return obj;
  },

  async initializeFrame() {
    // We don't do this earlier as it's only necessary once this function sends
    // the initial saved records.
    Services.obs.addObserver(this, "formautofill-storage-changed", true);

    let requestSerialized = this._serializeRequest(this.request);
    let chromeWindow = this.frameWeakRef.get().ownerGlobal;
    let isPrivate = PrivateBrowsingUtils.isWindowPrivate(chromeWindow);

    let [savedAddresses, savedBasicCards] = await Promise.all([
      this.fetchSavedAddresses(),
      this.fetchSavedPaymentCards(),
    ]);

    this.sendMessageToContent("showPaymentRequest", {
      request: requestSerialized,
      savedAddresses,
      tempAddresses: this.temporaryStore.addresses.getAll(),
      savedBasicCards,
      tempBasicCards: this.fetchTempPaymentCards(),
      isPrivate,
    });
  },

  debugFrame() {
    // To avoid self-XSS-type attacks, ensure that Browser Chrome debugging is enabled.
    if (!Services.prefs.getBoolPref("devtools.chrome.enabled", false)) {
      Cu.reportError(
        "devtools.chrome.enabled must be enabled to debug the frame"
      );
      return;
    }
    const { require } = ChromeUtils.import(
      "resource://devtools/shared/Loader.jsm"
    );
    const {
      gDevToolsBrowser,
    } = require("devtools/client/framework/devtools-browser");
    gDevToolsBrowser.openContentProcessToolbox({
      selectedBrowser: this.frameWeakRef.get(),
    });
  },

  onOpenPreferences() {
    BrowserWindowTracker.getTopWindow().openPreferences(
      "privacy-form-autofill"
    );
  },

  onPaymentCancel() {
    const showResponse = this.createShowResponse({
      acceptStatus: Ci.nsIPaymentActionResponse.PAYMENT_REJECTED,
    });

    paymentSrv.respondPayment(showResponse);
    paymentUISrv.closePayment(this.request.requestId);
  },

  async onPay({
    selectedPayerAddressGUID: payerGUID,
    selectedPaymentCardGUID: paymentCardGUID,
    selectedPaymentCardSecurityCode: cardSecurityCode,
    selectedShippingAddressGUID: shippingGUID,
  }) {
    let methodData;
    try {
      methodData = await this._convertProfileBasicCardToPaymentMethodData(
        paymentCardGUID,
        cardSecurityCode
      );
    } catch (ex) {
      // TODO (Bug 1498403): Some kind of "credit card storage error" here, perhaps asking user
      // to re-enter credit card # from management UI.
      Cu.reportError(ex);
      return;
    }

    if (!methodData) {
      // TODO (Bug 1429265/Bug 1429205): Handle when a user hits cancel on the
      // Master Password dialog.
      Cu.reportError(
        "Bug 1429265/Bug 1429205: User canceled master password entry"
      );
      return;
    }

    let payerName = "";
    let payerEmail = "";
    let payerPhone = "";
    if (payerGUID) {
      let payerData = await this._convertProfileAddressToPayerData(payerGUID);
      payerName = payerData.payerName;
      payerEmail = payerData.payerEmail;
      payerPhone = payerData.payerPhone;
    }

    // Update the lastUsedTime for the payerAddress and paymentCard. Check if
    // the record exists in formAutofillStorage because it may be temporary.
    if (
      shippingGUID &&
      (await formAutofillStorage.addresses.get(shippingGUID))
    ) {
      formAutofillStorage.addresses.notifyUsed(shippingGUID);
    }
    if (payerGUID && (await formAutofillStorage.addresses.get(payerGUID))) {
      formAutofillStorage.addresses.notifyUsed(payerGUID);
    }
    if (await formAutofillStorage.creditCards.get(paymentCardGUID)) {
      formAutofillStorage.creditCards.notifyUsed(paymentCardGUID);
    }

    this.pay({
      methodName: "basic-card",
      methodData,
      payerName,
      payerEmail,
      payerPhone,
    });
  },

  pay({ payerName, payerEmail, payerPhone, methodName, methodData }) {
    const showResponse = this.createShowResponse({
      acceptStatus: Ci.nsIPaymentActionResponse.PAYMENT_ACCEPTED,
      payerName,
      payerEmail,
      payerPhone,
      methodName,
      methodData,
    });
    paymentSrv.respondPayment(showResponse);
    this.sendMessageToContent("responseSent");
  },

  async onChangePayerAddress({ payerAddressGUID }) {
    if (payerAddressGUID) {
      // If a payer address was de-selected e.g. the selected address was deleted, we'll
      // just wait to send the address change when the payer address is eventually selected
      // before clicking Pay since it's a required field.
      let {
        payerName,
        payerEmail,
        payerPhone,
      } = await this._convertProfileAddressToPayerData(payerAddressGUID);
      paymentSrv.changePayerDetail(
        this.request.requestId,
        payerName,
        payerEmail,
        payerPhone
      );
    }
  },

  async onChangePaymentMethod({
    selectedPaymentCardBillingAddressGUID: billingAddressGUID,
  }) {
    const methodName = "basic-card";
    let methodDetails;
    try {
      let billingAddress = await this._convertProfileAddressToPaymentAddress(
        billingAddressGUID
      );
      const basicCardChangeDetails = Cc[
        "@mozilla.org/dom/payments/basiccard-change-details;1"
      ].createInstance(Ci.nsIBasicCardChangeDetails);
      basicCardChangeDetails.initData(billingAddress);
      methodDetails = basicCardChangeDetails.QueryInterface(
        Ci.nsIMethodChangeDetails
      );
    } catch (ex) {
      // TODO (Bug 1498403): Some kind of "credit card storage error" here, perhaps asking user
      // to re-enter credit card # from management UI.
      Cu.reportError(ex);
      return;
    }

    paymentSrv.changePaymentMethod(
      this.request.requestId,
      methodName,
      methodDetails
    );
  },

  async onChangeShippingAddress({ shippingAddressGUID }) {
    if (shippingAddressGUID) {
      // If a shipping address was de-selected e.g. the selected address was deleted, we'll
      // just wait to send the address change when the shipping address is eventually selected
      // before clicking Pay since it's a required field.
      let address = await this._convertProfileAddressToPaymentAddress(
        shippingAddressGUID
      );
      paymentSrv.changeShippingAddress(this.request.requestId, address);
    }
  },

  onChangeShippingOption({ optionID }) {
    // Note, failing here on browser_host_name.js because the test closes
    // the dialog before the onChangeShippingOption is called, thus
    // deleting the request and making the requestId invalid. Unclear
    // why we aren't seeing the same issue with onChangeShippingAddress.
    paymentSrv.changeShippingOption(this.request.requestId, optionID);
  },

  onCloseDialogMessage() {
    // The PR is complete(), just close the dialog
    paymentUISrv.closePayment(this.request.requestId);
  },

  async onUpdateAutofillRecord(collectionName, record, guid, messageID) {
    let responseMessage = {
      guid,
      messageID,
      stateChange: {},
    };
    try {
      let isTemporary = record.isTemporary;
      let collection = isTemporary
        ? this.temporaryStore[collectionName]
        : formAutofillStorage[collectionName];

      if (guid) {
        // We want to preserve old properties since the edit forms are often
        // shown without all fields visible/enabled and we don't want those
        // fields to be blanked upon saving. Examples of hidden/disabled fields:
        // email, cc-number, mailing-address on the payer forms, and payer fields
        // not requested in the payer form.
        let preserveOldProperties = true;
        await collection.update(guid, record, preserveOldProperties);
      } else {
        responseMessage.guid = await collection.add(record);
      }

      if (isTemporary && collectionName == "addresses") {
        // there will be no formautofill-storage-changed event to update state
        // so add updated collection here
        Object.assign(responseMessage.stateChange, {
          tempAddresses: this.temporaryStore.addresses.getAll(),
        });
      }
      if (isTemporary && collectionName == "creditCards") {
        // there will be no formautofill-storage-changed event to update state
        // so add updated collection here
        Object.assign(responseMessage.stateChange, {
          tempBasicCards: this.fetchTempPaymentCards(),
        });
      }
    } catch (ex) {
      responseMessage.error = true;
      Cu.reportError(ex);
    } finally {
      this.sendMessageToContent(
        "updateAutofillRecord:Response",
        responseMessage
      );
    }
  },

  /**
   * @implements {nsIObserver}
   * @param {nsISupports} subject
   * @param {string} topic
   * @param {string} data
   */
  observe(subject, topic, data) {
    switch (topic) {
      case "formautofill-storage-changed": {
        if (data == "notifyUsed") {
          break;
        }
        this.onAutofillStorageChange();
        break;
      }
      case "message-manager-close": {
        if (this.mm && subject == this.mm) {
          // Remove the observer to avoid message manager errors while the dialog
          // is closing and tests are cleaning up autofill storage.
          Services.obs.removeObserver(this, "formautofill-storage-changed");
        }
        break;
      }
    }
  },

  receiveMessage({ data }) {
    let { messageType } = data;

    switch (messageType) {
      case "debugFrame": {
        this.debugFrame();
        break;
      }
      case "initializeRequest": {
        this.initializeFrame();
        break;
      }
      case "changePayerAddress": {
        this.onChangePayerAddress(data);
        break;
      }
      case "changePaymentMethod": {
        this.onChangePaymentMethod(data);
        break;
      }
      case "changeShippingAddress": {
        this.onChangeShippingAddress(data);
        break;
      }
      case "changeShippingOption": {
        this.onChangeShippingOption(data);
        break;
      }
      case "closeDialog": {
        this.onCloseDialogMessage();
        break;
      }
      case "openPreferences": {
        this.onOpenPreferences();
        break;
      }
      case "paymentCancel": {
        this.onPaymentCancel();
        break;
      }
      case "paymentDialogReady": {
        this.frameWeakRef.get().dispatchEvent(
          new Event("tabmodaldialogready", {
            bubbles: true,
          })
        );
        break;
      }
      case "pay": {
        this.onPay(data);
        break;
      }
      case "updateAutofillRecord": {
        this.onUpdateAutofillRecord(
          data.collectionName,
          data.record,
          data.guid,
          data.messageID
        );
        break;
      }
      default: {
        throw new Error(
          `paymentDialogWrapper: Unexpected messageType: ${messageType}`
        );
      }
    }
  },
};