all files / firebase/utils/ index.js

73.15% Statements 79/108
65.08% Branches 41/63
85.71% Functions 18/21
74.49% Lines 73/98
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 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427                                                18×   18× 18× 18×   18× 18× 18× 18×     18×                                                               48×     48× 48× 48× 40× 142×     34×                               48×     164×                 2256×                     1463×                 297×                     717× 717×                       717× 717×                                                                                                                                                     2982× 2736× 2726×                                                                                                       28× 28× 28×   28×   28× 224× 224×     28×     28×   28× 28× 336×                         28× 336×     28×   28×                                                                                                     838×                                                 48×   48× 960×       48×    
// @flow
import { Platform } from 'react-native';
 
// todo cleanup unused utilities from legacy code
 
// modeled after base64 web-safe chars, but ordered by ASCII
const PUSH_CHARS =
  '-0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ_abcdefghijklmnopqrstuvwxyz';
const AUTO_ID_CHARS =
  'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
const { hasOwnProperty } = Object;
 
// const DEFAULT_CHUNK_SIZE = 50;
 
/**
 * Deep get a value from an object.
 * @website https://github.com/Salakar/deeps
 * @param object
 * @param path
 * @param joiner
 * @returns {*}
 */
export function deepGet(
  object: Object,
  path: string,
  joiner?: string = '/'
): any {
  const keys = path.split(joiner);
 
  let i = 0;
  let tmp = object;
  const len = keys.length;
 
  while (i < len) {
    const key = keys[i++];
    Iif (!tmp || !hasOwnProperty.call(tmp, key)) return null;
    tmp = tmp[key];
  }
 
  return tmp;
}
 
/**
 * Deep check if a key exists.
 * @website https://github.com/Salakar/deeps
 * @param object
 * @param path
 * @param joiner
 * @returns {*}
 */
export function deepExists(
  object: Object,
  path: string,
  joiner?: string = '/'
): boolean {
  const keys = path.split(joiner);
 
  let i = 0;
  let tmp = object;
  const len = keys.length;
 
  while (i < len) {
    const key = keys[i++];
    if (!tmp || !hasOwnProperty.call(tmp, key)) return false;
    tmp = tmp[key];
  }
 
  return tmp !== undefined;
}
 
/**
 * Deep Check if obj1 keys are contained in obj2
 * @param obj1
 * @param obj2
 * @returns {boolean}
 */
export function areObjectKeysContainedInOther(
  obj1: Object,
  obj2: Object
): boolean {
  Iif (!isObject(obj1) || !isObject(obj2)) {
    return false;
  }
  const keys1 = Object.keys(obj1);
  const keys2 = Object.keys(obj2);
  if (isArrayContainedInOther(keys1, keys2)) {
    return keys1
      .filter(key => isObject(obj1[key]))
      .reduce(
        (acc, cur) =>
          acc && areObjectKeysContainedInOther(obj1[cur], obj2[cur]),
        true
      );
  }
  return false;
}
 
/**
 * Check if arr1 is contained in arr2
 * @param arr1
 * @param arr2
 * @returns {boolean}
 */
export function isArrayContainedInOther(
  arr1: Array<*>,
  arr2: Array<*>
): boolean {
  Iif (!Array.isArray(arr1) || !Array.isArray(arr2)) {
    return false;
  }
  return arr1.reduce((acc, cur) => acc && arr2.includes(cur), true);
}
 
/**
 * Simple is object check.
 * @param item
 * @returns {boolean}
 */
export function isObject(item: mixed): boolean %checks {
  return item
    ? typeof item === 'object' && !Array.isArray(item) && item !== null
    : false;
}
 
/**
 * Simple is function check
 * @param item
 * @returns {*|boolean}
 */
export function isFunction(item?: mixed): boolean %checks {
  return item ? typeof item === 'function' : false;
}
 
/**
 * Simple is string check
 * @param value
 * @return {boolean}
 */
