s/getTracingMetaTags/getTraceMetaTags

getsentry · Aug 5, 2024 · 1fcd07b · 1fcd07b
1 parent 478c23b
commit 1fcd07b
Show file tree

Hide file tree

Showing 15 changed files with 26 additions and 24 deletions.
diff --git a/dev-packages/node-integration-tests/suites/tracing/meta-tags/server.js b/dev-packages/node-integration-tests/suites/tracing/meta-tags/server.js
@@ -18,7 +18,7 @@ app.get('/test', (_req, res) => {
     response: `
     <html>
       <head>
-        ${Sentry.getTracingMetaTags()}
+        ${Sentry.getTraceMetaTags()}
       </head>
       <body>
         Hi :)

diff --git a/dev-packages/node-integration-tests/suites/tracing/meta-tags/test.ts b/dev-packages/node-integration-tests/suites/tracing/meta-tags/test.ts
@@ -1,6 +1,6 @@
 import { cleanupChildProcesses, createRunner } from '../../../utils/runner';
 
-describe('getTracingMetaTags', () => {
+describe('getTraceMetaTags', () => {
   afterAll(() => {
     cleanupChildProcesses();
   });

diff --git a/packages/astro/src/server/middleware.ts b/packages/astro/src/server/middleware.ts
@@ -6,7 +6,7 @@ import {
   getActiveSpan,
   getClient,
   getCurrentScope,
-  getTracingMetaTags,
+  getTraceMetaTags,
   setHttpStatus,
   startSpan,
   withIsolationScope,
@@ -15,8 +15,6 @@ import type { Client, Scope, Span, SpanAttributes } from '@sentry/types';
 import { addNonEnumerableProperty, objectify, stripUrlQueryAndFragment } from '@sentry/utils';
 import type { APIContext, MiddlewareResponseHandler } from 'astro';
 
-import { getTraceData } from '@sentry/node';
-
 type MiddlewareOptions = {
   /**
    * If true, the client IP will be attached to the event by calling `setUser`.
@@ -190,7 +188,7 @@ function addMetaTagToHead(htmlChunk: string, scope: Scope, client: Client, span?
   if (typeof htmlChunk !== 'string') {
     return htmlChunk;
   }
-  const metaTags = getTracingMetaTags(span, scope, client);
+  const metaTags = getTraceMetaTags(span, scope, client);
 
   if (!metaTags) {
     return htmlChunk;

diff --git a/packages/astro/test/server/middleware.test.ts b/packages/astro/test/server/middleware.test.ts
@@ -34,7 +34,7 @@ describe('sentryMiddleware', () => {
     });
     vi.spyOn(SentryNode, 'getActiveSpan').mockImplementation(getSpanMock);
     vi.spyOn(SentryNode, 'getClient').mockImplementation(() => ({}) as Client);
-    vi.spyOn(SentryNode, 'getTracingMetaTags').mockImplementation(
+    vi.spyOn(SentryNode, 'getTraceMetaTags').mockImplementation(
       () => `
     <meta name="sentry-trace" content="123">
     <meta name="baggage" content="abc">

diff --git a/packages/aws-serverless/src/index.ts b/packages/aws-serverless/src/index.ts
@@ -21,7 +21,7 @@ export {
   getGlobalScope,
   getIsolationScope,
   getTraceData,
-  getTracingMetaTags,
+  getTraceMetaTags,
   setCurrentClient,
   Scope,
   SDK_VERSION,

diff --git a/packages/bun/src/index.ts b/packages/bun/src/index.ts
@@ -41,7 +41,7 @@ export {
   getGlobalScope,
   getIsolationScope,
   getTraceData,
-  getTracingMetaTags,
+  getTraceMetaTags,
   setCurrentClient,
   Scope,
   SDK_VERSION,

diff --git a/packages/cloudflare/src/index.ts b/packages/cloudflare/src/index.ts
@@ -56,7 +56,7 @@ export {
   getActiveSpan,
   getRootSpan,
   getTraceData,
-  getTracingMetaTags,
+  getTraceMetaTags,
   startSpan,
   startInactiveSpan,
   startSpanManual,

diff --git a/packages/core/src/index.ts b/packages/core/src/index.ts
@@ -83,7 +83,7 @@ export {
 export { parseSampleRate } from './utils/parseSampleRate';
 export { applySdkMetadata } from './utils/sdkMetadata';
 export { getTraceData } from './utils/traceData';
-export { getTracingMetaTags } from './utils/meta';
+export { getTraceMetaTags } from './utils/meta';
 export { DEFAULT_ENVIRONMENT } from './constants';
 export { addBreadcrumb } from './breadcrumbs';
 export { functionToStringIntegration } from './integrations/functiontostring';

diff --git a/packages/core/src/utils/meta.ts b/packages/core/src/utils/meta.ts
@@ -2,24 +2,28 @@ import type { Client, Scope, Span } from '@sentry/types';
 import { getTraceData } from './traceData';
 
 /**
- * Returns a string of meta tags that represent the tracing data.
+ * Returns a string of meta tags that represent the current trace data.
  *
  * You can use this to propagate a trace from your server-side rendered Html to the browser.
+ * This function returns up to two meta tags, `sentry-trace` and `baggage`, depending on the
+ * current trace data state.
+ *
+ * @example
  * Usage example:
  *
  * ```js
  * function renderHtml() {
  *   return `
  *     <head>
- *       ${getTracingMetaTags()}
+ *       ${getTraceMetaTags()}
  *     </head>
  *   `;
  * }
  * ```
  *
  * @returns
  */
-export function getTracingMetaTags(span?: Span, scope?: Scope, client?: Client): string {
+export function getTraceMetaTags(span?: Span, scope?: Scope, client?: Client): string {
   return Object.entries(getTraceData(span, scope, client))
     .map(([key, value]) => `<meta name="${key}" content="${value}"/>`)
     .join('\n');

diff --git a/packages/core/test/lib/utils/meta.test.ts b/packages/core/test/lib/utils/meta.test.ts
@@ -1,14 +1,14 @@
-import { getTracingMetaTags } from '../../../src/utils/meta';
+import { getTraceMetaTags } from '../../../src/utils/meta';
 import * as TraceDataModule from '../../../src/utils/traceData';
 
-describe('getTracingMetaTags', () => {
+describe('getTraceMetaTags', () => {
   it('renders baggage and sentry-trace values to stringified Html meta tags', () => {
     jest.spyOn(TraceDataModule, 'getTraceData').mockReturnValueOnce({
       'sentry-trace': '12345678901234567890123456789012-1234567890123456-1',
       baggage: 'sentry-environment=production',
     });
 
-    expect(getTracingMetaTags()).toBe(`<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>
+    expect(getTraceMetaTags()).toBe(`<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>
 <meta name="baggage" content="sentry-environment=production"/>`);
   });
 
@@ -17,14 +17,14 @@ describe('getTracingMetaTags', () => {
       'sentry-trace': '12345678901234567890123456789012-1234567890123456-1',
     });
 
-    expect(getTracingMetaTags()).toBe(
+    expect(getTraceMetaTags()).toBe(
       '<meta name="sentry-trace" content="12345678901234567890123456789012-1234567890123456-1"/>',
     );
   });
 
   it('returns an empty string if neither sentry-trace nor baggage values are available', () => {
     jest.spyOn(TraceDataModule, 'getTraceData').mockReturnValueOnce({});
 
-    expect(getTracingMetaTags()).toBe('');
+    expect(getTraceMetaTags()).toBe('');
   });
 });
diff --git a/packages/deno/src/index.ts b/packages/deno/src/index.ts
@@ -56,7 +56,7 @@ export {
   getActiveSpan,
   getRootSpan,
   getTraceData,
-  getTracingMetaTags,
+  getTraceMetaTags,
   startSpan,
   startInactiveSpan,
   startSpanManual,

diff --git a/packages/google-cloud-serverless/src/index.ts b/packages/google-cloud-serverless/src/index.ts
@@ -21,7 +21,7 @@ export {
   getGlobalScope,
   getIsolationScope,
   getTraceData,
-  getTracingMetaTags,
+  getTraceMetaTags,
   setCurrentClient,
   Scope,
   SDK_VERSION,

diff --git a/packages/node/src/index.ts b/packages/node/src/index.ts
@@ -96,7 +96,7 @@ export {
   getCurrentScope,
   getIsolationScope,
   getTraceData,
-  getTracingMetaTags,
+  getTraceMetaTags,
   withScope,
   withIsolationScope,
   captureException,

diff --git a/packages/sveltekit/src/server/index.ts b/packages/sveltekit/src/server/index.ts
@@ -52,7 +52,7 @@ export {
   getSpanDescendants,
   getSpanStatusFromHttpCode,
   getTraceData,
-  getTracingMetaTags,
+  getTraceMetaTags,
   graphqlIntegration,
   hapiIntegration,
   httpIntegration,

diff --git a/packages/vercel-edge/src/index.ts b/packages/vercel-edge/src/index.ts
@@ -56,7 +56,7 @@ export {
   getActiveSpan,
   getRootSpan,
   getTraceData,
-  getTracingMetaTags,
+  getTraceMetaTags,
   startSpan,
   startInactiveSpan,
   startSpanManual,