Synced Notification Sync Change Processor

sync/protocol/server_data.proto

+// Copyright (c) 2012 The Chromium Authors. All rights reserved.
+// Use of this source code is governed by a BSD-style license that can be
+// found in the LICENSE file.
+//
+// Sync protocol datatype extension for push notifications..
+
+// Update proto_value_conversions{.h,.cc,_unittest.cc} if you change
+// any fields in this file.
+
+syntax = "proto2";
+
+option optimize_for = LITE_RUNTIME;
+option retain_unknown_fields = true;
+
+package sync_pb;
+
+import "server_render.proto";
+
+// This message allows clients to identify a notification they have created.
+// IMPORTANT: Everything in this message may be sent to the client in clear text

[Nicolas Zea, 2013/01/25 00:18:46]

This comment is a bit odd to me (and all the IMPORTANT warnings below). I'm not
sure what the concern about sending in "clear text" is. All transmissions are
done via HTTPS. Certainly credit cards and such should not be synced (but for
entirely different reasons).

And all field names should be safe to have in an open source repository, so no
internal/confidential products should be referenced. But, if there is a field
reserved in the chromium protobuf, the server protobuf can use a different name
if it prefers (the field number is all that matters).

[Pete Williamson, 2013/01/25 19:58:36]

Once again, I am copying the protobuf from the sync side.  Ideally, we will make
them as close as possible to ease porting changes back and forth between the
chrome and server code bases.  I think this wording is boilerplate from the
server side code base.  I will check with the server folks to see if we can
remove it.

+// - do not expose any user ids, internal product names, credit card numbers,
+// etc... anywhere in the message.
+message SyncedNotificationIdentifier {
+  // The application that the notification is a part of.
+  //
+  // IMPORTANT: This string may be sent to the client in clear text - do not
+  // expose any user ids, internal product names, credit card numbers, etc...
+  optional string app_id = 1;
+
+  // Notifications with the same coalescing key (isolated to the same app_id)
+  // will be grouped together when fetched.
+  //
+  // IMPORTANT: This string may be sent to the client in clear text - do not
+  // expose any user ids, internal product names, credit card numbers, etc...
+  optional string coalescing_key = 2;
+}
+
+message SyncedNotificationItem {
+  // The unique identifier to identify the notification.

[Nicolas Zea, 2013/01/25 00:18:46]

s/to identify/of

[Pete Williamson, 2013/01/25 19:58:36]

Done.

+  optional SyncedNotificationIdentifier id = 1;
+
+  // A secondary type that is isolated within the same app_id.
+  //
+  // NOTE: For ASBE support purposes this must be in the format [A-Za-z_]+.
+  //
+  // IMPORTANT: This string may be sent to the client in clear text - do not
+  // expose any user ids, internal product names, credit card numbers, etc...
+  optional string type = 2;
+
+  // Whatever string the client entered during creation.  If no external_id is
+  // specified, the notification can no longer be identified individually for
+  // fetching/deleting, etc...
+  //
+  // IMPORTANT: This string may be sent to the client in clear text - do not
+  // expose any user ids, internal product names, credit card numbers, etc...
+  optional string external_id = 3;
+}
+
+message SyncedNotificationCoalesced {
+  // The identifier used to identify individual coalesced notifications.
+  optional SyncedNotificationIdentifier id = 1;
+
+  // All the notifications that are grouped together.
+  repeated SyncedNotificationItem notification = 2;
+
+  // Data that is used directly by endpoints to render notifications in the case
+  // where no "native" app can handle the notification.
+  optional SyncedNotificationRenderInfo render_info = 3;
+
+  // Read state will be per coalesced notification.
+  enum ReadState {
+    UNREAD = 1;
+    READ = 2;
+    DISMISSED = 3;
+  }
+  optional ReadState read_state = 4;
+
+  // The time when the LATEST notification of the coalesced notification is
+  // created (in Java time milliseconds).

[Nicolas Zea, 2013/01/25 00:18:46]

presumably this is milliseconds since unix epoch? I'd prefer specifying that.

[Pete Williamson, 2013/01/25 19:58:36]

Done.

+  optional uint64 creation_time_msec = 5;
+}