File size: 17,915 Bytes
fea495a | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 | import { HeadersAdapter } from '../web/spec-extension/adapters/headers';
import { workAsyncStorage } from '../app-render/work-async-storage.external';
import { throwForMissingRequestStore, workUnitAsyncStorage } from '../app-render/work-unit-async-storage.external';
import { postponeWithTracking, throwToInterruptStaticGeneration, trackDynamicDataInDynamicRender, trackSynchronousRequestDataAccessInDev } from '../app-render/dynamic-rendering';
import { StaticGenBailoutError } from '../../client/components/static-generation-bailout';
import { makeDevtoolsIOAwarePromise, makeHangingPromise } from '../dynamic-rendering-utils';
import { createDedupedByCallsiteServerErrorLoggerDev } from '../create-deduped-by-callsite-server-error-logger';
import { isRequestAPICallableInsideAfter } from './utils';
import { InvariantError } from '../../shared/lib/invariant-error';
import { ReflectAdapter } from '../web/spec-extension/adapters/reflect';
/**
* This function allows you to read the HTTP incoming request headers in
* [Server Components](https://nextjs.org/docs/app/building-your-application/rendering/server-components),
* [Server Actions](https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions-and-mutations),
* [Route Handlers](https://nextjs.org/docs/app/building-your-application/routing/route-handlers) and
* [Middleware](https://nextjs.org/docs/app/building-your-application/routing/middleware).
*
* Read more: [Next.js Docs: `headers`](https://nextjs.org/docs/app/api-reference/functions/headers)
*/ export function headers() {
const callingExpression = 'headers';
const workStore = workAsyncStorage.getStore();
const workUnitStore = workUnitAsyncStorage.getStore();
if (workStore) {
if (workUnitStore && workUnitStore.phase === 'after' && !isRequestAPICallableInsideAfter()) {
throw Object.defineProperty(new Error(`Route ${workStore.route} used "headers" inside "after(...)". This is not supported. If you need this data inside an "after" callback, use "headers" outside of the callback. See more info here: https://nextjs.org/docs/canary/app/api-reference/functions/after`), "__NEXT_ERROR_CODE", {
value: "E367",
enumerable: false,
configurable: true
});
}
if (workStore.forceStatic) {
// When using forceStatic we override all other logic and always just return an empty
// headers object without tracking
const underlyingHeaders = HeadersAdapter.seal(new Headers({}));
return makeUntrackedExoticHeaders(underlyingHeaders);
}
if (workUnitStore) {
switch(workUnitStore.type){
case 'cache':
{
const error = Object.defineProperty(new Error(`Route ${workStore.route} used "headers" inside "use cache". Accessing Dynamic data sources inside a cache scope is not supported. If you need this data inside a cached function use "headers" outside of the cached function and pass the required dynamic data in as an argument. See more info here: https://nextjs.org/docs/messages/next-request-in-use-cache`), "__NEXT_ERROR_CODE", {
value: "E304",
enumerable: false,
configurable: true
});
Error.captureStackTrace(error, headers);
workStore.invalidDynamicUsageError ??= error;
throw error;
}
case 'private-cache':
{
const error = Object.defineProperty(new Error(`Route ${workStore.route} used "headers" inside "use cache: private". Accessing "headers" inside a private cache scope is not supported. If you need this data inside a cached function use "headers" outside of the cached function and pass the required dynamic data in as an argument. See more info here: https://nextjs.org/docs/messages/next-request-in-use-cache`), "__NEXT_ERROR_CODE", {
value: "E742",
enumerable: false,
configurable: true
});
Error.captureStackTrace(error, headers);
workStore.invalidDynamicUsageError ??= error;
throw error;
}
case 'unstable-cache':
throw Object.defineProperty(new Error(`Route ${workStore.route} used "headers" inside a function cached with "unstable_cache(...)". Accessing Dynamic data sources inside a cache scope is not supported. If you need this data inside a cached function use "headers" outside of the cached function and pass the required dynamic data in as an argument. See more info here: https://nextjs.org/docs/app/api-reference/functions/unstable_cache`), "__NEXT_ERROR_CODE", {
value: "E127",
enumerable: false,
configurable: true
});
case 'prerender':
case 'prerender-client':
case 'prerender-runtime':
case 'prerender-ppr':
case 'prerender-legacy':
case 'request':
break;
default:
workUnitStore;
}
}
if (workStore.dynamicShouldError) {
throw Object.defineProperty(new StaticGenBailoutError(`Route ${workStore.route} with \`dynamic = "error"\` couldn't be rendered statically because it used \`headers\`. See more info here: https://nextjs.org/docs/app/building-your-application/rendering/static-and-dynamic#dynamic-rendering`), "__NEXT_ERROR_CODE", {
value: "E525",
enumerable: false,
configurable: true
});
}
if (workUnitStore) {
switch(workUnitStore.type){
case 'prerender':
case 'prerender-runtime':
return makeHangingHeaders(workStore, workUnitStore);
case 'prerender-client':
const exportName = '`headers`';
throw Object.defineProperty(new InvariantError(`${exportName} must not be used within a client component. Next.js should be preventing ${exportName} from being included in client components statically, but did not in this case.`), "__NEXT_ERROR_CODE", {
value: "E693",
enumerable: false,
configurable: true
});
case 'prerender-ppr':
// PPR Prerender (no cacheComponents)
// We are prerendering with PPR. We need track dynamic access here eagerly
// to keep continuity with how headers has worked in PPR without cacheComponents.
// TODO consider switching the semantic to throw on property access instead
return postponeWithTracking(workStore.route, callingExpression, workUnitStore.dynamicTracking);
case 'prerender-legacy':
// Legacy Prerender
// We are in a legacy static generation mode while prerendering
// We track dynamic access here so we don't need to wrap the headers in
// individual property access tracking.
return throwToInterruptStaticGeneration(callingExpression, workStore, workUnitStore);
case 'request':
trackDynamicDataInDynamicRender(workUnitStore);
if (process.env.NODE_ENV === 'development') {
// Semantically we only need the dev tracking when running in `next dev`
// but since you would never use next dev with production NODE_ENV we use this
// as a proxy so we can statically exclude this code from production builds.
if (process.env.__NEXT_CACHE_COMPONENTS) {
return makeUntrackedHeadersWithDevWarnings(workUnitStore.headers, workStore == null ? void 0 : workStore.route);
}
return makeUntrackedExoticHeadersWithDevWarnings(workUnitStore.headers, workStore == null ? void 0 : workStore.route);
} else {
if (process.env.__NEXT_CACHE_COMPONENTS) {
return makeUntrackedHeaders(workUnitStore.headers);
}
return makeUntrackedExoticHeaders(workUnitStore.headers);
}
break;
default:
workUnitStore;
}
}
}
// If we end up here, there was no work store or work unit store present.
throwForMissingRequestStore(callingExpression);
}
const CachedHeaders = new WeakMap();
function makeHangingHeaders(workStore, prerenderStore) {
const cachedHeaders = CachedHeaders.get(prerenderStore);
if (cachedHeaders) {
return cachedHeaders;
}
const promise = makeHangingPromise(prerenderStore.renderSignal, workStore.route, '`headers()`');
CachedHeaders.set(prerenderStore, promise);
return promise;
}
function makeUntrackedHeaders(underlyingHeaders) {
const cachedHeaders = CachedHeaders.get(underlyingHeaders);
if (cachedHeaders) {
return cachedHeaders;
}
const promise = Promise.resolve(underlyingHeaders);
CachedHeaders.set(underlyingHeaders, promise);
return promise;
}
function makeUntrackedExoticHeaders(underlyingHeaders) {
const cachedHeaders = CachedHeaders.get(underlyingHeaders);
if (cachedHeaders) {
return cachedHeaders;
}
const promise = Promise.resolve(underlyingHeaders);
CachedHeaders.set(underlyingHeaders, promise);
Object.defineProperties(promise, {
append: {
value: underlyingHeaders.append.bind(underlyingHeaders)
},
delete: {
value: underlyingHeaders.delete.bind(underlyingHeaders)
},
get: {
value: underlyingHeaders.get.bind(underlyingHeaders)
},
has: {
value: underlyingHeaders.has.bind(underlyingHeaders)
},
set: {
value: underlyingHeaders.set.bind(underlyingHeaders)
},
getSetCookie: {
value: underlyingHeaders.getSetCookie.bind(underlyingHeaders)
},
forEach: {
value: underlyingHeaders.forEach.bind(underlyingHeaders)
},
keys: {
value: underlyingHeaders.keys.bind(underlyingHeaders)
},
values: {
value: underlyingHeaders.values.bind(underlyingHeaders)
},
entries: {
value: underlyingHeaders.entries.bind(underlyingHeaders)
},
[Symbol.iterator]: {
value: underlyingHeaders[Symbol.iterator].bind(underlyingHeaders)
}
});
return promise;
}
function makeUntrackedExoticHeadersWithDevWarnings(underlyingHeaders, route) {
const cachedHeaders = CachedHeaders.get(underlyingHeaders);
if (cachedHeaders) {
return cachedHeaders;
}
const promise = makeDevtoolsIOAwarePromise(underlyingHeaders);
CachedHeaders.set(underlyingHeaders, promise);
Object.defineProperties(promise, {
append: {
value: function append() {
const expression = `\`headers().append(${describeNameArg(arguments[0])}, ...)\``;
syncIODev(route, expression);
return underlyingHeaders.append.apply(underlyingHeaders, arguments);
}
},
delete: {
value: function _delete() {
const expression = `\`headers().delete(${describeNameArg(arguments[0])})\``;
syncIODev(route, expression);
return underlyingHeaders.delete.apply(underlyingHeaders, arguments);
}
},
get: {
value: function get() {
const expression = `\`headers().get(${describeNameArg(arguments[0])})\``;
syncIODev(route, expression);
return underlyingHeaders.get.apply(underlyingHeaders, arguments);
}
},
has: {
value: function has() {
const expression = `\`headers().has(${describeNameArg(arguments[0])})\``;
syncIODev(route, expression);
return underlyingHeaders.has.apply(underlyingHeaders, arguments);
}
},
set: {
value: function set() {
const expression = `\`headers().set(${describeNameArg(arguments[0])}, ...)\``;
syncIODev(route, expression);
return underlyingHeaders.set.apply(underlyingHeaders, arguments);
}
},
getSetCookie: {
value: function getSetCookie() {
const expression = '`headers().getSetCookie()`';
syncIODev(route, expression);
return underlyingHeaders.getSetCookie.apply(underlyingHeaders, arguments);
}
},
forEach: {
value: function forEach() {
const expression = '`headers().forEach(...)`';
syncIODev(route, expression);
return underlyingHeaders.forEach.apply(underlyingHeaders, arguments);
}
},
keys: {
value: function keys() {
const expression = '`headers().keys()`';
syncIODev(route, expression);
return underlyingHeaders.keys.apply(underlyingHeaders, arguments);
}
},
values: {
value: function values() {
const expression = '`headers().values()`';
syncIODev(route, expression);
return underlyingHeaders.values.apply(underlyingHeaders, arguments);
}
},
entries: {
value: function entries() {
const expression = '`headers().entries()`';
syncIODev(route, expression);
return underlyingHeaders.entries.apply(underlyingHeaders, arguments);
}
},
[Symbol.iterator]: {
value: function() {
const expression = '`...headers()` or similar iteration';
syncIODev(route, expression);
return underlyingHeaders[Symbol.iterator].apply(underlyingHeaders, arguments);
}
}
});
return promise;
}
// Similar to `makeUntrackedExoticHeadersWithDevWarnings`, but just logging the
// sync access without actually defining the headers properties on the promise.
function makeUntrackedHeadersWithDevWarnings(underlyingHeaders, route) {
const cachedHeaders = CachedHeaders.get(underlyingHeaders);
if (cachedHeaders) {
return cachedHeaders;
}
const promise = makeDevtoolsIOAwarePromise(underlyingHeaders);
const proxiedPromise = new Proxy(promise, {
get (target, prop, receiver) {
switch(prop){
case Symbol.iterator:
{
warnForSyncAccess(route, '`...headers()` or similar iteration');
break;
}
case 'append':
case 'delete':
case 'get':
case 'has':
case 'set':
case 'getSetCookie':
case 'forEach':
case 'keys':
case 'values':
case 'entries':
{
warnForSyncAccess(route, `\`headers().${prop}\``);
break;
}
default:
{
// We only warn for well-defined properties of the headers object.
}
}
return ReflectAdapter.get(target, prop, receiver);
}
});
CachedHeaders.set(underlyingHeaders, proxiedPromise);
return proxiedPromise;
}
function describeNameArg(arg) {
return typeof arg === 'string' ? `'${arg}'` : '...';
}
function syncIODev(route, expression) {
const workUnitStore = workUnitAsyncStorage.getStore();
if (workUnitStore) {
switch(workUnitStore.type){
case 'request':
if (workUnitStore.prerenderPhase === true) {
// When we're rendering dynamically in dev, we need to advance out of
// the Prerender environment when we read Request data synchronously.
trackSynchronousRequestDataAccessInDev(workUnitStore);
}
break;
case 'prerender':
case 'prerender-client':
case 'prerender-runtime':
case 'prerender-ppr':
case 'prerender-legacy':
case 'cache':
case 'private-cache':
case 'unstable-cache':
break;
default:
workUnitStore;
}
}
// In all cases we warn normally
warnForSyncAccess(route, expression);
}
const warnForSyncAccess = createDedupedByCallsiteServerErrorLoggerDev(createHeadersAccessError);
function createHeadersAccessError(route, expression) {
const prefix = route ? `Route "${route}" ` : 'This route ';
return Object.defineProperty(new Error(`${prefix}used ${expression}. ` + `\`headers()\` should be awaited before using its value. ` + `Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis`), "__NEXT_ERROR_CODE", {
value: "E277",
enumerable: false,
configurable: true
});
}
//# sourceMappingURL=headers.js.map |