Skip to content

chore(generator): delegate request-id setup to public request#17739

Open
hebaalazzeh wants to merge 87 commits into
mainfrom
feat/gapic-generator-centralization-request-id
Open

chore(generator): delegate request-id setup to public request#17739
hebaalazzeh wants to merge 87 commits into
mainfrom
feat/gapic-generator-centralization-request-id

Conversation

@hebaalazzeh

@hebaalazzeh hebaalazzeh commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

Updates generator templates and goldens to import public requests from google-api-core gapic_v1 and call setup_request_id helper. Removes duplicate setup_request_id test logic from generated client unit tests.

Temporarily pointing to this PR then will revert once it is merged/released:

@gemini-code-assist gemini-code-assist Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request refactors the request ID setup logic in the generated client templates by delegating it to google.api_core.gapic_v1.method_helpers.setup_request_id instead of maintaining an inline implementation. As a result, the redundant unit tests for _setup_request_id have been removed from both the templates and the golden integration tests. There are no review comments, so I have no feedback to provide.

@hebaalazzeh
hebaalazzeh changed the base branch from main to feat/gapic-centralization-api-core-request-id July 16, 2026 15:20
@hebaalazzeh hebaalazzeh self-assigned this Jul 16, 2026
@hebaalazzeh hebaalazzeh reopened this Jul 16, 2026
@hebaalazzeh
hebaalazzeh force-pushed the feat/gapic-generator-centralization-request-id branch from f037044 to f25d768 Compare July 16, 2026 16:10
@hebaalazzeh
hebaalazzeh force-pushed the feat/gapic-centralization-api-core-request-id branch from a0bff77 to 613b392 Compare July 16, 2026 16:18
@hebaalazzeh
hebaalazzeh force-pushed the feat/gapic-generator-centralization-request-id branch from f25d768 to 71b2f4e Compare July 16, 2026 16:20
@hebaalazzeh
hebaalazzeh force-pushed the feat/gapic-centralization-api-core-request-id branch 3 times, most recently from e02ee4b to db040bb Compare July 16, 2026 16:28
@daniel-sanche daniel-sanche added the do not merge Indicates a pull request not ready for merge, due to either quality or timing. label Jul 16, 2026
@hebaalazzeh
hebaalazzeh force-pushed the feat/gapic-generator-centralization-request-id branch from 71b2f4e to a8cc8d8 Compare July 16, 2026 18:11
@daniel-sanche

Copy link
Copy Markdown
Contributor

This implementation makes sense if we plan to bump up the api_core requirement Before merging, we need to:

  1. get the changes in feat(api_core): add request-id auto-population logic to gapic_v1 public helpers #17738 released
  2. update the setup.py to reference the new api_core version floor
  3. regenerate goldens

There's also a chance we will want to keep a fallback implementation to keep supporting old api_core versions

@hebaalazzeh hebaalazzeh changed the title feat: delegate request-id setup to public method_helpers chore(generator): delegate request-id setup to public request Jul 16, 2026
…lic helpers

Introduces method_helpers module containing setup_request_id helper. Exposes the module as public in gapic_v1.
@hebaalazzeh
hebaalazzeh force-pushed the feat/gapic-centralization-api-core-request-id branch from 90602cc to 76ac456 Compare July 16, 2026 23:21
…lic helpers

Introduces method_helpers module containing setup_request_id helper. Exposes the module as public in gapic_v1.
Updates generator templates and goldens to import public method_helpers from google-api-core gapic_v1 and call setup_request_id helper. Removes duplicate setup_request_id test logic from generated client unit tests.
@hebaalazzeh
hebaalazzeh force-pushed the feat/gapic-centralization-api-core-request-id branch from 8e31d83 to 20adea6 Compare July 16, 2026 23:42
@hebaalazzeh
hebaalazzeh force-pushed the feat/gapic-generator-centralization-request-id branch from b014e36 to 0dc81e3 Compare July 23, 2026 08:18
Comment thread packages/gapic-generator/noxfile.py Outdated
"-p",
"google",
"--check-untyped-defs",
)

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this change related? Why is this here?

Comment thread packages/google-api-core/pyproject.toml Outdated
[tool.setuptools.package-data]
"google.api_core" = ["py.typed"]
"*" = ["py.typed"]

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question: Why is this here?

)
assert len(cgr.file) == 1
assert cgr.file[0].name == "foo/bar/baz.py"
assert cgr.file[0].content == "I am a template result.\n"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why were these assertions removed?

Comment thread packages/gapic-generator/noxfile.py Outdated
# Install the library without a constraints file.
session.install("-e", tmp_dir)

session.install("-e", "../google-api-core", "--no-deps")

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you clarify why this is needed? This is causing mypy to fail btw


from .rest_base import _BaseStorageBatchOperationsRestTransport
from google.cloud.storagebatchoperations_v1.storage_batch_operations._compat import transcode_request
from google.cloud.storagebatchoperations_v1._compat import transcode_request

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I mentioned this in a different PR, but can we have _compat in the service directory?

def _get_unset_required_fields(cls, message_dict):
return {k: v for k, v in cls.__REQUIRED_FIELDS_DEFAULT_VALUES.items() if k not in message_dict}
_REQUIRED_FIELDS_DEFAULT_VALUES: Dict[str, Any] = {
"updateMask" : {}, }

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: the indentation is a bit off on these

except ImportError: # pragma: NO COVER
from google.auth.transport import mtls # type: ignore

# TODO(https://github.com/googleapis/google-cloud-python/issues/17813): Remove these fallbacks when google-api-core >= 2.18.0 is the minimum required version.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I mentioned this in a different PR, but 2.18.0 seems like the wrong version

"Environment variable `GOOGLE_API_USE_CLIENT_CERTIFICATE` must be"
" either `true` or `false`"
)
return use_client_cert_str == "true"

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think these were indended to be here? This was a separate PR, but use_client_cert_effective shouldn't be in api_core, since it's already in google-auth

You can add a compat function for this if you want, but it should probably come in a separate change:

try:
  from google.auth.....mtls import should_use_client_cert
except ImportError:
  def should_use_client_cert():
      ...

@hebaalazzeh

Copy link
Copy Markdown
Contributor Author

To simplify things for myself and the review process I am going to break things down:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

do not merge Indicates a pull request not ready for merge, due to either quality or timing.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants