next
Version:
The React Framework
364 lines (363 loc) • 18.6 kB
JavaScript
import { areCookiesMutableInCurrentPhase, RequestCookiesAdapter } from '../web/spec-extension/adapters/request-cookies';
import { RequestCookies } from '../web/spec-extension/cookies';
import { workAsyncStorage } from '../app-render/work-async-storage.external';
import { workUnitAsyncStorage } from '../app-render/work-unit-async-storage.external';
import { postponeWithTracking, throwToInterruptStaticGeneration, trackDynamicDataInDynamicRender, trackSynchronousRequestDataAccessInDev } from '../app-render/dynamic-rendering';
import { getExpectedRequestStore } from '../app-render/work-unit-async-storage.external';
import { StaticGenBailoutError } from '../../client/components/static-generation-bailout';
import { makeHangingPromise } from '../dynamic-rendering-utils';
import { createDedupedByCallsiteServerErrorLoggerDev } from '../create-deduped-by-callsite-server-error-logger';
import { scheduleImmediate } from '../../lib/scheduler';
import { isRequestAPICallableInsideAfter } from './utils';
import { InvariantError } from '../../shared/lib/invariant-error';
import { ReflectAdapter } from '../web/spec-extension/adapters/reflect';
export function cookies() {
const callingExpression = 'cookies';
const workStore = workAsyncStorage.getStore();
const workUnitStore = workUnitAsyncStorage.getStore();
if (workStore) {
if (workUnitStore && workUnitStore.phase === 'after' && !isRequestAPICallableInsideAfter()) {
throw Object.defineProperty(new Error(// TODO(after): clarify that this only applies to pages?
`Route ${workStore.route} used "cookies" inside "after(...)". This is not supported. If you need this data inside an "after" callback, use "cookies" outside of the callback. See more info here: https://nextjs.org/docs/canary/app/api-reference/functions/after`), "__NEXT_ERROR_CODE", {
value: "E88",
enumerable: false,
configurable: true
});
}
if (workStore.forceStatic) {
// When using forceStatic we override all other logic and always just return an empty
// cookies object without tracking
const underlyingCookies = createEmptyCookies();
return makeUntrackedExoticCookies(underlyingCookies);
}
if (workUnitStore) {
if (workUnitStore.type === 'cache') {
throw Object.defineProperty(new Error(`Route ${workStore.route} used "cookies" inside "use cache". Accessing Dynamic data sources inside a cache scope is not supported. If you need this data inside a cached function use "cookies" 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: "E398",
enumerable: false,
configurable: true
});
} else if (workUnitStore.type === 'unstable-cache') {
throw Object.defineProperty(new Error(`Route ${workStore.route} used "cookies" 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 "cookies" 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: "E157",
enumerable: false,
configurable: true
});
}
}
if (workStore.dynamicShouldError) {
throw Object.defineProperty(new StaticGenBailoutError(`Route ${workStore.route} with \`dynamic = "error"\` couldn't be rendered statically because it used \`cookies\`. See more info here: https://nextjs.org/docs/app/building-your-application/rendering/static-and-dynamic#dynamic-rendering`), "__NEXT_ERROR_CODE", {
value: "E549",
enumerable: false,
configurable: true
});
}
if (workUnitStore) {
switch(workUnitStore.type){
case 'prerender':
return makeHangingCookies(workUnitStore);
case 'prerender-client':
const exportName = '`cookies`';
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 dynamicIO)
// We are prerendering with PPR. We need track dynamic access here eagerly
// to keep continuity with how cookies has worked in PPR without dynamicIO.
postponeWithTracking(workStore.route, callingExpression, workUnitStore.dynamicTracking);
break;
case 'prerender-legacy':
// Legacy Prerender
// We track dynamic access here so we don't need to wrap the cookies in
// individual property access tracking.
throwToInterruptStaticGeneration(callingExpression, workStore, workUnitStore);
break;
default:
}
}
// 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 cookies inside a cache context
trackDynamicDataInDynamicRender(workStore, workUnitStore);
}
// cookies is being called in a dynamic context
const requestStore = getExpectedRequestStore(callingExpression);
let underlyingCookies;
if (areCookiesMutableInCurrentPhase(requestStore)) {
// We can't conditionally return different types here based on the context.
// To avoid confusion, we always return the readonly type here.
underlyingCookies = requestStore.userspaceMutableCookies;
} else {
underlyingCookies = requestStore.cookies;
}
if (process.env.NODE_ENV === 'development' && !(workStore == null ? void 0 : workStore.isPrefetchRequest)) {
if (process.env.__NEXT_DYNAMIC_IO) {
return makeUntrackedCookiesWithDevWarnings(underlyingCookies, workStore == null ? void 0 : workStore.route);
}
return makeUntrackedExoticCookiesWithDevWarnings(underlyingCookies, workStore == null ? void 0 : workStore.route);
} else {
return makeUntrackedExoticCookies(underlyingCookies);
}
}
function createEmptyCookies() {
return RequestCookiesAdapter.seal(new RequestCookies(new Headers({})));
}
const CachedCookies = new WeakMap();
function makeHangingCookies(prerenderStore) {
const cachedPromise = CachedCookies.get(prerenderStore);
if (cachedPromise) {
return cachedPromise;
}
const promise = makeHangingPromise(prerenderStore.renderSignal, '`cookies()`');
CachedCookies.set(prerenderStore, promise);
return promise;
}
function makeUntrackedExoticCookies(underlyingCookies) {
const cachedCookies = CachedCookies.get(underlyingCookies);
if (cachedCookies) {
return cachedCookies;
}
const promise = Promise.resolve(underlyingCookies);
CachedCookies.set(underlyingCookies, promise);
Object.defineProperties(promise, {
[Symbol.iterator]: {
value: underlyingCookies[Symbol.iterator] ? underlyingCookies[Symbol.iterator].bind(underlyingCookies) : // We should remove this and unify our cookies types. We could just let this continue to throw lazily
// but that's already a hard thing to debug so we may as well implement it consistently. The biggest problem with
// implementing this in this way is the underlying cookie type is a ResponseCookie and not a RequestCookie and so it
// has extra properties not available on RequestCookie instances.
polyfilledResponseCookiesIterator.bind(underlyingCookies)
},
size: {
get () {
return underlyingCookies.size;
}
},
get: {
value: underlyingCookies.get.bind(underlyingCookies)
},
getAll: {
value: underlyingCookies.getAll.bind(underlyingCookies)
},
has: {
value: underlyingCookies.has.bind(underlyingCookies)
},
set: {
value: underlyingCookies.set.bind(underlyingCookies)
},
delete: {
value: underlyingCookies.delete.bind(underlyingCookies)
},
clear: {
value: // @ts-expect-error clear is defined in RequestCookies implementation but not in the type
typeof underlyingCookies.clear === 'function' ? underlyingCookies.clear.bind(underlyingCookies) : // We should remove this and unify our cookies types. We could just let this continue to throw lazily
// but that's already a hard thing to debug so we may as well implement it consistently. The biggest problem with
// implementing this in this way is the underlying cookie type is a ResponseCookie and not a RequestCookie and so it
// has extra properties not available on RequestCookie instances.
polyfilledResponseCookiesClear.bind(underlyingCookies, promise)
},
toString: {
value: underlyingCookies.toString.bind(underlyingCookies)
}
});
return promise;
}
function makeUntrackedExoticCookiesWithDevWarnings(underlyingCookies, route) {
const cachedCookies = CachedCookies.get(underlyingCookies);
if (cachedCookies) {
return cachedCookies;
}
const promise = new Promise((resolve)=>scheduleImmediate(()=>resolve(underlyingCookies)));
CachedCookies.set(underlyingCookies, promise);
Object.defineProperties(promise, {
[Symbol.iterator]: {
value: function() {
const expression = '`...cookies()` or similar iteration';
syncIODev(route, expression);
return underlyingCookies[Symbol.iterator] ? underlyingCookies[Symbol.iterator].apply(underlyingCookies, arguments) : // We should remove this and unify our cookies types. We could just let this continue to throw lazily
// but that's already a hard thing to debug so we may as well implement it consistently. The biggest problem with
// implementing this in this way is the underlying cookie type is a ResponseCookie and not a RequestCookie and so it
// has extra properties not available on RequestCookie instances.
polyfilledResponseCookiesIterator.call(underlyingCookies);
},
writable: false
},
size: {
get () {
const expression = '`cookies().size`';
syncIODev(route, expression);
return underlyingCookies.size;
}
},
get: {
value: function get() {
let expression;
if (arguments.length === 0) {
expression = '`cookies().get()`';
} else {
expression = `\`cookies().get(${describeNameArg(arguments[0])})\``;
}
syncIODev(route, expression);
return underlyingCookies.get.apply(underlyingCookies, arguments);
},
writable: false
},
getAll: {
value: function getAll() {
let expression;
if (arguments.length === 0) {
expression = '`cookies().getAll()`';
} else {
expression = `\`cookies().getAll(${describeNameArg(arguments[0])})\``;
}
syncIODev(route, expression);
return underlyingCookies.getAll.apply(underlyingCookies, arguments);
},
writable: false
},
has: {
value: function get() {
let expression;
if (arguments.length === 0) {
expression = '`cookies().has()`';
} else {
expression = `\`cookies().has(${describeNameArg(arguments[0])})\``;
}
syncIODev(route, expression);
return underlyingCookies.has.apply(underlyingCookies, arguments);
},
writable: false
},
set: {
value: function set() {
let expression;
if (arguments.length === 0) {
expression = '`cookies().set()`';
} else {
const arg = arguments[0];
if (arg) {
expression = `\`cookies().set(${describeNameArg(arg)}, ...)\``;
} else {
expression = '`cookies().set(...)`';
}
}
syncIODev(route, expression);
return underlyingCookies.set.apply(underlyingCookies, arguments);
},
writable: false
},
delete: {
value: function() {
let expression;
if (arguments.length === 0) {
expression = '`cookies().delete()`';
} else if (arguments.length === 1) {
expression = `\`cookies().delete(${describeNameArg(arguments[0])})\``;
} else {
expression = `\`cookies().delete(${describeNameArg(arguments[0])}, ...)\``;
}
syncIODev(route, expression);
return underlyingCookies.delete.apply(underlyingCookies, arguments);
},
writable: false
},
clear: {
value: function clear() {
const expression = '`cookies().clear()`';
syncIODev(route, expression);
// @ts-ignore clear is defined in RequestCookies implementation but not in the type
return typeof underlyingCookies.clear === 'function' ? underlyingCookies.clear.apply(underlyingCookies, arguments) : // We should remove this and unify our cookies types. We could just let this continue to throw lazily
// but that's already a hard thing to debug so we may as well implement it consistently. The biggest problem with
// implementing this in this way is the underlying cookie type is a ResponseCookie and not a RequestCookie and so it
// has extra properties not available on RequestCookie instances.
polyfilledResponseCookiesClear.call(underlyingCookies, promise);
},
writable: false
},
toString: {
value: function toString() {
const expression = '`cookies().toString()` or implicit casting';
syncIODev(route, expression);
return underlyingCookies.toString.apply(underlyingCookies, arguments);
},
writable: false
}
});
return promise;
}
// Similar to `makeUntrackedExoticCookiesWithDevWarnings`, but just logging the
// sync access without actually defining the cookies properties on the promise.
function makeUntrackedCookiesWithDevWarnings(underlyingCookies, route) {
const cachedCookies = CachedCookies.get(underlyingCookies);
if (cachedCookies) {
return cachedCookies;
}
const promise = new Promise((resolve)=>scheduleImmediate(()=>resolve(underlyingCookies)));
const proxiedPromise = new Proxy(promise, {
get (target, prop, receiver) {
switch(prop){
case Symbol.iterator:
{
warnForSyncAccess(route, '`...cookies()` or similar iteration');
break;
}
case 'size':
case 'get':
case 'getAll':
case 'has':
case 'set':
case 'delete':
case 'clear':
case 'toString':
{
warnForSyncAccess(route, `\`cookies().${prop}\``);
break;
}
default:
{
// We only warn for well-defined properties of the cookies object.
}
}
return ReflectAdapter.get(target, prop, receiver);
}
});
CachedCookies.set(underlyingCookies, proxiedPromise);
return proxiedPromise;
}
function describeNameArg(arg) {
return typeof arg === 'object' && arg !== null && typeof arg.name === 'string' ? `'${arg.name}'` : typeof arg === 'string' ? `'${arg}'` : '...';
}
function syncIODev(route, expression) {
const workUnitStore = 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;
trackSynchronousRequestDataAccessInDev(requestStore);
}
// In all cases we warn normally
warnForSyncAccess(route, expression);
}
const warnForSyncAccess = createDedupedByCallsiteServerErrorLoggerDev(createCookiesAccessError);
function createCookiesAccessError(route, expression) {
const prefix = route ? `Route "${route}" ` : 'This route ';
return Object.defineProperty(new Error(`${prefix}used ${expression}. ` + `\`cookies()\` should be awaited before using its value. ` + `Learn more: https://nextjs.org/docs/messages/sync-dynamic-apis`), "__NEXT_ERROR_CODE", {
value: "E223",
enumerable: false,
configurable: true
});
}
function polyfilledResponseCookiesIterator() {
return this.getAll().map((c)=>[
c.name,
c
]).values();
}
function polyfilledResponseCookiesClear(returnable) {
for (const cookie of this.getAll()){
this.delete(cookie.name);
}
return returnable;
}
//# sourceMappingURL=cookies.js.map