-
Notifications
You must be signed in to change notification settings - Fork 0
Typed sync payloads #1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
7c3d881
document typed Sync payload gap in roadmap
remdev 95cda91
wbxml: raw element field type for opaque payload pass-through
remdev 19bf69b
eas: typed Sync ApplicationData helpers
remdev ee52d05
client: SyncTyped[T] generic wrapper for single-class collections
remdev 6c1ac3f
address PR #1 review feedback
remdev e9ad9ba
address PR #1 second review pass
remdev 441b96e
wbxml: fix off-by-one in CaptureRaw STR_I cap
remdev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -49,7 +49,12 @@ if _, err := c.Provision(ctx, "[email protected]"); err != nil { /* handle */ } | |
| ### Sync new e-mails from the inbox | ||
|
|
||
| ```go | ||
| import "github.com/remdev/go-activesync/eas" | ||
| import ( | ||
| "log" | ||
|
|
||
| "github.com/remdev/go-activesync/client" | ||
| "github.com/remdev/go-activesync/eas" | ||
| ) | ||
|
|
||
| initial, _ := c.Sync(ctx, user, &eas.SyncRequest{ | ||
| Collections: eas.SyncCollections{ | ||
|
|
@@ -58,7 +63,7 @@ initial, _ := c.Sync(ctx, user, &eas.SyncRequest{ | |
| }) | ||
| syncKey := initial.Collections.Collection[0].SyncKey | ||
|
|
||
| resp, _ := c.Sync(ctx, user, &eas.SyncRequest{ | ||
| resp, _ := client.SyncTyped[eas.Email](ctx, c, user, &eas.SyncRequest{ | ||
| Collections: eas.SyncCollections{ | ||
| Collection: []eas.SyncCollection{{ | ||
| SyncKey: syncKey, | ||
|
|
@@ -69,13 +74,20 @@ resp, _ := c.Sync(ctx, user, &eas.SyncRequest{ | |
| }, | ||
| }) | ||
|
|
||
| for _, col := range resp.Collections.Collection { | ||
| for _, add := range col.Commands.Add { | ||
| // add.ApplicationData → typed eas.Email | ||
| for _, col := range resp.Collections { | ||
| for _, add := range col.Add { | ||
| if add.ApplicationData == nil { | ||
| continue | ||
| } | ||
| log.Printf("new mail %s: %s", add.ServerID, add.ApplicationData.Subject) | ||
| } | ||
| } | ||
| ``` | ||
|
|
||
| For mixed-class collections, call `c.Sync` directly and use the | ||
| `SyncAdd.Email()` / `Appointment()` / `Contact()` / `Task()` helpers, or | ||
| project a single collection with `eas.NewTypedSyncResponse[T]`. | ||
|
|
||
| ### Long-poll for changes with Ping | ||
|
|
||
| ```go | ||
|
|
@@ -119,6 +131,7 @@ Implemented and covered by the test suite: | |
| | Auth | HTTP Basic; pluggable `Authenticator` interface | | ||
| | Provisioning | Two-pass MS-ASPROV with auto re-provision on Status 142/143 | | ||
| | Commands | `Provision`, `FolderSync`, `Sync`, `Ping` | | ||
| | Typed Sync | `client.SyncTyped[T]`, `eas.UnmarshalApplicationData[T]`, four helpers | | ||
| | PIM data models | `MS-ASEMAIL`, `MS-ASCAL`, `MS-ASCNTC`, `MS-ASTASK` | | ||
| | Stores | In-memory `PolicyStore` and `SyncStateStore`; pluggable interfaces | | ||
| | Hardening | Bounded decoder allocations + `FuzzDecode` over the WBXML reader | | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| package client | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| "github.com/remdev/go-activesync/eas" | ||
| ) | ||
|
|
||
| // SyncTyped is a generic wrapper around Client.Sync that decodes every | ||
| // SyncAdd / SyncChange ApplicationData into the requested type T. It is | ||
| // intended for the common case of a Sync request that targets a single | ||
| // collection of a single Class (Email, Calendar, Contacts, Tasks). | ||
| // | ||
| // SyncTyped does not surface the raw eas.SyncResponse; callers that need | ||
| // access to the wire-level structure (e.g. to introspect Class / Status per | ||
| // collection while still picking the right T per collection at runtime) | ||
| // should call (*Client).Sync directly and project the response with | ||
| // eas.NewTypedSyncResponse[T] themselves. | ||
| // | ||
| // SPEC: MS-ASCMD/sync.typed | ||
| func SyncTyped[T any](ctx context.Context, c *Client, user string, req *eas.SyncRequest) (*eas.TypedSyncResponse[T], error) { | ||
| resp, err := c.Sync(ctx, user, req) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| return eas.NewTypedSyncResponse[T](resp) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,6 +1,7 @@ | ||
| package client | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "context" | ||
| "io" | ||
| "net/http" | ||
|
|
@@ -270,6 +271,176 @@ func TestSync_RoundTrip(t *testing.T) { | |
| } | ||
| } | ||
|
|
||
| // SPEC: MS-ASCMD/sync.applicationdata.raw | ||
| // SPEC: MS-ASCMD/sync.applicationdata.typed | ||
| func TestSync_TypedApplicationData(t *testing.T) { | ||
| emailIn := &eas.Email{ | ||
| Subject: "hello", | ||
| From: "[email protected]", | ||
| To: "[email protected]", | ||
| } | ||
| body := mustEmailBody(t, emailIn) | ||
|
|
||
| srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| var req eas.SyncRequest | ||
| decodeWBXML(t, r, &req) | ||
| writeWBXML(t, w, &eas.SyncResponse{ | ||
| Collections: eas.SyncCollections{ | ||
| Collection: []eas.SyncCollection{{ | ||
| SyncKey: "S-1", | ||
| CollectionID: "1", | ||
| Class: "Email", | ||
| Status: int32(eas.SyncStatusSuccess), | ||
| Commands: &eas.SyncCommands{ | ||
| Add: []eas.SyncAdd{{ | ||
| ServerID: "1:1", | ||
| ApplicationData: &wbxml.RawElement{ | ||
| Page: wbxml.PageAirSync, | ||
| Bytes: body, | ||
| }, | ||
| }}, | ||
| Change: []eas.SyncChange{{ | ||
| ServerID: "1:1", | ||
| ApplicationData: &wbxml.RawElement{ | ||
| Page: wbxml.PageAirSync, | ||
| Bytes: body, | ||
| }, | ||
| }}, | ||
| }, | ||
| }}, | ||
| }, | ||
| }) | ||
| })) | ||
| t.Cleanup(srv.Close) | ||
|
|
||
| c := newTestClient(t, srv) | ||
| resp, err := c.Sync(context.Background(), "[email protected]", &eas.SyncRequest{ | ||
| Collections: eas.SyncCollections{ | ||
| Collection: []eas.SyncCollection{{SyncKey: "0", CollectionID: "1", GetChanges: 1}}, | ||
| }, | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("Sync: %v", err) | ||
| } | ||
| col := resp.Collections.Collection[0] | ||
| if col.Commands == nil || len(col.Commands.Add) != 1 { | ||
| t.Fatalf("missing Add: %+v", col.Commands) | ||
| } | ||
| add := col.Commands.Add[0] | ||
| if add.ApplicationData == nil { | ||
| t.Fatal("ApplicationData missing on Add") | ||
| } | ||
| got, err := add.Email() | ||
| if err != nil { | ||
| t.Fatalf("add.Email: %v", err) | ||
| } | ||
| if got.Subject != emailIn.Subject || got.From != emailIn.From || got.To != emailIn.To { | ||
| t.Fatalf("Email decode mismatch: %+v", got) | ||
| } | ||
| chg := col.Commands.Change[0] | ||
| got2, err := chg.Email() | ||
| if err != nil { | ||
| t.Fatalf("change.Email: %v", err) | ||
| } | ||
| if got2.Subject != emailIn.Subject { | ||
| t.Fatalf("change Email mismatch: %+v", got2) | ||
| } | ||
| } | ||
|
|
||
| // mustEmailBody marshals an Email value and strips the WBXML header plus | ||
| // the AirSync.ApplicationData wrapper, returning just the bytes that would | ||
| // appear inside ApplicationData on the wire. | ||
| func mustEmailBody(t *testing.T, e *eas.Email) []byte { | ||
| t.Helper() | ||
| data, err := wbxml.Marshal(e) | ||
| if err != nil { | ||
| t.Fatalf("marshal email: %v", err) | ||
| } | ||
| dec := wbxml.NewDecoder(bytes.NewReader(data)) | ||
| if _, err := dec.ReadHeader(); err != nil { | ||
| t.Fatalf("read header: %v", err) | ||
| } | ||
| tok, err := dec.NextToken() | ||
| if err != nil { | ||
| t.Fatalf("next token: %v", err) | ||
| } | ||
| if tok.Kind != wbxml.KindTag { | ||
| t.Fatalf("expected tag, got %s", tok.Kind) | ||
| } | ||
| body, err := dec.CaptureRaw(tok.HasContent) | ||
| if err != nil { | ||
| t.Fatalf("capture raw: %v", err) | ||
| } | ||
| return body | ||
| } | ||
|
|
||
| // SPEC: MS-ASCMD/sync.typed | ||
| func TestSyncTyped_Email(t *testing.T) { | ||
| in := []eas.Email{ | ||
| {Subject: "first", From: "[email protected]", To: "[email protected]"}, | ||
| {Subject: "second", From: "[email protected]", To: "[email protected]"}, | ||
| } | ||
| srv := httptest.NewServer(http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { | ||
| var req eas.SyncRequest | ||
| decodeWBXML(t, r, &req) | ||
| adds := make([]eas.SyncAdd, 0, len(in)) | ||
| for i, e := range in { | ||
| adds = append(adds, eas.SyncAdd{ | ||
| ServerID: serverIDFor(i), | ||
| ApplicationData: &wbxml.RawElement{ | ||
| Page: wbxml.PageAirSync, | ||
| Bytes: mustEmailBody(t, &e), | ||
| }, | ||
| }) | ||
| } | ||
| writeWBXML(t, w, &eas.SyncResponse{ | ||
| Status: int32(eas.SyncStatusSuccess), | ||
| Collections: eas.SyncCollections{ | ||
| Collection: []eas.SyncCollection{{ | ||
| SyncKey: "S-2", | ||
| CollectionID: "1", | ||
| Class: "Email", | ||
| Status: int32(eas.SyncStatusSuccess), | ||
| Commands: &eas.SyncCommands{Add: adds}, | ||
| }}, | ||
| }, | ||
| }) | ||
| })) | ||
| t.Cleanup(srv.Close) | ||
|
|
||
| c := newTestClient(t, srv) | ||
| resp, err := SyncTyped[eas.Email](context.Background(), c, "[email protected]", &eas.SyncRequest{ | ||
| Collections: eas.SyncCollections{ | ||
| Collection: []eas.SyncCollection{{SyncKey: "0", CollectionID: "1", GetChanges: 1}}, | ||
| }, | ||
| }) | ||
| if err != nil { | ||
| t.Fatalf("SyncTyped: %v", err) | ||
| } | ||
| if len(resp.Collections) != 1 { | ||
| t.Fatalf("collections: %d", len(resp.Collections)) | ||
| } | ||
| col := resp.Collections[0] | ||
| if col.Class != "Email" || col.SyncKey != "S-2" { | ||
| t.Fatalf("collection metadata: %+v", col) | ||
| } | ||
| if len(col.Add) != len(in) { | ||
| t.Fatalf("Add count = %d, want %d", len(col.Add), len(in)) | ||
| } | ||
| for i, item := range col.Add { | ||
| if item.ApplicationData == nil { | ||
| t.Fatalf("Add[%d] ApplicationData nil", i) | ||
| } | ||
| if item.ApplicationData.Subject != in[i].Subject { | ||
| t.Fatalf("Add[%d] Subject %q, want %q", i, item.ApplicationData.Subject, in[i].Subject) | ||
| } | ||
| } | ||
| } | ||
|
|
||
| func serverIDFor(i int) string { | ||
| return "1:" + string(rune('0'+i)) | ||
| } | ||
|
|
||
| // SPEC: MS-ASCMD/ping.response | ||
| // SPEC: MS-ASCMD/ping.status.changes | ||
| func TestPing_ChangesAvailable(t *testing.T) { | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The updated Sync example now calls log.Printf but the snippet’s import list doesn’t include the standard library log package. Please either add the missing import(s) in the example or avoid using log in the snippet so it compiles as shown.