Skip to content

ref: Fix circular dependency checks & setup #12159

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 22, 2024
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
7 changes: 7 additions & 0 deletions .madgerc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"detectiveOptions": {
"ts": {
"skipTypeImports": true
}
}
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@
"jest-environment-node": "^27.5.1",
"jsdom": "^21.1.2",
"lerna": "7.1.1",
"madge": "4.0.2",
"madge": "7.0.0",
"nodemon": "^2.0.16",
"npm-run-all": "^4.1.5",
"prettier": "^3.1.1",
Expand Down
9 changes: 1 addition & 8 deletions packages/bun/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,5 @@
"volta": {
"extends": "../../package.json"
},
"sideEffects": false,
"madge": {
"detectiveOptions": {
"ts": {
"skipTypeImports": true
}
}
}
"sideEffects": false
}
7 changes: 0 additions & 7 deletions packages/core/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -69,12 +69,5 @@
"volta": {
"extends": "../../package.json"
},
"madge": {
"detectiveOptions": {
"ts": {
"skipTypeImports": true
}
}
},
"sideEffects": false
}
2 changes: 1 addition & 1 deletion packages/core/src/asyncContext/stackStrategy.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import type { Client, Scope as ScopeInterface } from '@sentry/types';
import { isThenable } from '@sentry/utils';
import { getDefaultCurrentScope, getDefaultIsolationScope } from '../currentScopes';
import { getDefaultCurrentScope, getDefaultIsolationScope } from '../defaultScopes';
import { Scope } from '../scope';

import { getMainCarrier, getSentryCarrier } from './../carrier';
Expand Down
10 changes: 0 additions & 10 deletions packages/core/src/currentScopes.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,16 +5,6 @@ import { getAsyncContextStrategy } from './asyncContext';
import { getMainCarrier } from './carrier';
import { Scope as ScopeClass } from './scope';

/** Get the default current scope. */
export function getDefaultCurrentScope(): Scope {
return getGlobalSingleton('defaultCurrentScope', () => new ScopeClass());
}

/** Get the default isolation scope. */
export function getDefaultIsolationScope(): Scope {
return getGlobalSingleton('defaultIsolationScope', () => new ScopeClass());
}

/**
* Get the currently active scope.
*/
Expand Down
13 changes: 13 additions & 0 deletions packages/core/src/defaultScopes.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
import type { Scope } from '@sentry/types';
import { getGlobalSingleton } from '@sentry/utils';
import { Scope as ScopeClass } from './scope';

/** Get the default current scope. */
export function getDefaultCurrentScope(): Scope {
return getGlobalSingleton('defaultCurrentScope', () => new ScopeClass());
}

/** Get the default isolation scope. */
export function getDefaultIsolationScope(): Scope {
return getGlobalSingleton('defaultIsolationScope', () => new ScopeClass());
}
3 changes: 2 additions & 1 deletion packages/core/src/envelope.ts
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@ import {
getSdkMetadataForEnvelopeHeader,
} from '@sentry/utils';
import { createSpanEnvelopeItem } from '@sentry/utils';
import { type SentrySpan, getDynamicSamplingContextFromSpan } from './tracing';
import { getDynamicSamplingContextFromSpan } from './tracing/dynamicSamplingContext';
import type { SentrySpan } from './tracing/sentrySpan';
import { spanToJSON } from './utils/spanUtils';

