feat: Enable tracing via OpenTelemetry

dev/conformance/runner.ts

@@ -12,8 +12,6 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-import {DocumentData} from '@google-cloud/firestore';
-
 import * as duplexify from 'duplexify';
 
 import {it, xit, describe} from 'mocha';
@@ -47,6 +45,7 @@
 } from '../test/util/helpers';
 
 import api = proto.google.firestore.v1;
+import {FirebaseFirestore} from '../../types/firestore';
 
 // TODO(mrschmidt): Create Protobuf .d.ts file for the conformance proto
 // eslint-disable-next-line @typescript-eslint/no-explicit-any
@@ -183,7 +182,7 @@
  args.push(
  DocumentSnapshot.fromObject(
  docRef(cursor.docSnapshot.path),
- convertInput.argument(cursor.docSnapshot.jsonData) as DocumentData
+ convertInput.argument(cursor.docSnapshot.jsonData) as FirebaseFirestore.DocumentData
  )
  );
  } else {
@@ -406,7 +405,7 @@
  }
  }
  return docRef(setSpec.docRefPath).set(
- convertInput.argument(spec.jsonData) as DocumentData,
+ convertInput.argument(spec.jsonData) as FirebaseFirestore.DocumentData,
  setOption
  );
  });
@@ -416,7 +415,7 @@
  const overrides = {commit: commitHandler(spec)};
  return createInstance(overrides).then(() => {
  return docRef(spec.docRefPath).create(
- convertInput.argument(spec.jsonData) as DocumentData
+ convertInput.argument(spec.jsonData) as FirebaseFirestore.DocumentData
  );
  });
  };

dev/src/aggregate.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 import {FieldPath} from './path';
 import {google} from '../protos/firestore_v1_proto_api';

dev/src/bulk-writer.ts

@@ -13,7 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import * as firestore from '@google-cloud/firestore';
+
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 import * as assert from 'assert';
 import type {GoogleError} from 'google-gax';
@@ -47,7 +49,7 @@ import {logger} from './logger';
 import {StatusCode} from './status-code';
 
 // eslint-disable-next-line no-undef