export function isString(value: mixed): boolean %checks {
  return typeof value === 'string';
}
 
// platform checks
export const isIOS = Platform.OS === 'ios';
export const isAndroid = Platform.OS === 'android';
 
/**
 *
 * @param string
 * @returns {*}
 */
export function tryJSONParse(string: string | null): any {
  try {
    return string && JSON.parse(string);
  } catch (jsonError) {
    return string;
  }
}
 
/**
 *
 * @param data
 * @returns {*}
 */
export function tryJSONStringify(data: mixed): string | null {
  try {
    return JSON.stringify(data);
  } catch (jsonError) {
    return null;
  }
}
 
/**
 * No operation func
 */
export function noop(): void {}
 
// /**
//  * Delays chunks based on sizes per event loop.
//  * @param collection
//  * @param chunkSize
//  * @param operation
//  * @param callback
//  * @private
//  */
// function _delayChunk(collection: Array<*>,
//                      chunkSize: number,
//                      operation: Function,
//                      callback: Function): void {
//   const length = collection.length;
//   const iterations = Math.ceil(length / chunkSize);
//
//   // noinspection ES6ConvertVarToLetConst
//   let thisIteration = 0;
//
//   setImmediate(function next() {
//     const start = thisIteration * chunkSize;
//     const _end = start + chunkSize;
//     const end = _end >= length ? length : _end;
//     const result = operation(collection.slice(start, end), start, end);
//
//     if (thisIteration++ > iterations) {
//       callback(null, result);
//     } else {
//       setImmediate(next);
//     }
//   });
// }
//
// /**
//  * Async each with optional chunk size limit
//  * @param array
//  * @param chunkSize
//  * @param iterator
//  * @param cb
//  */
// export function each(array: Array<*>,
//                      chunkSize: number | Function,
//                      iterator: Function,
//                      cb?: Function): void {
//   if (typeof chunkSize === 'function') {
//     cb = iterator;
//     iterator = chunkSize;
//     chunkSize = DEFAULT_CHUNK_SIZE;
//   }
//
//   if (cb) {
//     _delayChunk(array, chunkSize, (slice, start) => {
//       for (let ii = 0, jj = slice.length; ii < jj; ii += 1) {
//         iterator(slice[ii], start + ii);
//       }
//     }, cb);
//   }
// }
 
/**
 * Returns a string typeof that's valid for Firebase usage
 * @param value
 * @return {*}
 */
export function typeOf(value: any): string {
  if (value === null) return 'null';
  if (Array.isArray(value)) return 'array';
  return typeof value;
}
 
// /**
//  * Async map with optional chunk size limit
//  * @param array
//  * @param chunkSize
//  * @param iterator
//  * @param cb
//  * @returns {*}
//  */
// export function map(array: Array<*>,
//                     chunkSize: number | Function,
//                     iterator: Function,
//                     cb?: Function): void {
//   if (typeof chunkSize === 'function') {
//     cb = iterator;
//     iterator = chunkSize;
//     chunkSize = DEFAULT_CHUNK_SIZE;
//   }
//
//   const result = [];
//   _delayChunk(array, chunkSize, (slice, start) => {
//     for (let ii = 0, jj = slice.length; ii < jj; ii += 1) {
//       result.push(iterator(slice[ii], start + ii, array));
//     }
//     return result;
//   }, () => cb && cb(result));
// }
 
// /**
//  *
//  * @param string
//  * @return {string}
//  */
// export function capitalizeFirstLetter(string: string) {
//   return `${string.charAt(0).toUpperCase()}${string.slice(1)}`;
// }
 
// timestamp of last push, used to prevent local collisions if you push twice in one ms.
let lastPushTime = 0;
 
// we generate 72-bits of randomness which get turned into 12 characters and appended to the
// timestamp to prevent collisions with other clients.  We store the last characters we
// generated because in the event of a collision, we'll use those same characters except
// "incremented" by one.
const lastRandChars = [];
 
