feat(i18n): update user preferences function

Author: Ang-m4

src/i18n/languageApi.js

@@ -1,26 +1,31 @@
 import { getConfig } from '../config';
-import { getAuthenticatedHttpClient } from '../auth';
+import { getAuthenticatedHttpClient, getAuthenticatedUser } from '../auth';
 import { convertKeyNames, snakeCaseObject } from '../utils';
 
 /**
  * Updates user language preferences via the preferences API.
  *
- * This function converts preference data to snake_case and formats specific keys
- * according to backend requirements before sending the PATCH request.
+ * This function gets the authenticated user, converts preference data to snake_case 
+ * and formats specific keys according to backend requirements before sending the PATCH request.
+ * If no user is authenticated, the function returns early without making the API call.
  *
- * @param {string} username - The username of the user whose preferences to update.
  * @param {Object} preferenceData - The preference parameters to update (e.g., { prefLang: 'en' }).
  * @returns {Promise} - A promise that resolves when the API call completes successfully,
- *                      or rejects if there's an error with the request.
+ *                      or rejects if there's an error with the request. Returns early if no user is authenticated.
  */
-export async function updateUserPreferences(username, preferenceData) {
+export async function updateAuthenticatedUserPreferences(preferenceData) {
+  const user = getAuthenticatedUser();
+  if (!user) {
+    return Promise.resolve();
+  }
+
   const snakeCaseData = snakeCaseObject(preferenceData);
   const formattedData = convertKeyNames(snakeCaseData, {
     pref_lang: 'pref-lang',
   });
 
   return getAuthenticatedHttpClient().patch(
-    `${getConfig().LMS_BASE_URL}/api/user/v1/preferences/${username}`,
+    `${getConfig().LMS_BASE_URL}/api/user/v1/preferences/${user.username}`,
     formattedData,
     { headers: { 'Content-Type': 'application/merge-patch+json' } },
   );

src/i18n/languageApi.test.js

@@ -1,6 +1,6 @@
-import { updateUserPreferences, setSessionLanguage } from './languageApi';
+import { updateAuthenticatedUserPreferences, setSessionLanguage } from './languageApi';
 import { getConfig } from '../config';
-import { getAuthenticatedHttpClient } from '../auth';
+import { getAuthenticatedHttpClient, getAuthenticatedUser } from '../auth';
 
 jest.mock('../config');
 jest.mock('../auth');
@@ -11,21 +11,32 @@ describe('languageApi', () => {
   beforeEach(() => {
     jest.clearAllMocks();
     getConfig.mockReturnValue({ LMS_BASE_URL });
+    getAuthenticatedUser.mockReturnValue({ username: 'testuser', userId: '123' });
   });
 
-  describe('updateUserPreferences', () => {
+  describe('updateAuthenticatedUserPreferences', () => {
     it('should send a PATCH request with correct data', async () => {
       const patchMock = jest.fn().mockResolvedValue({});
       getAuthenticatedHttpClient.mockReturnValue({ patch: patchMock });
 
-      await updateUserPreferences('user1', { prefLang: 'es' });
+      await updateAuthenticatedUserPreferences({ prefLang: 'es' });
 
       expect(patchMock).toHaveBeenCalledWith(
-        `${LMS_BASE_URL}/api/user/v1/preferences/user1`,
+        `${LMS_BASE_URL}/api/user/v1/preferences/testuser`,
         expect.any(Object),
         expect.objectContaining({ headers: expect.any(Object) }),
       );
     });
+
+    it('should return early if no authenticated user', async () => {
+      const patchMock = jest.fn().mockResolvedValue({});
+      getAuthenticatedHttpClient.mockReturnValue({ patch: patchMock });
+      getAuthenticatedUser.mockReturnValue(null);
+
+      await updateAuthenticatedUserPreferences({ prefLang: 'es' });
+
+      expect(patchMock).not.toHaveBeenCalled();
+    });
   });
 
   describe('setSessionLanguage', () => {

src/i18n/languageManager.js

@@ -1,9 +1,8 @@
 import { getConfig } from '../config';
-import { getAuthenticatedUser } from '../auth';
 import { getCookies, handleRtl, LOCALE_CHANGED } from './lib';
 import { publish } from '../pubSub';
 import { logError } from '../logging';
-import { updateUserPreferences, setSessionLanguage } from './languageApi';
+import { updateAuthenticatedUserPreferences, setSessionLanguage } from './languageApi';
 
 /**
  * Changes the user's language preference and applies it to the current session.
@@ -29,11 +28,7 @@ export async function changeUserSessionLanguage(
   cookies.set(cookieName, languageCode);
 
   try {
-    const user = getAuthenticatedUser();
-    if (user) {
-      await updateUserPreferences(user.username, { prefLang: languageCode });
-    }
-
+    await updateAuthenticatedUserPreferences({ prefLang: languageCode });
     await setSessionLanguage(languageCode);
     handleRtl(languageCode);
     publish(LOCALE_CHANGED, languageCode);

src/i18n/languageManager.test.js

@@ -1,13 +1,11 @@
 import { changeUserSessionLanguage } from './languageManager';
 import { getConfig } from '../config';
-import { getAuthenticatedUser } from '../auth';
 import { getCookies, handleRtl, LOCALE_CHANGED } from './lib';
 import { logError } from '../logging';
 import { publish } from '../pubSub';
-import { updateUserPreferences, setSessionLanguage } from './languageApi';
+import { updateAuthenticatedUserPreferences, setSessionLanguage } from './languageApi';
 
 jest.mock('../config');
-jest.mock('../auth');
 jest.mock('./lib');
 jest.mock('../logging');
 jest.mock('../pubSub');
@@ -18,7 +16,6 @@ const LANGUAGE_PREFERENCE_COOKIE_NAME = 'lang';
 
 describe('languageManager', () => {
   let mockCookies;
-  let mockUser;
   let mockReload;
 
   beforeEach(() => {
@@ -31,17 +28,14 @@ describe('languageManager', () => {
     mockCookies = { set: jest.fn() };
     getCookies.mockReturnValue(mockCookies);
 
-    mockUser = { username: 'testuser', userId: '123' };
-    getAuthenticatedUser.mockReturnValue(mockUser);
-
     mockReload = jest.fn();
     Object.defineProperty(window, 'location', {
       configurable: true,
       writable: true,
       value: { reload: mockReload },
     });
 
-    updateUserPreferences.mockResolvedValue({});
+    updateAuthenticatedUserPreferences.mockResolvedValue({});
     setSessionLanguage.mockResolvedValue({});
   });
 
@@ -53,7 +47,7 @@ describe('languageManager', () => {
         LANGUAGE_PREFERENCE_COOKIE_NAME,
         'fr',
       );
-      expect(updateUserPreferences).toHaveBeenCalledWith('testuser', {
+      expect(updateAuthenticatedUserPreferences).toHaveBeenCalledWith({
         prefLang: 'fr',
       });
       expect(setSessionLanguage).toHaveBeenCalledWith('fr');
@@ -63,15 +57,16 @@ describe('languageManager', () => {
     });
 
     it('should handle errors gracefully', async () => {
-      updateUserPreferences.mockRejectedValue(new Error('fail'));
+      updateAuthenticatedUserPreferences.mockRejectedValue(new Error('fail'));
       await changeUserSessionLanguage('es', true);
       expect(logError).toHaveBeenCalled();
     });
 
-    it('should skip updateUserPreferences if user is not authenticated', async () => {
-      getAuthenticatedUser.mockReturnValue(null);
+    it('should call updateAuthenticatedUserPreferences even when user is not authenticated', async () => {
       await changeUserSessionLanguage('en', true);
-      expect(updateUserPreferences).not.toHaveBeenCalled();
+      expect(updateAuthenticatedUserPreferences).toHaveBeenCalledWith({
+        prefLang: 'en',
+      });
     });
 
     it('should reload if forceReload is true', async () => {