fix(tom-server): updates null detection and mock ordering

Signed-off-by: Pierre 'McFly' Marty <[email protected]>

Author: pm-McFly

packages/tom-server/src/user-info-api/services/index.ts

@@ -114,10 +114,7 @@ class UserInfoService implements IUserInfoService {
       })()
 
       const directoryPromise = (async () => {
-        if (
-          !this.enableAdditionalFeatures &&
-          process.env.ADDITIONAL_FEATURES !== 'true'
-        ) {
+        if (!this.enableAdditionalFeatures) {
           return null
         }
         const rows = (await this.userDb.db.get(
@@ -129,10 +126,7 @@ class UserInfoService implements IUserInfoService {
       })()
 
       const settingsPromise = (async () => {
-        if (
-          !this.enableCommonSettings &&
-          process.env.FEATURE_COMMON_SETTINGS_ENABLED !== 'true'
-        ) {
+        if (!this.enableCommonSettings) {
           return null
         }
         const rows = (await this.db.get('usersettings', ['*'], {
@@ -177,16 +171,20 @@ class UserInfoService implements IUserInfoService {
       }
 
       if (settingsRow) {
-        Object.assign(result, {
-          language: settingsRow.settings.language ?? '',
-          timezone: settingsRow.settings.timezone ?? ''
-        })
+        if (settingsRow.settings.language)
+          result.language = settingsRow.settings.language
+        if (settingsRow.settings.timezone)
+          result.timezone = settingsRow.settings.timezone
       }
 
-      if (Object.keys(result).length === 1 && result.uid != null) {
+      const finalResult = Object.fromEntries(
+        Object.entries(result).filter(([_, v]) => v != null)
+      )
+
+      if (Object.keys(finalResult).length === 1 && finalResult.uid != null) {
         return null
       }
-      return result as UserInformation
+      return finalResult as unknown as UserInformation
     } catch (error) {
       throw new Error(
         `Error getting user info ${JSON.stringify({ cause: error })}`,

packages/tom-server/src/user-info-api/tests/service.test.ts

@@ -288,6 +288,38 @@ describe('user info service', () => {
     expect(user).toHaveProperty('timezone', 'Europe/Paris')
   })
 
+  it('returns user info but without language/timezone if common settings is enabled but common settings service returns no values', async () => {
+    const configWithCommon = {
+      ...config,
+      features: { common_settings: { enabled: true } }
+    } as unknown as Config
+
+    const mockTwakeDBNoSettings = {
+      ...twakeDBMock,
+      get: jest.fn().mockImplementation(async (table, _fields, query) => {
+        if (table === 'usersettings' && query.matrix_id != null) {
+          return []
+        }
+        return []
+      })
+    }
+
+    const svc = new UserInfoService(
+      userDb,
+      mockTwakeDBNoSettings as unknown as TwakeDB,
+      matrixDBMock as unknown as MatrixDB,
+      configWithCommon,
+      logger
+    )
+
+    const user = await svc.get('@dwho:docker.localhost')
+
+    expect(user).not.toBeNull()
+    expect(user).toHaveProperty('display_name', 'Dr Who')
+    expect(user).not.toHaveProperty('language')
+    expect(user).not.toHaveProperty('timezone')
+  })
+
   it('propagates avatar_url as avatar when present', async () => {
     ;(matrixDBMock.get as jest.Mock).mockResolvedValueOnce([
       { displayname: 'Dr Who', avatar_url: 'http://example.com/avatar.png' }
@@ -323,8 +355,8 @@ describe('user info service', () => {
     getSpy.mockRestore()
   })
 
-  it('passes the exact matrix id to the usersettings query', async () => {
-    // Create a service instance with the common‑settings feature turned ON
+  it('passes the exact matrix id to the usersettings query (when common settings enabled)', async () => {
+    // Create a service instance with the common-settings feature turned ON
     const cfg = {
       ...config,
       features: { common_settings: { enabled: true } }
@@ -338,16 +370,16 @@ describe('user info service', () => {
       logger
     )
 
-    // spy on the DB mock (twakeDBMock.get is already a jest.fn)
-    const spy = jest.spyOn(twakeDBMock, 'get')
+    twakeDBMock.get.mockClear()
+
     await svc.get('@dwho:docker.localhost')
-    expect(spy).toHaveBeenCalledWith('usersettings', ['*'], {
+
+    expect(twakeDBMock.get).toHaveBeenCalledWith('usersettings', ['*'], {
       matrix_id: '@dwho:docker.localhost'
     })
-    spy.mockRestore()
   })
 
-  it('re‑throws a wrapped error when an internal query fails', async () => {
+  it('re-throws a wrapped error when an internal query fails', async () => {
     const brokenMatrix = {
       get: jest.fn().mockRejectedValue(new Error('boom'))
     } as unknown as MatrixDB
@@ -365,21 +397,29 @@ describe('user info service', () => {
   })
 
   it('honors the env var FEATURE_COMMON_SETTINGS_ENABLED', async () => {
+    // Set the environment variable BEFORE creating the service instance
     process.env.FEATURE_COMMON_SETTINGS_ENABLED = 'true'
+
     const cfg = {
       ...config,
       features: { common_settings: { enabled: false } } as any
     }
+
+    // New service instance created AFTER env var is set
     const svc = new UserInfoService(
       userDb,
       twakeDBMock as unknown as TwakeDB,
       matrixDBMock as unknown as MatrixDB,
       cfg as unknown as Config,
       logger
     )
+
     const user = await svc.get('@dwho:docker.localhost')
+    expect(user).not.toBeNull()
     expect(user).toHaveProperty('language', 'fr')
     expect(user).toHaveProperty('timezone', 'Europe/Paris')
+
+    // Clean up the environment variable
     delete process.env.FEATURE_COMMON_SETTINGS_ENABLED
   })
 
@@ -419,12 +459,4 @@ describe('user info service', () => {
     expect(user?.sn).toBe('One')
     expect(user?.givenName).toBe('Alpha')
   })
-
-  it('passes the exact matrix id to the usersettings query', async () => {
-    const spy = jest.spyOn(twakeDBMock, 'get')
-    await service.get('@dwho:docker.localhost')
-    expect(spy).toHaveBeenCalledWith('usersettings', ['*'], {
-      matrix_id: '@dwho:docker.localhost'
-    })
-  })
 })