/**
 * Generate a firebase id - for use with ref().push(val, cb) - e.g. -KXMr7k2tXUFQqiaZRY4'
 * @param serverTimeOffset - pass in server time offset from native side
 * @returns {string}
 */
export function generatePushID(serverTimeOffset?: number = 0): string {
  const timeStampChars = new Array(8);
  let now = new Date().getTime() + serverTimeOffset;
  const duplicateTime = now === lastPushTime;
 
  lastPushTime = now;
 
  for (let i = 7; i >= 0; i -= 1) {
    timeStampChars[i] = PUSH_CHARS.charAt(now % 64);
    now = Math.floor(now / 64);
  }
 
  Iif (now !== 0)
    throw new Error('We should have converted the entire timestamp.');
 
  let id = timeStampChars.join('');
 
  Eif (!duplicateTime) {
    for (let i = 0; i < 12; i += 1) {
      lastRandChars[i] = Math.floor(Math.random() * 64);
    }
  } else {
    // if the timestamp hasn't changed since last push,
    // use the same random number, but increment it by 1.
    let i;
    for (i = 11; i >= 0 && lastRandChars[i] === 63; i -= 1) {
      lastRandChars[i] = 0;
    }
 
    lastRandChars[i] += 1;
  }
 
  for (let i = 0; i < 12; i++) {
    id += PUSH_CHARS.charAt(lastRandChars[i]);
  }
 
  Iif (id.length !== 20) throw new Error('Length should be 20.');
 
  return id;
}
 
/**
 * Converts a code and message from a native event to a JS Error
 * @param code
 * @param message
 * @param additionalProps
 * @returns {Error}
 */
export function nativeToJSError(
  code: string,
  message: string,
  additionalProps?: Object = {}
) {
  const error: Object = new Error(message);
  error.code = code;
  Object.assign(error, additionalProps);
  // exclude this function from the stack
  const _stackArray = error.stack.split('\n');
  error.stack = _stackArray.splice(1, _stackArray.length).join('\n');
  return error;
}
 
/**
 *
 * @param object
 * @return {string}
 */
export function objectToUniqueId(object: Object): string {
  Eif (!isObject(object) || object === null) return JSON.stringify(object);
 
  const keys = Object.keys(object).sort();
 
  let key = '{';
  for (let i = 0; i < keys.length; i++) {
    if (i !== 0) key += ',';
    key += JSON.stringify(keys[i]);
    key += ':';
    key += objectToUniqueId(object[keys[i]]);
  }
 
  key += '}';
  return key;
}
 
/**
 * Return the existing promise if no callback provided or
 * exec the promise and callback if optionalCallback is valid.
 *
 * @param promise
 * @param optionalCallback
 * @return {Promise}
 */
export function promiseOrCallback(
  promise: Promise<*>,
  optionalCallback?: Function
): Promise<*> {
  Eif (!isFunction(optionalCallback)) return promise;
 
  return promise
    .then(result => {
      // some of firebase internal tests & methods only check/return one arg
      // see https://github.com/firebase/firebase-js-sdk/blob/master/src/utils/promise.ts#L62
      if (optionalCallback && optionalCallback.length === 1) {
        optionalCallback(null);
      } else if (optionalCallback) {
        optionalCallback(null, result);
      }
 
      return Promise.resolve(result);
    })
    .catch(error => {
      if (optionalCallback) optionalCallback(error);
      return Promise.reject(error);
    });
}
 
/**
 * Generate a firestore auto id for use with collection/document .add()
 * @return {string}
 */
export function firestoreAutoId(): string {
  let autoId = '';
 
  for (let i = 0; i < 20; i++) {
    autoId += AUTO_ID_CHARS.charAt(
      Math.floor(Math.random() * AUTO_ID_CHARS.length)
    );
  }
  return autoId;
}