All files / libs channels.js

100% Statements 104/104
86.79% Branches 46/53
100% Functions 22/22
100% Lines 101/101

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 27910x                 41x         41x   41x 5x 3x       41x 41x 14x 14x 27x 23x 16x 16x 16x 16x   7x 7x 7x 7x   4x 4x 4x 4x 4x 4x 4x     41x                                                       10x   10x 37x 22x           37x   37x 31x         37x   37x 31x     37x         10x                               33x 33x 33x 33x         72x 27x 45x 17x   28x         33x 7x     33x     33x 27x             33x                                         22x 6x   6x   6x 6x 1x     6x   6x 17x     6x 17x 3x     20x   17x 20x   22x   20x     17x     6x 6x 6x 17x 17x 20x 2x 4x   20x       4x 4x 4x   4x 4x   4x 4x   4x     18x 70x   18x 18x 13x   18x 18x   18x           6x     6x                         16x                        
const RISKS = ["stable", "candidate", "beta", "edge"];
 
/**
 * Parse a channel string into an object
 * @param {string} channelString
 * @param {{defaultTrack: string}} options
 * @returns {{format: {risk: boolean, track: boolean, branch: boolean}, risk: *, track: (string|*), branch: (string|*)}}
 */
function parseChannel(channelString, options) {
  const format = {
    track: false,
    risk: false,
    branch: false,
  };
  const channelArr = ["latest", undefined, "_base"];
 
  if (options) {
    if (options.defaultTrack) {
      channelArr[0] = options.defaultTrack;
    }
  }
 
  const parts = channelString.split("/");
  if (parts.length === 1) {
    channelArr[1] = channelString;
    format.risk = true;
  } else if (parts.length === 2) {
    if (RISKS.indexOf(parts[0]) === -1) {
      channelArr[0] = parts[0];
      channelArr[1] = parts[1];
      format.track = true;
      format.risk = true;
    } else {
      channelArr[1] = parts[0];
      channelArr[2] = parts[1];
      format.risk = true;
      format.branch = true;
    }
  } else Eif (parts.length === 3) {
    channelArr[0] = parts[0];
    channelArr[1] = parts[1];
    channelArr[2] = parts[2];
    format.track = true;
    format.risk = true;
    format.branch = true;
  }
 
  return {
    track: channelArr[0],
    risk: channelArr[1],
    branch: channelArr[2],
    format: format,
  };
}
 
/**
 * Create a tree from a list of channels
 * @param {[{track: string, risk: string, branch: string, format: {track: boolean, branch: boolean, format: boolean}}]} channelList
 * @returns {{
 *    track: {
 *      name: string,
 *      risks: {
 *        risk: {
 *          name: string,
 *          branches: {
 *            branch: {
 *              name: string
 *            }
 *          }
 *        }
 *      }
 *    }
 *  }}
 */
function createChannelTree(channelList) {
  const tracks = {};
 
  channelList.forEach((channel) => {
    if (!tracks[channel.track]) {
      tracks[channel.track] = {
        name: channel.track,
        risks: {},
      };
    }
 
    let level = tracks[channel.track];
 
    if (!level.risks[channel.risk]) {
      level.risks[channel.risk] = {
        name: channel.risk,
      };
    }
 
    level = level.risks[channel.risk];
 
    if (!level.branches) {
      level.branches = {};
    }
 
    level.branches[channel.branch] = {
      name: channel.branch,
    };
  });
 
  return tracks;
}
 
/**
 * Sort a list of strings
 * The output order will be:
 *  - hoistValue
 *  - strings
 *    - ascending
 *  - numbers
 *    - descending
 * @param {[string]} list
 * @param {string} hoistValue A value to always appear at the top
 * @returns {*[]}
 */
