Auth state change listeners in Supabase

Introduction

Auth state change listeners help your app know when a user logs in or out. This way, your app can update what it shows without needing a refresh.

When you want to show a welcome message after a user logs in.

When you need to hide or show parts of your app based on user login status.

When you want to automatically redirect users after they log out.

When you want to keep the app in sync with the user's authentication state.

When you want to update user-specific data immediately after login.

Syntax

Supabase

const { data: authListener } = supabase.auth.onAuthStateChange((event, session) => {
  // Your code here
});

The event tells you what happened, like 'SIGNED_IN' or 'SIGNED_OUT'.

The session contains user info if logged in, or null if logged out.

Examples

This listens only for sign-in events and logs the user's email.

Supabase

const { data: authListener } = supabase.auth.onAuthStateChange((event, session) => {
  if (event === 'SIGNED_IN') {
    console.log('User signed in:', session.user.email);
  }
});

This listens only for sign-out events and logs a message.

Supabase

const { data: authListener } = supabase.auth.onAuthStateChange((event, session) => {
  if (event === 'SIGNED_OUT') {
    console.log('User signed out');
  }
});

This listens to all auth events and logs the event type and session info.

Supabase

const { data: authListener } = supabase.auth.onAuthStateChange((event, session) => {
  console.log('Auth event:', event);
  console.log('Session:', session);
});

Sample Program

This program sets up a listener for authentication state changes using Supabase. It logs when a user signs in or out. It runs for 60 seconds before stopping the listener.

Supabase

import { createClient } from '@supabase/supabase-js';

const supabaseUrl = 'https://xyzcompany.supabase.co';
const supabaseKey = 'public-anonymous-key';
const supabase = createClient(supabaseUrl, supabaseKey);

console.log('Starting auth listener...');

const { data: authListener } = supabase.auth.onAuthStateChange((event, session) => {
  console.log(`Auth event detected: ${event}`);
  if (event === 'SIGNED_IN' && session) {
    console.log(`User signed in: ${session.user.email}`);
  } else if (event === 'SIGNED_OUT') {
    console.log('User signed out');
  } else {
    console.log('Other auth event or no session');
  }
});

// Simulate waiting for auth events
setTimeout(() => {
  console.log('Stopping auth listener...');
  authListener.subscription.unsubscribe();
}, 60000);

Important Notes

The listener runs in the background and triggers your code whenever the auth state changes.

Remember to unsubscribe the listener when it is no longer needed to avoid memory leaks.

Time complexity is minimal since it reacts only to events, not polling.

Summary

Auth state change listeners keep your app updated with user login status.

Use them to show or hide content based on whether a user is signed in.

Always unsubscribe listeners when done to keep your app efficient.

Practice

1. What is the main purpose of an auth state change listener in Supabase?

easy

A. To send emails to users automatically

B. To store user data permanently in the database

C. To detect when a user logs in or logs out and update the app accordingly

D. To encrypt user passwords before login

Solution

1. Step 1: Understand auth state change listener role

   An auth state change listener watches for user login or logout events.

2. Step 2: Identify its main use in app behavior

   It updates the app UI or logic based on whether the user is signed in or out.

3. Final Answer:

   To detect when a user logs in or logs out and update the app accordingly -> Option C

4. Quick Check:

   Auth listener updates app on login/logout [OK]

Hint: Auth listeners track login/logout to update app UI [OK]

Common Mistakes:

• Thinking it sends emails automatically
• Confusing with data storage functions
• Assuming it encrypts passwords

2. Which of the following is the correct way to subscribe to auth state changes in Supabase?

easy

A. supabase.auth.subscribe((event, session) => { /* handler */ })

B. supabase.auth.onAuthStateChange((event, session) => { /* handler */ })

C. supabase.auth.listenAuthChange((event, session) => { /* handler */ })

D. supabase.auth.watchStateChange((event, session) => { /* handler */ })

Solution

1. Step 1: Recall Supabase auth listener method

   The correct method to listen for auth changes is onAuthStateChange.

2. Step 2: Verify method signature

   It takes a callback with parameters event and session.

