fix(server): reinstate placeholder devices for sync sessions

This reverts commit c4c6733.

r=seanmonstar

Author: philbooth

lib/db.js

@@ -439,9 +439,17 @@ module.exports = function (
               type: item.type,
               pushCallback: item.callbackURL,
               pushPublicKey: item.callbackPublicKey,
-              pushAuthKey: item.callbackAuthKey
+              pushAuthKey: item.callbackAuthKey,
+              uaBrowser: item.uaBrowser,
+              uaBrowserVersion: item.uaBrowserVersion,
+              uaOS: item.uaOS,
+              uaOSVersion: item.uaOSVersion,
+              uaDeviceType: item.uaDeviceType
             }, {
-              ignore: [ 'name', 'type', 'pushCallback', 'pushPublicKey', 'pushAuthKey' ]
+              ignore: [
+                'name', 'type', 'pushCallback', 'pushPublicKey', 'pushAuthKey',
+                'uaBrowser', 'uaBrowserVersion', 'uaOS', 'uaOSVersion', 'uaDeviceType'
+              ]
             })
           })
         },

lib/devices.js

@@ -0,0 +1,84 @@
+/* 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/. */
+
+'use strict'
+
+module.exports = function (log, db, push) {
+  return {
+    upsert: upsert,
+    synthesizeName: synthesizeName
+  }
+
+  function upsert (request, sessionToken, deviceInfo) {
+    var operation, event, result
+    if (deviceInfo.id) {
+      operation = 'updateDevice'
+      event = 'device.updated'
+    } else {
+      operation = 'createDevice'
+      event = 'device.created'
+    }
+    var isPlaceholderDevice = Object.keys(deviceInfo).length === 0
+
+    return db[operation](sessionToken.uid, sessionToken.tokenId, deviceInfo)
+      .then(function (device) {
+        result = device
+        return log.activityEvent(event, request, {
+          uid: sessionToken.uid.toString('hex'),
+          device_id: result.id.toString('hex'),
+          is_placeholder: isPlaceholderDevice
+        })
+      })
+      .then(function () {
+        if (operation === 'createDevice') {
+          push.notifyDeviceConnected(sessionToken.uid, result.name, result.id.toString('hex'))
+          if (isPlaceholderDevice) {
+            log.info({
+              op: 'device:createPlaceholder',
+              uid: sessionToken.uid,
+              id: result.id
+            })
+          }
+          return log.notifyAttachedServices('device:create', request, {
+            uid: sessionToken.uid,
+            id: result.id,
+            type: result.type,
+            timestamp: result.createdAt,
+            isPlaceholder: isPlaceholderDevice
+          })
+        }
+      })
+      .then(function () {
+        return result
+      })
+  }
+
+  function synthesizeName (device) {
+    var browserPart = part('uaBrowser')
+    var osPart = part('uaOS')
+
+    if (browserPart) {
+      if (osPart) {
+        return browserPart + ', ' + osPart
+      }
+
+      return browserPart
+    }
+
+    return osPart || ''
+
+    function part (key) {
+      if (device[key]) {
+        var versionKey = key + 'Version'
+
+        if (device[versionKey]) {
+          return device[key] + ' ' + device[versionKey]
+        }
+
+        return device[key]
+      }
+    }
+  }
+}
+

lib/routes/account.js

