Bug: MaxListenersExceededWarning

[bonesinc]

Bug description

I'm using Portainer and it tells me after deploying Zipline 4.3.2 that the container is Unhealthy.
I checked the log and found out that after each page access in the web interface it produces a warning:

(node:1) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 close listeners added to [ServerResponse]. MaxListeners is 10. Use emitter.setMaxListeners() to increase limit.

Output of "--trace-warnings" below.

To (temporary) fix it I had to use Gemini (sorry, not a coder myself) and ended up adding the following to my Portainer Stack config:

services:
  zipline:
    # ... other config
    
    environment:
      # Inject the listener-setting script via NODE_OPTIONS
      # The '-r' flag loads the module before any other application code
      NODE_OPTIONS: "-r /zipline/set-listeners.js"
      # ... other environment variables
    
    # Keep the volume to ensure set-listeners.js exists inside the container
    volumes:
      - PUT_YOUR_PATH_HERE/set-listeners.js:/zipline/set-listeners.js:ro

set-listeners.js

const EventEmitter = require('events');
EventEmitter.defaultMaxListeners = 100; // or a higher number
console.log(`[Startup Fix] EventEmitter.defaultMaxListeners set to ${EventEmitter.defaultMaxListeners}`);

How is Zipline being run?

On docker (docker, docker compose, etc.)

Zipline Version

4.3.2

If applicable, what browsers are you seeing this issue on?

Chromium based (Chrome, Brave, Edge, Opera, etc.)

Relevant Logs

I added 'NODE_OPTIONS: "--trace-warnings"' to the config file, which gives me the following in the log:

(node:1) MaxListenersExceededWarning: Possible EventEmitter memory leak detected. 11 close listeners added to [ServerResponse]. MaxListeners is 10. Use emitter.setMaxListeners() to increase limit

at genericNodeError (node:internal/errors:983:15)

at wrappedFn (node:internal/errors:537:14)

at _addListener (node:events:593:17)

at ServerResponse.addListener (node:events:611:10)

at eos (node:internal/streams/end-of-stream:209:10)

at Reply.then (/zipline/node_modules/.pnpm/fastify@5.5.0/node_modules/fastify/lib/reply.js:459:3)

Steps to Reproduce

Access a page in the web interface and a warning will appear in the log.

[diced]

this shouldn't be crashing zipline and for the most part should be fine, but I will take a look at it. could you please upload your config as well so I can replicate your environment?

[bonesinc]

It's not crashing, it just bothered me. Here's my config:

services:
  db:
    image: postgres:17
    container_name: Zipline-DB
    hostname: zipline-db
    security_opt:
      - no-new-privileges:true
    environment:
      POSTGRES_DB: zipline
      POSTGRES_USER: $DB_USER # Hardcoded everywhere in my script
      POSTGRES_PASSWORD: $DB_PASS # Hardcoded everywhere in my script
    volumes:
      - /docker/zipline/db:/var/lib/postgresql/data
    healthcheck:
      test: ["CMD", "pg_isready", "-q", "-d", "zipline", "-U", "$DB_USER"]
      timeout: 45s
      interval: 10s
      retries: 10
    restart: on-failure:5

  zipline:
    image: ghcr.io/diced/zipline
    container_name: Zipline
    ports:
      - '3797:3000'
    environment:
      DATABASE_URL: postgres://$DB_USER:$DB_PASS@zipline-db:5432/zipline
      POSTGRESQL_PASSWORD: $DB_PASS
      CORE_SECRET: $SECRET # Hardcoded in my script
      CORE_PORT: 3000
      CORE_HOSTNAME: 0.0.0.0
      DATASOURCE_TYPE: local
      DATASOURCE_LOCAL_DIRECTORY: /zipline/uploads
      NODE_OPTIONS: "-r /zipline/set-listeners.js --max-http-header-size=32768 --max-old-space-size=4096"
    depends_on:
      db:
        condition: service_healthy
    volumes:
      - /docker/zipline/uploads:/zipline/uploads
      - /docker/zipline/public:/zipline/public
      - /docker/zipline/themes:/zipline/themes
      - /docker/zipline/maxlisteners-fix/set-listeners.js:/zipline/set-listeners.js:ro
    healthcheck:
      test: ['CMD', 'wget', '-q', '--spider', 'http://127.0.0.1:3000/api/healthcheck']
      interval: 15s
      timeout: 2s
      retries: 2
    restart: on-failure:5

[yashendra2797]

I'm facing the same issue on a brand new install. Using default docker compose. s3 storage, and reverse proxy via Caddy.

[diced]

(@yashendra2797 @bonesinc) could either one of you send the output of docker compose exec zipline pnpm ctl read-config? please make sure to redact sensitive information like keys or oauth secrets.

[bonesinc]

Here's the output while running zipline 'unfixed'.

zipline_config_output.txt