[plugin-http] null-check socket before destructuring

[adelsz]

What version of OpenTelemetry are you using?

"@opentelemetry/api": "0.9.0",
"@opentelemetry/node": "0.9.0",
"@opentelemetry/plugin-http": "0.9.0",
"@opentelemetry/plugin-https": "0.9.0",
"@opentelemetry/tracing": "0.9.0",

What version of Node are you using?

Node 12

What did you do?

We use OpenTelemetry for tracing and for some requests we see destructuring errors inside plugin-http in our error logs.
This isn't consistently reproducible but it does happen sometimes. Error trace:

TypeError: Cannot destructure property 'localAddress' of 'socket' as it is null.
    at Object.exports.getIncomingRequestAttributesOnResponse (/app/node_modules/@opentelemetry/plugin-http/build/src/utils.js:363:13)
    at ServerResponse.response.end (/app/node_modules/@opentelemetry/plugin-http/build/src/http.js:215:50)
    at ServerResponse.send (/app/node_modules/express/lib/response.js:221:10)
    at ServerResponse.sendStatus (/app/node_modules/express/lib/response.js:359:15)
    at /app/dist/src/index.js:409:46

Looks like these occur because response.socket can be null:

opentelemetry-js/packages/opentelemetry-plugin-http/src/utils.ts

Line 463 in 0cde542

const { localAddress, localPort, remoteAddress, remotePort } = socket;

Node docs do mention that:

After response.end(), the property (response.socket) is nulled

So maybe that is the source of the problem.

[dyladan]

@OlivierAlbertini can you look into this? It looks like the typings say that socket should always be defined, which is why we didn't catch this before. My first instinct is to try to move utils.getIncomingRequestAttributesOnResponse before response.end is called. I tried that locally and the tests seem to pass, but I'm not sure if I'm missing some edge case there.

[dyladan]

I will look into this today

[vardani]

@dyladan Hey, any updates on this?

[dyladan]

@OlivierAlbertini Do you have any idea what might have happened here?

[kaareal]

also seen with node 14 with

     "@opentelemetry/api": "^0.14.0",
    "@opentelemetry/core": "^0.14.0",
    "@opentelemetry/exporter-zipkin": "^0.14.0",
    "@opentelemetry/koa-instrumentation": "^0.12.0",
    "@opentelemetry/node": "^0.14.0",
    "@opentelemetry/plugin-dns": "^0.12.0",
    "@opentelemetry/plugin-grpc-js": "^0.14.0",
    "@opentelemetry/plugin-http": "^0.14.0",
    "@opentelemetry/plugin-https": "^0.14.0",
    "@opentelemetry/plugin-mongodb": "^0.12.0",
    "@opentelemetry/tracing": "^0.14.0"