Cookie-based session management in Astro

Introduction

Cookie-based session management helps websites remember who you are by storing small data pieces in your browser. This way, you stay logged in or keep your preferences while browsing.

When you want users to stay logged in after they close and reopen the browser.

When you need to save user preferences like language or theme across pages.

When you want to track a user's activity during a visit without asking them to log in again.

When building a shopping cart that keeps items even if the user navigates away.

When you want to securely store session IDs to identify users on the server.

Syntax

Astro

import { getCookies, setCookie } from 'astro:cookies';

// To set a cookie
const cookieHeader = setCookie('sessionId', 'abc123', { path: '/', httpOnly: true, maxAge: 3600 });
// response.headers.append('Set-Cookie', cookieHeader);

// To get cookies
const cookies = getCookies();
const sessionId = cookies.get('sessionId');

setCookie returns a 'Set-Cookie' header string with options like httpOnly to keep it safe from JavaScript access and maxAge to set expiration time. Append it to response headers.

getCookies reads all cookies sent by the browser in the current request and returns a Map.

Examples

This sets a cookie named user with value Alice that lasts for one day.

Astro

setCookie('user', 'Alice', { path: '/', maxAge: 86400 });

This reads all cookies and prints the value of the user cookie.

Astro

const cookies = getCookies();
console.log(cookies.get('user'));

This sets a secure, HTTP-only cookie for session ID, which helps protect it from being accessed by scripts.

Astro

setCookie('sessionId', 'xyz789', { path: '/', httpOnly: true, secure: true });

Sample Program

This Astro server endpoint checks if a sessionId cookie exists. If not, it creates a new session ID, sets it as a cookie, and returns it in the response. This keeps track of the user session using cookies.

Astro

import { getCookies, setCookie } from 'astro:cookies';

export async function GET({ request }) {
  const cookies = getCookies(request.headers);
  let sessionId = cookies.get('sessionId');

  const headers = new Headers({ 'Content-Type': 'text/plain' });

  if (!sessionId) {
    sessionId = 'sess_' + Math.random().toString(36).slice(2);
    const cookieHeader = setCookie('sessionId', sessionId, { path: '/', httpOnly: true, maxAge: 3600 });
    headers.append('Set-Cookie', cookieHeader);
  }

  return new Response(`Your session ID is: ${sessionId}`, { headers });
}

Important Notes

Cookies set with httpOnly cannot be read by JavaScript, which improves security.

Always set the path option to control where the cookie is sent.

Use maxAge or expires to control how long the cookie lasts.

Summary

Cookies store small data in the browser to remember user sessions.

Astro provides setCookie and getCookies to manage cookies easily.

Secure cookies help protect session data from being stolen by scripts.

Practice

1. What is the main purpose of using cookies in cookie-based session management in Astro?

easy

A. To run server-side code faster

B. To store small pieces of data in the browser to remember user sessions

C. To style the webpage dynamically

D. To increase the size of the webpage

Solution

1. Step 1: Understand what cookies do

   Cookies store small data on the user's browser to keep track of information like sessions.

2. Step 2: Identify the role in session management

   Cookies help remember who the user is between page visits by storing session IDs or tokens.

3. Final Answer:

   To store small pieces of data in the browser to remember user sessions -> Option B

4. Quick Check:

   Cookies = store session data [OK]

Hint: Cookies remember user info in browser for sessions [OK]

Common Mistakes:

• Thinking cookies speed up server code
• Confusing cookies with styling tools
• Believing cookies increase webpage size

2. Which of the following is the correct way to set a cookie named sessionId with value abc123 in Astro?

easy

A. setCookie('sessionId', 'abc123')

B. setCookie('sessionId', abc123)

C. setCookie(sessionId, 'abc123')

D. setCookie('sessionId' = 'abc123')

Solution

1. Step 1: Check function usage

   Astro's setCookie takes the cookie name as a string and the value as a string.

2. Step 2: Validate syntax correctness

   setCookie('sessionId', 'abc123') correctly passes both arguments as strings, matching the expected syntax.

3. Final Answer:

   setCookie('sessionId', 'abc123') -> Option A

