Support public flag for StateEntry

api.py

@@ -51,6 +51,7 @@ class SetValue(webapp2.RequestHandler):
   def post(self):
     entry_key = self.request.get('key')
     entry_value = self.request.get('value')
+    public = (self.request.get('public') == 'true')
 
     entries = (models.StateEntry.all()
                .ancestor(self.client.parent_key())
@@ -59,11 +60,13 @@ class SetValue(webapp2.RequestHandler):
     if entries:
       entry = entries[0]
       entry.entry_value = entry_value
+      entry.public = public
     else:
       entry = models.StateEntry(
           parent=self.client.parent_key(),
           entry_key=entry_key,
-          entry_value=entry_value)
+          entry_value=entry_value,
+          public=public)
 
     entry.put()
     msg = entry.ToMessage()
@@ -75,29 +78,6 @@ class SetValue(webapp2.RequestHandler):
     return {}
 
 
-class GetValue(webapp2.RequestHandler):
-  @utils.chaos_monkey
-  @utils.returns_json
-  @utils.local_namespace
-  @security.google_user_xsrf_protection
-  @security.weak_security_checks
-  @session.session_required
-  @db.transactional()
-  def post(self):
-    entry_key = self.request.get('key')
-
-    entries = (models.StateEntry.all()
-               .ancestor(self.client.parent_key())
-               .filter('entry_key =', entry_key)
-               .fetch(1))
-    if entries:
-      return {
-          'value': entries[0].entry_value
-      }
-
-    return {}
-
-
 class CreateChannel(webapp2.RequestHandler):
   @utils.chaos_monkey
   @utils.returns_json
@@ -119,6 +99,5 @@ class CreateChannel(webapp2.RequestHandler):
 app = webapp2.WSGIApplication([
   (config.URL_PREFIX + '/api/createChannel', CreateChannel),
   (config.URL_PREFIX + '/api/getUser', GetUser),
-  (config.URL_PREFIX + '/api/getValue', GetValue),
   (config.URL_PREFIX + '/api/setValue', SetValue),
 ])

lib/models.py

@@ -19,6 +19,8 @@ import logging
 from google.appengine.api import channel
 from google.appengine.ext import db
 
+import utils
+
 
 # Profile
 # ↳ Client
@@ -94,7 +96,7 @@ class Client(db.Model):
     return cls.FromProfile(profile)
 
   def SendMessage(self, msg):
-    channel.send_message(str(self.key()), json.dumps(msg))
+    channel.send_message(str(self.key()), json.dumps(msg, default=utils.EncodeJSON))
 
 
 class StateEntry(db.Model):
@@ -103,12 +105,15 @@ class StateEntry(db.Model):
   last_set = db.DateTimeProperty(required=True, auto_now=True)
   entry_key = db.StringProperty(required=True)
   entry_value = db.StringProperty()
+  public = db.BooleanProperty(required=True, default=False)
 
   def ToMessage(self):
     return {
       'message_type': 'state',
-      'key': self.entry_key,
-      'value': self.entry_value,
+      'key':          self.entry_key,
+      'value':        self.entry_value,
+      'last_set':     self.last_set,
+      'public':       self.public,
     }
 
 

lib/utils.py

@@ -12,9 +12,11 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import datetime
 import functools
 import json
 import random
+import time
 
 from google.appengine.api import namespace_manager
 
@@ -27,7 +29,7 @@ def returns_json(handler):
 
   @functools.wraps(handler)
   def SerializeResult(self):
-    json.dump(handler(self), self.response.out)
+    json.dump(handler(self), self.response.out, default=EncodeJSON)
 
   return SerializeResult
 
@@ -54,3 +56,9 @@ def local_namespace(handler):
     return handler(self)
 
   return SetNamespace
+
+
+def EncodeJSON(o):
+  if isinstance(o, datetime.datetime):
+    return time.mktime(o.timetuple())
+  return json.JSONEncoder.default(o)

