Merge pull request #32 from contentstack/feat/DX-317-handle-variant-a…

…pi-errors feat: handled variant api errors
contentstack · May 9, 2024 · 1514232 · 1514232
2 parents cbc09b9 + d70f22d
commit 1514232
Show file tree

Hide file tree

Showing 16 changed files with 148 additions and 97 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/contentstack-export/src/export/modules/personalization.ts b/packages/contentstack-export/src/export/modules/personalization.ts
@@ -39,7 +39,6 @@ export default class ExportPersonalization {
       }
     } catch (error) {
       this.exportConfig.personalizationEnabled = false;
-      log(this.exportConfig, `Failed to export Personalization project. ${formatError(error)}`, 'error');
       log(this.exportConfig, error, 'error');
     }
   }

diff --git a/packages/contentstack-import/src/import/modules/personalization.ts b/packages/contentstack-import/src/import/modules/personalization.ts
@@ -35,7 +35,11 @@ export default class ImportPersonalization {
         }
       }
     } catch (error) {
+      this.config.modules.personalization.importData = false; // Stop personalization import if project creation fails
       log(this.config, error, 'error');
+      if (!this.personalization.importData){
+        log(this.config, 'Skipping personalization migration...', 'warn')
+      } 
     }
   }
 }
diff --git a/packages/contentstack-variants/src/export/attributes.ts b/packages/contentstack-variants/src/export/attributes.ts
@@ -35,18 +35,14 @@ export default class ExportAttributes extends PersonalizationAdapter<ExportConfi
 
       if (!this.attributes?.length) {
         log(this.exportConfig, 'No Attributes found with the given project!', 'info');
-        return;
       } else {
         this.sanitizeAttribs();
         fsUtil.writeFile(pResolve(this.attributesFolderPath, this.attributesConfig.fileName), this.attributes);
         log(this.exportConfig, 'All the attributes have been exported successfully!', 'success');
-        return;
       }
-    } catch (error: any) {
-      if (error?.errorMessage || error?.message || error?.error_message) {
-        log(this.exportConfig, `Failed to export attributes! ${formatError(error)}`, 'error');
-      }
-      throw error;
+    } catch (error) {
+      log(this.exportConfig, `Failed to export attributes!`, 'error');
+      log(this.config, error, 'error');
     }
   }
 

diff --git a/packages/contentstack-variants/src/export/audiences.ts b/packages/contentstack-variants/src/export/audiences.ts
@@ -42,11 +42,9 @@ export default class ExportAudiences extends PersonalizationAdapter<ExportConfig
         log(this.exportConfig, 'All the audiences have been exported successfully!', 'success');
         return;
       }
-    } catch (error: any) {
-      if (error?.errorMessage || error?.message || error?.error_message) {
-        log(this.exportConfig, `Failed to export audiences! ${formatError(error)}`, 'error');
-      }
-      throw error;
+    } catch (error) {
+      log(this.exportConfig, `Failed to export audiences!`, 'error');
+      log(this.config, error, 'error');
     }
   }
 

diff --git a/packages/contentstack-variants/src/export/events.ts b/packages/contentstack-variants/src/export/events.ts
@@ -42,11 +42,9 @@ export default class ExportEvents extends PersonalizationAdapter<ExportConfig> {
         log(this.exportConfig, 'All the events have been exported successfully!', 'success');
         return;
       }
-    } catch (error: any) {
-      if (error?.errorMessage || error?.message || error?.error_message) {
-        log(this.exportConfig, `Failed to export events! ${formatError(error)}`, 'error');
-      }
-      throw error;
+    } catch (error) {
+      log(this.exportConfig, `Failed to export events!`, 'error');
+      log(this.config, error, 'error');
     }
   }
 

diff --git a/packages/contentstack-variants/src/export/experiences.ts b/packages/contentstack-variants/src/export/experiences.ts
@@ -51,8 +51,8 @@ export default class ExportExperiences extends PersonalizationAdapter<ExportConf
       );
       log(this.exportConfig, 'All the experiences have been exported successfully!', 'success');
     } catch (error) {
-      log(this.exportConfig, `Failed to export experiences  ${formatError(error)}`, 'error');
-      throw error;
+      log(this.exportConfig, `Failed to export experiences!`, 'error');
+      log(this.config, error, 'error');
     }
   }
 }
diff --git a/packages/contentstack-variants/src/export/projects.ts b/packages/contentstack-variants/src/export/projects.ts
@@ -33,12 +33,12 @@ export default class ExportProjects extends PersonalizationAdapter<ExportConfig>
         this.exportConfig.personalizationEnabled = false;
         return;
       }
-      this.exportConfig.project_id = project[0].uid;
       this.exportConfig.personalizationEnabled = true;
       this.exportConfig.project_id = project[0]?.uid;
       fsUtil.writeFile(path.resolve(this.projectFolderPath, 'projects.json'), project);
+      log(this.exportConfig, 'Project exported successfully!', 'success');
     } catch (error) {
-      log(this.exportConfig, `Failed to export projects  ${formatError(error)}`, 'error');
+      log(this.exportConfig, `Failed to export projects!`, 'error');
       throw error;
     }
   }

