TS Decorator Metadata Missing — reflect-metadata Not Loaded

Diagnose TypeScript decorator parameter types being undefined because reflect-metadata polyfill is not imported before decorator usage.

intermediatedebuggingtsphase-16

Symptoms

Decorator metadata (design:paramtypes) is undefined at runtime even though emitDecoratorMetadata is true.
Error message: TypeError: Cannot read metadata — Reflect.getMetadata is not a function
Failure occurs intermittently or after a specific code path

Possible causes

The reflect-metadata polyfill is not imported at the top of the entry file.
emitDecoratorMetadata is enabled but the runtime lacks the Reflect.metadata implementation.
Environment or runtime version mismatch introduces the defect

Diagnosis steps

Reproduce the error in a minimal isolated test case

node -e "require('./repro')"

Interpretation

If the minimal case reproduces, the bug is in the logic itself, not the environment. If not, collect environment details.

Capture the full error stack trace and identify the originating line

Set NODE_OPTIONS=--stack-trace-limit=100 and run with verbose logging

Interpretation

The first frame in user code is the trigger. Compare against the expected execution path to find the divergence point.

Inspect the values of all variables at the failure point

Add console.log / debugger / breakpoint at the line before the throw

Interpretation

Check for undefined, null, wrong type, or unexpected shape. The error message tells you what was wrong; the variables tell you why.

Root cause

TypeScript emits metadata calls via Reflect.metadata, but the Reflect API is not built-in; the reflect-metadata polyfill must be imported first.

Fix

Add import "reflect-metadata" at the very top of the entry file, before any decorator usage.

Risk note

Applying the fix without understanding the root cause may mask the symptom and introduce a different defect. Always verify with the reproduction case.

Verify the fix

Inspect design:paramtypes metadata and confirm it contains the parameter types.

Symptom and Error Message

When running the TypeScript code, the runtime raises the following error:

TypeError: Cannot read metadata — Reflect.getMetadata is not a function

This error indicates that decorator metadata (design:paramtypes) is undefined at runtime even though emitdecoratormetadata is true. The error is reproducible and appears consistently once the triggering condition is met. In production, you may see this error sporadically because the triggering condition depends on runtime state that is not always present.

Root Cause Analysis

The fundamental cause is: typescript emits metadata calls via reflect.metadata, but the reflect api is not built-in; the reflect-metadata polyfill must be imported first. Two factors converge to produce the visible error. First, the reflect-metadata polyfill is not imported at the top of the entry file. Second, emitdecoratormetadata is enabled but the runtime lacks the reflect.metadata implementation. Either factor alone might not trigger the error, but together they create the conditions for failure.

Diagnosis Walkthrough

Start by reproducing the error in isolation. Strip away everything except the minimum code path that triggers the error. Once you have a minimal reproduction, inspect every variable at the failure point. Look for: undefined where an object is expected, wrong types, stale references, and off-by-one indices. The error message tells you what went wrong; the surrounding state tells you why.

Fix and Code Example

// Before (buggy)
// ... code that triggers the error ...

// After (fixed)
// ... corrected code with proper guard or type check ...

The fix addresses the root cause directly: add import “reflect-metadata” at the very top of the entry file, before any decorator usage. After applying the fix, the error no longer occurs because the triggering condition is either prevented or handled gracefully.

Verification

Inspect design:paramtypes metadata and confirm it contains the parameter types. Run the reproduction case again and confirm the error is gone. Then run the full test suite to check for regressions. In production, monitor error logs for 24 hours to confirm the fix is effective under real load.

Common Pitfalls

A frequent mistake is to suppress the error with a try/catch or conditional without addressing the underlying cause. This masks the symptom but the defective logic remains, and the error will resurface in a different form. Always fix the root cause, not just the error message. Another pitfall is fixing the symptom only in the happy path while ignoring edge cases like empty input, null values, or concurrent access.