refactor: replace statusMessage with skipReason and skipDetail (Suggestion only)

- Add Suggestion.SKIP_REASONS enum
- Add skipReason and skipDetail attributes to Suggestion schema with postgrestField mapping
- Remove statusMessage from Opportunity (hold out of scope per review)
- Update unit tests

Author: Kanishka

packages/spacecat-shared-data-access/src/models/opportunity/opportunity.schema.js

@@ -66,9 +66,6 @@ const schema = new SchemaBuilder(Opportunity, OpportunityCollection)
   .addAttribute('tags', {
     type: 'set',
     items: 'string',
-  })
-  .addAttribute('statusMessage', {
-    type: 'string',
   });
 
 export default schema.build();

packages/spacecat-shared-data-access/src/models/suggestion/suggestion.model.js

@@ -46,6 +46,15 @@ class Suggestion extends BaseModel {
     CONFIG_UPDATE: 'CONFIG_UPDATE',
   };
 
+  /** Predefined categories for skip reason. Maps to PostgreSQL skip_reason. */
+  static SKIP_REASONS = {
+    ALREADY_IMPLEMENTED: 'already_implemented',
+    INACCURATE_OR_INCOMPLETE: 'inaccurate_or_incomplete',
+    TOO_RISKY: 'too_risky',
+    NO_REASON: 'no_reason',
+    OTHER: 'other',
+  };
+
   // Import schemas from external file for maintainability
   static FIELD_TRANSFORMERS = FIELD_TRANSFORMERS;
 

packages/spacecat-shared-data-access/src/models/suggestion/suggestion.schema.js

@@ -50,8 +50,14 @@ const schema = new SchemaBuilder(Suggestion, SuggestionCollection)
     required: true,
     default: Suggestion.STATUSES.NEW,
   })
-  .addAttribute('statusMessage', {
+  .addAttribute('skipReason', {
+    type: Object.values(Suggestion.SKIP_REASONS),
+    postgrestField: 'skip_reason',
+  })
+  .addAttribute('skipDetail', {
     type: 'string',
+    postgrestField: 'skip_detail',
+    validate: (value) => !value || (typeof value === 'string' && value.length <= 500),
   });
 
 export default schema.build();

packages/spacecat-shared-data-access/test/unit/models/opportunity/opportunity.model.test.js

@@ -338,17 +338,6 @@ describe('OpportunityModel', () => {
     });
   });
 
-  describe('getStatusMessage and setStatusMessage', () => {
-    it('returns undefined when no status message is set', () => {
-      expect(instance.getStatusMessage()).to.be.undefined;
-    });
-
-    it('sets and gets the status message', () => {
-      instance.setStatusMessage('Not relevant for our use case');
-      expect(instance.getStatusMessage()).to.equal('Not relevant for our use case');
-    });
-  });
-
   describe('getOrigin and setOrigin', () => {
     it('returns the origin of the opportunity', () => {
       expect(instance.getOrigin()).to.equal('ESS_OPS');

packages/spacecat-shared-data-access/test/unit/models/suggestion/suggestion.model.test.js

@@ -133,14 +133,34 @@ describe('SuggestionModel', () => {
     });
   });
 
-  describe('getStatusMessage and setStatusMessage', () => {
-    it('returns undefined when no status message is set', () => {
-      expect(instance.getStatusMessage()).to.be.undefined;
+  describe('SKIP_REASONS', () => {
+    it('has SKIP_REASONS enum', () => {
+      expect(Suggestion.SKIP_REASONS).to.be.an('object');
+      expect(Suggestion.SKIP_REASONS.ALREADY_IMPLEMENTED).to.equal('already_implemented');
+      expect(Suggestion.SKIP_REASONS.TOO_RISKY).to.equal('too_risky');
+      expect(Suggestion.SKIP_REASONS.OTHER).to.equal('other');
+    });
+  });
+
+  describe('getSkipReason and setSkipReason', () => {
+    it('returns undefined when no skip reason is set', () => {
+      expect(instance.getSkipReason()).to.be.undefined;
+    });
+
+    it('sets and gets the skip reason', () => {
+      instance.setSkipReason('too_risky');
+      expect(instance.getSkipReason()).to.equal('too_risky');
+    });
+  });
+
+  describe('getSkipDetail and setSkipDetail', () => {
+    it('returns undefined when no skip detail is set', () => {
+      expect(instance.getSkipDetail()).to.be.undefined;
     });
 
-    it('sets and gets the status message', () => {
-      instance.setStatusMessage('Not relevant for our use case');
-      expect(instance.getStatusMessage()).to.equal('Not relevant for our use case');
+    it('sets and gets the skip detail', () => {
+      instance.setSkipDetail('Not relevant for our use case');
+      expect(instance.getSkipDetail()).to.equal('Not relevant for our use case');
     });
   });