bigquery: `query()` never uses the `jobs.query` fast path when `jobTimeoutMs` is set
Mantenedores costumam responder em até 1 dia
Ninguém assumiu esta issue ainda.
Avaliação
- Dificuldade
- 2/5
- Tempo estimado
- 1-3 horas
- Facilidade para iniciantes
- 55/100
- Tipo de issue
- Bug
- Clareza
- Claramente especificada
- Status de atividade
- Pouca atividade
- Stack de tecnologia
- typescript
Direção de pesquisa
Comece em handwritten/bigquery/src/bigquery.ts, em buildQueryRequest_(), onde a denylist controla o fast path de jobs.query. Verifique a definição de IQueryRequest em handwritten/bigquery/src/types.d.ts e o mapeamento existente de createQueryJob(), depois adicione ou atualize o teste unitário relevante. Está concluído quando jobTimeoutMs for enviado como uma string por jobs.query e o teste verificar a requisição do fast path.
Escrita pelo modelo de indexação a partir do texto da issue.
Descrição
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:
jobs.queryacceptsjobTimeoutMsand returns results normally (HTTP 200).jobs.queryenforces it: a ~30s query withjobTimeoutMs: "1000"returns HTTP 499 with"Job execution was cancelled: Job timed out after 1 sec".
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:
// 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
- The
jobs.queryrequest body now has ajobTimeoutMsfield. This repository's generatedIQueryRequesttype already includes it: https://github.com/googleapis/google-cloud-node/blob/13d1ca8247789323094df9ed916e3ad184053cd7/handwritten/bigquery/src/types.d.ts#L4437-L4440 - The field's documentation explicitly covers the no-job case: "This timeout applies to the query even if a job does not need to be created."
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.
- Linguagem predominante
- TypeScript
- Estrelas
- 3.2k
- Forks
- 732
- Merge médio
- 2d 11h
- PRs com merge (30d)
- 99
Preparar o ambiente
- Sem Dockerfile nem arquivo Docker Compose
- Tem um modelo de pull request
- Ler o guia de contribuição
Primeiros passos
- Leia a issue inteira e depois o guia de contribuição do projeto.
- Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
- Faça um fork do repositório e trabalhe em uma branch.
- Abra um pull request que referencie o número da issue.
Mais de googleapis/google-cloud-node
-
Broken deprecation chainAberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 66/100
googleapis/google-cloud-node#9854 ·
Mantenedores costumam responder em até 1 dia
-
pubsub: "Operation attempted on ended Span" when a modack is flushed after the message was ackedAbertaapi: pubsub
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
googleapis/google-cloud-node#9853 ·
Mantenedores costumam responder em até 1 dia
-
storage: V4 getSignedUrl sorts canonical headers with localeCompare, so they disagree with X-Goog-SignedHeadersTalvez já em andamento @itsrayeedscodespace assumiu há 9 dias. Abertaapi: storage
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 82/100
googleapis/google-cloud-node#9840 · 1 comentário ·
Mantenedores costumam responder em até 1 dia
-
firestore: getPartitions() emits gax AutopaginateTrueWarning in every processTalvez já em andamento @TheRealDanii assumiu há 13 dias. Abertaapi: firestore
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 76/100
googleapis/google-cloud-node#9736 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 1/5 Menos de uma hora Facilidade para iniciantes 82/100
googleapis/google-cloud-node#9723 ·
Mantenedores costumam responder em até 1 dia
Todas as issues de googleapis/google-cloud-node
Issues semelhantes
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 67/100
ilan-pinto/roaring-lions#1552 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 72/100
Mantenedores costumam responder em até 1 dia
-
bug: [React Native/Android] KeepAliveService never starts when CAMERA is not granted (Android 14+)Aberta
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
cloudflare/realtimekit-ui#208 ·
Mantenedores costumam responder em até 1 dia
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 68/100
usebruno/bruno-vscode#235 ·
Mantenedores costumam responder em até 3 dias
-
Dificuldade 2/5 1-3 horas Facilidade para iniciantes 78/100
Mantenedores costumam responder em até 1 dia