runtime.ts — astro Source File

Source Code

import { stringify as rawStringify, unflatten as rawUnflatten } from 'devalue';
import type { RuntimeMode } from '../../types/public/config.js';
import type { AstroCookieSetOptions, AstroCookies } from '../cookies/cookies.js';
import { SessionStorageInitError, SessionStorageSaveError } from '../errors/errors-data.js';
import { AstroError } from '../errors/index.js';
import type { SessionDriverFactory } from './types.js';
import type { SSRManifestSession } from '../app/types.js';
import { createStorage, type Storage } from 'unstorage';

export const PERSIST_SYMBOL = Symbol();

const DEFAULT_COOKIE_NAME = 'astro-session';
const VALID_COOKIE_REGEX = /^[\w-]+$/;

interface SessionEntry {
	data: any;
	expires?: number;
}

const unflatten: typeof rawUnflatten = (parsed, _) => {
	// Revive URL objects
	return rawUnflatten(parsed, {
		URL: (href) => new URL(href),
	});
};

const stringify: typeof rawStringify = (data, _) => {
	return rawStringify(data, {
		// Support URL objects
		URL: (val) => val instanceof URL && val.href,
	});
};

export class AstroSession {
	// The cookies object.
	#cookies: AstroCookies;
	// The session configuration.
	#config: Omit<SSRManifestSession, 'cookie'>;
	// The cookie config
	#cookieConfig?: AstroCookieSetOptions;
	// The cookie name
	#cookieName: string;
	// The unstorage object for the session driver.
	#storage: Storage | undefined;
	#data: Map<string, SessionEntry> | undefined;
	// The session ID. A v4 UUID.
	#sessionID: string | undefined;
	// Sessions to destroy. Needed because we won't have the old session ID after it's destroyed locally.
	#toDestroy = new Set<string>();
	// Session keys to delete. Used for partial data sets to avoid overwriting the deleted value.
	#toDelete = new Set<string>();
	// Whether the session is dirty and needs to be saved.
	#dirty = false;
	// Whether the session cookie has been set.
	#cookieSet = false;
	// The local data is "partial" if it has not been loaded from storage yet and only
	// contains values that have been set or deleted in-memory locally.
	// We do this to avoid the need to block on loading data when it is only being set.
	// When we load the data from storage, we need to merge it with the local partial data,
	// preserving in-memory changes and deletions.
// ... (406 more lines)