next
Version:
The React Framework
335 lines (334 loc) • 16.7 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", {
value: true
});
Object.defineProperty(exports, "headers", {
enumerable: true,
get: function() {
return headers;
}
});
const _headers = require("../web/spec-extension/adapters/headers");
const _workasyncstorageexternal = require("../app-render/work-async-storage.external");
const _workunitasyncstorageexternal = require("../app-render/work-unit-async-storage.external");
const _dynamicrendering = require("../app-render/dynamic-rendering");
const _staticgenerationbailout = require("../../client/components/static-generation-bailout");
const _dynamicrenderingutils = require("../dynamic-rendering-utils");
const _creatededupedbycallsiteservererrorlogger = require("../create-deduped-by-callsite-server-error-logger");
const _scheduler = require("../../lib/scheduler");
const _utils = require("./utils");
function headers() {
const workStore = _workasyncstorageexternal.workAsyncStorage.getStore();
const workUnitStore = _workunitasyncstorageexternal.workUnitAsyncStorage.getStore();
if (workStore) {
if (workUnitStore && workUnitStore.phase === 'after' && !(0, _utils.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 = _headers.HeadersAdapter.seal(new Headers({}));
return makeUntrackedExoticHeaders(underlyingHeaders);
}
if (workUnitStore) {
if (workUnitStore.type === 'cache') {
throw 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
});
} else if (workUnitStore.type === '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
});
}
}
if (workStore.dynamicShouldError) {
throw Object.defineProperty(new _staticgenerationbailout.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) {
if (workUnitStore.type === 'prerender') {
// dynamicIO Prerender
// We don't track dynamic access here because access will be tracked when you access
// one of the properties of the headers object.
return makeDynamicallyTrackedExoticHeaders(workStore.route, workUnitStore);
} else if (workUnitStore.type === 'prerender-ppr') {
// PPR Prerender (no dynamicIO)
// We are prerendering with PPR. We need track dynamic access here eagerly
// to keep continuity with how headers has worked in PPR without dynamicIO.
// TODO consider switching the semantic to throw on property access instead
(0, _dynamicrendering.postponeWithTracking)(workStore.route, 'headers', workUnitStore.dynamicTracking);
} else if (workUnitStore.type === '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.
(0, _dynamicrendering.throwToInterruptStaticGeneration)('headers', workStore, workUnitStore);
}
}
// We fall through to the dynamic context below but we still track dynamic access
// because in dev we can still error for things like using headers inside a cache context
(0, _dynamicrendering.trackDynamicDataInDynamicRender)(workStore, workUnitStore);
}
const requestStore = (0, _workunitasyncstorageexternal.getExpectedRequestStore)('headers');
if (process.env.NODE_ENV === 'development' && !(workStore == null ? void 0 : workStore.isPrefetchRequest)) {
return makeUntrackedExoticHeadersWithDevWarnings(requestStore.headers, workStore == null ? void 0 : workStore.route);
} else {
return makeUntrackedExoticHeaders(requestStore.headers);
}
}
const CachedHeaders = new WeakMap();
function makeDynamicallyTrackedExoticHeaders(route, prerenderStore) {
const cachedHeaders = CachedHeaders.get(prerenderStore);
if (cachedHeaders) {
return cachedHeaders;
}
const promise = (0, _dynamicrenderingutils.makeHangingPromise)(prerenderStore.renderSignal, '`headers()`');
CachedHeaders.set(prerenderStore, promise);
Object.defineProperties(promise, {
append: {
value: function append() {
const expression = `\`headers().append(${describeNameArg(arguments[0])}, ...)\``;
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
delete: {
value: function _delete() {
const expression = `\`headers().delete(${describeNameArg(arguments[0])})\``;
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
get: {
value: function get() {
const expression = `\`headers().get(${describeNameArg(arguments[0])})\``;
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
has: {
value: function has() {
const expression = `\`headers().has(${describeNameArg(arguments[0])})\``;
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
set: {
value: function set() {
const expression = `\`headers().set(${describeNameArg(arguments[0])}, ...)\``;
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
getSetCookie: {
value: function getSetCookie() {
const expression = '`headers().getSetCookie()`';
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
forEach: {
value: function forEach() {
const expression = '`headers().forEach(...)`';
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
keys: {
value: function keys() {
const expression = '`headers().keys()`';
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
values: {
value: function values() {
const expression = '`headers().values()`';
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
entries: {
value: function entries() {
const expression = '`headers().entries()`';
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
},
[Symbol.iterator]: {
value: function() {
const expression = '`headers()[Symbol.iterator]()`';
const error = createHeadersAccessError(route, expression);
(0, _dynamicrendering.abortAndThrowOnSynchronousRequestDataAccess)(route, expression, error, prerenderStore);
}
}
});
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 = new Promise((resolve)=>(0, _scheduler.scheduleImmediate)(()=>resolve(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;
}
function describeNameArg(arg) {
return typeof arg === 'string' ? `'${arg}'` : '...';
}
function syncIODev(route, expression) {
const workUnitStore = _workunitasyncstorageexternal.workUnitAsyncStorage.getStore();
if (workUnitStore && workUnitStore.type === 'request' && 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
const requestStore = workUnitStore;
(0, _dynamicrendering.trackSynchronousRequestDataAccessInDev)(requestStore);
}
// In all cases we warn normally
warnForSyncAccess(route, expression);
}
const warnForSyncAccess = (0, _creatededupedbycallsiteservererrorlogger.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