feature/backend locale mapper sitecore

Author: shobhitupadhyayy

api/src/controllers/migration.controller.ts

@@ -60,11 +60,17 @@ const saveLocales = async (req:Request, res: Response):Promise<void> =>{
   res.status(200).json(resp);
 }
 
+const saveMappedLocales = async (req:Request, res:Response):Promise<void> =>{
+  const resp = await migrationService.updateLocaleMapper(req);
+  res.status(200).json(resp);
+}
+
 export const migrationController = {
   createTestStack,
   deleteTestStack,
   startTestMigration,
   startMigration,
   getLogs,
-  saveLocales
+  saveLocales,
+  saveMappedLocales
 };

api/src/routes/migration.routes.ts

@@ -65,10 +65,31 @@ router.get(
 
 )
 
+/**
+ * Route for updating the source locales from legacy CMS
+ * @route POST /validator
+ * @group Migration
+ * @param {string} projectID - Current project ID
+ * @body {Object} locales - Fetched Locales
+ * @returns {Promise<void>} - A promise which resolves when the locales are updated in the DB
+ */
 router.post(
   "/localeMapper/:projectId",
   asyncRouter(migrationController.saveLocales)
 )
 
+/**
+ * Route for updating the mapped locales by user 
+ * @route POST /validator
+ * @group Migration
+ * @param {string} projectID - Current project ID
+ * @body {Object} locales - Mapped Locales
+ * @returns {Promise<void>} - A promise which resolves when the locales are updated in the DB
+ */
+router.post(
+  "/updateLocales/:projectId",
+  asyncRouter(migrationController.saveMappedLocales)
+)
+
 
 export default router;

api/src/services/migration.service.ts

@@ -410,14 +410,18 @@ const getLogs = async (req: Request): Promise<any> => {
 
 }
 
+/**
+ * @description -  This function takes all the fetched locales from the exported data of the legacy CMS and stores/updates them in the project.json in DB
+ *
+ * @param req - A request body object with  fetched locales [] as payload along with project ID in params
+ * @return - void
+ * @throws Exception if the project ID is invalid or the when the path to project.json is incorrect
+ */
 export const createSourceLocales = async (req: Request) => {
 
-  console.info("ENTERED MIGRATION API LINE 415")
-  
   const projectFilePath = path.join(process.cwd(), 'database', 'project.json'); // Adjusted path to project.json
   const projectId = req.params.projectId;
 
-  console.info("Request Object LINE 420",req.body)
   const locales = req.body.locale
 
   try {
@@ -426,36 +430,91 @@ export const createSourceLocales = async (req: Request) => {
       console.error(`project.json not found at ${projectFilePath}`);
       throw new Error(`project.json not found.`);
     }
-
-    // const data = await fs.promises.readFile(projectFilePath, 'utf8');
-    // const projects = JSON.parse(data);
 
     // Find the project with the specified projectId
     const project: any = ProjectModelLowdb.chain.get("projects").find({ id: projectId }).value();
     if (project) {
       const index = ProjectModelLowdb.chain.get("projects").findIndex({ id: projectId }).value();
       if (index > -1) {
-        console.info("INSIDE API IF STATEMENT LINE 437",index );
 
         ProjectModelLowdb.update((data: any) => {
-          // console.info("DATA LINE 439 ", data?.projects?.[index])
           data.projects[index].source_locales = locales;
-          // console.info(data.projects[index] )
         });
       } // Write back the updated projects
     } else {
-      console.error(`Project with id ${projectId} not found.`);
+      logger.error(`Project with ID: ${projectId} not found`,{
+        status: HTTP_CODES?.NOT_FOUND,
+        message: HTTP_TEXTS?.INVALID_ID
+      })
     }
-  } catch (err) {
-    console.error('Error updating project.json:', err);
+  } catch (err: any) {
+    console.error("🚀 ~ createSourceLocales ~ err:", err?.response?.data ?? err, err)
+    logger.warn('Bad Request', {
+      status: HTTP_CODES?.BAD_REQUEST,
+      message: HTTP_TEXTS?.INTERNAL_ERROR,
+    });
+    throw new ExceptionFunction(
+      err?.message || HTTP_TEXTS.INTERNAL_ERROR,
+      err?.statusCode || err?.status || HTTP_CODES.SERVER_ERROR
+    );
   }
 }
 
