🔌 Olshoperp WebSocket

Laravel Reverb + Echo — in a nutshell

📡 Connection Flow 

Browser (Vue + Echo)
  ↓ WSS :443
NGINX (SSL + WS Upgrade)
  ↓ Proxy
Laravel Reverb
  ↓
Authorized Channels
  ↓
Vue UI (Toast / Status)

🧪 Example Usage

This example demonstrates the ToastNotification feature. Once the job completes, a toast notification is triggered and broadcast to targeted users, companies, or pages. 

$data = [
    'message'     => 'Your Message',
    'title'       => 'Your Title' // Not used since the title was removed in FE,
    'type'        =>
        $exception
            ? 'error'
            : 'info',

    // Targeting
    'user_ids'    => [$this->user->id],
    'company_ids' => [] // This line can be removed, or the array can be emptied,
    'pages'       => [] // This line can be removed, or the array can be emptied,
];

// Safety wrap prevents exception from killing job
try {
    event(
        new ToastNotification($data)
    );
} catch (\Throwable $e) {
    Log::warning(
        "Broadcast ToastNotification failed: "
        . $e->getMessage()
    );
}
Rule of Thumb
• All empty → GLOBAL broadcast
• Add one → Scoped
• Add more → Hyper-targeted
▶️ Demo GIF / Video goes here

🧩 Channel Architecture

Real-time broadcasting — explained from config to runtime

1️⃣ Channel Hierarchy

feature → scope → channel[]

Channels are organized in layers: feature groups events, scope limits who can listen, and channels define the final path.

2️⃣ Scope

global
All users
user
Single user
company
Company-wide
team / room
Custom group

Scope decides who is allowed to receive the event. It acts as a security boundary.

3️⃣ Channel Patterns

global-toast-notification
toast-notification.user-{id}
page-toast-notification.{page}
page-process-status.{page}.company-{id}

Channel names follow patterns so the backend can authorize and match them dynamically.

4️⃣ Runtime Flow

Event Fired
  ↓
Pattern Matched
  ↓
Scope Authorized
  ↓
Listeners Updated

Placeholders are filled at runtime to target the right users, pages, or environments.

Core Idea

Events are dumb.
Channels decide who hears them.