/*!

* Copyright 2020 Google LLC

*

* 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 * as firestore from '@google-cloud/firestore';

import * as assert from 'assert';

import type {GoogleError} from 'google-gax';

import {google} from '../protos/firestore_v1_proto_api';

import {FieldPath, Firestore} from '.';

import {

DEFAULT_BACKOFF_FACTOR,

DEFAULT_BACKOFF_INITIAL_DELAY_MS,

DEFAULT_BACKOFF_MAX_DELAY_MS,

delayExecution,

MAX_RETRY_ATTEMPTS,

} from './backoff';

import {RateLimiter} from './rate-limiter';

import {Timestamp} from './timestamp';

import {

Deferred,

getRetryCodes,

isObject,

requestTag,

silencePromise,

wrapError,

} from './util';

import {WriteBatch, WriteResult} from './write-batch';

import {

invalidArgumentMessage,

validateInteger,

validateOptional,

} from './validate';

import {logger} from './logger';

import {StatusCode} from './status-code';

// eslint-disable-next-line no-undef

import GrpcStatus = FirebaseFirestore.GrpcStatus;

import api = google.firestore.v1;

/*!

* The maximum number of writes that can be in a single batch.

*/

const MAX_BATCH_SIZE = 20;

/*!

* The maximum number of writes can be can in a single batch that is being retried.

*/

export const RETRY_MAX_BATCH_SIZE = 10;

/*!

* The starting maximum number of operations per second as allowed by the

* 500/50/5 rule.

*

* https://firebase.google.com/docs/firestore/best-practices#ramping_up_traffic.

*/

export const DEFAULT_INITIAL_OPS_PER_SECOND_LIMIT = 500;

/*!

* The maximum number of operations per second as allowed by the 500/50/5 rule.

* By default the rate limiter will not exceed this value.

*

* https://firebase.google.com/docs/firestore/best-practices#ramping_up_traffic.

*/

export const DEFAULT_MAXIMUM_OPS_PER_SECOND_LIMIT = 10000;

/*!

* The default jitter to apply to the exponential backoff used in retries. For

* example, a factor of 0.3 means a 30% jitter is applied.

*/

export const DEFAULT_JITTER_FACTOR = 0.3;

/*!

* The rate by which to increase the capacity as specified by the 500/50/5 rule.

*/

const RATE_LIMITER_MULTIPLIER = 1.5;

/*!

* How often the operations per second capacity should increase in milliseconds

* as specified by the 500/50/5 rule.

*/

const RATE_LIMITER_MULTIPLIER_MILLIS = 5 * 60 * 1000;

/*!

* The default maximum number of pending operations that can be enqueued onto a

* BulkWriter instance. An operation is considered pending if BulkWriter has

* sent it via RPC and is awaiting the result. BulkWriter buffers additional

* writes after this many pending operations in order to avoiding going OOM.

*/

const DEFAULT_MAXIMUM_PENDING_OPERATIONS_COUNT = 500;

/**

* Represents a single write for BulkWriter, encapsulating operation dispatch

* and error handling.

* @private

* @internal

*/

class BulkWriterOperation {

}

/**

* Used to represent a batch on the BatchQueue.

*

* @private

* @internal

*/

class BulkCommitBatch extends WriteBatch {

}

/**

* Used to represent a buffered BulkWriterOperation.

*

* @private

* @internal

*/

class BufferedOperation {

}

/**

* The error thrown when a BulkWriter operation fails.

*

* @class BulkWriterError

*/

export class BulkWriterError extends Error {

}

/**

* A Firestore BulkWriter that can be used to perform a large number of writes

* in parallel.

*

* @class BulkWriter

*/

export class BulkWriter {