Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,6 @@
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
"**/integrations/tracing/koa/vendored/**/*.ts",
"**/integrations/tracing/connect/vendored/**/*.ts",
"**/integrations/tracing/mysql2/vendored/**/*.ts",
"**/integration/aws/vendored/**/*.ts",
"**/integrations/tracing/kafka/vendored/**/*.ts",
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,13 @@ const port = 5986;
const run = async () => {
const app = connect();

// Path-less middleware produces `middleware`-type spans (named and anonymous).
app.use(function middleware1(req, res, next) {
next();
});

app.use((req, res, next) => next());

app.use('/', function (req, res, next) {
res.end('Hello World');
next();
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,32 @@ describe('connect auto-instrumentation', () => {
op: 'request_handler.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'middleware1',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

not sure if we should clean out stuff like this too, the product has no use for these but it's technically breaking

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMHO I'd leave such things as much as possible if we think they could be helpful/useful, no need to drop stuff that somebody could use.

'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'middleware1',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'anonymous',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'anonymous',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),
]),
};

Expand DownExpand Up@@ -56,7 +82,30 @@ describe('connect auto-instrumentation', () => {
test('should report errored transactions.', async () => {
const runner = createTestRunner()
.ignore('event')
.expect({ transaction: { transaction: 'GET /error' } })
.expect({
transaction: {
transaction: 'GET /error',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'connectErrorMiddleware',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'connectErrorMiddleware',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
}),

expect.objectContaining({
description: '/error',
op: 'request_handler.connect',
status: 'internal_error',
}),
]),
},
})
.start();
runner.makeRequest('get', '/error');
await runner.completed();
Expand Down
45 changes: 2 additions & 43 deletions packages/node/src/integrations/tracing/connect/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
import { ConnectInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import {
captureException,
defineIntegration,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { captureException, defineIntegration } from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';

type ConnectApp = {
Expand DownExpand Up@@ -78,39 +71,5 @@ function connectErrorMiddleware(err: any, req: any, res: any, next: any): void {
*/
export const setupConnectErrorHandler = (app: ConnectApp): void => {
app.use(connectErrorMiddleware);

// Sadly, ConnectInstrumentation has no requestHook, so we need to add the attributes here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using connect
const client = getClient();
if (client) {
client.on('spanStart', span => {
addConnectSpanAttributes(span);
});
}

ensureIsWrapped(app.use, 'connect');
};

function addConnectSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: middleware, request_handler
const type = attributes['connect.type'];

// If this is already set, or we have no connect span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
* - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-connect
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
*/
/* eslint-disable */

export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
Expand All@@ -28,8 +27,3 @@ export enum ConnectTypes {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request_handler',
}

export enum ConnectNames {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request handler',
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,26 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Minor TypeScript strictness adjustments for this repository's compiler settings
*/
/* eslint-disable */

import { context, Span, SpanOptions } from '@opentelemetry/api';
import type { ServerResponse } from 'http';
import { AttributeNames, ConnectNames, ConnectTypes } from './enums/AttributeNames';
import { HandleFunction, NextFunction, Server, PatchedRequest, Use, UseArgs, UseArgs2 } from './internal-types';
import { SDK_VERSION } from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import { AttributeNames, ConnectTypes } from './enums/AttributeNames';
import type { HandleFunction, NextFunction, PatchedRequest, Server, Use, UseArgs, UseArgs2 } from './internal-types';
import type { Span } from '@sentry/core';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
isError,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
startInactiveSpan,
} from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import { replaceCurrentStackRoute, addNewStackLayer, generateRoute } from './utils';

const PACKAGE_NAME = '@sentry/instrumentation-connect';

export const ANONYMOUS_NAME = 'anonymous';
const ANONYMOUS_NAME = 'anonymous';

/** Connect instrumentation for OpenTelemetry */
export class ConnectInstrumentation extends InstrumentationBase {
Expand All@@ -54,63 +55,60 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

private _patchApp(patchedApp: Server) {
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.use)) {
this._wrap(patchedApp, 'use', this._patchUse.bind(this));
}
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.handle)) {
this._wrap(patchedApp, 'handle', this._patchHandle.bind(this));
}
}

private _patchConstructor(original: () => Server): () => Server {
const instrumentation = this;
return function (this: Server, ...args: any[]) {
const app = original.apply(this, args) as Server;
instrumentation._patchApp(app);
const patchApp = this._patchApp.bind(this);
return function (this: Server, ...args: unknown[]) {
const app = Reflect.apply(original, this, args) as Server;
patchApp(app);
return app;
};
}

public _patchNext(next: NextFunction, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: any): void {
public _patchNext(next: NextFunction, span: Span, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: unknown): void {
if (isError(err)) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
const result = next.apply(this, [err]);
finishSpan();
return result;
};
}

public _startSpan(routeName: string, middleWare: HandleFunction): Span {
let connectType: ConnectTypes;
let connectName: string;
let connectTypeName: string;
if (routeName) {
connectType = ConnectTypes.REQUEST_HANDLER;
connectTypeName = ConnectNames.REQUEST_HANDLER;
connectName = routeName;
} else {
connectType = ConnectTypes.MIDDLEWARE;
connectTypeName = ConnectNames.MIDDLEWARE;
connectName = middleWare.name || ANONYMOUS_NAME;
}
const spanName = `${connectTypeName} - ${connectName}`;
const options: SpanOptions = {
const connectType = routeName ? ConnectTypes.REQUEST_HANDLER : ConnectTypes.MIDDLEWARE;
const connectName = routeName || middleWare.name || ANONYMOUS_NAME;
return startInactiveSpan({
name: connectName,
op: `${connectType}.connect`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
[AttributeNames.CONNECT_TYPE]: connectType,
[AttributeNames.CONNECT_NAME]: connectName,
},
};

return this.tracer.startSpan(spanName, options);
});
}

public _patchMiddleware(routeName: string, middleWare: HandleFunction): HandleFunction {
const instrumentation = this;
const isEnabled = this.isEnabled.bind(this);
const startSpan: (routeName: string, middleWare: HandleFunction) => Span = this._startSpan.bind(this);
const patchNext = this._patchNext.bind(this);
const isErrorMiddleware = middleWare.length === 4;

function patchedMiddleware(this: Use): void {
if (!instrumentation.isEnabled()) {
return (middleWare as any).apply(this, arguments);
if (!isEnabled()) {
return Reflect.apply(middleWare, this, arguments);
}
const [reqArgIdx, resArgIdx, nextArgIdx] = isErrorMiddleware ? [1, 2, 3] : [0, 1, 2];
const req = arguments[reqArgIdx] as PatchedRequest;
Expand All@@ -123,31 +121,27 @@ export class ConnectInstrumentation extends InstrumentationBase {
setHttpServerSpanRouteAttribute(generateRoute(req));
}

let spanName = '';
if (routeName) {
spanName = `request handler - ${routeName}`;
} else {
spanName = `middleware - ${middleWare.name || ANONYMOUS_NAME}`;
}
const span = instrumentation._startSpan(routeName, middleWare);
instrumentation._diag.debug('start span', spanName);
const span = startSpan(routeName, middleWare);
let spanFinished = false;

function finishSpan() {
if (!spanFinished) {
spanFinished = true;
instrumentation._diag.debug(`finishing span ${(span as any).name}`);
span.end();
} else {
instrumentation._diag.debug(`span ${(span as any).name} - already finished`);
}
res.removeListener('close', finishSpan);
}

res.addListener('close', finishSpan);
arguments[nextArgIdx] = instrumentation._patchNext(next, finishSpan);

return (middleWare as any).apply(this, arguments);
arguments[nextArgIdx] = patchNext(next, span, finishSpan);

try {
return Reflect.apply(middleWare, this, arguments);
} catch (e) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
finishSpan();
throw e;
}
}

Object.defineProperty(patchedMiddleware, 'length', {
Expand All@@ -160,35 +154,35 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

public _patchUse(original: Server['use']): Use {
const instrumentation = this;
const patchMiddleware = this._patchMiddleware.bind(this);
return function (this: Server, ...args: UseArgs): Server {
const middleWare = args[args.length - 1] as HandleFunction;
const routeName = (args[args.length - 2] || '') as string;

args[args.length - 1] = instrumentation._patchMiddleware(routeName, middleWare);
args[args.length - 1] = patchMiddleware(routeName, middleWare);

return original.apply(this, args as UseArgs2);
};
}

public _patchHandle(original: Server['handle']): Server['handle'] {
const instrumentation = this;
const patchOut = this._patchOut.bind(this);
return function (this: Server): ReturnType<Server['handle']> {
const [reqIdx, outIdx] = [0, 2];
const req = arguments[reqIdx] as PatchedRequest;
const out = arguments[outIdx];
const completeStack = addNewStackLayer(req);

if (typeof out === 'function') {
arguments[outIdx] = instrumentation._patchOut(out as NextFunction, completeStack);
arguments[outIdx] = patchOut(out as NextFunction, completeStack);
}

return (original as any).apply(this, arguments);
return Reflect.apply(original, this, arguments);
};
}

public _patchOut(out: NextFunction, completeStack: () => void): NextFunction {
return function nextFunction(this: NextFunction, ...args: any[]): void {
return function nextFunction(this: NextFunction, ...args: unknown[]): void {
completeStack();
return Reflect.apply(out, this, args);
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,20 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Some types vendored from @types/connect
*/
/* eslint-disable */

import type * as http from 'http';

export type IncomingMessage = http.IncomingMessage & {
originalUrl?: http.IncomingMessage['url'] | undefined;
};

export type NextFunction = (err?: any) => void;
export type NextFunction = (err?: unknown) => void;

export type SimpleHandleFunction = (req: IncomingMessage, res: http.ServerResponse) => void;
export type NextHandleFunction = (req: IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
export type ErrorHandleFunction = (
err: any,
err: unknown,
req: IncomingMessage,
res: http.ServerResponse,
next: NextFunction,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,6 @@
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
"**/integrations/tracing/koa/vendored/**/*.ts",
"**/integrations/tracing/connect/vendored/**/*.ts",
"**/integrations/tracing/mysql2/vendored/**/*.ts",
"**/integration/aws/vendored/**/*.ts",
"**/integrations/tracing/kafka/vendored/**/*.ts",
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,13 @@ const port = 5986;
const run = async () => {
const app = connect();

// Path-less middleware produces `middleware`-type spans (named and anonymous).
app.use(function middleware1(req, res, next) {
next();
});

app.use((req, res, next) => next());

app.use('/', function (req, res, next) {
res.end('Hello World');
next();
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,32 @@ describe('connect auto-instrumentation', () => {
op: 'request_handler.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'middleware1',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

not sure if we should clean out stuff like this too, the product has no use for these but it's technically breaking

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMHO I'd leave such things as much as possible if we think they could be helpful/useful, no need to drop stuff that somebody could use.

'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'middleware1',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'anonymous',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'anonymous',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),
]),
};

Expand DownExpand Up@@ -56,7 +82,30 @@ describe('connect auto-instrumentation', () => {
test('should report errored transactions.', async () => {
const runner = createTestRunner()
.ignore('event')
.expect({ transaction: { transaction: 'GET /error' } })
.expect({
transaction: {
transaction: 'GET /error',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'connectErrorMiddleware',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'connectErrorMiddleware',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
}),

expect.objectContaining({
description: '/error',
op: 'request_handler.connect',
status: 'internal_error',
}),
]),
},
})
.start();
runner.makeRequest('get', '/error');
await runner.completed();
Expand Down
45 changes: 2 additions & 43 deletions packages/node/src/integrations/tracing/connect/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
import { ConnectInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import {
captureException,
defineIntegration,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { captureException, defineIntegration } from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';

type ConnectApp = {
Expand DownExpand Up@@ -78,39 +71,5 @@ function connectErrorMiddleware(err: any, req: any, res: any, next: any): void {
*/
export const setupConnectErrorHandler = (app: ConnectApp): void => {
app.use(connectErrorMiddleware);

// Sadly, ConnectInstrumentation has no requestHook, so we need to add the attributes here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using connect
const client = getClient();
if (client) {
client.on('spanStart', span => {
addConnectSpanAttributes(span);
});
}

ensureIsWrapped(app.use, 'connect');
};

function addConnectSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: middleware, request_handler
const type = attributes['connect.type'];

// If this is already set, or we have no connect span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
* - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-connect
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
*/
/* eslint-disable */

export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
Expand All@@ -28,8 +27,3 @@ export enum ConnectTypes {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request_handler',
}

export enum ConnectNames {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request handler',
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,26 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Minor TypeScript strictness adjustments for this repository's compiler settings
*/
/* eslint-disable */

import { context, Span, SpanOptions } from '@opentelemetry/api';
import type { ServerResponse } from 'http';
import { AttributeNames, ConnectNames, ConnectTypes } from './enums/AttributeNames';
import { HandleFunction, NextFunction, Server, PatchedRequest, Use, UseArgs, UseArgs2 } from './internal-types';
import { SDK_VERSION } from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import { AttributeNames, ConnectTypes } from './enums/AttributeNames';
import type { HandleFunction, NextFunction, PatchedRequest, Server, Use, UseArgs, UseArgs2 } from './internal-types';
import type { Span } from '@sentry/core';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
isError,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
startInactiveSpan,
} from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import { replaceCurrentStackRoute, addNewStackLayer, generateRoute } from './utils';

const PACKAGE_NAME = '@sentry/instrumentation-connect';

export const ANONYMOUS_NAME = 'anonymous';
const ANONYMOUS_NAME = 'anonymous';

/** Connect instrumentation for OpenTelemetry */
export class ConnectInstrumentation extends InstrumentationBase {
Expand All@@ -54,63 +55,60 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

private _patchApp(patchedApp: Server) {
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.use)) {
this._wrap(patchedApp, 'use', this._patchUse.bind(this));
}
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.handle)) {
this._wrap(patchedApp, 'handle', this._patchHandle.bind(this));
}
}

private _patchConstructor(original: () => Server): () => Server {
const instrumentation = this;
return function (this: Server, ...args: any[]) {
const app = original.apply(this, args) as Server;
instrumentation._patchApp(app);
const patchApp = this._patchApp.bind(this);
return function (this: Server, ...args: unknown[]) {
const app = Reflect.apply(original, this, args) as Server;
patchApp(app);
return app;
};
}

public _patchNext(next: NextFunction, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: any): void {
public _patchNext(next: NextFunction, span: Span, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: unknown): void {
if (isError(err)) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
const result = next.apply(this, [err]);
finishSpan();
return result;
};
}

public _startSpan(routeName: string, middleWare: HandleFunction): Span {
let connectType: ConnectTypes;
let connectName: string;
let connectTypeName: string;
if (routeName) {
connectType = ConnectTypes.REQUEST_HANDLER;
connectTypeName = ConnectNames.REQUEST_HANDLER;
connectName = routeName;
} else {
connectType = ConnectTypes.MIDDLEWARE;
connectTypeName = ConnectNames.MIDDLEWARE;
connectName = middleWare.name || ANONYMOUS_NAME;
}
const spanName = `${connectTypeName} - ${connectName}`;
const options: SpanOptions = {
const connectType = routeName ? ConnectTypes.REQUEST_HANDLER : ConnectTypes.MIDDLEWARE;
const connectName = routeName || middleWare.name || ANONYMOUS_NAME;
return startInactiveSpan({
name: connectName,
op: `${connectType}.connect`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
[AttributeNames.CONNECT_TYPE]: connectType,
[AttributeNames.CONNECT_NAME]: connectName,
},
};

return this.tracer.startSpan(spanName, options);
});
}

public _patchMiddleware(routeName: string, middleWare: HandleFunction): HandleFunction {
const instrumentation = this;
const isEnabled = this.isEnabled.bind(this);
const startSpan: (routeName: string, middleWare: HandleFunction) => Span = this._startSpan.bind(this);
const patchNext = this._patchNext.bind(this);
const isErrorMiddleware = middleWare.length === 4;

function patchedMiddleware(this: Use): void {
if (!instrumentation.isEnabled()) {
return (middleWare as any).apply(this, arguments);
if (!isEnabled()) {
return Reflect.apply(middleWare, this, arguments);
}
const [reqArgIdx, resArgIdx, nextArgIdx] = isErrorMiddleware ? [1, 2, 3] : [0, 1, 2];
const req = arguments[reqArgIdx] as PatchedRequest;
Expand All@@ -123,31 +121,27 @@ export class ConnectInstrumentation extends InstrumentationBase {
setHttpServerSpanRouteAttribute(generateRoute(req));
}

let spanName = '';
if (routeName) {
spanName = `request handler - ${routeName}`;
} else {
spanName = `middleware - ${middleWare.name || ANONYMOUS_NAME}`;
}
const span = instrumentation._startSpan(routeName, middleWare);
instrumentation._diag.debug('start span', spanName);
const span = startSpan(routeName, middleWare);
let spanFinished = false;

function finishSpan() {
if (!spanFinished) {
spanFinished = true;
instrumentation._diag.debug(`finishing span ${(span as any).name}`);
span.end();
} else {
instrumentation._diag.debug(`span ${(span as any).name} - already finished`);
}
res.removeListener('close', finishSpan);
}

res.addListener('close', finishSpan);
arguments[nextArgIdx] = instrumentation._patchNext(next, finishSpan);

return (middleWare as any).apply(this, arguments);
arguments[nextArgIdx] = patchNext(next, span, finishSpan);

try {
return Reflect.apply(middleWare, this, arguments);
} catch (e) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
finishSpan();
throw e;
}
}

Object.defineProperty(patchedMiddleware, 'length', {
Expand All@@ -160,35 +154,35 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

public _patchUse(original: Server['use']): Use {
const instrumentation = this;
const patchMiddleware = this._patchMiddleware.bind(this);
return function (this: Server, ...args: UseArgs): Server {
const middleWare = args[args.length - 1] as HandleFunction;
const routeName = (args[args.length - 2] || '') as string;

args[args.length - 1] = instrumentation._patchMiddleware(routeName, middleWare);
args[args.length - 1] = patchMiddleware(routeName, middleWare);

return original.apply(this, args as UseArgs2);
};
}

public _patchHandle(original: Server['handle']): Server['handle'] {
const instrumentation = this;
const patchOut = this._patchOut.bind(this);
return function (this: Server): ReturnType<Server['handle']> {
const [reqIdx, outIdx] = [0, 2];
const req = arguments[reqIdx] as PatchedRequest;
const out = arguments[outIdx];
const completeStack = addNewStackLayer(req);

if (typeof out === 'function') {
arguments[outIdx] = instrumentation._patchOut(out as NextFunction, completeStack);
arguments[outIdx] = patchOut(out as NextFunction, completeStack);
}

return (original as any).apply(this, arguments);
return Reflect.apply(original, this, arguments);
};
}

public _patchOut(out: NextFunction, completeStack: () => void): NextFunction {
return function nextFunction(this: NextFunction, ...args: any[]): void {
return function nextFunction(this: NextFunction, ...args: unknown[]): void {
completeStack();
return Reflect.apply(out, this, args);
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,20 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Some types vendored from @types/connect
*/
/* eslint-disable */

import type * as http from 'http';

export type IncomingMessage = http.IncomingMessage & {
originalUrl?: http.IncomingMessage['url'] | undefined;
};

export type NextFunction = (err?: any) => void;
export type NextFunction = (err?: unknown) => void;

export type SimpleHandleFunction = (req: IncomingMessage, res: http.ServerResponse) => void;
export type NextHandleFunction = (req: IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
export type ErrorHandleFunction = (
err: any,
err: unknown,
req: IncomingMessage,
res: http.ServerResponse,
next: NextFunction,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,6 @@
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
"**/integrations/tracing/koa/vendored/**/*.ts",
"**/integrations/tracing/connect/vendored/**/*.ts",
"**/integrations/tracing/mysql2/vendored/**/*.ts",
"**/integration/aws/vendored/**/*.ts",
"**/integrations/tracing/kafka/vendored/**/*.ts",
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,13 @@ const port = 5986;
const run = async () => {
const app = connect();

// Path-less middleware produces `middleware`-type spans (named and anonymous).
app.use(function middleware1(req, res, next) {
next();
});

app.use((req, res, next) => next());

app.use('/', function (req, res, next) {
res.end('Hello World');
next();
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,32 @@ describe('connect auto-instrumentation', () => {
op: 'request_handler.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'middleware1',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

not sure if we should clean out stuff like this too, the product has no use for these but it's technically breaking

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMHO I'd leave such things as much as possible if we think they could be helpful/useful, no need to drop stuff that somebody could use.

'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'middleware1',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'anonymous',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'anonymous',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),
]),
};

Expand DownExpand Up@@ -56,7 +82,30 @@ describe('connect auto-instrumentation', () => {
test('should report errored transactions.', async () => {
const runner = createTestRunner()
.ignore('event')
.expect({ transaction: { transaction: 'GET /error' } })
.expect({
transaction: {
transaction: 'GET /error',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'connectErrorMiddleware',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'connectErrorMiddleware',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
}),

expect.objectContaining({
description: '/error',
op: 'request_handler.connect',
status: 'internal_error',
}),
]),
},
})
.start();
runner.makeRequest('get', '/error');
await runner.completed();
Expand Down
45 changes: 2 additions & 43 deletions packages/node/src/integrations/tracing/connect/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
import { ConnectInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import {
captureException,
defineIntegration,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { captureException, defineIntegration } from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';

type ConnectApp = {
Expand DownExpand Up@@ -78,39 +71,5 @@ function connectErrorMiddleware(err: any, req: any, res: any, next: any): void {
*/
export const setupConnectErrorHandler = (app: ConnectApp): void => {
app.use(connectErrorMiddleware);

// Sadly, ConnectInstrumentation has no requestHook, so we need to add the attributes here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using connect
const client = getClient();
if (client) {
client.on('spanStart', span => {
addConnectSpanAttributes(span);
});
}

ensureIsWrapped(app.use, 'connect');
};

function addConnectSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: middleware, request_handler
const type = attributes['connect.type'];

// If this is already set, or we have no connect span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
* - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-connect
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
*/
/* eslint-disable */

export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
Expand All@@ -28,8 +27,3 @@ export enum ConnectTypes {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request_handler',
}

export enum ConnectNames {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request handler',
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,26 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Minor TypeScript strictness adjustments for this repository's compiler settings
*/
/* eslint-disable */

import { context, Span, SpanOptions } from '@opentelemetry/api';
import type { ServerResponse } from 'http';
import { AttributeNames, ConnectNames, ConnectTypes } from './enums/AttributeNames';
import { HandleFunction, NextFunction, Server, PatchedRequest, Use, UseArgs, UseArgs2 } from './internal-types';
import { SDK_VERSION } from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import { AttributeNames, ConnectTypes } from './enums/AttributeNames';
import type { HandleFunction, NextFunction, PatchedRequest, Server, Use, UseArgs, UseArgs2 } from './internal-types';
import type { Span } from '@sentry/core';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
isError,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
startInactiveSpan,
} from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import { replaceCurrentStackRoute, addNewStackLayer, generateRoute } from './utils';

const PACKAGE_NAME = '@sentry/instrumentation-connect';

export const ANONYMOUS_NAME = 'anonymous';
const ANONYMOUS_NAME = 'anonymous';

/** Connect instrumentation for OpenTelemetry */
export class ConnectInstrumentation extends InstrumentationBase {
Expand All@@ -54,63 +55,60 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

private _patchApp(patchedApp: Server) {
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.use)) {
this._wrap(patchedApp, 'use', this._patchUse.bind(this));
}
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.handle)) {
this._wrap(patchedApp, 'handle', this._patchHandle.bind(this));
}
}

private _patchConstructor(original: () => Server): () => Server {
const instrumentation = this;
return function (this: Server, ...args: any[]) {
const app = original.apply(this, args) as Server;
instrumentation._patchApp(app);
const patchApp = this._patchApp.bind(this);
return function (this: Server, ...args: unknown[]) {
const app = Reflect.apply(original, this, args) as Server;
patchApp(app);
return app;
};
}

public _patchNext(next: NextFunction, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: any): void {
public _patchNext(next: NextFunction, span: Span, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: unknown): void {
if (isError(err)) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
const result = next.apply(this, [err]);
finishSpan();
return result;
};
}

public _startSpan(routeName: string, middleWare: HandleFunction): Span {
let connectType: ConnectTypes;
let connectName: string;
let connectTypeName: string;
if (routeName) {
connectType = ConnectTypes.REQUEST_HANDLER;
connectTypeName = ConnectNames.REQUEST_HANDLER;
connectName = routeName;
} else {
connectType = ConnectTypes.MIDDLEWARE;
connectTypeName = ConnectNames.MIDDLEWARE;
connectName = middleWare.name || ANONYMOUS_NAME;
}
const spanName = `${connectTypeName} - ${connectName}`;
const options: SpanOptions = {
const connectType = routeName ? ConnectTypes.REQUEST_HANDLER : ConnectTypes.MIDDLEWARE;
const connectName = routeName || middleWare.name || ANONYMOUS_NAME;
return startInactiveSpan({
name: connectName,
op: `${connectType}.connect`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
[AttributeNames.CONNECT_TYPE]: connectType,
[AttributeNames.CONNECT_NAME]: connectName,
},
};

return this.tracer.startSpan(spanName, options);
});
}

public _patchMiddleware(routeName: string, middleWare: HandleFunction): HandleFunction {
const instrumentation = this;
const isEnabled = this.isEnabled.bind(this);
const startSpan: (routeName: string, middleWare: HandleFunction) => Span = this._startSpan.bind(this);
const patchNext = this._patchNext.bind(this);
const isErrorMiddleware = middleWare.length === 4;

function patchedMiddleware(this: Use): void {
if (!instrumentation.isEnabled()) {
return (middleWare as any).apply(this, arguments);
if (!isEnabled()) {
return Reflect.apply(middleWare, this, arguments);
}
const [reqArgIdx, resArgIdx, nextArgIdx] = isErrorMiddleware ? [1, 2, 3] : [0, 1, 2];
const req = arguments[reqArgIdx] as PatchedRequest;
Expand All@@ -123,31 +121,27 @@ export class ConnectInstrumentation extends InstrumentationBase {
setHttpServerSpanRouteAttribute(generateRoute(req));
}

let spanName = '';
if (routeName) {
spanName = `request handler - ${routeName}`;
} else {
spanName = `middleware - ${middleWare.name || ANONYMOUS_NAME}`;
}
const span = instrumentation._startSpan(routeName, middleWare);
instrumentation._diag.debug('start span', spanName);
const span = startSpan(routeName, middleWare);
let spanFinished = false;

function finishSpan() {
if (!spanFinished) {
spanFinished = true;
instrumentation._diag.debug(`finishing span ${(span as any).name}`);
span.end();
} else {
instrumentation._diag.debug(`span ${(span as any).name} - already finished`);
}
res.removeListener('close', finishSpan);
}

res.addListener('close', finishSpan);
arguments[nextArgIdx] = instrumentation._patchNext(next, finishSpan);

return (middleWare as any).apply(this, arguments);
arguments[nextArgIdx] = patchNext(next, span, finishSpan);

try {
return Reflect.apply(middleWare, this, arguments);
} catch (e) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
finishSpan();
throw e;
}
}

Object.defineProperty(patchedMiddleware, 'length', {
Expand All@@ -160,35 +154,35 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

public _patchUse(original: Server['use']): Use {
const instrumentation = this;
const patchMiddleware = this._patchMiddleware.bind(this);
return function (this: Server, ...args: UseArgs): Server {
const middleWare = args[args.length - 1] as HandleFunction;
const routeName = (args[args.length - 2] || '') as string;

args[args.length - 1] = instrumentation._patchMiddleware(routeName, middleWare);
args[args.length - 1] = patchMiddleware(routeName, middleWare);

return original.apply(this, args as UseArgs2);
};
}

public _patchHandle(original: Server['handle']): Server['handle'] {
const instrumentation = this;
const patchOut = this._patchOut.bind(this);
return function (this: Server): ReturnType<Server['handle']> {
const [reqIdx, outIdx] = [0, 2];
const req = arguments[reqIdx] as PatchedRequest;
const out = arguments[outIdx];
const completeStack = addNewStackLayer(req);

if (typeof out === 'function') {
arguments[outIdx] = instrumentation._patchOut(out as NextFunction, completeStack);
arguments[outIdx] = patchOut(out as NextFunction, completeStack);
}

return (original as any).apply(this, arguments);
return Reflect.apply(original, this, arguments);
};
}

public _patchOut(out: NextFunction, completeStack: () => void): NextFunction {
return function nextFunction(this: NextFunction, ...args: any[]): void {
return function nextFunction(this: NextFunction, ...args: unknown[]): void {
completeStack();
return Reflect.apply(out, this, args);
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,20 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Some types vendored from @types/connect
*/
/* eslint-disable */

import type * as http from 'http';

export type IncomingMessage = http.IncomingMessage & {
originalUrl?: http.IncomingMessage['url'] | undefined;
};

export type NextFunction = (err?: any) => void;
export type NextFunction = (err?: unknown) => void;

export type SimpleHandleFunction = (req: IncomingMessage, res: http.ServerResponse) => void;
export type NextHandleFunction = (req: IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
export type ErrorHandleFunction = (
err: any,
err: unknown,
req: IncomingMessage,
res: http.ServerResponse,
next: NextFunction,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,6 @@
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
"**/integrations/tracing/koa/vendored/**/*.ts",
"**/integrations/tracing/connect/vendored/**/*.ts",
"**/integrations/tracing/mysql2/vendored/**/*.ts",
"**/integration/aws/vendored/**/*.ts",
"**/integrations/tracing/kafka/vendored/**/*.ts",
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,13 @@ const port = 5986;
const run = async () => {
const app = connect();

// Path-less middleware produces `middleware`-type spans (named and anonymous).
app.use(function middleware1(req, res, next) {
next();
});

app.use((req, res, next) => next());

app.use('/', function (req, res, next) {
res.end('Hello World');
next();
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,32 @@ describe('connect auto-instrumentation', () => {
op: 'request_handler.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'middleware1',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

not sure if we should clean out stuff like this too, the product has no use for these but it's technically breaking

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMHO I'd leave such things as much as possible if we think they could be helpful/useful, no need to drop stuff that somebody could use.

'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'middleware1',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'anonymous',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'anonymous',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),
]),
};

Expand DownExpand Up@@ -56,7 +82,30 @@ describe('connect auto-instrumentation', () => {
test('should report errored transactions.', async () => {
const runner = createTestRunner()
.ignore('event')
.expect({ transaction: { transaction: 'GET /error' } })
.expect({
transaction: {
transaction: 'GET /error',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'connectErrorMiddleware',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'connectErrorMiddleware',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
}),

expect.objectContaining({
description: '/error',
op: 'request_handler.connect',
status: 'internal_error',
}),
]),
},
})
.start();
runner.makeRequest('get', '/error');
await runner.completed();
Expand Down
45 changes: 2 additions & 43 deletions packages/node/src/integrations/tracing/connect/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
import { ConnectInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import {
captureException,
defineIntegration,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { captureException, defineIntegration } from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';

type ConnectApp = {
Expand DownExpand Up@@ -78,39 +71,5 @@ function connectErrorMiddleware(err: any, req: any, res: any, next: any): void {
*/
export const setupConnectErrorHandler = (app: ConnectApp): void => {
app.use(connectErrorMiddleware);

// Sadly, ConnectInstrumentation has no requestHook, so we need to add the attributes here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using connect
const client = getClient();
if (client) {
client.on('spanStart', span => {
addConnectSpanAttributes(span);
});
}

ensureIsWrapped(app.use, 'connect');
};

function addConnectSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: middleware, request_handler
const type = attributes['connect.type'];

// If this is already set, or we have no connect span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
* - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-connect
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
*/
/* eslint-disable */

export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
Expand All@@ -28,8 +27,3 @@ export enum ConnectTypes {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request_handler',
}

export enum ConnectNames {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request handler',
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,26 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Minor TypeScript strictness adjustments for this repository's compiler settings
*/
/* eslint-disable */

import { context, Span, SpanOptions } from '@opentelemetry/api';
import type { ServerResponse } from 'http';
import { AttributeNames, ConnectNames, ConnectTypes } from './enums/AttributeNames';
import { HandleFunction, NextFunction, Server, PatchedRequest, Use, UseArgs, UseArgs2 } from './internal-types';
import { SDK_VERSION } from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import { AttributeNames, ConnectTypes } from './enums/AttributeNames';
import type { HandleFunction, NextFunction, PatchedRequest, Server, Use, UseArgs, UseArgs2 } from './internal-types';
import type { Span } from '@sentry/core';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
isError,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
startInactiveSpan,
} from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import { replaceCurrentStackRoute, addNewStackLayer, generateRoute } from './utils';

const PACKAGE_NAME = '@sentry/instrumentation-connect';

export const ANONYMOUS_NAME = 'anonymous';
const ANONYMOUS_NAME = 'anonymous';

/** Connect instrumentation for OpenTelemetry */
export class ConnectInstrumentation extends InstrumentationBase {
Expand All@@ -54,63 +55,60 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

private _patchApp(patchedApp: Server) {
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.use)) {
this._wrap(patchedApp, 'use', this._patchUse.bind(this));
}
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.handle)) {
this._wrap(patchedApp, 'handle', this._patchHandle.bind(this));
}
}

private _patchConstructor(original: () => Server): () => Server {
const instrumentation = this;
return function (this: Server, ...args: any[]) {
const app = original.apply(this, args) as Server;
instrumentation._patchApp(app);
const patchApp = this._patchApp.bind(this);
return function (this: Server, ...args: unknown[]) {
const app = Reflect.apply(original, this, args) as Server;
patchApp(app);
return app;
};
}

public _patchNext(next: NextFunction, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: any): void {
public _patchNext(next: NextFunction, span: Span, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: unknown): void {
if (isError(err)) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
const result = next.apply(this, [err]);
finishSpan();
return result;
};
}

public _startSpan(routeName: string, middleWare: HandleFunction): Span {
let connectType: ConnectTypes;
let connectName: string;
let connectTypeName: string;
if (routeName) {
connectType = ConnectTypes.REQUEST_HANDLER;
connectTypeName = ConnectNames.REQUEST_HANDLER;
connectName = routeName;
} else {
connectType = ConnectTypes.MIDDLEWARE;
connectTypeName = ConnectNames.MIDDLEWARE;
connectName = middleWare.name || ANONYMOUS_NAME;
}
const spanName = `${connectTypeName} - ${connectName}`;
const options: SpanOptions = {
const connectType = routeName ? ConnectTypes.REQUEST_HANDLER : ConnectTypes.MIDDLEWARE;
const connectName = routeName || middleWare.name || ANONYMOUS_NAME;
return startInactiveSpan({
name: connectName,
op: `${connectType}.connect`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
[AttributeNames.CONNECT_TYPE]: connectType,
[AttributeNames.CONNECT_NAME]: connectName,
},
};

return this.tracer.startSpan(spanName, options);
});
}

public _patchMiddleware(routeName: string, middleWare: HandleFunction): HandleFunction {
const instrumentation = this;
const isEnabled = this.isEnabled.bind(this);
const startSpan: (routeName: string, middleWare: HandleFunction) => Span = this._startSpan.bind(this);
const patchNext = this._patchNext.bind(this);
const isErrorMiddleware = middleWare.length === 4;

function patchedMiddleware(this: Use): void {
if (!instrumentation.isEnabled()) {
return (middleWare as any).apply(this, arguments);
if (!isEnabled()) {
return Reflect.apply(middleWare, this, arguments);
}
const [reqArgIdx, resArgIdx, nextArgIdx] = isErrorMiddleware ? [1, 2, 3] : [0, 1, 2];
const req = arguments[reqArgIdx] as PatchedRequest;
Expand All@@ -123,31 +121,27 @@ export class ConnectInstrumentation extends InstrumentationBase {
setHttpServerSpanRouteAttribute(generateRoute(req));
}

let spanName = '';
if (routeName) {
spanName = `request handler - ${routeName}`;
} else {
spanName = `middleware - ${middleWare.name || ANONYMOUS_NAME}`;
}
const span = instrumentation._startSpan(routeName, middleWare);
instrumentation._diag.debug('start span', spanName);
const span = startSpan(routeName, middleWare);
let spanFinished = false;

function finishSpan() {
if (!spanFinished) {
spanFinished = true;
instrumentation._diag.debug(`finishing span ${(span as any).name}`);
span.end();
} else {
instrumentation._diag.debug(`span ${(span as any).name} - already finished`);
}
res.removeListener('close', finishSpan);
}

res.addListener('close', finishSpan);
arguments[nextArgIdx] = instrumentation._patchNext(next, finishSpan);

return (middleWare as any).apply(this, arguments);
arguments[nextArgIdx] = patchNext(next, span, finishSpan);

try {
return Reflect.apply(middleWare, this, arguments);
} catch (e) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
finishSpan();
throw e;
}
}

Object.defineProperty(patchedMiddleware, 'length', {
Expand All@@ -160,35 +154,35 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

public _patchUse(original: Server['use']): Use {
const instrumentation = this;
const patchMiddleware = this._patchMiddleware.bind(this);
return function (this: Server, ...args: UseArgs): Server {
const middleWare = args[args.length - 1] as HandleFunction;
const routeName = (args[args.length - 2] || '') as string;

args[args.length - 1] = instrumentation._patchMiddleware(routeName, middleWare);
args[args.length - 1] = patchMiddleware(routeName, middleWare);

return original.apply(this, args as UseArgs2);
};
}

public _patchHandle(original: Server['handle']): Server['handle'] {
const instrumentation = this;
const patchOut = this._patchOut.bind(this);
return function (this: Server): ReturnType<Server['handle']> {
const [reqIdx, outIdx] = [0, 2];
const req = arguments[reqIdx] as PatchedRequest;
const out = arguments[outIdx];
const completeStack = addNewStackLayer(req);

if (typeof out === 'function') {
arguments[outIdx] = instrumentation._patchOut(out as NextFunction, completeStack);
arguments[outIdx] = patchOut(out as NextFunction, completeStack);
}

return (original as any).apply(this, arguments);
return Reflect.apply(original, this, arguments);
};
}

public _patchOut(out: NextFunction, completeStack: () => void): NextFunction {
return function nextFunction(this: NextFunction, ...args: any[]): void {
return function nextFunction(this: NextFunction, ...args: unknown[]): void {
completeStack();
return Reflect.apply(out, this, args);
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,20 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Some types vendored from @types/connect
*/
/* eslint-disable */

import type * as http from 'http';

export type IncomingMessage = http.IncomingMessage & {
originalUrl?: http.IncomingMessage['url'] | undefined;
};

export type NextFunction = (err?: any) => void;
export type NextFunction = (err?: unknown) => void;

export type SimpleHandleFunction = (req: IncomingMessage, res: http.ServerResponse) => void;
export type NextHandleFunction = (req: IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
export type ErrorHandleFunction = (
err: any,
err: unknown,
req: IncomingMessage,
res: http.ServerResponse,
next: NextFunction,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,6 @@
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
"**/integrations/tracing/koa/vendored/**/*.ts",
"**/integrations/tracing/connect/vendored/**/*.ts",
"**/integrations/tracing/mysql2/vendored/**/*.ts",
"**/integration/aws/vendored/**/*.ts",
"**/integrations/tracing/kafka/vendored/**/*.ts",
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,13 @@ const port = 5986;
const run = async () => {
const app = connect();

// Path-less middleware produces `middleware`-type spans (named and anonymous).
app.use(function middleware1(req, res, next) {
next();
});

app.use((req, res, next) => next());

app.use('/', function (req, res, next) {
res.end('Hello World');
next();
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,32 @@ describe('connect auto-instrumentation', () => {
op: 'request_handler.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'middleware1',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

not sure if we should clean out stuff like this too, the product has no use for these but it's technically breaking

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMHO I'd leave such things as much as possible if we think they could be helpful/useful, no need to drop stuff that somebody could use.

'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'middleware1',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'anonymous',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'anonymous',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),
]),
};

Expand DownExpand Up@@ -56,7 +82,30 @@ describe('connect auto-instrumentation', () => {
test('should report errored transactions.', async () => {
const runner = createTestRunner()
.ignore('event')
.expect({ transaction: { transaction: 'GET /error' } })
.expect({
transaction: {
transaction: 'GET /error',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'connectErrorMiddleware',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'connectErrorMiddleware',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
}),

expect.objectContaining({
description: '/error',
op: 'request_handler.connect',
status: 'internal_error',
}),
]),
},
})
.start();
runner.makeRequest('get', '/error');
await runner.completed();
Expand Down
45 changes: 2 additions & 43 deletions packages/node/src/integrations/tracing/connect/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
import { ConnectInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import {
captureException,
defineIntegration,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { captureException, defineIntegration } from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';

type ConnectApp = {
Expand DownExpand Up@@ -78,39 +71,5 @@ function connectErrorMiddleware(err: any, req: any, res: any, next: any): void {
*/
export const setupConnectErrorHandler = (app: ConnectApp): void => {
app.use(connectErrorMiddleware);

// Sadly, ConnectInstrumentation has no requestHook, so we need to add the attributes here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using connect
const client = getClient();
if (client) {
client.on('spanStart', span => {
addConnectSpanAttributes(span);
});
}

ensureIsWrapped(app.use, 'connect');
};

function addConnectSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: middleware, request_handler
const type = attributes['connect.type'];

// If this is already set, or we have no connect span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
* - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-connect
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
*/
/* eslint-disable */

export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
Expand All@@ -28,8 +27,3 @@ export enum ConnectTypes {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request_handler',
}

export enum ConnectNames {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request handler',
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,26 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Minor TypeScript strictness adjustments for this repository's compiler settings
*/
/* eslint-disable */

import { context, Span, SpanOptions } from '@opentelemetry/api';
import type { ServerResponse } from 'http';
import { AttributeNames, ConnectNames, ConnectTypes } from './enums/AttributeNames';
import { HandleFunction, NextFunction, Server, PatchedRequest, Use, UseArgs, UseArgs2 } from './internal-types';
import { SDK_VERSION } from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import { AttributeNames, ConnectTypes } from './enums/AttributeNames';
import type { HandleFunction, NextFunction, PatchedRequest, Server, Use, UseArgs, UseArgs2 } from './internal-types';
import type { Span } from '@sentry/core';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
isError,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
startInactiveSpan,
} from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import { replaceCurrentStackRoute, addNewStackLayer, generateRoute } from './utils';

const PACKAGE_NAME = '@sentry/instrumentation-connect';

export const ANONYMOUS_NAME = 'anonymous';
const ANONYMOUS_NAME = 'anonymous';

/** Connect instrumentation for OpenTelemetry */
export class ConnectInstrumentation extends InstrumentationBase {
Expand All@@ -54,63 +55,60 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

private _patchApp(patchedApp: Server) {
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.use)) {
this._wrap(patchedApp, 'use', this._patchUse.bind(this));
}
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.handle)) {
this._wrap(patchedApp, 'handle', this._patchHandle.bind(this));
}
}

private _patchConstructor(original: () => Server): () => Server {
const instrumentation = this;
return function (this: Server, ...args: any[]) {
const app = original.apply(this, args) as Server;
instrumentation._patchApp(app);
const patchApp = this._patchApp.bind(this);
return function (this: Server, ...args: unknown[]) {
const app = Reflect.apply(original, this, args) as Server;
patchApp(app);
return app;
};
}

public _patchNext(next: NextFunction, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: any): void {
public _patchNext(next: NextFunction, span: Span, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: unknown): void {
if (isError(err)) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
const result = next.apply(this, [err]);
finishSpan();
return result;
};
}

public _startSpan(routeName: string, middleWare: HandleFunction): Span {
let connectType: ConnectTypes;
let connectName: string;
let connectTypeName: string;
if (routeName) {
connectType = ConnectTypes.REQUEST_HANDLER;
connectTypeName = ConnectNames.REQUEST_HANDLER;
connectName = routeName;
} else {
connectType = ConnectTypes.MIDDLEWARE;
connectTypeName = ConnectNames.MIDDLEWARE;
connectName = middleWare.name || ANONYMOUS_NAME;
}
const spanName = `${connectTypeName} - ${connectName}`;
const options: SpanOptions = {
const connectType = routeName ? ConnectTypes.REQUEST_HANDLER : ConnectTypes.MIDDLEWARE;
const connectName = routeName || middleWare.name || ANONYMOUS_NAME;
return startInactiveSpan({
name: connectName,
op: `${connectType}.connect`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
[AttributeNames.CONNECT_TYPE]: connectType,
[AttributeNames.CONNECT_NAME]: connectName,
},
};

return this.tracer.startSpan(spanName, options);
});
}

public _patchMiddleware(routeName: string, middleWare: HandleFunction): HandleFunction {
const instrumentation = this;
const isEnabled = this.isEnabled.bind(this);
const startSpan: (routeName: string, middleWare: HandleFunction) => Span = this._startSpan.bind(this);
const patchNext = this._patchNext.bind(this);
const isErrorMiddleware = middleWare.length === 4;

function patchedMiddleware(this: Use): void {
if (!instrumentation.isEnabled()) {
return (middleWare as any).apply(this, arguments);
if (!isEnabled()) {
return Reflect.apply(middleWare, this, arguments);
}
const [reqArgIdx, resArgIdx, nextArgIdx] = isErrorMiddleware ? [1, 2, 3] : [0, 1, 2];
const req = arguments[reqArgIdx] as PatchedRequest;
Expand All@@ -123,31 +121,27 @@ export class ConnectInstrumentation extends InstrumentationBase {
setHttpServerSpanRouteAttribute(generateRoute(req));
}

let spanName = '';
if (routeName) {
spanName = `request handler - ${routeName}`;
} else {
spanName = `middleware - ${middleWare.name || ANONYMOUS_NAME}`;
}
const span = instrumentation._startSpan(routeName, middleWare);
instrumentation._diag.debug('start span', spanName);
const span = startSpan(routeName, middleWare);
let spanFinished = false;

function finishSpan() {
if (!spanFinished) {
spanFinished = true;
instrumentation._diag.debug(`finishing span ${(span as any).name}`);
span.end();
} else {
instrumentation._diag.debug(`span ${(span as any).name} - already finished`);
}
res.removeListener('close', finishSpan);
}

res.addListener('close', finishSpan);
arguments[nextArgIdx] = instrumentation._patchNext(next, finishSpan);

return (middleWare as any).apply(this, arguments);
arguments[nextArgIdx] = patchNext(next, span, finishSpan);

try {
return Reflect.apply(middleWare, this, arguments);
} catch (e) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
finishSpan();
throw e;
}
}

Object.defineProperty(patchedMiddleware, 'length', {
Expand All@@ -160,35 +154,35 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

public _patchUse(original: Server['use']): Use {
const instrumentation = this;
const patchMiddleware = this._patchMiddleware.bind(this);
return function (this: Server, ...args: UseArgs): Server {
const middleWare = args[args.length - 1] as HandleFunction;
const routeName = (args[args.length - 2] || '') as string;

args[args.length - 1] = instrumentation._patchMiddleware(routeName, middleWare);
args[args.length - 1] = patchMiddleware(routeName, middleWare);

return original.apply(this, args as UseArgs2);
};
}

public _patchHandle(original: Server['handle']): Server['handle'] {
const instrumentation = this;
const patchOut = this._patchOut.bind(this);
return function (this: Server): ReturnType<Server['handle']> {
const [reqIdx, outIdx] = [0, 2];
const req = arguments[reqIdx] as PatchedRequest;
const out = arguments[outIdx];
const completeStack = addNewStackLayer(req);

if (typeof out === 'function') {
arguments[outIdx] = instrumentation._patchOut(out as NextFunction, completeStack);
arguments[outIdx] = patchOut(out as NextFunction, completeStack);
}

return (original as any).apply(this, arguments);
return Reflect.apply(original, this, arguments);
};
}

public _patchOut(out: NextFunction, completeStack: () => void): NextFunction {
return function nextFunction(this: NextFunction, ...args: any[]): void {
return function nextFunction(this: NextFunction, ...args: unknown[]): void {
completeStack();
return Reflect.apply(out, this, args);
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,20 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Some types vendored from @types/connect
*/
/* eslint-disable */

import type * as http from 'http';

export type IncomingMessage = http.IncomingMessage & {
originalUrl?: http.IncomingMessage['url'] | undefined;
};

export type NextFunction = (err?: any) => void;
export type NextFunction = (err?: unknown) => void;

export type SimpleHandleFunction = (req: IncomingMessage, res: http.ServerResponse) => void;
export type NextHandleFunction = (req: IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
export type ErrorHandleFunction = (
err: any,
err: unknown,
req: IncomingMessage,
res: http.ServerResponse,
next: NextFunction,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,6 @@
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
"**/integrations/tracing/koa/vendored/**/*.ts",
"**/integrations/tracing/connect/vendored/**/*.ts",
"**/integrations/tracing/mysql2/vendored/**/*.ts",
"**/integration/aws/vendored/**/*.ts",
"**/integrations/tracing/kafka/vendored/**/*.ts",
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,13 @@ const port = 5986;
const run = async () => {
const app = connect();

// Path-less middleware produces `middleware`-type spans (named and anonymous).
app.use(function middleware1(req, res, next) {
next();
});

app.use((req, res, next) => next());

app.use('/', function (req, res, next) {
res.end('Hello World');
next();
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,32 @@ describe('connect auto-instrumentation', () => {
op: 'request_handler.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'middleware1',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

not sure if we should clean out stuff like this too, the product has no use for these but it's technically breaking

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMHO I'd leave such things as much as possible if we think they could be helpful/useful, no need to drop stuff that somebody could use.

'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'middleware1',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'anonymous',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'anonymous',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),
]),
};

Expand DownExpand Up@@ -56,7 +82,30 @@ describe('connect auto-instrumentation', () => {
test('should report errored transactions.', async () => {
const runner = createTestRunner()
.ignore('event')
.expect({ transaction: { transaction: 'GET /error' } })
.expect({
transaction: {
transaction: 'GET /error',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'connectErrorMiddleware',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'connectErrorMiddleware',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
}),

expect.objectContaining({
description: '/error',
op: 'request_handler.connect',
status: 'internal_error',
}),
]),
},
})
.start();
runner.makeRequest('get', '/error');
await runner.completed();
Expand Down
45 changes: 2 additions & 43 deletions packages/node/src/integrations/tracing/connect/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
import { ConnectInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import {
captureException,
defineIntegration,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { captureException, defineIntegration } from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';

type ConnectApp = {
Expand DownExpand Up@@ -78,39 +71,5 @@ function connectErrorMiddleware(err: any, req: any, res: any, next: any): void {
*/
export const setupConnectErrorHandler = (app: ConnectApp): void => {
app.use(connectErrorMiddleware);

// Sadly, ConnectInstrumentation has no requestHook, so we need to add the attributes here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using connect
const client = getClient();
if (client) {
client.on('spanStart', span => {
addConnectSpanAttributes(span);
});
}

ensureIsWrapped(app.use, 'connect');
};

function addConnectSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: middleware, request_handler
const type = attributes['connect.type'];

// If this is already set, or we have no connect span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
* - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-connect
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
*/
/* eslint-disable */

export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
Expand All@@ -28,8 +27,3 @@ export enum ConnectTypes {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request_handler',
}

export enum ConnectNames {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request handler',
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,26 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Minor TypeScript strictness adjustments for this repository's compiler settings
*/
/* eslint-disable */

import { context, Span, SpanOptions } from '@opentelemetry/api';
import type { ServerResponse } from 'http';
import { AttributeNames, ConnectNames, ConnectTypes } from './enums/AttributeNames';
import { HandleFunction, NextFunction, Server, PatchedRequest, Use, UseArgs, UseArgs2 } from './internal-types';
import { SDK_VERSION } from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import { AttributeNames, ConnectTypes } from './enums/AttributeNames';
import type { HandleFunction, NextFunction, PatchedRequest, Server, Use, UseArgs, UseArgs2 } from './internal-types';
import type { Span } from '@sentry/core';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
isError,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
startInactiveSpan,
} from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import { replaceCurrentStackRoute, addNewStackLayer, generateRoute } from './utils';

const PACKAGE_NAME = '@sentry/instrumentation-connect';

export const ANONYMOUS_NAME = 'anonymous';
const ANONYMOUS_NAME = 'anonymous';

/** Connect instrumentation for OpenTelemetry */
export class ConnectInstrumentation extends InstrumentationBase {
Expand All@@ -54,63 +55,60 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

private _patchApp(patchedApp: Server) {
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.use)) {
this._wrap(patchedApp, 'use', this._patchUse.bind(this));
}
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.handle)) {
this._wrap(patchedApp, 'handle', this._patchHandle.bind(this));
}
}

private _patchConstructor(original: () => Server): () => Server {
const instrumentation = this;
return function (this: Server, ...args: any[]) {
const app = original.apply(this, args) as Server;
instrumentation._patchApp(app);
const patchApp = this._patchApp.bind(this);
return function (this: Server, ...args: unknown[]) {
const app = Reflect.apply(original, this, args) as Server;
patchApp(app);
return app;
};
}

public _patchNext(next: NextFunction, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: any): void {
public _patchNext(next: NextFunction, span: Span, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: unknown): void {
if (isError(err)) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
const result = next.apply(this, [err]);
finishSpan();
return result;
};
}

public _startSpan(routeName: string, middleWare: HandleFunction): Span {
let connectType: ConnectTypes;
let connectName: string;
let connectTypeName: string;
if (routeName) {
connectType = ConnectTypes.REQUEST_HANDLER;
connectTypeName = ConnectNames.REQUEST_HANDLER;
connectName = routeName;
} else {
connectType = ConnectTypes.MIDDLEWARE;
connectTypeName = ConnectNames.MIDDLEWARE;
connectName = middleWare.name || ANONYMOUS_NAME;
}
const spanName = `${connectTypeName} - ${connectName}`;
const options: SpanOptions = {
const connectType = routeName ? ConnectTypes.REQUEST_HANDLER : ConnectTypes.MIDDLEWARE;
const connectName = routeName || middleWare.name || ANONYMOUS_NAME;
return startInactiveSpan({
name: connectName,
op: `${connectType}.connect`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
[AttributeNames.CONNECT_TYPE]: connectType,
[AttributeNames.CONNECT_NAME]: connectName,
},
};

return this.tracer.startSpan(spanName, options);
});
}

public _patchMiddleware(routeName: string, middleWare: HandleFunction): HandleFunction {
const instrumentation = this;
const isEnabled = this.isEnabled.bind(this);
const startSpan: (routeName: string, middleWare: HandleFunction) => Span = this._startSpan.bind(this);
const patchNext = this._patchNext.bind(this);
const isErrorMiddleware = middleWare.length === 4;

function patchedMiddleware(this: Use): void {
if (!instrumentation.isEnabled()) {
return (middleWare as any).apply(this, arguments);
if (!isEnabled()) {
return Reflect.apply(middleWare, this, arguments);
}
const [reqArgIdx, resArgIdx, nextArgIdx] = isErrorMiddleware ? [1, 2, 3] : [0, 1, 2];
const req = arguments[reqArgIdx] as PatchedRequest;
Expand All@@ -123,31 +121,27 @@ export class ConnectInstrumentation extends InstrumentationBase {
setHttpServerSpanRouteAttribute(generateRoute(req));
}

let spanName = '';
if (routeName) {
spanName = `request handler - ${routeName}`;
} else {
spanName = `middleware - ${middleWare.name || ANONYMOUS_NAME}`;
}
const span = instrumentation._startSpan(routeName, middleWare);
instrumentation._diag.debug('start span', spanName);
const span = startSpan(routeName, middleWare);
let spanFinished = false;

function finishSpan() {
if (!spanFinished) {
spanFinished = true;
instrumentation._diag.debug(`finishing span ${(span as any).name}`);
span.end();
} else {
instrumentation._diag.debug(`span ${(span as any).name} - already finished`);
}
res.removeListener('close', finishSpan);
}

res.addListener('close', finishSpan);
arguments[nextArgIdx] = instrumentation._patchNext(next, finishSpan);

return (middleWare as any).apply(this, arguments);
arguments[nextArgIdx] = patchNext(next, span, finishSpan);

try {
return Reflect.apply(middleWare, this, arguments);
} catch (e) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
finishSpan();
throw e;
}
}

Object.defineProperty(patchedMiddleware, 'length', {
Expand All@@ -160,35 +154,35 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

public _patchUse(original: Server['use']): Use {
const instrumentation = this;
const patchMiddleware = this._patchMiddleware.bind(this);
return function (this: Server, ...args: UseArgs): Server {
const middleWare = args[args.length - 1] as HandleFunction;
const routeName = (args[args.length - 2] || '') as string;

args[args.length - 1] = instrumentation._patchMiddleware(routeName, middleWare);
args[args.length - 1] = patchMiddleware(routeName, middleWare);

return original.apply(this, args as UseArgs2);
};
}

public _patchHandle(original: Server['handle']): Server['handle'] {
const instrumentation = this;
const patchOut = this._patchOut.bind(this);
return function (this: Server): ReturnType<Server['handle']> {
const [reqIdx, outIdx] = [0, 2];
const req = arguments[reqIdx] as PatchedRequest;
const out = arguments[outIdx];
const completeStack = addNewStackLayer(req);

if (typeof out === 'function') {
arguments[outIdx] = instrumentation._patchOut(out as NextFunction, completeStack);
arguments[outIdx] = patchOut(out as NextFunction, completeStack);
}

return (original as any).apply(this, arguments);
return Reflect.apply(original, this, arguments);
};
}

public _patchOut(out: NextFunction, completeStack: () => void): NextFunction {
return function nextFunction(this: NextFunction, ...args: any[]): void {
return function nextFunction(this: NextFunction, ...args: unknown[]): void {
completeStack();
return Reflect.apply(out, this, args);
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,20 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Some types vendored from @types/connect
*/
/* eslint-disable */

import type * as http from 'http';

export type IncomingMessage = http.IncomingMessage & {
originalUrl?: http.IncomingMessage['url'] | undefined;
};

export type NextFunction = (err?: any) => void;
export type NextFunction = (err?: unknown) => void;

export type SimpleHandleFunction = (req: IncomingMessage, res: http.ServerResponse) => void;
export type NextHandleFunction = (req: IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
export type ErrorHandleFunction = (
err: any,
err: unknown,
req: IncomingMessage,
res: http.ServerResponse,
next: NextFunction,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,6 @@
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
"**/integrations/tracing/koa/vendored/**/*.ts",
"**/integrations/tracing/connect/vendored/**/*.ts",
"**/integrations/tracing/mysql2/vendored/**/*.ts",
"**/integration/aws/vendored/**/*.ts",
"**/integrations/tracing/kafka/vendored/**/*.ts",
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,13 @@ const port = 5986;
const run = async () => {
const app = connect();

// Path-less middleware produces `middleware`-type spans (named and anonymous).
app.use(function middleware1(req, res, next) {
next();
});

app.use((req, res, next) => next());

app.use('/', function (req, res, next) {
res.end('Hello World');
next();
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,32 @@ describe('connect auto-instrumentation', () => {
op: 'request_handler.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'middleware1',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

not sure if we should clean out stuff like this too, the product has no use for these but it's technically breaking

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMHO I'd leave such things as much as possible if we think they could be helpful/useful, no need to drop stuff that somebody could use.

'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'middleware1',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'anonymous',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'anonymous',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),
]),
};

Expand DownExpand Up@@ -56,7 +82,30 @@ describe('connect auto-instrumentation', () => {
test('should report errored transactions.', async () => {
const runner = createTestRunner()
.ignore('event')
.expect({ transaction: { transaction: 'GET /error' } })
.expect({
transaction: {
transaction: 'GET /error',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'connectErrorMiddleware',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'connectErrorMiddleware',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
}),

expect.objectContaining({
description: '/error',
op: 'request_handler.connect',
status: 'internal_error',
}),
]),
},
})
.start();
runner.makeRequest('get', '/error');
await runner.completed();
Expand Down
45 changes: 2 additions & 43 deletions packages/node/src/integrations/tracing/connect/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
import { ConnectInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import {
captureException,
defineIntegration,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { captureException, defineIntegration } from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';

type ConnectApp = {
Expand DownExpand Up@@ -78,39 +71,5 @@ function connectErrorMiddleware(err: any, req: any, res: any, next: any): void {
*/
export const setupConnectErrorHandler = (app: ConnectApp): void => {
app.use(connectErrorMiddleware);

// Sadly, ConnectInstrumentation has no requestHook, so we need to add the attributes here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using connect
const client = getClient();
if (client) {
client.on('spanStart', span => {
addConnectSpanAttributes(span);
});
}

ensureIsWrapped(app.use, 'connect');
};

function addConnectSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: middleware, request_handler
const type = attributes['connect.type'];

// If this is already set, or we have no connect span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
* - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-connect
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
*/
/* eslint-disable */

export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
Expand All@@ -28,8 +27,3 @@ export enum ConnectTypes {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request_handler',
}

export enum ConnectNames {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request handler',
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,26 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Minor TypeScript strictness adjustments for this repository's compiler settings
*/
/* eslint-disable */

import { context, Span, SpanOptions } from '@opentelemetry/api';
import type { ServerResponse } from 'http';
import { AttributeNames, ConnectNames, ConnectTypes } from './enums/AttributeNames';
import { HandleFunction, NextFunction, Server, PatchedRequest, Use, UseArgs, UseArgs2 } from './internal-types';
import { SDK_VERSION } from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import { AttributeNames, ConnectTypes } from './enums/AttributeNames';
import type { HandleFunction, NextFunction, PatchedRequest, Server, Use, UseArgs, UseArgs2 } from './internal-types';
import type { Span } from '@sentry/core';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
isError,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
startInactiveSpan,
} from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import { replaceCurrentStackRoute, addNewStackLayer, generateRoute } from './utils';

const PACKAGE_NAME = '@sentry/instrumentation-connect';

export const ANONYMOUS_NAME = 'anonymous';
const ANONYMOUS_NAME = 'anonymous';

/** Connect instrumentation for OpenTelemetry */
export class ConnectInstrumentation extends InstrumentationBase {
Expand All@@ -54,63 +55,60 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

private _patchApp(patchedApp: Server) {
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.use)) {
this._wrap(patchedApp, 'use', this._patchUse.bind(this));
}
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.handle)) {
this._wrap(patchedApp, 'handle', this._patchHandle.bind(this));
}
}

private _patchConstructor(original: () => Server): () => Server {
const instrumentation = this;
return function (this: Server, ...args: any[]) {
const app = original.apply(this, args) as Server;
instrumentation._patchApp(app);
const patchApp = this._patchApp.bind(this);
return function (this: Server, ...args: unknown[]) {
const app = Reflect.apply(original, this, args) as Server;
patchApp(app);
return app;
};
}

public _patchNext(next: NextFunction, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: any): void {
public _patchNext(next: NextFunction, span: Span, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: unknown): void {
if (isError(err)) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
const result = next.apply(this, [err]);
finishSpan();
return result;
};
}

public _startSpan(routeName: string, middleWare: HandleFunction): Span {
let connectType: ConnectTypes;
let connectName: string;
let connectTypeName: string;
if (routeName) {
connectType = ConnectTypes.REQUEST_HANDLER;
connectTypeName = ConnectNames.REQUEST_HANDLER;
connectName = routeName;
} else {
connectType = ConnectTypes.MIDDLEWARE;
connectTypeName = ConnectNames.MIDDLEWARE;
connectName = middleWare.name || ANONYMOUS_NAME;
}
const spanName = `${connectTypeName} - ${connectName}`;
const options: SpanOptions = {
const connectType = routeName ? ConnectTypes.REQUEST_HANDLER : ConnectTypes.MIDDLEWARE;
const connectName = routeName || middleWare.name || ANONYMOUS_NAME;
return startInactiveSpan({
name: connectName,
op: `${connectType}.connect`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
[AttributeNames.CONNECT_TYPE]: connectType,
[AttributeNames.CONNECT_NAME]: connectName,
},
};

return this.tracer.startSpan(spanName, options);
});
}

public _patchMiddleware(routeName: string, middleWare: HandleFunction): HandleFunction {
const instrumentation = this;
const isEnabled = this.isEnabled.bind(this);
const startSpan: (routeName: string, middleWare: HandleFunction) => Span = this._startSpan.bind(this);
const patchNext = this._patchNext.bind(this);
const isErrorMiddleware = middleWare.length === 4;

function patchedMiddleware(this: Use): void {
if (!instrumentation.isEnabled()) {
return (middleWare as any).apply(this, arguments);
if (!isEnabled()) {
return Reflect.apply(middleWare, this, arguments);
}
const [reqArgIdx, resArgIdx, nextArgIdx] = isErrorMiddleware ? [1, 2, 3] : [0, 1, 2];
const req = arguments[reqArgIdx] as PatchedRequest;
Expand All@@ -123,31 +121,27 @@ export class ConnectInstrumentation extends InstrumentationBase {
setHttpServerSpanRouteAttribute(generateRoute(req));
}

let spanName = '';
if (routeName) {
spanName = `request handler - ${routeName}`;
} else {
spanName = `middleware - ${middleWare.name || ANONYMOUS_NAME}`;
}
const span = instrumentation._startSpan(routeName, middleWare);
instrumentation._diag.debug('start span', spanName);
const span = startSpan(routeName, middleWare);
let spanFinished = false;

function finishSpan() {
if (!spanFinished) {
spanFinished = true;
instrumentation._diag.debug(`finishing span ${(span as any).name}`);
span.end();
} else {
instrumentation._diag.debug(`span ${(span as any).name} - already finished`);
}
res.removeListener('close', finishSpan);
}

res.addListener('close', finishSpan);
arguments[nextArgIdx] = instrumentation._patchNext(next, finishSpan);

return (middleWare as any).apply(this, arguments);
arguments[nextArgIdx] = patchNext(next, span, finishSpan);

try {
return Reflect.apply(middleWare, this, arguments);
} catch (e) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
finishSpan();
throw e;
}
}

Object.defineProperty(patchedMiddleware, 'length', {
Expand All@@ -160,35 +154,35 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

public _patchUse(original: Server['use']): Use {
const instrumentation = this;
const patchMiddleware = this._patchMiddleware.bind(this);
return function (this: Server, ...args: UseArgs): Server {
const middleWare = args[args.length - 1] as HandleFunction;
const routeName = (args[args.length - 2] || '') as string;

args[args.length - 1] = instrumentation._patchMiddleware(routeName, middleWare);
args[args.length - 1] = patchMiddleware(routeName, middleWare);

return original.apply(this, args as UseArgs2);
};
}

public _patchHandle(original: Server['handle']): Server['handle'] {
const instrumentation = this;
const patchOut = this._patchOut.bind(this);
return function (this: Server): ReturnType<Server['handle']> {
const [reqIdx, outIdx] = [0, 2];
const req = arguments[reqIdx] as PatchedRequest;
const out = arguments[outIdx];
const completeStack = addNewStackLayer(req);

if (typeof out === 'function') {
arguments[outIdx] = instrumentation._patchOut(out as NextFunction, completeStack);
arguments[outIdx] = patchOut(out as NextFunction, completeStack);
}

return (original as any).apply(this, arguments);
return Reflect.apply(original, this, arguments);
};
}

public _patchOut(out: NextFunction, completeStack: () => void): NextFunction {
return function nextFunction(this: NextFunction, ...args: any[]): void {
return function nextFunction(this: NextFunction, ...args: unknown[]): void {
completeStack();
return Reflect.apply(out, this, args);
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,20 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Some types vendored from @types/connect
*/
/* eslint-disable */

import type * as http from 'http';

export type IncomingMessage = http.IncomingMessage & {
originalUrl?: http.IncomingMessage['url'] | undefined;
};

export type NextFunction = (err?: any) => void;
export type NextFunction = (err?: unknown) => void;

export type SimpleHandleFunction = (req: IncomingMessage, res: http.ServerResponse) => void;
export type NextHandleFunction = (req: IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
export type ErrorHandleFunction = (
err: any,
err: unknown,
req: IncomingMessage,
res: http.ServerResponse,
next: NextFunction,
Expand Down
Loading
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion .oxlintrc.base.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -146,7 +146,6 @@
"**/integrations/tracing/knex/vendored/**/*.ts",
"**/integrations/tracing/mongo/vendored/**/*.ts",
"**/integrations/tracing/koa/vendored/**/*.ts",
"**/integrations/tracing/connect/vendored/**/*.ts",
"**/integrations/tracing/mysql2/vendored/**/*.ts",
"**/integration/aws/vendored/**/*.ts",
"**/integrations/tracing/kafka/vendored/**/*.ts",
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,6 +8,13 @@ const port = 5986;
const run = async () => {
const app = connect();

// Path-less middleware produces `middleware`-type spans (named and anonymous).
app.use(function middleware1(req, res, next) {
next();
});

app.use((req, res, next) => next());

app.use('/', function (req, res, next) {
res.end('Hello World');
next();
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -22,6 +22,32 @@ describe('connect auto-instrumentation', () => {
op: 'request_handler.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'middleware1',

Copy link
Copy Markdown
MemberAuthor

Choose a reason for hiding this comment

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

not sure if we should clean out stuff like this too, the product has no use for these but it's technically breaking

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

IMHO I'd leave such things as much as possible if we think they could be helpful/useful, no need to drop stuff that somebody could use.

'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'middleware1',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),

expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'anonymous',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'anonymous',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
status: 'ok',
}),
]),
};

Expand DownExpand Up@@ -56,7 +82,30 @@ describe('connect auto-instrumentation', () => {
test('should report errored transactions.', async () => {
const runner = createTestRunner()
.ignore('event')
.expect({ transaction: { transaction: 'GET /error' } })
.expect({
transaction: {
transaction: 'GET /error',
spans: expect.arrayContaining([
expect.objectContaining({
data: expect.objectContaining({
'connect.name': 'connectErrorMiddleware',
'connect.type': 'middleware',
'sentry.origin': 'auto.http.otel.connect',
'sentry.op': 'middleware.connect',
}),
description: 'connectErrorMiddleware',
origin: 'auto.http.otel.connect',
op: 'middleware.connect',
}),

expect.objectContaining({
description: '/error',
op: 'request_handler.connect',
status: 'internal_error',
}),
]),
},
})
.start();
runner.makeRequest('get', '/error');
await runner.completed();
Expand Down
45 changes: 2 additions & 43 deletions packages/node/src/integrations/tracing/connect/index.ts
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,6 @@
import { ConnectInstrumentation } from './vendored/instrumentation';
import type { IntegrationFn, Span } from '@sentry/core';
import {
captureException,
defineIntegration,
getClient,
SEMANTIC_ATTRIBUTE_SENTRY_OP,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
spanToJSON,
} from '@sentry/core';
import type { IntegrationFn } from '@sentry/core';
import { captureException, defineIntegration } from '@sentry/core';
import { ensureIsWrapped, generateInstrumentOnce } from '@sentry/node-core';

type ConnectApp = {
Expand DownExpand Up@@ -78,39 +71,5 @@ function connectErrorMiddleware(err: any, req: any, res: any, next: any): void {
*/
export const setupConnectErrorHandler = (app: ConnectApp): void => {
app.use(connectErrorMiddleware);

// Sadly, ConnectInstrumentation has no requestHook, so we need to add the attributes here
// We register this hook in this method, because if we register it in the integration `setup`,
// it would always run even for users that are not even using connect
const client = getClient();
if (client) {
client.on('spanStart', span => {
addConnectSpanAttributes(span);
});
}

ensureIsWrapped(app.use, 'connect');
};

function addConnectSpanAttributes(span: Span): void {
const attributes = spanToJSON(span).data;

// this is one of: middleware, request_handler
const type = attributes['connect.type'];

// If this is already set, or we have no connect span, no need to process again...
if (attributes[SEMANTIC_ATTRIBUTE_SENTRY_OP] || !type) {
return;
}

span.setAttributes({
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[SEMANTIC_ATTRIBUTE_SENTRY_OP]: `${type}.connect`,
});

// Also update the name, we don't need the "middleware - " prefix
const name = attributes['connect.name'];
if (typeof name === 'string') {
span.updateName(name);
}
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,7 +17,6 @@
* - Vendored from: https://github.com/open-telemetry/opentelemetry-js-contrib/tree/15ef7506553f631ea4181391e0c5725a56f0d082/packages/instrumentation-connect
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
*/
/* eslint-disable */

export enum AttributeNames {
CONNECT_TYPE = 'connect.type',
Expand All@@ -28,8 +27,3 @@ export enum ConnectTypes {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request_handler',
}

export enum ConnectNames {
MIDDLEWARE = 'middleware',
REQUEST_HANDLER = 'request handler',
}
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,26 +18,27 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Minor TypeScript strictness adjustments for this repository's compiler settings
*/
/* eslint-disable */

import { context, Span, SpanOptions } from '@opentelemetry/api';
import type { ServerResponse } from 'http';
import { AttributeNames, ConnectNames, ConnectTypes } from './enums/AttributeNames';
import { HandleFunction, NextFunction, Server, PatchedRequest, Use, UseArgs, UseArgs2 } from './internal-types';
import { SDK_VERSION } from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import { AttributeNames, ConnectTypes } from './enums/AttributeNames';
import type { HandleFunction, NextFunction, PatchedRequest, Server, Use, UseArgs, UseArgs2 } from './internal-types';
import type { Span } from '@sentry/core';
import {
InstrumentationBase,
InstrumentationConfig,
InstrumentationNodeModuleDefinition,
isWrapped,
} from '@opentelemetry/instrumentation';
isError,
SDK_VERSION,
SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN,
SPAN_STATUS_ERROR,
startInactiveSpan,
} from '@sentry/core';
import { setHttpServerSpanRouteAttribute } from '../../../../utils/setHttpServerSpanRouteAttribute';
import type { InstrumentationConfig } from '@opentelemetry/instrumentation';
import { InstrumentationBase, InstrumentationNodeModuleDefinition, isWrapped } from '@opentelemetry/instrumentation';
import { ATTR_HTTP_ROUTE } from '@opentelemetry/semantic-conventions';
import { replaceCurrentStackRoute, addNewStackLayer, generateRoute } from './utils';

const PACKAGE_NAME = '@sentry/instrumentation-connect';

export const ANONYMOUS_NAME = 'anonymous';
const ANONYMOUS_NAME = 'anonymous';

/** Connect instrumentation for OpenTelemetry */
export class ConnectInstrumentation extends InstrumentationBase {
Expand All@@ -54,63 +55,60 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

private _patchApp(patchedApp: Server) {
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.use)) {
this._wrap(patchedApp, 'use', this._patchUse.bind(this));
}
// oxlint-disable-next-line typescript/unbound-method
if (!isWrapped(patchedApp.handle)) {
this._wrap(patchedApp, 'handle', this._patchHandle.bind(this));
}
}

private _patchConstructor(original: () => Server): () => Server {
const instrumentation = this;
return function (this: Server, ...args: any[]) {
const app = original.apply(this, args) as Server;
instrumentation._patchApp(app);
const patchApp = this._patchApp.bind(this);
return function (this: Server, ...args: unknown[]) {
const app = Reflect.apply(original, this, args) as Server;
patchApp(app);
return app;
};
}

public _patchNext(next: NextFunction, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: any): void {
public _patchNext(next: NextFunction, span: Span, finishSpan: () => void): NextFunction {
return function nextFunction(this: NextFunction, err?: unknown): void {
if (isError(err)) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
}
const result = next.apply(this, [err]);
finishSpan();
return result;
};
}

public _startSpan(routeName: string, middleWare: HandleFunction): Span {
let connectType: ConnectTypes;
let connectName: string;
let connectTypeName: string;
if (routeName) {
connectType = ConnectTypes.REQUEST_HANDLER;
connectTypeName = ConnectNames.REQUEST_HANDLER;
connectName = routeName;
} else {
connectType = ConnectTypes.MIDDLEWARE;
connectTypeName = ConnectNames.MIDDLEWARE;
connectName = middleWare.name || ANONYMOUS_NAME;
}
const spanName = `${connectTypeName} - ${connectName}`;
const options: SpanOptions = {
const connectType = routeName ? ConnectTypes.REQUEST_HANDLER : ConnectTypes.MIDDLEWARE;
const connectName = routeName || middleWare.name || ANONYMOUS_NAME;
return startInactiveSpan({
name: connectName,
op: `${connectType}.connect`,
attributes: {
[SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN]: 'auto.http.otel.connect',
[ATTR_HTTP_ROUTE]: routeName.length > 0 ? routeName : '/',
[AttributeNames.CONNECT_TYPE]: connectType,
[AttributeNames.CONNECT_NAME]: connectName,
},
};

return this.tracer.startSpan(spanName, options);
});
}

public _patchMiddleware(routeName: string, middleWare: HandleFunction): HandleFunction {
const instrumentation = this;
const isEnabled = this.isEnabled.bind(this);
const startSpan: (routeName: string, middleWare: HandleFunction) => Span = this._startSpan.bind(this);
const patchNext = this._patchNext.bind(this);
const isErrorMiddleware = middleWare.length === 4;

function patchedMiddleware(this: Use): void {
if (!instrumentation.isEnabled()) {
return (middleWare as any).apply(this, arguments);
if (!isEnabled()) {
return Reflect.apply(middleWare, this, arguments);
}
const [reqArgIdx, resArgIdx, nextArgIdx] = isErrorMiddleware ? [1, 2, 3] : [0, 1, 2];
const req = arguments[reqArgIdx] as PatchedRequest;
Expand All@@ -123,31 +121,27 @@ export class ConnectInstrumentation extends InstrumentationBase {
setHttpServerSpanRouteAttribute(generateRoute(req));
}

let spanName = '';
if (routeName) {
spanName = `request handler - ${routeName}`;
} else {
spanName = `middleware - ${middleWare.name || ANONYMOUS_NAME}`;
}
const span = instrumentation._startSpan(routeName, middleWare);
instrumentation._diag.debug('start span', spanName);
const span = startSpan(routeName, middleWare);
let spanFinished = false;

function finishSpan() {
if (!spanFinished) {
spanFinished = true;
instrumentation._diag.debug(`finishing span ${(span as any).name}`);
span.end();
} else {
instrumentation._diag.debug(`span ${(span as any).name} - already finished`);
}
res.removeListener('close', finishSpan);
}

res.addListener('close', finishSpan);
arguments[nextArgIdx] = instrumentation._patchNext(next, finishSpan);

return (middleWare as any).apply(this, arguments);
arguments[nextArgIdx] = patchNext(next, span, finishSpan);

try {
return Reflect.apply(middleWare, this, arguments);
} catch (e) {
span.setStatus({ code: SPAN_STATUS_ERROR, message: 'internal_error' });
finishSpan();
throw e;
}
}

Object.defineProperty(patchedMiddleware, 'length', {
Expand All@@ -160,35 +154,35 @@ export class ConnectInstrumentation extends InstrumentationBase {
}

public _patchUse(original: Server['use']): Use {
const instrumentation = this;
const patchMiddleware = this._patchMiddleware.bind(this);
return function (this: Server, ...args: UseArgs): Server {
const middleWare = args[args.length - 1] as HandleFunction;
const routeName = (args[args.length - 2] || '') as string;

args[args.length - 1] = instrumentation._patchMiddleware(routeName, middleWare);
args[args.length - 1] = patchMiddleware(routeName, middleWare);

return original.apply(this, args as UseArgs2);
};
}

public _patchHandle(original: Server['handle']): Server['handle'] {
const instrumentation = this;
const patchOut = this._patchOut.bind(this);
return function (this: Server): ReturnType<Server['handle']> {
const [reqIdx, outIdx] = [0, 2];
const req = arguments[reqIdx] as PatchedRequest;
const out = arguments[outIdx];
const completeStack = addNewStackLayer(req);

if (typeof out === 'function') {
arguments[outIdx] = instrumentation._patchOut(out as NextFunction, completeStack);
arguments[outIdx] = patchOut(out as NextFunction, completeStack);
}

return (original as any).apply(this, arguments);
return Reflect.apply(original, this, arguments);
};
}

public _patchOut(out: NextFunction, completeStack: () => void): NextFunction {
return function nextFunction(this: NextFunction, ...args: any[]): void {
return function nextFunction(this: NextFunction, ...args: unknown[]): void {
completeStack();
return Reflect.apply(out, this, args);
};
Expand Down
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,20 +18,19 @@
* - Upstream version: @opentelemetry/instrumentation-connect@0.61.0
* - Some types vendored from @types/connect
*/
/* eslint-disable */

import type * as http from 'http';

export type IncomingMessage = http.IncomingMessage & {
originalUrl?: http.IncomingMessage['url'] | undefined;
};

export type NextFunction = (err?: any) => void;
export type NextFunction = (err?: unknown) => void;

export type SimpleHandleFunction = (req: IncomingMessage, res: http.ServerResponse) => void;
export type NextHandleFunction = (req: IncomingMessage, res: http.ServerResponse, next: NextFunction) => void;
export type ErrorHandleFunction = (
err: any,
err: unknown,
req: IncomingMessage,
res: http.ServerResponse,
next: NextFunction,
Expand Down
Loading
Loading