@@ -35,7 +35,8 @@ module.exports = function (
   isPreVerified,
   checkPassword,
   push,
-  metricsContext
+  metricsContext,
+  devices
   ) {
 
   // Loads and compiles a json validator for the payloads received
@@ -803,7 +804,7 @@ module.exports = function (
           schema: isA.object({
             id: isA.string().length(32).regex(HEX_STRING).required(),
             createdAt: isA.number().positive().optional(),
-            // We previously allowed devices to register with arbitrry unicode names,
+            // We previously allowed devices to register with arbitrary unicode names,
             // so we can't assert DISPLAY_SAFE_UNICODE in the response schema.
             name: isA.string().max(255).optional(),
             type: isA.string().max(16).optional(),
@@ -829,17 +830,19 @@ module.exports = function (
           if (config.deviceUpdatesEnabled === false) {
             throw error.featureNotEnabled()
           }
+        } else if (sessionToken.deviceId) {
+          // Keep the old id, which is probably from a synthesized device record
+          payload.id = sessionToken.deviceId.toString('hex')
         }
 
         if (payload.pushCallback && (!payload.pushPublicKey || !payload.pushAuthKey)) {
           payload.pushPublicKey = ''
           payload.pushAuthKey = ''
         }
 
-        upsertDevice().then(
+        devices.upsert(request, sessionToken, payload).then(
           function (device) {
             reply(butil.unbuffer(device))
-            push.notifyDeviceConnected(sessionToken.uid, device.name, device.id.toString('hex'))
           },
           reply
         )
@@ -871,45 +874,6 @@ module.exports = function (
           }
           return spurious
         }
-
-        function upsertDevice () {
-          var operation, event, result
-          if (payload.id) {
-            operation = 'updateDevice'
-            event = 'device.updated'
-          } else {
-            operation = 'createDevice'
-            event = 'device.created'
-          }
-
-          return db[operation](sessionToken.uid, sessionToken.tokenId, payload)
-            .then(
-              function (res) {
-                result = res
-                return log.activityEvent(event, request, {
-                  uid: sessionToken.uid.toString('hex'),
-                  device_id: result.id.toString('hex')
-                })
-              }
-            )
-            .then(
-              function () {
-                if (operation === 'createDevice') {
-                  return log.notifyAttachedServices('device:create', request, {
-                    uid: sessionToken.uid,
-                    id: result.id,
-                    type: result.type,
-                    timestamp: result.createdAt
-                  })
-                }
-              }
-            )
-            .then(
-              function () {
-                return result
-              }
-            )
-        }
       }
     },
     {
@@ -996,9 +960,9 @@ module.exports = function (
             id: isA.string().length(32).regex(HEX_STRING).required(),
             isCurrentDevice: isA.boolean().required(),
             lastAccessTime: isA.number().min(0).required().allow(null),
-            // We previously allowed devices to register with arbitrry unicode names,
+            // We previously allowed devices to register with arbitrary unicode names,
             // so we can't assert DISPLAY_SAFE_UNICODE in the response schema.
-            name: isA.string().max(255).required(),
+            name: isA.string().max(255).required().allow(''),
             type: isA.string().max(16).required(),
             pushCallback: isA.string().uri({ scheme: 'https' }).max(255).optional().allow('').allow(null),
             pushPublicKey: isA.string().max(88).regex(URLSAFEBASE64).optional().allow('').allow(null),
@@ -1011,11 +975,26 @@ module.exports = function (
         var sessionToken = request.auth.credentials
         var uid = sessionToken.uid
         db.devices(uid).then(
-          function (devices) {
-            reply(devices.map(function (device) {
+          function (deviceArray) {
+            reply(deviceArray.map(function (device) {
+              if (! device.name) {
+                device.name = devices.synthesizeName(device)
+              }
+
+              if (! device.type) {
+                device.type = device.uaDeviceType || 'desktop'
+              }
+
               device.isCurrentDevice =
                 device.sessionToken.toString('hex') === sessionToken.tokenId.toString('hex')
+
               delete device.sessionToken
+              delete device.uaBrowser
+              delete device.uaBrowserVersion
+              delete device.uaOS
+              delete device.uaOSVersion
+              delete device.uaDeviceType
+
               return butil.unbuffer(device)
             }))
           },

lib/routes/index.js

@@ -26,6 +26,7 @@ module.exports = function (
   var idp = require('./idp')(log, serverPublicKeys)
   var checkPassword = require('./utils/password_check')(log, config, Password, customs, db)
   var push = require('../push')(log, db)
+  var devices = require('../devices')(log, db, push)
   var account = require('./account')(
     log,
     crypto,
@@ -41,7 +42,8 @@ module.exports = function (
     isPreVerified,
     checkPassword,
     push,
-    metricsContext
+    metricsContext,
+    devices
   )
   var password = require('./password')(
     log,
@@ -57,7 +59,7 @@ module.exports = function (
     push
   )
   var session = require('./session')(log, isA, error, db)
-  var sign = require('./sign')(log, isA, error, signer, db, config.domain)
+  var sign = require('./sign')(log, P, isA, error, signer, db, config.domain, devices)
   var util = require('./util')(
     log,
     crypto,