-import GrpcStatus = FirebaseFirestore.GrpcStatus;
+import GrpcStatus = firestore.GrpcStatus;
 import api = google.firestore.v1;
 import {
  ATTRIBUTE_KEY_DOC_COUNT,

dev/src/collection-group.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import * as protos from '../protos/firestore_v1_proto_api';
 
 import {QueryPartition} from './query-partition';

dev/src/document-change.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 import {QueryDocumentSnapshot} from './document';
 

dev/src/document-reader.ts

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {DocumentSnapshot, DocumentSnapshotBuilder} from './document';
 import {DocumentReference} from './reference/document-reference';
 import {FieldPath} from './path';
@@ -22,10 +25,12 @@ import {google} from '../protos/firestore_v1_proto_api';
 import {logger} from './logger';
 import {Firestore} from './index';
 import {Timestamp} from './timestamp';
-import {DocumentData} from '@google-cloud/firestore';
 import api = google.firestore.v1;
 
-interface BatchGetResponse<AppModelType, DbModelType extends DocumentData> {
+interface BatchGetResponse<
+ AppModelType,
+ DbModelType extends firestore.DocumentData,
+> {
  result: Array<DocumentSnapshot<AppModelType, DbModelType>>;
  /**
  * The transaction that was started as part of this request. Will only be if
@@ -41,7 +46,10 @@ interface BatchGetResponse<AppModelType, DbModelType extends DocumentData> {
  * @private
  * @internal
  */
-export class DocumentReader<AppModelType, DbModelType extends DocumentData> {
+export class DocumentReader<
+ AppModelType,
+ DbModelType extends firestore.DocumentData,
+> {
  private readonly outstandingDocuments = new Set<string>();
  private readonly retrievedDocuments = new Map<string, DocumentSnapshot>();
  private retrievedTransactionId?: Uint8Array;
@@ -166,7 +174,7 @@ export class DocumentReader<AppModelType, DbModelType extends DocumentData> {
  this.retrievedTransactionId = response.transaction;
  }
 
- let snapshot: DocumentSnapshot<DocumentData> | undefined;
+ let snapshot: DocumentSnapshot<firestore.DocumentData> | undefined;
  if (response.found) {
  logger(
  'DocumentReader.fetchDocuments',

dev/src/document.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 import * as deepEqual from 'fast-deep-equal';
 

dev/src/field-value.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 import * as deepEqual from 'fast-deep-equal';
 

dev/src/filter.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 /**
  * A `Filter` represents a restriction on one or more field values and can

dev/src/geo-point.ts

@@ -14,14 +14,15 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
-
 import {google} from '../protos/firestore_v1_proto_api';
 import {Serializable} from './serializer';
 import {validateNumber} from './validate';
 
 import api = google.firestore.v1;
 
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 /**
  * An immutable object representing a geographic location in Firestore. The
  * location is represented as a latitude/longitude pair.

dev/src/index.ts

@@ -14,8 +14,8 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
-
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 import type {CallOptions, ClientOptions} from 'google-gax';
 import type * as googleGax from 'google-gax';
 import type * as googleGaxFallback from 'google-gax/build/src/fallback';
@@ -792,8 +792,7 @@ export class Firestore implements firestore.Firestore {
  }
 
  private newTraceUtilInstance(settings: firestore.Settings): TraceUtil {
- // Take the tracing option from the settings.
- let createEnabledInstance = settings.openTelemetryOptions?.enableTracing;
+ let createEnabledInstance = true;
 
  // The environment variable can override options to enable/disable telemetry collection.
  if ('FIRESTORE_ENABLE_TRACING' in process.env) {

dev/src/path.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 import {google} from '../protos/firestore_v1_proto_api';
 

dev/src/query-partition.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import * as protos from '../protos/firestore_v1_proto_api';
 
 import {FieldOrder} from './reference/field-order';

dev/src/query-profile.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {google} from '../protos/firestore_v1_proto_api';
 import {Serializer} from './serializer';
 import IPlanSummary = google.firestore.v1.IPlanSummary;

dev/src/recursive-delete.ts

@@ -13,7 +13,9 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-import * as firestore from '@google-cloud/firestore';
+
+import * as types from '../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 import * as assert from 'assert';
 

dev/src/reference/aggregate-query-snapshot.ts

@@ -16,7 +16,8 @@
 
 import * as deepEqual from 'fast-deep-equal';
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
 import {Timestamp} from '../timestamp';
 import {AggregateQuery} from './aggregate-query';
 

dev/src/reference/aggregate-query.ts

@@ -17,10 +17,12 @@
 import * as protos from '../../protos/firestore_v1_proto_api';
 import api = protos.google.firestore.v1;
 
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import * as assert from 'assert';
 import * as deepEqual from 'fast-deep-equal';
 
-import * as firestore from '@google-cloud/firestore';
 import {Aggregate, AggregateSpec} from '../aggregate';
 import {Timestamp} from '../timestamp';
 import {mapToArray, requestTag, wrapError} from '../util';

dev/src/reference/collection-reference.ts

@@ -17,7 +17,9 @@
 import * as protos from '../../protos/firestore_v1_proto_api';
 import api = protos.google.firestore.v1;
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {
  QualifiedResourcePath,
  ResourcePath,

dev/src/reference/document-reference.ts

@@ -17,7 +17,9 @@
 import * as protos from '../../protos/firestore_v1_proto_api';
 import api = protos.google.firestore.v1;
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import Firestore, {DocumentSnapshot, WriteBatch, WriteResult} from '../index';
 import {ResourcePath, validateResourcePath} from '../path';
 import {defaultConverter} from '../types';

dev/src/reference/helpers.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {invalidArgumentMessage, validateEnumValue} from '../validate';
 import {validateUserInput} from '../serializer';
 import {DocumentReference} from './document-reference';

dev/src/reference/query-options.ts

@@ -18,7 +18,9 @@ import * as protos from '../../protos/firestore_v1_proto_api';
 import api = protos.google.firestore.v1;
 import * as deepEqual from 'fast-deep-equal';
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {ResourcePath} from '../path';
 import {defaultConverter} from '../types';
 import {FilterInternal} from './filter-internal';

dev/src/reference/query-snapshot.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {QueryDocumentSnapshot} from '../document';
 import {DocumentChange} from '../document-change';
 import {Timestamp} from '../timestamp';

dev/src/reference/query-util.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {GoogleError} from 'google-gax';
 import {Duplex, Transform} from 'stream';
 

dev/src/reference/query.ts

@@ -16,7 +16,10 @@
 
 import * as protos from '../../protos/firestore_v1_proto_api';
 import api = protos.google.firestore.v1;
-import * as firestore from '@google-cloud/firestore';
+
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {GoogleError} from 'google-gax';
 import {Transform} from 'stream';
 

dev/src/reference/types.ts

@@ -17,12 +17,13 @@
 import * as protos from '../../protos/firestore_v1_proto_api';
 import api = protos.google.firestore.v1;
 
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {Timestamp} from '../timestamp';
 import {ExplainMetrics} from '../query-profile';
 import {QueryDocumentSnapshot} from '../document';
 
-import * as firestore from '@google-cloud/firestore';
-
 export interface QueryStreamElement<
  AppModelType = firestore.DocumentData,
  DbModelType extends firestore.DocumentData = firestore.DocumentData,

dev/src/reference/vector-query-options.ts

@@ -14,7 +14,8 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
 
 /**
  * Specifies the behavior of the {@link VectorQuery} generated by a call to {@link Query.findNearest}.

dev/src/reference/vector-query-snapshot.ts

@@ -14,7 +14,9 @@
  * limitations under the License.
  */
 
-import * as firestore from '@google-cloud/firestore';
+import * as types from '../../../types/firestore';
+import firestore = types.FirebaseFirestore;
+
 import {QueryDocumentSnapshot} from '../document';
 import {DocumentChange} from '../document-change';
 import {Timestamp} from '../timestamp';