From 20e0457a73cb5f9244a8b3ff6c20cd5bdbbcdea8 Mon Sep 17 00:00:00 2001
From: Stefan Stammberger <some.fusion@gmail.com>
Date: Tue, 30 Nov 2021 19:57:17 +0100
Subject: [PATCH] feat: send a wallet_locked_status SSE message

When someone connects to the SSE endpoint and the wallet is
locked a message with event name `wallet_lock_status` type is sent:
```js
// only sent when a new SSE connection is established and the wallet is
//  locked at the same time
event: wallet_lock_status
data: {"locked": true}
```
When the wallet is unlocked either through SSH or the API, another
event is sent:
```js
// sent always when a new connection is established when the wallet
// is unlocked, or it is sent when the wallet was unlocked after
// connection was established
event: wallet_lock_status
data: {"locked": false}
```

It is always the first thing the client receives. After the unlock
event, the usual warmup data is sent.

refs #34
---
 app/main.py  | 33 ++++++++++++++++++---------------
 app/utils.py |  1 +
 2 files changed, 19 insertions(+), 15 deletions(-)

diff --git a/app/main.py b/app/main.py
index aed908e..42c126b 100644
--- a/app/main.py
+++ b/app/main.py
@@ -35,7 +35,7 @@ from app.repositories.lightning import (
 from app.repositories.system import register_hardware_info_gatherer
 from app.repositories.utils import get_client_warmup_data
 from app.routers import apps, bitcoin, lightning, setup, system
-from app.utils import SSE
+from app.utils import SSE, send_sse_message
 
 
 @registered_configuration
@@ -103,28 +103,23 @@ new_connections = []
 wallet_locked = True
 
 
-@app.get(
-    "/sse/subscribe",
-    status_code=status.HTTP_200_OK,
-    responses={
-        423: {"description": "Wallet is locked. Unlock via /lightning/unlock-wallet"}
-    },
-)
+@app.get("/sse/subscribe", status_code=status.HTTP_200_OK)
 async def stream(request: Request):
     global wallet_locked
-    if wallet_locked:
-        raise HTTPException(
-            status.HTTP_423_LOCKED,
-            detail="Wallet is locked. Unlock via /lightning/unlock-wallet",
-        )
-
     global num_connections
     q = asyncio.Queue()
     connections[num_connections] = q
     num_connections += 1
     new_connections.append(q)
 
-    if len(new_connections) == 1:
+    if wallet_locked:
+        # send the the wallet locked event to the new connection
+        await q.put(_make_evt_data(SSE.WALLET_LOCK_STATUS, {"locked": True}))
+    else:
+        await q.put(_make_evt_data(SSE.WALLET_LOCK_STATUS, {"locked": False}))
+
+    if not wallet_locked and len(new_connections) == 1:
+        # if the wallet is locked, we'll handle the warmup in _handle_ln_wallet_locked()
         loop = asyncio.get_event_loop()
         loop.create_task(warmup_new_connections())
 
@@ -226,3 +221,11 @@ async def _handle_ln_wallet_locked():
     await register_lightning_listener()
     wallet_locked = False
     unregister_wallet_unlock_listener(q)
+
+    # send a wallet unlocked message to all connections before
+    # sending the warmup messages
+    await send_sse_message(SSE.WALLET_LOCK_STATUS, {"locked": False})
+
+    # send the connection warmup messages
+    loop = asyncio.get_event_loop()
+    loop.create_task(warmup_new_connections())
diff --git a/app/utils.py b/app/utils.py
index c4578d3..428d03f 100644
--- a/app/utils.py
+++ b/app/utils.py
@@ -158,3 +158,4 @@ class SSE:
     LN_ONCHAIN_PAYMENT_STATUS = "ln_onchain_payment_status"
 
     WALLET_BALANCE = "wallet_balance"
+    WALLET_LOCK_STATUS = "wallet_lock_status"