grpc-ecosystem/grpc-gateway

Flaky node_test run

Open

#1,659 opened on Sep 10, 2020

View on GitHub
 (0 comments) (0 reactions) (0 assignees)Go (16,971 stars) (2,250 forks)batch import
bughelp wanted

Description

🐛 Bug Report

One of our CI test jobs, node_test had a flaky failure.

To Reproduce

Run node_tests in CI enough times.

Expected behavior

The test should have deterministic behaviour.

Actual Behavior

It failed. See logs here.

Abbreviated logs:

[22:37:48] Using gulpfile /src/grpc-gateway/examples/internal/browser/gulpfile.js
[22:37:48] Starting 'gateway'...
[22:37:48] Starting 'server'...
[22:37:53] Finished 'server' after 5.13 s
[22:37:53] Starting 'serve-server'...
[22:37:53] 'serve-server' errored after 6.49 ms
[22:37:53] Error: ENOENT: no such file or directory, lstat '/src/grpc-gateway/examples/internal/browser/bin/example-gw-go-tmp-umask'
    at Object.lstatSync (fs.js:845:3)
    at Gaze._addToWatched (/src/grpc-gateway/examples/internal/browser/node_modules/gaze/lib/gaze.js:277:14)
    at Gaze.add (/src/grpc-gateway/examples/internal/browser/node_modules/gaze/lib/gaze.js:175:8)
    at new Gaze (/src/grpc-gateway/examples/internal/browser/node_modules/gaze/lib/gaze.js:74:10)
    at gaze (/src/grpc-gateway/examples/internal/browser/node_modules/gaze/lib/gaze.js:86:10)
    at Object.module.exports [as watch] (/src/grpc-gateway/examples/internal/browser/node_modules/glob-watcher/index.js:12:17)
    at Gulp.watch (/src/grpc-gateway/examples/internal/browser/node_modules/gulp/index.js:35:16)
    at Gulp.<anonymous> (/src/grpc-gateway/examples/internal/browser/gulpfile.js:30:8)
    at module.exports (/src/grpc-gateway/examples/internal/browser/node_modules/orchestrator/lib/runTask.js:34:7)
    at Gulp.Orchestrator._runTask (/src/grpc-gateway/examples/internal/browser/node_modules/orchestrator/index.js:273:3)
    at Gulp.Orchestrator._runStep (/src/grpc-gateway/examples/internal/browser/node_modules/orchestrator/index.js:214:10)
    at /src/grpc-gateway/examples/internal/browser/node_modules/orchestrator/index.js:279:18
    at finish (/src/grpc-gateway/examples/internal/browser/node_modules/orchestrator/lib/runTask.js:21:8)
    at cb (/src/grpc-gateway/examples/internal/browser/node_modules/orchestrator/lib/runTask.js:29:3)
    at /src/grpc-gateway/examples/internal/browser/node_modules/async/lib/async.js:52:16
    at /src/grpc-gateway/examples/internal/browser/node_modules/async/lib/async.js:269:32
[22:37:53] Finished 'gateway' after 5.19 s

It looks like the test failed to start the gateway, then just sat quietly for 10 minutes without failing. There might be two issues here, one is a random failure in gulp, and another one is that it doesn't fail the job immediately.

Contributor guide

Tech stack
gonodejs
Domain
testingci cd
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
familiarity with Gobasic knowledge of Node.jsunderstanding of CI/testing concepts
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate the flaky node test in CI. Look at the CircleCI job logs linked in the issue. The error suggests a missing file '/src/grpc gateway/examples/internal/browser/bin/example gw go tmp umask'. Examine the gulpfile.js in examples/internal/browser/ to understand the build sequence. Check if there is a race condition between the gateway startup and the file watcher. Also, review how the test job handles failures—it may not be failing fast enough. Consider running the test locally multiple times to reproduce the flakiness.