Refactoring checkUserCriteria.js

Author: Lacah

Script Includes/Check User Criteria for Catalog Item/checkUserCriteria.js

@@ -1,49 +1,46 @@
-/**
- * Script Include to check if a user has access to a catalog item based on user criteria.
- * 
- * @param {string} item - The sys_id of the catalog item to check.
- * @param {boolean} [adminOverride] - Optional. Specifies whether an admin override should apply.
- * @param {string} [userToCheck] - Optional. The sys_id of the user to check access for. Defaults to the current user if not provided.
- * 
- * @returns {boolean} - Returns true if the user has access to the catalog item, false otherwise.
- */
-
 var CheckCriteria = Class.create();
 CheckCriteria.prototype = {
     initialize: function() {},
-    itemCriteria: function(item, adminOverride, userToCheck) {		
-
-		// Determine the user object and user ID, using provided userToCheck or defaulting to the current user
-        var userObj = !gs.nil(userToCheck) ? gs.getUser().getUserByID(userToCheck) : gs.getUser(); 
-        var userId = !gs.nil(userToCheck) ? userToCheck : gs.getUserID();
 
-		// Admin override: if the user is an admin and adminOverride is not set to false, return true
-        if(adminOverride != false && userObj.hasRole('admin')) {
-			return true;
-		}
+    /**
+     * Checks if the user meets the criteria to access the catalog item.
+     * 
+     * @param {string} item - The sys_id of the catalog item.
+     * @param {boolean} [adminOverride] - Optional. Whether admin role should override the criteria check. Defaults to false if not provided.
+     * @param {string} [userToCheck] - Optional. The user ID of the user whose access is being checked. Defaults to the current user if not specified.
+     * 
+     * @returns {boolean} - True if the user has access to the catalog item, otherwise false.
+     */
+    itemCriteria: function(item, adminOverride, userToCheck) {
+        // Set default value for adminOverride if not provided
+        adminOverride = (typeof adminOverride !== 'undefined') ? adminOverride : false;
 
-		// Error handling: Ensure the item parameter is provided and not null
+        // Early exit if item is nil or missing
         if (gs.nil(item)) {
             gs.error('CheckCriteria().itemCriteria() failed: item parameter is missing or null, item: ' + item);
-            return;
+            return false;
+        }
+
+        // Get the user object and user ID, defaulting to the current user if userToCheck is not provided
+        var userObj = !gs.nil(userToCheck) ? gs.getUser().getUserByID(userToCheck) : gs.getUser();
+        var userId = userObj.getID();
+
+        // Admin override: if the user is an admin and adminOverride is true, return true
+        if (adminOverride && userObj.hasRole('admin')) {
+            return true;
         }
 
-		// Get the "Available for" and "Not Available for" user criteria for the catalog item
+        // Fetch "Available for" and "Not Available for" user criteria
         var availableForUC = this.getUserCritria(item, true);
         var notAvailableForUC = this.getUserCritria(item, false);
 
-		// Check if the user matches the "Not Available for" criteria
-        if(sn_uc.UserCriteriaLoader.userMatches(userId, notAvailableForUC)) {
-			return false; // User does not have access
-		} 
+        // Check if the user matches the "Not Available for" criteria first
+        if (sn_uc.UserCriteriaLoader.userMatches(userId, notAvailableForUC)) {
+            return false;
+        }
+
         // Check if the user matches the "Available for" criteria
-        else if (sn_uc.UserCriteriaLoader.userMatches(userId, availableForUC)) {
-			return true; // User has access
-		} 
-        // If user doesn't match any criteria, they have no access
-        else {
-			return false;
-		}
+        return sn_uc.UserCriteriaLoader.userMatches(userId, availableForUC);
     },
 
     /**
@@ -55,27 +52,30 @@ CheckCriteria.prototype = {
      * @returns {Array<string>} - An array of user criteria sys_ids for the catalog item.
      */
     getUserCritria: function(item, available) {
-		// Error handling: Ensure the item parameter is provided and not null
+        // Early exit if item is nil or missing
         if (gs.nil(item)) {
             gs.error('CheckCriteria().getUserCritria() failed: item parameter is missing or null, item: ' + item);
-            return;
+            return [];
         }
-        
-        var returnArr = [];
-		// Determine the correct table based on whether we're checking "Available for" or "Not Available for"
-        var tableToCheck = available == false ? 'sc_cat_item_user_criteria_no_mtom' : 'sc_cat_item_user_criteria_mtom';
 
-        // Query the user criteria table for the catalog item
+        // Define table name constants
+        var TABLE_AVAILABLE = 'sc_cat_item_user_criteria_mtom';
+        var TABLE_NOT_AVAILABLE = 'sc_cat_item_user_criteria_no_mtom';
+
+        // Select appropriate table based on availability flag
+        var tableToCheck = available ? TABLE_AVAILABLE : TABLE_NOT_AVAILABLE;
+
+        // Query user criteria from the appropriate table
         var ucCheckGr = new GlideRecord(tableToCheck);
         ucCheckGr.addQuery('sc_cat_item', item);
         ucCheckGr.query();
-		
-		// Loop through the results and collect the user criteria
+
+        // Store user criteria sys_ids in an array
+        var returnArr = [];
         while (ucCheckGr.next()) {
             returnArr.push(ucCheckGr.getValue('user_criteria'));
         }
-        
-		// Return the array of user criteria sys_ids
+
         return returnArr;
     },