static/cosmopolite.js

@@ -144,10 +144,11 @@ cosmopolite.Client.prototype.getUser_ = function() {
   });
 };
 
-cosmopolite.Client.prototype.setValue = function(key, value) {
+cosmopolite.Client.prototype.setValue = function(key, value, is_public) {
   this.sendRPC_('setValue', {
     'key': key,
     'value': value,
+    'public': is_public,
   })
   // Provide immediate feedback without waiting for a round trip.
   // We'll also get a response from the server, so this should be eventually
@@ -200,14 +201,20 @@ cosmopolite.Client.prototype.onServerMessage_ = function(msg) {
   switch (msg.message_type) {
     case 'state':
       var key = msg['key'];
-      var value = msg['value'];
-      if (this.stateCache_[key] == value) {
+      if (this.stateCache_[key] &&
+	  this.stateCache_[key]['value'] == msg['value'] &&
+          this.stateCache_[key]['last_set'] == msg['last_set'] &&
+	  this.stateCache_[key]['public'] == msg['public']) {
         // Duplicate message.
         break;
       }
-      this.stateCache_[key] = value;
+      this.stateCache_[key] = {
+          'value':    msg['value'],
+	  'last_set': msg['last_set'],
+	  'public':   msg['public'],
+      }
       if ('onStateChange' in this.callbacks_) {
-        this.callbacks_['onStateChange'](key, value);
+        this.callbacks_['onStateChange'](key, this.stateCache_[key]);
       }
       break;
     default:

static/debug.html

@@ -11,23 +11,35 @@ a {
     <div>Google user: <span id="google_user"></span></div>
 
     <div>
-      Key:
-      <select id="keys"></select>
-      <input type="button" id="set" value="Set">
-      <input type="button" id="add" value="Add">
-      <br />
-      <textarea id="value" rows="10" cols="40"></textarea>
+      <div>
+        Key:
+        <select id="keys"></select>
+        <input type="button" id="set" value="Set">
+        <input type="button" id="add" value="Add">
+      </div>
+      <div>
+        Last set:
+        <span id="last_set"></span>
+      </div>
+      <div>
+        <input type="checkbox" id="public"> Public
+      </div>
+      <div>
+        <textarea id="value" rows="10" cols="40"></textarea>
+      </div>
     </div>
     <script>
 var keys = document.getElementById('keys');
 var value = document.getElementById('value');
+var last_set = document.getElementById('last_set');
+var is_public = document.getElementById('public');
 
 var selectKey = function(new_key) {
   keys.value = new_key;
   keys.dispatchEvent(new CustomEvent('change'));
 };
 
-var addKey = function(new_key, new_value, index) {
+var addKey = function(new_key, index) {
   var option = document.createElement('option');
   option.text = new_key;
   keys.options.add(option, index);
@@ -55,19 +67,19 @@ window.addEventListener('load', function() {
           return;
         };
         if (keys.options[i].value > new_key) {
-          addKey(new_key, new_value, i);
+          addKey(new_key, i);
           return;
         };
       };
       // Sorts at the end
-      addKey(new_key, new_value, keys.options.length);
+      addKey(new_key, keys.options.length);
     },
   };
 
   var debug = new cosmopolite.Client(callbacks);
 
   document.getElementById('set').addEventListener('click', function() {
-    debug.setValue(keys.value, value.value);
+    debug.setValue(keys.value, value.value, is_public.checked);
   });
 
   document.getElementById('add').addEventListener('click', function() {
@@ -80,7 +92,10 @@ window.addEventListener('load', function() {
   });
 
   document.getElementById('keys').addEventListener('change', function() {
-    value.value = debug.getValue(keys.value);
+    var value_obj = debug.getValue(keys.value);
+    value.value = value_obj.value;
+    last_set.innerHTML = (new Date(value_obj.last_set * 1000)).toString();
+    is_public.checked = value_obj['public'];
   });
 });
     </script>