/**
Expand Down
5 changes: 3 additions & 2 deletions packages/core/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@ export {
withScope,
withIsolationScope,
getClient,
} from './currentScopes';
export {
getDefaultCurrentScope,
getDefaultIsolationScope,
} from './currentScopes';
} from './defaultScopes';
export { setAsyncContextStrategy } from './asyncContext';
export { getMainCarrier } from './carrier';
export { makeSession, closeSession, updateSession } from './session';
Expand Down Expand Up @@ -69,7 +71,6 @@ export { handleCallbackErrors } from './utils/handleCallbackErrors';
export { parameterize } from './utils/parameterize';
export {
spanToTraceHeader,
spanToBaggageHeader,
spanToJSON,
spanIsSampled,
spanToTraceContext,
Expand Down
14 changes: 13 additions & 1 deletion packages/core/src/tracing/dynamicSamplingContext.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
import type { Client, DynamicSamplingContext, Span } from '@sentry/types';
import { addNonEnumerableProperty, dropUndefinedKeys } from '@sentry/utils';
import {
addNonEnumerableProperty,
dropUndefinedKeys,
dynamicSamplingContextToSentryBaggageHeader,
} from '@sentry/utils';

import { DEFAULT_ENVIRONMENT } from '../constants';
import { getClient } from '../currentScopes';
Expand Down Expand Up @@ -93,3 +97,11 @@ export function getDynamicSamplingContextFromSpan(span: Span): Readonly<Partial<

return dsc;
}

/**
* Convert a Span to a baggage header.
*/
export function spanToBaggageHeader(span: Span): string | undefined {
const dsc = getDynamicSamplingContextFromSpan(span);
return dynamicSamplingContextToSentryBaggageHeader(dsc);
}
6 changes: 5 additions & 1 deletion packages/core/src/tracing/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,11 @@ export {
withActiveSpan,
suppressTracing,
} from './trace';
export { getDynamicSamplingContextFromClient, getDynamicSamplingContextFromSpan } from './dynamicSamplingContext';
export {
getDynamicSamplingContextFromClient,
getDynamicSamplingContextFromSpan,
spanToBaggageHeader,
} from './dynamicSamplingContext';
export { setMeasurement, timedEventsToMeasurements } from './measurement';
export { sampleSpan } from './sampling';
export { logSpanEnd, logSpanStart } from './logSpans';
10 changes: 0 additions & 10 deletions packages/core/src/utils/spanUtils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,6 @@ import type {
import {
addNonEnumerableProperty,
dropUndefinedKeys,
dynamicSamplingContextToSentryBaggageHeader,
generateSentryTraceHeader,
timestampInSeconds,
} from '@sentry/utils';
Expand All @@ -22,7 +21,6 @@ import { getCurrentScope } from '../currentScopes';
import { getMetricSummaryJsonForSpan, updateMetricSummaryOnSpan } from '../metrics/metric-summary';
import type { MetricType } from '../metrics/types';
import { SEMANTIC_ATTRIBUTE_SENTRY_OP, SEMANTIC_ATTRIBUTE_SENTRY_ORIGIN } from '../semanticAttributes';
import { getDynamicSamplingContextFromSpan } from '../tracing';
import type { SentrySpan } from '../tracing/sentrySpan';
import { SPAN_STATUS_OK, SPAN_STATUS_UNSET } from '../tracing/spanstatus';
import { _getSpanForScope } from './spanOnScope';
Expand Down Expand Up @@ -70,14 +68,6 @@ export function spanToTraceHeader(span: Span): string {
return generateSentryTraceHeader(traceId, spanId, sampled);
}

/**
* Convert a Span to a baggage header.
*/
export function spanToBaggageHeader(span: Span): string | undefined {
const dsc = getDynamicSamplingContextFromSpan(span);
return dynamicSamplingContextToSentryBaggageHeader(dsc);
}

/**
* Convert a span time input intp a timestamp in seconds.
*/
Expand Down
7 changes: 0 additions & 7 deletions packages/deno/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -63,13 +63,6 @@
"extends": "../../package.json"
},
"sideEffects": false,
"madge": {
"detectiveOptions": {
"ts": {
"skipTypeImports": true
}
}
},
"nx": {
"targets": {
"build:transpile": {
Expand Down
3 changes: 1 addition & 2 deletions packages/node/src/integrations/anr/index.ts
Original file line number Diff line number Diff line change
@@ -1,9 +1,8 @@
import * as inspector from 'node:inspector';
import { Worker } from 'node:worker_threads';
import { defineIntegration, mergeScopeData } from '@sentry/core';
import { defineIntegration, getCurrentScope, getGlobalScope, getIsolationScope, mergeScopeData } from '@sentry/core';
import type { Contexts, Event, EventHint, Integration, IntegrationFn, ScopeData } from '@sentry/types';
import { GLOBAL_OBJ, logger } from '@sentry/utils';
import { getCurrentScope, getGlobalScope, getIsolationScope } from '../..';
import { NODE_VERSION } from '../../nodeVersion';
import type { NodeClient } from '../../sdk/client';
import type { AnrIntegrationOptions, WorkerStartData } from './common';
Expand Down
6 changes: 1 addition & 5 deletions packages/node/src/sdk/init.ts
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,11 @@ import { spotlightIntegration } from '../integrations/spotlight';
import { getAutoPerformanceIntegrations } from '../integrations/tracing';
import { makeNodeTransport } from '../transports';
import type { NodeClientOptions, NodeOptions } from '../types';
import { isCjs } from '../utils/commonjs';
import { defaultStackParser, getSentryRelease } from './api';
import { NodeClient } from './client';
import { initOpenTelemetry } from './initOtel';

/** Detect CommonJS. */
export function isCjs(): boolean {
return typeof require !== 'undefined';
}

function getCjsOnlyIntegrations(): Integration[] {
return isCjs() ? [modulesIntegration()] : [];
}
Expand Down
4 changes: 4 additions & 0 deletions packages/node/src/utils/commonjs.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
/** Detect CommonJS. */
export function isCjs(): boolean {
return typeof require !== 'undefined';
}
2 changes: 1 addition & 1 deletion packages/node/src/utils/ensureIsWrapped.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { isWrapped } from '@opentelemetry/core';
import { hasTracingEnabled, isEnabled } from '@sentry/core';
import { consoleSandbox } from '@sentry/utils';
import { isCjs } from '../sdk/init';
import { isCjs } from './commonjs';

/**
* Checks and warns if a framework isn't wrapped by opentelemetry.
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/event.ts
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ import type { Thread } from './thread';
import type { TransactionSource } from './transaction';
import type { User } from './user';

/** JSDoc */
/** An event to be sent to Sentry. */
export interface Event {
event_id?: string;
message?: string;
Expand Down
3 changes: 1 addition & 2 deletions packages/types/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -121,11 +121,10 @@ export type { Stacktrace, StackParser, StackLineParser, StackLineParserFn } from
export type { PropagationContext, TracePropagationTargets } from './tracing';
export type { StartSpanOptions } from './startSpanOptions';
export type {
CustomSamplingContext,
SamplingContext,
TraceparentData,
TransactionSource,
} from './transaction';
export type { CustomSamplingContext, SamplingContext } from './samplingcontext';
export type {
DurationUnit,
InformationUnit,
Expand Down
2 changes: 1 addition & 1 deletion packages/types/src/options.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
import type { Breadcrumb, BreadcrumbHint } from './breadcrumb';
import type { ErrorEvent, EventHint, TransactionEvent } from './event';
import type { Integration } from './integration';
import type { SamplingContext } from './samplingcontext';
import type { CaptureContext } from './scope';
import type { SdkMetadata } from './sdkmetadata';
import type { SpanJSON } from './span';
import type { StackLineParser, StackParser } from './stacktrace';
import type { TracePropagationTargets } from './tracing';
import type { SamplingContext } from './transaction';
import type { BaseTransportOptions, Transport } from './transport';

export interface ClientOptions<TO extends BaseTransportOptions = BaseTransportOptions> {
Expand Down
47 changes: 47 additions & 0 deletions packages/types/src/samplingcontext.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
import type { ExtractedNodeRequestData, WorkerLocation } from './misc';
import type { SpanAttributes } from './span';

/**
* Context data passed by the user when starting a transaction, to be used by the tracesSampler method.
*/
export interface CustomSamplingContext {
[key: string]: any;
}

/**
* Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
*
* Adds default data to data provided by the user. See {@link Hub.startTransaction}
*/
export interface SamplingContext extends CustomSamplingContext {
/**
* Context data with which transaction being sampled was created.
* @deprecated This is duplicate data and will be removed eventually.
*/
transactionContext: {
name: string;
parentSampled?: boolean | undefined;
};

/**
* Sampling decision from the parent transaction, if any.
*/
parentSampled?: boolean;

/**
* Object representing the URL of the current page or worker script. Passed by default when using the `BrowserTracing`
* integration.
*/
location?: WorkerLocation;

/**
* Object representing the incoming request to a node server. Passed by default when using the TracingHandler.
*/
request?: ExtractedNodeRequestData;

/** The name of the span being sampled. */
name: string;

/** Initial attributes that have been passed to the span being sampled. */
attributes?: SpanAttributes;
}
48 changes: 0 additions & 48 deletions packages/types/src/transaction.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,3 @@
import type { ExtractedNodeRequestData, WorkerLocation } from './misc';
import type { SpanAttributes } from './span';

/**
* Data pulled from a `sentry-trace` header
*/
Expand All @@ -21,51 +18,6 @@ export interface TraceparentData {
parentSampled?: boolean | undefined;
}

/**
* Context data passed by the user when starting a transaction, to be used by the tracesSampler method.
*/
export interface CustomSamplingContext {
[key: string]: any;
}

/**
* Data passed to the `tracesSampler` function, which forms the basis for whatever decisions it might make.
*
* Adds default data to data provided by the user. See {@link Hub.startTransaction}
*/
export interface SamplingContext extends CustomSamplingContext {
/**
* Context data with which transaction being sampled was created.
* @deprecated This is duplicate data and will be removed eventually.
*/
transactionContext: {
name: string;
parentSampled?: boolean | undefined;
};

/**
* Sampling decision from the parent transaction, if any.
*/
parentSampled?: boolean;

/**
* Object representing the URL of the current page or worker script. Passed by default when using the `BrowserTracing`
* integration.
*/
location?: WorkerLocation;

/**
* Object representing the incoming request to a node server. Passed by default when using the TracingHandler.
*/
request?: ExtractedNodeRequestData;

/** The name of the span being sampled. */
name: string;

/** Initial attributes that have been passed to the span being sampled. */
attributes?: SpanAttributes;
}

/**
* Contains information about how the name of the transaction was determined. This will be used by the server to decide
* whether or not to scrub identifiers from the transaction name, or replace the entire name with a placeholder.
Expand Down
9 changes: 1 addition & 8 deletions packages/vercel-edge/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -73,12 +73,5 @@
"volta": {
"extends": "../../package.json"
},
"sideEffects": false,
"madge": {
"detectiveOptions": {
"ts": {
"skipTypeImports": true
}
}
}
"sideEffects": false
}
Loading
Loading