function sortAlphaNum(list, hoistValue) {
  let numbers = [];
  let strings = [];
  let hoistList = [];
  list.forEach((item) => {
    // numbers are defined by any string starting any of the following patterns:
    //   just a number – 1,2,3,4,
    //   numbers on the left in a pattern – 2018.3 , 1.1, 1.1.23 ...
    //   or numbers on the left with strings at the end – 1.1-hotfix
    if (hoistValue && item === hoistValue) {
      hoistList.push(item);
    } else if (isNaN(parseInt(item.substr(0, 1)))) {
      strings.push(item);
    } else {
      numbers.push(item);
    }
  });
 
  // Ignore case
  strings.sort(function (a, b) {
    return a.toLowerCase().localeCompare(b.toLowerCase());
  });
 
  strings = hoistList.concat(strings);
 
  // Sort numbers (that are actually strings)
  numbers.sort((a, b) => {
    return b.localeCompare(a, undefined, {
      numeric: true,
      sensitivity: "base",
    });
  });
 
  // Join the arrays together again
  return strings.concat(numbers);
}
 
/**
 * Sort channels into the following format:
 * defaultTrack/stable
 * defaultTrack/stable/branches
 * defaultTrack/candidate
 * defaultTrack/candidate/branches
 * defaultTrack/beta
 * defaultTrack/beta/branches
 * defaultTrack/edge
 * defaultTrack/edge/branches
 * track/stable
 * track/stable/branches
 * ...
 *
 * @param {{defaultTrack: string}} options
 * @returns {{tree: Array, list: Array}}
 */
function sortChannels(channels, options) {
  const channelList = channels.map((channel) => parseChannel(channel, options));
  const channelTree = createChannelTree(channelList);
 
  const sortedByTrack = [];
 
  let track = "latest";
  if (options && options.defaultTrack) {
    track = options.defaultTrack;
  }
 
  const trackOrder = sortAlphaNum(Object.keys(channelTree), track);
 
  trackOrder.forEach((track) => {
    sortedByTrack.push(channelTree[track]);
  });
 
  sortedByTrack.map((track) => {
    const riskOrder = Object.keys(track.risks).sort((a, b) => {
      return RISKS.indexOf(a) - RISKS.indexOf(b);
    });
 
    track.risks = riskOrder.map((risk) => track.risks[risk]);
 
    track.risks.map((risk) => {
      const branchOrder = sortAlphaNum(Object.keys(risk.branches), "_base");
 
      risk.branches = branchOrder.map((branch) => risk.branches[branch]);
 
      return risk;
    });
 
    return track;
  });
 
  const toArray = () => {
    const list = [];
    sortedByTrack.forEach((track) => {
      Eif (track.risks) {
        track.risks.forEach((risk) => {
          if (risk.branches.length > 1 || risk.branches[0].name !== "_base") {
            risk.branches.forEach((branch) => {
              const format = channelList.filter(
                (item) =>
                  item.track === track.name &&
                  item.risk === risk.name &&
                  item.branch === branch.name,
              )[0].format;
              const str = [];
              Eif (format.track) {
                str.push(track.name);
              }
              Eif (format.risk) {
                str.push(risk.name);
              }
              Eif (format.branch) {
                str.push(branch.name);
              }
              list.push(str.join("/"));
            });
          } else {
            const format = channelList.filter((item) => {
              return item.track === track.name && item.risk === risk.name;
            })[0].format;
            const str = [];
            if (format.track) {
              str.push(track.name);
            }
            Eif (format.risk) {
              str.push(risk.name);
            }
            list.push(str.join("/"));
          }
        });
      }
    });
 
    return list;
  };
 
  return {
    tree: sortedByTrack,
    list: toArray(),
  };
}
 
/**
 * Get a channel string based on an object containing track, risk and branch
 *
 * @param {track: string, risk: string, branch: string} channelObj
 * @returns string
 */
function getChannelString(channelObj) {
  return `${channelObj.track ? `${channelObj.track}/` : ""}${channelObj.risk}${
    channelObj.branch ? `/${channelObj.branch}` : ""
  }`;
}
 
export {
  sortChannels,
  parseChannel,
  createChannelTree,
  sortAlphaNum,
  getChannelString,
};