refactor: remove factory function

It can just be done explicitly by anything that needs it Signed-off-by: nkomonen-amazon <[email protected]>
aws · Nov 15, 2024 · c3d68bf · c3d68bf
1 parent 217e2a0
commit c3d68bf
Show file tree

Hide file tree

Showing 3 changed files with 1 addition and 49 deletions.
diff --git a/docs/telemetry.md b/docs/telemetry.md
@@ -229,8 +229,6 @@ thisThrows()
 
 ### Important Notes
 
--   You can avoid redundancy when repeating fields like `class` in `@withTelemetryContext` by using `withTelemetryContextFactory()`. It builds a new decorator with pre-defined values that you choose.
-
 -   If a nested function does not use a `run()` then it will not be part of the call stack.
 
     ```typescript

diff --git a/packages/core/src/shared/telemetry/util.ts b/packages/core/src/shared/telemetry/util.ts
@@ -452,11 +452,3 @@ export function withTelemetryContext(opts: TelemetryContextArgs) {
         })
     }
 }
-
-/**
- * Returns a custom {@link withTelemetryContext} decorator, but with some values predefined
- * to deduplicate boilerplate for a class that will use this decorator multiple times.
- */
-export function withTelemetryContextFactory(predefinedOpts: Omit<TelemetryContextArgs, 'name'>) {
-    return (opts: TelemetryContextArgs) => withTelemetryContext({ ...predefinedOpts, ...opts })
-}
diff --git a/packages/core/src/test/shared/telemetry/spans.test.ts b/packages/core/src/test/shared/telemetry/spans.test.ts
@@ -11,7 +11,7 @@ import { assertTelemetry, getMetrics, installFakeClock } from '../../testUtil'
 import { selectFrom } from '../../../shared/utilities/tsUtils'
 import { getAwsServiceError } from '../errors.test'
 import { sleep } from '../../../shared'
-import { withTelemetryContext, withTelemetryContextFactory } from '../../../shared/telemetry/util'
+import { withTelemetryContext } from '../../../shared/telemetry/util'
 import { SinonSandbox } from 'sinon'
 import sinon from 'sinon'
 import * as crypto from '../../../shared/crypto'
@@ -682,44 +682,6 @@ describe('TelemetryTracer', function () {
                 (e) => e === arbitraryError
             )
         })
-
-        const customWithTelemetryContext = withTelemetryContextFactory({ class: 'TestCustomContext', emit: true })
-
-        class TestCustomContext {
-            @customWithTelemetryContext({ name: 'testMethod' })
-            testMethod() {
-                return
-            }
-
-            @customWithTelemetryContext({ name: 'overridesTheClass', class: 'Overidden' })
-            overridesTheClass() {
-                return
-            }
-        }
-
-        it('Uses predefined context', function () {
-            const inst = new TestCustomContext()
-            inst.testMethod()
-            assertTelemetry('function_call', [
-                {
-                    functionName: 'testMethod',
-                    className: 'TestCustomContext',
-                    source: 'TestCustomContext#testMethod',
-                },
-            ])
-        })
-
-        it('can override the predefined context', function () {
-            const inst = new TestCustomContext()
-            inst.overridesTheClass()
-            assertTelemetry('function_call', [
-                {
-                    functionName: 'overridesTheClass',
-                    className: 'Overidden',
-                    source: 'Overidden#overridesTheClass',
-                },
-            ])
-        })
     })
 
     describe('withTraceId()', function () {