Problem with app.storage / ui.run_with

[shato20]

Question

Can someone please tell me what i'm doing wrong with this example? i go the basic integration with FastAPI running, now i am trying to add a middleware, but getting the folling error: RuntimeError: app.storage.user can only be used within a UI context

thanks

frontend.py:

from fastapi import FastAPI, Request
from nicegui import app, ui, Client
import nicegui
import asyncio
from starlette.datastructures import Headers

def init(fastapi_app: FastAPI) -> None:
    unrestricted_page_routes = {'/login'}

    @app.middleware("http")
    async def auth_middleware(request: Request, call_next):
        if not app.storage.user.get('authenticated', False):
            if request.url.path in Client.page_routes.values() and request.url.path not in unrestricted_page_routes:
                app.storage.user['referrer_path'] = request.url.path
                return RedirectResponse('/login')
        request._headers = Headers(scope=request.scope)
        request.headers.__dict__['_list'].append((b'authorization', f"Bearer {app.storage.user.get('token')}".encode()))
        print(f'auth_middleware auth: {request.headers.get("Authorization")}')
        return await call_next(request)    
    
    @ui.page('/login')
    def show():
        ui.label('Hello, FastAPI!')
    
    ui.run_with(
        fastapi_app, storage_secret='private')

main.py:

import frontend
from fastapi import FastAPI
import uvicorn

app=FastAPI()
frontend.init(app)


if __name__ =="__main__" :
         uvicorn.run("main:app", host="localhost", log_level="info")

[falkoschindler]

Hi @shato20,

It's currently not mentioned in the documentation, but the storage module requires the following two middlewares to be set:

fastapi_app.add_middleware(storage.RequestTrackingMiddleware)
fastapi_app.add_middleware(SessionMiddleware, secret_key='SECRET')

Here is an executable example:

import uvicorn
from fastapi import FastAPI, Request
from fastapi.responses import RedirectResponse
from starlette.datastructures import Headers
from starlette.middleware.sessions import SessionMiddleware
from nicegui import Client, app, storage, ui

fastapi_app = FastAPI()
fastapi_app.add_middleware(storage.RequestTrackingMiddleware)
fastapi_app.add_middleware(SessionMiddleware, secret_key='SECRET')

@app.middleware("http")
async def auth_middleware(request: Request, call_next):
    if not app.storage.user.get('authenticated', False):
        if request.url.path in Client.page_routes.values() and request.url.path != '/login':
            app.storage.user['referrer_path'] = request.url.path
            return RedirectResponse('/login')
    request._headers = Headers(scope=request.scope)
    request.headers.__dict__['_list'].append((b'authorization', f"Bearer {app.storage.user.get('token')}".encode()))
    print(f'auth_middleware auth: {request.headers.get("Authorization")}')
    return await call_next(request)

@ui.page('/login')
def show():
    ui.label('Hello, FastAPI!')

ui.run_with(fastapi_app, storage_secret='private')

if __name__ == "__main__":
    uvicorn.run("main:fastapi_app", host="localhost", log_level="info")

[shato20]

it works! thank you very much!

[shato20]

Hi @falkoschindler, i am posting here instad of opening a new topic since the two issues seem to related.
basically the app keeps redirecting me to login page. thiss issue happens only with ui.run_with. the app works as expected using ui.run.
i appreciate your help
here is the code:
main.py

import uvicorn
from fastapi import FastAPI, Request
from fastapi.responses import RedirectResponse

from starlette.middleware.sessions import SessionMiddleware
from nicegui import Client, app, storage, ui

fastapi_app = FastAPI()
fastapi_app.add_middleware(storage.RequestTrackingMiddleware)
fastapi_app.add_middleware(SessionMiddleware, secret_key='SECRET')
unrestricted_page_routes = {'/login'}
passwords = {'user1': 'pass1', 'user2': 'pass2'}
@app.middleware("http")
async def auth_middleware(request: Request, call_next):
    if not app.storage.user.get('authenticated', False):
        if request.url.path in Client.page_routes.values() and request.url.path not in unrestricted_page_routes:
            app.storage.user['referrer_path'] = request.url.path
            return RedirectResponse('/login')
    return await call_next(request)

    
@ui.page('/')
def main_page() -> None:
    def logout() -> None:
        app.storage.user.clear()
        ui.navigate.to('/login')

    with ui.column().classes('absolute-center items-center'):
        ui.label(f'Hello {app.storage.user["username"]}!').classes('text-2xl')
        ui.button(on_click=logout, icon='logout').props('outline round')
        ui.button('GUI', on_click=lambda:  ui.navigate.to('/gui'))
        
@ui.page('/gui')
def test_page() -> None:
     ui.label('This is a GUI page.')
    
@ui.page('/login')
def login():
    async def user_authenticate(email: str, password: str):
        if not  passwords.get(email) == password:
            return None
        else:
            user={email: password}
            return user

    async def try_login():
        user = await user_authenticate(email=username.value, password=password.value)   
        if user is None :
            ui.notify('Wrong username or password', color='negative')
        else:
            app.storage.user.update({
                'authenticated': True, 'username': username.value, 
            })
            print(app.storage.user.get('referrer_path', '/'))
            ui.navigate.to(app.storage.user.get('referrer_path', '/'))
        if app.storage.user.get('authenticated', False):
            return RedirectResponse('/login')
    with ui.card().classes('absolute-center'):
        username = ui.input('Username')
        password = ui.input(
            'Password', password=True, password_toggle_button=True
        )
        ui.button('Log in', on_click=try_login)
        
        
        
            
#ui.run(storage_secret='private')
ui.run_with(fastapi_app,
            
            storage_secret='private')

if __name__ == "__main__":
    uvicorn.run("main:fastapi_app", host="localhost", log_level="info")

[falkoschindler]

Hi @shato20, this looks like issue #2578 and can easily be fixed by using the same secret key for the SessionMiddleware as well as in ui.run_with.