bug(auth): Address case where sender is empty, null, or missing

Author: dschom

packages/fxa-auth-server/lib/routes/devices-and-sessions.js

@@ -271,6 +271,13 @@ module.exports = (
         // command, which should match to an "invoked" event emitted when it was invoked.
         for (const msg of response.messages) {
           const data = msg.data || {}; // should always be present, but you never know...
+
+          // Response validation allows an optional sender, but empty or null values are
+          // not allowed. Delete empty/null/undefined data to adhere to validation schema.
+          if (!data.sender) {
+            delete data.sender;
+          }
+
           log.info('device.command.retrieved', {
             uid,
             target: deviceId,

packages/fxa-auth-server/test/local/routes/devices-and-sessions.js

@@ -784,8 +784,12 @@ describe('/account/device/commands', () => {
       last: true,
       index: 4,
       messages: [
-        { index: 3, data: { command: 'three', payload: {} } },
-        { index: 4, data: { command: 'four', payload: {} } },
+        {
+          index: 2,
+          data: { command: 'two', payload: {}, sender: '1'.repeat(32) },
+        },
+        { index: 3, data: { command: 'three', payload: {}, sender: '' } },
+        { index: 4, data: { command: 'four', payload: {}, sender: null } },
       ],
     };
     const mockPushbox = mocks.mockPushbox();
@@ -809,7 +813,18 @@ describe('/account/device/commands', () => {
     return runTest(route, mockRequest).then((response) => {
       assert.equal(mockPushbox.retrieve.callCount, 1, 'pushbox was called');
       assert.calledWithExactly(mockPushbox.retrieve, uid, deviceId, 100, 2);
-      assert.deepEqual(response, mockResponse);
+      assert.deepEqual(response, {
+        last: true,
+        index: 4,
+        messages: [
+          {
+            index: 2,
+            data: { command: 'two', payload: {}, sender: '1'.repeat(32) },
+          },
+          { index: 3, data: { command: 'three', payload: {} } },
+          { index: 4, data: { command: 'four', payload: {} } },
+        ],
+      });
     });
   });