# All files / util input_validation.ts

89.53% Statements 77/86
85.94% Branches 55/64
95% Functions 19/20
89.41% Lines 76/85

    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

    2x
    2x

    2x

    2x

    2411x
    2x

    2x

    78x
    2x

    2x

    2004x
    2x

    2x

    753x

    2x

    3273x

    2x

    228x
    8x

    2x

    1410x

    2x

    2338x
    950x

    2x

    20x

    36x
    36x
    18x

    18x

    2x
    2x

    2x

    20x
    20x

    4683x
    14x
    14x

    2x
    7471x

    2x
    214x
    18x
    196x
    28x
    168x
    22x

    22x
    146x
    18x
    128x
    80x
    16x

    64x
    64x
    64x

    48x
    48x

    2x
    64x
    64x
    64x
    64x
    64x

    2x

    182x

    2x

    979x
    1436x
    8x

    2x

    3273x

    2265x

    217x

    791x

    10x

     /**
     * Copyright 2017 Google Inc.
     *
     * Licensed under the Apache License, Version 2.0 (the "License");
     * you may not use this file except in compliance with the License.
     * You may obtain a copy of the License at
     *
     *   http://www.apache.org/licenses/LICENSE-2.0
     *
     * Unless required by applicable law or agreed to in writing, software
     * distributed under the License is distributed on an "AS IS" BASIS,
     * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
     * See the License for the specific language governing permissions and
     * limitations under the License.
     */

    import { fail } from './assert';
    import { Code, FirestoreError } from './error';
    import { AnyJs } from './misc';
    import * as obj from './obj';

    /**
     * Validates the invocation of functionName has the exact number of arguments.
     *
     * Forward the magic "arguments" variable as second parameter on which the
     * parameter validation is performed:
     * validateExactNumberOfArgs('myFunction', arguments, 2);
     */
    export function validateExactNumberOfArgs(
      functionName: string,
      args: IArguments,
      numberOfArgs: number
    ): void {
      if (args.length !== numberOfArgs) {
        throw new FirestoreError(
          Code.INVALID_ARGUMENT,
          `Function ${functionName}() requires ` +
            formatPlural(numberOfArgs, 'argument') +
            ', but was called with ' +
            formatPlural(args.length, 'argument') +
            '.'
        );
      }
    }

    /**
     * Validates the invocation of functionName has at least the provided number of
     * arguments (but can have many more).
     *
     * Forward the magic "arguments" variable as second parameter on which the
     * parameter validation is performed:
     * validateAtLeastNumberOfArgs('myFunction', arguments, 2);
     */
    export function validateAtLeastNumberOfArgs(
      functionName: string,
      args: IArguments,
      minNumberOfArgs: number
    ): void {
      if (args.length < minNumberOfArgs) {
        throw new FirestoreError(
          Code.INVALID_ARGUMENT,
          `Function ${functionName}() requires at least ` +
            formatPlural(minNumberOfArgs, 'argument') +
            ', but was called with ' +
            formatPlural(args.length, 'argument') +
            '.'
        );
      }
    }

    /**
     * Validates the invocation of functionName has number of arguments between
     * the values provided.
     *
     * Forward the magic "arguments" variable as second parameter on which the
     * parameter validation is performed:
     * validateBetweenNumberOfArgs('myFunction', arguments, 2, 3);
     */
    export function validateBetweenNumberOfArgs(
      functionName: string,
      args: IArguments,
      minNumberOfArgs: number,
      maxNumberOfArgs: number
    ): void {
      if (args.length < minNumberOfArgs || args.length > maxNumberOfArgs) {
        throw new FirestoreError(
          Code.INVALID_ARGUMENT,
          `Function ${functionName}() requires between ${minNumberOfArgs} and ` +
            `${maxNumberOfArgs} arguments, but was called with ` +
            formatPlural(args.length, 'argument') +
            '.'
        );
      }
    }

    /**
     * Validates the provided argument is an array and has as least the expected
     * number of elements.
     */
    export function validateNamedArrayAtLeastNumberOfElements<T>(
      functionName: string,
      value: T[],
      name: string,
      minNumberOfElements: number
    ): void {
      Iif (!(value instanceof Array) || value.length < minNumberOfElements) {
        throw new FirestoreError(
          Code.INVALID_ARGUMENT,
          `Function ${functionName}() requires its ${name} argument to be an ` +
            'array with at least ' +
            `${formatPlural(minNumberOfElements, 'element')}.`
        );
      }
    }

    /**
     * Validates the provided positional argument has the native JavaScript type
     * using typeof checks.
     */
    export function validateArgType(
      functionName: string,
      type: string,
      position: number,
      argument: AnyJs
    ): void {
      validateType(functionName, type, `${ordinal(position)} argument`, argument);
    }

    /**
     * Validates the provided argument has the native JavaScript type using
     * typeof checks or is undefined.
     */
    export function validateOptionalArgType(
      functionName: string,
      type: string,
      position: number,
      argument: AnyJs
    ): void {
      if (argument !== undefined) {
        validateArgType(functionName, type, position, argument);
      }
    }

    /**
     * Validates the provided named option has the native JavaScript type using
     * typeof checks.
     */
    export function validateNamedType(
      functionName: string,
      type: string,
      optionName: string,
      argument: AnyJs
    ): void {
      validateType(functionName, type, `${optionName} option`, argument);
    }

    /**
     * Validates the provided named option has the native JavaScript type using
     * typeof checks or is undefined.
     */
    export function validateNamedOptionalType(
      functionName: string,
      type: string,
      optionName: string,
      argument: AnyJs
    ): void {
      if (argument !== undefined) {
        validateNamedType(functionName, type, optionName, argument);
      }
    }

    /**
     * Validates that the provided named option equals one of the expected values.
     */
    export function validateNamedPropertyEquals<T>(
      functionName: string,
      inputName: string,
      optionName: string,
      input: T,
      expected: T[]
    ): void {
      const expectedDescription: string[] = [];

      for (const val of expected) {
        if (val === input) {
          return;
        }
        expectedDescription.push(valueDescription(val));
      }

      const actualDescription = valueDescription(input);
      throw new FirestoreError(
        Code.INVALID_ARGUMENT,
        `Invalid value ${actualDescription} provided to function ${functionName}() for option "${optionName}". Acceptable values: ${expectedDescription.join(
          ', '
        )}`
      );
    }

    /**
     * Validates that the provided named option equals one of the expected values or
     * is undefined.
     */
    export function validateNamedOptionalPropertyEquals<T>(
      functionName: string,
      inputName: string,
      optionName: string,
      input: T,
      expected: T[]
    ): void {
      Eif (input !== undefined) {
        validateNamedPropertyEquals(
          functionName,
          inputName,
          optionName,
          input,
          expected
        );
      }
    }

    /** Helper to validate the type of a provided input. */
    function validateType(
      functionName: string,
      type: string,
      inputName: string,
      input: AnyJs
    ): void {
      if (typeof input !== type || (type === 'object' && !isPlainObject(input))) {
        const description = valueDescription(input);
        throw new FirestoreError(
          Code.INVALID_ARGUMENT,
          `Function ${functionName}() requires its ${inputName} ` +
            `to be of type ${type}, but it was: ${description}`
        );
      }
    }

    /**
     * Returns true iff it's a non-null object without a custom prototype
     * (i.e. excludes Array, Date, etc.).
     */
    export function isPlainObject(input: AnyJs) {
      return (
        typeof input === 'object' &&
        input !== null &&
        Object.getPrototypeOf(input) === Object.prototype
      );
    }

    /** Returns a string describing the type / value of the provided input. */
    export function valueDescription(input: AnyJs) {
      if (input === undefined) {
        return 'undefined';
      } else if (input === null) {
        return 'null';
      } else if (typeof input === 'string') {
        Iif (input.length > 20) {
          input = `${input.substring(0, 20)}...`;
        }
        return JSON.stringify(input);
      } else if (typeof input === 'number' || typeof input === 'boolean') {
        return '' + input;
      } else if (typeof input === 'object') {
        if (input instanceof Array) {
          return 'an array';
        } else {
          const customObjectName = tryGetCustomObjectType(input);
          Eif (customObjectName) {
            return `a custom ${customObjectName} object`;
          } else {
            return 'an object';
          }
        }
      } else Eif (typeof input === 'function') {
        return 'a function';
      } else {
        return fail('Unknown wrong type: ' + typeof input);
      }
    }

    /** Hacky method to try to get the constructor name for an object. */
    export function tryGetCustomObjectType(input: object): string | null {
      Eif (input.constructor) {
        const funcNameRegex = /function\s+([^\s(]+)\s*\(/;
        const results = funcNameRegex.exec(input.constructor.toString());
        Eif (results && results.length > 1) {
          return results[1];
        }
      }
      return null;
    }

    /** Validates the provided argument is defined. */
    export function validateDefined(
      functionName: string,
      position: number,
      argument: AnyJs
    ): void {
      Iif (argument === undefined) {
        throw new FirestoreError(
          Code.INVALID_ARGUMENT,
          `Function ${functionName}() requires a valid ${ordinal(position)} ` +
            `argument, but it was undefined.`
        );
      }
    }

    /**
     * Validates the provided positional argument is an object, and its keys and
     * values match the expected keys and types provided in optionTypes.
     */
    export function validateOptionNames(
      functionName: string,
      options: object,
      optionNames: string[]
    ) {
      obj.forEach(options as obj.Dict<AnyJs>, (key, _) => {
        if (optionNames.indexOf(key) < 0) {
          throw new FirestoreError(
            Code.INVALID_ARGUMENT,
            `Unknown option '${key}' passed to function ${functionName}(). ` +
              'Available options: ' +
              optionNames.join(', ')
          );
        }
      });
    }

    /**
     * Helper method to throw an error that the provided argument did not pass
     * an instanceof check.
     */
    export function invalidClassError(
      functionName: string,
      type: string,
      position: number,
      argument: AnyJs
    ): Error {
      const description = valueDescription(argument);
      return new FirestoreError(
        Code.INVALID_ARGUMENT,
        `Function ${functionName}() requires its ${ordinal(position)} ` +
          `argument to be a ${type}, but it was: ${description}`
      );
    }

    /** Converts a number to its english word representation */
    function ordinal(num: number) {
      switch (num) {
        case 1:
          return 'first';
        case 2:
          return 'second';
        case 3:
          return 'third';
        default:
          return num + 'th';
      }
    }

    /**
     * Formats the given word as plural conditionally given the preceding number.
     */
    function formatPlural(num: number, str: string) {
      return `${num} ${str}` + (num === 1 ? '' : 's');
    }