[FIX] read value description from user dictionary correctly (#623)

* Fix case sensitive attribute access to description * Fix reading description from user dictionary
neurobagel · Nov 13, 2023 · 3cf91bf · 3cf91bf
1 parent 1161c37
commit 3cf91bf
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 15 deletions.
diff --git a/cypress/fixtures/examples/good/example.json b/cypress/fixtures/examples/good/example.json
@@ -6,8 +6,8 @@
 	"sex": {
 		"Description": "sex of the participant as reported by the participant",
 		"Levels": {
-			"M": "male",
-			"F": "female"
+			"1": "male",
+			"2": "female"
 		}
 	},
 	"group": {

diff --git a/cypress/unit/store-getter-getValueDescription.cy.js b/cypress/unit/store-getter-getValueDescription.cy.js
@@ -5,17 +5,13 @@ const state = {
     dataDictionary: {
         annotated: {
             "goodColumn": {
-                "levels": {
-                    "value1": {
-                        "description": "my description"
-                    },
-                    "value2": {
-                        "description": "my other description"
+                "Levels": {
+                    "value1": "my description",
+                    "value2": "my other description"
                     }
-                }
             },
             "levelsButNothingElse": {
-                "levels": {
+                "Levels": {
                 }
             },
             "badColumn": {
@@ -33,12 +29,12 @@ describe("getValueDescription", () => {
         expect(result).to.be.equal("my description");
     });
 
-    it("Returns an empty string if the value does not have a description", () => {
+    it("Returns 'no description available' if the value does not have a description", () => {
 
         const resultNoValue = getters.getValueDescription(state)("levelsButNothingElse", "notExistValue");
-        expect(resultNoValue).to.be.empty;
+        expect(resultNoValue).to.be.equal("no description available");
 
         const resultNoLevels = getters.getValueDescription(state)("badColumn", "notExistValue");
-        expect(resultNoLevels).to.be.empty;
+        expect(resultNoLevels).to.be.equal("no description available");
     });
 });
diff --git a/store/index.js b/store/index.js
@@ -644,9 +644,9 @@ export const getters = {
     getValueDescription: (p_state) => (p_columnName, p_value) => {
         // Returns the description of a value in a column, if that description exists
         // Otherwise it returns an empty string
-        const description = p_state.dataDictionary.annotated[p_columnName].levels?.[p_value]?.description;
+        const description = p_state.dataDictionary.annotated[p_columnName].Levels?.[p_value];
         if ( typeof description  === "undefined" ) {
-            return "";
+            return "no description available";
         }
         return description;
     },