Merge pull request #484 from contentstack/feature/sitecore-locale-mapper

Feature/sitecore locale mapper

Author: RohitKini

.DS_Store

@@ -17,6 +17,9 @@ dist/
 # Mono auto generated files
 mono_crash.*
 
+#MAC DS_Store File
+/api/.DS_Store
+
 # Build results
 [Dd]ebug/
 [Dd]ebugPublic/

api/.DS_Store

@@ -1,5 +1,5 @@
 import { Request, Response } from "express";
-import { migrationService } from "../services/migration.service.js";
+import { migrationService } from "../services/migration.service.js"
 
 /**
  * Creates a test stack.
@@ -55,10 +55,22 @@ const getLogs = async (req: Request, res: Response): Promise<void> => {
   res.status(200).json(resp);
 };
 
+const saveLocales = async (req:Request, res: Response):Promise<void> =>{
+  const resp = await migrationService.createSourceLocales(req)
+  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,
+  saveMappedLocales
 };

api/.gitignore

@@ -65,5 +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/production.env

@@ -25,7 +25,6 @@ import { extensionService } from "./extension.service.js";
 
 
 
-
 /**
  * Creates a test stack.
  *
@@ -411,10 +410,111 @@ 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) => {
+
+  const projectFilePath = path.join(process.cwd(), 'database', 'project.json'); // Adjusted path to project.json
+  const projectId = req.params.projectId;
+
+  const locales = req.body.locale
+
+  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].source_locales = 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
+    );
+  }
+}
+
+
+/**
+ * @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,
+  updateLocaleMapper
 };

api/src/.DS_Store

@@ -9,8 +9,10 @@ import { orgService } from './org.service.js';
 import { getLogMessage } from '../utils/index.js';
 import customLogger from '../utils/custom-logger.utils.js';
 
+
 const append = "a";
 
+
 const baseDirName = MIGRATION_DATA_CONFIG.DATA
 const {
   ENTRIES_DIR_NAME,