refactor: centralize fiat value logic in dedicated helper

Author: wa0x6e

src/helpers/entityValue.ts

@@ -1,20 +1,17 @@
 type Proposal = {
-  scores_by_strategy: string;
-  vp_value_by_strategy: string;
+  scores_by_strategy: number[][];
+  vp_value_by_strategy: number[];
 };
 
 /**
  * Calculates the total proposal value based on the vote's total voting power and the proposal's value per strategy.
  * @returns The total value of the given proposal's votes, in the currency unit specified by the proposal's vp_value_by_strategy values
  */
 export function getProposalValue(proposal: Proposal): number {
-  const scoresByStrategy: number[][] = JSON.parse(proposal.scores_by_strategy);
-  const vpValueByStrategy: number[] = JSON.parse(proposal.vp_value_by_strategy);
-
   return (
-    scoresByStrategy[0]
-      ?.map((_, index) => scoresByStrategy.reduce((sum, array) => sum + array[index], 0))
-      ?.map((value, index) => value * vpValueByStrategy[index])
+    proposal.scores_by_strategy[0]
+      ?.map((_, index) => proposal.scores_by_strategy.reduce((sum, array) => sum + array[index], 0))
+      ?.map((value, index) => value * proposal.vp_value_by_strategy[index])
       ?.reduce((sum, value) => sum + value, 0) || 0
   );
 }

src/scores.ts

@@ -17,6 +17,7 @@ async function getProposal(id: string): Promise<any | undefined> {
   proposal.choices = JSON.parse(proposal.choices);
   proposal.scores = JSON.parse(proposal.scores);
   proposal.scores_by_strategy = JSON.parse(proposal.scores_by_strategy);
+  proposal.vp_value_by_strategy = JSON.parse(proposal.vp_value_by_strategy);
   let proposalState = 'pending';
   const ts = parseInt((Date.now() / 1e3).toFixed());
   if (ts > proposal.start) proposalState = 'active';
@@ -99,10 +100,7 @@ async function updateProposalScores(proposalId: string, scores: any, votes: numb
 }
 
 async function updateProposalScoresValue(proposalId: string) {
-  const [proposal] = await db.queryAsync(
-    'SELECT vp_value_by_strategy, scores_by_strategy FROM proposals WHERE id = ? LIMIT 1;',
-    [proposalId]
-  );
+  const proposal = await getProposal(proposalId);
   const query = 'UPDATE proposals SET scores_total_value = ? WHERE id = ? LIMIT 1;';
   await db.queryAsync(query, [getProposalValue(proposal), proposalId]);
 }

test/unit/helpers/entityValue.test.ts

@@ -3,8 +3,8 @@ import { getProposalValue } from '../../../src/helpers/entityValue';
 describe('getProposalValue', () => {
   it('should calculate correct proposal value with single strategy', () => {
     const proposal = {
-      scores_by_strategy: '[[100], [200]]',
-      vp_value_by_strategy: '[2.5]'
+      scores_by_strategy: [[100], [200]],
+      vp_value_by_strategy: [2.5]
     };
 
     const result = getProposalValue(proposal);
@@ -14,8 +14,12 @@ describe('getProposalValue', () => {
 
   it('should calculate correct proposal value with multiple strategies', () => {
     const proposal = {
-      scores_by_strategy: '[[100, 50], [200, 75], [300, 25]]',
-      vp_value_by_strategy: '[1.5, 3.0]'
+      scores_by_strategy: [
+        [100, 50],
+        [200, 75],
+        [300, 25]
+      ],
+      vp_value_by_strategy: [1.5, 3.0]
     };
 
     const result = getProposalValue(proposal);
@@ -25,8 +29,8 @@ describe('getProposalValue', () => {
 
   it('should return 0 when scores_by_strategy is empty', () => {
     const proposal = {
-      scores_by_strategy: '[]',
-      vp_value_by_strategy: '[2.0]'
+      scores_by_strategy: [],
+      vp_value_by_strategy: [2.0]
     };
 
     const result = getProposalValue(proposal);
@@ -36,8 +40,8 @@ describe('getProposalValue', () => {
 
   it('should return 0 when first strategy array is empty', () => {
     const proposal = {
-      scores_by_strategy: '[[]]',
-      vp_value_by_strategy: '[2.0]'
+      scores_by_strategy: [[]],
+      vp_value_by_strategy: [2.0]
     };
 
     const result = getProposalValue(proposal);
@@ -47,8 +51,11 @@ describe('getProposalValue', () => {
 
   it('should handle zero values correctly', () => {
     const proposal = {
-      scores_by_strategy: '[[0, 0], [0, 0]]',
-      vp_value_by_strategy: '[2.0, 1.5]'
+      scores_by_strategy: [
+        [0, 0],
+        [0, 0]
+      ],
+      vp_value_by_strategy: [2.0, 1.5]
     };
 
     const result = getProposalValue(proposal);
@@ -58,8 +65,11 @@ describe('getProposalValue', () => {
 
   it('should handle zero vp_value_by_strategy correctly', () => {
     const proposal = {
-      scores_by_strategy: '[[100, 50], [200, 75]]',
-      vp_value_by_strategy: '[0, 0]'
+      scores_by_strategy: [
+        [100, 50],
+        [200, 75]
+      ],
+      vp_value_by_strategy: [0, 0]
     };
 
     const result = getProposalValue(proposal);
@@ -69,8 +79,11 @@ describe('getProposalValue', () => {
 
   it('should handle decimal values correctly', () => {
     const proposal = {
-      scores_by_strategy: '[[10.5, 20.5], [15.5, 25.5]]',
-      vp_value_by_strategy: '[0.1, 0.2]'
+      scores_by_strategy: [
+        [10.5, 20.5],
+        [15.5, 25.5]
+      ],
+      vp_value_by_strategy: [0.1, 0.2]
     };
 
     const result = getProposalValue(proposal);
@@ -80,30 +93,12 @@ describe('getProposalValue', () => {
 
   it('should handle single vote scenario', () => {
     const proposal = {
-      scores_by_strategy: '[[100]]',
-      vp_value_by_strategy: '[2.0]'
+      scores_by_strategy: [[100]],
+      vp_value_by_strategy: [2.0]
     };
 
     const result = getProposalValue(proposal);
 
     expect(result).toBe(200); // 100 * 2.0 = 200
   });
-
-  it('should throw error for invalid JSON in scores_by_strategy', () => {
-    const proposal = {
-      scores_by_strategy: 'invalid json',
-      vp_value_by_strategy: '[2.0]'
-    };
-
-    expect(() => getProposalValue(proposal)).toThrow();
-  });
-
-  it('should throw error for invalid JSON in vp_value_by_strategy', () => {
-    const proposal = {
-      scores_by_strategy: '[[100]]',
-      vp_value_by_strategy: 'invalid json'
-    };
-
-    expect(() => getProposalValue(proposal)).toThrow();
-  });
 });