[
{
"path": ".github/CONTRIBUTING.md",
"content": "# How to use Jedis Github Issue\n\n* Github issues SHOULD BE USED to report bugs and for DETAILED feature requests. Everything else belongs in the [Jedis Google Group](https://groups.google.com/g/jedis_redis) or [Jedis Github Discussions](https://github.com/redis/jedis/discussions).\n\nPlease post general questions to Google Groups or Github discussions. These can be closed without response when posted to Github issues.\n\n# How to contribute by Pull Request\n\n1. Fork Jedis repo on github ([how to fork a repo](https://docs.github.com/en/get-started/quickstart/fork-a-repo))\n2. Create a topic branch (`git checkout -b my_branch`)\n3. Push to your remote branch (`git push origin my_branch`)\n4. Create a pull request on github ([how to create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request))\n\nCreate a branch with meaningful name, and do not modify the master branch directly.\n\nPlease add unit tests to validate your changes work, then ensure your changes pass all unit tests.\n\n# Jedis Test Environment\n\nJedis uses a Docker-based test environment as the primary method for running tests. A simplified local environment is also available for basic testing.\n\nJedis integration tests use many Redis instances, so we use a `Makefile` to prepare the environment.\n\n## Quick Start (Docker - Recommended)\n\nStart tests with `make test`. This will:\n1. Start the Docker-based test environment\n2. Run all tests\n3. Stop and clean up the environment\n\nSet up test environments with `make start`, tear down those environments with `make stop`.\n\n# Jedis Test Environment Using Docker\n\nThis guide explains how to bootstrap and manage a test environment for Jedis using Docker Compose.\n\n## Workflow Steps\n1. **Start the test environment** by running `make start` (examples below).\n2. **Run tests** through your IDE, Maven, or other testing tools as needed.\n3. **Stop the test environment** by running `make stop`.\n - This will stop and tear down the Docker containers running the Redis service.\n\n# Start the Test Environment Using Docker\n\nYou can bootstrap the test environment for supported versions of Redis using the provided `make` targets.\n\n## Option 1: Using `make` Targets\nTo bring up the test environment for a specific Redis version use the following command:\n```bash\nmake start version=8.0 # Replace with desired version\n```\nTo stop test environment:\n```bash\nmake stop\n```\nTo run tests using the Docker environment:\n```bash\nmake test\n```\n\n## Option 2: Using docker compose commands directly\nDocker compose file can be found in `src/test/resources/env` folder.\n- **Redis 8.4 (or other versions without custom env file)**\n```bash\nrm -rf /tmp/redis-env-work\nexport REDIS_VERSION=8.4\ndocker compose --env-file .env -f src/test/resources/env/docker-compose.yml up\n```\n- **Redis 7.4, 7.2, 6.2 (versions with custom env files)**\n```bash\nrm -rf /tmp/redis-env-work\nexport REDIS_VERSION=6.2\ndocker compose --env-file .env --env-file .env.v6.2 -f src/test/resources/env/docker-compose.yml up\n```\n\n# Local Test Environment (Simplified)\n\nFor basic testing with a minimal local Redis setup (requires Redis to be installed locally):\n\n```bash\nmake start-local # Start local Redis instances (standalone + Unix socket)\nmake test-local # Run tests against local environment\nmake stop-local # Stop local Redis instances\n```\n\n**Note:** The local environment provides only the `standalone-0` endpoint and a Unix socket instance. For full test coverage, use the Docker-based environment.\n\n\n# Some rules of Jedis source code\n\n## Code Convention\n\n* Jedis uses HBase Formatter introduced by [HBASE-5961](https://issues.apache.org/jira/browse/HBASE-5961)\n* You can import code style file (located to hbase-formatter.xml) to Eclipse, IntelliJ\n * line break by column count seems not working with IntelliJ\n* You can run ```make format``` anytime to reformat without IDEs\n* DO NOT format the source codes within `io.redis.examples` test package.\n* A test class name MUST NOT end with `Example`.\n\n## Adding commands\n\n* Jedis uses many interfaces to structure commands\n * planned to write documentation about it, contribution is more welcome!\n* We need to add commands to all interfaces which have responsibility to expose\n * ex) We need to add ping() command to BasicCommands, and provide implementation to all of classes which implemented BasicCommands\n\n## type <-> byte array conversion\n\n* string <-> byte array : use SafeEncoder.encode()\n * Caution: use String.toBytes() directly will break GBK support!\n* boolean, int, long, double -> byte array : use Protocol.toByteArray()\n\nThanks!\n"
},
{
"path": ".github/ISSUE_TEMPLATE",
"content": "\n\n### Expected behavior\n\nWrite here what you're expecting ...\n\n### Actual behavior\n\nWrite here what happens instead ...\n\n### Steps to reproduce:\n\nPlease create a reproducible case of your problem. Make sure\nthat case repeats consistently and it's not random\n1.\n2.\n3.\n\n### Redis / Jedis Configuration\n\n#### Jedis version:\n\n#### Redis version:\n\n#### Java version:\n\n\n\n\n"
},
{
"path": ".github/actions/run-tests/action.yml",
"content": "# Note: this action is used as a part of redis oss release and test automation in\n# redis-developer/redis-oss-release-automation repo\nname: 'Run Jedis Tests'\ndescription: 'Run Jedis tests in a containerized environment'\n\ninputs:\n redis_version:\n description: 'Redis version to test against'\n required: false\n client_libs_test_image_tag:\n description: 'Custom client libs test image tag to use instead of redis_version'\n required: false\n default: ''\n client_libs_test_image:\n description: 'Custom client libs test image name to use'\n required: false\n default: ''\n java_version:\n description: 'Java version to use'\n required: false\n default: '8'\n java_distribution:\n description: 'Java distribution to use'\n required: false\n default: 'temurin'\n specific_test:\n description: 'Run specific test(s) (optional)'\n required: false\n default: ''\n codecov_token:\n description: 'Codecov token for uploading coverage'\n required: false\n default: ''\n # repository and ref are reqired for correct checkout when using action\n # externally (e.g.: in redis-developer/redis-oss-release-automation)\n repository:\n description: 'Git repository to checkout'\n required: false\n default: ''\n ref:\n description: 'Git ref to checkout'\n required: false\n default: ''\n redis_env_work_dir:\n description: 'Redis env work directory'\n required: false\n default: ''\n redis_env_conf_dir:\n description: 'Redis env conf directory'\n required: false\n default: ''\n\nruns:\n using: 'composite'\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n with:\n repository: ${{ inputs.repository }}\n ref: ${{ inputs.ref }}\n\n - name: Validate inputs and prepare environment\n shell: bash\n id: args\n env:\n REDIS_VERSION: ${{ inputs.redis_version }}\n CLIENT_LIBS_TEST_IMAGE: ${{ inputs.client_libs_test_image }}\n CLIENT_LIBS_TEST_IMAGE_TAG: ${{ inputs.client_libs_test_image_tag }}\n REDIS_ENV_WORK_DIR: ${{ inputs.redis_env_work_dir }}\n REDIS_ENV_CONF_DIR: ${{ inputs.redis_env_conf_dir }}\n REDIS_VERSION_LABEL: ${{ inputs.client_libs_test_image_tag || inputs.redis_version }}\n run: |\n make_args=()\n\n if [ -n \"$CLIENT_LIBS_TEST_IMAGE\" ]; then\n make_args+=(CLIENT_LIBS_TEST_IMAGE=\"$CLIENT_LIBS_TEST_IMAGE\")\n fi\n\n if [ -n \"$CLIENT_LIBS_TEST_IMAGE_TAG\" ]; then\n make_args+=(CLIENT_LIBS_TEST_IMAGE_TAG=\"$CLIENT_LIBS_TEST_IMAGE_TAG\")\n elif [ -n \"$REDIS_VERSION\" ]; then\n make_args+=(version=\"$REDIS_VERSION\")\n else\n echo \"Error: redis_version or client_libs_test_image_tag input is required\"\n exit 1\n fi\n\n echo \"make_args=${make_args[*]}\" | tee -a ${GITHUB_OUTPUT}\n # either custom docker tag name or actual redis version\n echo \"redis_version_label=$REDIS_VERSION_LABEL\" | tee -a ${GITHUB_OUTPUT}\n\n if [ -z \"$REDIS_ENV_CONF_DIR\" ]; then\n REDIS_ENV_CONF_DIR=$(readlink -f \"${{ github.action_path }}/../../../src/test/resources/env\")\n fi\n echo \"redis_env_conf_dir=$REDIS_ENV_CONF_DIR\" | tee -a ${GITHUB_OUTPUT}\n\n if [ -n \"$REDIS_ENV_WORK_DIR\" ]; then\n echo \"redis_env_work_dir=$REDIS_ENV_WORK_DIR\" | tee -a ${GITHUB_OUTPUT}\n else\n REDIS_ENV_WORK_DIR=$(mktemp -du)\n echo \"redis_env_work_dir=$REDIS_ENV_WORK_DIR\" | tee -a ${GITHUB_OUTPUT}\n fi\n\n - name: Set up Java\n uses: actions/setup-java@v4\n with:\n java-version: ${{ inputs.java_version }}\n distribution: ${{ inputs.java_distribution }}\n\n - name: System setup\n shell: bash\n run: |\n sudo apt update\n sudo apt install -y make\n make compile-module\n\n - name: Cache dependencies\n uses: actions/cache@v4\n with:\n path: |\n ~/.m2/repository\n /var/cache/apt\n key: jedis-${{hashFiles('**/pom.xml')}}\n\n - name: Set up Docker Compose environment\n shell: bash\n run: |\n mkdir -m 777 $REDIS_ENV_WORK_DIR\n make start ${{ steps.args.outputs.make_args }}\n env:\n REDIS_ENV_CONF_DIR: ${{ steps.args.outputs.redis_env_conf_dir }}\n REDIS_ENV_WORK_DIR: ${{ steps.args.outputs.redis_env_work_dir }}\n\n - name: Maven offline\n shell: bash\n run: |\n mvn -q dependency:go-offline\n\n - name: Build docs\n shell: bash\n run: |\n mvn javadoc:jar\n\n - name: Run Maven tests\n shell: bash\n run: |\n export TEST_ENV_PROVIDER=oss-docker\n export TEST_WORK_FOLDER=$REDIS_ENV_WORK_DIR\n echo $TEST_WORK_FOLDER\n if [ -z \"$TESTS\" ]; then\n mvn -B -Dwith-param-names=true clean compile verify\n else\n mvn -B -Dwith-param-names=true -Dtest=$TESTS clean verify\n fi\n env:\n REDIS_ENV_WORK_DIR: ${{ steps.args.outputs.redis_env_work_dir }}\n JVM_OPTS: \"-XX:+HeapDumpOnOutOfMemoryError -XX:+ExitOnOutOfMemoryError -XX:HeapDumpPath=${{ runner.temp }}/heapdump-${{ steps.args.outputs.redis_version_label }}.hprof\"\n TESTS: ${{ inputs.specific_test }}\n\n - name: Upload Heap Dumps\n if: failure()\n uses: actions/upload-artifact@v4\n with:\n name: heap-dumps-${{ steps.args.outputs.redis_version_label }}\n path: ${{ runner.temp }}/heapdump-${{ steps.args.outputs.redis_version_label }}.hprof\n retention-days: 5\n\n - name: Upload Surefire Dump File\n uses: actions/upload-artifact@v4\n with:\n name: surefire-dumpstream\n path: target/surefire-reports/*.dumpstream\n\n - name: Publish Test Results\n uses: EnricoMi/publish-unit-test-result-action@v2\n if: github.actor != 'dependabot[bot]'\n with:\n files: |\n target/surefire-reports/**/*.xml\n target/failsafe-reports/**/*.xml\n\n - name: Collect logs on failure\n if: failure()\n shell: bash\n run: |\n echo \"Collecting logs from $REDIS_ENV_WORK_DIR...\"\n ls -la $REDIS_ENV_WORK_DIR\n env:\n REDIS_ENV_WORK_DIR: ${{ steps.args.outputs.redis_env_work_dir }}\n\n - name: Upload logs on failure\n if: failure()\n uses: actions/upload-artifact@v4\n with:\n name: redis-env-work-logs-${{ steps.args.outputs.redis_version_label }}\n path: ${{ steps.args.outputs.redis_env_work_dir }}\n\n - name: Tear down Docker Compose environment\n if: always()\n shell: bash\n run: |\n make stop\n continue-on-error: true\n\n - name: Upload merged coverage to Codecov\n if: inputs.codecov_token != ''\n uses: codecov/codecov-action@v5\n with:\n files: ./target/site/jacoco/jacoco.xml\n flags: docker-${{ steps.args.outputs.redis_version_label }}\n name: merged-coverage\n fail_ci_if_error: false\n token: ${{ inputs.codecov_token }}\n\n - name: Upload test results to Codecov (unit + IT)\n if: inputs.codecov_token != '' && !cancelled() && (github.event_name == 'schedule' || github.event_name == 'push' || github.event_name == 'workflow_dispatch')\n uses: codecov/test-results-action@v1\n with:\n fail_ci_if_error: false\n files: ./target/surefire-reports/TEST*,./target/failsafe-reports/TEST*\n flags: test-results-docker-${{ steps.args.outputs.redis_version_label }}\n token: ${{ inputs.codecov_token }}\n\n"
},
{
"path": ".github/codecov.yml",
"content": "codecov: # see https://docs.codecov.com/docs/codecovyml-reference\n branch: master\n\ncoverage:\n status: # see https://docs.codecov.com/docs/commit-status\n project:\n default:\n target: auto # minimum coverage ratio that the commit must meet to be considered a success\n threshold: 5 # Allow the coverage to drop by %, and posting a success status\n branches:\n - master\n - '[0-9].*'\n\ncomment: # see https://docs.codecov.com/docs/pull-request-comments\n layout: \"condensed_header, condensed_files, condensed_footer\"\n behavior: new\n require_changes: true\n\nignore:\n - \"**/*.txt\"\n"
},
{
"path": ".github/dependabot.yml",
"content": "version: 2\n\nupdates:\n - package-ecosystem: \"maven\"\n directory: \"/\"\n schedule:\n interval: \"weekly\"\n"
},
{
"path": ".github/release-drafter-config.yml",
"content": "name-template: '$NEXT_MINOR_VERSION'\ntag-template: 'v$NEXT_MINOR_VERSION'\nfilter-by-commitish: true\ncommitish: master\nautolabeler:\n - label: 'maintenance'\n files:\n - '*.md'\n - '.github/*'\n - label: 'bug'\n branch:\n - '/bug-.+'\n - label: 'maintenance'\n branch:\n - '/maintenance-.+'\n - label: 'feature'\n branch:\n - '/feature-.+'\ncategories:\n - title: '๐ฅ Breaking Changes'\n labels:\n - 'breakingchange'\n - title: '๐งช Experimental Features'\n labels:\n - 'experimental'\n - title: '๐ New Features'\n labels:\n - 'feature'\n - 'enhancement'\n - title: '๐ Bug Fixes'\n labels:\n - 'fix'\n - 'bugfix'\n - 'bug'\n - 'BUG'\n - title: '๐งฐ Maintenance'\n labels:\n - 'maintenance'\n - 'dependencies'\n - 'documentation'\n - 'docs'\n - 'testing'\nchange-template: '- $TITLE (#$NUMBER)'\nexclude-labels:\n - 'skip-changelog'\ntemplate: |\n # Changes\n\n $CHANGES\n\n ## Contributors\n We'd like to thank all the contributors who worked on this release!\n\n $CONTRIBUTORS\n\n"
},
{
"path": ".github/workflows/codeql-analysis.yml",
"content": "name: \"CodeQL\"\n\non:\n workflow_dispatch:\n push:\n branches: [ master ]\n pull_request:\n # The branches below must be a subset of the branches above\n branches: [ master ]\n schedule:\n - cron: '31 4 * * 4'\n\njobs:\n analyze:\n name: Analyze\n runs-on: ubuntu-latest\n permissions:\n security-events: write\n actions: read\n contents: read\n\n steps:\n - name: Checkout repository\n uses: actions/checkout@v4\n\n # Initializes the CodeQL tools for scanning.\n - name: Initialize CodeQL\n uses: github/codeql-action/init@v3\n with:\n languages: java\n dependency-caching: true\n build-mode: manual\n\n - name: Set up JDK 8\n uses: actions/setup-java@v4\n with:\n distribution: temurin\n java-version: '8'\n cache: maven\n\n - name: Build\n run: mvn -B package\n\n - name: Perform CodeQL Analysis\n uses: github/codeql-action/analyze@v3\n"
},
{
"path": ".github/workflows/docs.yml",
"content": "name: Publish Docs\non:\n push:\n branches: [\"master\"]\npermissions:\n contents: read\n pages: write\n id-token: write\nconcurrency:\n group: \"pages\"\n cancel-in-progress: false\njobs:\n build-and-deploy:\n concurrency: ci-${{ github.ref }}\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - uses: actions/setup-python@v5\n with:\n python-version: 3.13\n - name: Install dependencies\n run: |\n python -m pip install --upgrade pip\n pip install -r docs/requirements.txt\n - name: Build docs\n run: |\n mkdocs build -d docsbuild\n - name: Setup Pages\n uses: actions/configure-pages@v3\n - name: Upload artifact\n uses: actions/upload-pages-artifact@v3\n with:\n path: 'docsbuild'\n - name: Deploy to GitHub Pages\n id: deployment\n uses: actions/deploy-pages@v4\n"
},
{
"path": ".github/workflows/doctests.yml",
"content": "name: Documentation Tests\n\non:\n push:\n branches:\n - master\n - 'emb-examples'\n pull_request:\n workflow_dispatch:\n\njobs:\n doctests:\n runs-on: ubuntu-latest\n services:\n redis:\n image: redis:latest\n options: >-\n --health-cmd \"redis-cli ping\" --health-interval 10s --health-timeout 5s --health-retries 5\n ports:\n - 6379:6379\n\n steps:\n - uses: actions/checkout@v4\n - name: Cache dependencies\n uses: actions/cache@v4\n with:\n path: |\n ~/.m2/repository\n /var/cache/apt\n key: jedis-${{hashFiles('**/pom.xml')}}\n - name: Set up Java\n uses: actions/setup-java@v4\n with:\n java-version: '11'\n distribution: 'temurin'\n - name: Maven offline\n run: |\n mvn -q dependency:go-offline\n - name: Run doctests\n run: |\n mvn -Pdoctests clean compile test\n"
},
{
"path": ".github/workflows/format_check.yml",
"content": "name: Java Format Check\n\non:\n workflow_dispatch:\n pull_request:\n paths:\n - '**/*.java' # Only trigger for Java file changes\n\njobs:\n check-format:\n runs-on: ubuntu-latest\n\n steps:\n # Step 1: Checkout the PR code\n - name: Checkout code\n uses: actions/checkout@v3 \n\n # Step 2: Set up Java (if needed for format check tools)\n - name: Set up JDK\n uses: actions/setup-java@v4\n with:\n java-version: '11'\n distribution: 'temurin'\n\n # Step 3: Fetch latest changes\n - name: Fetch latest changes\n run: git fetch origin\n\n - name: Get changed Java files\n id: changed_files\n run: |\n echo \"::group::Changed Java Files\"\n echo Base Branch: ${{ github.event.pull_request.base.ref }}\n CHANGED_FILES=$(git diff --name-only --diff-filter=A origin/${{ github.event.pull_request.base.ref }} | grep '\\.java$' || true)\n echo \"$CHANGED_FILES\"\n echo \"::endgroup::\"\n # Write the multiline content to a file\n echo \"$CHANGED_FILES\" > changed_files.txt\n\n # Step 4: Get a list of changed Java files in the PR\n - name: Check Java file format\n run: |\n # Check if the changed_files.txt exists\n if [ ! -f changed_files.txt ]; then\n echo \"No changed files found.\"\n exit 0\n fi\n\n # Read the multiline content from the file\n CHANGED_FILES=$(cat changed_files.txt)\n\n # Ensure there are changed files\n if [ -z \"$CHANGED_FILES\" ]; then\n echo \"No Java files changed.\"\n else\n echo \"Processing the following changed Java files:\"\n\n # Iterate over the CHANGED_FILES variable, assuming files are separated by newlines\n while IFS= read -r FILE; do\n # Skip empty lines if any\n if [ -n \"$FILE\" ]; then\n FILE_NAME=$(basename \"$FILE\")\n echo \"Checking for $FILE_NAME\"\n \n # Run your formatter validation for each file\n mvn formatter:validate -f formatter-pom.xml \"-Dformatter.includes=**/$FILE_NAME\"\n fi\n done <<< \"$CHANGED_FILES\"\n fi\n"
},
{
"path": ".github/workflows/integration.yml",
"content": "---\n\nname: Build and Test using local environment\n\non:\n push:\n paths-ignore:\n - 'docs/**'\n - '**/*.md'\n - '**/*.rst'\n branches:\n - master\n - '[0-9].*'\n - 'topic/**'\n pull_request:\n branches:\n - master\n - '[0-9].*'\n schedule:\n - cron: '0 1 * * *' # nightly build\n workflow_dispatch:\n\njobs:\n\n build:\n name: Build and Test\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Set up publishing to maven central\n uses: actions/setup-java@v4\n with:\n java-version: '8'\n distribution: 'temurin'\n - name: System setup\n run: |\n sudo apt update\n sudo apt install -y make\n make system-setup\n - name: Cache dependencies\n uses: actions/cache@v4\n with:\n path: |\n ~/.m2/repository\n /var/cache/apt\n key: jedis-${{hashFiles('**/pom.xml')}}\n - name: Maven offline\n run: |\n mvn -q dependency:go-offline\n - name: Build docs\n run: |\n mvn javadoc:jar\n - name: Run tests\n run: |\n export TEST_ENV_PROVIDER=oss-local\n make test-local\n env:\n JVM_OPTS: -Xmx3200m\n TERM: dumb\n"
},
{
"path": ".github/workflows/release-drafter.yml",
"content": "name: Release Drafter\n\non:\n push:\n # branches to consider in the event; optional, defaults to all\n branches:\n - master\n workflow_dispatch:\n\njobs:\n update_release_draft:\n runs-on: ubuntu-latest\n steps:\n # Drafts your next Release notes as Pull Requests are merged into \"master\"\n - uses: release-drafter/release-drafter@v5\n with:\n # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml\n config-name: release-drafter-config.yml\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n\n"
},
{
"path": ".github/workflows/snapshot.yml",
"content": "---\n\nname: Publish Snapshot\n\non:\n push:\n branches:\n - master\n - '[0-9].x'\n workflow_dispatch:\n\njobs:\n\n snapshot:\n name: Deploy Snapshot\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v4\n - name: Set up publishing to maven central\n uses: actions/setup-java@v4\n with:\n java-version: '8'\n distribution: 'temurin'\n server-id: central\n server-username: MAVEN_USERNAME\n server-password: MAVEN_PASSWORD\n - name: Cache dependencies\n uses: actions/cache@v4\n with:\n path: |\n ~/.m2/repository\n /var/cache/apt\n key: jedis-${{hashFiles('**/pom.xml')}}\n - name: mvn offline\n run: |\n mvn -q dependency:go-offline\n - name: deploy\n run: |\n mvn --no-transfer-progress \\\n -DskipTests deploy\n env:\n MAVEN_USERNAME: ${{secrets.OSSH_USERNAME}}\n MAVEN_PASSWORD: ${{secrets.OSSH_TOKEN}}\n"
},
{
"path": ".github/workflows/stale-issues.yml",
"content": "name: \"Close stale issues\"\non:\n schedule:\n - cron: \"0 0 * * *\"\n\npermissions: {}\njobs:\n stale:\n permissions:\n issues: write # to close stale issues (actions/stale)\n pull-requests: write # to close stale PRs (actions/stale)\n\n runs-on: ubuntu-latest\n steps:\n - uses: actions/stale@v3\n with:\n repo-token: ${{ secrets.GITHUB_TOKEN }}\n stale-issue-message: 'This issue is marked stale. It will be closed in 30 days if it is not updated.'\n stale-pr-message: 'This pull request is marked stale. It will be closed in 30 days if it is not updated.'\n days-before-stale: 30\n days-before-close: 30\n stale-issue-label: \"stale\"\n stale-pr-label: \"stale\"\n operations-per-run: 10\n remove-stale-when-updated: true\n only-labels: 'waiting-for-feedback'\n exempt-issue-labels: 'feedback-provided'\n exempt-pr-labels: 'feedback-provided'\n exempt-all-milestones: true"
},
{
"path": ".github/workflows/test-on-docker.yml",
"content": "---\n\nname: Build and Test using a containerized environment\nrun-name: \"Build and Test using ${{ github.event.inputs.client_libs_test_image_tag != '' && format('image: {0}', github.event.inputs.client_libs_test_image_tag) || 'a containerized environment' }}\"\n\non:\n push:\n paths-ignore:\n - 'docs/**'\n - '**/*.md'\n - '**/*.rst'\n branches:\n - master\n - '[0-9].*'\n - 'feature/**'\n - 'topic/**'\n pull_request:\n branches:\n - master\n - '[0-9].*'\n - 'feature/**'\n schedule:\n - cron: '0 1 * * *' # nightly build\n workflow_dispatch:\n inputs:\n specific_test:\n description: 'Run specific test(s) (optional)'\n required: false\n default: ''\n client_libs_test_image_tag:\n description: 'Custom client libs test image tag to use instead of redis_version'\n required: false\n default: ''\njobs:\n\n build:\n name: Build and Test\n if: github.event.inputs.client_libs_test_image_tag == ''\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n redis_version:\n - \"8.6\"\n - \"8.4\"\n - \"8.2\"\n - \"8.0\"\n - \"7.4\"\n - \"7.2\"\n # - \"6.2\"\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n\n - uses: ./.github/actions/run-tests\n with:\n redis_version: ${{ matrix.redis_version }}\n specific_test: ${{ github.event.inputs.specific_test || '' }}\n codecov_token: ${{ secrets.CODECOV_TOKEN }}\n redis_env_work_dir: ${{ github.workspace }}/redis-env-work\n redis_env_conf_dir: ${{ github.workspace }}/src/test/resources/env\n\n build_using_custom_image:\n name: Build and Test using custom image\n if: github.event.inputs.client_libs_test_image_tag != ''\n runs-on: ubuntu-latest\n steps:\n - name: Checkout code\n uses: actions/checkout@v4\n\n - uses: ./.github/actions/run-tests\n with:\n client_libs_test_image_tag: ${{ github.event.inputs.client_libs_test_image_tag }}\n specific_test: ${{ github.event.inputs.specific_test || '' }}\n codecov_token: ${{ secrets.CODECOV_TOKEN }}\n redis_env_work_dir: ${{ github.workspace }}/redis-env-work\n redis_env_conf_dir: ${{ github.workspace }}/src/test/resources/env\n"
},
{
"path": ".github/workflows/version-and-release.yml",
"content": "name: Release\n\non:\n release:\n types: [published]\n\njobs:\n build:\n runs-on: ubuntu-latest\n\n steps:\n - uses: actions/checkout@v4\n\n - name: get version from tag\n id: get_version\n run: |\n realversion=\"${GITHUB_REF/refs\\/tags\\//}\"\n realversion=\"${realversion//v/}\"\n echo \"VERSION=$realversion\" >> $GITHUB_OUTPUT\n\n - name: Set up publishing to maven central\n uses: actions/setup-java@v4\n with:\n java-version: '8'\n distribution: 'temurin'\n server-id: central\n server-username: MAVEN_USERNAME\n server-password: MAVEN_PASSWORD\n\n - name: mvn versions\n run: mvn versions:set -DnewVersion=${{ steps.get_version.outputs.VERSION }}\n\n - name: Install gpg key\n run: |\n cat <(echo -e \"${{ secrets.OSSH_GPG_SECRET_KEY }}\") | gpg --batch --import\n gpg --list-secret-keys --keyid-format LONG\n\n - name: Publish\n run: |\n mvn --no-transfer-progress \\\n --batch-mode \\\n -Dgpg.passphrase='${{ secrets.OSSH_GPG_SECRET_KEY_PASSWORD }}' \\\n -DskipTests deploy -P release\n env:\n MAVEN_USERNAME: ${{secrets.OSSH_USERNAME}}\n MAVEN_PASSWORD: ${{secrets.OSSH_TOKEN}}\n"
},
{
"path": ".gitignore",
"content": ".classpath\n*.iml\n*.ipr\n*.iws\nnb*\n.project\n.settings/\n.gradle/\ntarget/\nbuild/\nbin/\ntags\n.idea\n.run\n*.aof\n*.rdb\nredis-git\nappendonlydir/\n.DS_Store\n.vscode/settings.json\n"
},
{
"path": "LICENSE",
"content": "MIT License\n\nCopyright (c) 2021-2023, Redis, inc.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the \"Software\"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
{
"path": "Makefile",
"content": "PATH := ./redis-git/src:${PATH}\n\n# Supported test env versions\nSUPPORTED_TEST_ENV_VERSIONS := 8.6 8.4 8.2 8.0 7.4 7.2 6.2\nDEFAULT_TEST_ENV_VERSION := 8.6\nREDIS_ENV_WORK_DIR := $(or ${REDIS_ENV_WORK_DIR},/tmp/redis-env-work)\nTOXIPROXY_IMAGE := ghcr.io/shopify/toxiproxy:2.8.0\n\ndefine REDIS1_CONF\ndaemonize yes\nprotected-mode no\nport 6379\nrequirepass foobared\nuser acljedis on allcommands allkeys >fizzbuzz\nuser deploy on allcommands allkeys >verify\npidfile /tmp/redis1.pid\nlogfile /tmp/redis1.log\nsave \"\"\nappendonly no\nenable-module-command yes\nclient-output-buffer-limit pubsub 256k 128k 5\nendef\n\n# UDS REDIS NODES\ndefine REDIS_UDS\ndaemonize yes\nprotected-mode no\nport 0\npidfile /tmp/redis_uds.pid\nlogfile /tmp/redis_uds.log\nunixsocket /tmp/redis_uds.sock\nunixsocketperm 777\nsave \"\"\nappendonly no\nendef\n\n# UNAVAILABLE REDIS NODES\ndefine REDIS_UNAVAILABLE_CONF\ndaemonize yes\nprotected-mode no\nport 6400\npidfile /tmp/redis_unavailable.pid\nlogfile /tmp/redis_unavailable.log\nsave \"\"\nappendonly no\nendef\n\nexport REDIS1_CONF\nexport REDIS_UDS\nexport REDIS_UNAVAILABLE_CONF\n\n\nstart-local: cleanup compile-module\n\t# Simple local test env that provides only \"standalone-0\" endpoint and an instance listening on Unix socket\n\texport TEST_ENV_PROVIDER=oss-source\n\techo \"$$REDIS1_CONF\" | redis-server -\n\techo \"$$REDIS_UDS\" | redis-server -\n\techo \"$$REDIS_UNAVAILABLE_CONF\" | redis-server -\n\ncleanup:\n\t- rm -vf /tmp/redis*.log 2>/dev/null\n\t- rm dump.rdb appendonly.aof - 2>/dev/null\n\nstop-local:\n\t@for pidfile in \\\n\t\t/tmp/redis1.pid \\\n\t\t/tmp/redis_uds.pid; do \\\n\t\tif [ -f $$pidfile ]; then \\\n\t\t\tpid=$$(cat $$pidfile); \\\n\t\t\tif kill -0 $$pid 2>/dev/null; then \\\n\t\t\t\techo \"Stopping process $$pid from $$pidfile\"; \\\n\t\t\t\tkill $$pid; \\\n\t\t\t\tsleep 1; \\\n\t\t\t\tif kill -0 $$pid 2>/dev/null; then \\\n\t\t\t\t\techo \"PID $$pid did not exit, forcing kill\"; \\\n\t\t\t\t\tkill -9 $$pid; \\\n\t\t\t\tfi; \\\n\t\t\tfi; \\\n\t\t\trm -f $$pidfile; \\\n\t\tfi; \\\n\tdone\n\t[ -f /tmp/redis_unavailable.pid ] && kill `cat /tmp/redis_unavailable.pid` || true\n\ntest-local: | start-local mvn-test-local stop-local\n\nmvn-test-local:\n\t@TEST_ENV_PROVIDER=oss-source mvn -Dwith-param-names=true -Dtest=${TEST} clean verify\n\nmvn-test:\n\tmvn -Dwith-param-names=true -Dtest=${TEST} clean verify\n\nformat:\n\tmvn java-formatter:format\n\nsystem-setup:\n\t# Install gcc with Homebrew (macOS) or apt (Linux)\n\tif [ \"$(shell uname)\" = \"Darwin\" ]; then \\\n\t\tbrew install gcc || true; \\\n\telse \\\n\t\tsudo apt install -y gcc g++; \\\n\tfi\n\t[ ! -e redis-git ] && git clone https://github.com/redis/redis.git --branch unstable --single-branch redis-git || true\n\t$(MAKE) -C redis-git clean\n\t$(MAKE) -C redis-git BUILD_TLS=yes\n\ncompile-module:\n\tgcc -shared -o /tmp/testmodule.so -fPIC src/test/resources/testmodule.c\n\n# Start test environment with specific version using predefined docker compose setup\n\nstart:\n\t@if [ -z \"$(version)\" ]; then \\\n\t\tversion=$(arg); \\\n\t\tif [ -z \"$$version\" ]; then \\\n\t\t\tversion=\"$(DEFAULT_TEST_ENV_VERSION)\"; \\\n\t\tfi; \\\n\tfi; \\\n\tif [ -n \"$$CLIENT_LIBS_TEST_IMAGE_TAG\" ]; then \\\n\t\techo \"Using custom image tag: $$CLIENT_LIBS_TEST_IMAGE_TAG\"; \\\n\t\tversion=\"\"; \\\n\telif ! echo \"$(SUPPORTED_TEST_ENV_VERSIONS)\" | grep -qw \"$$version\"; then \\\n\t\techo \"Error: Invalid version '$$version'. Supported versions are: $(SUPPORTED_TEST_ENV_VERSIONS).\"; \\\n\t\texit 1; \\\n\tfi; \\\n\tdefault_env_file=\"src/test/resources/env/.env\"; \\\n\tcustom_env_file=\"src/test/resources/env/.env.v$$version\"; \\\n\tenv_files=\"--env-file $$default_env_file\"; \\\n\tif [ -f \"$$custom_env_file\" ]; then \\\n\t\tenv_files=\"$$env_files --env-file $$custom_env_file\"; \\\n\tfi; \\\n\trm -rf \"$(REDIS_ENV_WORK_DIR)\"; \\\n\tmkdir -p \"$(REDIS_ENV_WORK_DIR)\"; \\\n\tdocker compose $$env_files -f src/test/resources/env/docker-compose.yml up -d --wait --quiet-pull; \\\n\techo \"Started test environment with Redis version $$version. \"\n\n# Stop the test environment\nstop:\n\tdocker compose -f src/test/resources/env/docker-compose.yml down; \\\n\trm -rf \"$(REDIS_ENV_WORK_DIR)\"; \\\n\techo \"Stopped test environment and performed cleanup.\"\n\ntest: | start mvn-test stop\n\n.PHONY: test test-local start start-local stop stop-local cleanup mvn-test-local mvn-test format system-setup compile-module\n"
},
{
"path": "README.md",
"content": "# Jedis\n\n[](https://github.com/redis/jedis/releases/latest)\n[](https://central.sonatype.com/artifact/redis.clients/jedis)\n[](https://www.javadoc.io/doc/redis.clients/jedis)\n[](https://github.com/redis/jedis/blob/master/LICENSE)\n[](https://codecov.io/gh/redis/jedis)\n[](https://discord.gg/redis)\n\n## What is Jedis?\n\nJedis is a Java client for [Redis](https://github.com/redis/redis \"Redis\") designed for performance and ease of use.\n\nAre you looking for a high-level library to handle object mapping? See [redis-om-spring](https://github.com/redis/redis-om-spring)!\n\n## How do I Redis?\n\n[Learn for free at Redis University](https://university.redis.io/academy/)\n\n[Try the Redis Cloud](https://redis.io/try-free/)\n\n[Dive in developer tutorials](https://redis.io/learn/)\n\n[Join the Redis community](https://redis.io/community/)\n\n[Work at Redis](https://redis.io/careers/jobs/)\n\n## Supported Redis versions\n\nThe most recent version of this library supports redis version \n[7.2](https://github.com/redis/redis/blob/7.2/00-RELEASENOTES),\n[7.4](https://github.com/redis/redis/blob/7.4/00-RELEASENOTES),\n[8.0](https://github.com/redis/redis/blob/8.0/00-RELEASENOTES),\n[8.2](https://github.com/redis/redis/blob/8.2/00-RELEASENOTES) and\n[8.4](https://github.com/redis/redis/blob/8.4/00-RELEASENOTES).\n\nThe table below highlights version compatibility of the most-recent library versions with Redis and JDK versions. Compatibility means communication features, and Redis command capabilities.\n\n\n| Jedis version | Supported Redis versions | JDK Compatibility |\n|---------------|---------------------------------------|-------------------|\n| 3.9+ | 5.0 to 6.2 Family of releases | 8, 11 |\n| >= 4.0 | Version 5.0 to 7.2 Family of releases | 8, 11, 17 |\n| >= 5.0 | Version 6.0 to current | 8, 11, 17, 21 |\n| >= 5.2 | Version 7.2 to current | 8, 11, 17, 21 |\n| >= 6.0 | Version 7.2 to current | 8, 11, 17, 21 |\n| >= 7.0 | Version 7.2 to current | 8, 11, 17, 21 |\n\n## Getting started\n\nTo get started with Jedis, first add it as a dependency in your Java project. If you're using Maven, that looks like this:\n\n```xml\n\n redis.clients\n jedis\n 7.1.0\n\n```\n\nTo use the cutting-edge Jedis, check [here](https://redis.github.io/jedis/jedis-maven/).\n\nNext, you'll need to connect to Redis. Consider installing a redis server with docker:\n\n```bash\ndocker run -p 6379:6379 -it redis:latest\n```\n\nYou can instantiate a RedisClient like so:\n\n```java\nRedisClient jedis = RedisClient.builder().hostAndPort(\"localhost\", 6379).build();\n```\n\nNow you can send commands:\n\n```java\njedis.sadd(\"planets\", \"Venus\");\n```\n\n## Connecting to a Redis cluster\n\nJedis lets you connect to Redis Clusters, supporting the [Redis Cluster Specification](https://redis.io/topics/cluster-spec).\nTo do this, you'll need to connect using `RedisClusterClient`. See the example below:\n\n```java\nSet jedisClusterNodes = new HashSet();\njedisClusterNodes.add(new HostAndPort(\"127.0.0.1\", 7379));\njedisClusterNodes.add(new HostAndPort(\"127.0.0.1\", 7380));\nRedisClusterClient jedis = RedisClusterClient.builder().nodes(jedisClusterNodes).build();\n```\n\nNow you can use the `RedisClusterClient` instance and send commands like you would with a standard pooled connection:\n\n```java\njedis.sadd(\"planets\", \"Mars\");\n```\n\n## Support for Redis data types\n\nJedis includes support for all [Redis data types](https://redis.io/docs/latest/develop/data-types/) and features such as\n[JSON](https://redis.io/docs/latest/develop/data-types/json/) and [VectorSets](https://redis.io/docs/latest/develop/data-types/vector-sets/).\n\n## Failover\n\nJedis supports retry and failover for your Redis deployments. This is useful when:\n\n1. You have more than one Redis deployment. This might include two independent Redis servers or two or more Redis databases replicated across multiple [active-active Redis Enterprise](https://redis.io/docs/latest/operate/rs/databases/active-active/) clusters.\n2. You want your application to connect to one deployment at a time and to fail over to the next available deployment if the first deployment becomes unavailable.\n\nFor the complete failover configuration options and examples, see the [Jedis failover docs](https://redis.github.io/jedis/failover/).\n\n## Token-Based Authentication\n\nJedis supports Token-Based authentication (TBA) starting with 5.3.0 GA release. This feature is complemented by an extension library that enhances the developer experience and provides most of the components required for TBA functionality.\n\nNotably, the extension library includes built-in support for **Microsoft EntraID**, offering a seamless integration as part of the generic solution.\n\nFor more details and examples, please refer to the [Advanced Usage](https://redis.github.io/jedis/advanced-usage/) documentation.\n\n## Documentation\n\nThe [Jedis documentation site](https://redis.github.io/jedis/) contains several useful articles for using Jedis.\n\nYou can also check the [latest Jedis Javadocs](https://www.javadoc.io/doc/redis.clients/jedis/latest/index.html).\n\nSome specific use-case examples can be found in [`redis.clients.jedis.examples`\npackage](https://github.com/redis/jedis/tree/master/src/test/java/redis/clients/jedis/examples/) of the test source codes.\n\n## Troubleshooting\n\nIf you run into trouble or have any questions, we're here to help!\n\nHit us up on the [Redis Discord Server](http://discord.gg/redis) or \n[Jedis GitHub Discussions](https://github.com/redis/jedis/discussions).\n\n## Contributing\n\nWe'd love your contributions!\n\nBug reports are always welcome! [You can open a bug report on GitHub](https://github.com/redis/jedis/issues/new).\n\nYou can also contribute documentation -- or anything to improve Jedis. Please see\n[contribution guideline](https://github.com/redis/jedis/blob/master/.github/CONTRIBUTING.md) for more details.\n\n## License\n\nJedis is licensed under the [MIT license](https://github.com/redis/jedis/blob/master/LICENSE).\n\n## Sponsorship\n\n[](https://redis.io/)\n"
},
{
"path": "docs/Dockerfile",
"content": "FROM squidfunk/mkdocs-material\nCOPY requirements.txt .\nRUN pip install -r requirements.txt\n"
},
{
"path": "docs/README.md",
"content": "# Jedis Documentation\n\nThis documentation uses [MkDocs](https://www.mkdocs.org/) to generate the static site.\n\nSee [mkdocs.yml](../mkdocs.yml) for the configuration. \n\nTo develop the documentation locally, you can use the included [Dockerfile](Dockerfile) to build a container with all the \ndependencies, and run it to preview your changes:\n\n```bash\n# in docs/\ndocker build -t squidfunk/mkdocs-material .\n# cd ..\ndocker run --rm -it -p 8000:8000 -v ${PWD}:/docs squidfunk/mkdocs-material \n```"
},
{
"path": "docs/advanced-usage.md",
"content": "# Advanced Usage\n\n## Transactions\n\nTo do transactions in Jedis, you have to wrap operations in a transaction block, very similar to pipelining:\n\n```java\njedis.watch (key1, key2, ...);\nTransaction t = jedis.multi();\nt.set(\"foo\", \"bar\");\nt.exec();\n```\n\nNote: when you have any method that returns values, you have to do like this:\n\n\n```java\nTransaction t = jedis.multi();\nt.set(\"fool\", \"bar\"); \nResponse result1 = t.get(\"fool\");\n\nt.zadd(\"foo\", 1, \"barowitch\"); t.zadd(\"foo\", 0, \"barinsky\"); t.zadd(\"foo\", 0, \"barikoviev\");\nResponse> sose = t.zrange(\"foo\", 0, -1); // get the entire sortedset\nt.exec(); // dont forget it\n\nString foolbar = result1.get(); // use Response.get() to retrieve things from a Response\nint soseSize = sose.get().size(); // on sose.get() you can directly call Set methods!\n\n// List