Fix update only stream name also set default to timezone and country code

CHANGELOG.md

@@ -2,6 +2,9 @@
 ### Common
 * **core**: `GET /detections` return `Total-items` in response headers
 
+### Bug Fixes
+* **core**: Fix update only stream name also set default to timezone and country code
+
 ## 1.3.8 (2024-03-xx)
 ### Common
 * **core**: Use Google Map API for getting timezone and country from latitude and longitude

common/converter/conversion.js

@@ -10,21 +10,25 @@ module.exports = class Conversion {
     this.target = target
     this.property = property
 
-    this.value = null
+    this.value = undefined
     this.conversions = []
     this.required = true
-    this.defaultValue = null
+    this.defaultValue = undefined
   }
 
   execute () {
-    if (this.required && this.src[this.property] == null) {
+    if (this.required && this.src[this.property] === undefined) {
       this.throwError('the parameter is required but was not provided')
     }
 
     this.value = this.src[this.property] !== undefined ? this.src[this.property] : this.defaultValue
 
+    if (!this.required && this.value === undefined) {
+      return
+    }
     if (!this.required && this.value === null) {
-      return this.value
+      this.target[this.property] = this.value
+      return
     }
 
     for (const executeValidation of this.conversions) {

core/internal/arbimon/stream.int.test.js

@@ -28,11 +28,13 @@ beforeEach(async () => {
 const PROJECT_1 = { id: 'testproj0001', name: 'Test project 1', externalId: 1, createdById: seedValues.primaryUserId }
 const PROJECT_2 = { id: 'testproj0002', name: 'Test project 2', externalId: 2, createdById: seedValues.otherUserId }
 const PROJECT_3 = { id: 'testproj0003', name: 'Test project 3', externalId: 3, createdById: seedValues.primaryUserId }
-const PROJECTS = [PROJECT_1, PROJECT_2, PROJECT_3]
+const PROJECT_4 = { id: 'testproj0004', name: 'Test project 4', externalId: 4, createdById: seedValues.primaryUserId }
+const PROJECTS = [PROJECT_1, PROJECT_2, PROJECT_3, PROJECT_4]
 
 const STREAM_1 = { id: 'LilSjZJkRK43', name: 'Stream 1', projectId: PROJECT_1.id, externalId: 1, createdById: seedValues.primaryUserId }
 const STREAM_2 = { id: 'LilSjZJkRK46', name: 'Stream 2', projectId: PROJECT_2.id, externalId: 2, isPublic: true, createdById: seedValues.otherUserId }
-const STREAMS = [STREAM_1, STREAM_2]
+const STREAM_3 = { id: 'LilSjZJkRK49', name: 'Stream 3', projectId: PROJECT_4.id, externalId: 3, latitude: 10, longitude: 103, createdById: seedValues.primaryUserId, countryCode: 'TH', timezone: 'Asia/Bangkok' }
+const STREAMS = [STREAM_1, STREAM_2, STREAM_3]
 
 async function commonSetup () {
   await models.Project.bulkCreate(PROJECTS)
@@ -54,6 +56,127 @@ describe('PATCH /internal/arbimon/streams/:externalId', () => {
       expect(stream.name).toBe(body.name)
     })
 
+    test('with [`name`] params should not change timezone and country code', async () => {
+      const body = {
+        name: 'New Stream 3'
+      }
+
+      const response = await request(app).patch(`/streams/${STREAM_3.externalId}`).send(body)
+
+      expect(response.statusCode).toBe(200)
+      const stream = await models.Stream.findByPk(STREAM_3.id)
+      expect(stream.name).toBe(body.name)
+      expect(stream.latitude).toBe(STREAM_3.latitude)
+      expect(stream.longitude).toBe(STREAM_3.longitude)
+      expect(stream.timezone).toBe(STREAM_3.timezone)
+      expect(stream.countryCode).toBe(STREAM_3.countryCode)
+    })
+
+    test('with [`name`, `latitude` = undefined, `longitude` = undefined] params should not change timezone and country code', async () => {
+      const body = {
+        name: 'New Stream 3',
+        latitude: undefined,
+        longitude: undefined
+      }
+
+      const response = await request(app).patch(`/streams/${STREAM_3.externalId}`).send(body)
+
+      expect(response.statusCode).toBe(200)
+      const stream = await models.Stream.findByPk(STREAM_3.id)
+      expect(stream.name).toBe(body.name)
+      expect(stream.latitude).toBe(STREAM_3.latitude)
+      expect(stream.longitude).toBe(STREAM_3.longitude)
+      expect(stream.timezone).toBe(STREAM_3.timezone)
+      expect(stream.countryCode).toBe(STREAM_3.countryCode)
+    })
+
+    test('with [`name`, `latitude` = 0, `longitude` = 0] params should change timezone and country code to default values', async () => {
+      const body = {
+        name: 'New Stream 3',
+        latitude: 0,
+        longitude: 0
+      }
+
+      const response = await request(app).patch(`/streams/${STREAM_3.externalId}`).send(body)
+
+      expect(response.statusCode).toBe(200)
+      const stream = await models.Stream.findByPk(STREAM_3.id)
+      expect(stream.name).toBe(body.name)
+      expect(stream.latitude).toBeNull()
+      expect(stream.longitude).toBeNull()
+      expect(stream.timezone).toBe('UTC')
+      expect(stream.countryCode).toBeNull()
+    })
+
+    test('with [`name`, `latitude`, `longitude` = null] params should change timezone and country code to default values', async () => {
+      const body = {
+        name: 'New Stream 3',
+        latitude: 10.1,
+        longitude: null
+      }
+
+      const response = await request(app).patch(`/streams/${STREAM_3.externalId}`).send(body)
+
+      expect(response.statusCode).toBe(200)
+      const stream = await models.Stream.findByPk(STREAM_3.id)
+      expect(stream.name).toBe(body.name)
+      expect(stream.latitude).toBe(body.latitude)
+      expect(stream.longitude).toBeNull()
+      expect(stream.timezone).toBe('UTC')
+      expect(stream.countryCode).toBeNull()
+    })
+
+    test('with [`name`, `latitude`= null, `longitude` = null] params should change timezone and country code to default values', async () => {
+      const body = {
+        name: 'New Stream 3',
+        latitude: null,
+        longitude: null
+      }
+
+      const response = await request(app).patch(`/streams/${STREAM_3.externalId}`).send(body)
+
+      expect(response.statusCode).toBe(200)
+      const stream = await models.Stream.findByPk(STREAM_3.id)
+      expect(stream.name).toBe(body.name)
+      expect(stream.latitude).toBeNull()
+      expect(stream.longitude).toBeNull()
+      expect(stream.timezone).toBe('UTC')
+      expect(stream.countryCode).toBeNull()
+    })
+
+    test('with [`name`, `latitude`, `longitude`] params should change timezone and country code correctly', async () => {
+      const body = {
+        name: 'New Stream 3',
+        longitude: 111
+      }
+      const mockCountry = jest.spyOn(googleMap, 'getCountry')
+      mockCountry.mockReturnValueOnce({
+        data: {
+          results: [{
+            address_components: [{
+              short_name: 'MY'
+            }]
+          }]
+        }
+      })
+      const mockTimezone = jest.spyOn(googleMap, 'getTimezone')
+      mockTimezone.mockReturnValueOnce({
+        data: {
+          timeZoneId: 'Asia/Myanmar'
+        }
+      })
+
+      const response = await request(app).patch(`/streams/${STREAM_3.externalId}`).send(body)
+
+      expect(response.statusCode).toBe(200)
+      const stream = await models.Stream.findByPk(STREAM_3.id)
+      expect(stream.name).toBe(body.name)
+      expect(stream.latitude).toBe(STREAM_3.latitude)
+      expect(stream.longitude).toBe(body.longitude)
+      expect(stream.timezone).toBe('Asia/Myanmar')
+      expect(stream.countryCode).toBe('MY')
+    })
+
     test('with [`name`, `latitude`] params', async () => {
       const body = {
         name: 'New Stream 1',
@@ -195,7 +318,7 @@ describe('PATCH /internal/arbimon/streams/:externalId', () => {
       const body = {
         name: 'New Stream 1',
         latitude: 19.9,
-        project_external_id: 4
+        project_external_id: 5
       }
 
       const response = await request(app).patch(`/streams/${STREAM_1.externalId}`).send(body)

core/streams/dao/index.js

@@ -246,7 +246,21 @@ async function update (id, data, options = {}) {
   if (options.updatableBy && !(await hasPermission(UPDATE, options.updatableBy, id, STREAM))) {
     throw new ForbiddenError()
   }
-  const fullStream = { ...data, ...(await computedAdditions(data, stream)) }
+  // data.latitude or data.longitude is undefined mean it is not in the updated blob unlike null
+  // So need to assign the current stream latitude or longitude value
+  // If both are undefined mean there is no intention to update coordinate so no need to get additional data for timezone and country code
+  // Avoid change timezone and countryCode to default value
+  let additions = {}
+  if (data.latitude !== undefined || data.longitude !== undefined) {
+    if (data.latitude === undefined) {
+      data.latitude = stream.latitude
+    }
+    if (data.longitude === undefined) {
+      data.longitude = stream.longitude
+    }
+    additions = await computedAdditions(data, stream)
+  }
+  const fullStream = { ...data, ...additions }
   if (fullStream.name) {
     if (stream && stream.project_id && stream.name !== fullStream.name) {
       const duplicateStreamInProject = await query({ names: [fullStream.name], projects: [fullStream.project_id || stream.project_id] }, { fields: 'id', transaction })