Overview
The getUser function retrieves the currently authenticated user from Supabase Auth. This is a fundamental function used throughout the application to verify authentication and access user data.
Function Signature
export async function getUser(): ServerActionRes<User>
Parameters
This function does not accept any parameters. It automatically retrieves the user from the current Supabase session.
Return Value
Indicates whether the operation was successful
The Supabase user object containing:Unique user identifier from Supabase Auth
Additional user metadata (e.g., name, avatar)
Timestamp when the user was created
Error message if the operation failed. Possible values:
- “User not found” - No authenticated session exists
- “Failed to get user” - Generic error during retrieval
Implementation Details
The function:
- Creates a Supabase server client
- Calls
supabase.auth.getUser() to retrieve the authenticated user
- Returns the user data if found
- Catches and handles any errors that occur
Error Handling
- Returns
{ success: false, error: "User not found" } if no user is authenticated
- Returns
{ success: false, error: "Failed to get user" } if an exception occurs
- All errors are caught and returned as structured responses
Usage Example
import { getUser } from '@/actions/get-user';
export default async function ProfilePage() {
const result = await getUser();
if (!result.success) {
return <div>Please log in to continue</div>;
}
const user = result.data;
return (
<div>
<h1>Welcome, {user.user_metadata.name || user.email}</h1>
<p>User ID: {user.id}</p>
<p>Email: {user.email}</p>
</div>
);
}
Middleware Protection Example
import { getUser } from '@/actions/get-user';
import { redirect } from 'next/navigation';
export default async function ProtectedPage() {
const result = await getUser();
if (!result.success) {
redirect('/login');
}
// User is authenticated, render protected content
return <div>Protected Content</div>;
}
Client Component Example
'use client';
import { getUser } from '@/actions/get-user';
import { useEffect, useState } from 'react';
import type { User } from '@supabase/supabase-js';
export function UserProfile() {
const [user, setUser] = useState<User | null>(null);
const [loading, setLoading] = useState(true);
useEffect(() => {
getUser().then(result => {
if (result.success) {
setUser(result.data);
}
setLoading(false);
});
}, []);
if (loading) return <div>Loading...</div>;
if (!user) return <div>Not logged in</div>;
return (
<div>
<p>Email: {user.email}</p>
<p>ID: {user.id}</p>
</div>
);
}
Source Code
Location: actions/get-user.ts:7