bigquery: `query()` never uses the `jobs.query` fast path when `jobTimeoutMs` is set

オープン
#9,119 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
55/100
issue の種類
バグ
明瞭さ
明確に書かれている
活発さ
静か
技術スタック
typescript
領域
api, data

調査の方向性

handwritten/bigquery/src/bigquery.ts の buildQueryRequest_() から始めます。ここでは denylist が jobs.query の fast path を制御しています。handwritten/bigquery/src/types.d.ts の IQueryRequest の定義と、既存の createQueryJob() のマッピングを確認してから、関連する unit test を追加または更新します。jobTimeoutMs が jobs.query を通じて文字列として送信され、test が fast-path request を検証すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

api: bigquery
Library Name

@google-cloud/bigquery

A screenshot that you have tested with "Try this API".

The screenshots show the issue is client-side, not API-side:

  1. jobs.query accepts jobTimeoutMs and returns results normally (HTTP 200).Image
  2. jobs.query enforces it: a ~30s query with jobTimeoutMs: "1000" returns HTTP 499 with "Job execution was cancelled: Job timed out after 1 sec".Image
What would you like to see in the library?

This is a request for the handwritten client logic in handwritten/bigquery, not for the API surface: the API already supports the field, and the limitation is a client-side denylist.

Current behavior

BigQuery.query() routes queries to the accelerated jobs.query endpoint unless an option appears on a denylist in buildQueryRequest_().
jobTimeoutMs is on that list, so setting it silently forces every query through the slower jobs.insert + getQueryResults path:

https://github.com/googleapis/google-cloud-node/blob/13d1ca8247789323094df9ed916e3ad184053cd7/handwritten/bigquery/src/bigquery.ts#L2354

// always goes through jobs.insert + polling, even for a tiny query
const [rows] = await bigquery.query({query: 'SELECT 1', jobTimeoutMs: 60000});
The API now supports jobTimeoutMs on jobs.query
Proposed change

Remove jobTimeoutMs from the denylist and map it into the IQueryRequest, converting the number to a string as the API expects an int64 field. This mirrors what createQueryJob() already does for the jobs.insert path.

A patch with a unit test is ready on my fork, based on current main. I will open a PR if the approach looks good: https://github.com/googleapis/google-cloud-node/compare/main...takaebato:google-cloud-node:bigquery-jobtimeoutms-fast-path

Describe alternatives you've considered

No real alternative: users today can only drop jobTimeoutMs or fall back to createQueryJob() and manage the job manually.

Additional context/notes

I verified the server-side behavior with direct REST calls.

1. jobTimeoutMs is enforced on the fast path, with the identical error as the slow path

A query that runs for roughly 30 seconds, submitted with a 1 second timeout via POST /projects/$PROJECT/queries:

{
  "query": "SELECT COUNT(*) FROM UNNEST(GENERATE_ARRAY(1, 1000000)) a CROSS JOIN UNNEST(GENERATE_ARRAY(1, 1000)) b WHERE MOD(a + b, 7) = 0",
  "useLegacySql": false,
  "useQueryCache": false,
  "jobTimeoutMs": "1000",
  "timeoutMs": 120000
}

returns HTTP 499 synchronously after about 7 seconds:

{
  "error": {
    "code": 499,
    "message": "Job execution was cancelled: Job timed out after 1 sec",
    "errors": [
      {
        "message": "Job execution was cancelled: Job timed out after 1 sec",
        "domain": "global",
        "reason": "stopped"
      }
    ],
    "status": "CANCELLED"
  }
}

The same query submitted via POST /projects/$PROJECT/jobs with {"configuration": {"query": {...}, "jobTimeoutMs": "1000"}} ends as DONE with an errorResult carrying the identical reason and message, and jobs.getQueryResults for that job returns a byte-identical HTTP 499 body. So the error surfaced to the client is the same regardless of path.

2. The timeout applies even when no job is created

The same fast path request with "jobCreationMode": "JOB_CREATION_OPTIONAL" added was cancelled as well, with the same error shape, confirming the documented behavior ("This timeout applies to the query even if a job does not need to be created").

3. The jobTimeoutMs: 0 case: only the request body changes, not the behavior

Before the patch, query({query, jobTimeoutMs: 0}) already took the fast path, because the denylist check is truthiness-based and 0 is falsy. The field was not sent in that case. With the patch, the field is sent as "jobTimeoutMs": "0". The server accepts "0" and treats it as "no timeout", so the observable behavior is the same, verified with

{"query": "SELECT 1", "useLegacySql": false, "jobTimeoutMs": "0"}

returning HTTP 200 with results. This also matches createQueryJob(), which has always sent "0" on the jobs.insert path.

主要言語
TypeScript
スター
3.2k
フォーク
732
平均マージ
2日 11時間
マージ済み PR(30日)
99

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

googleapis/google-cloud-node のほかの issue

googleapis/google-cloud-node の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。