fix legacy device id reset issue

fix test

add comments

client/constants/messages.js

@@ -34,12 +34,17 @@ const messages = {
    * saved. 'config' contains apiVersion, serverUrl, debug;
    * see server/config/default.json
    */
-  GOT_INIT_DATA: _, /* @param {Array} seed, @param {Array} deviceId, @param {Object} config */
+  GOT_INIT_DATA: _, /* @param {Array} seed, @param {Array} deviceId,
+                     * @param {Object} config, @param {string} deviceIdV2
+                     * */
   /**
    * webview -> browser
    * browser must save values in persistent storage if non-empty
+   * It will be called during initial setup or deviceIdV2 migration
    */
-  SAVE_INIT_DATA: _, /* @param {Uint8Array} seed, @param {Uint8Array} deviceId */
+  SAVE_INIT_DATA: _, /* @param {Uint8Array} seed, @param {Uint8Array} deviceId,
+                      * @param {string} deviceIdV2
+                      */
   /**
    * webview -> browser
    * sent when sync has finished initialization

client/requestUtil.js

@@ -251,18 +251,21 @@ RequestUtil.prototype.list = function (category, startAt, maxRecords, nextContin
       WaitTimeSeconds: CONFIG.SQS_MESSAGES_LONGPOLL_TIMEOUT
     }
 
+    // We will fetch from both old and new SQS queues until old one gets retired
     if (this.oldSQSUrlByCat[category]) {
       let oldNotificationParams = Object.assign({}, notificationParams)
       oldNotificationParams.QueueUrl = `${this.oldSQSUrlByCat[category]}`
 
-      return s3Helper.listNotifications(this.sqs, notificationParams, category, prefix).then((values) => {
+      return s3Helper.listNotifications(
+        this.sqs, notificationParams, category, prefix).then((values) => {
         if (this.shouldRetireOldSQSQueue(parseInt(values.createdTimeStamp))) {
           return this.deleteSQSQueue(this.oldSQSUrlByCat[category]).then(() => {
             delete this.oldSQSUrlByCat[category]
             return values
           })
         }
-        return s3Helper.listNotifications(this.sqs, oldNotificationParams, category, prefix).then((oldValues) => {
+        return s3Helper.listNotifications(
+          this.sqs, oldNotificationParams, category, prefix).then((oldValues) => {
           if (deepEqual(values.contents, oldValues.contents, {strict: true})) {
             return values
           }
@@ -296,6 +299,13 @@ RequestUtil.prototype.shouldListObject = function (startAt, category) {
       this.listInProgress === true
 }
 
+/**
+ * The retention time of our SQS queue is 24 hours so we will retire old SQS
+ * queue created by device id after 24 hours
+ * @param {number=} createdTimestamp is the when new device id v2 queue was
+ * created
+ * @returns {boolean}
+ */
 RequestUtil.prototype.shouldRetireOldSQSQueue = function (createdTimestamp) {
   let currentTime = new Date().getTime()
   let newQueueCreatedTime =
@@ -423,7 +433,6 @@ RequestUtil.prototype.createAndSubscribeSQS = function (deviceId, deviceIdV2) {
     // Doesn't have to create about to deprecated queues
     createSQSPromises.push(subscribeOldSQSforCategory(deviceId, CATEGORIES_FOR_SQS[i], this))
     createSQSPromises.push(createAndSubscribeSQSforCategory(deviceIdV2, CATEGORIES_FOR_SQS[i], this))
-    // TODO(darkdh): encode into base64
   }
 
   return Promise.all(createSQSPromises)
@@ -604,6 +613,10 @@ RequestUtil.prototype.purgeUserCategoryQueue = function (category) {
   })
 }
 
+/**
+ * Delete SQS queue by url
+ * @param {string} url - SQS queue url
+ */
 RequestUtil.prototype.deleteSQSQueue = function (url) {
   return new Promise((resolve, reject) => {
     let params = {

client/sync.js

@@ -52,7 +52,11 @@ const logSync = (message, logLevel = DEBUG) => {
  * @returns {Promise}
  */
 const maybeSetDeviceId = (requester) => {
-  if (clientDeviceId !== null && clientDeviceIdV2.length !== 0 ) {
+  if (clientDeviceId !== null) {
+    if (clientDeviceIdV2.length === 0) {
+      clientDeviceIdV2 = generateDeviceIdV2()
+      ipc.send(messages.SAVE_INIT_DATA, seed, clientDeviceId, clientDeviceIdV2)
+    }
     return Promise.resolve(requester)
   }
   if (!requester || !requester.s3) {

lib/crypto.js

@@ -113,6 +113,10 @@ module.exports.decrypt = function (ciphertext/* : Uint8Array */,
   return nacl.secretbox.open(ciphertext, nonce, secretboxKey)
 }
 
-module.exports.generateDeviceIdV2 = function() {
+/**
+ * Generate device id v2 which is a 3 random bytes hex encoded string
+ * @returns {string} device id v2
+ */
+module.exports.generateDeviceIdV2 = function () {
   return Buffer.from(nacl.randomBytes(3)).toString('hex')
 }

test/client/recordUtil.js

@@ -2,6 +2,7 @@ const test = require('tape')
 const testHelper = require('../testHelper')
 const timekeeper = require('timekeeper')
 const proto = require('../../client/constants/proto')
+const {generateDeviceIdV2} = require('../../lib/crypto')
 const recordUtil = require('../../client/recordUtil')
 const Serializer = require('../../lib/serializer')
 
@@ -548,8 +549,10 @@ test('recordUtil.syncRecordAsJS()', (t) => {
     })
     conversionEquals({ objectData: 'siteSetting', siteSetting })
 
+    const deviceIdV2 = generateDeviceIdV2()
     const device = serializer.api.SyncRecord.Device.create({
-      name: 'mobile pyramid'
+      name: 'mobile pyramid',
+      deviceIdV2
     })
     conversionEquals({ objectData: 'device', device })
   })

test/client/requestUtil.js

@@ -2,6 +2,7 @@ const test = require('tape')
 const testHelper = require('../testHelper')
 const timekeeper = require('timekeeper')
 const clientTestHelper = require('./testHelper')
+const {generateDeviceIdV2} = require('../../lib/crypto')
 const Serializer = require('../../lib/serializer')
 const RequestUtil = require('../../client/requestUtil')
 const proto = require('../../client/constants/proto')
@@ -30,7 +31,7 @@ test('client RequestUtil', (t) => {
         }
 
         const requestUtil = new RequestUtil(args)
-        requestUtil.createAndSubscribeSQS('0')
+        requestUtil.createAndSubscribeSQS('0', generateDeviceIdV2())
           .then(()=> {
             t.pass('can instantiate requestUtil')
             t.test('prototype', (t) => {