Merge pull request #515 from contentstack/dev

Dev

Author: umeshmore45

.DS_Store

@@ -118,7 +118,7 @@ jobs:
             env:
                 GH_TOKEN: ${{ secrets.GH_PAT }}
 
-        -   name: Sync changes to wordpress-repo (if applicable)
+        -   name: Sync changes to contentful-repo (if applicable)
             if: |
                 env.merged == 'true' &&
                 (

.github/workflows/repo-sync.yml

@@ -349,6 +349,7 @@ MigrationBackup/
 # Ionide (cross platform F# VS Code tools) working folder
 .ionide/
 
+**.DS_Store
 
 upload-api/node_modules
 upload-api/build

.gitignore

@@ -17,6 +17,7 @@ dist/
 # Mono auto generated files
 mono_crash.*
 
+
 # Build results
 [Dd]ebug/
 [Dd]ebugPublic/
@@ -358,6 +359,7 @@ combine.log
 
 
 !example.env
+!production.env
 
 database/
 /sitecoreMigrationData

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/src/.DS_Store

@@ -88,39 +88,44 @@ function makeChunks(assetData: any) {
 
 const transformCloudinaryObject = (input: any) => {
   const result: any = [];
+  if (!Array.isArray(input)) {
+    return result;
+  }
   for (const metaData of input ?? []) {
-    result?.push({
-      public_id: metaData.public_id,
-      resource_type: metaData.resource_type,
-      type: metaData.type,
-      format: metaData.format,
-      version: metaData.version,
-      url: metaData.original_url,
-      secure_url: metaData.original_secure_url,
-      width: metaData.width,
-      height: metaData.height,
-      bytes: metaData.bytes,
-      duration: metaData.duration,
-      tags: metaData.tags,
-      metadata: metaData.metadata,
-      created_at: metaData.created_at,
-      access_mode: "public",
-      access_control: [],
-      created_by: {
-        type: "",
-        id: ""
-      },
-      uploaded_by: {
-        type: "",
-        id: ""
-      },
-      folder_id: "",
-      id: "",
-      folder: "",
-      cs_metadata: {
-        config_label: "config"
-      }
-    });
+    if (metaData?.public_id) {
+      result?.push({
+        public_id: metaData?.public_id,
+        resource_type: metaData?.resource_type,
+        type: metaData?.type,
+        format: metaData?.format,
+        version: metaData?.version,
+        url: metaData?.original_url,
+        secure_url: metaData?.original_secure_url,
+        width: metaData?.width,
+        height: metaData?.height,
+        bytes: metaData?.bytes,
+        duration: metaData?.duration,
+        tags: metaData?.tags,
+        metadata: metaData?.metadata,
+        created_at: metaData?.created_at,
+        access_mode: "public",
+        access_control: [],
+        created_by: {
+          type: "",
+          id: ""
+        },
+        uploaded_by: {
+          type: "",
+          id: ""
+        },
+        folder_id: uuidv4(),
+        id: uuidv4(),
+        folder: "",
+        cs_metadata: {
+          config_label: "config"
+        }
+      });
+    }
   }
   return result;
 }
@@ -185,7 +190,7 @@ function convertToArray(data: any) {
   if (typeof data === 'object' && data !== null && !Array.isArray(data)) {
     return [data]// Converts object values into an array
   }
-  return data; // Return as is if it's already an array or not an object
+  return data ?? []; // Return as is if it's already an array or not an object
 }
 
 const mktApp = (type: string, data: any) => {
@@ -736,7 +741,6 @@ const mapLocales = ({ masterLocale, locale, locales }: any) => {
  * @throws Will log errors encountered during file reading, processing, or writing of entries.
  */
 const createEntry = async (packagePath: any, destination_stack_id: string, projectId: string, contentTypes: any, mapperKeys: any, master_locale: string): Promise<void> => {
-  console.info("🚀 ~ createEntry ~ master_locale:", master_locale)
   const srcFunc = 'createEntry';
   try {
     const entriesSave = path.join(DATA, destination_stack_id, ENTRIES_DIR_NAME);
@@ -783,7 +787,7 @@ const createEntry = async (packagePath: any, destination_stack_id: string, proje
               entryData[name][lang][id] ??= {};
               locales.push(lang);
               const fieldData = currentCT?.fieldMapping?.find((item: any) => key === item?.uid);
-              const newId = fieldData?.contentstackFieldUid ?? `${key}`.replace(/[^a-zA-Z0-9]+/g, "_");
+              const newId = fieldData?.contentstackFieldUid ?? `${key}`?.replace?.(/[^a-zA-Z0-9]+/g, "_");
               entryData[name][lang][id][newId] = processField(
                 langValue,
                 entryId,
@@ -796,16 +800,14 @@ const createEntry = async (packagePath: any, destination_stack_id: string, proje
             const pathName = getDisplayName(name, displayField);
             locales.forEach((locale) => {
               const localeCode = mapLocales({ masterLocale: master_locale, locale, locales: LOCALE_MAPPER });
-              console.info("🚀 ~ locales.forEach ~ localeCode:", localeCode);
               const publishDetails = Object?.values?.(environmentsId)?.length ? Object?.values?.(environmentsId)
                 .filter((env: any) => env?.name === environment_id)
                 ?.map((env: any) => ({
                   environment: env?.uid,
                   version: 1,
-                  locale: locale?.toLowerCase(),
+                  locale: locale?.toLowerCase?.(),
                 })) : [];
-
-              const title = entryData[name][locale][id][pathName] || "";
+              const title = fields?.[pathName]?.[locale] || "";
               const urlTitle = title
                 ?.replace?.(/[^a-zA-Z0-9]+/g, "-")
                 ?.toLowerCase?.();
@@ -858,7 +860,7 @@ const createEntry = async (packagePath: any, destination_stack_id: string, proje
           );
           for await (const [chunkId, chunkData] of Object.entries(chunks)) {
             refs[chunkIndex++] = `${chunkId}-entries.json`;
-            await writeFile(filePath, `${chunkId}-entries.json`, chunkData)
+            await writeFile(filePath, `${chunkId}-entries.json`, chunkData);
           }
           await writeFile(filePath, ENTRIES_MASTER_FILE, refs);
         }

api/src/controllers/migration.controller.ts

@@ -25,7 +25,6 @@ import { extensionService } from "./extension.service.js";
 
 
 
-
 /**
  * Creates a test stack.
  *
@@ -245,10 +244,10 @@ const startTestMigration = async (req: Request): Promise<any> => {
           await wordpressService?.extractChunks(file_path, packagePath, project?.current_test_stack_id, projectId)
           await wordpressService?.getAllAuthors(file_path, packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
           //await wordpressService?.extractContentTypes(projectId, project?.current_test_stack_id, contentTypes)
-          await wordpressService?.getAllTerms(file_path, packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys,project?.stackDetails?.master_locale)
-          await wordpressService?.getAllTags(file_path, packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys,project?.stackDetails?.master_locale)
-          await wordpressService?.getAllCategories(file_path, packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys,project?.stackDetails?.master_locale)
-          await wordpressService?.extractPosts(packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys,project?.stackDetails?.master_locale)
+          await wordpressService?.getAllTerms(file_path, packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
+          await wordpressService?.getAllTags(file_path, packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
+          await wordpressService?.getAllCategories(file_path, packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
+          await wordpressService?.extractPosts(packagePath, project?.current_test_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
           await wordpressService?.extractGlobalFields(project?.current_test_stack_id, projectId)
           await wordpressService?.createVersionFile(project?.current_test_stack_id, projectId);
         }
@@ -319,12 +318,12 @@ const startMigration = async (req: Request): Promise<any> => {
           await wordpressService?.createAssetFolderFile(file_path, project?.destination_stack_id, projectId)
           await wordpressService?.getAllreference(file_path, packagePath, project?.destination_stack_id, projectId)
           await wordpressService?.extractChunks(file_path, packagePath, project?.destination_stack_id, projectId)
-          await wordpressService?.getAllAuthors(file_path, packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys,project?.stackDetails?.master_locale)
+          await wordpressService?.getAllAuthors(file_path, packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
           //await wordpressService?.extractContentTypes(projectId, project?.destination_stack_id)
           await wordpressService?.getAllTerms(file_path, packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
-          await wordpressService?.getAllTags(file_path, packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys,project?.stackDetails?.master_locale)
-          await wordpressService?.getAllCategories(file_path, packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys,project?.stackDetails?.master_locale)
-          await wordpressService?.extractPosts(packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys,project?.stackDetails?.master_locale)
+          await wordpressService?.getAllTags(file_path, packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
+          await wordpressService?.getAllCategories(file_path, packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
+          await wordpressService?.extractPosts(packagePath, project?.destination_stack_id, projectId, contentTypes, project?.mapperKeys, project?.stackDetails?.master_locale)
           await wordpressService?.extractGlobalFields(project?.destination_stack_id, projectId)
           await wordpressService?.createVersionFile(project?.destination_stack_id, projectId);
 
@@ -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;
+  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("🚀 ~ updateLocaleMapper ~ 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
 };