+
+/**
+ * @description - Function retrieves the mapped locales and updates them in the project.json in DB
+ * @param req - A request body object with mapped locales as payload and project ID in the params
+ * @return - void
+ * @throws Exception if the project ID is invalid or the when the path to project.json is incorrect
+ */
+export const updateLocaleMapper = async (req:Request) =>{
+  const mapperObject = req.body.mapper;
+  const projectFilePath = path.join(process.cwd(), 'database', 'project.json'); // Adjusted path to project.json
+  const projectId = req.params.projectId;
+
+  try {
+    // Check if the project.json file exists
+    if (!fs.existsSync(projectFilePath)) {
+      console.error(`project.json not found at ${projectFilePath}`);
+      throw new Error(`project.json not found.`);
+    }
+    
+    // Find the project with the specified projectId
+    const project: any = ProjectModelLowdb.chain.get("projects").find({ id: projectId }).value();
+    if (project) {
+      const index = ProjectModelLowdb.chain.get("projects").findIndex({ id: projectId }).value();
+      if (index > -1) {
+        ProjectModelLowdb.update((data: any) => {
+          data.projects[index].master_locale = mapperObject?.master_locale;
+          data.projects[index].locales = mapperObject?.locales;
+        });
+      } // Write back the updated projects
+    } else {
+      logger.error(`Project with ID: ${projectId} not found`,{
+        status: HTTP_CODES?.NOT_FOUND,
+        message: HTTP_TEXTS?.INVALID_ID
+      })
+    }
+  } catch (err: any) {
+    console.error("🚀 ~ createSourceLocales ~ err:", err?.response?.data ?? err, err)
+    logger.warn('Bad Request', {
+      status: HTTP_CODES?.BAD_REQUEST,
+      message: HTTP_TEXTS?.INTERNAL_ERROR,
+    });
+    throw new ExceptionFunction(
+      err?.message || HTTP_TEXTS.INTERNAL_ERROR,
+      err?.statusCode || err?.status || HTTP_CODES.SERVER_ERROR
+    );
+  }
+
+}
+
 export const migrationService = {
   createTestStack,
   deleteTestStack,
   startTestMigration,
   startMigration,
   getLogs,
-  createSourceLocales
+  createSourceLocales,
+  updateLocaleMapper
 };

upload-api/migration-sitecore/index.js

@@ -7,7 +7,7 @@ import reference from "./libs/reference.js";
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 import ExtractFiles from "./libs/convert.js"
 
-import findAndExtractLanguages from './libs/extractLocales.js'
+import {findAndExtractLanguages} from './libs/extractLocales.js'
 
 export {
   contentTypes,

upload-api/migration-sitecore/libs/extractLocales.js

@@ -0,0 +1,29 @@
+import fs from 'fs'
+import path from 'path'
+
+const uniqueLanguages = new Set(); // Define uniqueLanguages globally or pass it as a parameter
+
+export const findAndExtractLanguages = (dir) => {
+    const items = fs.readdirSync(dir, { withFileTypes: true });
+
+    for (const item of items) {
+        const fullPath = path.join(dir, item.name);
+        
+        if (item.isDirectory()) {
+            findAndExtractLanguages(fullPath); // Proper recursion
+        } else if (item.isFile() && item.name === "data.json.json") {
+            try {
+                const rawData = fs.readFileSync(fullPath, "utf8");
+                const jsonData = JSON.parse(rawData);
+                const language = jsonData?.item?.$?.language;
+
+                if (language) {
+                    uniqueLanguages.add(language);
+                }
+            } catch (error) {
+                console.error(`Error reading ${fullPath}:`, error.message);
+            }
+        }
+    }
+    return uniqueLanguages;
+};

upload-api/src/controllers/sitecore/index.ts

@@ -19,7 +19,8 @@ const createSitecoreMapper = async (filePath: string = "", projectId: string | s
     const newPath = path.join(filePath, 'items');
 
     const localeData = await findAndExtractLanguages(path.join(filePath, 'items','master','sitecore','content')); 
-    logger.info('Fetched Locales: ', localeData)
+    console.log("Fetched Locales: ", localeData);
+    
 
     await ExtractFiles(newPath);
     await ExtractConfiguration(newPath);
@@ -76,15 +77,15 @@ const createSitecoreMapper = async (filePath: string = "", projectId: string | s
 
       const mapRes = await axios.request(mapperConfig)
       if(mapRes?.status==200){
-        logger.info('Validation success', {
+        logger.info('Locales Saved', {
           status: HTTP_CODES?.OK,
           message: HTTP_TEXTS?.LOCALE_SAVED,
-        });   
+        });
       }
 
     }
   } catch (err: any) {
-    console.error("🚀 ~ createSitecoreMapper ~ err:", err?.response?.data ?? err, err)
+    console.error("🚀 ~ createSitecoreMapper ~ err:", err?.response?.data ?? err)
     logger.warn('Validation error:', {
       status: HTTP_CODES?.UNAUTHORIZED,
       message: HTTP_TEXTS?.VALIDATION_ERROR,