How to turn off compression

[ed2050]

Question

Question

How can I disable compression of http data when running nicegui? Profiler shows my nicegui app spends a lot of time compressing data. It's not needed and contributing to lag.

There's no obvious flag in the ui.run page, and the uvicorn.run args aren't clear (ws-per-message-deflate is the only option that mentions compression, but this doesn't seem like the right setting). Can't find anything relevant in issue discussions either.

[rodja]

You are right. Currently the gzip compression middleware is non-optional because it's simply added when importing NiceGUI:

nicegui/nicegui/nicegui.py

Line 57 in 3fcfac6

app.add_middleware(GZipMiddleware)

We should move it to the ui_run.py initialization and introduce a configuration parameter. Would you like to create a pull request? Until it is merged you may be able to access app.user_middleware and remove the middleware in your application code...

[ed2050]

@rodja Ok thanks. I'll see what I can do. The fastapi and starlette middleware pages don't mention removing middleware handlers. Not sure it's possible once they're added.

Would you like to create a pull request?

I would like to, the question is whether I'm able to 😅. We'll see...

[me21]

Here's how I did it in one old application for NiceGUI 0.9.x:

if __name__ == '__main__':
    # monkey patch JustPy to remove GZipMiddleware (causes high CPU usage during database backup file download)
    app: Starlette = nicegui.globals.app
    app.user_middleware = [m for m in app.user_middleware if m.cls is not starlette.middleware.gzip.GZipMiddleware]
    app.middleware_stack = app.build_middleware_stack()

Hope it will work with NiceGUI 1.4.x!

[ed2050]

Thanks @me21! Seems to do the trick. I'm on nicegui 1.3.16.

[sklibanov]

Looks like there's a new parameter to ui.run():

    gzip_middleware_factory: Callable[[ASGIApp], GZipMiddleware] | None = GZipMiddleware,

from here - #5582 .

Good! Thanks!