firestore-integration.yaml

# Copyright 2026 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.
description: Integrate Google Cloud Firestore Handwritten code
# TODO(Fill in issue number below to add more context)
url: https://github.com/googleapis/gapic-generator-python/issues/123
replacements:
  - paths: [
      "packages/google-cloud-firestore/google/cloud/firestore_bundle/types/bundle.py",
    ]
    before: |
      import google.firestore.v1.document_pb2 as document_pb2  # type: ignore
      import google.firestore.v1.query_pb2 as query_pb2  # type: ignore
      import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
      import proto  # type: ignore
    after: |
      import google.protobuf.timestamp_pb2 as timestamp_pb2  # type: ignore
      import proto  # type: ignore

      from google.cloud.firestore_v1.types import document as document_pb2  # type: ignore
      from google.cloud.firestore_v1.types import query as query_pb2  # type: ignore
    count: 1
  - paths: [
      "packages/google-cloud-firestore/google/cloud/firestore_v1/__init__.py",
    ]
    before: |
      import sys\n
      import google.api_core as api_core\n
      from google.cloud.firestore_v1 import gapic_version as package_version
      [\s\S]*?"WriteResult",\n\)
    after: |
      """Python idiomatic client for Google Cloud Firestore."""\n
      from google.cloud.firestore_v1 import gapic_version as package_version

      __version__: str = package_version.__version__

      from typing import List

      from google.cloud.firestore_v1 import types
      from google.cloud.firestore_v1._helpers import (
          ExistsOption,
          GeoPoint,
          LastUpdateOption,
          ReadAfterWriteError,
          WriteOption,
      )
      from google.cloud.firestore_v1.async_batch import AsyncWriteBatch
      from google.cloud.firestore_v1.async_client import AsyncClient
      from google.cloud.firestore_v1.async_collection import AsyncCollectionReference
      from google.cloud.firestore_v1.async_document import AsyncDocumentReference
      from google.cloud.firestore_v1.async_pipeline import AsyncPipeline
      from google.cloud.firestore_v1.async_query import AsyncQuery
      from google.cloud.firestore_v1.async_transaction import (
          AsyncTransaction,
          async_transactional,
      )
      from google.cloud.firestore_v1.base_aggregation import CountAggregation
      from google.cloud.firestore_v1.base_document import DocumentSnapshot
      from google.cloud.firestore_v1.base_pipeline import SubPipeline
      from google.cloud.firestore_v1.base_query import And, FieldFilter, Or
      from google.cloud.firestore_v1.batch import WriteBatch
      from google.cloud.firestore_v1.client import Client
      from google.cloud.firestore_v1.collection import CollectionReference
      from google.cloud.firestore_v1.document import DocumentReference
      from google.cloud.firestore_v1.pipeline import Pipeline
      from google.cloud.firestore_v1.pipeline_result import (
          AsyncPipelineStream,
          PipelineResult,
          PipelineSnapshot,
          PipelineStream,
      )
      from google.cloud.firestore_v1.pipeline_source import PipelineSource
      from google.cloud.firestore_v1.pipeline_types import (
          FindNearestOptions,
          Ordering,
          PipelineDataType,
          SampleOptions,
          SearchOptions,
          TimeGranularity,
          TimePart,
          TimeUnit,
          UnnestOptions,
      )
      from google.cloud.firestore_v1.query import CollectionGroup, Query
      from google.cloud.firestore_v1.query_profile import (
          ExplainOptions,
          PipelineExplainOptions,
      )
      from google.cloud.firestore_v1.transaction import Transaction, transactional
      from google.cloud.firestore_v1.transforms import (
          DELETE_FIELD,
          SERVER_TIMESTAMP,
          ArrayRemove,
          ArrayUnion,
          Increment,
          Maximum,
          Minimum,
      )
      from google.cloud.firestore_v1.watch import Watch

      # TODO(https://github.com/googleapis/python-firestore/issues/93): this is all on the generated surface. We require this to match
      # firestore.py. So comment out until needed on customer level for certain.
      # from .services.firestore import FirestoreClient
      # from .types.common import DocumentMask
      # from .types.common import Precondition
      # from .types.common import TransactionOptions
      # from .types.document import ArrayValue
      # from .types.document import Document
      # from .types.document import MapValue
      # from .types.document import Value
      # from .types.firestore import BatchGetDocumentsRequest
      # from .types.firestore import BatchGetDocumentsResponse
      # from .types.firestore import BatchWriteRequest
      # from .types.firestore import BatchWriteResponse
      # from .types.firestore import BeginTransactionRequest
      # from .types.firestore import BeginTransactionResponse
      # from .types.firestore import CommitRequest
      # from .types.firestore import CommitResponse
      # from .types.firestore import CreateDocumentRequest
      # from .types.firestore import DeleteDocumentRequest
      # from .types.firestore import GetDocumentRequest
      # from .types.firestore import ListCollectionIdsRequest
      # from .types.firestore import ListCollectionIdsResponse
      # from .types.firestore import ListDocumentsRequest
      # from .types.firestore import ListDocumentsResponse
      # from .types.firestore import ListenRequest
      # from .types.firestore import ListenResponse
      # from .types.firestore import PartitionQueryRequest
      # from .types.firestore import PartitionQueryResponse
      # from .types.firestore import RollbackRequest
      # from .types.firestore import RunQueryRequest
      # from .types.firestore import RunQueryResponse
      # from .types.firestore import Target
      # from .types.firestore import TargetChange
      # from .types.firestore import UpdateDocumentRequest
      # from .types.firestore import WriteRequest
      # from .types.firestore import WriteResponse
      # from .types.query import Cursor
      # from .types.query import StructuredQuery
      # from .types.write import DocumentChange
      # from .types.write import DocumentDelete
      # from .types.write import DocumentRemove
      from .types.write import DocumentTransform

      # from .types.write import ExistenceFilter
      # from .types.write import Write
      # from .types.write import WriteResult

      __all__: List[str] = [
          "__version__",
          "And",
          "ArrayRemove",
          "ArrayUnion",
          "AsyncClient",
          "AsyncCollectionReference",
          "AsyncDocumentReference",
          "AsyncPipeline",
          "AsyncPipelineStream",
          "AsyncQuery",
          "async_transactional",
          "AsyncTransaction",
          "AsyncWriteBatch",
          "Client",
          "CountAggregation",
          "CollectionGroup",
          "CollectionReference",
          "DELETE_FIELD",
          "DocumentReference",
          "DocumentSnapshot",
          "DocumentTransform",
          "ExistsOption",
          "ExplainOptions",
          "FieldFilter",
          "FindNearestOptions",
          "GeoPoint",
          "Increment",
          "LastUpdateOption",
          "Maximum",
          "Minimum",
          "Or",
          "Ordering",
          "Pipeline",
          "PipelineDataType",
          "PipelineExplainOptions",
          "PipelineResult",
          "PipelineSnapshot",
          "PipelineSource",
          "PipelineStream",
          "Query",
          "ReadAfterWriteError",
          "SERVER_TIMESTAMP",
          "SampleOptions",
          "SearchOptions",
          "SubPipeline",
          "TimeGranularity",
          "TimePart",
          "TimeUnit",
          "Transaction",
          "transactional",
          "types",
          "UnnestOptions",
          "Watch",
          "WriteBatch",
          "WriteOption",
      ]
    count: 1
  - paths: [
      "packages/google-cloud-firestore/google/cloud/firestore/__init__.py",
    ]
    before: |
      from google.cloud.firestore import gapic_version as package_version
      [\s\S]*?"WriteResult",\n\)
    after: |
      """Python idiomatic client for Google Cloud Firestore."""\n
      from google.cloud.firestore_v1 import gapic_version as package_version

      __version__ = package_version.__version__

      from typing import List

      from google.cloud.firestore_v1 import (
          DELETE_FIELD,
          SERVER_TIMESTAMP,
          And,
          ArrayRemove,
          ArrayUnion,
          AsyncClient,
          AsyncCollectionReference,
          AsyncDocumentReference,
          AsyncPipeline,
          AsyncPipelineStream,
          AsyncQuery,
          AsyncTransaction,
          AsyncWriteBatch,
          Client,
          CollectionGroup,
          CollectionReference,
          CountAggregation,
          DocumentReference,
          DocumentSnapshot,
          DocumentTransform,
          ExistsOption,
          ExplainOptions,
          FieldFilter,
          FindNearestOptions,
          GeoPoint,
          Increment,
          LastUpdateOption,
          Maximum,
          Minimum,
          Or,
          Ordering,
          Pipeline,
          PipelineDataType,
          PipelineExplainOptions,
          PipelineResult,
          PipelineSnapshot,
          PipelineSource,
          PipelineStream,
          Query,
          ReadAfterWriteError,
          SampleOptions,
          SearchOptions,
          SubPipeline,
          TimeGranularity,
          TimePart,
          TimeUnit,
          Transaction,
          UnnestOptions,
          Watch,
          WriteBatch,
          WriteOption,
          async_transactional,
          transactional,
          types,
      )

      __all__: List[str] = [
          "__version__",
          "And",
          "ArrayRemove",
          "ArrayUnion",
          "AsyncClient",
          "AsyncCollectionReference",
          "AsyncDocumentReference",
          "AsyncPipeline",
          "AsyncPipelineStream",
          "AsyncQuery",
          "async_transactional",
          "AsyncTransaction",
          "AsyncWriteBatch",
          "Client",
          "CountAggregation",
          "CollectionGroup",
          "CollectionReference",
          "DELETE_FIELD",
          "DocumentReference",
          "DocumentSnapshot",
          "DocumentTransform",
          "ExistsOption",
          "ExplainOptions",
          "FieldFilter",
          "FindNearestOptions",
          "GeoPoint",
          "Increment",
          "LastUpdateOption",
          "Maximum",
          "Minimum",
          "Or",
          "Ordering",
          "Pipeline",
          "PipelineDataType",
          "PipelineExplainOptions",
          "PipelineResult",
          "PipelineSnapshot",
          "PipelineSource",
          "PipelineStream",
          "Query",
          "ReadAfterWriteError",
          "SERVER_TIMESTAMP",
          "SampleOptions",
          "SearchOptions",
          "SubPipeline",
          "TimeGranularity",
          "TimePart",
          "TimeUnit",
          "Transaction",
          "transactional",
          "types",
          "UnnestOptions",
          "Watch",
          "WriteBatch",
          "WriteOption",
      ]

    count: 1
    count: 1
  - paths: [
      "packages/google-cloud-firestore/google/cloud/firestore_admin_v1/__init__.py",
    ]
    before: |
      import sys\n
      import google.api_core as api_core\n
      from google.cloud.firestore_admin_v1 import gapic_version as package_version
      [\s\S]*?"WeeklyRecurrence",\n\)
    after: |
      from .services.firestore_admin import FirestoreAdminClient
      from .types.field import Field
      from .types.firestore_admin import (
          CreateIndexRequest,
          DeleteIndexRequest,
          ExportDocumentsRequest,
          GetFieldRequest,
          GetIndexRequest,
          ImportDocumentsRequest,
          ListFieldsRequest,
          ListFieldsResponse,
          ListIndexesRequest,
          ListIndexesResponse,
          UpdateFieldRequest,
      )
      from .types.index import Index
      from .types.location import LocationMetadata
      from .types.operation import (
          ExportDocumentsMetadata,
          ExportDocumentsResponse,
          FieldOperationMetadata,
          ImportDocumentsMetadata,
          IndexOperationMetadata,
          OperationState,
          Progress,
      )

      __all__ = (
          "CreateIndexRequest",
          "DeleteIndexRequest",
          "ExportDocumentsMetadata",
          "ExportDocumentsRequest",
          "ExportDocumentsResponse",
          "Field",
          "FieldOperationMetadata",
          "GetFieldRequest",
          "GetIndexRequest",
          "ImportDocumentsMetadata",
          "ImportDocumentsRequest",
          "Index",
          "IndexOperationMetadata",
          "ListFieldsRequest",
          "ListFieldsResponse",
          "ListIndexesRequest",
          "ListIndexesResponse",
          "LocationMetadata",
          "OperationState",
          "Progress",
          "UpdateFieldRequest",
          "FirestoreAdminClient",
      )

    count: 1
  - paths: [
      "packages/google-cloud-firestore/google/cloud/firestore_admin/__init__.py",
    ]
    before: |
      from google.cloud.firestore_admin import gapic_version as package_version
      [\s\S]*?"UserCreds",\n\)
    after: |
      from google.cloud.firestore_admin_v1.services.firestore_admin import (
          FirestoreAdminClient,
      )
      from google.cloud.firestore_admin_v1.types.field import Field
      from google.cloud.firestore_admin_v1.types.firestore_admin import (
          CreateIndexRequest,
          DeleteIndexRequest,
          ExportDocumentsRequest,
          GetFieldRequest,
          GetIndexRequest,
          ImportDocumentsRequest,
          ListFieldsRequest,
          ListFieldsResponse,
          ListIndexesRequest,
          ListIndexesResponse,
          UpdateFieldRequest,
      )
      from google.cloud.firestore_admin_v1.types.index import Index
      from google.cloud.firestore_admin_v1.types.location import LocationMetadata
      from google.cloud.firestore_admin_v1.types.operation import (
          ExportDocumentsMetadata,
          ExportDocumentsResponse,
          FieldOperationMetadata,
          ImportDocumentsMetadata,
          IndexOperationMetadata,
          OperationState,
          Progress,
      )

      __all__ = (
          "CreateIndexRequest",
          "DeleteIndexRequest",
          "ExportDocumentsMetadata",
          "ExportDocumentsRequest",
          "ExportDocumentsResponse",
          "Field",
          "FieldOperationMetadata",
          "GetFieldRequest",
          "GetIndexRequest",
          "ImportDocumentsMetadata",
          "ImportDocumentsRequest",
          "Index",
          "IndexOperationMetadata",
          "ListFieldsRequest",
          "ListFieldsResponse",
          "ListIndexesRequest",
          "ListIndexesResponse",
          "LocationMetadata",
          "OperationState",
          "Progress",
          "UpdateFieldRequest",
          "FirestoreAdminClient",
      )

    count: 1
  - paths: [
      "packages/google-cloud-firestore/google/cloud/firestore_bundle/__init__.py",
    ]
    before: |
      __lazy_modules__ = \{
      \    "google.cloud.firestore_bundle.types.bundle",
      \}\n\n
      from .types.bundle import \(
    after: |
      __lazy_modules__ = {
          "google.cloud.firestore_bundle.types.bundle",
      }\n\n
      from .bundle import FirestoreBundle
      from .types.bundle import (
    count: 1
  - paths: [
      "packages/google-cloud-firestore/google/cloud/firestore_bundle/__init__.py",
    ]
    before: '__all__ = \(\n    "BundleElement",\n'
    after: |
      __all__ = (
          "FirestoreBundle",
          "BundleElement",
    count: 1
  - paths: [
      "packages/google-cloud-firestore/noxfile.py",
    ]
    before: |
      # Error if a python version is missing
      nox.options.error_on_missing_interpreters = True\n\n
      \@nox.session\(python=ALL_PYTHON\)
      def mypy\(session\):
    after: |
      # Error if a python version is missing
      nox.options.error_on_missing_interpreters = True\n\n
      @nox.session(python=SYSTEM_TEST_PYTHON_VERSIONS)
      def system_emulated(session):
          import signal
          import subprocess

          try:
              # https://github.com/googleapis/python-firestore/issues/472
              # Kokoro image doesn't have java installed, don't attempt to run emulator.
              subprocess.call(["java", "--version"])
          except OSError:
              session.skip("java not found but required for emulator support")

          try:
              subprocess.call(["gcloud", "--version"])
          except OSError:
              session.skip("gcloud not found but required for emulator support")

          # Currently, CI/CD doesn't have beta component of gcloud.
          subprocess.call(
              [
                  "gcloud",
                  "components",
                  "install",
                  "beta",
                  "cloud-firestore-emulator",
              ]
          )

          hostport = "localhost:8789"
          session.env["FIRESTORE_EMULATOR_HOST"] = hostport

          p = subprocess.Popen(
              [
                  "gcloud",
                  "--quiet",
                  "beta",
                  "emulators",
                  "firestore",
                  "start",
                  "--host-port",
                  hostport,
              ]
          )

          try:
              system(session)
          finally:
              # Stop Emulator
              os.killpg(os.getpgid(p.pid), signal.SIGKILL)\n\n
      @nox.session(python=ALL_PYTHON)
      def mypy(session):
    count: 1
  - paths: [
      packages/google-cloud-firestore/noxfile.py
    ]
    before: |
      UNIT_TEST_EXTERNAL_DEPENDENCIES: List\[str\] = \[\]
    after: |
      UNIT_TEST_EXTERNAL_DEPENDENCIES: List[str] = [
          "aiounittest",
          "six",
          "freezegun",
      ]
    count: 1
  - paths: [
      packages/google-cloud-firestore/noxfile.py
    ]
    before: |
      SYSTEM_TEST_STANDARD_DEPENDENCIES = \[
          "mock",
          "pytest",
          "google-cloud-testutils",
      \]
    after: |
      SYSTEM_TEST_STANDARD_DEPENDENCIES = [
          "mock",
          "pytest",
      ]
    count: 1
  - paths: [
      packages/google-cloud-firestore/noxfile.py
    ]
    before: |
      SYSTEM_TEST_LOCAL_DEPENDENCIES: List\[str\] = \[\]
    after: |
      SYSTEM_TEST_LOCAL_DEPENDENCIES: List[str] = [
          "../google-cloud-testutils"
      ]
    count: 1
  # TODO(https://github.com/googleapis/google-cloud-python/issues/17429):
  # Temporary post-processing rule to add pytest-xdist dependency.
  # Remove this once gapic-generator includes pytest-xdist by default.
  - paths: [
      packages/google-cloud-firestore/noxfile.py
    ]
    before: |
      SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List\[str\] = \[\]
    after: |
      SYSTEM_TEST_EXTERNAL_DEPENDENCIES: List[str] = [
          "pytest-asyncio",
          "six",
          "pyyaml",
          "pytest-xdist",
      ]
    count: 1
  - paths: [
      packages/google-cloud-firestore/noxfile.py
    ]
    before: |
      "pytest-asyncio",
    after: |
      "pytest-asyncio==0.21.2",
    count: 2
  # TODO(https://github.com/googleapis/google-cloud-python/issues/17429):
  # Temporary post-processing rule to inject `-n auto` for Firestore parallel tests.
  # This rule should be removed once the generator template changes are released
  # and the generator version is updated in librarian.yaml.
  - paths: [
      packages/google-cloud-firestore/noxfile.py
    ]
    before: |
      # Run py.test against the system tests.
      \    if system_test_exists:
      \        session.run\(
      \            "py.test",
      \            "--quiet",
      \            f"--junitxml=system_\{session.python\}_sponge_log.xml",
      \            system_test_path,
      \            \*session.posargs,
      \        \)
      \    if system_test_folder_exists:
      \        session.run\(
      \            "py.test",
      \            "--quiet",
      \            f"--junitxml=system_\{session.python\}_sponge_log.xml",
      \            system_test_folder_path,
      \            \*session.posargs,
      \        \)
    after: |
      # Run py.test against the system tests.
          if system_test_exists:
              session.run(
                  "py.test",
                  "-n",
                  "10",
                  "--quiet",
                  f"--junitxml=system_{session.python}_sponge_log.xml",
                  system_test_path,
                  *session.posargs,
              )
          if system_test_folder_exists:
              session.run(
                  "py.test",
                  "-n",
                  "10",
                  "--quiet",
                  f"--junitxml=system_{session.python}_sponge_log.xml",
                  system_test_folder_path,
                  *session.posargs,
              )
    count: 1
  - paths: [
      "packages/google-cloud-firestore/docs/conf.py",
    ]
    before: |
      exclude_patterns = \[
      \    "_build",
    after: |
      exclude_patterns = [
          "**/firestore.rst",
          "**/firestore_admin.rst",
          "**/services_.rst",
          "**/types_.rst",
          "_build",
    count: 1
  - paths: [
      "packages/google-cloud-firestore/setup.py",
    ]
    before: |
      "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0",
      \    "grpcio >= 1.59.0, < 2.0.0",
    after: |
      "google-auth >= 2.14.1, <3.0.0,!=2.24.0,!=2.25.0",
          "google-cloud-core >= 2.0.0, <3.0.0",
          "grpcio >= 1.59.0, < 2.0.0",
    count: 1
  - paths: [
      "packages/google-cloud-firestore/docs/index.rst",
    ]
    before: |
      .. include:: multiprocessing.rst\n\n
      API Reference
      -------------
      .. toctree::
      \    :maxdepth: 2\n
      \    firestore_admin_v1/services_
      \    firestore_admin_v1/types_
    after: |
      .. include:: multiprocessing.rst\n\n
      API Reference
      -------------

      .. toctree::
        :maxdepth: 2

        firestore_admin_v1/admin_client

        firestore_bundle/bundles

        firestore_v1/aggregation
        firestore_v1/batch
        firestore_v1/bulk_writer
        firestore_v1/client
        firestore_v1/collection
        firestore_v1/document
        firestore_v1/field_path
        firestore_v1/query
        firestore_v1/transaction
        firestore_v1/transforms
        firestore_v1/types
    count: 1
  - paths: [
      "packages/google-cloud-firestore/testing/constraints-3.10.txt",
    ]
    before: |
      google-auth==2.14.1
      grpcio==1.59.0
    after: |
      google-auth==2.14.1
      google-cloud-core==2.0.0
      grpcio==1.59.0
    count: 1
  - paths: [
      "packages/google-cloud-firestore/testing/constraints-3.13.txt",
      "packages/google-cloud-firestore/testing/constraints-3.14.txt",
    ]
    before: |
      google-auth>=2
      grpcio>=1
    after: |
      google-auth>=2
      google-cloud-core>=2
      grpcio>=1
    count: 2