diff --git a/.env b/.env deleted file mode 100644 index 1583eab5b6a9..000000000000 --- a/.env +++ /dev/null @@ -1,68 +0,0 @@ -# These ports will be used on HOST machine -# Must not be used by other host machine services -LITELLM_PORT=11111 -JUPYTER_PORT=15555 -# UI HTTP server ports -UI_HTTP_PORT=4173 -UI_HTTPS_PORT=8443 -# OpenDevin API host, port -DEVIN_HOST=172.28.0.222 -DEVIN_API_PORT=4488 -# OpenDevin websockets port -DEVIN_WS_PORT=3000 -# -# Default Ollama model -DEFAULT_CHAT_MODEL=mistral:7b -# Default models -DEFAULT_EMBEDDINGS_MODEL=llama2 -# -# Redis ports at the HOST side -REDIS_SERVER_PORT=16379 -REDIS_INSIGHT_PORT=13333 -# -# Posgres variables -POSTGRES_USER=litellm -POSTGRES_PASSWORD=mysecretpassword -POSTGRES_DB=litellm_memory -POSTGRES_HOST_PORT=15432 -POSTGRES_CONTAINER_PORT=5432 -# -# Directories inside a container -APP_ROOT=/opt/opendevin -WORKSPACE_DIR=/opt/opendevin/workspace -CONDA_ROOT=/var/lib/miniconda -# Directories -# Path to ollama models directory at the host machine -HOST_MODELS_DIR=/mnt/g/LLMs/ollama/models -PYTHONPATH=/opt/opendevin -# Name of the container's Conda vitual environment -VENV_NAME=od_env -# -# Toggle debug mode: empty value or 'yes' -DEBUG=yes -# Secure mode: HTTPS, authorization etc. -# In development -SECURE_MODE= -# NodeJS environment mode. 'development' or 'production' -# Node's default is development if omitted -NODE_ENV=development -# -# NVidia CUDA driver version. -# Will download new image if changed -CUDA_VERSION=12.4.0 -# -# NodeJS and NPM versions of the UI image -NODE_VERSION=18.20.1 -NPM_VERSION=10.5.2 -NODE_OPTIONS="" -# -# mitmproxy version tag -MITMPROXY_VERSION=10.2.4 -# mitmproxy directory INSIDE THE CONTAINER -MITMPROXY_DIR=/home/mitmproxy/.mitmproxy -# -# Localization variables -# App locale -LANG=en_US.UTF-8 -# Specify timezone if necessary -TZ=Etc/UTC diff --git a/.env.dist b/.env.dist index e6eb06f1ef15..ddfe98e48a64 100644 --- a/.env.dist +++ b/.env.dist @@ -57,3 +57,6 @@ NPM_VERSION=10.5.2 MITMPROXY_VERSION=10.2.4 # mitmproxy directory INSIDE THE CONTAINER MITMPROXY_DIR=/home/mitmproxy/.mitmproxy + +REDIS_IMAGE=redis/redis-stack +UI_BUILD_DOCKERFILE=developer.Dockerfile diff --git a/.github/workflows/dogfood.yml b/.github/workflows/dogfood.yml index 4fc788c264ff..6d1b1a76f4ed 100644 --- a/.github/workflows/dogfood.yml +++ b/.github/workflows/dogfood.yml @@ -13,25 +13,18 @@ jobs: open-devin: if: github.event.label.name == 'dogfood-this' runs-on: ubuntu-latest - environment: OpenAI + container: + image: ghcr.io/opendevin/opendevin + volumes: + - /var/run/docker.sock:/var/run/docker.sock steps: + - name: install git, github cli + run: apt-get install -y git gh + - name: Checkout Repository uses: actions/checkout@v4 - - name: Install poetry - run: pipx install poetry - - - name: Set up Python - uses: actions/setup-python@v5 - with: - python-version: '3.12' - cache: 'poetry' - - - name: Install Dependencies - run: | - make build - - name: Write Task File env: ISSUE_TITLE: ${{ github.event.issue.title }} @@ -48,12 +41,15 @@ jobs: ISSUE_TITLE: ${{ github.event.issue.title }} ISSUE_BODY: ${{ github.event.issue.body }} LLM_API_KEY: ${{ secrets.OPENAI_API_KEY }} + SANDBOX_TYPE: exec run: | - poetry run python ./opendevin/main.py -d "./" -i 50 -f task.txt + python ./opendevin/main.py -d "./" -i 50 -f task.txt -d $GITHUB_WORKSPACE + rm task.txt - name: Setup Git, Create Branch, and Commit Changes run: | # Setup Git configuration + git config --global --add safe.directory $PWD git config --global user.name 'OpenDevin' git config --global user.email 'OpenDevin@users.noreply.github.com' @@ -76,10 +72,6 @@ jobs: # Push changes git push --set-upstream origin $BRANCH_NAME - - name: Install GitHub CLI - run: | - sudo apt-get install gh - - name: Fetch Default Branch env: GH_TOKEN: ${{ github.token }} @@ -101,10 +93,10 @@ jobs: --head "${{ github.head_ref }}" \ --base "${{ env.DEFAULT_BRANCH }}" \ | grep -o 'https://github.com/[^ ]*') - + # Extract PR number from URL PR_NUMBER=$(echo "$PR_URL" | grep -o '[0-9]\+$') - + # Set environment vars echo "PR_URL=$PR_URL" >> $GITHUB_ENV echo "PR_NUMBER=$PR_NUMBER" >> $GITHUB_ENV diff --git a/.github/workflows/ghcr.yml b/.github/workflows/ghcr.yml index 75129e75fb39..ced9804d7332 100644 --- a/.github/workflows/ghcr.yml +++ b/.github/workflows/ghcr.yml @@ -1,8 +1,7 @@ -name: Build and publish multi-arch container images +name: Publish Docker Image on: push: - branches: [ main ] workflow_dispatch: inputs: reason: @@ -14,6 +13,9 @@ jobs: ghcr_build_and_push: runs-on: ubuntu-latest if: github.event_name == 'push' || github.event.inputs.reason != '' + strategy: + matrix: + image: ["app", "evaluation", "sandbox"] steps: - name: checkout @@ -29,31 +31,5 @@ jobs: - name: Log-in to ghcr.io run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u ${{ github.actor }} --password-stdin - - name: Build and push multi-arch container images - run: | - # set env for fork repo - DOCKER_BUILD_ORG=$(echo "${{ github.repository }}" | tr '[A-Z]' '[a-z]' | cut -d '/' -f 1) - # Find directories containing Dockerfile but not containing .dockerfileignore - while IFS= read -r dockerfile_dir; do - - # Check if .dockerfileignore exists in the directory - if [ -f "$dockerfile_dir/.dockerfileignore" ]; then - echo "$dockerfile_dir/.dockerfileignore exists, skipping build and push" - continue - fi - - # Check if image was already exist in ghcr.io - pushd "$dockerfile_dir" > /dev/null - FULL_IMAGE=$(make get-full-image DOCKER_BUILD_ORG=$DOCKER_BUILD_ORG) - popd > /dev/null - EXISTS=$(docker manifest inspect "$FULL_IMAGE" > /dev/null 2>&1 && echo "true" || echo "false") - if [ "$EXISTS" == "true" ]; then - echo "Image $FULL_IMAGE already exists in ghcr.io, skipping build and push" - continue - fi - - # Build and push the image to ghcr.io - pushd "$dockerfile_dir" > /dev/null - make all DOCKER_BUILD_ORG=$DOCKER_BUILD_ORG - popd > /dev/null - done < <(find . -type f -name Dockerfile -exec dirname {} \; | sort -u) + - name: Build and push ${{ matrix.image }} + run: ./containers/build.sh ${{ matrix.image }} --push diff --git a/Makefile b/Makefile index 72442e00907b..669f1b885b87 100644 --- a/Makefile +++ b/Makefile @@ -1,8 +1,14 @@ # Makefile for OpenDevin project # Variables +DOCKER_IMAGE = ghcr.io/opendevin/sandbox +BACKEND_PORT = 3000 +BACKEND_HOST = "127.0.0.1:$(BACKEND_PORT)" +FRONTEND_PORT = 3001 +DEFAULT_WORKSPACE_DIR = "./workspace" DEFAULT_MODEL = "gpt-3.5-turbo-1106" CONFIG_FILE = config.toml +PRECOMMIT_CONFIG_PATH = "./dev_config/python/.pre-commit-config.yaml" # ANSI color codes GREEN=\033[0;32m @@ -15,21 +21,45 @@ RESET=\033[0m build: @echo "$(GREEN)Building project...$(RESET)" @$(MAKE) -s check-dependencies - @$(MAKE) -s docker-build + @$(MAKE) -s pull-docker-image + @$(MAKE) -s install-python-dependencies + @$(MAKE) -s install-frontend-dependencies + @$(MAKE) -s install-precommit-hooks + @$(MAKE) -s build-frontend @echo "$(GREEN)Build completed successfully.$(RESET)" check-dependencies: @echo "$(YELLOW)Checking dependencies...$(RESET)" - @$(MAKE) -s check-docker-compose + @$(MAKE) -s check-python + @$(MAKE) -s check-npm + @$(MAKE) -s check-docker @$(MAKE) -s check-poetry @echo "$(GREEN)Dependencies checked successfully.$(RESET)" -check-docker-compose: - @echo "$(YELLOW)Checking Docker Compose installation...$(RESET)" +check-python: + @echo "$(YELLOW)Checking Python installation...$(RESET)" + @if command -v python3 > /dev/null; then \ + echo "$(BLUE)$(shell python3 --version) is already installed.$(RESET)"; \ + else \ + echo "$(RED)Python 3 is not installed. Please install Python 3 to continue.$(RESET)"; \ + exit 1; \ + fi + +check-npm: + @echo "$(YELLOW)Checking npm installation...$(RESET)" + @if command -v npm > /dev/null; then \ + echo "$(BLUE)npm $(shell npm --version) is already installed.$(RESET)"; \ + else \ + echo "$(RED)npm is not installed. Please install Node.js to continue.$(RESET)"; \ + exit 1; \ + fi + +check-docker: + @echo "$(YELLOW)Checking Docker installation...$(RESET)" @if command -v docker > /dev/null; then \ echo "$(BLUE)$(shell docker --version) is already installed.$(RESET)"; \ else \ - echo "$(RED)Docker is not installed.\nPlease install Docker Desktop to continue.$(RESET)"; \ + echo "$(RED)Docker is not installed. Please install Docker to continue.$(RESET)"; \ exit 1; \ fi @@ -44,35 +74,55 @@ check-poetry: exit 1; \ fi -docker-build: - @read -p "Run 'docker compose down'? [Y/n]: " run_down; - @if [ ! -z "$$run_down" ] ; then @docker compose down \ - else exit 0; fi - @echo "$(YELLOW)Building Docker images...$(RESET)" - @docker compose -f docker-compose.yml build --pull > /dev/null - @echo "$(GREEN)Docker images generated successfully.$(RESET)" - -docker-rebuild: - @echo "$(YELLOW)Force rebuilding Docker images...$(RESET)" - @read -p "Run 'docker compose down'? [Y/n]: " run_down; \ - if [ ! -z = "$$run_down" ]; then docker compose down; else exit 0; fi - @docker compose -f docker-compose.yml build --pull --no-cache - @echo "$(GREEN)Docker images updated successfully.$(RESET)" - -docker-start: - @echo "$(YELLOW)Starting Docker services...$(RESET)" - @docker compose up --build - @echo "$(GREEN)All Docker services started$(RESET)" +pull-docker-image: + @echo "$(YELLOW)Pulling Docker image...$(RESET)" + @docker pull $(DOCKER_IMAGE) + @echo "$(GREEN)Docker image pulled successfully.$(RESET)" + +install-python-dependencies: + @echo "$(GREEN)Installing Python dependencies...$(RESET)" + @if [ "$(shell uname)" = "Darwin" ]; then \ + echo "$(BLUE)Installing `chroma-hnswlib`...$(RESET)"; \ + export HNSWLIB_NO_NATIVE=1; \ + poetry run pip install chroma-hnswlib; \ + fi + @poetry install --without evaluation + @echo "$(GREEN)Python dependencies installed successfully.$(RESET)" + +install-frontend-dependencies: + @echo "$(YELLOW)Setting up frontend environment...$(RESET)" + @echo "$(YELLOW)Detect Node.js version...$(RESET)" + @cd frontend && node ./scripts/detect-node-version.js + @cd frontend && \ + echo "$(BLUE)Installing frontend dependencies with npm...$(RESET)" && \ + npm install && \ + echo "$(BLUE)Running make-i18n with npm...$(RESET)" && \ + npm run make-i18n + @echo "$(GREEN)Frontend dependencies installed successfully.$(RESET)" + +install-precommit-hooks: + @echo "$(YELLOW)Installing pre-commit hooks...$(RESET)" + @git config --unset-all core.hooksPath || true + @poetry run pre-commit install --config $(PRECOMMIT_CONFIG_PATH) + @echo "$(GREEN)Pre-commit hooks installed successfully.$(RESET)" + +lint: + @echo "$(YELLOW)Running linters...$(RESET)" + @poetry run pre-commit run --files opendevin/**/* agenthub/**/* --show-diff-on-failure --config $(PRECOMMIT_CONFIG_PATH) + +build-frontend: + @echo "$(YELLOW)Building frontend...$(RESET)" + @cd frontend && npm run build # Start backend start-backend: @echo "$(YELLOW)Starting backend...$(RESET)" - @docker compose up devin + @poetry run uvicorn opendevin.server.listen:app --port $(BACKEND_PORT) # Start frontend start-frontend: @echo "$(YELLOW)Starting frontend...$(RESET)" - @docker compose up web_ui + @cd frontend && BACKEND_HOST=$(BACKEND_HOST) FRONTEND_PORT=$(FRONTEND_PORT) npm run start # Run the app run: @@ -83,7 +133,7 @@ run: fi @mkdir -p logs @echo "$(YELLOW)Starting backend server...$(RESET)" - @$(MAKE) docker-start + @poetry run uvicorn opendevin.server.listen:app --port $(BACKEND_PORT) & @echo "$(YELLOW)Waiting for the backend to start...$(RESET)" @until nc -z localhost $(BACKEND_PORT); do sleep 0.1; done @echo "$(GREEN)Backend started successfully.$(RESET)" @@ -125,13 +175,14 @@ setup-config-prompts: @read -p "Enter your workspace directory [default: $(DEFAULT_WORKSPACE_DIR)]: " workspace_dir; \ workspace_dir=$${workspace_dir:-$(DEFAULT_WORKSPACE_DIR)}; \ - echo "WORKSPACE_DIR=\"$$workspace_dir\"" >> $(CONFIG_FILE).tmp + echo "WORKSPACE_BASE=\"$$workspace_dir\"" >> $(CONFIG_FILE).tmp # Help help: @echo "$(BLUE)Usage: make [target]$(RESET)" @echo "Targets:" @echo " $(GREEN)build$(RESET) - Build project, including environment setup and dependencies." + @echo " $(GREEN)lint$(RESET) - Run linters on the project." @echo " $(GREEN)setup-config$(RESET) - Setup the configuration for OpenDevin by providing LLM API key," @echo " LLM Model name, and workspace directory." @echo " $(GREEN)start-backend$(RESET) - Start the backend server for the OpenDevin project." @@ -141,4 +192,4 @@ help: @echo " $(GREEN)help$(RESET) - Display this help message, providing information on available targets." # Phony targets -.PHONY: build check-dependencies check-docker check-poetry setup-config setup-config-prompts docker-build docker-start help +.PHONY: build check-dependencies check-python check-npm check-docker check-poetry pull-docker-image install-python-dependencies install-frontend-dependencies install-precommit-hooks lint start-backend start-frontend run setup-config setup-config-prompts help diff --git a/agenthub/monologue_agent/utils/memory.py b/agenthub/monologue_agent/utils/memory.py index 172e00555468..9cdc6c92c0b2 100644 --- a/agenthub/monologue_agent/utils/memory.py +++ b/agenthub/monologue_agent/utils/memory.py @@ -5,6 +5,7 @@ from llama_index.vector_stores.chroma import ChromaVectorStore from opendevin import config +from opendevin.logger import opendevin_logger as logger from . import json embedding_strategy = config.get('LLM_EMBEDDING_MODEL') @@ -83,6 +84,7 @@ def add_event(self, event: dict): }, ) self.thought_idx += 1 + logger.debug("Adding %s event to memory: %d", t, self.thought_idx) self.index.insert(doc) def search(self, query: str, k: int = 10): diff --git a/agenthub/planner_agent/prompt.py b/agenthub/planner_agent/prompt.py index a716d689909c..7088ccac5fae 100644 --- a/agenthub/planner_agent/prompt.py +++ b/agenthub/planner_agent/prompt.py @@ -1,11 +1,10 @@ import json from typing import List, Tuple, Dict, Type - -from opendevin.controller.agent_controller import print_with_color from opendevin.plan import Plan from opendevin.action import Action, action_from_dict from opendevin.observation import Observation from opendevin.schema import ActionType +from opendevin.logger import opendevin_logger as logger from opendevin.action import ( NullAction, @@ -198,7 +197,7 @@ def get_prompt(plan: Plan, history: List[Tuple[Action, Observation]]) -> str: elif latest_action_id == ActionType.FINISH: hint = '' - print_with_color('HINT:\n' + hint, 'INFO') + logger.info('HINT:\n' + hint, extra={'msg_type': 'INFO'}) return prompt % { 'task': plan.main_goal, 'plan': plan_str, diff --git a/config.toml.template b/config.toml.template deleted file mode 100644 index 1baa02e2ae84..000000000000 --- a/config.toml.template +++ /dev/null @@ -1,7 +0,0 @@ -# This is a template. Run `cp config.toml.template config.toml` to use it. - -LLM_MODEL="ollama/deepseek-coder:6.7b" -LLM_API_KEY="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" -LLM_EMBEDDING_MODEL="local" -LLM_BASE_URL="http://litellm:11111" -WORKSPACE_DIR="/home/wsluser/develop/oppendevin/workspace" diff --git a/containers/app/Dockerfile b/containers/app/Dockerfile new file mode 100644 index 000000000000..6ee55b375e47 --- /dev/null +++ b/containers/app/Dockerfile @@ -0,0 +1,54 @@ +FROM node:21.7.2-bookworm-slim as frontend-builder + +WORKDIR /app + +COPY ./frontend/package.json frontend/package-lock.json ./ +RUN npm install + +COPY ./frontend ./ +RUN npm run make-i18n && npm run build + +FROM python:3.12-slim as backend-builder + +WORKDIR /app +ENV PYTHONPATH '/app' + +ENV POETRY_NO_INTERACTION=1 \ + POETRY_VIRTUALENVS_IN_PROJECT=1 \ + POETRY_VIRTUALENVS_CREATE=1 \ + POETRY_CACHE_DIR=/tmp/poetry_cache + +RUN apt-get update -y \ + && apt-get install -y curl make git build-essential \ + && python3 -m pip install poetry==1.8.2 --break-system-packages + +COPY ./pyproject.toml ./poetry.lock ./ +RUN touch README.md +RUN poetry install --without evaluation --no-root && rm -rf $POETRY_CACHE_DIR + +FROM python:3.12-slim as runtime + +WORKDIR /app + +ENV RUN_AS_DEVIN=false +ENV USE_HOST_NETWORK=false +ENV SSH_HOSTNAME=host.docker.internal +ENV WORKSPACE_BASE=/opt/workspace_base +RUN mkdir -p $WORKSPACE_BASE + +RUN apt-get update -y \ + && apt-get install -y curl ssh + +ENV VIRTUAL_ENV=/app/.venv \ + PATH="/app/.venv/bin:$PATH" \ + PYTHONPATH='/app' + +COPY --from=backend-builder ${VIRTUAL_ENV} ${VIRTUAL_ENV} + +COPY ./opendevin ./opendevin +COPY ./agenthub ./agenthub +RUN python opendevin/download.py # No-op to download assets + +COPY --from=frontend-builder /app/dist ./frontend/dist + +CMD ["uvicorn", "opendevin.server.listen:app", "--host", "0.0.0.0", "--port", "3000"] diff --git a/containers/app/config.sh b/containers/app/config.sh new file mode 100644 index 000000000000..2082324826e1 --- /dev/null +++ b/containers/app/config.sh @@ -0,0 +1,2 @@ +DOCKER_REPOSITORY=ghcr.io/opendevin/opendevin +DOCKER_BASE_DIR="." diff --git a/containers/build.sh b/containers/build.sh new file mode 100644 index 000000000000..b20395e4c77d --- /dev/null +++ b/containers/build.sh @@ -0,0 +1,48 @@ +#!/bin/bash +set -eo pipefail + +image_name=$1 +push=0 +if [[ $2 == "--push" ]]; then + push=1 +fi + +echo -e "Building: $image_name" +tags=(latest) +if [[ -n $GITHUB_REF_NAME ]]; then + # check if ref name is a version number + if [[ $GITHUB_REF_NAME =~ ^v[0-9]+\.[0-9]+\.[0-9]+$ ]]; then + major_version=$(echo $GITHUB_REF_NAME | cut -d. -f1) + minor_version=$(echo $GITHUB_REF_NAME | cut -d. -f1,2) + tags+=($major_version $minor_version) + fi + sanitized=$(echo $GITHUB_REF_NAME | sed 's/[^a-zA-Z0-9.-]\+/-/g') + tags+=($sanitized) +fi +echo "Tags: ${tags[@]}" + +dir=./containers/$image_name +if [ ! -f $dir/Dockerfile ]; then + echo "No Dockerfile found" + exit 1 +fi +if [ ! -f $dir/config.sh ]; then + echo "No config.sh found for Dockerfile" + exit 1 +fi +source $dir/config.sh +echo "Repo: $DOCKER_REPOSITORY" +echo "Base dir: $DOCKER_BASE_DIR" +#docker pull $DOCKER_REPOSITORY:main || true # try to get any cached layers +args="" +for tag in ${tags[@]}; do + args+=" -t $DOCKER_REPOSITORY:$tag" +done +if [[ $push -eq 1 ]]; then + args+=" --push" +fi + +docker buildx build \ + $args \ + --platform linux/amd64,linux/arm64 \ + -f $dir/Dockerfile $DOCKER_BASE_DIR diff --git a/evaluation/SWE-bench/Dockerfile b/containers/evaluation/Dockerfile similarity index 97% rename from evaluation/SWE-bench/Dockerfile rename to containers/evaluation/Dockerfile index 8a235b08ca06..9101eca6d3e5 100644 --- a/evaluation/SWE-bench/Dockerfile +++ b/containers/evaluation/Dockerfile @@ -31,7 +31,7 @@ RUN conda env create -f environment.yml # Add commands COPY ./commands.sh . -RUN source commands.sh +RUN . ./commands.sh # Some missing packages RUN pip install datasets python-dotenv gitpython diff --git a/containers/evaluation/config.sh b/containers/evaluation/config.sh new file mode 100644 index 000000000000..421fe371a582 --- /dev/null +++ b/containers/evaluation/config.sh @@ -0,0 +1,2 @@ +DOCKER_REPOSITORY=ghcr.io/opendevin/eval-swe-bench +DOCKER_BASE_DIR=evaluation/SWE-bench diff --git a/opendevin/sandbox/Dockerfile b/containers/sandbox/Dockerfile similarity index 100% rename from opendevin/sandbox/Dockerfile rename to containers/sandbox/Dockerfile diff --git a/containers/sandbox/config.sh b/containers/sandbox/config.sh new file mode 100644 index 000000000000..2a14a21e2925 --- /dev/null +++ b/containers/sandbox/config.sh @@ -0,0 +1,2 @@ +DOCKER_REPOSITORY=ghcr.io/opendevin/sandbox +DOCKER_BASE_DIR="." diff --git a/dev_config/python/.pre-commit-config.yaml b/dev_config/python/.pre-commit-config.yaml index 931b57297a4f..591b3b87141b 100644 --- a/dev_config/python/.pre-commit-config.yaml +++ b/dev_config/python/.pre-commit-config.yaml @@ -1,12 +1,19 @@ repos: - repo: https://github.com/pre-commit/pre-commit-hooks - rev: v3.2.0 + rev: v4.5.0 hooks: - id: trailing-whitespace - id: end-of-file-fixer - id: check-yaml - id: debug-statements - - id: double-quote-string-fixer + + - repo: https://github.com/PyCQA/flake8 + rev: 7.0.0 + hooks: + - id: flake8 + args: ['--select=Q000'] # Q000 is the error code for single quote enforcement + additional_dependencies: + - flake8-quotes - repo: https://github.com/hhatto/autopep8 rev: v2.1.0 diff --git a/docker-compose.yml b/docker-compose.yml index c9c46a38c731..e069a1556ea6 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,5 +1,3 @@ -version: "3.8" - services: # Devin Out-of-The-Box Agent Service devin: @@ -22,6 +20,8 @@ services: locale: ${LANG:?} timezone: ${TZ:?} backend_host: ${DEVIN_HOST:?} + devin_ws_port: ${DEVIN_WS_PORT:?} + jupyter_port: ${JUPYTER_PORT:?} env_file: - ./.env - docker/devin/app/.env @@ -39,15 +39,6 @@ services: - conda_vol:${CONDA_ROOT:?} - ./environment.yml:${APP_ROOT:?}/environment.yml - ./workspace:${WORKSPACE_DIR:?} -# - ./docker/devin/app/.condarc:${CONDA_ROOT:?}/.condarc -# - ./Makefile:${APP_ROOT:?}/Makefile -# - ./pyproject.toml:${APP_ROOT:?}/pyproject.toml -# - ./config.toml.dist:${APP_ROOT:?}/config.toml -# - ./.env:${APP_ROOT:?}/.env -# - ./opendevin:${APP_ROOT:?}/opendevin -# - ./agenthub:${APP_ROOT:?}/agenthub -# - ./dev_config:${APP_ROOT:?}/dev_config -# - ./tests:${APP_ROOT:?}/tests tmpfs: - /run - /tmp @@ -77,8 +68,8 @@ services: litellm: image: ghcr.io/berriai/litellm:main-latest pull_policy: always - container_name: litellm_proxy - command: "--config /etc/config.yaml --port ${LITELLM_PORT} --num_workers 8 --detailed_debug" + container_name: od_litellm_proxy + command: "--config /etc/litellm/config.yaml --port ${LITELLM_PORT} --num_workers 8 --detailed_debug" environment: DEFAULT_CHAT_MODEL: ${DEFAULT_CHAT_MODEL:?} DATABASE_URL: postgresql://${POSTGRES_USER}:${POSTGRES_PASSWORD}@postgres:${POSTGRES_CONTAINER_PORT}/${POSTGRES_DB} @@ -86,8 +77,11 @@ services: - "${LITELLM_PORT}:4000" volumes: - pip_cache_vol:/root/.cache/pip:tmpfs=4G - - ./docker/litellm/config.yaml:/etc/config.yaml - - ./docker/env_debug.sh:/usr/local/bin/env_debug + - ./litellm_config.yaml:/etc/litellm/config.yaml + - ./docker/env_debug.sh:${APP_ROOT}/run/env_debug + env_file: + - .env + - docker/litellm/.env depends_on: - redis - postgres @@ -106,27 +100,26 @@ services: - /var/tmp redis: - image: redis/redis-stack:latest + image: ${REDIS_IMAGE:?}:latest + container_name: od_redis pull_policy: always - container_name: redis_stack - env_file: - - .env - - docker/redis/redis.env + env_file: docker/redis/.env ports: - - "0.0.0.0:${REDIS_SERVER_PORT}:6379" - - "0.0.0.0:${REDIS_INSIGHT_PORT}:8001" + - "${REDIS_SERVER_PORT}:6379" + - "${REDIS_INSIGHT_PORT}:8001" volumes: - - redis_data:${REDIS_DATA:-/data} + - ./docker/redis/data:/data + - ./docker/redis/stack.conf:/redis-stack.conf networks: - opendevin-net postgres: image: postgres:latest pull_policy: always - container_name: db_postgres + container_name: od_postgres env_file: - .env - - docker/postgres/postgres.env + - docker/postgres/.env volumes: - posgtres_data:${POSTGRES_DATA:-/var/lib/postgres} ports: @@ -140,16 +133,19 @@ services: # UI service web_ui: container_name: devin_web + hostname: devin_web image: lehcode/opendevin_ui-node${NODE_VERSION:?}-npm${NPM_VERSION}-pnpm-reactjs:dev pull_policy: always build: - dockerfile: docker/devin/web_ui/Dockerfile + dockerfile: docker/devin/web_ui/${UI_BUILD_DOCKERFILE:?} args: node_version: ${NODE_VERSION:?} npm_version: ${NPM_VERSION:?} node_env: ${NODE_ENV:?} debug: ${DEBUG:?} node_options: ${NODE_OPTIONS} + build_prod: ${BUILD_PROD} + frontend_port: ${UI_HTTP_PORT:?} env_file: - ./.env - docker/devin/web_ui/.env @@ -165,6 +161,9 @@ services: - "${UI_HTTPS_PORT:?}:${UI_HTTPS_PORT:?}" tty: true command: "" + volumes: + - ./docker/openssl.cnf:/etc/ssl/od_openssl.cnf +# - ./docker/nginx/nginx.conf.dist:/etc/nginx/nginx.conf networks: opendevin-net: diff --git a/docker/devin/app/Dockerfile b/docker/devin/app/Dockerfile index 9c0cd995a353..2fc52b30aaca 100644 --- a/docker/devin/app/Dockerfile +++ b/docker/devin/app/Dockerfile @@ -10,15 +10,12 @@ LABEL org.opencontainers.image.author="lehcode <53556648+lehcode@users.noreply.g ARG debug ARG apt_cache_dir=/var/cache/apt - ARG nvidia_utils_driver=550 ENV DEBUG="$debug" ENV DEBIAN_FRONTEND=noninteractive -COPY docker/locales /etc/locale.gen - -ADD --checksum=sha256:b978856ec3c826eb495b60e3fffe621f670c101150ebcbdeede4f961f22dc438 https://repo.anaconda.com/miniconda/Miniconda3-latest-Linux-x86_64.sh /tmp/miniconda.sh +ADD --checksum=sha256:3f2e5498e550a6437f15d9cc8020d52742d0ba70976ee8fce4f0daefa3992d2e https://repo.anaconda.com/miniconda/Miniconda3-py311_24.1.2-0-Linux-x86_64.sh /tmp/miniconda.sh RUN --mount=type=cache,target=${apt_cache_dir},sharing=locked \ if [ -n "${DEBUG}" ]; then set -eux; fi && \ @@ -30,13 +27,14 @@ RUN --mount=type=cache,target=${apt_cache_dir},sharing=locked \ if [ -z "${DEBUG}" ]; then apt-get -qy upgrade > /dev/null; fi ARG timezone=Etc/UTC -ARG locale +ARG lang -ENV LANG="$locale" +ENV LANG="$lang" ENV TZ="$timezone" -RUN --mount=type=cache,target=/usr/share/i18n/locales \ - if [ -n "$debug" ]; then set -eux; fi && \ +COPY docker/locales /etc/locale.gen + +RUN if [ -n "$debug" ]; then set -eux; fi && \ echo "Configuring timezone and $ubuntu_version locale..." && \ ln -fs "/usr/share/zoneinfo/$timezone" /etc/localtime > /dev/null && \ echo "$TZ" | tee -pa /etc/timezone > /dev/null && \ @@ -102,7 +100,6 @@ WORKDIR "$APP_ROOT" COPY .env . COPY pyproject.toml . -COPY README.md . ENV POETRY_HOME=/etc/poetry ENV PATH="${POETRY_HOME}/bin:${PATH}" @@ -145,7 +142,6 @@ COPY .gitignore . COPY .gitattributes . COPY docker/devin/app/devin_up.py oppendevin_launcher -COPY config.toml.template config.toml COPY docker/env_debug.sh "${APP_ROOT}/run/env_debug" COPY docker/devin/app/entrypoint.sh /docker-entrypoint.sh @@ -156,5 +152,11 @@ RUN if [ -n "$debug" ]; then set -eux; fi && \ chmod a+x /docker-entrypoint.sh && \ rm -rf /var/lib/apt/lists/* +ARG devin_ws_port +ARG jupyter_port + +EXPOSE $devin_ws_port +EXPOSE $jupyter_port + ENTRYPOINT ["/docker-entrypoint.sh", "-c"] CMD "-m ${DEFAULT_CHAT_MODEL} -e ${DEFAULT_EMBEDDINGS_MODEL} --" diff --git a/docker/devin/app/entrypoint.sh b/docker/devin/app/entrypoint.sh index 654d6c7d335b..f544b3a20b33 100644 --- a/docker/devin/app/entrypoint.sh +++ b/docker/devin/app/entrypoint.sh @@ -14,7 +14,7 @@ if [ -n "${DEBUG}" ]; then env | grep JUPYTER_PORT echo "Nvidia CUDA properties:" nvidia-smi - bash $BIN_DIR/env_debug + bash "${APP_ROOT}/run/env_debug" fi set -eux diff --git a/docker/devin/web_ui/developer.Dockerfile b/docker/devin/web_ui/developer.Dockerfile new file mode 100644 index 000000000000..5a53e6eb7132 --- /dev/null +++ b/docker/devin/web_ui/developer.Dockerfile @@ -0,0 +1,82 @@ +ARG node_version +ARG npm_version +FROM node:${node_version}-alpine as builder + +ARG node_version +ARG npm_version +ARG debug +ARG build_prod +ARG app_root=/opt/opendevin/ui +ARG build_dir="$app_root/build" + +ENV DEBIAN_FRONTEND=noninteractive + +COPY docker/openssl.cnf /etc/ssl/od_openssl.cnf + +RUN if [ -n "$debug" ]; then set -eux; fi && \ + if [ -z "$build_prod" ]; then apk update && apk upgrade; fi && \ + apk add openssl git ca-certificates &&\ + mkdir -p $app_root/config/ssl && \ + openssl req -x509 -nodes -days 365 -newkey rsa:2048 \ + -keyout $app_root/config/ssl/mydomain-nginx.crt \ + -out $app_root/config/ssl/mydomain-nginx.key \ + -config /etc/ssl/od_openssl.cnf > /dev/null && \ + rm -rf /var/lib/apt/lists/* + +ARG node_env +ARG node_options +ARG pm_cache_dir=/usr/local/share/.cache/yarn/v6 + +ENV NODE_ENV="$node_env" +ENV yarn_global_root=/usr/local/lib +ENV PATH="${PATH}:$yarn_global_root/node_modules/npm/bin:$yarn_global_root/bin" +ENV NODE_OPTIONS="$node_options" + +WORKDIR $build_dir + +COPY frontend/*.json . +COPY frontend/.npmrc . +COPY frontend/*.config.js . +COPY frontend/index.html . +COPY frontend/src ./src +COPY frontend/public ./public +COPY frontend/scripts ./scripts +COPY .env . + +RUN --mount=type=cache,target=$pm_cache_dir \ + if [ -n "$debug" ]; then set -eux; fi && \ + if [ -z .npmrc ]; then touch .npmrc; fi && \ + if [ -z "$debug" ]; then echo "loglevel=silent" | tee -a ./.npmrc; fi && \ + sed -i 's/"packageManager": ".+@.+",/"packageManager": "yarn@'$(yarn --version)'",/' package.json > /dev/null && \ + npm config set prefix "$yarn_global_root" && \ + npm config set audit false && \ + npm config set fund false && \ + npm install -g npm@${npm_version} && \ + yarn global add --prefix="$yarn_global_root" classnames typescript webpack tsx @types/node \ + vite nx@latest @nx/react && \ + yarn install + +ENV PATH=/usr/local/lib/bin:$PATH + +RUN if [ -n "$debug" ]; then set -eux; fi && \ + tsx && \ + sed -i 's/^\/\/.+//g' vite.config.js && \ +# ls -al . && cat vite.config.js && exit 1 && \ + vite build --config vite.config.js --clearScreen false + +RUN if [ -n "$debug" ]; then set -eux; fi && \ + if [ -n "$build_prod" ]; then rm -rf /var/lib/apt/lists/*; fi && \ + if [ -n "$build_prod" ]; then rm -rf $pm_cache_dir/*; fi && \ + if [ -z "$build_prod" ]; then npm cache clean --force; fi && \ + if [ -z "$build_prod" ]; then yarn cache clean; fi + +COPY docker/devin/web_ui/entrypoint.sh /docker-entrypoint.sh + +ARG frontend_port + +ENV FRONTEND_PORT=$frontend_port + +EXPOSE $frontend_port + +ENTRYPOINT ["/bin/sh", "-c", "/docker-entrypoint.sh"] +CMD "-m ${DEFAULT_CHAT_MODEL} -e ${DEFAULT_EMBEDDINGS_MODEL} --" diff --git a/docker/devin/web_ui/end-user.Dockerfile b/docker/devin/web_ui/end-user.Dockerfile new file mode 100644 index 000000000000..467082e1c329 --- /dev/null +++ b/docker/devin/web_ui/end-user.Dockerfile @@ -0,0 +1,80 @@ +ARG node_version +ARG npm_version +FROM node:${node_version}-alpine as builder + +ARG node_version +ARG npm_version +ARG debug +ARG build_prod +ARG app_root=/opt/opendevin/ui +ARG build_dir="$app_root/build" + +ENV DEBIAN_FRONTEND=noninteractive + +COPY docker/openssl.cnf /etc/ssl/od_openssl.cnf + +RUN if [ -n "$debug" ]; then set -eux; fi && \ + if [ -z "$build_prod" ]; then apk update && apk upgrade; fi && \ + apk add openssl git ca-certificates &&\ + mkdir -p $app_root/config/ssl && \ + openssl req -x509 -nodes -days 365 -newkey rsa:2048 \ + -keyout $app_root/config/ssl/mydomain-nginx.crt \ + -out $app_root/config/ssl/mydomain-nginx.key \ + -config /etc/ssl/od_openssl.cnf > /dev/null && \ + rm -rf /var/lib/apt/lists/* + +ARG node_env +ARG node_options +ARG pm_cache_dir=/usr/local/share/.cache/yarn/v6 + +ENV NODE_ENV="$node_env" +ENV yarn_global_root=/usr/local/lib +ENV PATH="${PATH}:$yarn_global_root/node_modules/npm/bin:$yarn_global_root/bin" +ENV NODE_OPTIONS="$node_options" + +WORKDIR $build_dir + +COPY frontend/*.json . +COPY frontend/.npmrc . +COPY frontend/*.config.js . +COPY frontend/index.html . +COPY frontend/src ./src +COPY frontend/public ./public +COPY frontend/scripts ./scripts +COPY .env . + +RUN --mount=type=cache,target=$pm_cache_dir \ + if [ -n "$debug" ]; then set -eux; fi && \ + if [ -z .npmrc ]; then touch .npmrc; fi && \ + if [ -z "$debug" ]; then echo "loglevel=silent" | tee -a ./.npmrc; fi && \ + sed -i 's/"packageManager": ".+@.+",/"packageManager": "yarn@'$(yarn --version)'",/' package.json > /dev/null && \ + npm config set prefix "$yarn_global_root" && \ + npm config set audit false && \ + npm config set fund false && \ + npm install -g npm@${npm_version} && \ + yarn global add --prefix="$yarn_global_root" classnames typescript webpack tsx @types/node \ + vite nx@latest @nx/react && \ + yarn install + +RUN if [ -n "$debug" ]; then set -eux; fi && \ + tsx && \ + sed -i 's/^\/\/.+//g' vite.config.js && \ + vite build --config vite.config.js --clearScreen false + +RUN if [ -n "$debug" ]; then set -eux; fi && \ + if [ -n "$build_prod" ]; then rm -rf /var/lib/apt/lists/*; fi && \ + if [ -n "$build_prod" ]; then rm -rf $pm_cache_dir/*; fi && \ + if [ -z "$build_prod" ]; then npm cache clean --force; fi && \ + if [ -z "$build_prod" ]; then yarn cache clean; fi + + +COPY docker/devin/web_ui/entrypoint.sh /docker-entrypoint.sh + +ARG frontend_port + +ENV FRONTEND_PORT=$frontend_port + +EXPOSE $frontend_port + +ENTRYPOINT ["/bin/sh", "-c", "/docker-entrypoint.sh"] +CMD "-m ${DEFAULT_CHAT_MODEL} -e ${DEFAULT_EMBEDDINGS_MODEL} --" diff --git a/docker/litellm/.env.dist b/docker/litellm/.env.dist new file mode 100644 index 000000000000..8b137891791f --- /dev/null +++ b/docker/litellm/.env.dist @@ -0,0 +1 @@ + diff --git a/docker/devin/Dockerfile b/docker/mitmproxy/.env.dist similarity index 100% rename from docker/devin/Dockerfile rename to docker/mitmproxy/.env.dist diff --git a/docker/nginx/nginx.conf.dist b/docker/nginx/nginx.conf.dist new file mode 100644 index 000000000000..4c85d9c399cb --- /dev/null +++ b/docker/nginx/nginx.conf.dist @@ -0,0 +1,68 @@ +events{} + +http { + server { + listen 14044; + + location / { + proxy_pass http://devin:14080; + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + # proxy_set_header Host $host; + proxy_set_header Host devin:14080; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + } + } + + server{ + listen 80; + server_name devin-ui-domain.local; # Replace with your domain + + root /path/to/your/react/app/build; # The path to your React app's build directory + index index.html; + + location /{ + try_files $uri /index.html; # Serve index.html for any requests that don't match a file + } + + # Optionally, configure gzip compression for better performance + gzip on; + gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; + + # Optionally, set up a location block for handling API requests if you have an API + # location /api{ + # proxy_pass http://api-server; # Proxy API requests to your API server + # } + } + + server{ + listen 443 ssl; + server_name devin-ui-domain.local; # Replace with your domain + + ssl_certificate /etc/nginx/ssl/mydomain.local/self.crt; + ssl_certificate_key /etc/nginx/ssl/mydomain.local/self.key; + # Uncomment if using Certbot to generate SSL certificate for real domain + # ssl_certificate /etc/letsencrypt/live/yourdomain.com/fullchain.pem; + # ssl_certificate_key /etc/letsencrypt/live/yourdomain.com/privkey.pem; + + + root /path/to/your/react/app/build; # The path to your React app's build directory + index index.html; + + location /{ + try_files $uri /index.html; # Serve index.html for any requests that don't match a file + } + + # Optionally, configure gzip compression for better performance + gzip on; + gzip_types text/plain text/css application/json application/javascript text/xml application/xml application/xml+rss text/javascript; + + # Optionally, set up a location block for handling API requests if you have an API + # location /api{ + # proxy_pass http://api-server; # Proxy API requests to your API server + # } + } +} diff --git a/docker/ollama/.env.dist b/docker/ollama/.env.dist new file mode 100644 index 000000000000..d56b85934b1c --- /dev/null +++ b/docker/ollama/.env.dist @@ -0,0 +1,3 @@ +# CORS +OLLAMA_HOST=0.0.0.0 +OLLAMA_ORIGINS=* diff --git a/docker/postgres/.env.dist b/docker/postgres/.env.dist new file mode 100644 index 000000000000..2e9988c7884d --- /dev/null +++ b/docker/postgres/.env.dist @@ -0,0 +1,2 @@ +POSTGRES_INITDB_ARGS="--data-checksums" +POSTGRES_DATA=/var/lib/postgres diff --git a/docker/redis/.env.dist b/docker/redis/.env.dist new file mode 100644 index 000000000000..da32a24450b1 --- /dev/null +++ b/docker/redis/.env.dist @@ -0,0 +1,6 @@ +REDIS_ARGS="--save 60 1000" +REDISEARCH_ARGS= +REDISJSON_ARGS= +REDISTIMESERIES_ARGS="RETENTION_POLICY=20" +REDISBLOOM_ARGS= +REDIS_DATA=/data diff --git a/docker/redis/Dockerfile b/docker/redis/Dockerfile new file mode 100644 index 000000000000..f90a9e9e3ca9 --- /dev/null +++ b/docker/redis/Dockerfile @@ -0,0 +1,14 @@ +ARG image +FROM $image + +ARG app_root +ARG redis_data_dir + +ENV REDIS_DATA_DIR=$redis_data_dir + +EXPOSE 6379 +EXPOSE 8001 + +COPY stack.conf /redis-stack.conf + +CMD ["redis-server"] diff --git a/docker/redis/stack.conf b/docker/redis/stack.conf new file mode 100644 index 000000000000..0300f7ea3f8d --- /dev/null +++ b/docker/redis/stack.conf @@ -0,0 +1,2322 @@ +# Redis configuration file example. +# +# Note that in order to read the configuration file, Redis must be +# started with the file path as first argument: +# +# ./redis-server /path/to/stack.conf + +# Note on units: when memory size is needed, it is possible to specify +# it in the usual form of 1k 5GB 4M and so forth: +# +# 1k => 1000 bytes +# 1kb => 1024 bytes +# 1m => 1000000 bytes +# 1mb => 1024*1024 bytes +# 1g => 1000000000 bytes +# 1gb => 1024*1024*1024 bytes +# +# units are case insensitive so 1GB 1Gb 1gB are all the same. + +################################## INCLUDES ################################### + +# Include one or more other config files here. This is useful if you +# have a standard template that goes to all Redis servers but also need +# to customize a few per-server settings. Include files can include +# other files, so use this wisely. +# +# Note that option "include" won't be rewritten by command "CONFIG REWRITE" +# from admin or Redis Sentinel. Since Redis always uses the last processed +# line as value of a configuration directive, you'd better put includes +# at the beginning of this file to avoid overwriting config change at runtime. +# +# If instead you are interested in using includes to override configuration +# options, it is better to use include as the last line. +# +# Included paths may contain wildcards. All files matching the wildcards will +# be included in alphabetical order. +# Note that if an include path contains a wildcards but no files match it when +# the server is started, the include statement will be ignored and no error will +# be emitted. It is safe, therefore, to include wildcard files from empty +# directories. +# +# include /path/to/local.conf +# include /path/to/other.conf +# include /path/to/fragments/*.conf +# + +################################## MODULES ##################################### + +# Load modules at startup. If the server is not able to load modules +# it will abort. It is possible to use multiple loadmodule directives. +# +# loadmodule /path/to/my_module.so +# loadmodule /path/to/other_module.so +# loadmodule /path/to/args_module.so [arg [arg ...]] + +################################## NETWORK ##################################### + +# By default, if no "bind" configuration directive is specified, Redis listens +# for connections from all available network interfaces on the host machine. +# It is possible to listen to just one or multiple selected interfaces using +# the "bind" configuration directive, followed by one or more IP addresses. +# Each address can be prefixed by "-", which means that redis will not fail to +# start if the address is not available. Being not available only refers to +# addresses that does not correspond to any network interface. Addresses that +# are already in use will always fail, and unsupported protocols will always BE +# silently skipped. +# +# Examples: +# +# bind 192.168.1.100 10.0.0.1 # listens on two specific IPv4 addresses +# bind 127.0.0.1 ::1 # listens on loopback IPv4 and IPv6 +# bind * -::* # like the default, all available interfaces +# +# ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the +# internet, binding to all the interfaces is dangerous and will expose the +# instance to everybody on the internet. So by default we uncomment the +# following bind directive, that will force Redis to listen only on the +# IPv4 and IPv6 (if available) loopback interface addresses (this means Redis +# will only be able to accept client connections from the same host that it is +# running on). +# +# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES +# COMMENT OUT THE FOLLOWING LINE. +# +# You will also need to set a password unless you explicitly disable protected +# mode. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +bind 127.0.0.1 -::1 + +# By default, outgoing connections (from replica to master, from Sentinel to +# instances, cluster bus, etc.) are not bound to a specific local address. In +# most cases, this means the operating system will handle that based on routing +# and the interface through which the connection goes out. +# +# Using bind-source-addr it is possible to configure a specific address to bind +# to, which may also affect how the connection gets routed. +# +# Example: +# +# bind-source-addr 10.0.0.1 + +# Protected mode is a layer of security protection, in order to avoid that +# Redis instances left open on the internet are accessed and exploited. +# +# When protected mode is on and the default user has no password, the server +# only accepts local connections from the IPv4 address (127.0.0.1), IPv6 address +# (::1) or Unix domain sockets. +# +# By default protected mode is enabled. You should disable it only if +# you are sure you want clients from other hosts to connect to Redis +# even if no authentication is configured. +# protected-mode yes +protected-mode no + +# Redis uses default hardened security configuration directives to reduce the +# attack surface on innocent users. Therefore, several sensitive configuration +# directives are immutable, and some potentially-dangerous commands are blocked. +# +# Configuration directives that control files that Redis writes to (e.g., 'dir' +# and 'dbfilename') and that aren't usually modified during runtime +# are protected by making them immutable. +# +# Commands that can increase the attack surface of Redis and that aren't usually +# called by users are blocked by default. +# +# These can be exposed to either all connections or just local ones by setting +# each of the configs listed below to either of these values: +# +# no - Block for any connection (remain immutable) +# yes - Allow for any connection (no protection) +# local - Allow only for local connections. Ones originating from the +# IPv4 address (127.0.0.1), IPv6 address (::1) or Unix domain sockets. +# +# enable-protected-configs no +# enable-debug-command no +# enable-module-command no + +# Accept connections on the specified port, default is 6379 (IANA #815344). +# If port 0 is specified Redis will not listen on a TCP socket. +port 6379 + +# TCP listen() backlog. +# +# In high requests-per-second environments you need a high backlog in order +# to avoid slow clients connection issues. Note that the Linux kernel +# will silently truncate it to the value of /proc/sys/net/core/somaxconn so +# make sure to raise both the value of somaxconn and tcp_max_syn_backlog +# in order to get the desired effect. +tcp-backlog 511 + +# Unix socket. +# +# Specify the path for the Unix socket that will be used to listen for +# incoming connections. There is no default, so Redis will not listen +# on a unix socket when not specified. +# +# unixsocket /run/redis.sock +# unixsocketperm 700 + +# Close the connection after a client is idle for N seconds (0 to disable) +timeout 0 + +# TCP keepalive. +# +# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence +# of communication. This is useful for two reasons: +# +# 1) Detect dead peers. +# 2) Force network equipment in the middle to consider the connection to be +# alive. +# +# On Linux, the specified value (in seconds) is the period used to send ACKs. +# Note that to close the connection the double of the time is needed. +# On other kernels the period depends on the kernel configuration. +# +# A reasonable value for this option is 300 seconds, which is the new +# Redis default starting with Redis 3.2.1. +tcp-keepalive 300 + +# Apply OS-specific mechanism to mark the listening socket with the specified +# ID, to support advanced routing and filtering capabilities. +# +# On Linux, the ID represents a connection mark. +# On FreeBSD, the ID represents a socket cookie ID. +# On OpenBSD, the ID represents a route table ID. +# +# The default value is 0, which implies no marking is required. +# socket-mark-id 0 + +################################# TLS/SSL ##################################### + +# By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration +# directive can be used to define TLS-listening ports. To enable TLS on the +# default port, use: +# +# port 0 +# tls-port 6379 + +# Configure a X.509 certificate and private key to use for authenticating the +# server to connected clients, masters or cluster peers. These files should be +# PEM formatted. +# +# tls-cert-file redis.crt +# tls-key-file redis.key +# +# If the key file is encrypted using a passphrase, it can be included here +# as well. +# +# tls-key-file-pass secret + +# Normally Redis uses the same certificate for both server functions (accepting +# connections) and client functions (replicating from a master, establishing +# cluster bus connections, etc.). +# +# Sometimes certificates are issued with attributes that designate them as +# client-only or server-only certificates. In that case it may be desired to use +# different certificates for incoming (server) and outgoing (client) +# connections. To do that, use the following directives: +# +# tls-client-cert-file client.crt +# tls-client-key-file client.key +# +# If the key file is encrypted using a passphrase, it can be included here +# as well. +# +# tls-client-key-file-pass secret + +# Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange, +# required by older versions of OpenSSL (<3.0). Newer versions do not require +# this configuration and recommend against it. +# +# tls-dh-params-file redis.dh + +# Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL +# clients and peers. Redis requires an explicit configuration of at least one +# of these, and will not implicitly use the system wide configuration. +# +# tls-ca-cert-file ca.crt +# tls-ca-cert-dir /etc/ssl/certs + +# By default, clients (including replica servers) on a TLS port are required +# to authenticate using valid client side certificates. +# +# If "no" is specified, client certificates are not required and not accepted. +# If "optional" is specified, client certificates are accepted and must be +# valid if provided, but are not required. +# +# tls-auth-clients no +# tls-auth-clients optional + +# By default, a Redis replica does not attempt to establish a TLS connection +# with its master. +# +# Use the following directive to enable TLS on replication links. +# +# tls-replication yes + +# By default, the Redis Cluster bus uses a plain TCP connection. To enable +# TLS for the bus protocol, use the following directive: +# +# tls-cluster yes + +# By default, only TLSv1.2 and TLSv1.3 are enabled and it is highly recommended +# that older formally deprecated versions are kept disabled to reduce the attack surface. +# You can explicitly specify TLS versions to support. +# Allowed values are case insensitive and include "TLSv1", "TLSv1.1", "TLSv1.2", +# "TLSv1.3" (OpenSSL >= 1.1.1) or any combination. +# To enable only TLSv1.2 and TLSv1.3, use: +# +# tls-protocols "TLSv1.2 TLSv1.3" + +# Configure allowed ciphers. See the ciphers(1ssl) manpage for more information +# about the syntax of this string. +# +# Note: this configuration applies only to <= TLSv1.2. +# +# tls-ciphers DEFAULT:!MEDIUM + +# Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more +# information about the syntax of this string, and specifically for TLSv1.3 +# ciphersuites. +# +# tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256 + +# When choosing a cipher, use the server's preference instead of the client +# preference. By default, the server follows the client's preference. +# +# tls-prefer-server-ciphers yes + +# By default, TLS session caching is enabled to allow faster and less expensive +# reconnections by clients that support it. Use the following directive to disable +# caching. +# +# tls-session-caching no + +# Change the default number of TLS sessions cached. A zero value sets the cache +# to unlimited size. The default size is 20480. +# +# tls-session-cache-size 5000 + +# Change the default timeout of cached TLS sessions. The default timeout is 300 +# seconds. +# +# tls-session-cache-timeout 60 + +################################# GENERAL ##################################### + +# By default Redis does not run as a daemon. Use 'yes' if you need it. +# Note that Redis will write a pid file in /var/run/redis.pid when daemonized. +# When Redis is supervised by upstart or systemd, this parameter has no impact. +daemonize yes + +# If you run Redis from upstart or systemd, Redis can interact with your +# supervision tree. Options: +# supervised no - no supervision interaction +# supervised upstart - signal upstart by putting Redis into SIGSTOP mode +# requires "expect stop" in your upstart job config +# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET +# on startup, and updating Redis status on a regular +# basis. +# supervised auto - detect upstart or systemd method based on +# UPSTART_JOB or NOTIFY_SOCKET environment variables +# Note: these supervision methods only signal "process is ready." +# They do not enable continuous pings back to your supervisor. +# +# The default is "no". To run under upstart/systemd, you can simply uncomment +# the line below: +# +# supervised auto + +# If a pid file is specified, Redis writes it where specified at startup +# and removes it at exit. +# +# When the server runs non daemonized, no pid file is created if none is +# specified in the configuration. When the server is daemonized, the pid file +# is used even if not specified, defaulting to "/var/run/redis.pid". +# +# Creating a pid file is best effort: if Redis is not able to create it +# nothing bad happens, the server will start and run normally. +# +# Note that on modern Linux systems "/run/redis.pid" is more conforming +# and should be used instead. +pidfile /var/run/redis_6379.pid + +# Specify the server verbosity level. +# This can be one of: +# debug (a lot of information, useful for development/testing) +# verbose (many rarely useful info, but not a mess like the debug level) +# notice (moderately verbose, what you want in production probably) +# warning (only very important / critical messages are logged) +# nothing (nothing is logged) +loglevel verbose + +# Specify the log file name. Also the empty string can be used to force +# Redis to log on the standard output. Note that if you use standard +# output for logging but daemonize, logs will be sent to /dev/null +logfile "/var/log/redis.log" + +# To enable logging to the system logger, just set 'syslog-enabled' to yes, +# and optionally update the other syslog parameters to suit your needs. +# syslog-enabled no + +# Specify the syslog identity. +# syslog-ident redis + +# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. +# syslog-facility local0 + +# To disable the built in crash log, which will possibly produce cleaner core +# dumps when they are needed, uncomment the following: +# +# crash-log-enabled no + +# To disable the fast memory check that's run as part of the crash log, which +# will possibly let redis terminate sooner, uncomment the following: +# +# crash-memcheck-enabled no + +# Set the number of databases. The default database is DB 0, you can select +# a different one on a per-connection basis using SELECT where +# dbid is a number between 0 and 'databases'-1 +databases 16 + +# By default Redis shows an ASCII art logo only when started to log to the +# standard output and if the standard output is a TTY and syslog logging is +# disabled. Basically this means that normally a logo is displayed only in +# interactive sessions. +# +# However it is possible to force the pre-4.0 behavior and always show a +# ASCII art logo in startup logs by setting the following option to yes. +always-show-logo no + +# By default, Redis modifies the process title (as seen in 'top' and 'ps') to +# provide some runtime information. It is possible to disable this and leave +# the process name as executed by setting the following to no. +set-proc-title yes + +# When changing the process title, Redis uses the following template to construct +# the modified title. +# +# Template variables are specified in curly brackets. The following variables are +# supported: +# +# {title} Name of process as executed if parent, or type of child process. +# {listen-addr} Bind address or '*' followed by TCP or TLS port listening on, or +# Unix socket if only that's available. +# {server-mode} Special mode, i.e. "[sentinel]" or "[cluster]". +# {port} TCP port listening on, or 0. +# {tls-port} TLS port listening on, or 0. +# {unixsocket} Unix domain socket listening on, or "". +# {config-file} Name of configuration file used. +# +proc-title-template "{title} {listen-addr} {server-mode}" + +# Set the local environment which is used for string comparison operations, and +# also affect the performance of Lua scripts. Empty String indicates the locale +# is derived from the environment variables. +locale-collate "" + +################################ SNAPSHOTTING ################################ + +# Save the DB to disk. +# +# save [ ...] +# +# Redis will save the DB if the given number of seconds elapsed and it +# surpassed the given number of write operations against the DB. +# +# Snapshotting can be completely disabled with a single empty string argument +# as in following example: +# +# save "" +# +# Unless specified otherwise, by default Redis will save the DB: +# * After 3600 seconds (an hour) if at least 1 change was performed +# * After 300 seconds (5 minutes) if at least 100 changes were performed +# * After 60 seconds if at least 10000 changes were performed +# +# You can set these explicitly by uncommenting the following line. +# +# save 3600 1 300 100 60 10000 + +# By default Redis will stop accepting writes if RDB snapshots are enabled +# (at least one save point) and the latest background save failed. +# This will make the user aware (in a hard way) that data is not persisting +# on disk properly, otherwise chances are that no one will notice and some +# disaster will happen. +# +# If the background saving process will start working again Redis will +# automatically allow writes again. +# +# However if you have setup your proper monitoring of the Redis server +# and persistence, you may want to disable this feature so that Redis will +# continue to work as usual even if there are problems with disk, +# permissions, and so forth. +stop-writes-on-bgsave-error yes + +# Compress string objects using LZF when dump .rdb databases? +# By default compression is enabled as it's almost always a win. +# If you want to save some CPU in the saving child set it to 'no' but +# the dataset will likely be bigger if you have compressible values or keys. +rdbcompression yes + +# Since version 5 of RDB a CRC64 checksum is placed at the end of the file. +# This makes the format more resistant to corruption but there is a performance +# hit to pay (around 10%) when saving and loading RDB files, so you can disable it +# for maximum performances. +# +# RDB files created with checksum disabled have a checksum of zero that will +# tell the loading code to skip the check. +rdbchecksum yes + +# Enables or disables full sanitization checks for ziplist and listpack etc when +# loading an RDB or RESTORE payload. This reduces the chances of a assertion or +# crash later on while processing commands. +# Options: +# no - Never perform full sanitization +# yes - Always perform full sanitization +# clients - Perform full sanitization only for user connections. +# Excludes: RDB files, RESTORE commands received from the master +# connection, and client connections which have the +# skip-sanitize-payload ACL flag. +# The default should be 'clients' but since it currently affects cluster +# resharding via MIGRATE, it is temporarily set to 'no' by default. +# +# sanitize-dump-payload no + +# The filename where to dump the DB +dbfilename dump.rdb + +# Remove RDB files used by replication in instances without persistence +# enabled. By default this option is disabled, however there are environments +# where for regulations or other security concerns, RDB files persisted on +# disk by masters in order to feed replicas, or stored on disk by replicas +# in order to load them for the initial synchronization, should be deleted +# ASAP. Note that this option ONLY WORKS in instances that have both AOF +# and RDB persistence disabled, otherwise is completely ignored. +# +# An alternative (and sometimes better) way to obtain the same effect is +# to use diskless replication on both master and replicas instances. However +# in the case of replicas, diskless is not always an option. +rdb-del-sync-files no + +# The working directory. +# +# The DB will be written inside this directory, with the filename specified +# above using the 'dbfilename' configuration directive. +# +# The Append Only File will also be created inside this directory. +# +# Note that you must specify a directory here, not a file name. +dir ./ + +################################# REPLICATION ################################# + +# Master-Replica replication. Use replicaof to make a Redis instance a copy of +# another Redis server. A few things to understand ASAP about Redis replication. +# +# +------------------+ +---------------+ +# | Master | ---> | Replica | +# | (receive writes) | | (exact copy) | +# +------------------+ +---------------+ +# +# 1) Redis replication is asynchronous, but you can configure a master to +# stop accepting writes if it appears to be not connected with at least +# a given number of replicas. +# 2) Redis replicas are able to perform a partial resynchronization with the +# master if the replication link is lost for a relatively small amount of +# time. You may want to configure the replication backlog size (see the next +# sections of this file) with a sensible value depending on your needs. +# 3) Replication is automatic and does not need user intervention. After a +# network partition replicas automatically try to reconnect to masters +# and resynchronize with them. +# +# replicaof + +# If the master is password protected (using the "requirepass" configuration +# directive below) it is possible to tell the replica to authenticate before +# starting the replication synchronization process, otherwise the master will +# refuse the replica request. +# +# masterauth +# +# However this is not enough if you are using Redis ACLs (for Redis version +# 6 or greater), and the default user is not capable of running the PSYNC +# command and/or other commands needed for replication. In this case it's +# better to configure a special user to use with replication, and specify the +# masteruser configuration as such: +# +# masteruser +# +# When masteruser is specified, the replica will authenticate against its +# master using the new AUTH form: AUTH . + +# When a replica loses its connection with the master, or when the replication +# is still in progress, the replica can act in two different ways: +# +# 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will +# still reply to client requests, possibly with out of date data, or the +# data set may just be empty if this is the first synchronization. +# +# 2) If replica-serve-stale-data is set to 'no' the replica will reply with error +# "MASTERDOWN Link with MASTER is down and replica-serve-stale-data is set to 'no'" +# to all data access commands, excluding commands such as: +# INFO, REPLICAOF, AUTH, SHUTDOWN, REPLCONF, ROLE, CONFIG, SUBSCRIBE, +# UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, COMMAND, POST, +# HOST and LATENCY. +# +replica-serve-stale-data yes + +# You can configure a replica instance to accept writes or not. Writing against +# a replica instance may be useful to store some ephemeral data (because data +# written on a replica will be easily deleted after resync with the master) but +# may also cause problems if clients are writing to it because of a +# misconfiguration. +# +# Since Redis 2.6 by default replicas are read-only. +# +# Note: read only replicas are not designed to be exposed to untrusted clients +# on the internet. It's just a protection layer against misuse of the instance. +# Still a read only replica exports by default all the administrative commands +# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve +# security of read only replicas using 'rename-command' to shadow all the +# administrative / dangerous commands. +replica-read-only yes + +# Replication SYNC strategy: disk or socket. +# +# New replicas and reconnecting replicas that are not able to continue the +# replication process just receiving differences, need to do what is called a +# "full synchronization". An RDB file is transmitted from the master to the +# replicas. +# +# The transmission can happen in two different ways: +# +# 1) Disk-backed: The Redis master creates a new process that writes the RDB +# file on disk. Later the file is transferred by the parent +# process to the replicas incrementally. +# 2) Diskless: The Redis master creates a new process that directly writes the +# RDB file to replica sockets, without touching the disk at all. +# +# With disk-backed replication, while the RDB file is generated, more replicas +# can be queued and served with the RDB file as soon as the current child +# producing the RDB file finishes its work. With diskless replication instead +# once the transfer starts, new replicas arriving will be queued and a new +# transfer will start when the current one terminates. +# +# When diskless replication is used, the master waits a configurable amount of +# time (in seconds) before starting the transfer in the hope that multiple +# replicas will arrive and the transfer can be parallelized. +# +# With slow disks and fast (large bandwidth) networks, diskless replication +# works better. +repl-diskless-sync yes + +# When diskless replication is enabled, it is possible to configure the delay +# the server waits in order to spawn the child that transfers the RDB via socket +# to the replicas. +# +# This is important since once the transfer starts, it is not possible to serve +# new replicas arriving, that will be queued for the next RDB transfer, so the +# server waits a delay in order to let more replicas arrive. +# +# The delay is specified in seconds, and by default is 5 seconds. To disable +# it entirely just set it to 0 seconds and the transfer will start ASAP. +repl-diskless-sync-delay 5 + +# When diskless replication is enabled with a delay, it is possible to let +# the replication start before the maximum delay is reached if the maximum +# number of replicas expected have connected. Default of 0 means that the +# maximum is not defined and Redis will wait the full delay. +repl-diskless-sync-max-replicas 0 + +# ----------------------------------------------------------------------------- +# WARNING: Since in this setup the replica does not immediately store an RDB on +# disk, it may cause data loss during failovers. RDB diskless load + Redis +# modules not handling I/O reads may cause Redis to abort in case of I/O errors +# during the initial synchronization stage with the master. +# ----------------------------------------------------------------------------- +# +# Replica can load the RDB it reads from the replication link directly from the +# socket, or store the RDB to a file and read that file after it was completely +# received from the master. +# +# In many cases the disk is slower than the network, and storing and loading +# the RDB file may increase replication time (and even increase the master's +# Copy on Write memory and replica buffers). +# However, when parsing the RDB file directly from the socket, in order to avoid +# data loss it's only safe to flush the current dataset when the new dataset is +# fully loaded in memory, resulting in higher memory usage. +# For this reason we have the following options: +# +# "disabled" - Don't use diskless load (store the rdb file to the disk first) +# "swapdb" - Keep current db contents in RAM while parsing the data directly +# from the socket. Replicas in this mode can keep serving current +# dataset while replication is in progress, except for cases where +# they can't recognize master as having a data set from same +# replication history. +# Note that this requires sufficient memory, if you don't have it, +# you risk an OOM kill. +# "on-empty-db" - Use diskless load only when current dataset is empty. This is +# safer and avoid having old and new dataset loaded side by side +# during replication. +repl-diskless-load disabled + +# Master send PINGs to its replicas in a predefined interval. It's possible to +# change this interval with the repl_ping_replica_period option. The default +# value is 10 seconds. +# +# repl-ping-replica-period 10 + +# The following option sets the replication timeout for: +# +# 1) Bulk transfer I/O during SYNC, from the point of view of replica. +# 2) Master timeout from the point of view of replicas (data, pings). +# 3) Replica timeout from the point of view of masters (REPLCONF ACK pings). +# +# It is important to make sure that this value is greater than the value +# specified for repl-ping-replica-period otherwise a timeout will be detected +# every time there is low traffic between the master and the replica. The default +# value is 60 seconds. +# +# repl-timeout 60 + +# Disable TCP_NODELAY on the replica socket after SYNC? +# +# If you select "yes" Redis will use a smaller number of TCP packets and +# less bandwidth to send data to replicas. But this can add a delay for +# the data to appear on the replica side, up to 40 milliseconds with +# Linux kernels using a default configuration. +# +# If you select "no" the delay for data to appear on the replica side will +# be reduced but more bandwidth will be used for replication. +# +# By default we optimize for low latency, but in very high traffic conditions +# or when the master and replicas are many hops away, turning this to "yes" may +# be a good idea. +repl-disable-tcp-nodelay no + +# Set the replication backlog size. The backlog is a buffer that accumulates +# replica data when replicas are disconnected for some time, so that when a +# replica wants to reconnect again, often a full resync is not needed, but a +# partial resync is enough, just passing the portion of data the replica +# missed while disconnected. +# +# The bigger the replication backlog, the longer the replica can endure the +# disconnect and later be able to perform a partial resynchronization. +# +# The backlog is only allocated if there is at least one replica connected. +# +# repl-backlog-size 1mb + +# After a master has no connected replicas for some time, the backlog will be +# freed. The following option configures the amount of seconds that need to +# elapse, starting from the time the last replica disconnected, for the backlog +# buffer to be freed. +# +# Note that replicas never free the backlog for timeout, since they may be +# promoted to masters later, and should be able to correctly "partially +# resynchronize" with other replicas: hence they should always accumulate backlog. +# +# A value of 0 means to never release the backlog. +# +# repl-backlog-ttl 3600 + +# The replica priority is an integer number published by Redis in the INFO +# output. It is used by Redis Sentinel in order to select a replica to promote +# into a master if the master is no longer working correctly. +# +# A replica with a low priority number is considered better for promotion, so +# for instance if there are three replicas with priority 10, 100, 25 Sentinel +# will pick the one with priority 10, that is the lowest. +# +# However a special priority of 0 marks the replica as not able to perform the +# role of master, so a replica with priority of 0 will never be selected by +# Redis Sentinel for promotion. +# +# By default the priority is 100. +replica-priority 100 + +# The propagation error behavior controls how Redis will behave when it is +# unable to handle a command being processed in the replication stream from a master +# or processed while reading from an AOF file. Errors that occur during propagation +# are unexpected, and can cause data inconsistency. However, there are edge cases +# in earlier versions of Redis where it was possible for the server to replicate or persist +# commands that would fail on future versions. For this reason the default behavior +# is to ignore such errors and continue processing commands. +# +# If an application wants to ensure there is no data divergence, this configuration +# should be set to 'panic' instead. The value can also be set to 'panic-on-replicas' +# to only panic when a replica encounters an error on the replication stream. One of +# these two panic values will become the default value in the future once there are +# sufficient safety mechanisms in place to prevent false positive crashes. +# +# propagation-error-behavior ignore + +# Replica ignore disk write errors controls the behavior of a replica when it is +# unable to persist a write command received from its master to disk. By default, +# this configuration is set to 'no' and will crash the replica in this condition. +# It is not recommended to change this default, however in order to be compatible +# with older versions of Redis this config can be toggled to 'yes' which will just +# log a warning and execute the write command it got from the master. +# +# replica-ignore-disk-write-errors no + +# ----------------------------------------------------------------------------- +# By default, Redis Sentinel includes all replicas in its reports. A replica +# can be excluded from Redis Sentinel's announcements. An unannounced replica +# will be ignored by the 'sentinel replicas ' command and won't be +# exposed to Redis Sentinel's clients. +# +# This option does not change the behavior of replica-priority. Even with +# replica-announced set to 'no', the replica can be promoted to master. To +# prevent this behavior, set replica-priority to 0. +# +# replica-announced yes + +# It is possible for a master to stop accepting writes if there are less than +# N replicas connected, having a lag less or equal than M seconds. +# +# The N replicas need to be in "online" state. +# +# The lag in seconds, that must be <= the specified value, is calculated from +# the last ping received from the replica, that is usually sent every second. +# +# This option does not GUARANTEE that N replicas will accept the write, but +# will limit the window of exposure for lost writes in case not enough replicas +# are available, to the specified number of seconds. +# +# For example to require at least 3 replicas with a lag <= 10 seconds use: +# +# min-replicas-to-write 3 +# min-replicas-max-lag 10 +# +# Setting one or the other to 0 disables the feature. +# +# By default min-replicas-to-write is set to 0 (feature disabled) and +# min-replicas-max-lag is set to 10. + +# A Redis master is able to list the address and port of the attached +# replicas in different ways. For example the "INFO replication" section +# offers this information, which is used, among other tools, by +# Redis Sentinel in order to discover replica instances. +# Another place where this info is available is in the output of the +# "ROLE" command of a master. +# +# The listed IP address and port normally reported by a replica is +# obtained in the following way: +# +# IP: The address is auto detected by checking the peer address +# of the socket used by the replica to connect with the master. +# +# Port: The port is communicated by the replica during the replication +# handshake, and is normally the port that the replica is using to +# listen for connections. +# +# However when port forwarding or Network Address Translation (NAT) is +# used, the replica may actually be reachable via different IP and port +# pairs. The following two options can be used by a replica in order to +# report to its master a specific set of IP and port, so that both INFO +# and ROLE will report those values. +# +# There is no need to use both the options if you need to override just +# the port or the IP address. +# +# replica-announce-ip 5.5.5.5 +# replica-announce-port 1234 + +############################### KEYS TRACKING ################################# + +# Redis implements server assisted support for client side caching of values. +# This is implemented using an invalidation table that remembers, using +# a radix key indexed by key name, what clients have which keys. In turn +# this is used in order to send invalidation messages to clients. Please +# check this page to understand more about the feature: +# +# https://redis.io/topics/client-side-caching +# +# When tracking is enabled for a client, all the read only queries are assumed +# to be cached: this will force Redis to store information in the invalidation +# table. When keys are modified, such information is flushed away, and +# invalidation messages are sent to the clients. However if the workload is +# heavily dominated by reads, Redis could use more and more memory in order +# to track the keys fetched by many clients. +# +# For this reason it is possible to configure a maximum fill value for the +# invalidation table. By default it is set to 1M of keys, and once this limit +# is reached, Redis will start to evict keys in the invalidation table +# even if they were not modified, just to reclaim memory: this will in turn +# force the clients to invalidate the cached values. Basically the table +# maximum size is a trade off between the memory you want to spend server +# side to track information about who cached what, and the ability of clients +# to retain cached objects in memory. +# +# If you set the value to 0, it means there are no limits, and Redis will +# retain as many keys as needed in the invalidation table. +# In the "stats" INFO section, you can find information about the number of +# keys in the invalidation table at every given moment. +# +# Note: when key tracking is used in broadcasting mode, no memory is used +# in the server side so this setting is useless. +# +# tracking-table-max-keys 1000000 + +################################## SECURITY ################################### + +# Warning: since Redis is pretty fast, an outside user can try up to +# 1 million passwords per second against a modern box. This means that you +# should use very strong passwords, otherwise they will be very easy to break. +# Note that because the password is really a shared secret between the client +# and the server, and should not be memorized by any human, the password +# can be easily a long string from /dev/urandom or whatever, so by using a +# long and unguessable password no brute force attack will be possible. + +# Redis ACL users are defined in the following format: +# +# user ... acl rules ... +# +# For example: +# +# user worker +@list +@connection ~jobs:* on >ffa9203c493aa99 +# +# The special username "default" is used for new connections. If this user +# has the "nopass" rule, then new connections will be immediately authenticated +# as the "default" user without the need of any password provided via the +# AUTH command. Otherwise if the "default" user is not flagged with "nopass" +# the connections will start in not authenticated state, and will require +# AUTH (or the HELLO command AUTH option) in order to be authenticated and +# start to work. +# +# The ACL rules that describe what a user can do are the following: +# +# on Enable the user: it is possible to authenticate as this user. +# off Disable the user: it's no longer possible to authenticate +# with this user, however the already authenticated connections +# will still work. +# skip-sanitize-payload RESTORE dump-payload sanitization is skipped. +# sanitize-payload RESTORE dump-payload is sanitized (default). +# + Allow the execution of that command. +# May be used with `|` for allowing subcommands (e.g "+config|get") +# - Disallow the execution of that command. +# May be used with `|` for blocking subcommands (e.g "-config|set") +# +@ Allow the execution of all the commands in such category +# with valid categories are like @admin, @set, @sortedset, ... +# and so forth, see the full list in the server.c file where +# the Redis command table is described and defined. +# The special category @all means all the commands, but currently +# present in the server, and that will be loaded in the future +# via modules. +# +|first-arg Allow a specific first argument of an otherwise +# disabled command. It is only supported on commands with +# no sub-commands, and is not allowed as negative form +# like -SELECT|1, only additive starting with "+". This +# feature is deprecated and may be removed in the future. +# allcommands Alias for +@all. Note that it implies the ability to execute +# all the future commands loaded via the modules system. +# nocommands Alias for -@all. +# ~ Add a pattern of keys that can be mentioned as part of +# commands. For instance ~* allows all the keys. The pattern +# is a glob-style pattern like the one of KEYS. +# It is possible to specify multiple patterns. +# %R~ Add key read pattern that specifies which keys can be read +# from. +# %W~ Add key write pattern that specifies which keys can be +# written to. +# allkeys Alias for ~* +# resetkeys Flush the list of allowed keys patterns. +# & Add a glob-style pattern of Pub/Sub channels that can be +# accessed by the user. It is possible to specify multiple channel +# patterns. +# allchannels Alias for &* +# resetchannels Flush the list of allowed channel patterns. +# > Add this password to the list of valid password for the user. +# For example >mypass will add "mypass" to the list. +# This directive clears the "nopass" flag (see later). +# < Remove this password from the list of valid passwords. +# nopass All the set passwords of the user are removed, and the user +# is flagged as requiring no password: it means that every +# password will work against this user. If this directive is +# used for the default user, every new connection will be +# immediately authenticated with the default user without +# any explicit AUTH command required. Note that the "resetpass" +# directive will clear this condition. +# resetpass Flush the list of allowed passwords. Moreover removes the +# "nopass" status. After "resetpass" the user has no associated +# passwords and there is no way to authenticate without adding +# some password (or setting it as "nopass" later). +# reset Performs the following actions: resetpass, resetkeys, resetchannels, +# allchannels (if acl-pubsub-default is set), off, clearselectors, -@all. +# The user returns to the same state it has immediately after its creation. +# () Create a new selector with the options specified within the +# parentheses and attach it to the user. Each option should be +# space separated. The first character must be ( and the last +# character must be ). +# clearselectors Remove all of the currently attached selectors. +# Note this does not change the "root" user permissions, +# which are the permissions directly applied onto the +# user (outside the parentheses). +# +# ACL rules can be specified in any order: for instance you can start with +# passwords, then flags, or key patterns. However note that the additive +# and subtractive rules will CHANGE MEANING depending on the ordering. +# For instance see the following example: +# +# user alice on +@all -DEBUG ~* >somepassword +# +# This will allow "alice" to use all the commands with the exception of the +# DEBUG command, since +@all added all the commands to the set of the commands +# alice can use, and later DEBUG was removed. However if we invert the order +# of two ACL rules the result will be different: +# +# user alice on -DEBUG +@all ~* >somepassword +# +# Now DEBUG was removed when alice had yet no commands in the set of allowed +# commands, later all the commands are added, so the user will be able to +# execute everything. +# +# Basically ACL rules are processed left-to-right. +# +# The following is a list of command categories and their meanings: +# * keyspace - Writing or reading from keys, databases, or their metadata +# in a type agnostic way. Includes DEL, RESTORE, DUMP, RENAME, EXISTS, DBSIZE, +# KEYS, EXPIRE, TTL, FLUSHALL, etc. Commands that may modify the keyspace, +# key or metadata will also have `write` category. Commands that only read +# the keyspace, key or metadata will have the `read` category. +# * read - Reading from keys (values or metadata). Note that commands that don't +# interact with keys, will not have either `read` or `write`. +# * write - Writing to keys (values or metadata) +# * admin - Administrative commands. Normal applications will never need to use +# these. Includes REPLICAOF, CONFIG, DEBUG, SAVE, MONITOR, ACL, SHUTDOWN, etc. +# * dangerous - Potentially dangerous (each should be considered with care for +# various reasons). This includes FLUSHALL, MIGRATE, RESTORE, SORT, KEYS, +# CLIENT, DEBUG, INFO, CONFIG, SAVE, REPLICAOF, etc. +# * connection - Commands affecting the connection or other connections. +# This includes AUTH, SELECT, COMMAND, CLIENT, ECHO, PING, etc. +# * blocking - Potentially blocking the connection until released by another +# command. +# * fast - Fast O(1) commands. May loop on the number of arguments, but not the +# number of elements in the key. +# * slow - All commands that are not Fast. +# * pubsub - PUBLISH / SUBSCRIBE related +# * transaction - WATCH / MULTI / EXEC related commands. +# * scripting - Scripting related. +# * set - Data type: sets related. +# * sortedset - Data type: zsets related. +# * list - Data type: lists related. +# * hash - Data type: hashes related. +# * string - Data type: strings related. +# * bitmap - Data type: bitmaps related. +# * hyperloglog - Data type: hyperloglog related. +# * geo - Data type: geo related. +# * stream - Data type: streams related. +# +# For more information about ACL configuration please refer to +# the Redis web site at https://redis.io/topics/acl + +# ACL LOG +# +# The ACL Log tracks failed commands and authentication events associated +# with ACLs. The ACL Log is useful to troubleshoot failed commands blocked +# by ACLs. The ACL Log is stored in memory. You can reclaim memory with +# ACL LOG RESET. Define the maximum entry length of the ACL Log below. +acllog-max-len 128 + +# Using an external ACL file +# +# Instead of configuring users here in this file, it is possible to use +# a stand-alone file just listing users. The two methods cannot be mixed: +# if you configure users here and at the same time you activate the external +# ACL file, the server will refuse to start. +# +# The format of the external ACL user file is exactly the same as the +# format that is used inside stack.conf to describe users. +# +# aclfile /etc/redis/users.acl + +# IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatibility +# layer on top of the new ACL system. The option effect will be just setting +# the password for the default user. Clients will still authenticate using +# AUTH as usually, or more explicitly with AUTH default +# if they follow the new protocol: both will work. +# +# The requirepass is not compatible with aclfile option and the ACL LOAD +# command, these will cause requirepass to be ignored. +# +# requirepass foobared + +# New users are initialized with restrictive permissions by default, via the +# equivalent of this ACL rule 'off resetkeys -@all'. Starting with Redis 6.2, it +# is possible to manage access to Pub/Sub channels with ACL rules as well. The +# default Pub/Sub channels permission if new users is controlled by the +# acl-pubsub-default configuration directive, which accepts one of these values: +# +# allchannels: grants access to all Pub/Sub channels +# resetchannels: revokes access to all Pub/Sub channels +# +# From Redis 7.0, acl-pubsub-default defaults to 'resetchannels' permission. +# +# acl-pubsub-default resetchannels + +# Command renaming (DEPRECATED). +# +# ------------------------------------------------------------------------ +# WARNING: avoid using this option if possible. Instead use ACLs to remove +# commands from the default user, and put them only in some admin user you +# create for administrative purposes. +# ------------------------------------------------------------------------ +# +# It is possible to change the name of dangerous commands in a shared +# environment. For instance the CONFIG command may be renamed into something +# hard to guess so that it will still be available for internal-use tools +# but not available for general clients. +# +# Example: +# +# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 +# +# It is also possible to completely kill a command by renaming it into +# an empty string: +# +# rename-command CONFIG "" +# +# Please note that changing the name of commands that are logged into the +# AOF file or transmitted to replicas may cause problems. + +################################### CLIENTS #################################### + +# Set the max number of connected clients at the same time. By default +# this limit is set to 10000 clients, however if the Redis server is not +# able to configure the process file limit to allow for the specified limit +# the max number of allowed clients is set to the current file limit +# minus 32 (as Redis reserves a few file descriptors for internal uses). +# +# Once the limit is reached Redis will close all the new connections sending +# an error 'max number of clients reached'. +# +# IMPORTANT: When Redis Cluster is used, the max number of connections is also +# shared with the cluster bus: every node in the cluster will use two +# connections, one incoming and another outgoing. It is important to size the +# limit accordingly in case of very large clusters. +# +# maxclients 10000 + +############################## MEMORY MANAGEMENT ################################ + +# Set a memory usage limit to the specified amount of bytes. +# When the memory limit is reached Redis will try to remove keys +# according to the eviction policy selected (see maxmemory-policy). +# +# If Redis can't remove keys according to the policy, or if the policy is +# set to 'noeviction', Redis will start to reply with errors to commands +# that would use more memory, like SET, LPUSH, and so on, and will continue +# to reply to read-only commands like GET. +# +# This option is usually useful when using Redis as an LRU or LFU cache, or to +# set a hard memory limit for an instance (using the 'noeviction' policy). +# +# WARNING: If you have replicas attached to an instance with maxmemory on, +# the size of the output buffers needed to feed the replicas are subtracted +# from the used memory count, so that network problems / resyncs will +# not trigger a loop where keys are evicted, and in turn the output +# buffer of replicas is full with DELs of keys evicted triggering the deletion +# of more keys, and so forth until the database is completely emptied. +# +# In short... if you have replicas attached it is suggested that you set a lower +# limit for maxmemory so that there is some free RAM on the system for replica +# output buffers (but this is not needed if the policy is 'noeviction'). +# +# maxmemory + +# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory +# is reached. You can select one from the following behaviors: +# +# volatile-lru -> Evict using approximated LRU, only keys with an expire set. +# allkeys-lru -> Evict any key using approximated LRU. +# volatile-lfu -> Evict using approximated LFU, only keys with an expire set. +# allkeys-lfu -> Evict any key using approximated LFU. +# volatile-random -> Remove a random key having an expire set. +# allkeys-random -> Remove a random key, any key. +# volatile-ttl -> Remove the key with the nearest expire time (minor TTL) +# noeviction -> Don't evict anything, just return an error on write operations. +# +# LRU means Least Recently Used +# LFU means Least Frequently Used +# +# Both LRU, LFU and volatile-ttl are implemented using approximated +# randomized algorithms. +# +# Note: with any of the above policies, when there are no suitable keys for +# eviction, Redis will return an error on write operations that require +# more memory. These are usually commands that create new keys, add data or +# modify existing keys. A few examples are: SET, INCR, HSET, LPUSH, SUNIONSTORE, +# SORT (due to the STORE argument), and EXEC (if the transaction includes any +# command that requires memory). +# +# The default is: +# +# maxmemory-policy noeviction + +# LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated +# algorithms (in order to save memory), so you can tune it for speed or +# accuracy. By default Redis will check five keys and pick the one that was +# used least recently, you can change the sample size using the following +# configuration directive. +# +# The default of 5 produces good enough results. 10 Approximates very closely +# true LRU but costs more CPU. 3 is faster but not very accurate. The maximum +# value that can be set is 64. +# +# maxmemory-samples 5 + +# Eviction processing is designed to function well with the default setting. +# If there is an unusually large amount of write traffic, this value may need to +# be increased. Decreasing this value may reduce latency at the risk of +# eviction processing effectiveness +# 0 = minimum latency, 10 = default, 100 = process without regard to latency +# +# maxmemory-eviction-tenacity 10 + +# Starting from Redis 5, by default a replica will ignore its maxmemory setting +# (unless it is promoted to master after a failover or manually). It means +# that the eviction of keys will be just handled by the master, sending the +# DEL commands to the replica as keys evict in the master side. +# +# This behavior ensures that masters and replicas stay consistent, and is usually +# what you want, however if your replica is writable, or you want the replica +# to have a different memory setting, and you are sure all the writes performed +# to the replica are idempotent, then you may change this default (but be sure +# to understand what you are doing). +# +# Note that since the replica by default does not evict, it may end using more +# memory than the one set via maxmemory (there are certain buffers that may +# be larger on the replica, or data structures may sometimes take more memory +# and so forth). So make sure you monitor your replicas and make sure they +# have enough memory to never hit a real out-of-memory condition before the +# master hits the configured maxmemory setting. +# +# replica-ignore-maxmemory yes + +# Redis reclaims expired keys in two ways: upon access when those keys are +# found to be expired, and also in background, in what is called the +# "active expire key". The key space is slowly and interactively scanned +# looking for expired keys to reclaim, so that it is possible to free memory +# of keys that are expired and will never be accessed again in a short time. +# +# The default effort of the expire cycle will try to avoid having more than +# ten percent of expired keys still in memory, and will try to avoid consuming +# more than 25% of total memory and to add latency to the system. However +# it is possible to increase the expire "effort" that is normally set to +# "1", to a greater value, up to the value "10". At its maximum value the +# system will use more CPU, longer cycles (and technically may introduce +# more latency), and will tolerate less already expired keys still present +# in the system. It's a tradeoff between memory, CPU and latency. +# +# active-expire-effort 1 + +############################# LAZY FREEING #################################### + +# Redis has two primitives to delete keys. One is called DEL and is a blocking +# deletion of the object. It means that the server stops processing new commands +# in order to reclaim all the memory associated with an object in a synchronous +# way. If the key deleted is associated with a small object, the time needed +# in order to execute the DEL command is very small and comparable to most other +# O(1) or O(log_N) commands in Redis. However if the key is associated with an +# aggregated value containing millions of elements, the server can block for +# a long time (even seconds) in order to complete the operation. +# +# For the above reasons Redis also offers non blocking deletion primitives +# such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and +# FLUSHDB commands, in order to reclaim memory in background. Those commands +# are executed in constant time. Another thread will incrementally free the +# object in the background as fast as possible. +# +# DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled. +# It's up to the design of the application to understand when it is a good +# idea to use one or the other. However the Redis server sometimes has to +# delete keys or flush the whole database as a side effect of other operations. +# Specifically Redis deletes objects independently of a user call in the +# following scenarios: +# +# 1) On eviction, because of the maxmemory and maxmemory policy configurations, +# in order to make room for new data, without going over the specified +# memory limit. +# 2) Because of expire: when a key with an associated time to live (see the +# EXPIRE command) must be deleted from memory. +# 3) Because of a side effect of a command that stores data on a key that may +# already exist. For example the RENAME command may delete the old key +# content when it is replaced with another one. Similarly SUNIONSTORE +# or SORT with STORE option may delete existing keys. The SET command +# itself removes any old content of the specified key in order to replace +# it with the specified string. +# 4) During replication, when a replica performs a full resynchronization with +# its master, the content of the whole database is removed in order to +# load the RDB file just transferred. +# +# In all the above cases the default is to delete objects in a blocking way, +# like if DEL was called. However you can configure each case specifically +# in order to instead release memory in a non-blocking way like if UNLINK +# was called, using the following configuration directives. + +lazyfree-lazy-eviction no +lazyfree-lazy-expire no +lazyfree-lazy-server-del no +replica-lazy-flush no + +# It is also possible, for the case when to replace the user code DEL calls +# with UNLINK calls is not easy, to modify the default behavior of the DEL +# command to act exactly like UNLINK, using the following configuration +# directive: + +lazyfree-lazy-user-del no + +# FLUSHDB, FLUSHALL, SCRIPT FLUSH and FUNCTION FLUSH support both asynchronous and synchronous +# deletion, which can be controlled by passing the [SYNC|ASYNC] flags into the +# commands. When neither flag is passed, this directive will be used to determine +# if the data should be deleted asynchronously. + +lazyfree-lazy-user-flush no + +################################ THREADED I/O ################################# + +# Redis is mostly single threaded, however there are certain threaded +# operations such as UNLINK, slow I/O accesses and other things that are +# performed on side threads. +# +# Now it is also possible to handle Redis clients socket reads and writes +# in different I/O threads. Since especially writing is so slow, normally +# Redis users use pipelining in order to speed up the Redis performances per +# core, and spawn multiple instances in order to scale more. Using I/O +# threads it is possible to easily speedup two times Redis without resorting +# to pipelining nor sharding of the instance. +# +# By default threading is disabled, we suggest enabling it only in machines +# that have at least 4 or more cores, leaving at least one spare core. +# Using more than 8 threads is unlikely to help much. We also recommend using +# threaded I/O only if you actually have performance problems, with Redis +# instances being able to use a quite big percentage of CPU time, otherwise +# there is no point in using this feature. +# +# So for instance if you have a four cores boxes, try to use 2 or 3 I/O +# threads, if you have a 8 cores, try to use 6 threads. In order to +# enable I/O threads use the following configuration directive: +# +# io-threads 4 +# +# Setting io-threads to 1 will just use the main thread as usual. +# When I/O threads are enabled, we only use threads for writes, that is +# to thread the write(2) syscall and transfer the client buffers to the +# socket. However it is also possible to enable threading of reads and +# protocol parsing using the following configuration directive, by setting +# it to yes: +# +# io-threads-do-reads no +# +# Usually threading reads doesn't help much. +# +# NOTE 1: This configuration directive cannot be changed at runtime via +# CONFIG SET. Also, this feature currently does not work when SSL is +# enabled. +# +# NOTE 2: If you want to test the Redis speedup using redis-benchmark, make +# sure you also run the benchmark itself in threaded mode, using the +# --threads option to match the number of Redis threads, otherwise you'll not +# be able to notice the improvements. + +############################ KERNEL OOM CONTROL ############################## + +# On Linux, it is possible to hint the kernel OOM killer on what processes +# should be killed first when out of memory. +# +# Enabling this feature makes Redis actively control the oom_score_adj value +# for all its processes, depending on their role. The default scores will +# attempt to have background child processes killed before all others, and +# replicas killed before masters. +# +# Redis supports these options: +# +# no: Don't make changes to oom-score-adj (default). +# yes: Alias to "relative" see below. +# absolute: Values in oom-score-adj-values are written as is to the kernel. +# relative: Values are used relative to the initial value of oom_score_adj when +# the server starts and are then clamped to a range of -1000 to 1000. +# Because typically the initial value is 0, they will often match the +# absolute values. +oom-score-adj no + +# When oom-score-adj is used, this directive controls the specific values used +# for master, replica and background child processes. Values range -2000 to +# 2000 (higher means more likely to be killed). +# +# Unprivileged processes (not root, and without CAP_SYS_RESOURCE capabilities) +# can freely increase their value, but not decrease it below its initial +# settings. This means that setting oom-score-adj to "relative" and setting the +# oom-score-adj-values to positive values will always succeed. +oom-score-adj-values 0 200 800 + + +#################### KERNEL transparent hugepage CONTROL ###################### + +# Usually the kernel Transparent Huge Pages control is set to "madvise" or +# or "never" by default (/sys/kernel/mm/transparent_hugepage/enabled), in which +# case this config has no effect. On systems in which it is set to "always", +# redis will attempt to disable it specifically for the redis process in order +# to avoid latency problems specifically with fork(2) and CoW. +# If for some reason you prefer to keep it enabled, you can set this config to +# "no" and the kernel global to "always". + +disable-thp yes + +############################## APPEND ONLY MODE ############################### + +# By default Redis asynchronously dumps the dataset on disk. This mode is +# good enough in many applications, but an issue with the Redis process or +# a power outage may result into a few minutes of writes lost (depending on +# the configured save points). +# +# The Append Only File is an alternative persistence mode that provides +# much better durability. For instance using the default data fsync policy +# (see later in the config file) Redis can lose just one second of writes in a +# dramatic event like a server power outage, or a single write if something +# wrong with the Redis process itself happens, but the operating system is +# still running correctly. +# +# AOF and RDB persistence can be enabled at the same time without problems. +# If the AOF is enabled on startup Redis will load the AOF, that is the file +# with the better durability guarantees. +# +# Note that changing this value in a config file of an existing database and +# restarting the server can lead to data loss. A conversion needs to be done +# by setting it via CONFIG command on a live server first. +# +# Please check https://redis.io/topics/persistence for more information. + +appendonly no + +# The base name of the append only file. +# +# Redis 7 and newer use a set of append-only files to persist the dataset +# and changes applied to it. There are two basic types of files in use: +# +# - Base files, which are a snapshot representing the complete state of the +# dataset at the time the file was created. Base files can be either in +# the form of RDB (binary serialized) or AOF (textual commands). +# - Incremental files, which contain additional commands that were applied +# to the dataset following the previous file. +# +# In addition, manifest files are used to track the files and the order in +# which they were created and should be applied. +# +# Append-only file names are created by Redis following a specific pattern. +# The file name's prefix is based on the 'appendfilename' configuration +# parameter, followed by additional information about the sequence and type. +# +# For example, if appendfilename is set to appendonly.aof, the following file +# names could be derived: +# +# - appendonly.aof.1.base.rdb as a base file. +# - appendonly.aof.1.incr.aof, appendonly.aof.2.incr.aof as incremental files. +# - appendonly.aof.manifest as a manifest file. + +appendfilename "appendonly.aof" + +# For convenience, Redis stores all persistent append-only files in a dedicated +# directory. The name of the directory is determined by the appenddirname +# configuration parameter. + +appenddirname "appendonlydir" + +# The fsync() call tells the Operating System to actually write data on disk +# instead of waiting for more data in the output buffer. Some OS will really flush +# data on disk, some other OS will just try to do it ASAP. +# +# Redis supports three different modes: +# +# no: don't fsync, just let the OS flush the data when it wants. Faster. +# always: fsync after every write to the append only log. Slow, Safest. +# everysec: fsync only one time every second. Compromise. +# +# The default is "everysec", as that's usually the right compromise between +# speed and data safety. It's up to you to understand if you can relax this to +# "no" that will let the operating system flush the output buffer when +# it wants, for better performances (but if you can live with the idea of +# some data loss consider the default persistence mode that's snapshotting), +# or on the contrary, use "always" that's very slow but a bit safer than +# everysec. +# +# More details please check the following article: +# http://antirez.com/post/redis-persistence-demystified.html +# +# If unsure, use "everysec". + +# appendfsync always +appendfsync everysec +# appendfsync no + +# When the AOF fsync policy is set to always or everysec, and a background +# saving process (a background save or AOF log background rewriting) is +# performing a lot of I/O against the disk, in some Linux configurations +# Redis may block too long on the fsync() call. Note that there is no fix for +# this currently, as even performing fsync in a different thread will block +# our synchronous write(2) call. +# +# In order to mitigate this problem it's possible to use the following option +# that will prevent fsync() from being called in the main process while a +# BGSAVE or BGREWRITEAOF is in progress. +# +# This means that while another child is saving, the durability of Redis is +# the same as "appendfsync no". In practical terms, this means that it is +# possible to lose up to 30 seconds of log in the worst scenario (with the +# default Linux settings). +# +# If you have latency problems turn this to "yes". Otherwise leave it as +# "no" that is the safest pick from the point of view of durability. + +no-appendfsync-on-rewrite no + +# Automatic rewrite of the append only file. +# Redis is able to automatically rewrite the log file implicitly calling +# BGREWRITEAOF when the AOF log size grows by the specified percentage. +# +# This is how it works: Redis remembers the size of the AOF file after the +# latest rewrite (if no rewrite has happened since the restart, the size of +# the AOF at startup is used). +# +# This base size is compared to the current size. If the current size is +# bigger than the specified percentage, the rewrite is triggered. Also +# you need to specify a minimal size for the AOF file to be rewritten, this +# is useful to avoid rewriting the AOF file even if the percentage increase +# is reached but it is still pretty small. +# +# Specify a percentage of zero in order to disable the automatic AOF +# rewrite feature. + +auto-aof-rewrite-percentage 100 +auto-aof-rewrite-min-size 64mb + +# An AOF file may be found to be truncated at the end during the Redis +# startup process, when the AOF data gets loaded back into memory. +# This may happen when the system where Redis is running +# crashes, especially when an ext4 filesystem is mounted without the +# data=ordered option (however this can't happen when Redis itself +# crashes or aborts but the operating system still works correctly). +# +# Redis can either exit with an error when this happens, or load as much +# data as possible (the default now) and start if the AOF file is found +# to be truncated at the end. The following option controls this behavior. +# +# If aof-load-truncated is set to yes, a truncated AOF file is loaded and +# the Redis server starts emitting a log to inform the user of the event. +# Otherwise if the option is set to no, the server aborts with an error +# and refuses to start. When the option is set to no, the user requires +# to fix the AOF file using the "redis-check-aof" utility before to restart +# the server. +# +# Note that if the AOF file will be found to be corrupted in the middle +# the server will still exit with an error. This option only applies when +# Redis will try to read more data from the AOF file but not enough bytes +# will be found. +aof-load-truncated yes + +# Redis can create append-only base files in either RDB or AOF formats. Using +# the RDB format is always faster and more efficient, and disabling it is only +# supported for backward compatibility purposes. +aof-use-rdb-preamble yes + +# Redis supports recording timestamp annotations in the AOF to support restoring +# the data from a specific point-in-time. However, using this capability changes +# the AOF format in a way that may not be compatible with existing AOF parsers. +aof-timestamp-enabled no + +################################ SHUTDOWN ##################################### + +# Maximum time to wait for replicas when shutting down, in seconds. +# +# During shut down, a grace period allows any lagging replicas to catch up with +# the latest replication offset before the master exists. This period can +# prevent data loss, especially for deployments without configured disk backups. +# +# The 'shutdown-timeout' value is the grace period's duration in seconds. It is +# only applicable when the instance has replicas. To disable the feature, set +# the value to 0. +# +# shutdown-timeout 10 + +# When Redis receives a SIGINT or SIGTERM, shutdown is initiated and by default +# an RDB snapshot is written to disk in a blocking operation if save points are configured. +# The options used on signaled shutdown can include the following values: +# default: Saves RDB snapshot only if save points are configured. +# Waits for lagging replicas to catch up. +# save: Forces a DB saving operation even if no save points are configured. +# nosave: Prevents DB saving operation even if one or more save points are configured. +# now: Skips waiting for lagging replicas. +# force: Ignores any errors that would normally prevent the server from exiting. +# +# Any combination of values is allowed as long as "save" and "nosave" are not set simultaneously. +# Example: "nosave force now" +# +# shutdown-on-sigint default +# shutdown-on-sigterm default + +################ NON-DETERMINISTIC LONG BLOCKING COMMANDS ##################### + +# Maximum time in milliseconds for EVAL scripts, functions and in some cases +# modules' commands before Redis can start processing or rejecting other clients. +# +# If the maximum execution time is reached Redis will start to reply to most +# commands with a BUSY error. +# +# In this state Redis will only allow a handful of commands to be executed. +# For instance, SCRIPT KILL, FUNCTION KILL, SHUTDOWN NOSAVE and possibly some +# module specific 'allow-busy' commands. +# +# SCRIPT KILL and FUNCTION KILL will only be able to stop a script that did not +# yet call any write commands, so SHUTDOWN NOSAVE may be the only way to stop +# the server in the case a write command was already issued by the script when +# the user doesn't want to wait for the natural termination of the script. +# +# The default is 5 seconds. It is possible to set it to 0 or a negative value +# to disable this mechanism (uninterrupted execution). Note that in the past +# this config had a different name, which is now an alias, so both of these do +# the same: +# lua-time-limit 5000 +# busy-reply-threshold 5000 + +################################ REDIS CLUSTER ############################### + +# Normal Redis instances can't be part of a Redis Cluster; only nodes that are +# started as cluster nodes can. In order to start a Redis instance as a +# cluster node enable the cluster support uncommenting the following: +# +# cluster-enabled yes + +# Every cluster node has a cluster configuration file. This file is not +# intended to be edited by hand. It is created and updated by Redis nodes. +# Every Redis Cluster node requires a different cluster configuration file. +# Make sure that instances running in the same system do not have +# overlapping cluster configuration file names. +# +# cluster-config-file nodes-6379.conf + +# Cluster node timeout is the amount of milliseconds a node must be unreachable +# for it to be considered in failure state. +# Most other internal time limits are a multiple of the node timeout. +# +# cluster-node-timeout 15000 + +# The cluster port is the port that the cluster bus will listen for inbound connections on. When set +# to the default value, 0, it will be bound to the command port + 10000. Setting this value requires +# you to specify the cluster bus port when executing cluster meet. +# cluster-port 0 + +# A replica of a failing master will avoid to start a failover if its data +# looks too old. +# +# There is no simple way for a replica to actually have an exact measure of +# its "data age", so the following two checks are performed: +# +# 1) If there are multiple replicas able to failover, they exchange messages +# in order to try to give an advantage to the replica with the best +# replication offset (more data from the master processed). +# Replicas will try to get their rank by offset, and apply to the start +# of the failover a delay proportional to their rank. +# +# 2) Every single replica computes the time of the last interaction with +# its master. This can be the last ping or command received (if the master +# is still in the "connected" state), or the time that elapsed since the +# disconnection with the master (if the replication link is currently down). +# If the last interaction is too old, the replica will not try to failover +# at all. +# +# The point "2" can be tuned by user. Specifically a replica will not perform +# the failover if, since the last interaction with the master, the time +# elapsed is greater than: +# +# (node-timeout * cluster-replica-validity-factor) + repl-ping-replica-period +# +# So for example if node-timeout is 30 seconds, and the cluster-replica-validity-factor +# is 10, and assuming a default repl-ping-replica-period of 10 seconds, the +# replica will not try to failover if it was not able to talk with the master +# for longer than 310 seconds. +# +# A large cluster-replica-validity-factor may allow replicas with too old data to failover +# a master, while a too small value may prevent the cluster from being able to +# elect a replica at all. +# +# For maximum availability, it is possible to set the cluster-replica-validity-factor +# to a value of 0, which means, that replicas will always try to failover the +# master regardless of the last time they interacted with the master. +# (However they'll always try to apply a delay proportional to their +# offset rank). +# +# Zero is the only value able to guarantee that when all the partitions heal +# the cluster will always be able to continue. +# +# cluster-replica-validity-factor 10 + +# Cluster replicas are able to migrate to orphaned masters, that are masters +# that are left without working replicas. This improves the cluster ability +# to resist to failures as otherwise an orphaned master can't be failed over +# in case of failure if it has no working replicas. +# +# Replicas migrate to orphaned masters only if there are still at least a +# given number of other working replicas for their old master. This number +# is the "migration barrier". A migration barrier of 1 means that a replica +# will migrate only if there is at least 1 other working replica for its master +# and so forth. It usually reflects the number of replicas you want for every +# master in your cluster. +# +# Default is 1 (replicas migrate only if their masters remain with at least +# one replica). To disable migration just set it to a very large value or +# set cluster-allow-replica-migration to 'no'. +# A value of 0 can be set but is useful only for debugging and dangerous +# in production. +# +# cluster-migration-barrier 1 + +# Turning off this option allows to use less automatic cluster configuration. +# It both disables migration to orphaned masters and migration from masters +# that became empty. +# +# Default is 'yes' (allow automatic migrations). +# +# cluster-allow-replica-migration yes + +# By default Redis Cluster nodes stop accepting queries if they detect there +# is at least a hash slot uncovered (no available node is serving it). +# This way if the cluster is partially down (for example a range of hash slots +# are no longer covered) all the cluster becomes, eventually, unavailable. +# It automatically returns available as soon as all the slots are covered again. +# +# However sometimes you want the subset of the cluster which is working, +# to continue to accept queries for the part of the key space that is still +# covered. In order to do so, just set the cluster-require-full-coverage +# option to no. +# +# cluster-require-full-coverage yes + +# This option, when set to yes, prevents replicas from trying to failover its +# master during master failures. However the replica can still perform a +# manual failover, if forced to do so. +# +# This is useful in different scenarios, especially in the case of multiple +# data center operations, where we want one side to never be promoted if not +# in the case of a total DC failure. +# +# cluster-replica-no-failover no + +# This option, when set to yes, allows nodes to serve read traffic while the +# cluster is in a down state, as long as it believes it owns the slots. +# +# This is useful for two cases. The first case is for when an application +# doesn't require consistency of data during node failures or network partitions. +# One example of this is a cache, where as long as the node has the data it +# should be able to serve it. +# +# The second use case is for configurations that don't meet the recommended +# three shards but want to enable cluster mode and scale later. A +# master outage in a 1 or 2 shard configuration causes a read/write outage to the +# entire cluster without this option set, with it set there is only a write outage. +# Without a quorum of masters, slot ownership will not change automatically. +# +# cluster-allow-reads-when-down no + +# This option, when set to yes, allows nodes to serve pubsub shard traffic while +# the cluster is in a down state, as long as it believes it owns the slots. +# +# This is useful if the application would like to use the pubsub feature even when +# the cluster global stable state is not OK. If the application wants to make sure only +# one shard is serving a given channel, this feature should be kept as yes. +# +# cluster-allow-pubsubshard-when-down yes + +# Cluster link send buffer limit is the limit on the memory usage of an individual +# cluster bus link's send buffer in bytes. Cluster links would be freed if they exceed +# this limit. This is to primarily prevent send buffers from growing unbounded on links +# toward slow peers (E.g. PubSub messages being piled up). +# This limit is disabled by default. Enable this limit when 'mem_cluster_links' INFO field +# and/or 'send-buffer-allocated' entries in the 'CLUSTER LINKS` command output continuously increase. +# Minimum limit of 1gb is recommended so that cluster link buffer can fit in at least a single +# PubSub message by default. (client-query-buffer-limit default value is 1gb) +# +# cluster-link-sendbuf-limit 0 + +# Clusters can configure their announced hostname using this config. This is a common use case for +# applications that need to use TLS Server Name Indication (SNI) or dealing with DNS based +# routing. By default this value is only shown as additional metadata in the CLUSTER SLOTS +# command, but can be changed using 'cluster-preferred-endpoint-type' config. This value is +# communicated along the clusterbus to all nodes, setting it to an empty string will remove +# the hostname and also propagate the removal. +# +# cluster-announce-hostname "" + +# Clusters can configure an optional nodename to be used in addition to the node ID for +# debugging and admin information. This name is broadcasted between nodes, so will be used +# in addition to the node ID when reporting cross node events such as node failures. +# cluster-announce-human-nodename "" + +# Clusters can advertise how clients should connect to them using either their IP address, +# a user defined hostname, or by declaring they have no endpoint. Which endpoint is +# shown as the preferred endpoint is set by using the cluster-preferred-endpoint-type +# config with values 'ip', 'hostname', or 'unknown-endpoint'. This value controls how +# the endpoint returned for MOVED/ASKING requests as well as the first field of CLUSTER SLOTS. +# If the preferred endpoint type is set to hostname, but no announced hostname is set, a '?' +# will be returned instead. +# +# When a cluster advertises itself as having an unknown endpoint, it's indicating that +# the server doesn't know how clients can reach the cluster. This can happen in certain +# networking situations where there are multiple possible routes to the node, and the +# server doesn't know which one the client took. In this case, the server is expecting +# the client to reach out on the same endpoint it used for making the last request, but use +# the port provided in the response. +# +# cluster-preferred-endpoint-type ip + +# In order to setup your cluster make sure to read the documentation +# available at https://redis.io web site. + +########################## CLUSTER DOCKER/NAT support ######################## + +# In certain deployments, Redis Cluster nodes address discovery fails, because +# addresses are NAT-ted or because ports are forwarded (the typical case is +# Docker and other containers). +# +# In order to make Redis Cluster working in such environments, a static +# configuration where each node knows its public address is needed. The +# following four options are used for this scope, and are: +# +# * cluster-announce-ip +# * cluster-announce-port +# * cluster-announce-tls-port +# * cluster-announce-bus-port +# +# Each instructs the node about its address, client ports (for connections +# without and with TLS) and cluster message bus port. The information is then +# published in the header of the bus packets so that other nodes will be able to +# correctly map the address of the node publishing the information. +# +# If tls-cluster is set to yes and cluster-announce-tls-port is omitted or set +# to zero, then cluster-announce-port refers to the TLS port. Note also that +# cluster-announce-tls-port has no effect if tls-cluster is set to no. +# +# If the above options are not used, the normal Redis Cluster auto-detection +# will be used instead. +# +# Note that when remapped, the bus port may not be at the fixed offset of +# clients port + 10000, so you can specify any port and bus-port depending +# on how they get remapped. If the bus-port is not set, a fixed offset of +# 10000 will be used as usual. +# +# Example: +# +# cluster-announce-ip 10.1.1.5 +# cluster-announce-tls-port 6379 +# cluster-announce-port 0 +# cluster-announce-bus-port 6380 + +################################## SLOW LOG ################################### + +# The Redis Slow Log is a system to log queries that exceeded a specified +# execution time. The execution time does not include the I/O operations +# like talking with the client, sending the reply and so forth, +# but just the time needed to actually execute the command (this is the only +# stage of command execution where the thread is blocked and can not serve +# other requests in the meantime). +# +# You can configure the slow log with two parameters: one tells Redis +# what is the execution time, in microseconds, to exceed in order for the +# command to get logged, and the other parameter is the length of the +# slow log. When a new command is logged the oldest one is removed from the +# queue of logged commands. + +# The following time is expressed in microseconds, so 1000000 is equivalent +# to one second. Note that a negative number disables the slow log, while +# a value of zero forces the logging of every command. +slowlog-log-slower-than 10000 + +# There is no limit to this length. Just be aware that it will consume memory. +# You can reclaim memory used by the slow log with SLOWLOG RESET. +slowlog-max-len 128 + +################################ LATENCY MONITOR ############################## + +# The Redis latency monitoring subsystem samples different operations +# at runtime in order to collect data related to possible sources of +# latency of a Redis instance. +# +# Via the LATENCY command this information is available to the user that can +# print graphs and obtain reports. +# +# The system only logs operations that were performed in a time equal or +# greater than the amount of milliseconds specified via the +# latency-monitor-threshold configuration directive. When its value is set +# to zero, the latency monitor is turned off. +# +# By default latency monitoring is disabled since it is mostly not needed +# if you don't have latency issues, and collecting data has a performance +# impact, that while very small, can be measured under big load. Latency +# monitoring can easily be enabled at runtime using the command +# "CONFIG SET latency-monitor-threshold " if needed. +latency-monitor-threshold 0 + +################################ LATENCY TRACKING ############################## + +# The Redis extended latency monitoring tracks the per command latencies and enables +# exporting the percentile distribution via the INFO latencystats command, +# and cumulative latency distributions (histograms) via the LATENCY command. +# +# By default, the extended latency monitoring is enabled since the overhead +# of keeping track of the command latency is very small. +# latency-tracking yes + +# By default the exported latency percentiles via the INFO latencystats command +# are the p50, p99, and p999. +# latency-tracking-info-percentiles 50 99 99.9 + +############################# EVENT NOTIFICATION ############################## + +# Redis can notify Pub/Sub clients about events happening in the key space. +# This feature is documented at https://redis.io/topics/notifications +# +# For instance if keyspace events notification is enabled, and a client +# performs a DEL operation on key "foo" stored in the Database 0, two +# messages will be published via Pub/Sub: +# +# PUBLISH __keyspace@0__:foo del +# PUBLISH __keyevent@0__:del foo +# +# It is possible to select the events that Redis will notify among a set +# of classes. Every class is identified by a single character: +# +# K Keyspace events, published with __keyspace@__ prefix. +# E Keyevent events, published with __keyevent@__ prefix. +# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... +# $ String commands +# l List commands +# s Set commands +# h Hash commands +# z Sorted set commands +# x Expired events (events generated every time a key expires) +# e Evicted events (events generated when a key is evicted for maxmemory) +# n New key events (Note: not included in the 'A' class) +# t Stream commands +# d Module key type events +# m Key-miss events (Note: It is not included in the 'A' class) +# A Alias for g$lshzxetd, so that the "AKE" string means all the events +# (Except key-miss events which are excluded from 'A' due to their +# unique nature). +# +# The "notify-keyspace-events" takes as argument a string that is composed +# of zero or multiple characters. The empty string means that notifications +# are disabled. +# +# Example: to enable list and generic events, from the point of view of the +# event name, use: +# +# notify-keyspace-events Elg +# +# Example 2: to get the stream of the expired keys subscribing to channel +# name __keyevent@0__:expired use: +# +# notify-keyspace-events Ex +# +# By default all notifications are disabled because most users don't need +# this feature and the feature has some overhead. Note that if you don't +# specify at least one of K or E, no events will be delivered. +notify-keyspace-events "" + +############################### ADVANCED CONFIG ############################### + +# Hashes are encoded using a memory efficient data structure when they have a +# small number of entries, and the biggest entry does not exceed a given +# threshold. These thresholds can be configured using the following directives. +hash-max-listpack-entries 512 +hash-max-listpack-value 64 + +# Lists are also encoded in a special way to save a lot of space. +# The number of entries allowed per internal list node can be specified +# as a fixed maximum size or a maximum number of elements. +# For a fixed maximum size, use -5 through -1, meaning: +# -5: max size: 64 Kb <-- not recommended for normal workloads +# -4: max size: 32 Kb <-- not recommended +# -3: max size: 16 Kb <-- probably not recommended +# -2: max size: 8 Kb <-- good +# -1: max size: 4 Kb <-- good +# Positive numbers mean store up to _exactly_ that number of elements +# per list node. +# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size), +# but if your use case is unique, adjust the settings as necessary. +list-max-listpack-size -2 + +# Lists may also be compressed. +# Compress depth is the number of quicklist ziplist nodes from *each* side of +# the list to *exclude* from compression. The head and tail of the list +# are always uncompressed for fast push/pop operations. Settings are: +# 0: disable all list compression +# 1: depth 1 means "don't start compressing until after 1 node into the list, +# going from either the head or tail" +# So: [head]->node->node->...->node->[tail] +# [head], [tail] will always be uncompressed; inner nodes will compress. +# 2: [head]->[next]->node->node->...->node->[prev]->[tail] +# 2 here means: don't compress head or head->next or tail->prev or tail, +# but compress all nodes between them. +# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail] +# etc. +list-compress-depth 0 + +# Sets have a special encoding when a set is composed +# of just strings that happen to be integers in radix 10 in the range +# of 64 bit signed integers. +# The following configuration setting sets the limit in the size of the +# set in order to use this special memory saving encoding. +set-max-intset-entries 512 + +# Sets containing non-integer values are also encoded using a memory efficient +# data structure when they have a small number of entries, and the biggest entry +# does not exceed a given threshold. These thresholds can be configured using +# the following directives. +set-max-listpack-entries 128 +set-max-listpack-value 64 + +# Similarly to hashes and lists, sorted sets are also specially encoded in +# order to save a lot of space. This encoding is only used when the length and +# elements of a sorted set are below the following limits: +zset-max-listpack-entries 128 +zset-max-listpack-value 64 + +# HyperLogLog sparse representation bytes limit. The limit includes the +# 16 bytes header. When a HyperLogLog using the sparse representation crosses +# this limit, it is converted into the dense representation. +# +# A value greater than 16000 is totally useless, since at that point the +# dense representation is more memory efficient. +# +# The suggested value is ~ 3000 in order to have the benefits of +# the space efficient encoding without slowing down too much PFADD, +# which is O(N) with the sparse encoding. The value can be raised to +# ~ 10000 when CPU is not a concern, but space is, and the data set is +# composed of many HyperLogLogs with cardinality in the 0 - 15000 range. +hll-sparse-max-bytes 3000 + +# Streams macro node max size / items. The stream data structure is a radix +# tree of big nodes that encode multiple items inside. Using this configuration +# it is possible to configure how big a single node can be in bytes, and the +# maximum number of items it may contain before switching to a new node when +# appending new stream entries. If any of the following settings are set to +# zero, the limit is ignored, so for instance it is possible to set just a +# max entries limit by setting max-bytes to 0 and max-entries to the desired +# value. +stream-node-max-bytes 4096 +stream-node-max-entries 100 + +# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in +# order to help rehashing the main Redis hash table (the one mapping top-level +# keys to values). The hash table implementation Redis uses (see dict.c) +# performs a lazy rehashing: the more operation you run into a hash table +# that is rehashing, the more rehashing "steps" are performed, so if the +# server is idle the rehashing is never complete and some more memory is used +# by the hash table. +# +# The default is to use this millisecond 10 times every second in order to +# actively rehash the main dictionaries, freeing memory when possible. +# +# If unsure: +# use "activerehashing no" if you have hard latency requirements and it is +# not a good thing in your environment that Redis can reply from time to time +# to queries with 2 milliseconds delay. +# +# use "activerehashing yes" if you don't have such hard requirements but +# want to free memory asap when possible. +activerehashing yes + +# The client output buffer limits can be used to force disconnection of clients +# that are not reading data from the server fast enough for some reason (a +# common reason is that a Pub/Sub client can't consume messages as fast as the +# publisher can produce them). +# +# The limit can be set differently for the three different classes of clients: +# +# normal -> normal clients including MONITOR clients +# replica -> replica clients +# pubsub -> clients subscribed to at least one pubsub channel or pattern +# +# The syntax of every client-output-buffer-limit directive is the following: +# +# client-output-buffer-limit +# +# A client is immediately disconnected once the hard limit is reached, or if +# the soft limit is reached and remains reached for the specified number of +# seconds (continuously). +# So for instance if the hard limit is 32 megabytes and the soft limit is +# 16 megabytes / 10 seconds, the client will get disconnected immediately +# if the size of the output buffers reach 32 megabytes, but will also get +# disconnected if the client reaches 16 megabytes and continuously overcomes +# the limit for 10 seconds. +# +# By default normal clients are not limited because they don't receive data +# without asking (in a push way), but just after a request, so only +# asynchronous clients may create a scenario where data is requested faster +# than it can read. +# +# Instead there is a default limit for pubsub and replica clients, since +# subscribers and replicas receive data in a push fashion. +# +# Note that it doesn't make sense to set the replica clients output buffer +# limit lower than the repl-backlog-size config (partial sync will succeed +# and then replica will get disconnected). +# Such a configuration is ignored (the size of repl-backlog-size will be used). +# This doesn't have memory consumption implications since the replica client +# will share the backlog buffers memory. +# +# Both the hard or the soft limit can be disabled by setting them to zero. +client-output-buffer-limit normal 0 0 0 +client-output-buffer-limit replica 256mb 64mb 60 +client-output-buffer-limit pubsub 32mb 8mb 60 + +# Client query buffers accumulate new commands. They are limited to a fixed +# amount by default in order to avoid that a protocol desynchronization (for +# instance due to a bug in the client) will lead to unbound memory usage in +# the query buffer. However you can configure it here if you have very special +# needs, such as a command with huge argument, or huge multi/exec requests or alike. +# +# client-query-buffer-limit 1gb + +# In some scenarios client connections can hog up memory leading to OOM +# errors or data eviction. To avoid this we can cap the accumulated memory +# used by all client connections (all pubsub and normal clients). Once we +# reach that limit connections will be dropped by the server freeing up +# memory. The server will attempt to drop the connections using the most +# memory first. We call this mechanism "client eviction". +# +# Client eviction is configured using the maxmemory-clients setting as follows: +# 0 - client eviction is disabled (default) +# +# A memory value can be used for the client eviction threshold, +# for example: +# maxmemory-clients 1g +# +# A percentage value (between 1% and 100%) means the client eviction threshold +# is based on a percentage of the maxmemory setting. For example to set client +# eviction at 5% of maxmemory: +# maxmemory-clients 5% + +# In the Redis protocol, bulk requests, that are, elements representing single +# strings, are normally limited to 512 mb. However you can change this limit +# here, but must be 1mb or greater +# +# proto-max-bulk-len 512mb + +# Redis calls an internal function to perform many background tasks, like +# closing connections of clients in timeout, purging expired keys that are +# never requested, and so forth. +# +# Not all tasks are performed with the same frequency, but Redis checks for +# tasks to perform according to the specified "hz" value. +# +# By default "hz" is set to 10. Raising the value will use more CPU when +# Redis is idle, but at the same time will make Redis more responsive when +# there are many keys expiring at the same time, and timeouts may be +# handled with more precision. +# +# The range is between 1 and 500, however a value over 100 is usually not +# a good idea. Most users should use the default of 10 and raise this up to +# 100 only in environments where very low latency is required. +hz 10 + +# Normally it is useful to have an HZ value which is proportional to the +# number of clients connected. This is useful in order, for instance, to +# avoid too many clients are processed for each background task invocation +# in order to avoid latency spikes. +# +# Since the default HZ value by default is conservatively set to 10, Redis +# offers, and enables by default, the ability to use an adaptive HZ value +# which will temporarily raise when there are many connected clients. +# +# When dynamic HZ is enabled, the actual configured HZ will be used +# as a baseline, but multiples of the configured HZ value will be actually +# used as needed once more clients are connected. In this way an idle +# instance will use very little CPU time while a busy instance will be +# more responsive. +dynamic-hz yes + +# When a child rewrites the AOF file, if the following option is enabled +# the file will be fsync-ed every 4 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +aof-rewrite-incremental-fsync yes + +# When redis saves RDB file, if the following option is enabled +# the file will be fsync-ed every 4 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +rdb-save-incremental-fsync yes + +# Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good +# idea to start with the default settings and only change them after investigating +# how to improve the performances and how the keys LFU change over time, which +# is possible to inspect via the OBJECT FREQ command. +# +# There are two tunable parameters in the Redis LFU implementation: the +# counter logarithm factor and the counter decay time. It is important to +# understand what the two parameters mean before changing them. +# +# The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis +# uses a probabilistic increment with logarithmic behavior. Given the value +# of the old counter, when a key is accessed, the counter is incremented in +# this way: +# +# 1. A random number R between 0 and 1 is extracted. +# 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1). +# 3. The counter is incremented only if R < P. +# +# The default lfu-log-factor is 10. This is a table of how the frequency +# counter changes with a different number of accesses with different +# logarithmic factors: +# +# +--------+------------+------------+------------+------------+------------+ +# | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits | +# +--------+------------+------------+------------+------------+------------+ +# | 0 | 104 | 255 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 1 | 18 | 49 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 10 | 10 | 18 | 142 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 100 | 8 | 11 | 49 | 143 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# +# NOTE: The above table was obtained by running the following commands: +# +# redis-benchmark -n 1000000 incr foo +# redis-cli object freq foo +# +# NOTE 2: The counter initial value is 5 in order to give new objects a chance +# to accumulate hits. +# +# The counter decay time is the time, in minutes, that must elapse in order +# for the key counter to be decremented. +# +# The default value for the lfu-decay-time is 1. A special value of 0 means we +# will never decay the counter. +# +# lfu-log-factor 10 +# lfu-decay-time 1 + + +# The maximum number of new client connections accepted per event-loop cycle. This configuration +# is set independently for TLS connections. +# +# By default, up to 10 new connection will be accepted per event-loop cycle for normal connections +# and up to 1 new connection per event-loop cycle for TLS connections. +# +# Adjusting this to a larger number can slightly improve efficiency for new connections +# at the risk of causing timeouts for regular commands on established connections. It is +# not advised to change this without ensuring that all clients have limited connection +# pools and exponential backoff in the case of command/connection timeouts. +# +# If your application is establishing a large number of new connections per second you should +# also consider tuning the value of tcp-backlog, which allows the kernel to buffer more +# pending connections before dropping or rejecting connections. +# +# max-new-connections-per-cycle 10 +# max-new-tls-connections-per-cycle 1 + + +########################### ACTIVE DEFRAGMENTATION ####################### +# +# What is active defragmentation? +# ------------------------------- +# +# Active (online) defragmentation allows a Redis server to compact the +# spaces left between small allocations and deallocations of data in memory, +# thus allowing to reclaim back memory. +# +# Fragmentation is a natural process that happens with every allocator (but +# less so with Jemalloc, fortunately) and certain workloads. Normally a server +# restart is needed in order to lower the fragmentation, or at least to flush +# away all the data and create it again. However thanks to this feature +# implemented by Oran Agra for Redis 4.0 this process can happen at runtime +# in a "hot" way, while the server is running. +# +# Basically when the fragmentation is over a certain level (see the +# configuration options below) Redis will start to create new copies of the +# values in contiguous memory regions by exploiting certain specific Jemalloc +# features (in order to understand if an allocation is causing fragmentation +# and to allocate it in a better place), and at the same time, will release the +# old copies of the data. This process, repeated incrementally for all the keys +# will cause the fragmentation to drop back to normal values. +# +# Important things to understand: +# +# 1. This feature is disabled by default, and only works if you compiled Redis +# to use the copy of Jemalloc we ship with the source code of Redis. +# This is the default with Linux builds. +# +# 2. You never need to enable this feature if you don't have fragmentation +# issues. +# +# 3. Once you experience fragmentation, you can enable this feature when +# needed with the command "CONFIG SET activedefrag yes". +# +# The configuration parameters are able to fine tune the behavior of the +# defragmentation process. If you are not sure about what they mean it is +# a good idea to leave the defaults untouched. + +# Active defragmentation is disabled by default +# activedefrag no + +# Minimum amount of fragmentation waste to start active defrag +# active-defrag-ignore-bytes 100mb + +# Minimum percentage of fragmentation to start active defrag +# active-defrag-threshold-lower 10 + +# Maximum percentage of fragmentation at which we use maximum effort +# active-defrag-threshold-upper 100 + +# Minimal effort for defrag in CPU percentage, to be used when the lower +# threshold is reached +# active-defrag-cycle-min 1 + +# Maximal effort for defrag in CPU percentage, to be used when the upper +# threshold is reached +# active-defrag-cycle-max 25 + +# Maximum number of set/hash/zset/list fields that will be processed from +# the main dictionary scan +# active-defrag-max-scan-fields 1000 + +# Jemalloc background thread for purging will be enabled by default +jemalloc-bg-thread yes + +# It is possible to pin different threads and processes of Redis to specific +# CPUs in your system, in order to maximize the performances of the server. +# This is useful both in order to pin different Redis threads in different +# CPUs, but also in order to make sure that multiple Redis instances running +# in the same host will be pinned to different CPUs. +# +# Normally you can do this using the "taskset" command, however it is also +# possible to this via Redis configuration directly, both in Linux and FreeBSD. +# +# You can pin the server/IO threads, bio threads, aof rewrite child process, and +# the bgsave child process. The syntax to specify the cpu list is the same as +# the taskset command: +# +# Set redis server/io threads to cpu affinity 0,2,4,6: +# server-cpulist 0-7:2 +# +# Set bio threads to cpu affinity 1,3: +# bio-cpulist 1,3 +# +# Set aof rewrite child process to cpu affinity 8,9,10,11: +# aof-rewrite-cpulist 8-11 +# +# Set bgsave child process to cpu affinity 1,10,11 +# bgsave-cpulist 1,10-11 + +# In some cases redis will emit warnings and even refuse to start if it detects +# that the system is in bad state, it is possible to suppress these warnings +# by setting the following config which takes a space delimited list of warnings +# to suppress +# +# ignore-warnings ARM64-COW-BUG diff --git a/docs/documentation/AZURE_LLM_GUIDE.md b/docs/documentation/AZURE_LLM_GUIDE.md index e762b9ed4d88..5b0fb127d4d4 100644 --- a/docs/documentation/AZURE_LLM_GUIDE.md +++ b/docs/documentation/AZURE_LLM_GUIDE.md @@ -6,37 +6,26 @@ OpenDevin uses LiteLLM for completion calls. You can find their documentation on ## azure openai configs -During installation of OpenDevin, you can set up the following parameters: +When running the OpenDevin Docker image, you'll need to set the following environment variables using `-e`: ``` LLM_BASE_URL="" # e.g. "https://openai-gpt-4-test-v-1.openai.azure.com/" LLM_API_KEY="" LLM_MODEL="azure/" +AZURE_API_VERSION = "" # e.g. "2024-02-15-preview" ``` -They will be saved in the `config.toml` file in the `OpenDevin` directory. You can add or edit them manually in the file after installation. - -In addition, you need to set the following environment variable, which is used by the LiteLLM library to make requests to the Azure API: - -`AZURE_API_VERSION = "" # e.g. "2024-02-15-preview"` - -You can set the environment variable in your terminal or in an `.env` file in the `OpenDevin` directory. - -Alternatively, you can add all these in .env, however in that case make sure to check the LiteLLM documentation for the correct variables. - # 2. Embeddings OpenDevin uses llama-index for embeddings. You can find their documentation on Azure [here](https://docs.llamaindex.ai/en/stable/api_reference/embeddings/azure_openai/) ## azure openai configs -The model used for Azure OpenAI embeddings is "text-embedding-ada-002". You need the correct deployment name for this model in your Azure account. - -During installation of OpenDevin, you can set the following parameters used for embeddings, when prompted by the makefile: +The model used for Azure OpenAI embeddings is "text-embedding-ada-002". +You need the correct deployment name for this model in your Azure account. +When running OpenDevin in Docker, set the following environment variables using `-e`: ``` LLM_EMBEDDING_MODEL="azureopenai" DEPLOYMENT_NAME = "" # e.g. "TextEmbedding..." LLM_API_VERSION = "" # e.g. "2024-02-15-preview" ``` - -You can re-run ```make setup-config``` anytime, or add or edit them manually in the file afterwards. diff --git a/docs/documentation/LOCAL_LLM_GUIDE.md b/docs/documentation/LOCAL_LLM_GUIDE.md index 14b981882183..c70526327a0f 100644 --- a/docs/documentation/LOCAL_LLM_GUIDE.md +++ b/docs/documentation/LOCAL_LLM_GUIDE.md @@ -7,7 +7,7 @@ Linux: ``` curl -fsSL https://ollama.com/install.sh | sh ``` -Windows or macOS: +Windows or macOS: - Download from [here](https://ollama.com/download/) @@ -60,30 +60,10 @@ sudo systemctl stop ollama For more info go [here](https://github.com/ollama/ollama/blob/main/docs/faq.md) -## 3. Follow the default installation of OpenDevin: -``` -git clone git@github.com:OpenDevin/OpenDevin.git -``` -or -``` -git clone git@github.com:/OpenDevin.git -``` - -then -``` -cd OpenDevin -``` - -## 4. Run setup commands: -``` -make build -make setup-config -``` - -## 5. Modify config file: +## 3. Start OpenDevin -- After running `make setup-config` you will see a generated file `OpenDevin/config.toml`. -- Open this file and modify it to your needs based on this template: +Use the instructions in [README.md](/README.md) to start OpenDevin using Docker. +When running `docker run`, add the following environment variables using `-e`: ``` LLM_API_KEY="ollama" @@ -92,34 +72,25 @@ LLM_EMBEDDING_MODEL="local" LLM_BASE_URL="http://localhost:" WORKSPACE_DIR="./workspace" ``` -Notes: -- The API key should be set to `"ollama"` -- The base url needs to be `localhost` +Notes: +- The API key should be set to `"ollama"` +- The base url needs to be `localhost` - By default ollama port is `11434` unless you set it - `model_name` needs to be the entire model name - Example: `LLM_MODEL="ollama/llama2:13b-chat-q4_K_M"` -## 6. Start OpenDevin: - -At this point everything should be set up and working properly. -1. Start by running the ollama server using the method outlined above -2. Run `make build` in your terminal `~/OpenDevin/` -3. Run `make run` in your terminal -4. If that fails try running the server and front end in sepparate terminals: - - In the first terminal `make start-backend` - - In the second terminal `make start-frontend` -5. you should now be able to connect to `http://localhost:3001/` with your local model running! +You should now be able to connect to `http://localhost:3001/` with your local model running! ## Additional Notes for WSL2 Users: -1. If you encounter the following error during setup: `Exception: Failed to create opendevin user in sandbox: b'useradd: UID 0 is not unique\n'` -You can resolve it by running: +1. If you encounter the following error during setup: `Exception: Failed to create opendevin user in sandbox: b'useradd: UID 0 is not unique\n'` +You can resolve it by running: ``` export SANDBOX_USER_ID=1000 ``` -2. If you face issues running Poetry even after installing it during the build process, you may need to add its binary path to your environment: +2. If you face issues running Poetry even after installing it during the build process, you may need to add its binary path to your environment: ``` export PATH="$HOME/.local/bin:$PATH" ``` @@ -134,4 +105,4 @@ You can resolve it by running: ``` - Save the `.wslconfig` file. - Restart WSL2 completely by exiting any running WSL2 instances and executing the command `wsl --shutdown` in your command prompt or terminal. - - After restarting WSL, attempt to execute `make run` again. The networking issue should be resolved. \ No newline at end of file + - After restarting WSL, attempt to execute `make run` again. The networking issue should be resolved. diff --git a/evaluation/SWE-bench/Makefile b/evaluation/SWE-bench/Makefile deleted file mode 100644 index 1d72f8f46f28..000000000000 --- a/evaluation/SWE-bench/Makefile +++ /dev/null @@ -1,31 +0,0 @@ -DOCKER_BUILD_REGISTRY=ghcr.io -DOCKER_BUILD_ORG=opendevin -DOCKER_BUILD_REPO=eval-swe-bench -DOCKER_BUILD_TAG=v0.1.0 -FULL_IMAGE=$(DOCKER_BUILD_REGISTRY)/$(DOCKER_BUILD_ORG)/$(DOCKER_BUILD_REPO):$(DOCKER_BUILD_TAG) - -LATEST_FULL_IMAGE=$(DOCKER_BUILD_REGISTRY)/$(DOCKER_BUILD_ORG)/$(DOCKER_BUILD_REPO):latest - -MAJOR_VERSION=$(shell echo $(DOCKER_BUILD_TAG) | cut -d. -f1) -MAJOR_FULL_IMAGE=$(DOCKER_BUILD_REGISTRY)/$(DOCKER_BUILD_ORG)/$(DOCKER_BUILD_REPO):$(MAJOR_VERSION) -MINOR_VERSION=$(shell echo $(DOCKER_BUILD_TAG) | cut -d. -f1,2) -MINOR_FULL_IMAGE=$(DOCKER_BUILD_REGISTRY)/$(DOCKER_BUILD_ORG)/$(DOCKER_BUILD_REPO):$(MINOR_VERSION) - -# normally, for local build testing or development. use cross platform build for sharing images to others. -build: - docker build -f Dockerfile -t ${FULL_IMAGE} -t ${LATEST_FULL_IMAGE} . - -push: - docker push ${FULL_IMAGE} ${LATEST_FULL_IMAGE} - -test: - docker buildx build --platform linux/amd64 \ - -t ${FULL_IMAGE} -t ${LATEST_FULL_IMAGE} --load -f Dockerfile . - -# cross platform build, you may need to manually stop the buildx(buildkit) container -all: - docker buildx build --platform linux/amd64,linux/arm64 \ - -t ${FULL_IMAGE} -t ${LATEST_FULL_IMAGE} -t ${MINOR_FULL_IMAGE} --push -f Dockerfile . - -get-full-image: - @echo ${FULL_IMAGE} diff --git a/frontend/.dockerignore b/frontend/.dockerignore index 1e5a276a8285..1481deafc4e0 100644 --- a/frontend/.dockerignore +++ b/frontend/.dockerignore @@ -1,2 +1,3 @@ src/.vite **/*.md +node_modules diff --git a/frontend/.eslintrc b/frontend/.eslintrc index 5d6532c77423..076ff67af45b 100644 --- a/frontend/.eslintrc +++ b/frontend/.eslintrc @@ -32,6 +32,7 @@ "acc", "state" ] }], + "no-duplicate-imports": "warn", "import/no-extraneous-dependencies": "off", "@typescript-eslint/no-unused-vars": "warn", // For https://stackoverflow.com/questions/55844608/stuck-with-eslint-error-i-e-separately-loops-should-be-avoided-in-favor-of-arra diff --git a/frontend/.gitignore b/frontend/.gitignore index 3b4145536f57..c1017dfe2ce3 100644 --- a/frontend/.gitignore +++ b/frontend/.gitignore @@ -2,3 +2,5 @@ public/locales/**/* src/i18n/declaration.ts .vite +.vite +.env diff --git a/frontend/package.json b/frontend/package.json index 87a4461833ef..09ee19217628 100644 --- a/frontend/package.json +++ b/frontend/package.json @@ -24,21 +24,22 @@ "react": "^18.2.0", "react-accessible-treeview": "^2.8.3", "react-dom": "^18.2.0", + "react-hot-toast": "^2.4.1", "react-i18next": "^14.1.0", "react-icons": "^5.0.1", - "react-hot-toast": "^2.4.1", "react-redux": "^9.1.0", "react-syntax-highlighter": "^15.5.0", "tailwind-merge": "^2.2.2", + "vite": "^5.1.6", + "vite-tsconfig-paths": "^4.3.2", "web-vitals": "^2.1.4", - "xterm": "^5.0.0", "xterm-addon-fit": "^0.8.0" }, "scripts": { - "start": "vite --", - "build": "tsc && vite build --", - "test": "jest", - "preview": "vite preview --", + "start": "vite", + "build": "tsc && vite build", + "test": "vitest", + "preview": "vite preview", "make-i18n": "node scripts/make-i18n-translations.cjs", "prelint": "npm run make-i18n", "lint": "eslint src/**/*.ts* && prettier --check src/**/*.ts*", @@ -55,23 +56,20 @@ "prettier --write" ] }, - "jest": { - "preset": "ts-jest/presets/js-with-ts", - "testEnvironment": "jest-environment-jsdom", - "modulePaths": [ - "/src" - ] - }, "devDependencies": { - "@emotion/is-prop-valid": "latest", - "@tsconfig/node18": "^18.2.4", - "@types/jest": "^29.5.12", + "@testing-library/jest-dom": "^6.4.2", + "@testing-library/react": "^13.4.0", + "@testing-library/user-event": "^13.5.0", + "@types/node": "^18.0.0 ", + "@types/react": "^18.2.66", + "@types/react-dom": "^18.2.22", + "@types/react-syntax-highlighter": "^15.5.11", + "@typescript-eslint/eslint-plugin": "^7.4.0", "@typescript-eslint/parser": "^7.0.0", "autoprefixer": "^10.4.19", - "classnames": "^2.5.1", - "csstype": "^3.1.3", "eslint": "^8.57.0", "eslint-config-airbnb": "^19.0.4", + "eslint-config-airbnb-typescript": "^18.0.0", "eslint-config-prettier": "^9.1.0", "eslint-plugin-import": "^2.29.1", "eslint-plugin-jsx-a11y": "^6.8.0", @@ -79,31 +77,15 @@ "eslint-plugin-react": "^7.34.1", "eslint-plugin-react-hooks": "^4.6.0", "husky": "^8.0.0", - "jest": "^29.7.0", - "jest-environment-jsdom": "^29.7.0", + "jsdom": "^24.0.0", "lint-staged": "^15.2.2", - "pnpm": "^8.15.6", "postcss": "^8.4.38", "prettier": "^3.2.5", - "prop-types": "^15.8.1", - "tailwind-variants": "^0.2.1", "tailwindcss": "^3.4.2", - "ts-jest": "^29.1.2", - "@testing-library/dom": "^10.0.0", - "@testing-library/jest-dom": "^6.4.2", - "@testing-library/react": "^13.4.0", - "@testing-library/user-event": "^13.5.0", - "@types/node": "^18.0.0 ", - "@types/react": "^18.2.66", - "@types/react-dom": "^18.2.22", - "@types/react-syntax-highlighter": "^15.5.11", - "@typescript-eslint/eslint-plugin": "^7.4.0", - "eslint-config-airbnb-typescript": "^18.0.0", "typescript": "^5.4.3", - "vite": "^5.1.6", - "vite-tsconfig-paths": "^4.3.2" + "vitest": "^1.5.0" }, - "packageManager": "yarn@1.22.22", + "packageManager": "npm@10.5.0", "volta": { "node": "18.20.1" } diff --git a/frontend/src/App.test.tsx b/frontend/src/App.test.tsx deleted file mode 100644 index d76787ed69b4..000000000000 --- a/frontend/src/App.test.tsx +++ /dev/null @@ -1,9 +0,0 @@ -import React from "react"; -import { render, screen } from "@testing-library/react"; -import App from "./App"; - -test("renders learn react link", () => { - render(); - const linkElement = screen.getByText(/learn react/i); - expect(linkElement).toBeInTheDocument(); -}); diff --git a/frontend/src/components/AgentStatusBar.tsx b/frontend/src/components/AgentStatusBar.tsx index de4bdb524f2f..73c52ee15dd8 100644 --- a/frontend/src/components/AgentStatusBar.tsx +++ b/frontend/src/components/AgentStatusBar.tsx @@ -1,9 +1,9 @@ import React from "react"; -import { Trans } from "react-i18next"; -import i18next from "i18next"; +import { useTranslation } from "react-i18next"; +import { I18nKey } from "../i18n/declaration"; function AgentStatusBar() { - const { t } = i18next; + const { t } = useTranslation(); // TODO: Extend the agent status, e.g.: // - Agent is typing @@ -15,7 +15,7 @@ function AgentStatusBar() {
- CHAT_INTERFACE$INITIALZING_AGENT_LOADING_MESSAGE + {t(I18nKey.CHAT_INTERFACE$INITIALZING_AGENT_LOADING_MESSAGE)}
); diff --git a/frontend/src/components/ChatInterface.tsx b/frontend/src/components/ChatInterface.tsx index 19b4be97978d..971f280a21e0 100644 --- a/frontend/src/components/ChatInterface.tsx +++ b/frontend/src/components/ChatInterface.tsx @@ -101,7 +101,7 @@ function MessageList(): JSX.Element { ))} {typingActive && ( -
+
diff --git a/frontend/src/components/Files.tsx b/frontend/src/components/Files.tsx index 57b7ec814462..be3d91554f76 100644 --- a/frontend/src/components/Files.tsx +++ b/frontend/src/components/Files.tsx @@ -7,9 +7,9 @@ import TreeView, { import { AiOutlineFolder } from "react-icons/ai"; import { + IoIosArrowBack, IoIosArrowDown, IoIosArrowForward, - IoIosArrowBack, IoIosRefresh, } from "react-icons/io"; @@ -33,7 +33,12 @@ function RefreshButton({ }: Omit): React.ReactElement { return ( } + icon={ + + } onClick={onClick} ariaLabel={ariaLabel} /> @@ -46,7 +51,12 @@ function CloseButton({ }: Omit): React.ReactElement { return ( } + icon={ + + } onClick={onClick} ariaLabel={ariaLabel} /> @@ -68,6 +78,7 @@ function Files({ useEffect(() => { getWorkspace().then((file) => dispatch(updateWorkspace(file))); + // eslint-disable-next-line react-hooks/exhaustive-deps }, []); if (workspaceTree.length <= 1) { @@ -82,7 +93,7 @@ function Files({
setExplorerOpen(true)} />
@@ -111,7 +122,7 @@ function Files({ return (
-
+
{workspaceFolder.name} -
- - getWorkspace().then((file) => - dispatch(updateWorkspace(file)), - ) - } - ariaLabel="Refresh" - /> - setExplorerOpen(false)} - ariaLabel="Close Explorer" - /> -
} className="editor-accordion" @@ -185,6 +182,18 @@ function Files({
+
+ + getWorkspace().then((file) => dispatch(updateWorkspace(file))) + } + ariaLabel="Refresh" + /> + setExplorerOpen(false)} + ariaLabel="Close Explorer" + /> +
); diff --git a/frontend/src/components/Input.tsx b/frontend/src/components/Input.tsx index 75d95f81ddf3..2fc01ea8e5b6 100644 --- a/frontend/src/components/Input.tsx +++ b/frontend/src/components/Input.tsx @@ -3,7 +3,6 @@ import React, { ChangeEvent, KeyboardEvent, useState } from "react"; import { useTranslation } from "react-i18next"; import { VscSend } from "react-icons/vsc"; import { useSelector } from "react-redux"; -import { useTranslation } from "react-i18next"; import { twMerge } from "tailwind-merge"; import useInputComposition from "../hooks/useInputComposition"; import { I18nKey } from "../i18n/declaration"; @@ -13,7 +12,6 @@ import { RootState } from "../store"; function Input() { const { t } = useTranslation(); const { initialized } = useSelector((state: RootState) => state.task); - const { t } = useTranslation(); const [inputMessage, setInputMessage] = useState(""); const handleSendMessage = () => { @@ -39,7 +37,6 @@ function Input() { return; } e.preventDefault(); - e.stopPropagation(); handleSendMessage(); } }; diff --git a/frontend/src/components/LoadMessageModal.tsx b/frontend/src/components/LoadMessageModal.tsx index bc4caf995449..ef0262dfb96b 100644 --- a/frontend/src/components/LoadMessageModal.tsx +++ b/frontend/src/components/LoadMessageModal.tsx @@ -1,77 +1,82 @@ import React from "react"; -import { - Modal, - ModalContent, - ModalHeader, - ModalBody, - ModalFooter, - Button, -} from "@nextui-org/react"; +import { Button } from "@nextui-org/react"; import { fetchMsgs, clearMsgs } from "../services/session"; import { sendChatMessageFromEvent } from "../services/chatService"; import { handleAssistantMessage } from "../services/actions"; import { ResFetchMsg } from "../types/ResponseType"; +import ODModal from "./ODModal"; +import toast from "../utils/toast"; -interface Props { +interface LoadMessageModalProps { isOpen: boolean; onClose: () => void; } -function LoadMessageModal({ isOpen, onClose }: Props): JSX.Element { - const handleDelMsg = () => { +function LoadMessageModal({ + isOpen, + onClose, +}: LoadMessageModalProps): JSX.Element { + const handleStartNewSession = () => { clearMsgs().then().catch(); onClose(); }; - const handleLoadMsg = () => { - fetchMsgs() - .then((data) => { - if ( - data === undefined || - data.messages === undefined || - data.messages.length === 0 - ) { - return; + const handleResumeSession = async () => { + try { + const data = await fetchMsgs(); + if (!data || !data.messages || data.messages.length === 0) { + return; + } + + data.messages.forEach((msg: ResFetchMsg) => { + switch (msg.role) { + case "user": + sendChatMessageFromEvent(msg.payload); + break; + case "assistant": + handleAssistantMessage(msg.payload); + break; + default: + break; } - const { messages } = data; - messages.forEach((msg: ResFetchMsg) => { - switch (msg.role) { - case "user": - sendChatMessageFromEvent(msg.payload); - break; - case "assistant": - handleAssistantMessage(msg.payload); - break; - default: - } - }); - }) - .catch(); - onClose(); + }); + + onClose(); + } catch (error) { + toast.stickyError("ws", "Error fetching the session"); + } }; return ( - - - <> - - Unfinished Session Detected - - - You have an unfinished session. Do you want to load it? - - - - - - - - - + + Resume Session + + } + secondaryAction={ + + } + > +

+ You seem to have an unfinished task. Would you like to pick up where you + left off or start fresh? +

+ ); } diff --git a/frontend/src/components/ODModal.tsx b/frontend/src/components/ODModal.tsx new file mode 100644 index 000000000000..c36ea6fca4b9 --- /dev/null +++ b/frontend/src/components/ODModal.tsx @@ -0,0 +1,71 @@ +import React from "react"; +import { + ModalProps, + Modal, + ModalBody, + ModalContent, + ModalFooter, + ModalHeader, +} from "@nextui-org/react"; + +interface ODModalProps extends Omit { + title?: string; + subtitle?: string; + primaryAction?: React.ReactNode; + secondaryAction?: React.ReactNode; + children: React.ReactNode; + isOpen: boolean; + onClose: () => void; + size: "sm" | "md"; +} + +function ODModal(props: ODModalProps): React.ReactElement { + const { + children, + title, + subtitle, + primaryAction, + secondaryAction, + size, + ...modalProps + } = props; + + return ( + + + + {title &&

{title}

} + {subtitle && ( + + {subtitle} + + )} + + {children} + {(primaryAction || secondaryAction) && ( + + {primaryAction} + {secondaryAction} + + )} + + + ); +} + +ODModal.defaultProps = { + title: "", + subtitle: "", + primaryAction: null, + secondaryAction: null, +}; + +export default ODModal; diff --git a/frontend/src/components/Resizable.tsx b/frontend/src/components/Resizable.tsx index bc617e4d2105..4d7663e45963 100644 --- a/frontend/src/components/Resizable.tsx +++ b/frontend/src/components/Resizable.tsx @@ -42,7 +42,6 @@ export function Container({ }, [firstSize, orientation]); const onMouseMove = (e: MouseEvent) => { - e.stopPropagation(); e.preventDefault(); if (firstSize && dividerPosition) { if (orientation === Orientation.HORIZONTAL) { @@ -64,7 +63,6 @@ export function Container({ const onMouseDown = (e: React.MouseEvent) => { e.preventDefault(); - e.stopPropagation(); setDividerPosition( orientation === Orientation.HORIZONTAL ? e.clientX : e.clientY, ); diff --git a/frontend/src/components/SettingModal.tsx b/frontend/src/components/SettingModal.tsx index 4042203f0745..79df456508f5 100644 --- a/frontend/src/components/SettingModal.tsx +++ b/frontend/src/components/SettingModal.tsx @@ -4,11 +4,6 @@ import { Autocomplete, AutocompleteItem, Button, - Modal, - ModalBody, - ModalContent, - ModalFooter, - ModalHeader, Select, SelectItem, } from "@nextui-org/react"; @@ -25,6 +20,7 @@ import { RootState } from "../store"; import { I18nKey } from "../i18n/declaration"; import { AvailableLanguages } from "../i18n"; import { ArgConfigType } from "../types/ConfigType"; +import ODModal from "./ODModal"; interface Props { isOpen: boolean; @@ -88,82 +84,83 @@ function InnerSettingModal({ isOpen, onClose }: Props): JSX.Element { item.toLowerCase().includes(input.toLowerCase()); return ( - - - <> - - {t(I18nKey.CONFIGURATION$MODAL_TITLE)} - - - ({ - label: v, - value: v, - }))} - label={t(I18nKey.CONFIGURATION$MODEL_SELECT_LABEL)} - placeholder={t(I18nKey.CONFIGURATION$MODEL_SELECT_PLACEHOLDER)} - selectedKey={model} - onSelectionChange={(key) => { - setModel(key as string); - }} - onInputChange={(e) => setInputModel(e)} - onKeyDown={(e: KeyboardEvent) => e.continuePropagation()} - defaultFilter={customFilter} - defaultInputValue={inputModel} - allowsCustomValue - > - {(item: { label: string; value: string }) => ( - - {item.label} - - )} - - - ({ - label: v, - value: v, - }))} - label={t(I18nKey.CONFIGURATION$AGENT_SELECT_LABEL)} - placeholder={t(I18nKey.CONFIGURATION$AGENT_SELECT_PLACEHOLDER)} - defaultSelectedKey={agent} - onSelectionChange={(key) => { - setAgent(key as string); - }} - onKeyDown={(e: KeyboardEvent) => e.continuePropagation()} - defaultFilter={customFilter} - > - {(item: { label: string; value: string }) => ( - - {item.label} - - )} - - - - - - - - - - - + + {t(I18nKey.CONFIGURATION$MODAL_SAVE_BUTTON_LABEL)} + + } + secondaryAction={ + + } + > + <> + ({ + label: v, + value: v, + }))} + label={t(I18nKey.CONFIGURATION$MODEL_SELECT_LABEL)} + placeholder={t(I18nKey.CONFIGURATION$MODEL_SELECT_PLACEHOLDER)} + selectedKey={model} + onSelectionChange={(key) => { + setModel(key as string); + }} + onInputChange={(e) => setInputModel(e)} + onKeyDown={(e: KeyboardEvent) => e.continuePropagation()} + defaultFilter={customFilter} + defaultInputValue={inputModel} + allowsCustomValue + > + {(item: { label: string; value: string }) => ( + + {item.label} + + )} + + ({ + label: v, + value: v, + }))} + label={t(I18nKey.CONFIGURATION$AGENT_SELECT_LABEL)} + placeholder={t(I18nKey.CONFIGURATION$AGENT_SELECT_PLACEHOLDER)} + defaultSelectedKey={agent} + onSelectionChange={(key) => { + setAgent(key as string); + }} + onKeyDown={(e: KeyboardEvent) => e.continuePropagation()} + defaultFilter={customFilter} + > + {(item: { label: string; value: string }) => ( + + {item.label} + + )} + + + + ); } diff --git a/frontend/src/components/Workspace.tsx b/frontend/src/components/Workspace.tsx index a0c2832fae91..c60293345703 100644 --- a/frontend/src/components/Workspace.tsx +++ b/frontend/src/components/Workspace.tsx @@ -23,7 +23,7 @@ function Workspace() { }, [TabOption.CODE]: { name: t(I18nKey.WORKSPACE$CODE_EDITOR_TAB_LABEL), - icon: , + icon: , component: , }, [TabOption.BROWSER]: { diff --git a/frontend/src/hooks/useInputComposition.test.ts b/frontend/src/hooks/useInputComposition.test.ts new file mode 100644 index 000000000000..c1669666cfbb --- /dev/null +++ b/frontend/src/hooks/useInputComposition.test.ts @@ -0,0 +1,35 @@ +import { act, renderHook } from "@testing-library/react"; +import useInputComposition from "./useInputComposition"; + +describe("useInputComposition", () => { + it("should return isComposing as false by default", () => { + const { result } = renderHook(() => useInputComposition()); + expect(result.current.isComposing).toBe(false); + }); + + it("should set isComposing to true when onCompositionStart is called", () => { + const { result } = renderHook(() => useInputComposition()); + + act(() => { + result.current.onCompositionStart(); + }); + + expect(result.current.isComposing).toBe(true); + }); + + it("should set isComposing to false when onCompositionEnd is called", () => { + const { result } = renderHook(() => useInputComposition()); + + act(() => { + result.current.onCompositionStart(); + }); + + expect(result.current.isComposing).toBe(true); + + act(() => { + result.current.onCompositionEnd(); + }); + + expect(result.current.isComposing).toBe(false); + }); +}); diff --git a/frontend/src/hooks/useTypingEffect.test.ts b/frontend/src/hooks/useTypingEffect.test.ts new file mode 100644 index 000000000000..18942d0b0a4e --- /dev/null +++ b/frontend/src/hooks/useTypingEffect.test.ts @@ -0,0 +1,156 @@ +import { renderHook, act } from "@testing-library/react"; +import { useTypingEffect } from "./useTypingEffect"; + +describe("useTypingEffect", () => { + beforeEach(() => { + vi.useFakeTimers(); + }); + + afterEach(() => { + vi.clearAllTimers(); + }); + + // This test fails because the hook improperly handles this case. + it.skip("should handle empty strings array", () => { + const { result } = renderHook(() => useTypingEffect([])); + + // Immediately check the result since there's nothing to type + expect(result.current).toBe("\u00A0"); // Non-breaking space + }); + + it("should type out a string correctly", () => { + const message = "Hello, world! This is a test message."; + + const { result } = renderHook(() => useTypingEffect([message])); + + // msg.length - 2 because the first two characters are typed immediately + // 100ms per character, 0.1 playbackRate + const msToRun = (message.length - 2) * 100 * 0.1; + + // Fast-forward time by to simulate typing message + act(() => { + vi.advanceTimersByTime(msToRun - 1); // exclude the last character for testing + }); + + expect(result.current).toBe(message.slice(0, -1)); + + act(() => { + vi.advanceTimersByTime(1); // include the last character + }); + + expect(result.current).toBe(message); + }); + + it("should type of a string correctly with a different playback rate", () => { + const message = "Hello, world! This is a test message."; + const playbackRate = 0.5; + + const { result } = renderHook(() => + useTypingEffect([message], { playbackRate }), + ); + + const msToRun = (message.length - 2) * 100 * playbackRate; + + act(() => { + vi.advanceTimersByTime(msToRun - 1); // exclude the last character for testing + }); + + expect(result.current).toBe(message.slice(0, -1)); + + act(() => { + vi.advanceTimersByTime(1); // include the last character + }); + + expect(result.current).toBe(message); + }); + + it("should loop through strings when multiple are provided", () => { + const messages = ["Hello", "World"]; + + const { result } = renderHook(() => useTypingEffect(messages)); + + const msToRunFirstString = messages[0].length * 100 * 0.1; + + // Fast-forward to end of first string + act(() => { + vi.advanceTimersByTime(msToRunFirstString); + }); + + expect(result.current).toBe(messages[0]); // Hello + + // Fast-forward through the delay and through the second string + act(() => { + // TODO: Improve to clarify the expected timing + vi.runAllTimers(); + }); + + expect(result.current).toBe(messages[1]); // World + }); + + it("should call setTypingActive with false when typing completes without loop", () => { + const setTypingActiveMock = vi.fn(); + + renderHook(() => + useTypingEffect(["Hello, world!", "This is a test message."], { + loop: false, + setTypingActive: setTypingActiveMock, + }), + ); + + expect(setTypingActiveMock).not.toHaveBeenCalled(); + + act(() => { + vi.runAllTimers(); + }); + + expect(setTypingActiveMock).toHaveBeenCalledWith(false); + expect(setTypingActiveMock).toHaveBeenCalledTimes(1); + }); + + it("should call addAssistantMessageToChat with the typeThis argument when typing completes without loop", () => { + const addAssistantMessageToChatMock = vi.fn(); + + renderHook(() => + useTypingEffect(["Hello, world!", "This is a test message."], { + loop: false, + // Note that only "Hello, world!" is typed out (the first string in the array) + typeThis: { content: "Hello, world!", sender: "assistant" }, + addAssistantMessageToChat: addAssistantMessageToChatMock, + }), + ); + + expect(addAssistantMessageToChatMock).not.toHaveBeenCalled(); + + act(() => { + vi.runAllTimers(); + }); + + expect(addAssistantMessageToChatMock).toHaveBeenCalledTimes(1); + expect(addAssistantMessageToChatMock).toHaveBeenCalledWith({ + content: "Hello, world!", + sender: "assistant", + }); + }); + + it("should call takeOneAndType when typing completes without loop", () => { + const takeOneAndTypeMock = vi.fn(); + + renderHook(() => + useTypingEffect(["Hello, world!", "This is a test message."], { + loop: false, + takeOneAndType: takeOneAndTypeMock, + }), + ); + + expect(takeOneAndTypeMock).not.toHaveBeenCalled(); + + act(() => { + vi.runAllTimers(); + }); + + expect(takeOneAndTypeMock).toHaveBeenCalledTimes(1); + }); + + // Implementation is not clear on how to handle this case + it.todo("should handle typing with loop"); +}); diff --git a/frontend/src/i18n/translation.json b/frontend/src/i18n/translation.json index 46053dd25967..53944c828c8e 100644 --- a/frontend/src/i18n/translation.json +++ b/frontend/src/i18n/translation.json @@ -95,6 +95,18 @@ "es": "Configuración", "tr": "Konfigürasyon" }, + "CONFIGURATION$MODAL_SUB_TITLE": { + "en": "Adjust settings to your liking", + "zh-CN": "根据您的喜好调整设置", + "de": "Passen Sie die Einstellungen nach Ihren Wünschen an ", + "ko-KR": "원하는 대로 설정 조정", + "no": "Juster innstillinger etter dine ønsker ", + "zh-TW": "調整設定以符合您的喜好", + "it": "Regola le impostazioni in base alle tue preferenze", + "pt": "Ajuste as configurações de acordo com sua preferência", + "es": "Ajusta la configuración a tu gusto", + "tr": "Ayarları isteğinize göre ayarlayın" + }, "CONFIGURATION$MODEL_SELECT_LABEL": { "en": "Model", "zh-CN": "模型", @@ -201,7 +213,7 @@ "it": "Invia un messaggio (non interromperà l'Assistente)", "pt": "Envie uma mensagem (não interromperá o Assistente)", "es": "Enviar un mensaje (no interrumpirá al Asistente)", - "tr": "Bir mesaj gönderin (Asistan Kesilmeyecek)" + "tr": "Bir mesaj gönderin (Asistan Kesilmeyecek)" }, "CHAT_INTERFACE$INPUT_SEND_MESSAGE_BUTTON_CONTENT": { "en": "Send", @@ -215,4 +227,4 @@ "es": "Enviar", "tr": "Gönder" } -} + } diff --git a/frontend/src/services/auth.test.ts b/frontend/src/services/auth.test.ts new file mode 100644 index 000000000000..b21843acfcae --- /dev/null +++ b/frontend/src/services/auth.test.ts @@ -0,0 +1,87 @@ +import * as jose from "jose"; +import type { Mock } from "vitest"; +import { fetchToken, validateToken, getToken } from "./auth"; + +vi.mock("jose", () => ({ + decodeJwt: vi.fn(), +})); + +// SUGGESTION: Prefer using msw for mocking requests (see https://mswjs.io/) +global.fetch = vi.fn(() => + Promise.resolve({ + status: 200, + json: () => Promise.resolve({ token: "newToken" }), + }), +) as Mock; + +Storage.prototype.getItem = vi.fn(); +Storage.prototype.setItem = vi.fn(); + +describe("Auth Service", () => { + beforeEach(() => { + vi.clearAllMocks(); + }); + + describe("fetchToken", () => { + it("should fetch and return a token", async () => { + const data = await fetchToken(); + + expect(localStorage.getItem).toHaveBeenCalledWith("token"); // Used to set Authorization header + expect(data).toEqual({ token: "newToken" }); + expect(fetch).toHaveBeenCalledWith(`/api/auth`, { + headers: expect.any(Headers), + }); + }); + + it("throws an error if response status is not 200", async () => { + (fetch as Mock).mockImplementationOnce(() => + Promise.resolve({ status: 401 }), + ); + await expect(fetchToken()).rejects.toThrow("Get token failed."); + }); + }); + + describe("validateToken", () => { + it("returns true for a valid token", () => { + (jose.decodeJwt as Mock).mockReturnValue({ sid: "123" }); + expect(validateToken("validToken")).toBe(true); + }); + + it("returns false for an invalid token", () => { + (jose.decodeJwt as Mock).mockReturnValue({}); + expect(validateToken("invalidToken")).toBe(false); + }); + + it("returns false when decodeJwt throws", () => { + (jose.decodeJwt as Mock).mockImplementation(() => { + throw new Error("Invalid token"); + }); + expect(validateToken("badToken")).toBe(false); + }); + }); + + describe("getToken", () => { + it("returns existing valid token from localStorage", async () => { + (jose.decodeJwt as Mock).mockReturnValue({ sid: "123" }); + (Storage.prototype.getItem as Mock).mockReturnValue("existingToken"); + + const token = await getToken(); + expect(token).toBe("existingToken"); + }); + + it("fetches, validates, and stores a new token when existing token is invalid", async () => { + (jose.decodeJwt as Mock) + .mockReturnValueOnce({}) + .mockReturnValueOnce({ sid: "123" }); + + const token = await getToken(); + expect(token).toBe("newToken"); + expect(localStorage.setItem).toHaveBeenCalledWith("token", "newToken"); + }); + + it("throws an error when fetched token is invalid", async () => { + (jose.decodeJwt as Mock).mockReturnValue({}); + await expect(getToken()).rejects.toThrow("Token validation failed."); + }); + }); +}); diff --git a/frontend/src/services/auth.ts b/frontend/src/services/auth.ts index 703503adc02a..4f9ba870a1eb 100644 --- a/frontend/src/services/auth.ts +++ b/frontend/src/services/auth.ts @@ -1,4 +1,3 @@ -// eslint-disable-next-line import/no-extraneous-dependencies import * as jose from "jose"; import { ResFetchToken } from "../types/ResponseType"; @@ -7,10 +6,7 @@ const fetchToken = async (): Promise => { "Content-Type": "application/json", Authorization: `Bearer ${localStorage.getItem("token")}`, }); - const response = await fetch( - `http://${process.env.APP_HOST}:${process.env.APP_PORT}/api/auth`, - { headers }, - ); + const response = await fetch(`/api/auth`, { headers }); if (response.status !== 200) { throw new Error("Get token failed."); } @@ -18,7 +14,7 @@ const fetchToken = async (): Promise => { return data; }; -const validateToken = (token: string): boolean => { +export const validateToken = (token: string): boolean => { try { const claims = jose.decodeJwt(token); return !(claims.sid === undefined || claims.sid === ""); diff --git a/frontend/src/services/fileService.ts b/frontend/src/services/fileService.ts index 1b07ac409df6..3e23924c9b35 100644 --- a/frontend/src/services/fileService.ts +++ b/frontend/src/services/fileService.ts @@ -6,6 +6,9 @@ export type WorkspaceFile = { export async function selectFile(file: string): Promise { const res = await fetch(`/api/select-file?file=${file}`); const data = await res.json(); + if (res.status !== 200) { + throw new Error(data.error); + } return data.code as string; } diff --git a/frontend/src/services/session.test.ts b/frontend/src/services/session.test.ts new file mode 100644 index 000000000000..3ab66a4f324e --- /dev/null +++ b/frontend/src/services/session.test.ts @@ -0,0 +1,127 @@ +import type { Mock } from "vitest"; +import { + ResDelMsg, + ResFetchMsg, + ResFetchMsgTotal, + ResFetchMsgs, +} from "../types/ResponseType"; +import { clearMsgs, fetchMsgTotal, fetchMsgs } from "./session"; + +// SUGGESTION: Prefer using msw for mocking requests (see https://mswjs.io/) +global.fetch = vi.fn(); +Storage.prototype.getItem = vi.fn(); + +describe("Session Service", () => { + beforeEach(() => { + vi.clearAllMocks(); + }); + + afterEach(() => { + // Used to set Authorization header + expect(localStorage.getItem).toHaveBeenCalledWith("token"); + }); + + describe("fetchMsgTotal", () => { + it("should fetch and return message total", async () => { + const expectedResult: ResFetchMsgTotal = { + msg_total: 10, + }; + + (fetch as Mock).mockImplementationOnce(() => + Promise.resolve({ + status: 200, + json: () => Promise.resolve(expectedResult), + }), + ); + + const data = await fetchMsgTotal(); + + expect(fetch).toHaveBeenCalledWith(`/api/messages/total`, { + headers: expect.any(Headers), + }); + + expect(data).toEqual(expectedResult); + }); + + it("throws an error if response status is not 200", async () => { + // NOTE: The current implementation ONLY handles 200 status; + // this means throwing even with a status of 201, 204, etc. + (fetch as Mock).mockImplementationOnce(() => + Promise.resolve({ status: 401 }), + ); + + await expect(fetchMsgTotal()).rejects.toThrow( + "Get message total failed.", + ); + }); + }); + + describe("fetchMsgs", () => { + it("should fetch and return messages", async () => { + const expectedResult: ResFetchMsgs = { + messages: [ + { + id: "1", + role: "admin", + payload: {} as ResFetchMsg["payload"], + }, + ], + }; + + (fetch as Mock).mockImplementationOnce(() => + Promise.resolve({ + status: 200, + json: () => Promise.resolve(expectedResult), + }), + ); + + const data = await fetchMsgs(); + + expect(fetch).toHaveBeenCalledWith(`/api/messages`, { + headers: expect.any(Headers), + }); + + expect(data).toEqual(expectedResult); + }); + + it("throws an error if response status is not 200", async () => { + (fetch as Mock).mockImplementationOnce(() => + Promise.resolve({ status: 401 }), + ); + + await expect(fetchMsgs()).rejects.toThrow("Get messages failed."); + }); + }); + + describe("clearMsgs", () => { + it("should clear messages", async () => { + const expectedResult: ResDelMsg = { + ok: "true", + }; + + (fetch as Mock).mockImplementationOnce(() => + Promise.resolve({ + status: 200, + json: () => Promise.resolve(expectedResult), + }), + ); + + const data = await clearMsgs(); + + expect(fetch).toHaveBeenCalledWith(`/api/messages`, { + method: "DELETE", + headers: expect.any(Headers), + }); + + expect(data).toEqual(expectedResult); + }); + + it("throws an error if response status is not 200", async () => { + (fetch as Mock).mockImplementationOnce(() => + Promise.resolve({ status: 401 }), + ); + + await expect(clearMsgs()).rejects.toThrow("Delete messages failed."); + }); + }); +}); diff --git a/frontend/src/services/settingsService.test.ts b/frontend/src/services/settingsService.test.ts new file mode 100644 index 000000000000..4e588b9306b0 --- /dev/null +++ b/frontend/src/services/settingsService.test.ts @@ -0,0 +1,104 @@ +import { mergeAndUpdateSettings } from "./settingsService"; +import { ArgConfigType } from "../types/ConfigType"; + +describe("mergeAndUpdateSettings", () => { + it("should return initial settings if newSettings is empty", () => { + const oldSettings = { key1: "value1" }; + const isInit = false; + + const result = mergeAndUpdateSettings({}, oldSettings, isInit); + + expect(result.mergedSettings).toEqual(oldSettings); + expect(result.updatedSettings).toEqual({}); + }); + + it("should add new keys to mergedSettings and updatedSettings", () => { + const oldSettings = { key1: "value1" }; + const newSettings = { key2: "value2" }; + const isInit = false; + + const result = mergeAndUpdateSettings(newSettings, oldSettings, isInit); + + expect(result.mergedSettings).toEqual({ + key1: "value1", + key2: "value2", + }); + expect(result.updatedSettings).toEqual({ + key2: "value2", // New key + }); + }); + + it("should overwrite non-DISPLAY_MAP keys in mergedSettings", () => { + const oldSettings = { key1: "value1" }; + const newSettings = { key1: "newvalue1" }; + const isInit = false; + + const result = mergeAndUpdateSettings(newSettings, oldSettings, isInit); + + expect(result.mergedSettings).toEqual({ key1: "newvalue1" }); + expect(result.updatedSettings).toEqual({}); + }); + + it("should keep old values in mergedSettings if they are equal", () => { + const oldSettings = { + [ArgConfigType.LLM_MODEL]: "gpt-4-0125-preview", + [ArgConfigType.AGENT]: "MonologueAgent", + }; + const newSettings = { + [ArgConfigType.AGENT]: "MonologueAgent", + }; + const isInit = false; + + const result = mergeAndUpdateSettings(newSettings, oldSettings, isInit); + + expect(result.mergedSettings).toEqual(oldSettings); + expect(result.updatedSettings).toEqual({}); + }); + + it("should keep old values in mergedSettings if isInit is true and old value is not empty", () => { + const oldSettings = { + [ArgConfigType.LLM_MODEL]: "gpt-4-0125-preview", + [ArgConfigType.AGENT]: "MonologueAgent", + }; + const newSettings = { + [ArgConfigType.AGENT]: "MonologueAgent", + }; + const isInit = true; + + const result = mergeAndUpdateSettings(newSettings, oldSettings, isInit); + + expect(result.mergedSettings).toEqual(oldSettings); + expect(result.updatedSettings).toEqual({}); + }); + + it("should update mergedSettings, updatedSettings and set needToSend to true for relevant changes", () => { + const oldSettings = { + [ArgConfigType.LLM_MODEL]: "gpt-4-0125-preview", + [ArgConfigType.AGENT]: "MonologueAgent", + key1: "value1", + }; + const newSettings = { + [ArgConfigType.AGENT]: "CodeActAgent", + [ArgConfigType.LANGUAGE]: "es", + key1: "newvalue1", + key2: "value2", + }; + const isInit = false; + + const result = mergeAndUpdateSettings(newSettings, oldSettings, isInit); + + expect(result.mergedSettings).toEqual({ + [ArgConfigType.LLM_MODEL]: "gpt-4-0125-preview", + [ArgConfigType.AGENT]: "CodeActAgent", // Updated value + [ArgConfigType.LANGUAGE]: "es", // New key added + key1: "newvalue1", // Updated value + key2: "value2", // New key added + }); + expect(result.updatedSettings).toEqual({ + [ArgConfigType.AGENT]: "CodeActAgent", + [ArgConfigType.LANGUAGE]: "es", + key2: "value2", + }); + expect(result.needToSend).toBe(true); + }); +}); diff --git a/frontend/src/services/settingsService.ts b/frontend/src/services/settingsService.ts index 6d80b32102f3..6bad46078774 100644 --- a/frontend/src/services/settingsService.ts +++ b/frontend/src/services/settingsService.ts @@ -52,15 +52,19 @@ const DISPLAY_MAP = new Map([ [ArgConfigType.LANGUAGE, "language"], ]); -// Send settings to the server -export function saveSettings( - newSettings: { [key: string]: string }, - oldSettings: { [key: string]: string }, - isInit: boolean = false, -): void { - const { mergedSettings, updatedSettings, needToSend } = Object.keys( - newSettings, - ).reduce( +type SettingsUpdateInfo = { + mergedSettings: Record; + updatedSettings: Record; + needToSend: boolean; +}; + +// Function to merge and update settings +export const mergeAndUpdateSettings = ( + newSettings: Record, + oldSettings: Record, + isInit: boolean, +) => + Object.keys(newSettings).reduce( (acc, key) => { const newValue = String(newSettings[key]); const oldValue = oldSettings[key]; @@ -71,6 +75,7 @@ export function saveSettings( acc.updatedSettings[key] = newValue; return acc; } + if (!DISPLAY_MAP.has(key)) { acc.mergedSettings[key] = newValue; return acc; @@ -91,13 +96,10 @@ export function saveSettings( mergedSettings: { ...oldSettings }, updatedSettings: {}, needToSend: false, - } as { - mergedSettings: { [key: string]: string }; - updatedSettings: { [key: string]: string }; - needToSend: boolean; - }, + } as SettingsUpdateInfo, ); +const dispatchSettings = (updatedSettings: Record) => { let i = 0; for (const [key, value] of Object.entries(updatedSettings)) { if (DISPLAY_MAP.has(key)) { @@ -108,16 +110,38 @@ export function saveSettings( i += 1; } } +}; - if (isInit) { - store.dispatch(setAllSettings(JSON.stringify(newSettings))); - } +const sendSettings = ( + mergedSettings: Record, + needToSend: boolean, + isInit: boolean, +) => { + const settingsCopy = { ...mergedSettings }; + delete settingsCopy.ALL_SETTINGS; - delete mergedSettings.ALL_SETTINGS; if (needToSend || isInit) { - const event = { action: ActionType.INIT, args: mergedSettings }; + const event = { action: ActionType.INIT, args: settingsCopy }; const eventString = JSON.stringify(event); store.dispatch(setInitialized(false)); Socket.send(eventString); } +}; + +// Save and send settings to the server +export function saveSettings( + newSettings: { [key: string]: string }, + oldSettings: { [key: string]: string }, + isInit: boolean = false, +): void { + const { mergedSettings, updatedSettings, needToSend } = + mergeAndUpdateSettings(newSettings, oldSettings, isInit); + + dispatchSettings(updatedSettings); + + if (isInit) { + store.dispatch(setAllSettings(JSON.stringify(newSettings))); + } + + sendSettings(mergedSettings, needToSend, isInit); } diff --git a/frontend/src/state/codeSlice.ts b/frontend/src/state/codeSlice.ts index 1e0f31e6aaaf..b09a35df5e28 100644 --- a/frontend/src/state/codeSlice.ts +++ b/frontend/src/state/codeSlice.ts @@ -6,7 +6,7 @@ import { WorkspaceFile } from "../services/fileService"; export const codeSlice = createSlice({ name: "code", initialState: { - code: "# Welcome to devin!", + code: "# Welcome to OpenDevin!", selectedIds: [] as number[], workspaceFolder: { name: "" } as WorkspaceFile, }, diff --git a/frontend/src/utils/storage.test.ts b/frontend/src/utils/storage.test.ts new file mode 100644 index 000000000000..9d479d39cb27 --- /dev/null +++ b/frontend/src/utils/storage.test.ts @@ -0,0 +1,28 @@ +import type { Mock } from "vitest"; +import { getCachedConfig } from "./storage"; + +describe("getCachedConfig", () => { + beforeEach(() => { + // Clear all instances and calls to constructor and all methods + Storage.prototype.getItem = vi.fn(); + }); + + it("should return an empty object when local storage is null or undefined", () => { + (Storage.prototype.getItem as Mock).mockReturnValue(null); + expect(getCachedConfig()).toEqual({}); + + (Storage.prototype.getItem as Mock).mockReturnValue(undefined); + expect(getCachedConfig()).toEqual({}); + }); + + it("should return an empty object when local storage has invalid JSON", () => { + (Storage.prototype.getItem as Mock).mockReturnValue("invalid JSON"); + expect(getCachedConfig()).toEqual({}); + }); + + it("should return parsed object when local storage has valid JSON", () => { + const validJSON = '{"key":"value"}'; + (Storage.prototype.getItem as Mock).mockReturnValue(validJSON); + expect(getCachedConfig()).toEqual({ key: "value" }); + }); +}); diff --git a/frontend/tailwind.config.js b/frontend/tailwind.config.js index d5a11b62a7a2..46c0a0b68fae 100644 --- a/frontend/tailwind.config.js +++ b/frontend/tailwind.config.js @@ -1,14 +1,27 @@ /** @type {import('tailwindcss').Config} */ const { nextui } = require("@nextui-org/react"); export default { - content: [ - "./src/**/*.{js,ts,jsx,tsx}", - "./node_modules/@nextui-org/theme/dist/**/*.{js,ts,jsx,tsx}", - ], - darkMode: "class", - plugins: [ - nextui({ - defaultTheme: "dark", - }), - ], + content: [ + "./src/**/*.{js,ts,jsx,tsx}", + "./node_modules/@nextui-org/theme/dist/**/*.{js,ts,jsx,tsx}", + ], + darkMode: "class", + plugins: [ + nextui({ + defaultTheme: "dark", + layout: { + radius: { + small: "5px", + large: "20px", + }, + }, + themes: { + dark: { + colors: { + primary:"#4465DB", + }, + } + } + }), + ], }; diff --git a/frontend/tsconfig.json b/frontend/tsconfig.json index ac3600aa84d9..1ae6eb49c057 100644 --- a/frontend/tsconfig.json +++ b/frontend/tsconfig.json @@ -1,8 +1,5 @@ { - "extends": "@tsconfig/node18/tsconfig.json", "compilerOptions": { - "outDir": "./dist", - "rootDir": "./", "target": "es5", "lib": [ "dom", @@ -22,11 +19,10 @@ "isolatedModules": true, "noEmit": true, "jsx": "react", - "types": ["vite/client", "node"] + "types": ["vite/client", "vitest/globals"] }, "include": [ - "src/**/*", + "src", "vite.config.js" - ], - "exclude": ["node_modules"] + ] } diff --git a/frontend/vite.config.js b/frontend/vite.config.js index 45c47f3bb98e..f8db314c2794 100644 --- a/frontend/vite.config.js +++ b/frontend/vite.config.js @@ -11,12 +11,16 @@ if (!BACKEND_HOST.match(/^([\w\d-]+(\.[\w\d-]+)+(:\d+)?)/)) { ); } -export default defineConfig({ +// Define separate configurations for development and production modes +let viteConfig; +// eslint-disable-next-line prefer-const +viteConfig = { // depending on your application, base can also be "/" base: "", plugins: [react(), viteTsconfigPaths()], clearScreen: false, server: { + watch: { usePolling: true }, port: process.env.FRONTEND_PORT ? Number.parseInt(process.env.FRONTEND_PORT, 10) : 3001, @@ -31,4 +35,49 @@ export default defineConfig({ }, }, }, -}); + build: { + minify: false, + sourcemap: "inline", + optimizeDeps: { + include: ["lodash/fp", "src/index.tsx"], + }, + chunkSizeWarningLimit: 2000, // Set a warning limit for chunk sizes (in bytes) + rollupOptions: { + external: ["src/index.tsx"], + output: { + manualChunks: { + // Define manual chunks for optimization + // For example, you can manually split React and other large dependencies into separate chunks + react: ["react", "react-dom"], + // Add more manual chunks as needed for other dependencies + }, + }, + }, + server: {}, + }, +}; + +// Conditional configuration based on NODE_ENV +if (process.env.NODE_ENV === "production") { + // Production configuration + viteConfig.base = "/"; + viteConfig.build.minify = true; +} else { + // Development configuration + viteConfig.base = ""; +} + +// Applied only in non-interactive environment, i.e. Docker +if (process.env.DEBIAN_FRONTEND === "noninteractive") { + const dockerConfig = { + server: { + host: os.hostname(), + origin: `http://web_ui:${process.env.UI_HTTP_PORT}`, + port: 4173, + }, + }; + + viteConfig = { ...viteConfig, ...dockerConfig }; +} + +export default defineConfig(viteConfig); diff --git a/opendevin/action/agent.py b/opendevin/action/agent.py index 708113e68099..48ded32f93ce 100644 --- a/opendevin/action/agent.py +++ b/opendevin/action/agent.py @@ -18,7 +18,7 @@ class AgentRecallAction(ExecutableAction): query: str action: str = ActionType.RECALL - def run(self, controller: 'AgentController') -> AgentRecallObservation: + async def run(self, controller: 'AgentController') -> AgentRecallObservation: return AgentRecallObservation( content='Recalling memories...', memories=controller.agent.search_memory(self.query), @@ -34,7 +34,7 @@ class AgentThinkAction(NotExecutableAction): thought: str action: str = ActionType.THINK - def run(self, controller: 'AgentController') -> 'Observation': + async def run(self, controller: 'AgentController') -> 'Observation': raise NotImplementedError @property @@ -47,7 +47,7 @@ class AgentEchoAction(ExecutableAction): content: str action: str = 'echo' - def run(self, controller: 'AgentController') -> 'Observation': + async def run(self, controller: 'AgentController') -> 'Observation': return AgentMessageObservation(self.content) @property @@ -70,7 +70,7 @@ def message(self) -> str: class AgentFinishAction(NotExecutableAction): action: str = ActionType.FINISH - def run(self, controller: 'AgentController') -> 'Observation': + async def run(self, controller: 'AgentController') -> 'Observation': raise NotImplementedError @property diff --git a/opendevin/action/base.py b/opendevin/action/base.py index 6ee0c76457e2..bfc8d93bc827 100644 --- a/opendevin/action/base.py +++ b/opendevin/action/base.py @@ -9,7 +9,7 @@ @dataclass class Action: - def run(self, controller: 'AgentController') -> 'Observation': + async def run(self, controller: 'AgentController') -> 'Observation': raise NotImplementedError def to_dict(self): diff --git a/opendevin/action/bash.py b/opendevin/action/bash.py index 797381a70c83..b24d1f96ba04 100644 --- a/opendevin/action/bash.py +++ b/opendevin/action/bash.py @@ -15,8 +15,8 @@ class CmdRunAction(ExecutableAction): background: bool = False action: str = ActionType.RUN - def run(self, controller: 'AgentController') -> 'CmdOutputObservation': - return controller.command_manager.run_command(self.command, self.background) + async def run(self, controller: 'AgentController') -> 'CmdOutputObservation': + return controller.action_manager.run_command(self.command, self.background) @property def message(self) -> str: @@ -28,8 +28,8 @@ class CmdKillAction(ExecutableAction): id: int action: str = ActionType.KILL - def run(self, controller: 'AgentController') -> 'CmdOutputObservation': - return controller.command_manager.kill_command(self.id) + async def run(self, controller: 'AgentController') -> 'CmdOutputObservation': + return controller.action_manager.kill_command(self.id) @property def message(self) -> str: diff --git a/opendevin/action/tasks.py b/opendevin/action/tasks.py index 172fdd4d7057..2bdcace4f817 100644 --- a/opendevin/action/tasks.py +++ b/opendevin/action/tasks.py @@ -1,27 +1,40 @@ from dataclasses import dataclass, field -from .base import NotExecutableAction +from .base import ExecutableAction from opendevin.schema import ActionType +from opendevin.observation import NullObservation + +from typing import TYPE_CHECKING +if TYPE_CHECKING: + from opendevin.controller import AgentController @dataclass -class AddTaskAction(NotExecutableAction): +class AddTaskAction(ExecutableAction): parent: str goal: str subtasks: list = field(default_factory=list) action: str = ActionType.ADD_TASK + async def run(self, controller: 'AgentController') -> NullObservation: # type: ignore + controller.state.plan.add_subtask(self.parent, self.goal, self.subtasks) + return NullObservation('') + @property def message(self) -> str: return f'Added task: {self.goal}' @dataclass -class ModifyTaskAction(NotExecutableAction): +class ModifyTaskAction(ExecutableAction): id: str state: str action: str = ActionType.MODIFY_TASK + async def run(self, controller: 'AgentController') -> NullObservation: # type: ignore + controller.state.plan.set_subtask_state(self.id, self.state) + return NullObservation('') + @property def message(self) -> str: return f'Set task {self.id} to {self.state}' diff --git a/opendevin/controller/__init__.py b/opendevin/controller/__init__.py index aa4a979c4a5f..2f6d436e01d2 100644 --- a/opendevin/controller/__init__.py +++ b/opendevin/controller/__init__.py @@ -1,7 +1,7 @@ from .agent_controller import AgentController -from .command_manager import CommandManager +from .action_manager import ActionManager __all__ = [ 'AgentController', - 'CommandManager' + 'ActionManager' ] diff --git a/opendevin/controller/command_manager.py b/opendevin/controller/action_manager.py similarity index 78% rename from opendevin/controller/command_manager.py rename to opendevin/controller/action_manager.py index bdd0dc966c74..31b5cd3a7c30 100644 --- a/opendevin/controller/command_manager.py +++ b/opendevin/controller/action_manager.py @@ -1,12 +1,22 @@ from typing import List +import traceback from opendevin import config from opendevin.observation import CmdOutputObservation from opendevin.sandbox import DockerExecBox, DockerSSHBox, Sandbox, LocalBox from opendevin.schema import ConfigType +from opendevin.logger import opendevin_logger as logger +from opendevin.action import ( + Action, +) +from opendevin.observation import ( + Observation, + AgentErrorObservation, + NullObservation, +) -class CommandManager: +class ActionManager: id: str shell: Sandbox @@ -29,6 +39,18 @@ def __init__( else: raise ValueError(f'Invalid sandbox type: {sandbox_type}') + async def run_action(self, action: Action, agent_controller) -> Observation: + observation: Observation = NullObservation('') + if not action.executable: + return observation + try: + observation = await action.run(agent_controller) + except Exception as e: + observation = AgentErrorObservation(str(e)) + logger.error(e) + traceback.print_exc() + return observation + def run_command(self, command: str, background=False) -> CmdOutputObservation: if background: return self._run_background(command) diff --git a/opendevin/llm/llm.py b/opendevin/llm/llm.py index 866c986cdf37..0beaa2dab758 100644 --- a/opendevin/llm/llm.py +++ b/opendevin/llm/llm.py @@ -57,3 +57,6 @@ def completion(self): Decorator for the litellm completion function. """ return self._completion + + def __str__(self): + return f'LLM(model={self.model_name}, base_url={self.base_url})' diff --git a/opendevin/logger.py b/opendevin/logger.py index adc11a5c515c..e3e9d8227dc7 100644 --- a/opendevin/logger.py +++ b/opendevin/logger.py @@ -3,11 +3,63 @@ import sys import traceback from datetime import datetime +from opendevin import config +from typing import Literal, Mapping +from termcolor import colored -console_formatter = logging.Formatter( +DISABLE_COLOR_PRINTING = ( + config.get('DISABLE_COLOR').lower() == 'true' +) + +ColorType = Literal[ + 'red', + 'green', + 'yellow', + 'blue', + 'magenta', + 'cyan', + 'light_grey', + 'dark_grey', + 'light_red', + 'light_green', + 'light_yellow', + 'light_blue', + 'light_magenta', + 'light_cyan', + 'white', +] + +LOG_COLORS: Mapping[str, ColorType] = { + 'BACKGROUND LOG': 'blue', + 'ACTION': 'green', + 'OBSERVATION': 'yellow', + 'INFO': 'cyan', + 'ERROR': 'red', + 'PLAN': 'light_magenta', +} + + +class ColoredFormatter(logging.Formatter): + def format(self, record): + msg_type = record.__dict__.get('msg_type', None) + if msg_type in LOG_COLORS and not DISABLE_COLOR_PRINTING: + msg_type_color = colored(msg_type, LOG_COLORS[msg_type]) + msg = colored(record.msg, LOG_COLORS[msg_type]) + time_str = colored(self.formatTime(record, self.datefmt), 'green') + name_str = colored(record.name, 'cyan') + level_str = colored(record.levelname, 'yellow') + return f'{time_str} - {name_str}:{level_str}: {record.filename}:{record.lineno}\n{msg_type_color}\n{msg}' + elif msg_type == 'STEP': + msg = '\n\n==============\n' + record.msg + '\n' + return f'{msg}' + return super().format(record) + + +console_formatter = ColoredFormatter( '\033[92m%(asctime)s - %(name)s:%(levelname)s\033[0m: %(filename)s:%(lineno)s - %(message)s', datefmt='%H:%M:%S', ) + file_formatter = logging.Formatter( '%(asctime)s - %(name)s:%(levelname)s: %(filename)s:%(lineno)s - %(message)s', datefmt='%H:%M:%S', @@ -33,7 +85,7 @@ def get_file_handler(): """ log_dir = os.path.join(os.getcwd(), 'logs') os.makedirs(log_dir, exist_ok=True) - timestamp = datetime.now().strftime('%Y-%m-%d_%H-%M-%S') + timestamp = datetime.now().strftime('%Y-%m-%d') file_name = f'opendevin_{timestamp}.log' file_handler = logging.FileHandler(os.path.join(log_dir, file_name)) file_handler.setLevel(logging.DEBUG) @@ -65,24 +117,25 @@ def log_uncaught_exceptions(ex_cls, ex, tb): opendevin_logger = logging.getLogger('opendevin') opendevin_logger.setLevel(logging.INFO) -opendevin_logger.addHandler(get_console_handler()) opendevin_logger.addHandler(get_file_handler()) +opendevin_logger.addHandler(get_console_handler()) opendevin_logger.propagate = False opendevin_logger.debug('Logging initialized') opendevin_logger.debug('Logging to %s', os.path.join( os.getcwd(), 'logs', 'opendevin.log')) -# Exclude "litellm" from logging output +# Exclude LiteLLM from logging output logging.getLogger('LiteLLM').disabled = True logging.getLogger('LiteLLM Router').disabled = True logging.getLogger('LiteLLM Proxy').disabled = True -# LLM prompt and response logging - class LlmFileHandler(logging.FileHandler): + """ + # LLM prompt and response logging + """ - def __init__(self, filename, mode='a', encoding=None, delay=False): + def __init__(self, filename, mode='a', encoding='utf-8', delay=False): """ Initializes an instance of LlmFileHandler. @@ -94,12 +147,11 @@ def __init__(self, filename, mode='a', encoding=None, delay=False): """ self.filename = filename self.message_counter = 1 - self.session = datetime.now().strftime('%y-%m-%d_%H-%M-%S') - self.log_directory = os.path.join( - os.getcwd(), 'logs', 'llm', self.session) + self.session = datetime.now().strftime('%y-%m-%d_%H-%M') + self.log_directory = os.path.join(os.getcwd(), 'logs', 'llm', self.session) os.makedirs(self.log_directory, exist_ok=True) - self.baseFilename = os.path.join( - self.log_directory, f'{self.filename}_{self.message_counter:03}.log') + filename = f'{self.filename}_{self.message_counter:03}.log' + self.baseFilename = os.path.join(self.log_directory, filename) super().__init__(self.baseFilename, mode, encoding, delay) def emit(self, record): @@ -109,8 +161,8 @@ def emit(self, record): Args: record (logging.LogRecord): The log record to emit. """ - self.baseFilename = os.path.join( - self.log_directory, f'{self.filename}_{self.message_counter:03}.log') + filename = f'{self.filename}_{self.message_counter:03}.log' + self.baseFilename = os.path.join(self.log_directory, filename) self.stream = self._open() super().emit(record) self.stream.close @@ -122,9 +174,9 @@ def get_llm_prompt_file_handler(): """ Returns a file handler for LLM prompt logging. """ - llm_prompt_file_handler = LlmFileHandler('prompt') - llm_prompt_file_handler.setLevel(logging.INFO) + llm_prompt_file_handler = LlmFileHandler('prompt', delay=True) llm_prompt_file_handler.setFormatter(llm_formatter) + llm_prompt_file_handler.setLevel(logging.DEBUG) return llm_prompt_file_handler @@ -132,16 +184,18 @@ def get_llm_response_file_handler(): """ Returns a file handler for LLM response logging. """ - llm_response_file_handler = LlmFileHandler('response') - llm_response_file_handler.setLevel(logging.INFO) + llm_response_file_handler = LlmFileHandler('response', delay=True) llm_response_file_handler.setFormatter(llm_formatter) + llm_response_file_handler.setLevel(logging.DEBUG) return llm_response_file_handler llm_prompt_logger = logging.getLogger('prompt') llm_prompt_logger.propagate = False +llm_prompt_logger.setLevel(logging.DEBUG) llm_prompt_logger.addHandler(get_llm_prompt_file_handler()) llm_response_logger = logging.getLogger('response') llm_response_logger.propagate = False +llm_response_logger.setLevel(logging.DEBUG) llm_response_logger.addHandler(get_llm_response_file_handler()) diff --git a/opendevin/sandbox/Makefile b/opendevin/sandbox/Makefile deleted file mode 100644 index e5b0a2d487c7..000000000000 --- a/opendevin/sandbox/Makefile +++ /dev/null @@ -1,31 +0,0 @@ -DOCKER_BUILD_REGISTRY=ghcr.io -DOCKER_BUILD_ORG=opendevin -DOCKER_BUILD_REPO=sandbox -DOCKER_BUILD_TAG=v0.2 -FULL_IMAGE=$(DOCKER_BUILD_REGISTRY)/$(DOCKER_BUILD_ORG)/$(DOCKER_BUILD_REPO):$(DOCKER_BUILD_TAG) - -LATEST_FULL_IMAGE=$(DOCKER_BUILD_REGISTRY)/$(DOCKER_BUILD_ORG)/$(DOCKER_BUILD_REPO):latest - -MAJOR_VERSION=$(shell echo $(DOCKER_BUILD_TAG) | cut -d. -f1) -MAJOR_FULL_IMAGE=$(DOCKER_BUILD_REGISTRY)/$(DOCKER_BUILD_ORG)/$(DOCKER_BUILD_REPO):$(MAJOR_VERSION) -MINOR_VERSION=$(shell echo $(DOCKER_BUILD_TAG) | cut -d. -f1,2) -MINOR_FULL_IMAGE=$(DOCKER_BUILD_REGISTRY)/$(DOCKER_BUILD_ORG)/$(DOCKER_BUILD_REPO):$(MINOR_VERSION) - -# normally, for local build testing or development. use cross platform build for sharing images to others. -build: - docker build -f Dockerfile -t ${FULL_IMAGE} -t ${LATEST_FULL_IMAGE} . - -push: - docker push ${FULL_IMAGE} ${LATEST_FULL_IMAGE} - -test: - docker buildx build --platform linux/amd64 \ - -t ${FULL_IMAGE} -t ${LATEST_FULL_IMAGE} --load -f Dockerfile . - -# cross platform build, you may need to manually stop the buildx(buildkit) container -all: - docker buildx build --platform linux/amd64,linux/arm64 \ - -t ${FULL_IMAGE} -t ${LATEST_FULL_IMAGE} -t ${MINOR_FULL_IMAGE} --push -f Dockerfile . - -get-full-image: - @echo ${FULL_IMAGE} diff --git a/opendevin/sandbox/ssh_box.py b/opendevin/sandbox/ssh_box.py index 8a49d2b8c07b..d78046a154bb 100644 --- a/opendevin/sandbox/ssh_box.py +++ b/opendevin/sandbox/ssh_box.py @@ -279,7 +279,7 @@ def restart_docker_container(self): network_kwargs['network_mode'] = 'host' else: # FIXME: This is a temporary workaround for Mac OS - network_kwargs['ports'] = {'2222/tcp': self._ssh_port} + network_kwargs['ports'] = {f'{self._ssh_port}/tcp': self._ssh_port} logger.warning( ('Using port forwarding for Mac OS. ' 'Server started by OpenDevin will not be accessible from the host machine at the moment. ' @@ -293,7 +293,7 @@ def restart_docker_container(self): self.container = self.docker_client.containers.run( self.container_image, # allow root login - command="/usr/sbin/sshd -D -p 2222 -o 'PermitRootLogin=yes'", + command=f"/usr/sbin/sshd -D -p {self._ssh_port} -o 'PermitRootLogin=yes'", **network_kwargs, working_dir=SANDBOX_WORKSPACE_DIR, name=self.container_name, diff --git a/opendevin/server/agent/agent.py b/opendevin/server/agent/agent.py index 13cac60216e1..001cd2e016f4 100644 --- a/opendevin/server/agent/agent.py +++ b/opendevin/server/agent/agent.py @@ -173,4 +173,4 @@ def close(self): if self.agent_task: self.agent_task.cancel() if self.controller is not None: - self.controller.command_manager.shell.close() + self.controller.action_manager.shell.close() diff --git a/opendevin/server/agent/manager.py b/opendevin/server/agent/manager.py index 39ea27363fae..e842a46df414 100644 --- a/opendevin/server/agent/manager.py +++ b/opendevin/server/agent/manager.py @@ -1,7 +1,7 @@ import atexit -import signal from opendevin.server.session import session_manager +from opendevin.logger import opendevin_logger as logger from .agent import AgentUnit @@ -10,8 +10,6 @@ class AgentManager: def __init__(self): atexit.register(self.close) - signal.signal(signal.SIGINT, self.handle_signal) - signal.signal(signal.SIGTERM, self.handle_signal) def register_agent(self, sid: str): """Registers a new agent. @@ -34,11 +32,7 @@ async def dispatch(self, sid: str, action: str | None, data: dict): await self.sid_to_agent[sid].dispatch(action, data) - def handle_signal(self, signum, _): - print(f'Received signal {signum}, exiting...') - self.close() - exit(0) - def close(self): + logger.info(f'Closing {len(self.sid_to_agent)} agent(s)...') for sid, agent in self.sid_to_agent.items(): agent.close() diff --git a/opendevin/server/session/manager.py b/opendevin/server/session/manager.py index 53a1d3f35361..1301cc0e9432 100644 --- a/opendevin/server/session/manager.py +++ b/opendevin/server/session/manager.py @@ -1,11 +1,11 @@ import atexit import json import os -import signal from typing import Dict, Callable from fastapi import WebSocket +from opendevin.logger import opendevin_logger as logger from .msg_stack import message_stack from .session import Session @@ -19,8 +19,6 @@ class SessionManager: def __init__(self): self._load_sessions() atexit.register(self.close) - signal.signal(signal.SIGINT, self.handle_signal) - signal.signal(signal.SIGTERM, self.handle_signal) def add_session(self, sid: str, ws_conn: WebSocket): if sid not in self._sessions: @@ -36,13 +34,9 @@ async def loop_recv(self, sid: str, dispatch: Callable): await self._sessions[sid].loop_recv(dispatch) def close(self): + logger.info('Saving sessions...') self._save_sessions() - def handle_signal(self, signum, _): - print(f'Received signal {signum}, exiting...') - self.close() - exit(0) - async def send(self, sid: str, data: Dict[str, object]) -> bool: """Sends data to the client.""" message_stack.add_message(sid, 'assistant', data) diff --git a/opendevin/server/session/msg_stack.py b/opendevin/server/session/msg_stack.py index 5777d34439b6..334db524f457 100644 --- a/opendevin/server/session/msg_stack.py +++ b/opendevin/server/session/msg_stack.py @@ -1,7 +1,6 @@ import os import json import atexit -import signal import uuid from typing import Dict, List @@ -38,17 +37,11 @@ class MessageStack: def __init__(self): self._load_messages() atexit.register(self.close) - signal.signal(signal.SIGINT, self.handle_signal) - signal.signal(signal.SIGTERM, self.handle_signal) def close(self): + logger.info('Saving messages...') self._save_messages() - def handle_signal(self, signum, _): - logger.info('Received signal %s, exiting...', signum) - self.close() - exit(0) - def add_message(self, sid: str, role: str, message: Dict[str, object]): if sid not in self._messages: self._messages[sid] = [] diff --git a/poetry.lock b/poetry.lock index f1f44e0cc6f0..1f656fe5e374 100644 --- a/poetry.lock +++ b/poetry.lock @@ -173,6 +173,20 @@ tests = ["attrs[tests-no-zope]", "zope-interface"] tests-mypy = ["mypy (>=1.6)", "pytest-mypy-plugins"] tests-no-zope = ["attrs[tests-mypy]", "cloudpickle", "hypothesis", "pympler", "pytest (>=4.3.0)", "pytest-xdist[psutil]"] +[[package]] +name = "autopep8" +version = "2.1.0" +description = "A tool that automatically formats Python code to conform to the PEP 8 style guide" +optional = false +python-versions = ">=3.8" +files = [ + {file = "autopep8-2.1.0-py2.py3-none-any.whl", hash = "sha256:2bb76888c5edbcafe6aabab3c47ba534f5a2c2d245c2eddced4a30c4b4946357"}, + {file = "autopep8-2.1.0.tar.gz", hash = "sha256:1fa8964e4618929488f4ec36795c7ff12924a68b8bf01366c094fc52f770b6e7"}, +] + +[package.dependencies] +pycodestyle = ">=2.11.0" + [[package]] name = "azure-core" version = "1.30.1" @@ -932,6 +946,22 @@ docs = ["furo (>=2023.9.10)", "sphinx (>=7.2.6)", "sphinx-autodoc-typehints (>=1 testing = ["covdefaults (>=2.3)", "coverage (>=7.3.2)", "diff-cover (>=8.0.1)", "pytest (>=7.4.3)", "pytest-cov (>=4.1)", "pytest-mock (>=3.12)", "pytest-timeout (>=2.2)"] typing = ["typing-extensions (>=4.8)"] +[[package]] +name = "flake8" +version = "7.0.0" +description = "the modular source code checker: pep8 pyflakes and co" +optional = false +python-versions = ">=3.8.1" +files = [ + {file = "flake8-7.0.0-py2.py3-none-any.whl", hash = "sha256:a6dfbb75e03252917f2473ea9653f7cd799c3064e54d4c8140044c5c065f53c3"}, + {file = "flake8-7.0.0.tar.gz", hash = "sha256:33f96621059e65eec474169085dc92bf26e7b2d47366b70be2f67ab80dc25132"}, +] + +[package.dependencies] +mccabe = ">=0.7.0,<0.8.0" +pycodestyle = ">=2.11.0,<2.12.0" +pyflakes = ">=3.2.0,<3.3.0" + [[package]] name = "flatbuffers" version = "24.3.25" @@ -2397,6 +2427,17 @@ pillow = ">=8" pyparsing = ">=2.3.1" python-dateutil = ">=2.7" +[[package]] +name = "mccabe" +version = "0.7.0" +description = "McCabe checker, plugin for flake8" +optional = false +python-versions = ">=3.6" +files = [ + {file = "mccabe-0.7.0-py2.py3-none-any.whl", hash = "sha256:6c2d30ab6be0e4a46919781807b4f0d834ebdd6c6e3dca0bda5a15f863427b6e"}, + {file = "mccabe-0.7.0.tar.gz", hash = "sha256:348e0240c33b60bbdf4e523192ef919f28cb2c3d7d5c7794f74009290f236325"}, +] + [[package]] name = "mdurl" version = "0.1.2" @@ -3801,6 +3842,17 @@ files = [ [package.dependencies] pyasn1 = ">=0.4.6,<0.7.0" +[[package]] +name = "pycodestyle" +version = "2.11.1" +description = "Python style guide checker" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pycodestyle-2.11.1-py2.py3-none-any.whl", hash = "sha256:44fe31000b2d866f2e41841b18528a505fbd7fef9017b04eff4e2648a0fadc67"}, + {file = "pycodestyle-2.11.1.tar.gz", hash = "sha256:41ba0e7afc9752dfb53ced5489e89f8186be00e599e712660695b7a75ff2663f"}, +] + [[package]] name = "pycparser" version = "2.22" @@ -3939,6 +3991,17 @@ typing-extensions = "*" [package.extras] dev = ["black", "build", "flake8", "flake8-black", "isort", "jupyter-console", "mkdocs", "mkdocs-include-markdown-plugin", "mkdocstrings[python]", "pytest", "pytest-asyncio", "pytest-trio", "sphinx", "toml", "tox", "trio", "trio", "trio-typing", "twine", "twisted", "validate-pyproject[all]"] +[[package]] +name = "pyflakes" +version = "3.2.0" +description = "passive checker of Python programs" +optional = false +python-versions = ">=3.8" +files = [ + {file = "pyflakes-3.2.0-py2.py3-none-any.whl", hash = "sha256:84b5be138a2dfbb40689ca07e2152deb896a65c3a3e24c251c5c62489568074a"}, + {file = "pyflakes-3.2.0.tar.gz", hash = "sha256:1c61603ff154621fb2a9172037d84dca3500def8c8b630657d1701f026f8af3f"}, +] + [[package]] name = "pygments" version = "2.17.2" @@ -5907,4 +5970,4 @@ testing = ["big-O", "jaraco.functools", "jaraco.itertools", "more-itertools", "p [metadata] lock-version = "2.0" python-versions = "^3.11" -content-hash = "2157e2433781d90b46d2e153a34282b17666e9d6bdcb1777788f204349ca0159" +content-hash = "3a5ca3c8b47e0e43994032d1620d85a8d602c52a93790d192b9fdb3a8ac36d97" diff --git a/pyproject.toml b/pyproject.toml index 2a0a7a1948f1..2ffe09ecfc42 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -34,6 +34,8 @@ llama-index-embeddings-azure-openai = "*" llama-index-embeddings-ollama = "*" [tool.poetry.group.dev.dependencies] +autopep8 = "v2.1.0" +flake8 = "7.0.0" ruff = "0.3.7" mypy = "1.9.0" pre-commit = "3.7.0" @@ -44,10 +46,14 @@ pytest = "*" [tool.poetry.group.evaluation.dependencies] torch = "*" -[tool.autopep8] -ignore = [ "E501" ] - [build-system] requires = ["poetry-core"] build-backend = "poetry.core.masonry.api" -package-mode = false + +[tool.autopep8] +# autopep8 fights with mypy on line length issue +ignore = [ "E501" ] + +[tool.black] +# prevent black (if installed) from changing single quotes to double quotes +skip-string-normalization = true