Merge pull request #421 from icgc-argo/treatment_unknown

add unknown treatment exception validations
icgc-argo · Oct 27, 2023 · dc60b84 · dc60b84
2 parents 31b643f + 53fcb45
commit dc60b84
Show file tree

Hide file tree

Showing 3 changed files with 446 additions and 256 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1,3 +1,4 @@
+.DS_Store
 node_modules
 dictionary.json
 populated_dictionary.json

diff --git a/references/validationFunctions/treatment/checkWhenNoTreatment.js b/references/validationFunctions/treatment/checkWhenNoTreatment.js
@@ -5,42 +5,81 @@
  * You should have received a copy of the GNU Affero General Public License along with
  * this program. If not, see <http://www.gnu.org/licenses/>.
  *
- * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY                           
- * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES                          
- * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT                           
- * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,                                
- * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED                          
- * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;                               
- * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER                              
- * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN                         
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT
+ * SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
+ * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS;
+ * OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER
+ * IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
- *  
+ *
  *
  */
 
 /**
- * If treatment_type is 'No treatment', core treatment fields should not be submitted.
+ * If treatment_type is 'No treatment' or 'Unknown', core treatment fields should not be submitted.
  */
 
-const validation = () => 
-  (function validate(inputs) {
-      const {$row, $name, $field} = inputs;
-      let result = {valid: true, message: "Ok"};
-      const coreFields = ['treatment_start_interval', 'treatment_duration', 'is_primary_treatment', 'treatment_intent', 'treatment_setting', 'response_to_treatment_criteria_method', 'response_to_treatment'];
-
-      // checks for a string just consisting of whitespace
-      const checkforEmpty = (entry) => {return /^\s+$/g.test(decodeURI(entry).replace(/^"(.*)"$/, '$1'))};
-      const treatmentType = ($row.treatment_type).map(value => value.toLowerCase());
-
-      if (!treatmentType.includes("no treatment") && coreFields.includes($name) && (!$field || $field === null || checkforEmpty($field))) {
-          result = { valid: false, message: `The '${$name}' field must be submitted when the 'treatment_type' field is '${treatmentType}'`};
-      }
-      else if (treatmentType.includes("no treatment") && ($field && $field != null && !(checkforEmpty($field)))) {
-        if (coreFields.includes($name) || (typeof($field) === 'string' && $field.trim().toLowerCase() != 'not applicable') || typeof($field) === 'number') {
-          result = { valid: false, message: `The '${$name}' field cannot be submitted if the 'treatment_type' field is '${treatmentType}'`};
+const validation = () =>
+    (function validate(inputs) {
+        const { $row, $name, $field } = inputs;
+        const result = { valid: true, message: 'Ok' };
+
+        const arrayItemsInSecondArray = (arr1, arr2) => {
+            return arr2.some(arr2Item => {
+                return arr1.includes(arr2Item);
+            });
+        };
+
+        const coreFields = [
+            'treatment_start_interval',
+            'treatment_duration',
+            'is_primary_treatment',
+            'treatment_intent',
+            'treatment_setting',
+            'response_to_treatment_criteria_method',
+            'response_to_treatment',
+        ];
+
+        const treatmentExceptionTypes = ['no treatment', 'unknown'];
+
+        // checks for a string just consisting of whitespace
+        const checkforEmpty = entry => {
+            return /^\s+$/g.test(decodeURI(entry).replace(/^"(.*)"$/, '$1'));
+        };
+        const treatmentTypes = $row.treatment_type.map(value => value.toLowerCase());
+
+        const recordHasTreatments = !arrayItemsInSecondArray(
+            treatmentExceptionTypes,
+            treatmentTypes,
+        );
+
+        if (recordHasTreatments) {
+            if (
+                coreFields.includes($name) &&
+                (!$field || $field === null || checkforEmpty($field))
+            ) {
+                return {
+                    valid: false,
+                    message: `The '${$name}' field must be submitted when the 'treatment_type' field is '${treatmentTypes}'`,
+                };
+            }
+
+        } else if ($field && $field != null && !checkforEmpty($field)) {
+            if (
+                coreFields.includes($name) ||
+                (typeof $field === 'string' && $field.trim().toLowerCase() != 'not applicable') ||
+                typeof $field === 'number'
+            ) {
+                return {
+                    valid: false,
+                    message: `The '${$name}' field cannot be submitted if the 'treatment_type' field is '${treatmentTypes}'`,
+                };
+            }
         }
-      }
-      return result;
-  });
+        return result;
+    });
 
 module.exports = validation;