diff --git a/.github/actions/build_clio/action.yml b/.github/actions/build_clio/action.yml index 3316d2ed6..2287ad22e 100644 --- a/.github/actions/build_clio/action.yml +++ b/.github/actions/build_clio/action.yml @@ -4,12 +4,18 @@ inputs: target: description: Build target name default: all + substract_threads: + description: An option for the action get_number_of_threads. See get_number_of_threads + required: true + default: '0' runs: using: composite steps: - name: Get number of threads uses: ./.github/actions/get_number_of_threads id: number_of_threads + with: + substract_threads: ${{ inputs.substract_threads }} - name: Build Clio shell: bash diff --git a/.github/actions/generate/action.yml b/.github/actions/generate/action.yml index 1dcfe0193..1926cf135 100644 --- a/.github/actions/generate/action.yml +++ b/.github/actions/generate/action.yml @@ -12,6 +12,10 @@ inputs: description: Build type for third-party libraries and clio. Could be 'Release', 'Debug' required: true default: 'Release' + build_integration_tests: + description: Whether to build integration tests + required: true + default: 'true' code_coverage: description: Whether conan's coverage option should be on or not required: true @@ -20,6 +24,10 @@ inputs: description: Whether Clio is to be statically linked required: true default: 'false' + sanitizer: + description: Sanitizer to use + required: true + default: 'false' # false, tsan, asan or ubsan runs: using: composite steps: @@ -33,14 +41,20 @@ runs: BUILD_OPTION: "${{ inputs.conan_cache_hit == 'true' && 'missing' || '' }}" CODE_COVERAGE: "${{ inputs.code_coverage == 'true' && 'True' || 'False' }}" STATIC_OPTION: "${{ inputs.static == 'true' && 'True' || 'False' }}" + INTEGRATION_TESTS_OPTION: "${{ inputs.build_integration_tests == 'true' && 'True' || 'False' }}" run: | cd build - conan install .. -of . -b $BUILD_OPTION -s build_type=${{ inputs.build_type }} -o clio:static="${STATIC_OPTION}" -o clio:tests=True -o clio:integration_tests=True -o clio:lint=False -o clio:coverage="${CODE_COVERAGE}" --profile ${{ inputs.conan_profile }} - + conan install .. -of . -b $BUILD_OPTION -s build_type=${{ inputs.build_type }} -o clio:static="${STATIC_OPTION}" -o clio:tests=True -o clio:integration_tests="${INTEGRATION_TESTS_OPTION}" -o clio:lint=False -o clio:coverage="${CODE_COVERAGE}" --profile ${{ inputs.conan_profile }} + - name: Run cmake shell: bash env: BUILD_TYPE: "${{ inputs.build_type }}" + SANITIZER_OPTION: | + ${{ inputs.sanitizer == 'tsan' && '-Dsan=thread' || + inputs.sanitizer == 'ubsan' && '-Dsan=undefined' || + inputs.sanitizer == 'asan' && '-Dsan=address' || + '' }} run: | cd build - cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE=${{ inputs.build_type }} ${{ inputs.extra_cmake_args }} .. -G Ninja + cmake -DCMAKE_TOOLCHAIN_FILE:FILEPATH=build/generators/conan_toolchain.cmake -DCMAKE_BUILD_TYPE="${BUILD_TYPE}" ${SANITIZER_OPTION} .. -G Ninja diff --git a/.github/actions/get_number_of_threads/action.yml b/.github/actions/get_number_of_threads/action.yml index 3af2e9f2b..088371b9e 100644 --- a/.github/actions/get_number_of_threads/action.yml +++ b/.github/actions/get_number_of_threads/action.yml @@ -1,5 +1,10 @@ name: Get number of threads description: Determines number of threads to use on macOS and Linux +inputs: + substract_threads: + description: How many threads to substract from the calculated number + required: true + default: '0' outputs: threads_number: description: Number of threads to use @@ -19,8 +24,11 @@ runs: shell: bash run: echo "num=$(($(nproc) - 2))" >> $GITHUB_OUTPUT - - name: Export output variable - shell: bash + - name: Shift and export number of threads id: number_of_threads_export + shell: bash run: | - echo "num=${{ steps.mac_threads.outputs.num || steps.linux_threads.outputs.num }}" >> $GITHUB_OUTPUT + num_of_threads=${{ steps.mac_threads.outputs.num || steps.linux_threads.outputs.num }} + shift_by=${{ inputs.substract_threads }} + shifted=$((num_of_threads - shift_by)) + echo "num=$(( shifted > 1 ? shifted : 1 ))" >> $GITHUB_OUTPUT diff --git a/.github/scripts/execute-tests-under-sanitizer b/.github/scripts/execute-tests-under-sanitizer new file mode 100755 index 000000000..4e1cc087e --- /dev/null +++ b/.github/scripts/execute-tests-under-sanitizer @@ -0,0 +1,45 @@ +#!/bin/bash + +set -o pipefail + +# Note: This script is intended to be run from the root of the repository. +# +# This script runs each unit-test separately and generates reports from the currently active sanitizer. +# Output is saved in ./.sanitizer-report in the root of the repository + +if [[ -z "$1" ]]; then + cat < /dev/null 2>&1 + + if [ $? -ne 0 ]; then + echo "'$TEST' failed a sanitizer check." + fi +done diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index e200a3ad3..45d62bb7c 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -9,7 +9,7 @@ on: jobs: check_format: name: Check format - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest container: image: rippleci/clio_ci:latest steps: @@ -26,7 +26,7 @@ jobs: check_docs: name: Check documentation - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest container: image: rippleci/clio_ci:latest steps: @@ -47,133 +47,44 @@ jobs: matrix: include: - os: heavy - container: - image: rippleci/clio_ci:latest - build_type: Release conan_profile: gcc + build_type: Release + container: '{ "image": "rippleci/clio_ci:latest" }' code_coverage: false static: true - os: heavy - container: - image: rippleci/clio_ci:latest - build_type: Debug conan_profile: gcc + build_type: Debug + container: '{ "image": "rippleci/clio_ci:latest" }' code_coverage: true static: true - os: heavy - container: - image: rippleci/clio_ci:latest - build_type: Release conan_profile: clang + build_type: Release + container: '{ "image": "rippleci/clio_ci:latest" }' code_coverage: false static: true - os: heavy - container: - image: rippleci/clio_ci:latest - build_type: Debug conan_profile: clang + build_type: Debug + container: '{ "image": "rippleci/clio_ci:latest" }' code_coverage: false static: true - os: macos15 build_type: Release code_coverage: false static: false - runs-on: [self-hosted, "${{ matrix.os }}"] - container: ${{ matrix.container }} - - steps: - - name: Clean workdir - if: ${{ runner.os == 'macOS' }} - uses: kuznetsss/workspace-cleanup@1.0 - - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Prepare runner - uses: ./.github/actions/prepare_runner - with: - disable_ccache: false - - - name: Setup conan - uses: ./.github/actions/setup_conan - id: conan - with: - conan_profile: ${{ matrix.conan_profile }} - - - name: Restore cache - uses: ./.github/actions/restore_cache - id: restore_cache - with: - conan_dir: ${{ env.CONAN_USER_HOME }}/.conan - conan_profile: ${{ steps.conan.outputs.conan_profile }} - ccache_dir: ${{ env.CCACHE_DIR }} - build_type: ${{ matrix.build_type }} - code_coverage: ${{ matrix.code_coverage }} - - - name: Run conan and cmake - uses: ./.github/actions/generate - with: - conan_profile: ${{ steps.conan.outputs.conan_profile }} - conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }} - build_type: ${{ matrix.build_type }} - code_coverage: ${{ matrix.code_coverage }} - static: ${{ matrix.static }} - - - name: Build Clio - uses: ./.github/actions/build_clio - - - name: Show ccache's statistics - shell: bash - id: ccache_stats - run: | - ccache -s > /tmp/ccache.stats - miss_rate=$(cat /tmp/ccache.stats | grep 'Misses' | head -n1 | sed 's/.*(\(.*\)%).*/\1/') - echo "miss_rate=${miss_rate}" >> $GITHUB_OUTPUT - cat /tmp/ccache.stats - - - name: Strip tests - if: ${{ !matrix.code_coverage }} - run: strip build/clio_tests && strip build/clio_integration_tests - - - name: Upload clio_server - uses: actions/upload-artifact@v4 - with: - name: clio_server_${{ runner.os }}_${{ matrix.build_type }}_${{ steps.conan.outputs.conan_profile }} - path: build/clio_server - - - name: Upload clio_tests - if: ${{ !matrix.code_coverage }} - uses: actions/upload-artifact@v4 - with: - name: clio_tests_${{ runner.os }}_${{ matrix.build_type }}_${{ steps.conan.outputs.conan_profile }} - path: build/clio_*tests - - - name: Save cache - uses: ./.github/actions/save_cache - with: - conan_dir: ${{ env.CONAN_USER_HOME }}/.conan - conan_hash: ${{ steps.restore_cache.outputs.conan_hash }} - conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }} - ccache_dir: ${{ env.CCACHE_DIR }} - ccache_cache_hit: ${{ steps.restore_cache.outputs.ccache_cache_hit }} - ccache_cache_miss_rate: ${{ steps.ccache_stats.outputs.miss_rate }} - build_type: ${{ matrix.build_type }} - code_coverage: ${{ matrix.code_coverage }} - conan_profile: ${{ steps.conan.outputs.conan_profile }} - - # TODO: This is not a part of build process but it is the easiest way to do it here. - # It will be refactored in https://github.com/XRPLF/clio/issues/1075 - - name: Run code coverage - if: ${{ matrix.code_coverage }} - uses: ./.github/actions/code_coverage - - upload_coverage_report: - name: Codecov - needs: build - uses: ./.github/workflows/upload_coverage_report.yml - secrets: - CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} + uses: ./.github/workflows/build_impl.yml + with: + runs_on: ${{ matrix.os }} + container: ${{ matrix.container }} + conan_profile: ${{ matrix.conan_profile }} + build_type: ${{ matrix.build_type }} + code_coverage: ${{ matrix.code_coverage }} + static: ${{ matrix.static }} + unit_tests: true + integration_tests: true + clio_server: true test: name: Run Tests @@ -183,24 +94,24 @@ jobs: matrix: include: - os: heavy - container: - image: rippleci/clio_ci:latest conan_profile: gcc build_type: Release - - os: heavy container: image: rippleci/clio_ci:latest + - os: heavy conan_profile: clang build_type: Release - - os: heavy container: image: rippleci/clio_ci:latest + - os: heavy conan_profile: clang build_type: Debug + container: + image: rippleci/clio_ci:latest - os: macos15 conan_profile: apple_clang_16 build_type: Release - runs-on: [self-hosted, "${{ matrix.os }}"] + runs-on: ${{ matrix.os }} container: ${{ matrix.container }} steps: @@ -216,3 +127,44 @@ jobs: run: | chmod +x ./clio_tests ./clio_tests + + check_config: + name: Check Config Description + needs: build + runs-on: heavy + container: + image: rippleci/clio_ci:latest + steps: + - uses: actions/checkout@v4 + - uses: actions/download-artifact@v4 + with: + name: clio_server_Linux_Release_gcc + - name: Compare Config Description + shell: bash + run: | + repoConfigFile=docs/config-description.md + if ! [ -f ${repoConfigFile} ]; then + echo "Config Description markdown file is missing in docs folder" + exit 1 + fi + + chmod +x ./clio_server + configDescriptionFile=config_description_new.md + ./clio_server -d ${configDescriptionFile} + + configDescriptionHash=$(sha256sum ${configDescriptionFile} | cut -d' ' -f1) + repoConfigHash=$(sha256sum ${repoConfigFile} | cut -d' ' -f1) + + if [ ${configDescriptionHash} != ${repoConfigHash} ]; then + echo "Markdown file is not up to date" + diff -u "${repoConfigFile}" "${configDescriptionFile}" + rm -f ${configDescriptionFile} + exit 1 + fi + rm -f ${configDescriptionFile} + exit 0 + + + + + diff --git a/.github/workflows/build_clio_docker_image.yml b/.github/workflows/build_clio_docker_image.yml index 6a3594684..07c6ba321 100644 --- a/.github/workflows/build_clio_docker_image.yml +++ b/.github/workflows/build_clio_docker_image.yml @@ -40,7 +40,7 @@ on: jobs: build_and_publish_image: name: Build and publish image - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 diff --git a/.github/workflows/build_impl.yml b/.github/workflows/build_impl.yml new file mode 100644 index 000000000..db4a7edd0 --- /dev/null +++ b/.github/workflows/build_impl.yml @@ -0,0 +1,192 @@ +name: Reusable build +on: + workflow_call: + inputs: + runs_on: + description: Runner to run the job on + required: true + type: string + default: heavy + + container: + description: "The container object as a JSON string (leave empty to run natively)" + required: true + type: string + default: "" + + conan_profile: + description: Conan profile to use + required: true + type: string + + build_type: + description: Build type + required: true + type: string + + disable_cache: + description: Whether ccache and conan cache should be disabled + required: false + type: boolean + default: false + + code_coverage: + description: Whether to enable code coverage + required: true + type: boolean + default: false + + static: + description: Whether to build static binaries + required: true + type: boolean + default: true + + unit_tests: + description: Whether to run unit tests + required: true + type: boolean + default: false + + integration_tests: + description: Whether to run integration tests + required: true + type: boolean + default: false + + clio_server: + description: Whether to build clio_server + required: true + type: boolean + default: true + + target: + description: Build target name + required: false + type: string + default: all + + sanitizer: + description: Sanitizer to use + required: false + type: string + default: 'false' + +jobs: + build: + name: Build ${{ inputs.container != '' && 'in container' || 'natively' }} + runs-on: ${{ inputs.runs_on }} + container: ${{ inputs.container != '' && fromJson(inputs.container) || null }} + + steps: + - name: Clean workdir + if: ${{ runner.os == 'macOS' }} + uses: kuznetsss/workspace-cleanup@1.0 + + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - name: Prepare runner + uses: ./.github/actions/prepare_runner + with: + disable_ccache: ${{ inputs.disable_cache }} + + - name: Setup conan + uses: ./.github/actions/setup_conan + id: conan + with: + conan_profile: ${{ inputs.conan_profile }} + + - name: Restore cache + if: ${{ !inputs.disable_cache }} + uses: ./.github/actions/restore_cache + id: restore_cache + with: + conan_dir: ${{ env.CONAN_USER_HOME }}/.conan + conan_profile: ${{ steps.conan.outputs.conan_profile }} + ccache_dir: ${{ env.CCACHE_DIR }} + build_type: ${{ inputs.build_type }} + code_coverage: ${{ inputs.code_coverage }} + + - name: Run conan and cmake + uses: ./.github/actions/generate + with: + conan_profile: ${{ steps.conan.outputs.conan_profile }} + conan_cache_hit: ${{ !inputs.disable_cache && steps.restore_cache.outputs.conan_cache_hit }} + build_type: ${{ inputs.build_type }} + code_coverage: ${{ inputs.code_coverage }} + static: ${{ inputs.static }} + sanitizer: ${{ inputs.sanitizer }} + + - name: Build Clio + uses: ./.github/actions/build_clio + with: + target: ${{ inputs.target }} + + - name: Show ccache's statistics + if: ${{ !inputs.disable_cache }} + shell: bash + id: ccache_stats + run: | + ccache -s > /tmp/ccache.stats + miss_rate=$(cat /tmp/ccache.stats | grep 'Misses' | head -n1 | sed 's/.*(\(.*\)%).*/\1/') + echo "miss_rate=${miss_rate}" >> $GITHUB_OUTPUT + cat /tmp/ccache.stats + + - name: Strip unit_tests + if: ${{ inputs.unit_tests && !inputs.code_coverage && inputs.sanitizer == 'false' }} + run: strip build/clio_tests + + - name: Strip integration_tests + if: ${{ inputs.integration_tests && !inputs.code_coverage }} + run: strip build/clio_integration_tests + + - name: Upload clio_server + if: ${{ inputs.clio_server }} + uses: actions/upload-artifact@v4 + with: + name: clio_server_${{ runner.os }}_${{ inputs.build_type }}_${{ steps.conan.outputs.conan_profile }} + path: build/clio_server + + - name: Upload clio_tests + if: ${{ inputs.unit_tests && !inputs.code_coverage }} + uses: actions/upload-artifact@v4 + with: + name: clio_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ steps.conan.outputs.conan_profile }} + path: build/clio_tests + + - name: Upload clio_integration_tests + if: ${{ inputs.integration_tests && !inputs.code_coverage }} + uses: actions/upload-artifact@v4 + with: + name: clio_integration_tests_${{ runner.os }}_${{ inputs.build_type }}_${{ steps.conan.outputs.conan_profile }} + path: build/clio_integration_tests + + - name: Save cache + if: ${{ !inputs.disable_cache && github.ref == 'refs/heads/develop' }} + uses: ./.github/actions/save_cache + with: + conan_dir: ${{ env.CONAN_USER_HOME }}/.conan + conan_hash: ${{ steps.restore_cache.outputs.conan_hash }} + conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }} + ccache_dir: ${{ env.CCACHE_DIR }} + ccache_cache_hit: ${{ steps.restore_cache.outputs.ccache_cache_hit }} + ccache_cache_miss_rate: ${{ steps.ccache_stats.outputs.miss_rate }} + build_type: ${{ inputs.build_type }} + code_coverage: ${{ inputs.code_coverage }} + conan_profile: ${{ steps.conan.outputs.conan_profile }} + + # TODO: This is not a part of build process but it is the easiest way to do it here. + # It will be refactored in https://github.com/XRPLF/clio/issues/1075 + - name: Run code coverage + if: ${{ inputs.code_coverage }} + uses: ./.github/actions/code_coverage + + upload_coverage_report: + if: ${{ inputs.code_coverage }} + name: Codecov + needs: build + uses: ./.github/workflows/upload_coverage_report.yml + secrets: + CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }} diff --git a/.github/workflows/check_libxrpl.yml b/.github/workflows/check_libxrpl.yml index 923d9d7a4..50f0eb46d 100644 --- a/.github/workflows/check_libxrpl.yml +++ b/.github/workflows/check_libxrpl.yml @@ -71,7 +71,7 @@ jobs: name: Create an issue on failure needs: [build, run_tests] if: ${{ always() && contains(needs.*.result, 'failure') }} - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest permissions: contents: write issues: write diff --git a/.github/workflows/check_pr_title.yml b/.github/workflows/check_pr_title.yml index fd0a0fdc7..5e6f86854 100644 --- a/.github/workflows/check_pr_title.yml +++ b/.github/workflows/check_pr_title.yml @@ -6,7 +6,7 @@ on: jobs: check_title: - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest # permissions: # pull-requests: write steps: diff --git a/.github/workflows/clang-tidy.yml b/.github/workflows/clang-tidy.yml index 54fe48dbb..e251aff1d 100644 --- a/.github/workflows/clang-tidy.yml +++ b/.github/workflows/clang-tidy.yml @@ -1,7 +1,7 @@ name: Clang-tidy check on: schedule: - - cron: "0 6 * * 1-5" + - cron: "0 9 * * 1-5" workflow_dispatch: pull_request: branches: [develop] @@ -12,7 +12,7 @@ on: jobs: clang_tidy: - runs-on: [self-hosted, Linux] + runs-on: heavy container: image: rippleci/clio_ci:latest permissions: diff --git a/.github/workflows/clang-tidy_on_fix_merged.yml b/.github/workflows/clang-tidy_on_fix_merged.yml index 712e40474..e78fef591 100644 --- a/.github/workflows/clang-tidy_on_fix_merged.yml +++ b/.github/workflows/clang-tidy_on_fix_merged.yml @@ -6,7 +6,7 @@ on: jobs: restart_clang_tidy: - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest permissions: actions: write diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 6acaa9534..d4b9a80a3 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -18,7 +18,7 @@ jobs: environment: name: github-pages url: ${{ steps.deployment.outputs.page_url }} - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest continue-on-error: true container: image: rippleci/clio_ci:latest diff --git a/.github/workflows/nightly.yml b/.github/workflows/nightly.yml index 080df1760..12d215dca 100644 --- a/.github/workflows/nightly.yml +++ b/.github/workflows/nightly.yml @@ -1,7 +1,7 @@ name: Nightly release on: schedule: - - cron: '0 5 * * 1-5' + - cron: '0 8 * * 1-5' workflow_dispatch: pull_request: paths: @@ -21,68 +21,23 @@ jobs: - os: heavy build_type: Release static: true - container: - image: rippleci/clio_ci:latest + container: '{ "image": "rippleci/clio_ci:latest" }' - os: heavy build_type: Debug static: true - container: - image: rippleci/clio_ci:latest - runs-on: [self-hosted, "${{ matrix.os }}"] - container: ${{ matrix.container }} - - steps: - - name: Clean workdir - if: ${{ runner.os == 'macOS' }} - uses: kuznetsss/workspace-cleanup@1.0 - - - uses: actions/checkout@v4 - with: - fetch-depth: 0 - - - name: Prepare runner - uses: ./.github/actions/prepare_runner - with: - disable_ccache: true - - - name: Setup conan - uses: ./.github/actions/setup_conan - id: conan - with: - conan_profile: gcc - - - name: Run conan and cmake - uses: ./.github/actions/generate - with: - conan_profile: ${{ steps.conan.outputs.conan_profile }} - conan_cache_hit: ${{ steps.restore_cache.outputs.conan_cache_hit }} - build_type: ${{ matrix.build_type }} - static: ${{ matrix.static }} - - - name: Build Clio - uses: ./.github/actions/build_clio - - - name: Strip tests - run: strip build/clio_tests && strip build/clio_integration_tests - - - name: Upload clio_tests - uses: actions/upload-artifact@v4 - with: - name: clio_tests_${{ runner.os }}_${{ matrix.build_type }} - path: build/clio_*tests - - - name: Compress clio_server - shell: bash - run: | - cd build - tar czf ./clio_server_${{ runner.os }}_${{ matrix.build_type }}.tar.gz ./clio_server - - - name: Upload clio_server - uses: actions/upload-artifact@v4 - with: - name: clio_server_${{ runner.os }}_${{ matrix.build_type }} - path: build/clio_server_${{ runner.os }}_${{ matrix.build_type }}.tar.gz - + container: '{ "image": "rippleci/clio_ci:latest" }' + uses: ./.github/workflows/build_impl.yml + with: + runs_on: ${{ matrix.os }} + container: ${{ matrix.container }} + conan_profile: gcc + build_type: ${{ matrix.build_type }} + code_coverage: false + static: ${{ matrix.static }} + unit_tests: true + integration_tests: true + clio_server: true + disable_cache: true run_tests: needs: build @@ -91,14 +46,17 @@ jobs: matrix: include: - os: macos15 + conan_profile: apple_clang_16 build_type: Release integration_tests: false - os: heavy + conan_profile: gcc build_type: Release container: image: rippleci/clio_ci:latest integration_tests: true - os: heavy + conan_profile: gcc build_type: Debug container: image: rippleci/clio_ci:latest @@ -122,13 +80,17 @@ jobs: - uses: actions/download-artifact@v4 with: - name: clio_tests_${{ runner.os }}_${{ matrix.build_type }} + name: clio_tests_${{ runner.os }}_${{ matrix.build_type }}_${{ matrix.conan_profile }} - name: Run clio_tests run: | chmod +x ./clio_tests ./clio_tests + - uses: actions/download-artifact@v4 + with: + name: clio_integration_tests_${{ runner.os }}_${{ matrix.build_type }}_${{ matrix.conan_profile }} + # To be enabled back once docker in mac runner arrives # https://github.com/XRPLF/clio/issues/1400 - name: Run clio_integration_tests @@ -140,7 +102,7 @@ jobs: nightly_release: if: ${{ github.event_name != 'pull_request' }} needs: run_tests - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest env: GH_REPO: ${{ github.repository }} GH_TOKEN: ${{ github.token }} @@ -189,14 +151,14 @@ jobs: tags: | type=raw,value=nightly type=raw,value=${{ github.sha }} - artifact_name: clio_server_Linux_Release + artifact_name: clio_server_Linux_Release_gcc strip_binary: true publish_image: ${{ github.event_name != 'pull_request' }} create_issue_on_failure: needs: [build, run_tests, nightly_release, build_and_publish_docker_image] if: ${{ always() && contains(needs.*.result, 'failure') && github.event_name != 'pull_request' }} - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest permissions: contents: write issues: write diff --git a/.github/workflows/sanitizers.yml b/.github/workflows/sanitizers.yml new file mode 100644 index 000000000..ce0f2bb33 --- /dev/null +++ b/.github/workflows/sanitizers.yml @@ -0,0 +1,106 @@ +name: Run tests with sanitizers +on: + schedule: + - cron: "0 4 * * 1-5" + workflow_dispatch: + pull_request: + paths: + - '.github/workflows/sanitizers.yml' + +jobs: + build: + name: Build clio tests + strategy: + fail-fast: false + matrix: + include: + - sanitizer: tsan + compiler: gcc + - sanitizer: asan + compiler: gcc + # - sanitizer: ubsan # todo: enable when heavy runners are available + # compiler: gcc + uses: ./.github/workflows/build_impl.yml + with: + runs_on: ubuntu-latest # todo: change to heavy + container: '{ "image": "rippleci/clio_ci:latest" }' + disable_cache: true + conan_profile: ${{ matrix.compiler }}.${{ matrix.sanitizer }} + build_type: Release + code_coverage: false + static: false + unit_tests: true + integration_tests: false + clio_server: false + target: clio_tests + sanitizer: ${{ matrix.sanitizer }} + + # consider combining this with the previous matrix instead + run_tests: + needs: build + strategy: + fail-fast: false + matrix: + include: + - sanitizer: tsan + compiler: gcc + - sanitizer: asan + compiler: gcc + # - sanitizer: ubsan # todo: enable when heavy runners are available + # compiler: gcc + runs-on: ubuntu-latest # todo: change to heavy + container: + image: rippleci/clio_ci:latest + permissions: + contents: write + issues: write + + steps: + - uses: actions/checkout@v4 + with: + fetch-depth: 0 + + - uses: actions/download-artifact@v4 + with: + name: clio_tests_${{ runner.os }}_Release_${{ matrix.compiler }}.${{ matrix.sanitizer }} + + - name: Run clio_tests [${{ matrix.compiler }} / ${{ matrix.sanitizer }}] + shell: bash + run: | + chmod +x ./clio_tests + ./.github/scripts/execute-tests-under-sanitizer ./clio_tests + + - name: Check for sanitizer report + shell: bash + id: check_report + run: | + if ls .sanitizer-report/* 1> /dev/null 2>&1; then + echo "found_report=true" >> $GITHUB_OUTPUT + else + echo "found_report=false" >> $GITHUB_OUTPUT + fi + + - name: Upload report + if: ${{ steps.check_report.outputs.found_report == 'true' }} + uses: actions/upload-artifact@v4 + with: + name: ${{ matrix.compiler }}_${{ matrix.sanitizer }}_report + path: .sanitizer-report/* + include-hidden-files: true + + # + # todo: enable when we have fixed all currently existing issues from sanitizers + # + # - name: Create an issue + # if: ${{ steps.check_report.outputs.found_report == 'true' }} + # uses: ./.github/actions/create_issue + # env: + # GH_TOKEN: ${{ github.token }} + # with: + # labels: 'bug' + # title: '[${{ matrix.sanitizer }}/${{ matrix.compiler }}] reported issues' + # body: > + # Clio tests failed one or more sanitizer checks when built with ${{ matrix.compiler }}`. + + # Workflow: ${{ github.server_url }}/${{ github.repository }}/actions/runs/${{ github.run_id }}/ + # Reports are available as artifacts. diff --git a/.github/workflows/upload_coverage_report.yml b/.github/workflows/upload_coverage_report.yml index 349dab085..1f9c46c73 100644 --- a/.github/workflows/upload_coverage_report.yml +++ b/.github/workflows/upload_coverage_report.yml @@ -9,7 +9,7 @@ on: jobs: upload_report: name: Upload report - runs-on: ubuntu-20.04 + runs-on: ubuntu-latest steps: - uses: actions/checkout@v4 with: diff --git a/.gitignore b/.gitignore index 2f3da47ef..f9f86f4ac 100644 --- a/.gitignore +++ b/.gitignore @@ -6,6 +6,7 @@ .vscode .python-version .DS_Store +.sanitizer-report CMakeUserPresets.json config.json src/util/build/Build.cpp diff --git a/CMakeLists.txt b/CMakeLists.txt index 14136cda5..27b1c3d55 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -16,6 +16,8 @@ option(coverage "Build test coverage report" FALSE) option(packaging "Create distribution packages" FALSE) option(lint "Run clang-tidy checks during compilation" FALSE) option(static "Statically linked Clio" FALSE) +option(snapshot "Build snapshot tool" FALSE) + # ========================================================================== # set(san "" CACHE STRING "Add sanitizer instrumentation") set(CMAKE_EXPORT_COMPILE_COMMANDS TRUE) @@ -65,15 +67,21 @@ endif () # Enable selected sanitizer if enabled via `san` if (san) + set(SUPPORTED_SANITIZERS "address" "thread" "memory" "undefined") + list(FIND SUPPORTED_SANITIZERS "${san}" INDEX) + if (INDEX EQUAL -1) + message(FATAL_ERROR "Error: Unsupported sanitizer '${san}'. Supported values are: ${SUPPORTED_SANITIZERS}.") + endif () + target_compile_options( - clio PUBLIC # Sanitizers recommend minimum of -O1 for reasonable performance - $<$:-O1> ${SAN_FLAG} -fno-omit-frame-pointer + clio_options INTERFACE # Sanitizers recommend minimum of -O1 for reasonable performance + $<$:-O1> ${SAN_FLAG} -fno-omit-frame-pointer ) target_compile_definitions( - clio PUBLIC $<$:SANITIZER=ASAN> $<$:SANITIZER=TSAN> - $<$:SANITIZER=MSAN> $<$:SANITIZER=UBSAN> + clio_options INTERFACE $<$:SANITIZER=ASAN> $<$:SANITIZER=TSAN> + $<$:SANITIZER=MSAN> $<$:SANITIZER=UBSAN> ) - target_link_libraries(clio INTERFACE ${SAN_FLAG} ${SAN_LIB}) + target_link_libraries(clio_options INTERFACE ${SAN_FLAG} ${SAN_LIB}) endif () # Generate `docs` target for doxygen documentation if enabled Note: use `make docs` to generate the documentation @@ -85,3 +93,7 @@ include(install/install) if (packaging) include(cmake/packaging.cmake) # This file exists only in build runner endif () + +if (snapshot) + add_subdirectory(tools/snapshot) +endif () diff --git a/cmake/Settings.cmake b/cmake/Settings.cmake index e469b0920..6ed745272 100644 --- a/cmake/Settings.cmake +++ b/cmake/Settings.cmake @@ -39,6 +39,34 @@ if (is_appleclang) list(APPEND COMPILER_FLAGS -Wreorder-init-list) endif () +if (san) + # When building with sanitizers some compilers will actually produce extra warnings/errors. We don't want this yet, at + # least not until we have fixed all runtime issues reported by the sanitizers. Once that is done we can start removing + # some of these and trying to fix it in our codebase. We can never remove all of below because most of them are + # reported from deep inside libraries like boost or libxrpl. + # + # TODO: Address in https://github.com/XRPLF/clio/issues/1885 + list( + APPEND + COMPILER_FLAGS + -Wno-error=tsan # Disables treating TSAN warnings as errors + -Wno-tsan # Disables TSAN warnings (thread-safety analysis) + -Wno-uninitialized # Disables warnings about uninitialized variables (AddressSanitizer, UndefinedBehaviorSanitizer, + # etc.) + -Wno-stringop-overflow # Disables warnings about potential string operation overflows (AddressSanitizer) + -Wno-unsafe-buffer-usage # Disables warnings about unsafe memory operations (AddressSanitizer) + -Wno-frame-larger-than # Disables warnings about stack frame size being too large (AddressSanitizer) + -Wno-unused-function # Disables warnings about unused functions (LeakSanitizer, memory-related issues) + -Wno-unused-but-set-variable # Disables warnings about unused variables (MemorySanitizer) + -Wno-thread-safety-analysis # Disables warnings related to thread safety usage (ThreadSanitizer) + -Wno-thread-safety # Disables warnings related to thread safety usage (ThreadSanitizer) + -Wno-sign-compare # Disables warnings about signed/unsigned comparison (UndefinedBehaviorSanitizer) + -Wno-nonnull # Disables warnings related to null pointer dereferencing (UndefinedBehaviorSanitizer) + -Wno-address # Disables warnings about address-related issues (UndefinedBehaviorSanitizer) + -Wno-array-bounds # Disables array bounds checks (UndefinedBehaviorSanitizer) + ) +endif () + # See https://github.com/cpp-best-practices/cppbestpractices/blob/master/02-Use_the_Tools_Available.md#gcc--clang for # the flags description diff --git a/cmake/deps/libbacktrace.cmake b/cmake/deps/libbacktrace.cmake index d4babd8a1..8d1f4fea3 100644 --- a/cmake/deps/libbacktrace.cmake +++ b/cmake/deps/libbacktrace.cmake @@ -1,3 +1,11 @@ -target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_LINK) -target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_USE_BACKTRACE) -find_package(libbacktrace REQUIRED CONFIG) +if ("${san}" STREQUAL "") + target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_LINK) + target_compile_definitions(clio_options INTERFACE BOOST_STACKTRACE_USE_BACKTRACE) + find_package(libbacktrace REQUIRED CONFIG) +else () + # Some sanitizers (TSAN and ASAN for sure) can't be used with libbacktrace because they have their own backtracing + # capabilities and there are conflicts. In any case, this makes sure Clio code knows that backtrace is not available. + # See relevant conan profiles for sanitizers where we disable stacktrace in Boost explicitly. + target_compile_definitions(clio_options INTERFACE CLIO_WITHOUT_STACKTRACE) + message(STATUS "Sanitizer enabled, disabling stacktrace") +endif () diff --git a/conanfile.py b/conanfile.py index ee1d02598..54b3eea45 100644 --- a/conanfile.py +++ b/conanfile.py @@ -19,6 +19,7 @@ class Clio(ConanFile): 'packaging': [True, False], # create distribution packages 'coverage': [True, False], # build for test coverage report; create custom target `clio_tests-ccov` 'lint': [True, False], # run clang-tidy checks during compilation + 'snapshot': [True, False], # build export/import snapshot tool } requires = [ @@ -28,7 +29,7 @@ class Clio(ConanFile): 'protobuf/3.21.9', 'grpc/1.50.1', 'openssl/1.1.1u', - 'xrpl/2.4.0-b3', + 'xrpl/2.4.0-rc4', 'zlib/1.3.1', 'libbacktrace/cci.20210118' ] @@ -44,6 +45,7 @@ class Clio(ConanFile): 'coverage': False, 'lint': False, 'docs': False, + 'snapshot': False, 'xrpl/*:tests': False, 'xrpl/*:rocksdb': False, @@ -92,6 +94,7 @@ class Clio(ConanFile): tc.variables['docs'] = self.options.docs tc.variables['packaging'] = self.options.packaging tc.variables['benchmark'] = self.options.benchmark + tc.variables['snapshot'] = self.options.snapshot tc.generate() def build(self): diff --git a/docs/config-description.md b/docs/config-description.md new file mode 100644 index 000000000..5ef30b2f6 --- /dev/null +++ b/docs/config-description.md @@ -0,0 +1,452 @@ +# Clio Config Description +This file lists all Clio Configuration definitions in detail. + +## Configuration Details + +### Key: database.type +- **Required**: True +- **Type**: string +- **Default value**: cassandra +- **Constraints**: The value must be one of the following: `cassandra` + - **Description**: Type of database to use. We currently support Cassandra and Scylladb. We default to Scylladb. +### Key: database.cassandra.contact_points +- **Required**: True +- **Type**: string +- **Default value**: localhost +- **Constraints**: None + - **Description**: A list of IP addresses or hostnames of the initial nodes (Cassandra/Scylladb cluster nodes) that the client will connect to when establishing a connection with the database. If you're running locally, it should be 'localhost' or 127.0.0.1 +### Key: database.cassandra.secure_connect_bundle +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: Configuration file that contains the necessary security credentials and connection details for securely connecting to a Cassandra database cluster. +### Key: database.cassandra.port +- **Required**: False +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `1`. The maximum value is `65535 + - **Description**: Port number to connect to the database. +### Key: database.cassandra.keyspace +- **Required**: True +- **Type**: string +- **Default value**: clio +- **Constraints**: None + - **Description**: Keyspace to use for the database. +### Key: database.cassandra.replication_factor +- **Required**: True +- **Type**: int +- **Default value**: 3 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Number of replicated nodes for Scylladb. Visit this link for more details : https://university.scylladb.com/courses/scylla-essentials-overview/lessons/high-availability/topic/fault-tolerance-replication-factor/ +### Key: database.cassandra.table_prefix +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: Prefix for Database table names. +### Key: database.cassandra.max_write_requests_outstanding +- **Required**: True +- **Type**: int +- **Default value**: 10000 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Maximum number of outstanding write requests. Write requests are api calls that write to database +### Key: database.cassandra.max_read_requests_outstanding +- **Required**: True +- **Type**: int +- **Default value**: 100000 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Maximum number of outstanding read requests, which reads from database +### Key: database.cassandra.threads +- **Required**: True +- **Type**: int +- **Default value**: The number of available CPU cores. +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Number of threads that will be used for database operations. +### Key: database.cassandra.core_connections_per_host +- **Required**: True +- **Type**: int +- **Default value**: 1 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Number of core connections per host for Cassandra. +### Key: database.cassandra.queue_size_io +- **Required**: False +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Queue size for I/O operations in Cassandra. +### Key: database.cassandra.write_batch_size +- **Required**: True +- **Type**: int +- **Default value**: 20 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Batch size for write operations in Cassandra. +### Key: database.cassandra.connect_timeout +- **Required**: False +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: The maximum amount of time in seconds the system will wait for a connection to be successfully established with the database. +### Key: database.cassandra.request_timeout +- **Required**: False +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: The maximum amount of time in seconds the system will wait for a request to be fetched from database. +### Key: database.cassandra.username +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: The username used for authenticating with the database. +### Key: database.cassandra.password +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: The password used for authenticating with the database. +### Key: database.cassandra.certfile +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: The path to the SSL/TLS certificate file used to establish a secure connection between the client and the Cassandra database. +### Key: allow_no_etl +- **Required**: True +- **Type**: boolean +- **Default value**: True +- **Constraints**: None + - **Description**: If True, no ETL nodes will run with Clio. +### Key: etl_sources.[].ip +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: The value must be a valid IP address + - **Description**: IP address of the ETL source. +### Key: etl_sources.[].ws_port +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: The minimum value is `1`. The maximum value is `65535 + - **Description**: WebSocket port of the ETL source. +### Key: etl_sources.[].grpc_port +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: The minimum value is `1`. The maximum value is `65535 + - **Description**: gRPC port of the ETL source. +### Key: forwarding.cache_timeout +- **Required**: True +- **Type**: double +- **Default value**: 0 +- **Constraints**: The value must be a positive double number + - **Description**: Timeout duration for the forwarding cache used in Rippled communication. +### Key: forwarding.request_timeout +- **Required**: True +- **Type**: double +- **Default value**: 10 +- **Constraints**: The value must be a positive double number + - **Description**: Timeout duration for the forwarding request used in Rippled communication. +### Key: rpc.cache_timeout +- **Required**: True +- **Type**: double +- **Default value**: 0 +- **Constraints**: The value must be a positive double number + - **Description**: Timeout duration for RPC requests. +### Key: num_markers +- **Required**: False +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `1`. The maximum value is `256` + - **Description**: The number of markers is the number of coroutines to download the initial ledger +### Key: dos_guard.whitelist.[] +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: List of IP addresses to whitelist for DOS protection. +### Key: dos_guard.max_fetches +- **Required**: True +- **Type**: int +- **Default value**: 1000000 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Maximum number of fetch operations allowed by DOS guard. +### Key: dos_guard.max_connections +- **Required**: True +- **Type**: int +- **Default value**: 20 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Maximum number of concurrent connections allowed by DOS guard. +### Key: dos_guard.max_requests +- **Required**: True +- **Type**: int +- **Default value**: 20 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Maximum number of requests allowed by DOS guard. +### Key: dos_guard.sweep_interval +- **Required**: True +- **Type**: double +- **Default value**: 1 +- **Constraints**: The value must be a positive double number + - **Description**: Interval in seconds for DOS guard to sweep/clear its state. +### Key: workers +- **Required**: True +- **Type**: int +- **Default value**: The number of available CPU cores. +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Number of threads to process RPC requests. +### Key: server.ip +- **Required**: True +- **Type**: string +- **Default value**: None +- **Constraints**: The value must be a valid IP address + - **Description**: IP address of the Clio HTTP server. +### Key: server.port +- **Required**: True +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `1`. The maximum value is `65535 + - **Description**: Port number of the Clio HTTP server. +### Key: server.max_queue_size +- **Required**: True +- **Type**: int +- **Default value**: 0 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Maximum size of the server's request queue. Value of 0 is no limit. +### Key: server.local_admin +- **Required**: False +- **Type**: boolean +- **Default value**: None +- **Constraints**: None + - **Description**: Indicates if the server should run with admin privileges. Only one of local_admin or admin_password can be set. +### Key: server.admin_password +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: Password for Clio admin-only APIs. Only one of local_admin or admin_password can be set. +### Key: server.processing_policy +- **Required**: True +- **Type**: string +- **Default value**: parallel +- **Constraints**: The value must be one of the following: `parallel, sequent` + - **Description**: Could be "sequent" or "parallel". For the sequent policy, requests from a single client + connection are processed one by one, with the next request read only after the previous one is processed. For the parallel policy, Clio will accept + all requests and process them in parallel, sending a reply for each request as soon as it is ready. +### Key: server.parallel_requests_limit +- **Required**: False +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Optional parameter, used only if processing_strategy `parallel`. It limits the number of requests for a single client connection that are processed in parallel. If not specified, the limit is infinite. +### Key: server.ws_max_sending_queue_size +- **Required**: True +- **Type**: int +- **Default value**: 1500 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Maximum size of the websocket sending queue. +### Key: prometheus.enabled +- **Required**: True +- **Type**: boolean +- **Default value**: False +- **Constraints**: None + - **Description**: Enable or disable Prometheus metrics. +### Key: prometheus.compress_reply +- **Required**: True +- **Type**: boolean +- **Default value**: False +- **Constraints**: None + - **Description**: Enable or disable compression of Prometheus responses. +### Key: io_threads +- **Required**: True +- **Type**: int +- **Default value**: 2 +- **Constraints**: The minimum value is `1`. The maximum value is `65535` + - **Description**: Number of I/O threads. Value cannot be less than 1 +### Key: subscription_workers +- **Required**: True +- **Type**: int +- **Default value**: 1 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: The number of worker threads or processes that are responsible for managing and processing subscription-based tasks from rippled +### Key: graceful_period +- **Required**: True +- **Type**: double +- **Default value**: 10 +- **Constraints**: The value must be a positive double number + - **Description**: Number of milliseconds server will wait to shutdown gracefully. +### Key: cache.num_diffs +- **Required**: True +- **Type**: int +- **Default value**: 32 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Number of diffs to cache. For more info, consult readme.md in etc +### Key: cache.num_markers +- **Required**: True +- **Type**: int +- **Default value**: 48 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Number of markers to cache. +### Key: cache.num_cursors_from_diff +- **Required**: True +- **Type**: int +- **Default value**: 0 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Num of cursors that are different. +### Key: cache.num_cursors_from_account +- **Required**: True +- **Type**: int +- **Default value**: 0 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Number of cursors from an account. +### Key: cache.page_fetch_size +- **Required**: True +- **Type**: int +- **Default value**: 512 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Page fetch size for cache operations. +### Key: cache.load +- **Required**: True +- **Type**: string +- **Default value**: async +- **Constraints**: The value must be one of the following: `sync, async, none` + - **Description**: Cache loading strategy ('sync' or 'async'). +### Key: log_channels.[].channel +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: The value must be one of the following: `General, WebServer, Backend, RPC, ETL, Subscriptions, Performance, Migration` + - **Description**: Name of the log channel.'RPC', 'ETL', and 'Performance' +### Key: log_channels.[].log_level +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: The value must be one of the following: `trace, debug, info, warning, error, fatal, count` + - **Description**: Log level for the specific log channel.`warning`, `error`, `fatal` +### Key: log_level +- **Required**: True +- **Type**: string +- **Default value**: info +- **Constraints**: The value must be one of the following: `trace, debug, info, warning, error, fatal, count` + - **Description**: General logging level of Clio. This level will be applied to all log channels that do not have an explicitly defined logging level. +### Key: log_format +- **Required**: True +- **Type**: string +- **Default value**: %TimeStamp% (%SourceLocation%) [%ThreadID%] %Channel%:%Severity% %Message% +- **Constraints**: None + - **Description**: Format string for log messages. +### Key: log_to_console +- **Required**: True +- **Type**: boolean +- **Default value**: True +- **Constraints**: None + - **Description**: Enable or disable logging to console. +### Key: log_directory +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: Directory path for log files. +### Key: log_rotation_size +- **Required**: True +- **Type**: int +- **Default value**: 2048 +- **Constraints**: The minimum value is `1`. The maximum value is `4294967295` + - **Description**: Log rotation size in megabytes. When the log file reaches this particular size, a new log file starts. +### Key: log_directory_max_size +- **Required**: True +- **Type**: int +- **Default value**: 51200 +- **Constraints**: The minimum value is `1`. The maximum value is `4294967295` + - **Description**: Maximum size of the log directory in megabytes. +### Key: log_rotation_hour_interval +- **Required**: True +- **Type**: int +- **Default value**: 12 +- **Constraints**: The minimum value is `1`. The maximum value is `4294967295` + - **Description**: Interval in hours for log rotation. If the current log file reaches this value in logging, a new log file starts. +### Key: log_tag_style +- **Required**: True +- **Type**: string +- **Default value**: none +- **Constraints**: The value must be one of the following: `int, uint, null, none, uuid` + - **Description**: Style for log tags. +### Key: extractor_threads +- **Required**: True +- **Type**: int +- **Default value**: 1 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Number of extractor threads. +### Key: read_only +- **Required**: True +- **Type**: boolean +- **Default value**: True +- **Constraints**: None + - **Description**: Indicates if the server should have read-only privileges. +### Key: txn_threshold +- **Required**: True +- **Type**: int +- **Default value**: 0 +- **Constraints**: The minimum value is `0`. The maximum value is `65535` + - **Description**: Transaction threshold value. +### Key: start_sequence +- **Required**: False +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Starting ledger index. +### Key: finish_sequence +- **Required**: False +- **Type**: int +- **Default value**: None +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: Ending ledger index. +### Key: ssl_cert_file +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: Path to the SSL certificate file. +### Key: ssl_key_file +- **Required**: False +- **Type**: string +- **Default value**: None +- **Constraints**: None + - **Description**: Path to the SSL key file. +### Key: api_version.default +- **Required**: True +- **Type**: int +- **Default value**: 1 +- **Constraints**: The minimum value is `1`. The maximum value is `3` + - **Description**: Default API version Clio will run on. +### Key: api_version.min +- **Required**: True +- **Type**: int +- **Default value**: 1 +- **Constraints**: The minimum value is `1`. The maximum value is `3` + - **Description**: Minimum API version. +### Key: api_version.max +- **Required**: True +- **Type**: int +- **Default value**: 3 +- **Constraints**: The minimum value is `1`. The maximum value is `3` + - **Description**: Maximum API version. +### Key: migration.full_scan_threads +- **Required**: True +- **Type**: int +- **Default value**: 2 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: The number of threads used to scan the table. +### Key: migration.full_scan_jobs +- **Required**: True +- **Type**: int +- **Default value**: 4 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: The number of coroutines used to scan the table. +### Key: migration.cursors_per_job +- **Required**: True +- **Type**: int +- **Default value**: 100 +- **Constraints**: The minimum value is `0`. The maximum value is `4294967295` + - **Description**: The number of cursors each coroutine will scan. + diff --git a/docs/examples/infrastructure/README.md b/docs/examples/infrastructure/README.md index bf215c99b..7e44d9aab 100644 --- a/docs/examples/infrastructure/README.md +++ b/docs/examples/infrastructure/README.md @@ -1,5 +1,9 @@ # Example of clio monitoring infrastructure +> [!WARNING] +> This is only an example of Grafana dashboard for Clio. It was created for demonstration purposes only and may contain errors. +> Clio team would not recommend to relate on data from this dashboard or use it for monitoring your Clio instances. + This directory contains an example of docker based infrastructure to collect and visualise metrics from clio. The structure of the directory: diff --git a/docs/examples/infrastructure/grafana/clio_dashboard.json b/docs/examples/infrastructure/grafana/clio_dashboard.json index 810653dbe..315b1a2d3 100644 --- a/docs/examples/infrastructure/grafana/clio_dashboard.json +++ b/docs/examples/infrastructure/grafana/clio_dashboard.json @@ -20,7 +20,6 @@ "graphTooltip": 0, "id": 1, "links": [], - "liveNow": false, "panels": [ { "datasource": { @@ -79,6 +78,7 @@ "graphMode": "area", "justifyMode": "auto", "orientation": "auto", + "percentChangeColorMode": "standard", "reduceOptions": { "calcs": [ "lastNotNull" @@ -90,7 +90,7 @@ "textMode": "auto", "wideLayout": true }, - "pluginVersion": "10.4.0", + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -159,6 +159,7 @@ "graphMode": "area", "justifyMode": "auto", "orientation": "auto", + "percentChangeColorMode": "standard", "reduceOptions": { "calcs": [ "lastNotNull" @@ -170,7 +171,7 @@ "textMode": "auto", "wideLayout": true }, - "pluginVersion": "10.4.0", + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -243,6 +244,7 @@ "graphMode": "area", "justifyMode": "auto", "orientation": "auto", + "percentChangeColorMode": "standard", "reduceOptions": { "calcs": [ "lastNotNull" @@ -254,7 +256,7 @@ "textMode": "auto", "wideLayout": true }, - "pluginVersion": "10.4.0", + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -327,6 +329,7 @@ "graphMode": "area", "justifyMode": "auto", "orientation": "auto", + "percentChangeColorMode": "standard", "reduceOptions": { "calcs": [ "lastNotNull" @@ -338,7 +341,7 @@ "textMode": "auto", "wideLayout": true }, - "pluginVersion": "10.4.0", + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -373,6 +376,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -435,6 +439,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -491,6 +496,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -552,6 +558,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -586,6 +593,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -647,6 +655,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -681,6 +690,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -742,6 +752,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -776,6 +787,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -837,6 +849,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -872,6 +885,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -934,6 +948,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -941,7 +956,7 @@ "uid": "PBFA97CFB590B2093" }, "editorMode": "code", - "expr": "rpc_method_duration_us{job=\"clio\"}", + "expr": "sum by (method) (increase(rpc_method_duration_us[$__interval]))\n / \n sum by (method,) (increase(rpc_method_total_number{status=\"finished\"}[$__interval]))", "instant": false, "legendFormat": "{{method}}", "range": true, @@ -968,6 +983,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -1029,6 +1045,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -1063,6 +1080,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -1124,6 +1142,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -1158,6 +1177,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 10, "gradientMode": "none", @@ -1223,7 +1243,7 @@ "sort": "none" } }, - "pluginVersion": "10.2.0", + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -1296,6 +1316,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -1357,6 +1378,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -1404,6 +1426,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -1465,6 +1488,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -1510,6 +1534,7 @@ "axisLabel": "", "axisPlacement": "auto", "barAlignment": 0, + "barWidthFactor": 0.6, "drawStyle": "line", "fillOpacity": 0, "gradientMode": "none", @@ -1572,6 +1597,7 @@ "sort": "none" } }, + "pluginVersion": "11.4.0", "targets": [ { "datasource": { @@ -1590,8 +1616,9 @@ "type": "timeseries" } ], + "preload": false, "refresh": "5s", - "schemaVersion": 39, + "schemaVersion": 40, "tags": [], "templating": { "list": [] diff --git a/src/app/CliArgs.cpp b/src/app/CliArgs.cpp index 4673c9f90..ce461c83b 100644 --- a/src/app/CliArgs.cpp +++ b/src/app/CliArgs.cpp @@ -21,6 +21,7 @@ #include "migration/MigrationApplication.hpp" #include "util/build/Build.hpp" +#include "util/newconfig/ConfigDescription.hpp" #include #include @@ -29,6 +30,7 @@ #include #include +#include #include #include #include @@ -42,12 +44,13 @@ CliArgs::parse(int argc, char const* argv[]) // clang-format off po::options_description description("Options"); description.add_options() - ("help,h", "print help message and exit") - ("version,v", "print version and exit") - ("conf,c", po::value()->default_value(kDEFAULT_CONFIG_PATH), "configuration file") + ("help,h", "Print help message and exit") + ("version,v", "Print version and exit") + ("conf,c", po::value()->default_value(kDEFAULT_CONFIG_PATH), "Configuration file") ("ng-web-server,w", "Use ng-web-server") - ("migrate", po::value(), "start migration helper") + ("migrate", po::value(), "Start migration helper") ("verify", "Checks the validity of config values") + ("config-description,d", po::value(), "Generate config description markdown file") ; // clang-format on po::positional_options_description positional; @@ -67,6 +70,17 @@ CliArgs::parse(int argc, char const* argv[]) return Action{Action::Exit{EXIT_SUCCESS}}; } + if (parsed.count("config-description") != 0u) { + std::filesystem::path const filePath = parsed["config-description"].as(); + + auto const res = util::config::ClioConfigDescription::generateConfigDescriptionToFile(filePath); + if (res.has_value()) + return Action{Action::Exit{EXIT_SUCCESS}}; + + std::cerr << res.error().error << std::endl; + return Action{Action::Exit{EXIT_FAILURE}}; + } + auto configPath = parsed["conf"].as(); if (parsed.count("migrate") != 0u) { diff --git a/src/app/ClioApplication.cpp b/src/app/ClioApplication.cpp index bc5d0df1a..d64a6b976 100644 --- a/src/app/ClioApplication.cpp +++ b/src/app/ClioApplication.cpp @@ -106,6 +106,8 @@ ClioApplication::run(bool const useNgWebServer) // Interface to the database auto backend = data::makeBackend(config_); + auto const amendmentCenter = std::make_shared(backend); + { auto const migrationInspector = migration::makeMigrationInspector(config_, backend); // Check if any migration is blocking Clio server starting. @@ -117,7 +119,7 @@ ClioApplication::run(bool const useNgWebServer) } // Manages clients subscribed to streams - auto subscriptions = feed::SubscriptionManager::makeSubscriptionManager(config_, backend); + auto subscriptions = feed::SubscriptionManager::makeSubscriptionManager(config_, backend, amendmentCenter); // Tracks which ledgers have been validated by the network auto ledgers = etl::NetworkValidatedLedgers::makeValidatedLedgers(); @@ -133,7 +135,7 @@ ClioApplication::run(bool const useNgWebServer) auto workQueue = rpc::WorkQueue::makeWorkQueue(config_); auto counters = rpc::Counters::makeCounters(workQueue); - auto const amendmentCenter = std::make_shared(backend); + auto const handlerProvider = std::make_shared( config_, backend, subscriptions, balancer, etl, amendmentCenter, counters ); diff --git a/src/data/AmendmentCenter.hpp b/src/data/AmendmentCenter.hpp index 777ba340b..1aac59548 100644 --- a/src/data/AmendmentCenter.hpp +++ b/src/data/AmendmentCenter.hpp @@ -134,6 +134,9 @@ struct Amendments { REGISTER(Credentials); REGISTER(DynamicNFT); REGISTER(PermissionedDomains); + REGISTER(fixInvalidTxFlags); + REGISTER(fixFrozenLPTokenTransfer); + REGISTER(DeepFreeze); // Obsolete but supported by libxrpl REGISTER(CryptoConditionsSuite); diff --git a/src/data/CassandraBackend.hpp b/src/data/CassandraBackend.hpp index 65309a5fd..0fe12d0d2 100644 --- a/src/data/CassandraBackend.hpp +++ b/src/data/CassandraBackend.hpp @@ -36,6 +36,7 @@ #include #include #include +#include #include #include #include @@ -113,13 +114,24 @@ public: try { schema_.prepareStatements(handle_); } catch (std::runtime_error const& ex) { - LOG(log_.error()) << "Failed to prepare the statements: " << ex.what() << "; readOnly: " << readOnly; - throw; + auto const error = fmt::format( + "Failed to prepare the statements: {}; readOnly: {}. ReadOnly should be turned off or another Clio " + "node with write access to DB should be started first.", + ex.what(), + readOnly + ); + LOG(log_.error()) << error; + throw std::runtime_error(error); } LOG(log_.info()) << "Created (revamped) CassandraBackend"; } + /* + * @brief Move constructor is deleted because handle_ is shared by reference with executor + */ + BasicCassandraBackend(BasicCassandraBackend&&) = delete; + TransactionsAndCursor fetchAccountTransactions( ripple::AccountID const& account, diff --git a/src/etl/ETLService.hpp b/src/etl/ETLService.hpp index f0e2a2fc3..79142096a 100644 --- a/src/etl/ETLService.hpp +++ b/src/etl/ETLService.hpp @@ -138,6 +138,11 @@ public: std::shared_ptr ledgers ); + /** + * @brief Move constructor is deleted because ETL service shares its fields by reference + */ + ETLService(ETLService&&) = delete; + /** * @brief A factory function to spawn new ETLService instances. * diff --git a/src/etl/NetworkValidatedLedgers.cpp b/src/etl/NetworkValidatedLedgers.cpp index 9a317c062..cd9fa93b8 100644 --- a/src/etl/NetworkValidatedLedgers.cpp +++ b/src/etl/NetworkValidatedLedgers.cpp @@ -19,6 +19,8 @@ #include "etl/NetworkValidatedLedgers.hpp" +#include + #include #include #include @@ -35,25 +37,27 @@ NetworkValidatedLedgers::makeValidatedLedgers() void NetworkValidatedLedgers::push(uint32_t idx) { - std::lock_guard const lck(m_); - if (!max_ || idx > *max_) - max_ = idx; + std::lock_guard const lck(mtx_); + if (!latest_ || idx > *latest_) + latest_ = idx; + + notificationChannel_(idx); cv_.notify_all(); } std::optional NetworkValidatedLedgers::getMostRecent() { - std::unique_lock lck(m_); - cv_.wait(lck, [this]() { return max_; }); - return max_; + std::unique_lock lck(mtx_); + cv_.wait(lck, [this]() { return latest_; }); + return latest_; } bool NetworkValidatedLedgers::waitUntilValidatedByNetwork(uint32_t sequence, std::optional maxWaitMs) { - std::unique_lock lck(m_); - auto pred = [sequence, this]() -> bool { return (max_ && sequence <= *max_); }; + std::unique_lock lck(mtx_); + auto pred = [sequence, this]() -> bool { return (latest_ && sequence <= *latest_); }; if (maxWaitMs) { cv_.wait_for(lck, std::chrono::milliseconds(*maxWaitMs)); } else { @@ -62,4 +66,10 @@ NetworkValidatedLedgers::waitUntilValidatedByNetwork(uint32_t sequence, std::opt return pred(); } +boost::signals2::scoped_connection +NetworkValidatedLedgers::subscribe(SignalType::slot_type const& subscriber) +{ + return notificationChannel_.connect(subscriber); +} + } // namespace etl diff --git a/src/etl/NetworkValidatedLedgers.hpp b/src/etl/NetworkValidatedLedgers.hpp index c694c3b85..28acc0abf 100644 --- a/src/etl/NetworkValidatedLedgers.hpp +++ b/src/etl/NetworkValidatedLedgers.hpp @@ -21,6 +21,10 @@ #include "etl/NetworkValidatedLedgersInterface.hpp" +#include +#include +#include + #include #include #include @@ -38,12 +42,13 @@ namespace etl { * remains stopped for the rest of its lifetime. */ class NetworkValidatedLedgers : public NetworkValidatedLedgersInterface { - // max sequence validated by network - std::optional max_; + std::optional latest_; // currently known latest sequence validated by network - mutable std::mutex m_; + mutable std::mutex mtx_; std::condition_variable cv_; + SignalType notificationChannel_; + public: /** * @brief A factory function for NetworkValidatedLedgers @@ -81,6 +86,9 @@ public: */ bool waitUntilValidatedByNetwork(uint32_t sequence, std::optional maxWaitMs = {}) final; + + boost::signals2::scoped_connection + subscribe(SignalType::slot_type const& subscriber) override; }; } // namespace etl diff --git a/src/etl/NetworkValidatedLedgersInterface.hpp b/src/etl/NetworkValidatedLedgersInterface.hpp index aaa456295..d2ab9d12b 100644 --- a/src/etl/NetworkValidatedLedgersInterface.hpp +++ b/src/etl/NetworkValidatedLedgersInterface.hpp @@ -20,6 +20,10 @@ /** @file */ #pragma once +#include +#include +#include + #include #include namespace etl { @@ -29,6 +33,8 @@ namespace etl { */ class NetworkValidatedLedgersInterface { public: + using SignalType = boost::signals2::signal; + virtual ~NetworkValidatedLedgersInterface() = default; /** @@ -46,7 +52,7 @@ public: * * @return Sequence of most recently validated ledger. empty optional if the datastructure has been stopped */ - virtual std::optional + [[nodiscard]] virtual std::optional getMostRecent() = 0; /** @@ -59,6 +65,15 @@ public: */ virtual bool waitUntilValidatedByNetwork(uint32_t sequence, std::optional maxWaitMs = {}) = 0; + + /** + * @brief Allows clients to get notified when a new validated ledger becomes known to Clio + * + * @param subscriber The slot to connect + * @return A connection object that automatically disconnects the subscription once destroyed + */ + [[nodiscard]] virtual boost::signals2::scoped_connection + subscribe(SignalType::slot_type const& subscriber) = 0; }; } // namespace etl diff --git a/src/etlng/CMakeLists.txt b/src/etlng/CMakeLists.txt index 57fafcdfc..4b97c43ab 100644 --- a/src/etlng/CMakeLists.txt +++ b/src/etlng/CMakeLists.txt @@ -1,8 +1,14 @@ add_library(clio_etlng) target_sources( - clio_etlng PRIVATE impl/AmendmentBlockHandler.cpp impl/AsyncGrpcCall.cpp impl/Extraction.cpp impl/GrpcSource.cpp - impl/Loading.cpp impl/TaskManager.cpp + clio_etlng + PRIVATE impl/AmendmentBlockHandler.cpp + impl/AsyncGrpcCall.cpp + impl/Extraction.cpp + impl/GrpcSource.cpp + impl/Loading.cpp + impl/Monitor.cpp + impl/TaskManager.cpp ) target_link_libraries(clio_etlng PUBLIC clio_data) diff --git a/src/etlng/MonitorInterface.hpp b/src/etlng/MonitorInterface.hpp new file mode 100644 index 000000000..8e4b745e9 --- /dev/null +++ b/src/etlng/MonitorInterface.hpp @@ -0,0 +1,67 @@ +//------------------------------------------------------------------------------ +/* + This file is part of clio: https://github.com/XRPLF/clio + Copyright (c) 2025, the clio developers. + + Permission to use, copy, modify, and distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ +//============================================================================== + +#pragma once + +#include +#include +#include + +#include +#include + +namespace etlng { + +/** + * @brief An interface for the monitor service + * An implementation of this service is responsible for periodically checking various datasources to detect newly + * ingested ledgers. + */ +class MonitorInterface { +public: + static constexpr auto kDEFAULT_REPEAT_INTERVAL = std::chrono::seconds{1}; + using SignalType = boost::signals2::signal; + + virtual ~MonitorInterface() = default; + + /** + * @brief Allows clients to get notified when a new ledger becomes available in Clio's database + * + * @param subscriber The slot to connect + * @return A connection object that automatically disconnects the subscription once destroyed + */ + [[nodiscard]] virtual boost::signals2::scoped_connection + subscribe(SignalType::slot_type const& subscriber) = 0; + + /** + * @brief Run the monitor service + * + * @param repeatInterval The interval between attempts to check the database for new ledgers + */ + virtual void + run(std::chrono::steady_clock::duration repeatInterval = kDEFAULT_REPEAT_INTERVAL) = 0; + + /** + * @brief Stops the monitor service + */ + virtual void + stop() = 0; +}; + +} // namespace etlng diff --git a/src/etlng/impl/Monitor.cpp b/src/etlng/impl/Monitor.cpp new file mode 100644 index 000000000..8b8bedad2 --- /dev/null +++ b/src/etlng/impl/Monitor.cpp @@ -0,0 +1,99 @@ +//------------------------------------------------------------------------------ +/* + This file is part of clio: https://github.com/XRPLF/clio + Copyright (c) 2025, the clio developers. + + Permission to use, copy, modify, and distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ +//============================================================================== + +#include "etlng/impl/Monitor.hpp" + +#include "data/BackendInterface.hpp" +#include "etl/NetworkValidatedLedgersInterface.hpp" +#include "util/Assert.hpp" +#include "util/async/AnyExecutionContext.hpp" +#include "util/async/AnyOperation.hpp" +#include "util/log/Logger.hpp" + +#include + +#include +#include +#include +#include +#include +#include +#include + +namespace etlng::impl { +Monitor::Monitor( + util::async::AnyExecutionContext ctx, + std::shared_ptr backend, + std::shared_ptr validatedLedgers, + uint32_t startSequence +) + : strand_(ctx.makeStrand()) + , backend_(std::move(backend)) + , validatedLedgers_(std::move(validatedLedgers)) + , nextSequence_(startSequence) +{ +} + +Monitor::~Monitor() +{ + stop(); +} + +void +Monitor::run(std::chrono::steady_clock::duration repeatInterval) +{ + ASSERT(not repeatedTask_.has_value(), "Monitor attempted to run more than once"); + LOG(log_.debug()) << "Starting monitor"; + + repeatedTask_ = strand_.executeRepeatedly(repeatInterval, std::bind_front(&Monitor::doWork, this)); + subscription_ = validatedLedgers_->subscribe(std::bind_front(&Monitor::onNextSequence, this)); +} + +void +Monitor::stop() +{ + if (repeatedTask_.has_value()) + repeatedTask_->abort(); + + repeatedTask_ = std::nullopt; +} + +boost::signals2::scoped_connection +Monitor::subscribe(SignalType::slot_type const& subscriber) +{ + return notificationChannel_.connect(subscriber); +} + +void +Monitor::onNextSequence(uint32_t seq) +{ + LOG(log_.debug()) << "rippled published sequence " << seq; + repeatedTask_->invoke(); // force-invoke immediately +} + +void +Monitor::doWork() +{ + if (auto rng = backend_->hardFetchLedgerRangeNoThrow(); rng) { + while (rng->maxSequence >= nextSequence_) + notificationChannel_(nextSequence_++); + } +} + +} // namespace etlng::impl diff --git a/src/etlng/impl/Monitor.hpp b/src/etlng/impl/Monitor.hpp new file mode 100644 index 000000000..9b5112cc3 --- /dev/null +++ b/src/etlng/impl/Monitor.hpp @@ -0,0 +1,80 @@ +//------------------------------------------------------------------------------ +/* + This file is part of clio: https://github.com/XRPLF/clio + Copyright (c) 2025, the clio developers. + + Permission to use, copy, modify, and distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ +//============================================================================== + +#pragma once + +#include "data/BackendInterface.hpp" +#include "etl/NetworkValidatedLedgersInterface.hpp" +#include "etlng/MonitorInterface.hpp" +#include "util/async/AnyExecutionContext.hpp" +#include "util/async/AnyOperation.hpp" +#include "util/async/AnyStrand.hpp" +#include "util/log/Logger.hpp" + +#include +#include + +#include +#include +#include +#include +#include + +namespace etlng::impl { + +class Monitor : public MonitorInterface { + util::async::AnyStrand strand_; + std::shared_ptr backend_; + std::shared_ptr validatedLedgers_; + + uint32_t nextSequence_; + std::optional> repeatedTask_; + std::optional subscription_; // network validated ledgers subscription + + SignalType notificationChannel_; + + util::Logger log_{"ETL"}; + +public: + Monitor( + util::async::AnyExecutionContext ctx, + std::shared_ptr backend, + std::shared_ptr validatedLedgers, + uint32_t startSequence + ); + ~Monitor() override; + + void + run(std::chrono::steady_clock::duration repeatInterval) override; + + void + stop() override; + + boost::signals2::scoped_connection + subscribe(SignalType::slot_type const& subscriber) override; + +private: + void + onNextSequence(uint32_t seq); + + void + doWork(); +}; + +} // namespace etlng::impl diff --git a/src/feed/SubscriptionManager.cpp b/src/feed/SubscriptionManager.cpp index 8c169be24..7db63718a 100644 --- a/src/feed/SubscriptionManager.cpp +++ b/src/feed/SubscriptionManager.cpp @@ -191,7 +191,7 @@ SubscriptionManager::unsubBook(ripple::Book const& book, SubscriberSharedPtr con void SubscriptionManager::pubTransaction(data::TransactionAndMetadata const& txMeta, ripple::LedgerHeader const& lgrInfo) { - transactionFeed_.pub(txMeta, lgrInfo, backend_); + transactionFeed_.pub(txMeta, lgrInfo, backend_, amendmentCenter_); } boost::json::object diff --git a/src/feed/SubscriptionManager.hpp b/src/feed/SubscriptionManager.hpp index c51ea5270..09c004a5b 100644 --- a/src/feed/SubscriptionManager.hpp +++ b/src/feed/SubscriptionManager.hpp @@ -19,6 +19,7 @@ #pragma once +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "data/Types.hpp" #include "feed/SubscriptionManagerInterface.hpp" @@ -60,6 +61,7 @@ namespace feed { */ class SubscriptionManager : public SubscriptionManagerInterface { std::shared_ptr backend_; + std::shared_ptr amendmentCenter_; util::async::AnyExecutionContext ctx_; impl::ForwardFeed manifestFeed_; impl::ForwardFeed validationsFeed_; @@ -74,12 +76,14 @@ public: * * @param config The configuration to use * @param backend The backend to use + * @param amendmentCenter The amendmentCenter to use * @return A shared pointer to a new instance of SubscriptionManager */ static std::shared_ptr makeSubscriptionManager( util::config::ClioConfigDefinition const& config, - std::shared_ptr const& backend + std::shared_ptr const& backend, + std::shared_ptr const& amendmentCenter ) { auto const workersNum = config.get("subscription_workers"); @@ -87,7 +91,9 @@ public: util::Logger const logger{"Subscriptions"}; LOG(logger.info()) << "Starting subscription manager with " << workersNum << " workers"; - return std::make_shared(util::async::PoolExecutionContext(workersNum), backend); + return std::make_shared( + util::async::PoolExecutionContext(workersNum), backend, amendmentCenter + ); } /** @@ -95,12 +101,15 @@ public: * * @param executor The executor to use to publish the feeds * @param backend The backend to use + * @param amendmentCenter The amendmentCenter to use */ SubscriptionManager( util::async::AnyExecutionContext&& executor, - std::shared_ptr const& backend + std::shared_ptr const& backend, + std::shared_ptr const& amendmentCenter ) : backend_(backend) + , amendmentCenter_(amendmentCenter) , ctx_(std::move(executor)) , manifestFeed_(ctx_, "manifest") , validationsFeed_(ctx_, "validations") diff --git a/src/feed/impl/TransactionFeed.cpp b/src/feed/impl/TransactionFeed.cpp index 7ff0ba852..ac65cca6f 100644 --- a/src/feed/impl/TransactionFeed.cpp +++ b/src/feed/impl/TransactionFeed.cpp @@ -19,6 +19,7 @@ #include "feed/impl/TransactionFeed.hpp" +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "data/Types.hpp" #include "feed/Types.hpp" @@ -174,7 +175,8 @@ void TransactionFeed::pub( data::TransactionAndMetadata const& txMeta, ripple::LedgerHeader const& lgrInfo, - std::shared_ptr const& backend + std::shared_ptr const& backend, + std::shared_ptr const& amendmentCenter ) { auto [tx, meta] = rpc::deserializeTxPlusMeta(txMeta, lgrInfo.seq); @@ -187,7 +189,7 @@ TransactionFeed::pub( if (account != amount.issue().account) { auto fetchFundsSynchronous = [&]() { data::synchronous([&](boost::asio::yield_context yield) { - ownerFunds = rpc::accountFunds(*backend, lgrInfo.seq, amount, account, yield); + ownerFunds = rpc::accountFunds(*backend, *amendmentCenter, lgrInfo.seq, amount, account, yield); }); }; data::retryOnTimeout(fetchFundsSynchronous); diff --git a/src/feed/impl/TransactionFeed.hpp b/src/feed/impl/TransactionFeed.hpp index 787fd7614..4500575d4 100644 --- a/src/feed/impl/TransactionFeed.hpp +++ b/src/feed/impl/TransactionFeed.hpp @@ -19,6 +19,7 @@ #pragma once +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "data/Types.hpp" #include "feed/Types.hpp" @@ -94,6 +95,11 @@ public: { } + /** + * @brief Move constructor is deleted because TransactionSlot takes TransactionFeed by reference + */ + TransactionFeed(TransactionFeed&&) = delete; + /** * @brief Subscribe to the transaction feed. * @param subscriber @@ -180,7 +186,8 @@ public: void pub(data::TransactionAndMetadata const& txMeta, ripple::LedgerHeader const& lgrInfo, - std::shared_ptr const& backend); + std::shared_ptr const& backend, + std::shared_ptr const& amendmentCenter); /** * @brief Get the number of subscribers of the transaction feed. diff --git a/src/main/Main.cpp b/src/main/Main.cpp index 4dd39e712..6d1ff8e11 100644 --- a/src/main/Main.cpp +++ b/src/main/Main.cpp @@ -52,7 +52,10 @@ try { if (not app::parseConfig(run.configPath)) return EXIT_FAILURE; - util::LogService::init(gClioConfig); + if (auto const initSuccess = util::LogService::init(gClioConfig); not initSuccess) { + std::cerr << initSuccess.error() << std::endl; + return EXIT_FAILURE; + } app::ClioApplication clio{gClioConfig}; return clio.run(run.useNgWebServer); }, @@ -60,7 +63,10 @@ try { if (not app::parseConfig(migrate.configPath)) return EXIT_FAILURE; - util::LogService::init(gClioConfig); + if (auto const initSuccess = util::LogService::init(gClioConfig); not initSuccess) { + std::cerr << initSuccess.error() << std::endl; + return EXIT_FAILURE; + } app::MigratorApplication migrator{gClioConfig, migrate.subCmd}; return migrator.run(); } diff --git a/src/rpc/AMMHelpers.cpp b/src/rpc/AMMHelpers.cpp index 2635530db..5cb5cf71e 100644 --- a/src/rpc/AMMHelpers.cpp +++ b/src/rpc/AMMHelpers.cpp @@ -19,6 +19,7 @@ #include "rpc/AMMHelpers.hpp" +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "rpc/RPCHelpers.hpp" @@ -38,6 +39,7 @@ namespace rpc { std::pair getAmmPoolHolds( BackendInterface const& backend, + data::AmendmentCenterInterface const& amendmentCenter, std::uint32_t sequence, ripple::AccountID const& ammAccountID, ripple::Issue const& issue1, @@ -46,10 +48,12 @@ getAmmPoolHolds( boost::asio::yield_context yield ) { - auto const assetInBalance = - accountHolds(backend, sequence, ammAccountID, issue1.currency, issue1.account, freezeHandling, yield); - auto const assetOutBalance = - accountHolds(backend, sequence, ammAccountID, issue2.currency, issue2.account, freezeHandling, yield); + auto const assetInBalance = accountHolds( + backend, amendmentCenter, sequence, ammAccountID, issue1.currency, issue1.account, freezeHandling, yield + ); + auto const assetOutBalance = accountHolds( + backend, amendmentCenter, sequence, ammAccountID, issue2.currency, issue2.account, freezeHandling, yield + ); return std::make_pair(assetInBalance, assetOutBalance); } @@ -65,7 +69,9 @@ getAmmLpHolds( ) { auto const lptCurrency = ammLPTCurrency(cur1, cur2); - return accountHolds(backend, sequence, lpAccount, lptCurrency, ammAccount, true, yield); + + // not using accountHolds because we don't need to check if the associated tokens of the LP are frozen + return ammAccountHolds(backend, sequence, lpAccount, lptCurrency, ammAccount, true, yield); } ripple::STAmount diff --git a/src/rpc/AMMHelpers.hpp b/src/rpc/AMMHelpers.hpp index 4af61dc87..286d37645 100644 --- a/src/rpc/AMMHelpers.hpp +++ b/src/rpc/AMMHelpers.hpp @@ -19,6 +19,7 @@ #pragma once +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include @@ -37,6 +38,7 @@ namespace rpc { * @brief getAmmPoolHolds returns the balances of the amm asset pair * * @param backend The backend to use + * @param amendmentCenter The amendmentCenter to use * @param sequence The sequence number to use * @param ammAccountID The amm account * @param issue1 The first issue @@ -48,6 +50,7 @@ namespace rpc { std::pair getAmmPoolHolds( BackendInterface const& backend, + data::AmendmentCenterInterface const& amendmentCenter, std::uint32_t sequence, ripple::AccountID const& ammAccountID, ripple::Issue const& issue1, diff --git a/src/rpc/RPCHelpers.cpp b/src/rpc/RPCHelpers.cpp index 2294ecec4..c67a8269b 100644 --- a/src/rpc/RPCHelpers.cpp +++ b/src/rpc/RPCHelpers.cpp @@ -19,12 +19,15 @@ #include "rpc/RPCHelpers.hpp" +#include "data/AmendmentCenter.hpp" +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "data/Types.hpp" #include "rpc/Errors.hpp" #include "rpc/JS.hpp" #include "rpc/common/Types.hpp" #include "util/AccountUtils.hpp" +#include "util/Assert.hpp" #include "util/Profiler.hpp" #include "util/log/Logger.hpp" #include "web/Context.hpp" @@ -899,6 +902,26 @@ isGlobalFrozen( return sle.isFlag(ripple::lsfGlobalFreeze); } +bool +fetchAndCheckAnyFlagsExists( + BackendInterface const& backend, + std::uint32_t sequence, + ripple::Keylet const& keylet, + std::vector const& flags, + boost::asio::yield_context yield +) +{ + auto const blob = backend.fetchLedgerObject(keylet.key, sequence, yield); + + if (!blob) + return false; + + ripple::SerialIter it{blob->data(), blob->size()}; + ripple::SLE const sle{it, keylet.key}; + + return std::ranges::any_of(flags, [sle](std::uint32_t flag) { return sle.isFlag(flag); }); +} + bool isFrozen( BackendInterface const& backend, @@ -912,35 +935,57 @@ isFrozen( if (ripple::isXRP(currency)) return false; - auto key = ripple::keylet::account(issuer).key; - auto blob = backend.fetchLedgerObject(key, sequence, yield); - - if (!blob) - return false; - - ripple::SerialIter it{blob->data(), blob->size()}; - ripple::SLE const sle{it, key}; - - if (sle.isFlag(ripple::lsfGlobalFreeze)) + if (fetchAndCheckAnyFlagsExists( + backend, sequence, ripple::keylet::account(issuer), {ripple::lsfGlobalFreeze}, yield + )) return true; - if (issuer != account) { - key = ripple::keylet::line(account, issuer, currency).key; - blob = backend.fetchLedgerObject(key, sequence, yield); + auto const trustLineKeylet = ripple::keylet::line(account, issuer, currency); + return issuer != account && + fetchAndCheckAnyFlagsExists( + backend, + sequence, + trustLineKeylet, + {(issuer > account) ? ripple::lsfHighFreeze : ripple::lsfLowFreeze}, + yield + ); +} - if (!blob) - return false; +bool +isDeepFrozen( + BackendInterface const& backend, + std::uint32_t sequence, + ripple::AccountID const& account, + ripple::Currency const& currency, + ripple::AccountID const& issuer, + boost::asio::yield_context yield +) +{ + if (ripple::isXRP(currency)) + return false; - ripple::SerialIter issuerIt{blob->data(), blob->size()}; - ripple::SLE const issuerLine{issuerIt, key}; + if (issuer == account) + return false; - auto frozen = (issuer > account) ? ripple::lsfHighFreeze : ripple::lsfLowFreeze; + auto const trustLineKeylet = ripple::keylet::line(account, issuer, currency); - if (issuerLine.isFlag(frozen)) - return true; - } + return fetchAndCheckAnyFlagsExists( + backend, sequence, trustLineKeylet, {ripple::lsfHighDeepFreeze, ripple::lsfLowDeepFreeze}, yield + ); +} - return false; +bool +isLPTokenFrozen( + BackendInterface const& backend, + std::uint32_t sequence, + ripple::AccountID const& account, + ripple::Issue const& asset, + ripple::Issue const& asset2, + boost::asio::yield_context yield +) +{ + return isFrozen(backend, sequence, account, asset.currency, asset.account, yield) || + isFrozen(backend, sequence, account, asset2.currency, asset2.account, yield); } ripple::XRPAmount @@ -981,6 +1026,7 @@ xrpLiquid( ripple::STAmount accountFunds( BackendInterface const& backend, + data::AmendmentCenterInterface const& amendmentCenter, std::uint32_t const sequence, ripple::STAmount const& amount, ripple::AccountID const& id, @@ -991,12 +1037,58 @@ accountFunds( return amount; } - return accountHolds(backend, sequence, id, amount.getCurrency(), amount.getIssuer(), true, yield); + return accountHolds(backend, amendmentCenter, sequence, id, amount.getCurrency(), amount.getIssuer(), true, yield); +} + +ripple::STAmount +ammAccountHolds( + BackendInterface const& backend, + std::uint32_t sequence, + ripple::AccountID const& account, + ripple::Currency const& currency, + ripple::AccountID const& issuer, + bool const zeroIfFrozen, + boost::asio::yield_context yield +) +{ + ripple::STAmount amount; + ASSERT(!ripple::isXRP(currency), "LPToken currency can never be XRP"); + if (ripple::isXRP(currency)) + return {xrpLiquid(backend, sequence, account, yield)}; + + auto const key = ripple::keylet::line(account, issuer, currency).key; + auto const blob = backend.fetchLedgerObject(key, sequence, yield); + + if (!blob) { + amount.setIssue(ripple::Issue(currency, issuer)); + amount.clear(); + return amount; + } + + ripple::SerialIter it{blob->data(), blob->size()}; + ripple::SLE const sle{it, key}; + + if (zeroIfFrozen && + (isFrozen(backend, sequence, account, currency, issuer, yield) || + isDeepFrozen(backend, sequence, account, currency, issuer, yield))) { + amount.setIssue(ripple::Issue(currency, issuer)); + amount.clear(); + } else { + amount = sle.getFieldAmount(ripple::sfBalance); + if (account > issuer) { + // Put balance in account terms. + amount.negate(); + } + amount.setIssuer(issuer); + } + + return amount; } ripple::STAmount accountHolds( BackendInterface const& backend, + data::AmendmentCenterInterface const& amendmentCenter, std::uint32_t sequence, ripple::AccountID const& account, ripple::Currency const& currency, @@ -1018,19 +1110,61 @@ accountHolds( return amount; } - ripple::SerialIter it{blob->data(), blob->size()}; - ripple::SLE const sle{it, key}; + auto const allowBalance = [&]() { + if (!zeroIfFrozen) + return true; + + if (isFrozen(backend, sequence, account, currency, issuer, yield)) + return false; + + if (amendmentCenter.isEnabled(yield, data::Amendments::fixFrozenLPTokenTransfer, sequence)) { + auto const issuerBlob = backend.fetchLedgerObject(ripple::keylet::account(issuer).key, sequence, yield); + + if (!issuerBlob) + return false; + + ripple::SLE const issuerSle{ + ripple::SerialIter{issuerBlob->data(), issuerBlob->size()}, ripple::keylet::account(issuer).key + }; + + // if the issuer is an amm account, then currency is lptoken, so we will need to check if the + // assets in the pool are frozen as well + if (issuerSle.isFieldPresent(ripple::sfAMMID)) { + auto const ammKeylet = ripple::keylet::amm(issuerSle[ripple::sfAMMID]); + auto const ammBlob = backend.fetchLedgerObject(ammKeylet.key, sequence, yield); + + if (!ammBlob) + return false; + + ripple::SLE const ammSle{ripple::SerialIter{ammBlob->data(), ammBlob->size()}, ammKeylet.key}; + + return !isLPTokenFrozen( + backend, + sequence, + account, + ammSle[ripple::sfAsset].get(), + ammSle[ripple::sfAsset2].get(), + yield + ); + } + } + + return true; + }(); + + if (allowBalance) { + ripple::SerialIter it{blob->data(), blob->size()}; + ripple::SLE const sle{it, key}; - if (zeroIfFrozen && isFrozen(backend, sequence, account, currency, issuer, yield)) { - amount.setIssue(ripple::Issue(currency, issuer)); - amount.clear(); - } else { amount = sle.getFieldAmount(ripple::sfBalance); if (account > issuer) { // Put balance in account terms. amount.negate(); } amount.setIssuer(issuer); + } else { + amount.setIssue(ripple::Issue(currency, issuer)); + amount.clear(); } return amount; @@ -1064,6 +1198,7 @@ postProcessOrderBook( ripple::Book const& book, ripple::AccountID const& takerID, data::BackendInterface const& backend, + data::AmendmentCenterInterface const& amendmentCenter, std::uint32_t const ledgerSequence, boost::asio::yield_context yield ) @@ -1106,7 +1241,14 @@ postProcessOrderBook( firstOwnerOffer = false; } else { saOwnerFunds = accountHolds( - backend, ledgerSequence, uOfferOwnerID, book.out.currency, book.out.account, true, yield + backend, + amendmentCenter, + ledgerSequence, + uOfferOwnerID, + book.out.currency, + book.out.account, + true, + yield ); if (saOwnerFunds < beast::zero) diff --git a/src/rpc/RPCHelpers.hpp b/src/rpc/RPCHelpers.hpp index 0a9202d4d..040a211a0 100644 --- a/src/rpc/RPCHelpers.hpp +++ b/src/rpc/RPCHelpers.hpp @@ -24,6 +24,7 @@ * This file contains a variety of utility functions used when executing the handlers. */ +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "data/Types.hpp" #include "rpc/Errors.hpp" @@ -427,10 +428,75 @@ isFrozen( boost::asio::yield_context yield ); +/** + * @brief Fetches a ledger object and checks if any of the specified flag is set on the account. + * + * @param backend The backend to use + * @param sequence The sequence + * @param keylet The keylet representing the object + * @param flags The flags to check on the fetched `SLE`. + * @param yield The coroutine context + * @return true if any of the flag in flags are set for this account; false otherwise + */ +bool +fetchAndCheckAnyFlagsExists( + BackendInterface const& backend, + std::uint32_t sequence, + ripple::Keylet const& keylet, + std::vector const& flags, + boost::asio::yield_context yield +); + +/** + * @brief Whether the trustline is deep frozen. + * + * For deep freeze, (unlike regular freeze) we do not care which account has the high/low deep freeze flag. + * We only care about if the trustline is deep frozen or not. + * + * @param backend The backend to use + * @param sequence The sequence + * @param account The account + * @param currency The currency + * @param issuer The issuer + * @param yield The coroutine context + * @return true if the account is deep frozen; false otherwise + */ +bool +isDeepFrozen( + BackendInterface const& backend, + std::uint32_t sequence, + ripple::AccountID const& account, + ripple::Currency const& currency, + ripple::AccountID const& issuer, + boost::asio::yield_context yield +); + +/** + * @brief Whether the account that owns a LPToken is frozen for the assets in the pool + * + * @param backend The backend to use + * @param sequence The sequence + * @param account The account + * @param asset The first asset in the pool + * @param asset2 The second asset in the pool + * @param yield The coroutine context + * @return true if account is frozen for one of the assets + */ +bool +isLPTokenFrozen( + BackendInterface const& backend, + std::uint32_t sequence, + ripple::AccountID const& account, + ripple::Issue const& asset, + ripple::Issue const& asset2, + boost::asio::yield_context yield +); + /** * @brief Get the account funds * * @param backend The backend to use + * @param amendmentCenter The amendmentCenter to use * @param sequence The sequence * @param amount The amount * @param id The account ID @@ -440,6 +506,7 @@ isFrozen( ripple::STAmount accountFunds( BackendInterface const& backend, + data::AmendmentCenterInterface const& amendmentCenter, std::uint32_t sequence, ripple::STAmount const& amount, ripple::AccountID const& id, @@ -450,6 +517,7 @@ accountFunds( * @brief Get the amount that an account holds * * @param backend The backend to use + * @param amendmentCenter The amendmentCenter to use * @param sequence The sequence * @param account The account * @param currency The currency @@ -461,6 +529,7 @@ accountFunds( ripple::STAmount accountHolds( BackendInterface const& backend, + data::AmendmentCenterInterface const& amendmentCenter, std::uint32_t sequence, ripple::AccountID const& account, ripple::Currency const& currency, @@ -469,6 +538,29 @@ accountHolds( boost::asio::yield_context yield ); +/** + * @brief Get the amount that an LPToken owner holds + * + * @param backend The backend to use + * @param sequence The sequence + * @param account The account + * @param currency The currency + * @param issuer The issuer + * @param zeroIfFrozen Whether to return zero if frozen + * @param yield The coroutine context + * @return The amount account holds + */ +ripple::STAmount +ammAccountHolds( + BackendInterface const& backend, + std::uint32_t sequence, + ripple::AccountID const& account, + ripple::Currency const& currency, + ripple::AccountID const& issuer, + bool const zeroIfFrozen, + boost::asio::yield_context yield +); + /** * @brief Get the transfer rate * @@ -510,6 +602,7 @@ xrpLiquid( * @param book The book * @param takerID The taker ID * @param backend The backend to use + * @param amendmentCenter The amendmentCenter to use * @param ledgerSequence The ledger sequence * @param yield The coroutine context * @return The post processed order book @@ -520,6 +613,7 @@ postProcessOrderBook( ripple::Book const& book, ripple::AccountID const& takerID, data::BackendInterface const& backend, + data::AmendmentCenterInterface const& amendmentCenter, std::uint32_t ledgerSequence, boost::asio::yield_context yield ); diff --git a/src/rpc/common/impl/ForwardingProxy.hpp b/src/rpc/common/impl/ForwardingProxy.hpp index e4e2b32ea..c60773df1 100644 --- a/src/rpc/common/impl/ForwardingProxy.hpp +++ b/src/rpc/common/impl/ForwardingProxy.hpp @@ -116,6 +116,7 @@ public: "manifest", "channel_authorize", "channel_verify", + "simulate", }; return kPROXIED_COMMANDS.contains(method); diff --git a/src/rpc/common/impl/HandlerProvider.cpp b/src/rpc/common/impl/HandlerProvider.cpp index 90ec3f7b3..cf4485cc2 100644 --- a/src/rpc/common/impl/HandlerProvider.cpp +++ b/src/rpc/common/impl/HandlerProvider.cpp @@ -86,14 +86,14 @@ ProductionHandlerProvider::ProductionHandlerProvider( {"account_objects", {.handler = AccountObjectsHandler{backend}}}, {"account_offers", {.handler = AccountOffersHandler{backend}}}, {"account_tx", {.handler = AccountTxHandler{backend}}}, - {"amm_info", {.handler = AMMInfoHandler{backend}}}, + {"amm_info", {.handler = AMMInfoHandler{backend, amendmentCenter}}}, {"book_changes", {.handler = BookChangesHandler{backend}}}, - {"book_offers", {.handler = BookOffersHandler{backend}}}, + {"book_offers", {.handler = BookOffersHandler{backend, amendmentCenter}}}, {"deposit_authorized", {.handler = DepositAuthorizedHandler{backend}}}, {"feature", {.handler = FeatureHandler{backend, amendmentCenter}}}, {"gateway_balances", {.handler = GatewayBalancesHandler{backend}}}, {"get_aggregate_price", {.handler = GetAggregatePriceHandler{backend}}}, - {"ledger", {.handler = LedgerHandler{backend}}}, + {"ledger", {.handler = LedgerHandler{backend, amendmentCenter}}}, {"ledger_data", {.handler = LedgerDataHandler{backend}}}, {"ledger_entry", {.handler = LedgerEntryHandler{backend}}}, {"ledger_index", {.handler = LedgerIndexHandler{backend}, .isClioOnly = true}}, // clio only @@ -110,7 +110,7 @@ ProductionHandlerProvider::ProductionHandlerProvider( {"server_info", {.handler = ServerInfoHandler{backend, subscriptionManager, balancer, etl, counters}}}, {"transaction_entry", {.handler = TransactionEntryHandler{backend}}}, {"tx", {.handler = TxHandler{backend, etl}}}, - {"subscribe", {.handler = SubscribeHandler{backend, subscriptionManager}}}, + {"subscribe", {.handler = SubscribeHandler{backend, amendmentCenter, subscriptionManager}}}, {"unsubscribe", {.handler = UnsubscribeHandler{subscriptionManager}}}, {"version", {.handler = VersionHandler{config}}}, } diff --git a/src/rpc/handlers/AMMInfo.cpp b/src/rpc/handlers/AMMInfo.cpp index 93ed49249..e73c76b22 100644 --- a/src/rpc/handlers/AMMInfo.cpp +++ b/src/rpc/handlers/AMMInfo.cpp @@ -149,8 +149,9 @@ AMMInfoHandler::process(AMMInfoHandler::Input input, Context const& ctx) const issue2 = amm[sfAsset2].get(); } - auto const [asset1Balance, asset2Balance] = - getAmmPoolHolds(*sharedPtrBackend_, lgrInfo.seq, ammAccountID, issue1, issue2, false, ctx.yield); + auto const [asset1Balance, asset2Balance] = getAmmPoolHolds( + *sharedPtrBackend_, *amendmentCenter_, lgrInfo.seq, ammAccountID, issue1, issue2, false, ctx.yield + ); auto const lptAMMBalance = input.accountID ? getAmmLpHolds(*sharedPtrBackend_, lgrInfo.seq, amm, *input.accountID, ctx.yield) : amm[sfLPTokenBalance]; diff --git a/src/rpc/handlers/AMMInfo.hpp b/src/rpc/handlers/AMMInfo.hpp index 06b1236b8..25cee74d8 100644 --- a/src/rpc/handlers/AMMInfo.hpp +++ b/src/rpc/handlers/AMMInfo.hpp @@ -19,6 +19,7 @@ #pragma once +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "rpc/common/Specs.hpp" @@ -42,6 +43,7 @@ namespace rpc { */ class AMMInfoHandler { std::shared_ptr sharedPtrBackend_; + std::shared_ptr amendmentCenter_; public: /** @@ -82,8 +84,13 @@ public: * @brief Construct a new AMMInfoHandler object * * @param sharedPtrBackend The backend to use + * @param amendmentCenter The amendmentCenter to use */ - AMMInfoHandler(std::shared_ptr const& sharedPtrBackend) : sharedPtrBackend_(sharedPtrBackend) + AMMInfoHandler( + std::shared_ptr const& sharedPtrBackend, + std::shared_ptr const& amendmentCenter + ) + : sharedPtrBackend_(sharedPtrBackend), amendmentCenter_{amendmentCenter} { } diff --git a/src/rpc/handlers/AccountLines.cpp b/src/rpc/handlers/AccountLines.cpp index 85c6c8036..a5ab872d4 100644 --- a/src/rpc/handlers/AccountLines.cpp +++ b/src/rpc/handlers/AccountLines.cpp @@ -86,6 +86,8 @@ AccountLinesHandler::addLine( bool const lineNoRipplePeer = (flags & (not viewLowest ? ripple::lsfLowNoRipple : ripple::lsfHighNoRipple)) != 0u; bool const lineFreeze = (flags & (viewLowest ? ripple::lsfLowFreeze : ripple::lsfHighFreeze)) != 0u; bool const lineFreezePeer = (flags & (not viewLowest ? ripple::lsfLowFreeze : ripple::lsfHighFreeze)) != 0u; + bool const lineDeepFreeze = (flags & (viewLowest ? ripple::lsfLowDeepFreeze : ripple::lsfHighFreeze)) != 0u; + bool const lineDeepFreezePeer = (flags & (not viewLowest ? ripple::lsfLowDeepFreeze : ripple::lsfHighFreeze)) != 0u; ripple::STAmount const& saBalance = balance; ripple::STAmount const& saLimit = lineLimit; @@ -112,6 +114,12 @@ AccountLinesHandler::addLine( if (lineFreezePeer) line.freezePeer = true; + if (lineDeepFreeze) + line.deepFreeze = true; + + if (lineDeepFreezePeer) + line.deepFreezePeer = true; + line.noRipple = lineNoRipple; line.noRipplePeer = lineNoRipplePeer; lines.push_back(line); @@ -264,6 +272,12 @@ tag_invoke( if (line.freezePeer) obj[JS(freeze_peer)] = *(line.freezePeer); + if (line.deepFreeze) + obj[JS(deep_freeze)] = *(line.deepFreeze); + + if (line.deepFreezePeer) + obj[JS(deep_freeze_peer)] = *(line.deepFreezePeer); + jv = std::move(obj); } diff --git a/src/rpc/handlers/AccountLines.hpp b/src/rpc/handlers/AccountLines.hpp index 266624297..3388f3166 100644 --- a/src/rpc/handlers/AccountLines.hpp +++ b/src/rpc/handlers/AccountLines.hpp @@ -76,6 +76,8 @@ public: std::optional peerAuthorized; std::optional freeze; std::optional freezePeer; + std::optional deepFreeze; + std::optional deepFreezePeer; }; /** diff --git a/src/rpc/handlers/BookOffers.cpp b/src/rpc/handlers/BookOffers.cpp index 65110ecb5..f63c98be5 100644 --- a/src/rpc/handlers/BookOffers.cpp +++ b/src/rpc/handlers/BookOffers.cpp @@ -72,7 +72,13 @@ BookOffersHandler::process(Input input, Context const& ctx) const output.ledgerHash = ripple::strHex(lgrInfo.hash); output.ledgerIndex = lgrInfo.seq; output.offers = postProcessOrderBook( - offers, book, input.taker ? *(input.taker) : beast::zero, *sharedPtrBackend_, lgrInfo.seq, ctx.yield + offers, + book, + input.taker ? *(input.taker) : beast::zero, + *sharedPtrBackend_, + *amendmentCenter_, + lgrInfo.seq, + ctx.yield ); return output; diff --git a/src/rpc/handlers/BookOffers.hpp b/src/rpc/handlers/BookOffers.hpp index 01d2b2539..cd7eed6de 100644 --- a/src/rpc/handlers/BookOffers.hpp +++ b/src/rpc/handlers/BookOffers.hpp @@ -19,6 +19,7 @@ #pragma once +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "rpc/Errors.hpp" #include "rpc/JS.hpp" @@ -51,6 +52,7 @@ namespace rpc { */ class BookOffersHandler { std::shared_ptr sharedPtrBackend_; + std::shared_ptr amendmentCenter_; public: static constexpr auto kLIMIT_MIN = 1; @@ -91,8 +93,13 @@ public: * @brief Construct a new BookOffersHandler object * * @param sharedPtrBackend The backend to use + * @param amendmentCenter The amendmentCenter to use */ - BookOffersHandler(std::shared_ptr const& sharedPtrBackend) : sharedPtrBackend_(sharedPtrBackend) + BookOffersHandler( + std::shared_ptr const& sharedPtrBackend, + std::shared_ptr const& amendmentCenter + ) + : sharedPtrBackend_(sharedPtrBackend), amendmentCenter_{amendmentCenter} { } diff --git a/src/rpc/handlers/Ledger.cpp b/src/rpc/handlers/Ledger.cpp index f6b7dd595..519b983a0 100644 --- a/src/rpc/handlers/Ledger.cpp +++ b/src/rpc/handlers/Ledger.cpp @@ -134,6 +134,7 @@ LedgerHandler::process(LedgerHandler::Input input, Context const& ctx) const if (account != amount.getIssuer()) { auto const ownerFunds = accountHolds( *sharedPtrBackend_, + *amendmentCenter_, lgrInfo.seq, account, amount.getCurrency(), diff --git a/src/rpc/handlers/Ledger.hpp b/src/rpc/handlers/Ledger.hpp index b507dd702..5b762f6ec 100644 --- a/src/rpc/handlers/Ledger.hpp +++ b/src/rpc/handlers/Ledger.hpp @@ -19,6 +19,7 @@ #pragma once +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "rpc/JS.hpp" #include "rpc/common/Checkers.hpp" @@ -35,6 +36,7 @@ #include #include #include +#include namespace rpc { @@ -45,6 +47,7 @@ namespace rpc { */ class LedgerHandler { std::shared_ptr sharedPtrBackend_; + std::shared_ptr amendmentCenter_; public: /** @@ -89,8 +92,13 @@ public: * @brief Construct a new LedgerHandler object * * @param sharedPtrBackend The backend to use + * @param amendmentCenter The amendmentCenter to use */ - LedgerHandler(std::shared_ptr const& sharedPtrBackend) : sharedPtrBackend_(sharedPtrBackend) + LedgerHandler( + std::shared_ptr const& sharedPtrBackend, + std::shared_ptr amendmentCenter + ) + : sharedPtrBackend_(sharedPtrBackend), amendmentCenter_(std::move(amendmentCenter)) { } diff --git a/src/rpc/handlers/Subscribe.cpp b/src/rpc/handlers/Subscribe.cpp index 206e2336f..2f140d9fb 100644 --- a/src/rpc/handlers/Subscribe.cpp +++ b/src/rpc/handlers/Subscribe.cpp @@ -19,6 +19,7 @@ #include "rpc/handlers/Subscribe.hpp" +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "data/Types.hpp" #include "feed/SubscriptionManagerInterface.hpp" @@ -55,9 +56,10 @@ namespace rpc { SubscribeHandler::SubscribeHandler( std::shared_ptr const& sharedPtrBackend, + std::shared_ptr const& amendmentCenter, std::shared_ptr const& subscriptions ) - : sharedPtrBackend_(sharedPtrBackend), subscriptions_(subscriptions) + : sharedPtrBackend_(sharedPtrBackend), amendmentCenter_(amendmentCenter), subscriptions_(subscriptions) { } @@ -216,8 +218,9 @@ SubscribeHandler::subscribeToBooks( // https://github.com/XRPLF/xrpl-dev-portal/issues/1818 auto const takerID = internalBook.taker ? accountFromStringStrict(*(internalBook.taker)) : beast::zero; - auto const orderBook = - postProcessOrderBook(offers, book, *takerID, *sharedPtrBackend_, rng->maxSequence, yield); + auto const orderBook = postProcessOrderBook( + offers, book, *takerID, *sharedPtrBackend_, *amendmentCenter_, rng->maxSequence, yield + ); std::copy(orderBook.begin(), orderBook.end(), std::back_inserter(snapshots)); }; diff --git a/src/rpc/handlers/Subscribe.hpp b/src/rpc/handlers/Subscribe.hpp index 89c295c13..3e3e16afb 100644 --- a/src/rpc/handlers/Subscribe.hpp +++ b/src/rpc/handlers/Subscribe.hpp @@ -19,6 +19,7 @@ #pragma once +#include "data/AmendmentCenterInterface.hpp" #include "data/BackendInterface.hpp" #include "feed/SubscriptionManagerInterface.hpp" #include "feed/Types.hpp" @@ -53,6 +54,7 @@ namespace rpc { class SubscribeHandler { std::shared_ptr sharedPtrBackend_; + std::shared_ptr amendmentCenter_; std::shared_ptr subscriptions_; public: @@ -98,10 +100,12 @@ public: * @brief Construct a new BaseSubscribeHandler object * * @param sharedPtrBackend The backend to use + * @param amendmentCenter The amendmentCenter to use * @param subscriptions The subscription manager to use */ SubscribeHandler( std::shared_ptr const& sharedPtrBackend, + std::shared_ptr const& amendmentCenter, std::shared_ptr const& subscriptions ); diff --git a/src/util/Assert.cpp b/src/util/Assert.cpp new file mode 100644 index 000000000..8becebaf4 --- /dev/null +++ b/src/util/Assert.cpp @@ -0,0 +1,66 @@ +//------------------------------------------------------------------------------ +/* + This file is part of clio: https://github.com/XRPLF/clio + Copyright (c) 2025, the clio developers. + + Permission to use, copy, modify, and distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ +//============================================================================== + +#include "util/Assert.hpp" + +#include "util/log/Logger.hpp" + + +#include +#include +#include +#include + +namespace util::impl { + +OnAssert::ActionType OnAssert::action; + +void +OnAssert::call(std::string_view message) +{ + if (not OnAssert::action) { + resetAction(); + } + OnAssert::action(message); +} + +void +OnAssert::setAction(ActionType newAction) +{ + OnAssert::action = std::move(newAction); +} + +void +OnAssert::resetAction() +{ + OnAssert::action = [](std::string_view m) { OnAssert::defaultAction(m); }; +} + +void +OnAssert::defaultAction(std::string_view message) +{ + if (LogService::enabled()) { + LOG(LogService::fatal()) << message; + } else { + std::cerr << message; + } + std::exit(EXIT_FAILURE); // std::abort does not flush gcovr output and causes uncovered lines +} + +} // namespace util::impl diff --git a/src/util/Assert.hpp b/src/util/Assert.hpp index 47bf2f530..503829858 100644 --- a/src/util/Assert.hpp +++ b/src/util/Assert.hpp @@ -20,18 +20,43 @@ #pragma once #include "util/SourceLocation.hpp" -#include "util/log/Logger.hpp" #include + +#include +#include +#ifndef CLIO_WITHOUT_STACKTRACE #include #include +#endif // CLIO_WITHOUT_STACKTRACE #include #include #include -#include -namespace util { +namespace util::impl { + +class OnAssert { +public: + using ActionType = std::function; + +private: + static ActionType action; + +public: + static void + call(std::string_view message); + + static void + setAction(ActionType newAction); + + static void + resetAction(); + +private: + static void + defaultAction(std::string_view message); +}; /** * @brief Assert that a condition is true @@ -55,6 +80,7 @@ assertImpl( ) { if (!condition) { +#ifndef CLIO_WITHOUT_STACKTRACE auto const resultMessage = fmt::format( "Assertion '{}' failed at {}:{}:\n{}\nStacktrace:\n{}", expression, @@ -63,16 +89,21 @@ assertImpl( fmt::format(format, std::forward(args)...), boost::stacktrace::to_string(boost::stacktrace::stacktrace()) ); - if (boost::log::core::get()->get_logging_enabled()) { - LOG(LogService::fatal()) << resultMessage; - } else { - std::cerr << resultMessage; - } - std::exit(EXIT_FAILURE); // std::abort does not flush gcovr output and causes uncovered lines +#else + auto const resultMessage = fmt::format( + "Assertion '{}' failed at {}:{}:\n{}", + expression, + location.file_name(), + location.line(), + fmt::format(format, std::forward(args)...) + ); +#endif + + OnAssert::call(resultMessage); } } -} // namespace util +} // namespace util::impl #define ASSERT(condition, ...) \ - util::assertImpl(CURRENT_SRC_LOCATION, #condition, static_cast(condition), __VA_ARGS__) + util::impl::assertImpl(CURRENT_SRC_LOCATION, #condition, static_cast(condition), __VA_ARGS__) diff --git a/src/util/CMakeLists.txt b/src/util/CMakeLists.txt index 32e792e80..51d44765f 100644 --- a/src/util/CMakeLists.txt +++ b/src/util/CMakeLists.txt @@ -2,7 +2,8 @@ add_library(clio_util) target_sources( clio_util - PRIVATE build/Build.cpp + PRIVATE Assert.cpp + build/Build.cpp config/Config.cpp CoroutineGroup.cpp log/Logger.cpp @@ -34,20 +35,17 @@ target_sources( newconfig/ConfigDefinition.cpp newconfig/ConfigFileJson.cpp newconfig/ObjectView.cpp + newconfig/Types.cpp newconfig/ValueView.cpp ) +# This must be above the target_link_libraries call otherwise backtrace doesn't work +if ("${san}" STREQUAL "") + target_link_libraries(clio_util PUBLIC Boost::stacktrace_backtrace dl libbacktrace::libbacktrace) +endif () + target_link_libraries( - clio_util - PUBLIC Boost::headers - Boost::stacktrace_backtrace - dl - libbacktrace::libbacktrace - fmt::fmt - openssl::openssl - xrpl::libxrpl - Threads::Threads - clio_options + clio_util PUBLIC Boost::headers fmt::fmt openssl::openssl xrpl::libxrpl Threads::Threads clio_options ) # FIXME: needed on gcc-12, clang-16 and AppleClang for now (known boost 1.82 issue for some compilers) diff --git a/src/util/CoroutineGroup.cpp b/src/util/CoroutineGroup.cpp index 195df2f36..b288859b3 100644 --- a/src/util/CoroutineGroup.cpp +++ b/src/util/CoroutineGroup.cpp @@ -56,13 +56,15 @@ CoroutineGroup::spawn(boost::asio::yield_context yield, std::function> -CoroutineGroup::registerForeign() +CoroutineGroup::registerForeign(boost::asio::yield_context yield) { if (isFull()) return std::nullopt; ++childrenCounter_; - return [this]() { onCoroutineCompleted(); }; + // It is important to spawn onCoroutineCompleted() to the same coroutine as will be calling asyncWait(). + // timer_ here is not thread safe, so without spawn there could be a data race. + return [this, yield]() { boost::asio::spawn(yield, [this](auto&&) { onCoroutineCompleted(); }); }; } void diff --git a/src/util/CoroutineGroup.hpp b/src/util/CoroutineGroup.hpp index 9e5b70b18..b14c3b0ff 100644 --- a/src/util/CoroutineGroup.hpp +++ b/src/util/CoroutineGroup.hpp @@ -73,10 +73,11 @@ public: * @note A foreign coroutine is still counted as a child one, i.e. calling this method increases the size of the * group. * + * @param yield The yield context owning the coroutine group. * @return A callback to call on foreign coroutine completes or std::nullopt if the group is already full. */ std::optional> - registerForeign(); + registerForeign(boost::asio::yield_context yield); /** * @brief Wait for all the coroutines in the group to finish diff --git a/src/util/TerminationHandler.cpp b/src/util/TerminationHandler.cpp index e2f886412..9343841ff 100644 --- a/src/util/TerminationHandler.cpp +++ b/src/util/TerminationHandler.cpp @@ -21,7 +21,9 @@ #include "util/log/Logger.hpp" +#ifndef CLIO_WITHOUT_STACKTRACE #include +#endif // CLIO_WITHOUT_STACKTRACE #include #include @@ -33,11 +35,15 @@ namespace { void terminationHandler() { +#ifndef CLIO_WITHOUT_STACKTRACE try { LOG(LogService::fatal()) << "Exit on terminate. Backtrace:\n" << boost::stacktrace::stacktrace(); } catch (...) { LOG(LogService::fatal()) << "Exit on terminate. Can't get backtrace."; } +#else + LOG(LogService::fatal()) << "Exit on terminate. Stacktrace disabled."; +#endif // CLIO_WITHOUT_STACKTRACE std::abort(); } diff --git a/src/util/async/AnyOperation.hpp b/src/util/async/AnyOperation.hpp index 439b91b3d..3c0ee1714 100644 --- a/src/util/async/AnyOperation.hpp +++ b/src/util/async/AnyOperation.hpp @@ -19,7 +19,6 @@ #pragma once -#include "util/async/Concepts.hpp" #include "util/async/Error.hpp" #include "util/async/impl/ErasedOperation.hpp" @@ -78,7 +77,7 @@ public: * Used to cancel the timer for scheduled operations and request the operation to be stopped as soon as possible */ void - abort() noexcept + abort() { operation_.abort(); } @@ -107,6 +106,18 @@ public: } } + /** + * @brief Force-invoke the operation + * @note The action is scheduled on the underlying context/strand + * @warning The code of the user-provided action is expected to take care of thread-safety unless this operation is + * scheduled through a strand + */ + void + invoke() + { + operation_.invoke(); + } + private: impl::ErasedOperation operation_; }; diff --git a/src/util/async/AnyStrand.hpp b/src/util/async/AnyStrand.hpp index 487d65b2a..f2d7b8ed5 100644 --- a/src/util/async/AnyStrand.hpp +++ b/src/util/async/AnyStrand.hpp @@ -131,14 +131,43 @@ public: ); } + /** + * @brief Schedule a repeating operation on the execution context + * + * @param interval The interval at which the operation should be repeated + * @param fn The block of code to execute; no args allowed and return type must be void + * @return A repeating stoppable operation that can be used to wait for its cancellation + */ + [[nodiscard]] auto + executeRepeatedly(SomeStdDuration auto interval, SomeHandlerWithoutStopToken auto&& fn) + { + using RetType = std::decay_t; + static_assert(not std::is_same_v); + + auto const millis = std::chrono::duration_cast(interval); + return AnyOperation( // + pimpl_->executeRepeatedly( + millis, + [fn = std::forward(fn)] -> std::any { + fn(); + return {}; + } + ) + ); + } + private: struct Concept { virtual ~Concept() = default; [[nodiscard]] virtual impl::ErasedOperation - execute(std::function, std::optional timeout = std::nullopt) - const = 0; + execute( + std::function, + std::optional timeout = std::nullopt + ) = 0; [[nodiscard]] virtual impl::ErasedOperation execute(std::function) = 0; + [[nodiscard]] virtual impl::ErasedOperation + executeRepeatedly(std::chrono::milliseconds, std::function) = 0; }; template @@ -152,8 +181,7 @@ private: } [[nodiscard]] impl::ErasedOperation - execute(std::function fn, std::optional timeout) - const override + execute(std::function fn, std::optional timeout) override { return strand.execute(std::move(fn), timeout); } @@ -163,6 +191,12 @@ private: { return strand.execute(std::move(fn)); } + + impl::ErasedOperation + executeRepeatedly(std::chrono::milliseconds interval, std::function fn) override + { + return strand.executeRepeatedly(interval, std::move(fn)); + } }; private: diff --git a/src/util/async/Concepts.hpp b/src/util/async/Concepts.hpp index b6b86038f..eb863699b 100644 --- a/src/util/async/Concepts.hpp +++ b/src/util/async/Concepts.hpp @@ -75,6 +75,14 @@ concept SomeOperationWithData = SomeOperation and requires(T v) { { v.get() }; }; +/** + * @brief Specifies the interface for an operation that can force-invoked + */ +template +concept SomeForceInvocableOperation = SomeOperation and requires(T v) { + { v.invoke() }; +}; + /** * @brief Specifies the interface for an operation that can be stopped */ diff --git a/src/util/async/Operation.hpp b/src/util/async/Operation.hpp index 8bb4a531d..3b1a7420c 100644 --- a/src/util/async/Operation.hpp +++ b/src/util/async/Operation.hpp @@ -32,6 +32,7 @@ #include #include #include +#include #include #include #include @@ -227,6 +228,7 @@ using ScheduledOperation = impl::BasicScheduledOperation; template class RepeatingOperation : public util::MoveTracker { util::Repeat repeat_; + std::function action_; public: /** @@ -237,10 +239,11 @@ public: * @param interval Time to wait before repeating the user-provided block of code * @param fn The function to execute repeatedly */ - RepeatingOperation(auto& executor, std::chrono::steady_clock::duration interval, std::invocable auto&& fn) - : repeat_(executor) + template + RepeatingOperation(auto& executor, std::chrono::steady_clock::duration interval, FnType&& fn) + : repeat_(executor), action_([fn = std::forward(fn), &executor] { boost::asio::post(executor, fn); }) { - repeat_.start(interval, std::forward(fn)); + repeat_.start(interval, action_); } ~RepeatingOperation() override @@ -266,6 +269,18 @@ public: { repeat_.stop(); } + + /** + * @brief Force-invoke the operation + * @note The action is scheduled on the underlying context/strand + * @warning The code of the user-provided action is expected to take care of thread-safety unless this operation is + * scheduled through a strand + */ + void + invoke() + { + action_(); + } }; } // namespace util::async diff --git a/src/util/async/context/BasicExecutionContext.hpp b/src/util/async/context/BasicExecutionContext.hpp index b2b921828..288e93141 100644 --- a/src/util/async/context/BasicExecutionContext.hpp +++ b/src/util/async/context/BasicExecutionContext.hpp @@ -61,8 +61,8 @@ struct AsioPoolStrandContext { using Executor = boost::asio::strand; using Timer = SteadyTimer; - Executor const& - getExecutor() const + Executor& + getExecutor() { return executor; } @@ -272,6 +272,7 @@ public: /** * @brief Schedule a repeating operation on the execution context + * @warning The code of the user-provided action is expected to be thread-safe * * @param interval The interval at which the operation should be repeated * @param fn The block of code to execute; no args allowed and return type must be void diff --git a/src/util/async/context/impl/Strand.hpp b/src/util/async/context/impl/Strand.hpp index 6a6cfd116..cb0a38d89 100644 --- a/src/util/async/context/impl/Strand.hpp +++ b/src/util/async/context/impl/Strand.hpp @@ -20,6 +20,7 @@ #pragma once #include "util/async/Concepts.hpp" +#include "util/async/Operation.hpp" #include "util/async/context/impl/Cancellation.hpp" #include "util/async/context/impl/Execution.hpp" #include "util/async/context/impl/Timer.hpp" @@ -52,6 +53,7 @@ public: using StopToken = typename StopSourceType::Token; using Timer = typename ParentContextType::ContextHolderType::Timer; // timers are associated with the parent context + using RepeatedOperation = RepeatingOperation; BasicStrand(ParentContextType& parent, auto&& strand) : parentContext_{std::ref(parent)}, context_{std::forward(strand)} @@ -64,8 +66,10 @@ public: BasicStrand(BasicStrand const&) = delete; [[nodiscard]] auto - execute(SomeHandlerWith auto&& fn, std::optional timeout = std::nullopt) const - noexcept(kIS_NOEXCEPT) + execute( + SomeHandlerWith auto&& fn, + std::optional timeout = std::nullopt + ) noexcept(kIS_NOEXCEPT) { return DispatcherType::dispatch( context_, @@ -89,7 +93,7 @@ public: } [[nodiscard]] auto - execute(SomeHandlerWith auto&& fn, SomeStdDuration auto timeout) const noexcept(kIS_NOEXCEPT) + execute(SomeHandlerWith auto&& fn, SomeStdDuration auto timeout) noexcept(kIS_NOEXCEPT) { return execute( std::forward(fn), @@ -98,7 +102,7 @@ public: } [[nodiscard]] auto - execute(SomeHandlerWithoutStopToken auto&& fn) const noexcept(kIS_NOEXCEPT) + execute(SomeHandlerWithoutStopToken auto&& fn) noexcept(kIS_NOEXCEPT) { return DispatcherType::dispatch( context_, @@ -114,6 +118,16 @@ public: }) ); } + + [[nodiscard]] auto + executeRepeatedly(SomeStdDuration auto interval, SomeHandlerWithoutStopToken auto&& fn) noexcept(kIS_NOEXCEPT) + { + if constexpr (not std::is_same_v) { + return TimerContextProvider::getContext(*this).executeRepeatedly(interval, std::forward(fn)); + } else { + return RepeatedOperation(impl::extractAssociatedExecutor(*this), interval, std::forward(fn)); + } + } }; } // namespace util::async::impl diff --git a/src/util/async/impl/ErasedOperation.hpp b/src/util/async/impl/ErasedOperation.hpp index 480295ddb..d42de490c 100644 --- a/src/util/async/impl/ErasedOperation.hpp +++ b/src/util/async/impl/ErasedOperation.hpp @@ -71,6 +71,12 @@ public: pimpl_->abort(); } + void + invoke() + { + pimpl_->invoke(); + } + private: struct Concept { virtual ~Concept() = default; @@ -81,6 +87,8 @@ private: get() = 0; virtual void abort() = 0; + virtual void + invoke() = 0; }; template @@ -133,6 +141,16 @@ private: } } } + + void + invoke() override + { + if constexpr (not SomeForceInvocableOperation) { + ASSERT(false, "Called invoke() on an operation that can't be force-invoked"); + } else { + operation.invoke(); + } + } }; private: diff --git a/src/util/log/Logger.cpp b/src/util/log/Logger.cpp index 3f9a35dda..3fcad094f 100644 --- a/src/util/log/Logger.cpp +++ b/src/util/log/Logger.cpp @@ -28,8 +28,6 @@ #include #include -#include -#include #include #include #include @@ -48,18 +46,20 @@ #include #include #include +#include #include #include #include #include +#include #include #include #include #include -#include #include #include +#include #include #include @@ -111,7 +111,7 @@ getSeverityLevel(std::string_view logLevel) std::unreachable(); } -void +std::expected LogService::init(config::ClioConfigDefinition const& config) { namespace keywords = boost::log::keywords; @@ -132,9 +132,15 @@ LogService::init(config::ClioConfigDefinition const& config) auto const logDir = config.maybeValue("log_directory"); if (logDir) { - boost::filesystem::path dirPath{logDir.value()}; - if (!boost::filesystem::exists(dirPath)) - boost::filesystem::create_directories(dirPath); + std::filesystem::path dirPath{logDir.value()}; + if (not std::filesystem::exists(dirPath)) { + if (std::error_code error; not std::filesystem::create_directories(dirPath, error)) { + return std::unexpected{ + fmt::format("Couldn't create logs directory '{}': {}", dirPath.string(), error.message()) + }; + } + } + auto const rotationPeriod = config.get("log_rotation_hour_interval"); // the below are taken from user in MB, but boost::log::add_file_log needs it to be in bytes @@ -169,8 +175,9 @@ LogService::init(config::ClioConfigDefinition const& config) for (auto it = overrides.begin(); it != overrides.end(); ++it) { auto const& channelConfig = *it; auto const name = channelConfig.get("channel"); - if (std::count(std::begin(Logger::kCHANNELS), std::end(Logger::kCHANNELS), name) == 0) - throw std::runtime_error("Can't override settings for log channel " + name + ": invalid channel"); + if (std::ranges::count(Logger::kCHANNELS, name) == 0) { // TODO: use std::ranges::contains when available + return std::unexpected{fmt::format("Can't override settings for log channel {}: invalid channel", name)}; + } minSeverity[name] = getSeverityLevel(channelConfig.get("log_level")); } @@ -189,6 +196,13 @@ LogService::init(config::ClioConfigDefinition const& config) filter = boost::log::filter{std::move(logFilter)}; boost::log::core::get()->set_filter(filter); LOG(LogService::info()) << "Default log level = " << defaultSeverity; + return {}; +} + +bool +LogService::enabled() +{ + return boost::log::core::get()->get_logging_enabled(); } Logger::Pump diff --git a/src/util/log/Logger.hpp b/src/util/log/Logger.hpp index a3df8ffa9..6390b47d8 100644 --- a/src/util/log/Logger.hpp +++ b/src/util/log/Logger.hpp @@ -46,6 +46,7 @@ #include #include +#include #include #include #include @@ -278,8 +279,9 @@ public: * @brief Global log core initialization from a @ref Config * * @param config The configuration to use + * @return Void on success, error message on failure */ - static void + [[nodiscard]] static std::expected init(config::ClioConfigDefinition const& config); /** @@ -365,6 +367,14 @@ public: { return alertLog.warn(loc); } + + /** + * @brief Whether the LogService is enabled or not + * + * @return true if the LogService is enabled, false otherwise + */ + [[nodiscard]] static bool + enabled(); }; }; // namespace util diff --git a/src/util/newconfig/Array.cpp b/src/util/newconfig/Array.cpp index 13d9b8361..46c2b31eb 100644 --- a/src/util/newconfig/Array.cpp +++ b/src/util/newconfig/Array.cpp @@ -36,17 +36,34 @@ Array::Array(ConfigValue arg) : itemPattern_{std::move(arg)} { } +std::string_view +Array::prefix(std::string_view key) +{ + static constexpr std::string_view kARRAY_SUFFIX = ".[]"; + ASSERT(key.contains(kARRAY_SUFFIX), "Provided key is not an array key: {}", key); + + return key.substr(0, key.rfind(kARRAY_SUFFIX) + kARRAY_SUFFIX.size()); +} + std::optional Array::addValue(Value value, std::optional key) { - auto const& configValPattern = itemPattern_; - auto const constraint = configValPattern.getConstraint(); + auto newItem = itemPattern_; - auto newElem = constraint.has_value() ? ConfigValue{configValPattern.type()}.withConstraint(constraint->get()) - : ConfigValue{configValPattern.type()}; - if (auto const maybeError = newElem.setValue(value, key); maybeError.has_value()) + if (auto const maybeError = newItem.setValue(value, key); maybeError.has_value()) return maybeError; - elements_.emplace_back(std::move(newElem)); + elements_.emplace_back(std::move(newItem)); + return std::nullopt; +} + +std::optional +Array::addNull(std::optional key) +{ + if (not itemPattern_.isOptional() and not itemPattern_.hasValue()) { + return Error{key.value_or("Unknown_key"), "value for the array (or object field inside array) is required"}; + } + + elements_.push_back(itemPattern_); return std::nullopt; } diff --git a/src/util/newconfig/Array.hpp b/src/util/newconfig/Array.hpp index a6ccbe958..71e946aab 100644 --- a/src/util/newconfig/Array.hpp +++ b/src/util/newconfig/Array.hpp @@ -25,6 +25,7 @@ #include #include +#include #include #include @@ -46,6 +47,17 @@ public: */ Array(ConfigValue arg); + /** + * @brief Extract array prefix from a key, For example for a key foo.[].bar the method will return foo.[] + * @note Provided key must contain '.[]' + * @warning Be careful with string_view! Returned value is valid only while the key is valid + * + * @param key The key to extract the array prefix from + * @return Prefix of array extracted from the key + */ + static std::string_view + prefix(std::string_view key); + /** * @brief Add ConfigValues to Array class * @@ -53,9 +65,19 @@ public: * @param key optional string key to include that will show in error message * @return optional error if adding config value to array fails. nullopt otherwise */ - std::optional + [[nodiscard]] std::optional addValue(Value value, std::optional key = std::nullopt); + /** + * @brief Add null value to the array + * @note The error will be returned if item pattern of the array is neither optional nor has a default value + * + * @param key An optional key which will be used for error message only (if any) + * @return An error if any or nullopt if the operation succeeded + */ + [[nodiscard]] std::optional + addNull(std::optional key = std::nullopt); + /** * @brief Returns the number of values stored in the Array * @@ -103,4 +125,18 @@ private: std::vector elements_; }; +/** + * @brief Custom output stream for Array + * + * @param stream The output stream + * @param arr The Array + * @return The same ostream we were given + */ +inline std::ostream& +operator<<(std::ostream& stream, Array arr) +{ + stream << arr.getArrayPattern(); + return stream; +} + } // namespace util::config diff --git a/src/util/newconfig/ConfigConstraints.cpp b/src/util/newconfig/ConfigConstraints.cpp index 66e91771f..2a0f8fb6e 100644 --- a/src/util/newconfig/ConfigConstraints.cpp +++ b/src/util/newconfig/ConfigConstraints.cpp @@ -22,6 +22,8 @@ #include "util/newconfig/Error.hpp" #include "util/newconfig/Types.hpp" +#include + #include #include #include @@ -68,20 +70,19 @@ ValidIPConstraint::checkTypeImpl(Value const& ip) const std::optional ValidIPConstraint::checkValueImpl(Value const& ip) const { - if (std::get(ip) == "localhost") + boost::system::error_code errorCode; + boost::asio::ip::make_address(std::get(ip), errorCode); + if (not errorCode.failed()) return std::nullopt; - static std::regex const kIPV4( - R"(^((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])$)" - ); + static std::regex const kHOST{ + R"regex(^(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])$)regex" + }; - static std::regex const kIP_URL( - R"(^((http|https):\/\/)?((([a-zA-Z0-9-]+\.)+[a-zA-Z]{2,6})|(((25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])\.){3}(25[0-5]|2[0-4][0-9]|1[0-9]{2}|[1-9]?[0-9])))(:\d{1,5})?(\/[^\s]*)?$)" - ); - if (std::regex_match(std::get(ip), kIPV4) || std::regex_match(std::get(ip), kIP_URL)) + if (std::regex_match(std::get(ip), kHOST)) return std::nullopt; - return Error{"Ip is not a valid ip address"}; + return Error{"Ip is not a valid ip address or hostname"}; } std::optional diff --git a/src/util/newconfig/ConfigConstraints.hpp b/src/util/newconfig/ConfigConstraints.hpp index 315ea05f7..910dff1e5 100644 --- a/src/util/newconfig/ConfigConstraints.hpp +++ b/src/util/newconfig/ConfigConstraints.hpp @@ -33,6 +33,7 @@ #include #include #include +#include #include #include #include @@ -149,6 +150,28 @@ protected: */ virtual std::optional checkValueImpl(Value const& val) const = 0; + + /** + * @brief Prints to the output stream for this specific constraint. + * + * @param stream The output stream + */ + virtual void + print(std::ostream& stream) const = 0; + + /** + * @brief Custom output stream for constraint + * + * @param stream The output stream + * @param cons The constraint + * @return The same ostream we were given + */ + friend std::ostream& + operator<<(std::ostream& stream, Constraint const& cons) + { + cons.print(stream); + return stream; + } }; /** @@ -177,6 +200,17 @@ private: [[nodiscard]] std::optional checkValueImpl(Value const& port) const override; + /** + * @brief Prints to the output stream for this specific constraint. + * + * @param stream The output stream + */ + void + print(std::ostream& stream) const override + { + stream << fmt::format("The minimum value is `{}`. The maximum value is `{}", kPORT_MIN, kPORT_MAX); + } + static constexpr uint32_t kPORT_MIN = 1; static constexpr uint32_t kPORT_MAX = 65535; }; @@ -206,6 +240,17 @@ private: */ [[nodiscard]] std::optional checkValueImpl(Value const& ip) const override; + + /** + * @brief Prints to the output stream for this specific constraint. + * + * @param stream The output stream + */ + void + print(std::ostream& stream) const override + { + stream << "The value must be a valid IP address"; + } }; /** @@ -260,6 +305,17 @@ private: return Error{makeErrorMsg(key_, val, arr_)}; } + /** + * @brief Prints to the output stream for this specific constraint. + * + * @param stream The output stream + */ + void + print(std::ostream& stream) const override + { + stream << fmt::format("The value must be one of the following: `{}`", fmt::join(arr_, ", ")); + } + std::string_view key_; std::array arr_; }; @@ -312,6 +368,17 @@ private: return Error{fmt::format("Number must be between {} and {}", min_, max_)}; } + /** + * @brief Prints to the output stream for this specific constraint. + * + * @param stream The output stream + */ + void + print(std::ostream& stream) const override + { + stream << fmt::format("The minimum value is `{}`. The maximum value is `{}`", min_, max_); + } + NumType min_; NumType max_; }; @@ -341,6 +408,17 @@ private: */ [[nodiscard]] std::optional checkValueImpl(Value const& num) const override; + + /** + * @brief Prints to the output stream for this specific constraint. + * + * @param stream The output stream + */ + void + print(std::ostream& stream) const override + { + stream << fmt::format("The value must be a positive double number"); + } }; static constinit PortConstraint gValidatePort{}; diff --git a/src/util/newconfig/ConfigDefinition.cpp b/src/util/newconfig/ConfigDefinition.cpp index bad33717e..a041d9412 100644 --- a/src/util/newconfig/ConfigDefinition.cpp +++ b/src/util/newconfig/ConfigDefinition.cpp @@ -42,6 +42,7 @@ #include #include #include +#include #include #include #include @@ -65,6 +66,7 @@ ClioConfigDefinition::getObject(std::string_view prefix, std::optional(mapVal)) { ASSERT(std::get(mapVal).size() > idx.value(), "Index provided is out of scope"); + // we want to support getObject("array") and getObject("array.[]"), so we check if "[]" exists if (!prefix.contains("[]")) return ObjectView{prefixWithDot + "[]", idx.value(), *this}; @@ -156,16 +158,19 @@ std::optional> ClioConfigDefinition::parse(ConfigFileInterface const& config) { std::vector listOfErrors; + std::unordered_map> arrayPrefixesToKeysMap; for (auto& [key, value] : map_) { + if (key.contains(".[]")) { + auto const prefix = Array::prefix(key); + arrayPrefixesToKeysMap[prefix].push_back(key); + } + // if key doesn't exist in user config, makes sure it is marked as ".optional()" or has ".defaultValue()"" in - // ClioConfigDefitinion above + // ClioConfigDefinition above if (!config.containsKey(key)) { if (std::holds_alternative(value)) { if (!(std::get(value).isOptional() || std::get(value).hasValue())) listOfErrors.emplace_back(key, "key is required in user Config"); - } else if (std::holds_alternative(value)) { - if (!(std::get(value).getArrayPattern().isOptional())) - listOfErrors.emplace_back(key, "key is required in user Config"); } continue; } @@ -178,21 +183,59 @@ ClioConfigDefinition::parse(ConfigFileInterface const& config) // attempt to set the value from the configuration for the specified key. [&key, &config, &listOfErrors](ConfigValue& val) { if (auto const maybeError = val.setValue(config.getValue(key), key); - maybeError.has_value()) + maybeError.has_value()) { listOfErrors.emplace_back(maybeError.value()); + } }, // handle the case where the config value is an array. // iterate over each provided value in the array and attempt to set it for the key. [&key, &config, &listOfErrors](Array& arr) { for (auto const& val : config.getArray(key)) { - if (auto const maybeError = arr.addValue(val, key); maybeError.has_value()) - listOfErrors.emplace_back(maybeError.value()); + if (val.has_value()) { + if (auto const maybeError = arr.addValue(*val, key); maybeError.has_value()) { + listOfErrors.emplace_back(*maybeError); + } + } else { + if (auto const maybeError = arr.addNull(key); maybeError.has_value()) { + listOfErrors.emplace_back(*maybeError); + } + } } } }, value ); } + + if (!listOfErrors.empty()) + return listOfErrors; + + // The code above couldn't detect whether some fields in an array are missing. + // So to fix it for each array we determine it's size and add empty values if the field is optional + // or generate an error. + for (auto const& [_, keys] : arrayPrefixesToKeysMap) { + size_t maxSize = 0; + std::ranges::for_each(keys, [&](std::string_view key) { + ASSERT(std::holds_alternative(map_.at(key)), "{} is not array", key); + maxSize = std::max(maxSize, arraySize(key)); + }); + if (maxSize == 0) { + // empty arrays are allowed + continue; + } + + std::ranges::for_each(keys, [&](std::string_view key) { + auto& array = std::get(map_.at(key)); + while (array.size() < maxSize) { + auto const err = array.addNull(key); + if (err.has_value()) { + listOfErrors.emplace_back(*err); + break; + } + } + }); + } + if (!listOfErrors.empty()) return listOfErrors; diff --git a/src/util/newconfig/ConfigDefinition.hpp b/src/util/newconfig/ConfigDefinition.hpp index 94a70b671..030b8d160 100644 --- a/src/util/newconfig/ConfigDefinition.hpp +++ b/src/util/newconfig/ConfigDefinition.hpp @@ -23,7 +23,6 @@ #include "util/Assert.hpp" #include "util/newconfig/Array.hpp" #include "util/newconfig/ConfigConstraints.hpp" -#include "util/newconfig/ConfigDescription.hpp" #include "util/newconfig/ConfigFileInterface.hpp" #include "util/newconfig/ConfigValue.hpp" #include "util/newconfig/Error.hpp" @@ -31,16 +30,10 @@ #include "util/newconfig/Types.hpp" #include "util/newconfig/ValueView.hpp" -#include -#include -#include - #include -#include #include #include #include -#include #include #include #include @@ -84,26 +77,6 @@ public: [[nodiscard]] std::optional> parse(ConfigFileInterface const& config); - /** - * @brief Validates the configuration file - * - * Should only check for valid values, without populating - * - * @param config The configuration file interface - * @return An optional vector of Error objects stating all the failures if validation fails - */ - [[nodiscard]] std::optional> - validate(ConfigFileInterface const& config) const; - - /** - * @brief Generate markdown file of all the clio config descriptions - * - * @param configDescription The configuration description object - * @return An optional Error if generating markdown fails - */ - [[nodiscard]] std::expected - getMarkdown(ClioConfigDescription const& configDescription) const; - /** * @brief Returns the ObjectView specified with the prefix * @@ -301,7 +274,10 @@ static ClioConfigDefinition gClioConfig = ClioConfigDefinition{ ConfigValue{ConfigType::Integer}.defaultValue(100'000).withConstraint(gValidateUint32)}, {"database.cassandra.threads", ConfigValue{ConfigType::Integer} - .defaultValue(static_cast(std::thread::hardware_concurrency())) + .defaultValue( + static_cast(std::thread::hardware_concurrency()), + "The number of available CPU cores." + ) .withConstraint(gValidateUint32)}, {"database.cassandra.core_connections_per_host", ConfigValue{ConfigType::Integer}.defaultValue(1).withConstraint(gValidateUint16)}, @@ -340,9 +316,9 @@ static ClioConfigDefinition gClioConfig = ClioConfigDefinition{ ConfigValue{ConfigType::Double}.defaultValue(1.0).withConstraint(gValidatePositiveDouble)}, {"workers", - ConfigValue{ConfigType::Integer}.defaultValue(std::thread::hardware_concurrency()).withConstraint(gValidateUint32) - }, - + ConfigValue{ConfigType::Integer} + .defaultValue(std::thread::hardware_concurrency(), "The number of available CPU cores.") + .withConstraint(gValidateUint32)}, {"server.ip", ConfigValue{ConfigType::String}.withConstraint(gValidateIp)}, {"server.port", ConfigValue{ConfigType::Integer}.withConstraint(gValidatePort)}, {"server.max_queue_size", ConfigValue{ConfigType::Integer}.defaultValue(0).withConstraint(gValidateUint32)}, diff --git a/src/util/newconfig/ConfigDescription.hpp b/src/util/newconfig/ConfigDescription.hpp index 71335a66c..52fbc6d06 100644 --- a/src/util/newconfig/ConfigDescription.hpp +++ b/src/util/newconfig/ConfigDescription.hpp @@ -20,9 +20,19 @@ #pragma once #include "util/Assert.hpp" +#include "util/newconfig/ConfigDefinition.hpp" +#include "util/newconfig/Error.hpp" + +#include #include #include +#include +#include +#include +#include +#include +#include #include namespace util::config { @@ -61,26 +71,90 @@ public: return itr->value; } + /** + * @brief Generate markdown file of all the clio config descriptions + * + * @param path The path location to generate the Config-description file + * @return An Error if generating markdown fails, otherwise nothing + */ + [[nodiscard]] static std::expected + generateConfigDescriptionToFile(std::filesystem::path path) + { + namespace fs = std::filesystem; + + // Validate the directory exists + auto const dir = path.parent_path(); + if (!dir.empty() && !fs::exists(dir)) { + return std::unexpected{ + fmt::format("Error: Directory '{}' does not exist or provided path is invalid", dir.string()) + }; + } + + std::ofstream file(path.string()); + if (!file.is_open()) { + return std::unexpected{fmt::format("Failed to create file '{}': {}", path.string(), std::strerror(errno))}; + } + + writeConfigDescriptionToFile(file); + file.close(); + + std::cout << "Markdown file generated successfully: " << path << "\n"; + return {}; + } + + /** + * @brief Writes to Config description to file + * + * @param file The config file to write to + */ + static void + writeConfigDescriptionToFile(std::ostream& file) + { + file << "# Clio Config Description\n"; + file << "This file lists all Clio Configuration definitions in detail.\n\n"; + file << "## Configuration Details\n\n"; + + for (auto const& [key, val] : kCONFIG_DESCRIPTION) { + file << "### Key: " << key << "\n"; + + // Every type of value is directed to operator<< in ConfigValue.hpp + // as ConfigValue is the one that holds all the info regarding the config values + if (key.contains("[]")) { + file << gClioConfig.asArray(key); + } else { + file << gClioConfig.getValueView(key); + } + file << " - **Description**: " << val << "\n"; + } + file << "\n"; + } + private: static constexpr auto kCONFIG_DESCRIPTION = std::array{ - KV{.key = "database.type", .value = "Type of database to use. Default is Scylladb."}, + KV{.key = "database.type", + .value = "Type of database to use. We currently support Cassandra and Scylladb. We default to Scylladb."}, KV{.key = "database.cassandra.contact_points", - .value = - "A list of IP addresses or hostnames of the initial nodes (Cassandra/Scylladb cluster nodes) that the " - "client will connect to when establishing a connection with the database."}, + .value = "A list of IP addresses or hostnames of the initial nodes (Cassandra/Scylladb cluster nodes) that " + "the client will connect to when establishing a connection with the database. If you're running " + "locally, it should be 'localhost' or 127.0.0.1"}, KV{.key = "database.cassandra.secure_connect_bundle", .value = "Configuration file that contains the necessary security credentials and connection details for " "securely " "connecting to a Cassandra database cluster."}, - KV{.key = "database.cassandra.port", .value = "Port number to connect to Cassandra."}, - KV{.key = "database.cassandra.keyspace", .value = "Keyspace to use in Cassandra."}, - KV{.key = "database.cassandra.replication_factor", .value = "Number of replicated nodes for Scylladb."}, - KV{.key = "database.cassandra.table_prefix", .value = "Prefix for Cassandra table names."}, + KV{.key = "database.cassandra.port", .value = "Port number to connect to the database."}, + KV{.key = "database.cassandra.keyspace", .value = "Keyspace to use for the database."}, + KV{.key = "database.cassandra.replication_factor", + .value = "Number of replicated nodes for Scylladb. Visit this link for more details : " + "https://university.scylladb.com/courses/scylla-essentials-overview/lessons/high-availability/" + "topic/fault-tolerance-replication-factor/ "}, + KV{.key = "database.cassandra.table_prefix", .value = "Prefix for Database table names."}, KV{.key = "database.cassandra.max_write_requests_outstanding", - .value = "Maximum number of outstanding write requests."}, + .value = "Maximum number of outstanding write requests. Write requests are api calls that write to database " + }, KV{.key = "database.cassandra.max_read_requests_outstanding", - .value = "Maximum number of outstanding read requests."}, - KV{.key = "database.cassandra.threads", .value = "Number of threads for Cassandra operations."}, + .value = "Maximum number of outstanding read requests, which reads from database"}, + KV{.key = "database.cassandra.threads", .value = "Number of threads that will be used for database operations." + }, KV{.key = "database.cassandra.core_connections_per_host", .value = "Number of core connections per host for Cassandra."}, KV{.key = "database.cassandra.queue_size_io", .value = "Queue size for I/O operations in Cassandra."}, @@ -106,10 +180,10 @@ private: .value = "Timeout duration for the forwarding cache used in Rippled communication."}, KV{.key = "forwarding.request_timeout", .value = "Timeout duration for the forwarding request used in Rippled communication."}, - KV{.key = "rpc.cache_timeout", .value = "Timeout duration for the rpc request."}, + KV{.key = "rpc.cache_timeout", .value = "Timeout duration for RPC requests."}, KV{.key = "num_markers", - .value = "The number of markers is the number of coroutines to load the cache concurrently."}, - KV{.key = "dos_guard.[].whitelist", .value = "List of IP addresses to whitelist for DOS protection."}, + .value = "The number of markers is the number of coroutines to download the initial ledger"}, + KV{.key = "dos_guard.whitelist.[]", .value = "List of IP addresses to whitelist for DOS protection."}, KV{.key = "dos_guard.max_fetches", .value = "Maximum number of fetch operations allowed by DOS guard."}, KV{.key = "dos_guard.max_connections", .value = "Maximum number of concurrent connections allowed by DOS guard." }, @@ -120,39 +194,53 @@ private: KV{.key = "server.port", .value = "Port number of the Clio HTTP server."}, KV{.key = "server.max_queue_size", .value = "Maximum size of the server's request queue. Value of 0 is no limit."}, - KV{.key = "server.local_admin", .value = "Indicates if the server should run with admin privileges."}, - KV{.key = "server.admin_password", .value = "Password for Clio admin-only APIs."}, + KV{.key = "server.local_admin", + .value = "Indicates if the server should run with admin privileges. Only one of local_admin or " + "admin_password can be set."}, + KV{.key = "server.admin_password", + .value = "Password for Clio admin-only APIs. Only one of local_admin or admin_password can be set."}, KV{.key = "server.processing_policy", .value = R"(Could be "sequent" or "parallel". For the sequent policy, requests from a single client connection are processed one by one, with the next request read only after the previous one is processed. For the parallel policy, Clio will accept all requests and process them in parallel, sending a reply for each request as soon as it is ready.)"}, KV{.key = "server.parallel_requests_limit", - .value = R"(Optional parameter, used only if "processing_strategy" is - "parallel". It limits the number of requests for a single client connection that are processed in parallel. If not specified, the limit is infinite.)" + .value = + R"(Optional parameter, used only if processing_strategy `parallel`. It limits the number of requests for a single client connection that are processed in parallel. If not specified, the limit is infinite.)" }, KV{.key = "server.ws_max_sending_queue_size", .value = "Maximum size of the websocket sending queue."}, KV{.key = "prometheus.enabled", .value = "Enable or disable Prometheus metrics."}, KV{.key = "prometheus.compress_reply", .value = "Enable or disable compression of Prometheus responses."}, - KV{.key = "io_threads", .value = "Number of I/O threads. Value must be greater than 1"}, + KV{.key = "io_threads", .value = "Number of I/O threads. Value cannot be less than 1"}, KV{.key = "subscription_workers", .value = "The number of worker threads or processes that are responsible for managing and processing " - "subscription-based tasks."}, + "subscription-based tasks from rippled"}, KV{.key = "graceful_period", .value = "Number of milliseconds server will wait to shutdown gracefully."}, - KV{.key = "cache.num_diffs", .value = "Number of diffs to cache."}, + KV{.key = "cache.num_diffs", .value = "Number of diffs to cache. For more info, consult readme.md in etc"}, KV{.key = "cache.num_markers", .value = "Number of markers to cache."}, KV{.key = "cache.num_cursors_from_diff", .value = "Num of cursors that are different."}, KV{.key = "cache.num_cursors_from_account", .value = "Number of cursors from an account."}, KV{.key = "cache.page_fetch_size", .value = "Page fetch size for cache operations."}, KV{.key = "cache.load", .value = "Cache loading strategy ('sync' or 'async')."}, - KV{.key = "log_channels.[].channel", .value = "Name of the log channel."}, - KV{.key = "log_channels.[].log_level", .value = "Log level for the log channel."}, - KV{.key = "log_level", .value = "General logging level of Clio."}, + KV{.key = "log_channels.[].channel", + .value = "Name of the log channel." + "'RPC', 'ETL', and 'Performance'"}, + KV{.key = "log_channels.[].log_level", + .value = "Log level for the specific log channel." + "`warning`, `error`, `fatal`"}, + KV{.key = "log_level", + .value = "General logging level of Clio. This level will be applied to all log channels that do not have an " + "explicitly defined logging level."}, KV{.key = "log_format", .value = "Format string for log messages."}, KV{.key = "log_to_console", .value = "Enable or disable logging to console."}, KV{.key = "log_directory", .value = "Directory path for log files."}, - KV{.key = "log_rotation_size", .value = "Log rotation size in megabytes."}, + KV{.key = "log_rotation_size", + .value = + "Log rotation size in megabytes. When the log file reaches this particular size, a new log file starts." + }, KV{.key = "log_directory_max_size", .value = "Maximum size of the log directory in megabytes."}, - KV{.key = "log_rotation_hour_interval", .value = "Interval in hours for log rotation."}, + KV{.key = "log_rotation_hour_interval", + .value = "Interval in hours for log rotation. If the current log file reaches this value in logging, a new " + "log file starts."}, KV{.key = "log_tag_style", .value = "Style for log tags."}, KV{.key = "extractor_threads", .value = "Number of extractor threads."}, KV{.key = "read_only", .value = "Indicates if the server should have read-only privileges."}, @@ -164,8 +252,8 @@ private: KV{.key = "api_version.default", .value = "Default API version Clio will run on."}, KV{.key = "api_version.min", .value = "Minimum API version."}, KV{.key = "api_version.max", .value = "Maximum API version."}, - KV{.key = "migration.full_scan_threads", .value = "The number of threads used to scan table."}, - KV{.key = "migration.full_scan_jobs", .value = "The number of coroutines used to scan table."}, + KV{.key = "migration.full_scan_threads", .value = "The number of threads used to scan the table."}, + KV{.key = "migration.full_scan_jobs", .value = "The number of coroutines used to scan the table."}, KV{.key = "migration.cursors_per_job", .value = "The number of cursors each coroutine will scan."} }; }; diff --git a/src/util/newconfig/ConfigFileInterface.hpp b/src/util/newconfig/ConfigFileInterface.hpp index a26dda043..4749fe4d9 100644 --- a/src/util/newconfig/ConfigFileInterface.hpp +++ b/src/util/newconfig/ConfigFileInterface.hpp @@ -21,6 +21,7 @@ #include "util/newconfig/Types.hpp" +#include #include #include @@ -49,9 +50,9 @@ public: * @brief Retrieves an array of configuration values. * * @param key The key of the configuration array. - * @return A vector of configuration values if found, otherwise std::nullopt. + * @return A vector of configuration values some of which could be nullopt */ - virtual std::vector + virtual std::vector> getArray(std::string_view key) const = 0; /** diff --git a/src/util/newconfig/ConfigFileJson.cpp b/src/util/newconfig/ConfigFileJson.cpp index bb9730fb8..a9d50fe52 100644 --- a/src/util/newconfig/ConfigFileJson.cpp +++ b/src/util/newconfig/ConfigFileJson.cpp @@ -20,6 +20,7 @@ #include "util/newconfig/ConfigFileJson.hpp" #include "util/Assert.hpp" +#include "util/newconfig/Array.hpp" #include "util/newconfig/Error.hpp" #include "util/newconfig/Types.hpp" @@ -30,15 +31,19 @@ #include #include +#include #include #include #include #include #include #include +#include +#include #include #include #include +#include #include #include @@ -69,14 +74,14 @@ extractJsonValue(boost::json::value const& jsonValue) if (jsonValue.is_double()) { return jsonValue.as_double(); } - ASSERT(false, "Json is not of type int, uint, string, bool or double"); + ASSERT(false, "Json is not of type null, int, uint, string, bool or double"); std::unreachable(); } } // namespace ConfigFileJson::ConfigFileJson(boost::json::object jsonObj) { - flattenJson(jsonObj, ""); + flattenJson(jsonObj); } std::expected @@ -86,8 +91,7 @@ ConfigFileJson::makeConfigFileJson(std::filesystem::path const& configFilePath) if (auto const in = std::ifstream(configFilePath.string(), std::ios::in | std::ios::binary); in) { std::stringstream contents; contents << in.rdbuf(); - auto opts = boost::json::parse_options{}; - opts.allow_comments = true; + auto const opts = boost::json::parse_options{.allow_comments = true}; auto const tempObj = boost::json::parse(contents.str(), {}, opts).as_object(); return ConfigFileJson{tempObj}; } @@ -105,22 +109,29 @@ ConfigFileJson::makeConfigFileJson(std::filesystem::path const& configFilePath) Value ConfigFileJson::getValue(std::string_view key) const { + ASSERT(containsKey(key), "Key {} not found in ConfigFileJson", key); auto const jsonValue = jsonObject_.at(key); + ASSERT(jsonValue.is_primitive(), "Key {} has value that is not a primitive", key); auto const value = extractJsonValue(jsonValue); return value; } -std::vector +std::vector> ConfigFileJson::getArray(std::string_view key) const { + ASSERT(containsKey(key), "Key {} not found in ConfigFileJson", key); ASSERT(jsonObject_.at(key).is_array(), "Key {} has value that is not an array", key); - std::vector configValues; + std::vector> configValues; auto const arr = jsonObject_.at(key).as_array(); for (auto const& item : arr) { - auto const value = extractJsonValue(item); - configValues.emplace_back(value); + if (item.is_null()) { + configValues.emplace_back(std::nullopt); + } else { + auto value = extractJsonValue(item); + configValues.emplace_back(std::move(value)); + } } return configValues; } @@ -131,38 +142,90 @@ ConfigFileJson::containsKey(std::string_view key) const return jsonObject_.contains(key); } -void -ConfigFileJson::flattenJson(boost::json::object const& obj, std::string const& prefix) +boost::json::object const& +ConfigFileJson::inner() const { - for (auto const& [key, value] : obj) { - std::string const fullKey = prefix.empty() ? std::string(key) : fmt::format("{}.{}", prefix, std::string(key)); + return jsonObject_; +} - // In ClioConfigDefinition, value must be a primitive or array - if (value.is_object()) { - flattenJson(value.as_object(), fullKey); - } else if (value.is_array()) { - auto const& arr = value.as_array(); - for (std::size_t i = 0; i < arr.size(); ++i) { - std::string const arrayPrefix = fullKey + ".[]"; - if (arr[i].is_object()) { - flattenJson(arr[i].as_object(), arrayPrefix); +void +ConfigFileJson::flattenJson(boost::json::object const& jsonRootObject) +{ + struct Task { + boost::json::object const& object; + std::string prefix; + std::optional arrayIndex = std::nullopt; + }; + + std::queue tasks; + tasks.push(Task{.object = jsonRootObject, .prefix = ""}); + + std::unordered_map arraysSizes; + + while (not tasks.empty()) { + auto const task = std::move(tasks.front()); + tasks.pop(); + + for (auto const& [key, value] : task.object) { + auto fullKey = + task.prefix.empty() ? std::string(key) : fmt::format("{}.{}", task.prefix, std::string_view{key}); + + if (value.is_object()) { + tasks.push( + Task{.object = value.as_object(), .prefix = std::move(fullKey), .arrayIndex = task.arrayIndex} + ); + } else if (value.is_array()) { + fullKey += ".[]"; + auto const& array = value.as_array(); + + if (std::ranges::all_of(array, [](auto const& v) { return v.is_primitive(); })) { + jsonObject_[fullKey] = array; + } else if (std::ranges::all_of(array, [](auto const& v) { return v.is_object(); })) { + for (size_t i = 0; i < array.size(); ++i) { + tasks.push(Task{.object = array.at(i).as_object(), .prefix = fullKey, .arrayIndex = i}); + } } else { - jsonObject_[arrayPrefix] = arr; + ASSERT( + false, + "Arrays containing both values and objects are not supported. Please check the array {}", + fullKey + ); } - } - } else { - // if "[]" is present in key, then value must be an array instead of primitive - if (fullKey.contains(".[]") && !jsonObject_.contains(fullKey)) { - boost::json::array newArray; - newArray.emplace_back(value); - jsonObject_[fullKey] = newArray; - } else if (fullKey.contains(".[]") && jsonObject_.contains(fullKey)) { - jsonObject_[fullKey].as_array().emplace_back(value); } else { - jsonObject_[fullKey] = value; + if (task.arrayIndex.has_value()) { + if (not jsonObject_.contains(fullKey)) { + jsonObject_[fullKey] = boost::json::array{}; + } + + auto& targetArray = jsonObject_.at(fullKey).as_array(); + while (targetArray.size() < (*task.arrayIndex + 1)) { + targetArray.push_back(boost::json::value()); + } + targetArray.at(*task.arrayIndex) = value; + auto const prefix = std::string{Array::prefix(fullKey)}; + arraysSizes[prefix] = std::max(arraysSizes[prefix], targetArray.size()); + } else { + jsonObject_[fullKey] = value; + } } } } + + // adjust length of each array containing objects + std::ranges::for_each(jsonObject_, [&arraysSizes](auto& item) { + auto const key = item.key(); + if (not key.contains("[]")) + return; + + auto& value = item.value(); + auto const prefix = std::string{Array::prefix(key)}; + if (auto const it = arraysSizes.find(prefix); it != arraysSizes.end()) { + auto const size = it->second; + while (value.as_array().size() < size) { + value.as_array().push_back(boost::json::value{}); + } + } + }); } } // namespace util::config diff --git a/src/util/newconfig/ConfigFileJson.hpp b/src/util/newconfig/ConfigFileJson.hpp index c208a334b..11eb92e10 100644 --- a/src/util/newconfig/ConfigFileJson.hpp +++ b/src/util/newconfig/ConfigFileJson.hpp @@ -27,7 +27,7 @@ #include #include -#include +#include #include #include @@ -35,6 +35,8 @@ namespace util::config { /** @brief Json representation of config */ class ConfigFileJson final : public ConfigFileInterface { + boost::json::object jsonObject_; + public: /** * @brief Construct a new ConfigJson object and stores the values from @@ -59,7 +61,7 @@ public: * @param key The key of the configuration array to retrieve. * @return A vector of variants holding the config values specified by user. */ - [[nodiscard]] std::vector + [[nodiscard]] std::vector> getArray(std::string_view key) const override; /** @@ -81,20 +83,26 @@ public: [[nodiscard]] static std::expected makeConfigFileJson(std::filesystem::path const& configFilePath); + /** + * @brief Get the inner representation of json file. + * @note This method is mostly used for testing purposes. + * + * @return The inner representation of json file. + */ + [[nodiscard]] boost::json::object const& + inner() const; + private: /** - * @brief Recursive function to flatten a JSON object into the same structure as the Clio Config. + * @brief Method to flatten a JSON object into the same structure as the Clio Config. * - * The keys will end up having the same naming convensions in Clio Config. + * The keys will end up having the same naming conventions in Clio Config. * Other than the keys specified in user Config file, no new keys are created. * * @param obj The JSON object to flatten. - * @param prefix The prefix to use for the keys in the flattened object. */ void - flattenJson(boost::json::object const& obj, std::string const& prefix); - - boost::json::object jsonObject_; + flattenJson(boost::json::object const& jsonRootObject); }; } // namespace util::config diff --git a/src/util/newconfig/ConfigValue.hpp b/src/util/newconfig/ConfigValue.hpp index d68daaa60..3911d2651 100644 --- a/src/util/newconfig/ConfigValue.hpp +++ b/src/util/newconfig/ConfigValue.hpp @@ -31,6 +31,7 @@ #include #include #include +#include #include #include #include @@ -58,13 +59,15 @@ public: * @brief Sets the default value for the config * * @param value The default value + * @param description Optional description to use instead of default generated description * @return Reference to this ConfigValue */ [[nodiscard]] ConfigValue& - defaultValue(Value value) + defaultValue(Value value, std::optional description = std::nullopt) { auto const err = checkTypeConsistency(type_, value); ASSERT(!err.has_value(), "{}", err->error); + description_ = description; value_ = value; return *this; } @@ -81,16 +84,14 @@ public: { auto err = checkTypeConsistency(type_, value); if (err.has_value()) { - if (key.has_value()) - err->error = fmt::format("{} {}", key.value(), err->error); + err->error = fmt::format("{} {}", key.value_or("Unknown_key"), err->error); return err; } if (cons_.has_value()) { auto constraintCheck = cons_->get().checkConstraint(value); if (constraintCheck.has_value()) { - if (key.has_value()) - constraintCheck->error = fmt::format("{} {}", key.value(), constraintCheck->error); + constraintCheck->error = fmt::format("{} {}", key.value_or("Unknown_key"), constraintCheck->error); return constraintCheck; } } @@ -126,7 +127,7 @@ public: [&type](bool tmp) { type = fmt::format("bool {}", tmp); }, [&type](std::string const& tmp) { type = fmt::format("string {}", tmp); }, [&type](double tmp) { type = fmt::format("double {}", tmp); }, - [&type](int64_t tmp) { type = fmt::format("int {}", tmp); } + [&type](int64_t tmp) { type = fmt::format("int {}", tmp); }, }, value_.value() ); @@ -141,7 +142,7 @@ public: * * @return An optional reference to the associated Constraint. */ - [[nodiscard]] std::optional> + [[nodiscard]] constexpr std::optional> getConstraint() const { return cons_; @@ -198,9 +199,37 @@ public: [[nodiscard]] Value const& getValue() const { + ASSERT(value_.has_value(), "getValue() is called when there is no value set"); return value_.value(); } + /** + * @brief Prints all the info of this config value to the output stream. + * + * @param stream The output stream + * @param val The config value to output to osstream + * @return The same ostream we were given + */ + friend std::ostream& + operator<<(std::ostream& stream, ConfigValue val) + { + stream << "- **Required**: " << (val.isOptional() ? "False" : "True") << "\n"; + stream << "- **Type**: " << val.type() << "\n"; + if (val.description_.has_value()) { + stream << "- **Default value**: " << *val.description_ << "\n"; + } else { + stream << "- **Default value**: " << (val.hasValue() ? *val.value_ : "None") << "\n"; + } + stream << "- **Constraints**: "; + + if (val.getConstraint().has_value()) { + stream << val.getConstraint()->get() << "\n"; + } else { + stream << "None" << "\n"; + } + return stream; + } + private: /** * @brief Checks if the value type is consistent with the specified ConfigType @@ -232,6 +261,7 @@ private: bool optional_{false}; std::optional value_; std::optional> cons_; + std::optional description_; }; } // namespace util::config diff --git a/src/util/newconfig/Types.cpp b/src/util/newconfig/Types.cpp new file mode 100644 index 000000000..b8a6330db --- /dev/null +++ b/src/util/newconfig/Types.cpp @@ -0,0 +1,66 @@ +//------------------------------------------------------------------------------ +/* + This file is part of clio: https://github.com/XRPLF/clio + Copyright (c) 2025, the clio developers. + + Permission to use, copy, modify, and distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ +//============================================================================== + +#include "util/newconfig/Types.hpp" + +#include +#include +#include +#include + +namespace util::config { + +std::ostream& +operator<<(std::ostream& stream, ConfigType type) +{ + switch (type) { + case ConfigType::Integer: + stream << "int"; + break; + case ConfigType::String: + stream << "string"; + break; + case ConfigType::Double: + stream << "double"; + break; + case ConfigType::Boolean: + stream << "boolean"; + break; + default: + stream << "unsupported type"; + } + return stream; +} + +std::ostream& +operator<<(std::ostream& stream, Value value) +{ + if (std::holds_alternative(value)) { + stream << std::get(value); + } else if (std::holds_alternative(value)) { + stream << (std::get(value) ? "False" : "True"); + } else if (std::holds_alternative(value)) { + stream << std::get(value); + } else if (std::holds_alternative(value)) { + stream << std::get(value); + } + return stream; +} + +} // namespace util::config diff --git a/src/util/newconfig/Types.hpp b/src/util/newconfig/Types.hpp index 42c9ddffa..5ff744efd 100644 --- a/src/util/newconfig/Types.hpp +++ b/src/util/newconfig/Types.hpp @@ -21,9 +21,12 @@ #include "util/UnsupportedType.hpp" +#include + #include +#include +#include #include -#include #include namespace util::config { @@ -31,9 +34,29 @@ namespace util::config { /** @brief Custom clio config types */ enum class ConfigType { Integer, String, Double, Boolean }; +/** + * @brief Prints the specified config type to output stream + * + * @param stream The output stream + * @param type The config type + * @return The same ostream we were given + */ +std::ostream& +operator<<(std::ostream& stream, ConfigType type); + /** @brief Represents the supported Config Values */ using Value = std::variant; +/** + * @brief Prints the specified value to output stream + * + * @param stream The output stream + * @param value The value type + * @return The same ostream we were given + */ +std::ostream& +operator<<(std::ostream& stream, Value value); + /** * @brief Get the corresponding clio config type * diff --git a/src/util/newconfig/ValueView.hpp b/src/util/newconfig/ValueView.hpp index 078296fa6..d23848542 100644 --- a/src/util/newconfig/ValueView.hpp +++ b/src/util/newconfig/ValueView.hpp @@ -20,6 +20,7 @@ #pragma once #include "util/Assert.hpp" +#include "util/newconfig/ConfigConstraints.hpp" #include "util/newconfig/ConfigValue.hpp" #include "util/newconfig/Types.hpp" @@ -30,6 +31,7 @@ #include #include #include +#include #include #include #include @@ -141,6 +143,17 @@ public: return configVal_.get().isOptional(); } + /** + * @brief Retrieves the constraint associated with the ConfigValue in this ValueView, if any. + * + * @return An optional reference to the associated Constraint + */ + [[nodiscard]] constexpr std::optional> + getConstraint() const + { + return configVal_.get().getConstraint(); + } + /** * @brief Retrieves the stored value as the specified type T * @@ -186,6 +199,20 @@ public: return std::make_optional(getValueImpl()); } + /** + * @brief Custom output stream for ValueView + * + * @param stream The output stream + * @param value The ValueView + * @return The same ostream we were given + */ + friend std::ostream& + operator<<(std::ostream& stream, ValueView value) + { + stream << value.configVal_; + return stream; + } + private: std::reference_wrapper configVal_; }; diff --git a/src/web/ng/RPCServerHandler.hpp b/src/web/ng/RPCServerHandler.hpp index 5865748f9..f8dbcb183 100644 --- a/src/web/ng/RPCServerHandler.hpp +++ b/src/web/ng/RPCServerHandler.hpp @@ -54,7 +54,6 @@ #include #include #include -#include #include #include @@ -118,7 +117,7 @@ public: { std::optional response; util::CoroutineGroup coroutineGroup{yield, 1}; - auto const onTaskComplete = coroutineGroup.registerForeign(); + auto const onTaskComplete = coroutineGroup.registerForeign(yield); ASSERT(onTaskComplete.has_value(), "Coroutine group can't be full"); bool const postSuccessful = rpcEngine_->post( @@ -127,28 +126,34 @@ public: &response, &onTaskComplete = onTaskComplete.value(), &connectionMetadata, - subscriptionContext = std::move(subscriptionContext)](boost::asio::yield_context yield) mutable { + subscriptionContext = std::move(subscriptionContext)](boost::asio::yield_context innerYield) mutable { try { - auto parsedRequest = boost::json::parse(request.message()).as_object(); - LOG(perfLog_.debug()) << connectionMetadata.tag() << "Adding to work queue"; + boost::system::error_code ec; + auto parsedRequest = boost::json::parse(request.message(), ec); + if (ec.failed() or not parsedRequest.is_object()) { + rpcEngine_->notifyBadSyntax(); + response = impl::ErrorHelper{request}.makeJsonParsingError(); + if (ec.failed()) { + LOG(log_.warn()) + << "Error parsing JSON: " << ec.message() << ". For request: " << request.message(); + } else { + LOG(log_.warn()) << "Received not a JSON object. For request: " << request.message(); + } + } else { + auto parsedObject = std::move(parsedRequest).as_object(); + LOG(perfLog_.debug()) << connectionMetadata.tag() << "Adding to work queue"; - if (not connectionMetadata.wasUpgraded() and shouldReplaceParams(parsedRequest)) - parsedRequest[JS(params)] = boost::json::array({boost::json::object{}}); + if (not connectionMetadata.wasUpgraded() and shouldReplaceParams(parsedObject)) + parsedObject[JS(params)] = boost::json::array({boost::json::object{}}); - response = handleRequest( - yield, request, std::move(parsedRequest), connectionMetadata, std::move(subscriptionContext) - ); - } catch (boost::system::system_error const& ex) { - // system_error thrown when json parsing failed - rpcEngine_->notifyBadSyntax(); - response = impl::ErrorHelper{request}.makeJsonParsingError(); - LOG(log_.warn()) << "Error parsing JSON: " << ex.what() << ". For request: " << request.message(); - } catch (std::invalid_argument const& ex) { - // thrown when json parses something that is not an object at top level - rpcEngine_->notifyBadSyntax(); - LOG(log_.warn()) << "Invalid argument error: " << ex.what() - << ". For request: " << request.message(); - response = impl::ErrorHelper{request}.makeJsonParsingError(); + response = handleRequest( + innerYield, + request, + std::move(parsedObject), + connectionMetadata, + std::move(subscriptionContext) + ); + } } catch (std::exception const& ex) { LOG(perfLog_.error()) << connectionMetadata.tag() << "Caught exception: " << ex.what(); rpcEngine_->notifyInternalError(); diff --git a/src/web/ng/Server.cpp b/src/web/ng/Server.cpp index f86470486..a209fea35 100644 --- a/src/web/ng/Server.cpp +++ b/src/web/ng/Server.cpp @@ -363,7 +363,8 @@ makeServer( auto const maxSubscriptionSendQueueSize = serverConfig.get("ws_max_sending_queue_size"); - return Server{ + return std::expected{ + std::in_place, context, std::move(endpoint).value(), std::move(expectedSslContext).value(), diff --git a/src/web/ng/Server.hpp b/src/web/ng/Server.hpp index f719b8dd2..188f6a883 100644 --- a/src/web/ng/Server.hpp +++ b/src/web/ng/Server.hpp @@ -116,9 +116,9 @@ public: Server(Server const&) = delete; /** - * @brief Move constructor is defaulted. + * @brief Move constructor is deleted because connectionHandler_ contains references to some fields of the Server. */ - Server(Server&&) = default; + Server(Server&&) = delete; /** * @brief Set handler for GET requests. diff --git a/src/web/ng/impl/ConnectionHandler.cpp b/src/web/ng/impl/ConnectionHandler.cpp index 0f2cd50d3..adfd8bc12 100644 --- a/src/web/ng/impl/ConnectionHandler.cpp +++ b/src/web/ng/impl/ConnectionHandler.cpp @@ -294,14 +294,13 @@ ConnectionHandler::sequentRequestResponseLoop( LOG(log_.trace()) << connection.tag() << "Processing sequentially"; while (true) { - auto expectedRequest = connection.receive(yield); + auto const expectedRequest = connection.receive(yield); if (not expectedRequest) return handleError(expectedRequest.error(), connection); LOG(log_.info()) << connection.tag() << "Received request from ip = " << connection.ip(); - auto maybeReturnValue = - processRequest(connection, subscriptionContext, std::move(expectedRequest).value(), yield); + auto maybeReturnValue = processRequest(connection, subscriptionContext, expectedRequest.value(), yield); if (maybeReturnValue.has_value()) return maybeReturnValue.value(); } diff --git a/src/web/ng/impl/ConnectionHandler.hpp b/src/web/ng/impl/ConnectionHandler.hpp index b3f17416a..cc1fc6417 100644 --- a/src/web/ng/impl/ConnectionHandler.hpp +++ b/src/web/ng/impl/ConnectionHandler.hpp @@ -100,6 +100,8 @@ public: OnDisconnectHook onDisconnectHook ); + ConnectionHandler(ConnectionHandler&&) = delete; + static constexpr std::chrono::milliseconds kCLOSE_CONNECTION_TIMEOUT{500}; void diff --git a/tests/common/CMakeLists.txt b/tests/common/CMakeLists.txt index e0c577180..ed174da1f 100644 --- a/tests/common/CMakeLists.txt +++ b/tests/common/CMakeLists.txt @@ -2,7 +2,8 @@ add_library(clio_testing_common) target_sources( clio_testing_common - PRIVATE util/AssignRandomPort.cpp + PRIVATE util/MockAssert.cpp + util/AssignRandomPort.cpp util/CallWithTimeout.cpp util/StringUtils.cpp util/TestHttpClient.cpp diff --git a/tests/common/feed/FeedTestUtil.hpp b/tests/common/feed/FeedTestUtil.hpp index 320c2d59b..adb3974eb 100644 --- a/tests/common/feed/FeedTestUtil.hpp +++ b/tests/common/feed/FeedTestUtil.hpp @@ -19,6 +19,7 @@ #pragma once +#include "util/MockAmendmentCenter.hpp" #include "util/MockBackendTestFixture.hpp" #include "util/MockPrometheus.hpp" #include "util/MockWsBase.hpp" @@ -43,9 +44,10 @@ protected: web::SubscriptionContextPtr sessionPtr = std::make_shared(); std::shared_ptr testFeedPtr = std::make_shared(ctx_); MockSession* mockSessionPtr = dynamic_cast(sessionPtr.get()); + StrictMockAmendmentCenterSharedPtr mockAmendmentCenterPtr_; }; -namespace impl { +namespace feed::impl { class SharedStringJsonEqMatcher { std::string expected_; @@ -74,12 +76,12 @@ public: *os << "Expecting json " << expected_; } }; -} // namespace impl +} // namespace feed::impl // NOLINTEND(readability-identifier-naming) inline ::testing::Matcher> sharedStringJsonEq(std::string const& expected) { - return impl::SharedStringJsonEqMatcher(expected); + return feed::impl::SharedStringJsonEqMatcher(expected); } diff --git a/tests/common/util/MockAssert.cpp b/tests/common/util/MockAssert.cpp new file mode 100644 index 000000000..055096f9f --- /dev/null +++ b/tests/common/util/MockAssert.cpp @@ -0,0 +1,45 @@ +//------------------------------------------------------------------------------ +/* + This file is part of clio: https://github.com/XRPLF/clio + Copyright (c) 2025, the clio developers. + + Permission to use, copy, modify, and distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ +//============================================================================== + +#include "util/MockAssert.hpp" + +#include "util/Assert.hpp" + +#include +#include + +namespace common::util { + +WithMockAssert::WithMockAssert() +{ + ::util::impl::OnAssert::setAction([](std::string_view m) { WithMockAssert::throwOnAssert(m); }); +} + +WithMockAssert::~WithMockAssert() +{ + ::util::impl::OnAssert::resetAction(); +} + +void +WithMockAssert::throwOnAssert(std::string_view m) +{ + throw MockAssertException{.message = std::string{m}}; +} + +} // namespace common::util diff --git a/tests/common/util/MockAssert.hpp b/tests/common/util/MockAssert.hpp new file mode 100644 index 000000000..0a1741140 --- /dev/null +++ b/tests/common/util/MockAssert.hpp @@ -0,0 +1,59 @@ +//------------------------------------------------------------------------------ +/* + This file is part of clio: https://github.com/XRPLF/clio + Copyright (c) 2025, the clio developers. + + Permission to use, copy, modify, and distribute this software for any + purpose with or without fee is hereby granted, provided that the above + copyright notice and this permission notice appear in all copies. + + THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES + WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF + MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR + ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES + WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN + ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF + OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. +*/ +//============================================================================== + +#pragma once + +#include +#include + +#include +#include + +namespace common::util { + +class WithMockAssert : virtual public testing::Test { +public: + struct MockAssertException { + std::string message; + }; + + WithMockAssert(); + ~WithMockAssert() override; + +private: + static void + throwOnAssert(std::string_view m); +}; + +} // namespace common::util + +#define EXPECT_CLIO_ASSERT_FAIL(statement) EXPECT_THROW(statement, MockAssertException) + +#define EXPECT_CLIO_ASSERT_FAIL_WITH_MESSAGE(statement, message_regex) \ + EXPECT_THROW( \ + { \ + try { \ + statement; \ + } catch (common::util::WithMockAssert::MockAssertException const& e) { \ + EXPECT_THAT(e.message, testing::ContainsRegex(message_regex)); \ + throw; \ + } \ + }, \ + common::util::WithMockAssert::MockAssertException \ + ) diff --git a/tests/common/util/MockNetworkValidatedLedgers.hpp b/tests/common/util/MockNetworkValidatedLedgers.hpp index 3371c67ca..5af4d850c 100644 --- a/tests/common/util/MockNetworkValidatedLedgers.hpp +++ b/tests/common/util/MockNetworkValidatedLedgers.hpp @@ -19,8 +19,9 @@ #pragma once -#include "etl/ETLHelpers.hpp" +#include "etl/NetworkValidatedLedgersInterface.hpp" +#include #include #include @@ -31,6 +32,12 @@ struct MockNetworkValidatedLedgers : public etl::NetworkValidatedLedgersInterfac MOCK_METHOD(void, push, (uint32_t), (override)); MOCK_METHOD(std::optional, getMostRecent, (), (override)); MOCK_METHOD(bool, waitUntilValidatedByNetwork, (uint32_t, std::optional), (override)); + MOCK_METHOD( + boost::signals2::scoped_connection, + subscribe, + (etl::NetworkValidatedLedgersInterface::SignalType::slot_type const& subscriber), + (override) + ); }; template