diff --git a/packages/contentstack-variants/src/import/attribute.ts b/packages/contentstack-variants/src/import/attribute.ts
@@ -51,11 +51,9 @@ export default class Attribute extends PersonalizationAdapter<ImportConfig> {
 
         fsUtil.writeFile(this.attributesUidMapperPath, this.attributesUidMapper);
         this.log(this.config, this.$t(this.messages.CREATE_SUCCESS, { module: 'Attributes' }), 'info');
-      } catch (error: any) {
-        if (error?.errorMessage || error?.message || error?.error_message) {
-          this.log(this.config, this.$t(this.messages.CREATE_FAILURE, { module: 'Attributes' }), 'error');
-        }
-        throw error;
+      } catch (error) {
+        this.log(this.config, this.$t(this.messages.CREATE_FAILURE, { module: 'Attributes' }), 'error');
+        this.log(this.config, error, 'error');
       }
     }
   }

diff --git a/packages/contentstack-variants/src/import/audiences.ts b/packages/contentstack-variants/src/import/audiences.ts
@@ -60,11 +60,9 @@ export default class Audiences extends PersonalizationAdapter<ImportConfig> {
 
         fsUtil.writeFile(this.audiencesUidMapperPath, this.audiencesUidMapper);
         this.log(this.config, this.$t(this.messages.CREATE_SUCCESS, { module: 'Audiences' }), 'info');
-      } catch (error: any) {
-        if (error?.errorMessage || error?.message || error?.error_message) {
-          this.log(this.config, this.$t(this.messages.CREATE_FAILURE, { module: 'Audiences' }), 'error');
-        }
-        throw error;
+      } catch (error) {
+        this.log(this.config, this.$t(this.messages.CREATE_FAILURE, { module: 'Audiences' }), 'error');
+        this.log(this.config, error, 'error');
       }
     }
   }

diff --git a/packages/contentstack-variants/src/import/events.ts b/packages/contentstack-variants/src/import/events.ts
@@ -49,11 +49,9 @@ export default class Events extends PersonalizationAdapter<ImportConfig> {
 
         fsUtil.writeFile(this.eventsUidMapperPath, this.eventsUidMapper);
         this.log(this.config, this.$t(this.messages.CREATE_SUCCESS, { module: 'Events' }), 'info');
-      } catch (error: any) {
-        if (error?.errorMessage || error?.message || error?.error_message) {
-          this.log(this.config, this.$t(this.messages.CREATE_FAILURE, { module: 'Events' }), 'error');
-        }
-        throw error;
+      } catch (error) {
+        this.log(this.config, this.$t(this.messages.CREATE_FAILURE, { module: 'Events' }), 'error');
+        this.log(this.config, error, 'error');
       }
     }
   }

diff --git a/packages/contentstack-variants/src/import/experiences.ts b/packages/contentstack-variants/src/import/experiences.ts
@@ -111,12 +111,9 @@ export default class Experiences extends PersonalizationAdapter<ImportConfig> {
         }
 
         await this.createVariantIdMapper();
-      } catch (error: any) {
-        if (error?.errorMessage || error?.message || error?.error_message) {
-          this.log(this.config, this.$t(this.messages.CREATE_FAILURE, { module: 'Experiences' }), 'error');
-        } else {
-          this.log(this.config, error, 'error');
-        }
+      } catch (error) {
+        this.log(this.config, this.$t(this.messages.CREATE_FAILURE, { module: 'Experiences' }), 'error');
+        this.log(this.config, error, 'error');
       }
     }
   }

diff --git a/packages/contentstack-variants/src/messages/index.ts b/packages/contentstack-variants/src/messages/index.ts
@@ -1,7 +1,7 @@
 import memoize from 'lodash/memoize';
 
 const errors = {
-  CREATE_FAILURE: '{module} created failed!',
+  CREATE_FAILURE: '{module} creation failed!',
 };
 
 const commonMsg = {

diff --git a/packages/contentstack-variants/src/types/personalization-api-adapter.ts b/packages/contentstack-variants/src/types/personalization-api-adapter.ts
@@ -114,7 +114,7 @@ export type ExperienceStruct = {
   _cms?: {
     variantGroup: object;
     variants: Record<string, string>;
-  }
+  };
 } & AnyProperty;
 
 export interface CreateExperienceInput {
@@ -138,6 +138,25 @@ export interface CMSExperienceStruct {
   contentTypes: string[];
 }
 
+export type VariantAPIRes =
+  | ProjectStruct[]
+  | ProjectStruct
+  | AttributeStruct[]
+  | AttributeStruct
+  | ExperienceStruct[]
+  | EventStruct[]
+  | AudienceStruct[]
+  | ExperienceStruct
+  | EventStruct
+  | AudienceStruct
+  | CMSExperienceStruct
+  | Error;
+
+export interface APIResponse {
+    status: number;
+    data: any;
+  }
+
 export interface Personalization<T> extends AdapterHelperInterface<T, HttpClient> {
   projects(options: GetProjectsParams): Promise<ProjectStruct[] | void>;
 
@@ -157,5 +176,7 @@ export interface Personalization<T> extends AdapterHelperInterface<T, HttpClient
 
   getCTsFromExperience(experienceUid: string): Promise<CMSExperienceStruct | void>;
 
-  updateCTsInExperience(experience: UpdateExperienceInput, experienceUid: string): Promise<CMSExperienceStruct | void>; 
+  updateCTsInExperience(experience: UpdateExperienceInput, experienceUid: string): Promise<CMSExperienceStruct | void>;
+
+  handleVariantAPIRes(res: any): VariantAPIRes;
 }