4. Quick Check:

   Correct string arguments = setCookie('sessionId', 'abc123') [OK]

Hint: Use quotes around both name and value strings [OK]

Common Mistakes:

• Omitting quotes around value
• Using variable without quotes for name
• Using assignment syntax inside function call

3. Given this Astro server code snippet:

import { setCookie, getCookies } from 'astro:cookies';

export async function get({ request }) {
  const cookies = getCookies(request);
  if (!cookies.user) {
    return new Response('No user cookie', { status: 401 });
  }
  setCookie('lastVisit', new Date().toISOString());
  return new Response(`Welcome back, ${cookies.user}!`);
}

What will be the response if the request has a cookie user=Alice?

medium

A. Error: setCookie requires response object

B. Welcome back, Alice!

C. No user cookie

D. Welcome back, undefined!

Solution

1. Step 1: Check cookie presence

   The code gets cookies from request and checks if cookies.user exists. With user=Alice, it passes the check.

2. Step 2: Identify the error in setCookie

   setCookie('lastVisit', new Date().toISOString()) lacks the required first Response argument, causing a runtime error before returning the greeting.

3. Final Answer:

   Error: setCookie requires response object -> Option A

4. Quick Check:

   setCookie(response, name, value) [OK]

Hint: setCookie requires Response as first argument [OK]

Common Mistakes:

• Overlooking incorrect setCookie usage
• Assuming greeting returns despite error
• Misreading cookie presence logic

4. Identify the error in this Astro code snippet for setting a secure cookie:

import { setCookie } from 'astro:cookies';

export async function post({ request }) {
  setCookie('session', 'xyz', { secure: true });
  return new Response('Session set');
}

medium

A. Missing await before setCookie

B. The cookie name cannot be 'session'

C. The secure option is invalid in Astro

D. setCookie must be called with the response object to attach cookie

Solution

1. Step 1: Understand setCookie usage

   In Astro, to set a cookie on the response, you must attach it to the response headers, not just call setCookie alone.

2. Step 2: Identify missing response handling

   The code calls setCookie but does not attach the cookie to the response, so the cookie won't be sent.

3. Final Answer:

   setCookie must be called with the response object to attach cookie -> Option D

4. Quick Check:

   Cookie needs response headers [OK]

Hint: Attach cookies to response headers to set them [OK]

Common Mistakes:

• Calling setCookie without response context
• Thinking secure option is unsupported
• Forgetting to return response with cookie

5. You want to create a cookie-based session in Astro that expires in 1 hour and is only sent over HTTPS. Which of the following code snippets correctly sets this cookie?

hard

A. setCookie('sessionId', 'abc123', { maxAge: 3600, secure: false })

B. setCookie('sessionId', 'abc123', { expires: new Date(Date.now() + 3600), secure: false })

C. setCookie('sessionId', 'abc123', { maxAge: 3600, secure: true, httpOnly: true })

D. setCookie('sessionId', 'abc123', { maxAge: 3600, secure: false, path: '/' })

Solution

1. Step 1: Check expiration setting

   To expire in 1 hour, use maxAge: 3600 (seconds). One option uses it correctly with secure: true; another uses incorrect expires value.

2. Step 2: Verify secure and httpOnly flags

   Secure must be true to send only over HTTPS. HttpOnly helps protect cookie from scripts.

3. Step 3: Compare options

   Options with secure: false or incorrect expires fail. The snippet with maxAge: 3600, secure: true, httpOnly: true satisfies expiration, HTTPS-only, and adds security.

4. Final Answer:

   setCookie('sessionId', 'abc123', { maxAge: 3600, secure: true, httpOnly: true }) -> Option C

5. Quick Check:

   Expire 1hr + secure + httpOnly = setCookie('sessionId', 'abc123', { maxAge: 3600, secure: true, httpOnly: true }) [OK]

Hint: Use maxAge in seconds, secure and httpOnly true [OK]

Common Mistakes:

• Using expires with wrong Date format
• Setting secure to false for HTTPS-only cookie
• Forgetting httpOnly for security