3. Final Answer:

   supabase.auth.onAuthStateChange((event, session) => { /* handler */ }) -> Option B

4. Quick Check:

   Use onAuthStateChange for auth listeners [OK]

Hint: Use onAuthStateChange method to listen auth events [OK]

Common Mistakes:

• Using non-existent methods like listenAuthChange
• Confusing subscribe or watchStateChange methods
• Incorrect callback parameters

3. What will be logged by this code snippet when a user signs out?

const { data: authListener } = supabase.auth.onAuthStateChange((event, session) => {
  console.log(event);
});

// User signs out here
supabase.auth.signOut();

medium

A. "SIGNED_OUT"

B. "SIGNED_IN"

C. "USER_UPDATED"

D. No output

Solution

1. Step 1: Understand event on user sign out

   When a user signs out, the event emitted is "SIGNED_OUT".

2. Step 2: Check console.log output

   The listener logs the event string, so it will print "SIGNED_OUT".

3. Final Answer:

   "SIGNED_OUT" -> Option A

4. Quick Check:

   Sign out triggers SIGNED_OUT event [OK]

Hint: Sign out triggers SIGNED_OUT event logged [OK]

Common Mistakes:

• Expecting SIGNED_IN on sign out
• Thinking USER_UPDATED triggers on sign out
• Assuming no event is logged

4. Identify the error in this code that listens for auth state changes:

const authListener = supabase.auth.onAuthStateChange((event, session) => {
  if(event === 'SIGNED_IN') {
    console.log('User signed in');
  }
});

// Later in code
authListener.unsubscribe();

medium

A. authListener.unsubscribe() is incorrect; should use authListener.data.subscription.unsubscribe()

B. Callback function parameters are wrong

C. Event name 'SIGNED_IN' is invalid

D. No need to unsubscribe from authListener

Solution

1. Step 1: Check how onAuthStateChange returns subscription

   It returns an object with a data property containing the subscription.

2. Step 2: Verify unsubscribe method call

   Unsubscribe should be called on authListener.data.subscription.unsubscribe(), not directly on authListener.unsubscribe().

3. Final Answer:

   authListener.unsubscribe() is incorrect; should use authListener.data.subscription.unsubscribe() -> Option A

4. Quick Check:

   Unsubscribe via authListener.data.subscription.unsubscribe() [OK]

Hint: Call unsubscribe on data.subscription, not directly [OK]

Common Mistakes:

• Calling unsubscribe directly on listener object
• Misnaming event strings
• Skipping unsubscribe causing memory leaks

5. You want to update your app UI only when a user signs in or signs out, but not on other auth events. Which code snippet correctly implements this using Supabase auth state change listener?

hard

A. supabase.auth.onAuthStateChange((event, session) => {
if(event === 'USER_UPDATED') {
updateUI(session);
}
});

B. supabase.auth.onAuthStateChange((event, session) => {
if(event !== 'SIGNED_IN' && event !== 'SIGNED_OUT') {
updateUI(session);
}
});

C. supabase.auth.onAuthStateChange((event, session) => {
updateUI(session);
});

D. supabase.auth.onAuthStateChange((event, session) => {
if(event === 'SIGNED_IN' || event === 'SIGNED_OUT') {
updateUI(session);
}
});

Solution

1. Step 1: Identify events to trigger UI update

   Only 'SIGNED_IN' and 'SIGNED_OUT' events should update the UI.

2. Step 2: Check conditional logic in each option

   supabase.auth.onAuthStateChange((event, session) => { if(event === 'SIGNED_IN' || event === 'SIGNED_OUT') { updateUI(session); } }); correctly checks for these two events and calls updateUI accordingly.

3. Final Answer:

   supabase.auth.onAuthStateChange((event, session) => { if(event === 'SIGNED_IN' || event === 'SIGNED_OUT') { updateUI(session); } }); -> Option D

4. Quick Check:

   Update UI only on SIGNED_IN or SIGNED_OUT [OK]

Hint: Use if(event==='SIGNED_IN'||event==='SIGNED_OUT') to filter events [OK]

Common Mistakes:

• Updating UI on all events without filtering
• Using wrong event names like USER_UPDATED
• Negating conditions incorrectly