1982671 - [ews] Eliminate required boilerplate for EWS client operations

Status: ASSIGNED

(MailNews Core :: Networking: Exchange, task)

Description

[Eleanor Dicharry]

Attachment: error_handling.patch

Currently, all of our EWS operations have the following structure:

impl XpComEwsClient {

fn some_operation(...) {
    match self.some_operation_inner(...).await {
        Ok(some_data) => //operation success callback,
       Err(err) => //operation failure callback,
    }
}

fn some_operation_inner(...) -> Result<SomeData, XpComEwsError> {

    // construct input, call self.make_operation_request, parse response

}

}

The structure is there to allow the implementation to propagate errors, but the outer function is almost exactly the same for all of the client operations, so we want to eliminate the boiler plate and have a uniform way of doing this.

I'm attaching a partial patch of some work I did as part of another issue that we decided to hold off on in order come up with a more uniform approach for this.

Comment 1

[Justin Tracey [:jtracey]]

Attachment: WIP: Bug 1982671 - Add more structure to EWS client operations.

Comment 2

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Use operation name constants instead of magic strings. r=#thunderbird-back-end-reviewers

Comment 3

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Add DoOperation trait to represent doing EWS operations. r=#thunderbird-back-end-reviewers

The new trait is demonstrated with XpComEwsClient::check_connectivity.

Comment 4

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for CreateFolder. r=#thunderbird-back-end-reviewers

Comment 5

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for copy/move operations. r=#thunderbird-back-end-reviewers

Comment 6

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for MarkAsJunk. r=#thunderbird-back-end-reviewers

Comment 7

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for SyncFolderHierarchy. r=#thunderbird-back-end-reviewers

Comment 8

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for sync_messages_for_folder. r=#thunderbird-back-end-reviewers

Comment 9

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for GetMessage. r=#thunderbird-back-end-reviewers

Comment 10

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for SendMessage. r=#thunderbird-back-end-reviewers

Comment 11

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for create_message. r=#thunderbird-back-end-reviewers

Comment 12

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for delete_messages. r=#thunderbird-back-end-reviewers

Comment 13

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for DeleteFolder. r=#thunderbird-back-end-reviewers

Comment 14

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for UpdateFolder. r=#thunderbird-back-end-reviewers

Comment 15

[Justin Tracey [:jtracey]]

Try run for https://phabricator.services.mozilla.com/D266205 only (failures are unrelated): https://treeherder.mozilla.org/jobs?repo=try-comm-central&revision=acfec97e5a7ee61fdbda60a0f893db254b633243

Comment 16

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Implement DoOperation for change_read_status. r=#thunderbird-back-end-reviewers

Comment 17

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/152dfd0cefbc
Use operation name constants instead of magic strings. r=edicharry

Comment 18

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/4613f65ed3f0
Add DoOperation trait to represent doing EWS operations. r=edicharry

Comment 19

[Magnus Melin [:mkmelin]]

(In reply to Pulsebot from comment #18)
This is breaking the builds - https://treeherder.mozilla.org/jobs?repo=comm-central&revision=4613f65ed3f0a68caf6f4ad4d18bce0ba765b924. Will back out

Comment 20

[Magnus Melin [:mkmelin]]

Backout: https://hg.mozilla.org/comm-central/rev/1f119a62d44928e6845cf2fcc7d067c3f6829757

Comment 21

[Justin Tracey [:jtracey]]

Whoops, didn't properly test the individual patches after rebasing, sorry. New try run for just the one patch: https://treeherder.mozilla.org/jobs?repo=try-comm-central&revision=bc4e042c4ba99852f351701e40618c3ea3d15dc5

Comment 22

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/b7ed54290558
Add DoOperation trait to represent doing EWS operations. r=edicharry

Comment 23

[Justin Tracey [:jtracey]]

Try run for the whole patch set: https://treeherder.mozilla.org/jobs?repo=try-comm-central&revision=307f967cbc3da39f229c02ac2b3e14b243f92654

Comment 24

[Justin Tracey [:jtracey]]

Attachment: Bug 1982671 - Add ServerType helper trait to dedup constraints. r=#thunderbird-back-end-reviewers

Comment 25

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/7dd560b32fe1
Implement DoOperation for CreateFolder. r=edicharry
https://hg.mozilla.org/comm-central/rev/a243076046cf
Implement DoOperation for copy/move operations. r=edicharry
https://hg.mozilla.org/comm-central/rev/cff0d8f078f3
Implement DoOperation for MarkAsJunk. r=edicharry
https://hg.mozilla.org/comm-central/rev/4094ebeab7d0
Implement DoOperation for SyncFolderHierarchy. r=edicharry
https://hg.mozilla.org/comm-central/rev/a9b5793e18d7
Implement DoOperation for sync_messages_for_folder. r=edicharry
https://hg.mozilla.org/comm-central/rev/26550588c2d3
Implement DoOperation for GetMessage. r=edicharry
https://hg.mozilla.org/comm-central/rev/9faae0b6e51b
Implement DoOperation for SendMessage. r=edicharry
https://hg.mozilla.org/comm-central/rev/f226b3d7daa5
Implement DoOperation for create_message. r=edicharry
https://hg.mozilla.org/comm-central/rev/8407475896ee
Implement DoOperation for delete_messages. r=edicharry
https://hg.mozilla.org/comm-central/rev/fe0803ad0e93
Implement DoOperation for DeleteFolder. r=edicharry
https://hg.mozilla.org/comm-central/rev/1cb3aaa42454
Implement DoOperation for UpdateFolder. r=edicharry

Comment 26

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/comm-central/rev/f607e3556a50
Implement DoOperation for change_read_status. r=babolivier