diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json new file mode 100644 index 000000000..c92d1a789 --- /dev/null +++ b/.devcontainer/devcontainer.json @@ -0,0 +1,33 @@ +{ + "name": "OpenFeature .NET SDK", + "image": "mcr.microsoft.com/devcontainers/dotnet:9.0-bookworm", + "features": { + "ghcr.io/devcontainers/features/dotnet:latest": { + "version": "9.0", + "additionalVersions": "8.0" + }, + "ghcr.io/devcontainers/features/github-cli:latest": {}, + "ghcr.io/devcontainers/features/docker-in-docker": {} + }, + "customizations": { + "vscode": { + "extensions": [ + "EditorConfig.EditorConfig", + "GitHub.copilot", + "GitHub.copilot-chat", + "GitHub.vscode-github-actions", + "GitHub.vscode-pull-request-github", + "ms-dotnettools.csharp", + "esbenp.prettier-vscode", + "redhat.vscode-yaml", + "cucumberopen.cucumber-official", + "ms-dotnettools.csdevkit" + ] + } + }, + "remoteUser": "vscode", + "hostRequirements": { + "memory": "8gb" + }, + "postCreateCommand": "git submodule update --init --recursive" +} diff --git a/.github/actions/sbom-generator/action.yml b/.github/actions/sbom-generator/action.yml index 0af8c2c47..9d27d486b 100644 --- a/.github/actions/sbom-generator/action.yml +++ b/.github/actions/sbom-generator/action.yml @@ -35,7 +35,7 @@ runs: gh release upload ${{ inputs.release-tag }} ./artifacts/sboms/${{ inputs.project-name }}.bom.json - name: Attest package - uses: actions/attest-sbom@115c3be05ff3974bcbd596578934b3f9ce39bf68 # v2.2.0 + uses: actions/attest-sbom@4651f806c01d8637787e274ac3bdf724ef169f34 # v3.0.0 with: subject-path: src/**/${{ inputs.project-name }}.*.nupkg sbom-path: ./artifacts/sboms/${{ inputs.project-name }}.bom.json diff --git a/.github/workflows/aot-compatibility.yml b/.github/workflows/aot-compatibility.yml new file mode 100644 index 000000000..76e16c246 --- /dev/null +++ b/.github/workflows/aot-compatibility.yml @@ -0,0 +1,95 @@ +name: AOT Compatibility + +on: + push: + branches: [main] + pull_request: + branches: [main] + merge_group: + workflow_dispatch: + +jobs: + aot-compatibility: + name: AOT Test (${{ matrix.os }}, ${{ matrix.arch }}) + permissions: + contents: read + strategy: + fail-fast: false + matrix: + include: + # Linux x64 + - os: ubuntu-latest + arch: x64 + runtime: linux-x64 + # Linux ARM64 + - os: ubuntu-24.04-arm + arch: arm64 + runtime: linux-arm64 + # Windows x64 + - os: windows-latest + arch: x64 + runtime: win-x64 + # Windows ARM64 + - os: windows-11-arm + arch: arm64 + runtime: win-arm64 + # macOS x64 + - os: macos-13 + arch: x64 + runtime: osx-x64 + # macOS ARM64 (Apple Silicon) + - os: macos-latest + arch: arm64 + runtime: osx-arm64 + + runs-on: ${{ matrix.os }} + + steps: + - name: Checkout + uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 + with: + fetch-depth: 0 + submodules: recursive + + - name: Setup .NET SDK + uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5 + with: + global-json-file: global.json + + - name: Cache NuGet packages + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 + with: + path: ~/.nuget/packages + key: ${{ runner.os }}-${{ matrix.arch }}-nuget-${{ hashFiles('**/*.csproj', 'Directory.Packages.props', 'global.json') }} + restore-keys: | + ${{ runner.os }}-${{ matrix.arch }}-nuget- + ${{ runner.os }}-nuget- + + - name: Restore dependencies + shell: pwsh + run: dotnet restore + + - name: Build solution + shell: pwsh + run: dotnet build -c Release --no-restore + + - name: Test AOT compatibility project build + shell: pwsh + run: dotnet build test/OpenFeature.AotCompatibility/OpenFeature.AotCompatibility.csproj -c Release --no-restore + + - name: Publish AOT compatibility test (cross-platform) + shell: pwsh + run: | + dotnet publish test/OpenFeature.AotCompatibility/OpenFeature.AotCompatibility.csproj ` + -r ${{ matrix.runtime }} ` + -o ./aot-output + + - name: Run AOT compatibility test + shell: pwsh + run: | + if ("${{ runner.os }}" -eq "Windows") { + ./aot-output/OpenFeature.AotCompatibility.exe + } else { + chmod +x ./aot-output/OpenFeature.AotCompatibility + ./aot-output/OpenFeature.AotCompatibility + } diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index bb1c72273..f62e3cd44 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -23,18 +23,23 @@ jobs: steps: - name: Checkout - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 submodules: recursive - name: Setup .NET SDK - uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4 - env: - NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5 with: global-json-file: global.json - source-url: https://nuget.pkg.github.com/open-feature/index.json + + - name: Cache NuGet packages + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 + with: + path: ~/.nuget/packages + key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', 'Directory.Packages.props', 'global.json') }} + restore-keys: | + ${{ runner.os }}-nuget- - name: Restore run: dotnet restore @@ -45,6 +50,10 @@ jobs: - name: Test run: dotnet test -c Release --no-build --logger GitHubActions + - name: aot-publish test + run: | + dotnet publish ./samples/AspNetCore/Samples.AspNetCore.csproj + packaging: needs: build @@ -58,18 +67,23 @@ jobs: steps: - name: Checkout - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 submodules: recursive - name: Setup .NET SDK - uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4 - env: - NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5 with: global-json-file: global.json - source-url: https://nuget.pkg.github.com/open-feature/index.json + + - name: Cache NuGet packages + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 + with: + path: ~/.nuget/packages + key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', 'Directory.Packages.props', 'global.json') }} + restore-keys: | + ${{ runner.os }}-nuget- - name: Restore run: dotnet restore diff --git a/.github/workflows/code-coverage.yml b/.github/workflows/code-coverage.yml index fc7c37f5c..e6c2518c0 100644 --- a/.github/workflows/code-coverage.yml +++ b/.github/workflows/code-coverage.yml @@ -22,22 +22,27 @@ jobs: runs-on: ${{ matrix.os }} steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 - name: Setup .NET SDK - uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4 - env: - NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5 with: global-json-file: global.json - source-url: https://nuget.pkg.github.com/open-feature/index.json + + - name: Cache NuGet packages + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 + with: + path: ~/.nuget/packages + key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', 'Directory.Packages.props', 'global.json') }} + restore-keys: | + ${{ runner.os }}-nuget- - name: Run Test run: dotnet test --verbosity normal /p:CollectCoverage=true /p:CoverletOutputFormat=opencover - - uses: codecov/codecov-action@18283e04ce6e62d37312384ff67231eb8fd56d24 # v5.4.3 + - uses: codecov/codecov-action@5a1091511ad55cbe89839c7260b706298ca349f7 # v5.5.1 with: name: Code Coverage for ${{ matrix.os }} fail_ci_if_error: true diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 2f4645ece..74378bfc9 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -38,11 +38,11 @@ jobs: steps: - name: Checkout repository - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 # Initializes the CodeQL tools for scanning. - name: Initialize CodeQL - uses: github/codeql-action/init@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3 + uses: github/codeql-action/init@f443b600d91635bebf5b0d9ebc620189c0d6fba5 # v4 with: languages: ${{ matrix.language }} # If you wish to specify custom queries, you can do so here or in a config file. @@ -56,7 +56,7 @@ jobs: # Autobuild attempts to build any compiled languages (C/C++, C#, or Java). # If this step fails, then you should remove it and run the build manually (see below) - name: Autobuild - uses: github/codeql-action/autobuild@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3 + uses: github/codeql-action/autobuild@f443b600d91635bebf5b0d9ebc620189c0d6fba5 # v4 # โ„น๏ธ Command-line programs to run using the OS shell. # ๐Ÿ“š See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun @@ -69,4 +69,4 @@ jobs: # ./location_of_script_within_repo/buildscript.sh - name: Perform CodeQL Analysis - uses: github/codeql-action/analyze@ff0a06e83cb2de871e5a09832bc6a81e7276941f # v3 + uses: github/codeql-action/analyze@f443b600d91635bebf5b0d9ebc620189c0d6fba5 # v4 diff --git a/.github/workflows/dotnet-format.yml b/.github/workflows/dotnet-format.yml index e35e37756..f7857ea64 100644 --- a/.github/workflows/dotnet-format.yml +++ b/.github/workflows/dotnet-format.yml @@ -15,12 +15,14 @@ jobs: steps: - name: Check out code - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 - name: Setup .NET SDK - uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4 + uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5 with: global-json-file: global.json - name: dotnet format - run: dotnet format --verify-no-changes OpenFeature.slnx + run: | + # Exclude diagnostics to work around dotnet-format issue, see https://github.com/dotnet/sdk/issues/50012 + dotnet format --verify-no-changes OpenFeature.slnx --exclude-diagnostics IL2026 --exclude-diagnostics IL3050 diff --git a/.github/workflows/e2e.yml b/.github/workflows/e2e.yml index ae0ca8391..da2edad27 100644 --- a/.github/workflows/e2e.yml +++ b/.github/workflows/e2e.yml @@ -17,17 +17,22 @@ jobs: contents: read pull-requests: write steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 - name: Setup .NET SDK - uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4 - env: - NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5 with: global-json-file: global.json - source-url: https://nuget.pkg.github.com/open-feature/index.json + + - name: Cache NuGet packages + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 + with: + path: ~/.nuget/packages + key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', 'Directory.Packages.props', 'global.json') }} + restore-keys: | + ${{ runner.os }}-nuget- - name: Initialize Tests run: | diff --git a/.github/workflows/lint-pr.yml b/.github/workflows/lint-pr.yml index f23079276..2aad982e7 100644 --- a/.github/workflows/lint-pr.yml +++ b/.github/workflows/lint-pr.yml @@ -12,9 +12,31 @@ jobs: name: Validate PR title runs-on: ubuntu-latest permissions: - contents: read pull-requests: write steps: - - uses: amannn/action-semantic-pull-request@0723387faaf9b38adef4775cd42cfd5155ed6017 # v5 + - uses: amannn/action-semantic-pull-request@48f256284bd46cdaab1048c3721360e808335d50 # v6 + id: lint_pr_title env: GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + + - uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2 + # When the previous steps fails, the workflow would stop. By adding this + # condition you can continue the execution with the populated error message. + if: always() && (steps.lint_pr_title.outputs.error_message != null) + with: + header: pr-title-lint-error + message: | + Hey there and thank you for opening this pull request! ๐Ÿ‘‹๐Ÿผ + + We require pull request titles to follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and it looks like your proposed title needs to be adjusted. + Details: + + ``` + ${{ steps.lint_pr_title.outputs.error_message }} + ``` + # Delete a previous comment when the issue has been resolved + - if: ${{ steps.lint_pr_title.outputs.error_message == null }} + uses: marocchino/sticky-pull-request-comment@773744901bac0e8cbb5a0dc842800d45e9b2b405 # v2 + with: + header: pr-title-lint-error + delete: true diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 47898d387..caf7f9e6f 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -19,7 +19,7 @@ jobs: runs-on: ubuntu-latest steps: - - uses: googleapis/release-please-action@a02a34c4d625f9be7cb89156071d8567266a2445 #v4 + - uses: googleapis/release-please-action@c2a5a2bd6a758a0937f1ddb1e8950609867ed15c # v4 id: release with: token: ${{secrets.RELEASE_PLEASE_ACTION_TOKEN}} @@ -32,24 +32,29 @@ jobs: runs-on: ubuntu-latest needs: release-please permissions: - id-token: write + id-token: write # enable GitHub OIDC token issuance for this job (NuGet login) contents: write # for SBOM release attestations: write # for actions/attest-sbom to create attestation packages: read # for internal nuget reading if: ${{ fromJSON(needs.release-please.outputs.release_created || false) }} steps: - - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + - uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5 with: fetch-depth: 0 - name: Setup .NET SDK - uses: actions/setup-dotnet@67a3573c9a986a3f9c594539f4ab511d57bb3ce9 # v4 - env: - NUGET_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }} + uses: actions/setup-dotnet@d4c94342e560b34958eacfc5d055d21461ed1c5d # v5 with: global-json-file: global.json - source-url: https://nuget.pkg.github.com/open-feature/index.json + + - name: Cache NuGet packages + uses: actions/cache@0057852bfaa89a56745cba8c7296529d2fc39830 # v4.3.0 + with: + path: ~/.nuget/packages + key: ${{ runner.os }}-nuget-${{ hashFiles('**/*.csproj', 'Directory.Packages.props', 'global.json') }} + restore-keys: | + ${{ runner.os }}-nuget- - name: Install dependencies run: dotnet restore @@ -57,11 +62,18 @@ jobs: - name: Pack run: dotnet pack -c Release --no-restore + # Get a short-lived NuGet API key + - name: NuGet login (OIDC โ†’ temp API key) + uses: NuGet/login@d22cc5f58ff5b88bf9bd452535b4335137e24544 # v1 + id: login + with: + user: ${{secrets.NUGET_USER}} + - name: Publish to Nuget - run: dotnet nuget push "src/**/*.nupkg" --api-key "${{ secrets.NUGET_TOKEN }}" --source https://api.nuget.org/v3/index.json + run: dotnet nuget push "src/**/*.nupkg" --api-key "${{ steps.login.outputs.NUGET_API_KEY }}" --source https://api.nuget.org/v3/index.json - name: Generate artifact attestation - uses: actions/attest-build-provenance@db473fddc028af60658334401dc6fa3ffd8669fd # v2.3.0 + uses: actions/attest-build-provenance@977bb373ede98d70efdf65b84cb5f73e068dcc2a # v3.0.0 with: subject-path: "src/**/*.nupkg" @@ -88,3 +100,11 @@ jobs: github-token: ${{secrets.GITHUB_TOKEN}} project-name: OpenFeature.DependencyInjection release-tag: ${{ needs.release-please.outputs.release_tag_name }} + + # Process OpenFeature.Providers.MultiProvider project + - name: Generate and Attest SBOM for OpenFeature.Providers.MultiProvider + uses: ./.github/actions/sbom-generator + with: + github-token: ${{secrets.GITHUB_TOKEN}} + project-name: OpenFeature.Providers.MultiProvider + release-tag: ${{ needs.release-please.outputs.release_tag_name }} diff --git a/.gitignore b/.gitignore index 055ffe50f..c77e4f530 100644 --- a/.gitignore +++ b/.gitignore @@ -8,7 +8,6 @@ *.user *.userosscache *.sln.docstates -.devcontainer/ # User-specific files (MonoDevelop/Xamarin Studio) *.userprefs diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 69e82f12f..a3906fc08 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "2.6.0" + ".": "2.9.0" } diff --git a/CHANGELOG.md b/CHANGELOG.md index e06ef65bb..bdbe5b608 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,112 @@ # Changelog +## [2.9.0](https://github.com/open-feature/dotnet-sdk/compare/v2.8.1...v2.9.0) (2025-10-16) + + +### ๐Ÿ› Bug Fixes + +* update provider status to Fatal during disposal ([#580](https://github.com/open-feature/dotnet-sdk/issues/580)) ([76bd94b](https://github.com/open-feature/dotnet-sdk/commit/76bd94b03ea19ad3c432a52dd644317e362b99ec)) + + +### โœจ New Features + +* Add events to the multi provider ([#568](https://github.com/open-feature/dotnet-sdk/issues/568)) ([9d8ab03](https://github.com/open-feature/dotnet-sdk/commit/9d8ab037df1749d098f5e1e210f71cf9d1e7adff)) +* Add multi-provider support ([#488](https://github.com/open-feature/dotnet-sdk/issues/488)) ([7237053](https://github.com/open-feature/dotnet-sdk/commit/7237053561d9c36194197169734522f0b978f6e5)) +* Deprecate AddHostedFeatureLifecycle method ([#531](https://github.com/open-feature/dotnet-sdk/issues/531)) ([fdf2297](https://github.com/open-feature/dotnet-sdk/commit/fdf229737118639d323e74cceac490d44c4c24dd)) +* Implement hooks in multi provider ([#594](https://github.com/open-feature/dotnet-sdk/issues/594)) ([95ae7f0](https://github.com/open-feature/dotnet-sdk/commit/95ae7f03249e351c20ccd6152d88400a7e1ef764)) +* Support retrieving numeric metadata as either integers or decimals ([#490](https://github.com/open-feature/dotnet-sdk/issues/490)) ([12de5f1](https://github.com/open-feature/dotnet-sdk/commit/12de5f10421bac749fdd45c748e7b970f3f69a39)) + + +### ๐Ÿš€ Performance + +* Add NativeAOT Support ([#554](https://github.com/open-feature/dotnet-sdk/issues/554)) ([acd0486](https://github.com/open-feature/dotnet-sdk/commit/acd0486563f7b67a782ee169315922fb5d0f343e)) + +## [2.8.1](https://github.com/open-feature/dotnet-sdk/compare/v2.8.0...v2.8.1) (2025-07-31) + + +### ๐Ÿ› Bug Fixes + +* expose ValueJsonConverter for generator support and add JsonSourceGenerator test cases ([#537](https://github.com/open-feature/dotnet-sdk/issues/537)) ([e03aeba](https://github.com/open-feature/dotnet-sdk/commit/e03aeba0f515f668afaba0a3c6f0ea01b44d6ee4)) + +## [2.8.0](https://github.com/open-feature/dotnet-sdk/compare/v2.7.0...v2.8.0) (2025-07-30) + + +### ๐Ÿ› Bug Fixes + +* update DI lifecycle to use container instead of static instance ([#534](https://github.com/open-feature/dotnet-sdk/issues/534)) ([1a3846d](https://github.com/open-feature/dotnet-sdk/commit/1a3846d7575e75b5d7d05ec2a7db0b0f82c7b274)) + + +### โœจ New Features + +* Add Hook Dependency Injection extension method with Hook instance ([#513](https://github.com/open-feature/dotnet-sdk/issues/513)) ([12396b7](https://github.com/open-feature/dotnet-sdk/commit/12396b7872a2db6533b33267cf9c299248c41472)) +* Add TraceEnricherHookOptions Custom Attributes ([#526](https://github.com/open-feature/dotnet-sdk/issues/526)) ([5a91005](https://github.com/open-feature/dotnet-sdk/commit/5a91005c888c8966145eae7745cc40b2b066f343)) +* Add Track method to IFeatureClient ([#519](https://github.com/open-feature/dotnet-sdk/issues/519)) ([2e70072](https://github.com/open-feature/dotnet-sdk/commit/2e7007277e19a0fbc4c4c3944d24eea1608712e6)) +* Support JSON Serialize for Value ([#529](https://github.com/open-feature/dotnet-sdk/issues/529)) ([6e521d2](https://github.com/open-feature/dotnet-sdk/commit/6e521d25c3dd53c45f2fd30f5319cae5cd2ff46d)) +* Add Metric Hook Custom Attributes ([#512](https://github.com/open-feature/dotnet-sdk/issues/512)) ([8c05d1d](https://github.com/open-feature/dotnet-sdk/commit/8c05d1d7363db89b8379e1a4e46e455f210888e2)) + + +### ๐Ÿงน Chore + +* Add comparison to Value ([#523](https://github.com/open-feature/dotnet-sdk/issues/523)) ([883f4f3](https://github.com/open-feature/dotnet-sdk/commit/883f4f3c8b553dc01b5accdbae2782ca7805e8ed)) +* **deps:** update github/codeql-action digest to 181d5ee ([#520](https://github.com/open-feature/dotnet-sdk/issues/520)) ([40bec0d](https://github.com/open-feature/dotnet-sdk/commit/40bec0d51b6fa782a8b6d90a3d84463f9fb73c1b)) +* **deps:** update github/codeql-action digest to 4e828ff ([#532](https://github.com/open-feature/dotnet-sdk/issues/532)) ([20d1f37](https://github.com/open-feature/dotnet-sdk/commit/20d1f37a4f8991419bb14dae7eec9a08c2b32bc6)) +* **deps:** update github/codeql-action digest to d6bbdef ([#527](https://github.com/open-feature/dotnet-sdk/issues/527)) ([03d3b9e](https://github.com/open-feature/dotnet-sdk/commit/03d3b9e5d6ff1706faffc25afeba80a0e2bb37ec)) +* **deps:** update spec digest to 224b26e ([#521](https://github.com/open-feature/dotnet-sdk/issues/521)) ([fbc2645](https://github.com/open-feature/dotnet-sdk/commit/fbc2645efd649c0c37bd1a1cf473fbd98d920948)) +* **deps:** update spec digest to baec39b ([#528](https://github.com/open-feature/dotnet-sdk/issues/528)) ([a0ae014](https://github.com/open-feature/dotnet-sdk/commit/a0ae014d3194fcf6e5e5e4a17a2f92b1df3dc7c7)) +* remove redundant rule (now in parent) ([929fa74](https://github.com/open-feature/dotnet-sdk/commit/929fa7497197214d385eeaa40aba008932d00896)) + + +### ๐Ÿ“š Documentation + +* fix anchor link in readme ([#525](https://github.com/open-feature/dotnet-sdk/issues/525)) ([18705c7](https://github.com/open-feature/dotnet-sdk/commit/18705c7338a0c89f163f808c81e513a029c95239)) +* remove curly brace from readme ([8c92524](https://github.com/open-feature/dotnet-sdk/commit/8c92524edbf4579d4ad62c699b338b9811a783fd)) + + +### ๐Ÿ”„ Refactoring + +* Simplify Provider Repository ([#515](https://github.com/open-feature/dotnet-sdk/issues/515)) ([2547a57](https://github.com/open-feature/dotnet-sdk/commit/2547a574e0d0328f909b7e69f3775d07492de3dd)) + +## [2.7.0](https://github.com/open-feature/dotnet-sdk/compare/v2.6.0...v2.7.0) (2025-07-03) + + +### ๐Ÿ› Bug Fixes + +* Add generic to evaluation event builder ([#500](https://github.com/open-feature/dotnet-sdk/issues/500)) ([68af649](https://github.com/open-feature/dotnet-sdk/commit/68af6493b09d29be5d4cdda9e6f792ee8667bf4f)) +* ArgumentNullException when creating a client with optional name ([#508](https://github.com/open-feature/dotnet-sdk/issues/508)) ([9151dcd](https://github.com/open-feature/dotnet-sdk/commit/9151dcdf2cecde9b4b01f06c73d149e0ad3bb539)) + + +### โœจ New Features + +* Move OTEL hooks to the SDK ([#338](https://github.com/open-feature/dotnet-sdk/issues/338)) ([77f6e1b](https://github.com/open-feature/dotnet-sdk/commit/77f6e1bbb76973e078c1999ad0784c9edc9def96)) + + +### ๐Ÿงน Chore + +* **deps:** update actions/attest-build-provenance action to v2.4.0 ([#495](https://github.com/open-feature/dotnet-sdk/issues/495)) ([349c073](https://github.com/open-feature/dotnet-sdk/commit/349c07301d0ff97c759417344eef74a00b06edbc)) +* **deps:** update actions/attest-sbom action to v2.4.0 ([#496](https://github.com/open-feature/dotnet-sdk/issues/496)) ([f7ca416](https://github.com/open-feature/dotnet-sdk/commit/f7ca4163e0ce549a015a7a27cb184fb76a199a04)) +* **deps:** update dependency benchmarkdotnet to 0.15.0 ([#481](https://github.com/open-feature/dotnet-sdk/issues/481)) ([714425d](https://github.com/open-feature/dotnet-sdk/commit/714425d405a33231e85b1e62019fc678b2e883ef)) +* **deps:** update dependency benchmarkdotnet to 0.15.2 ([#494](https://github.com/open-feature/dotnet-sdk/issues/494)) ([cab3807](https://github.com/open-feature/dotnet-sdk/commit/cab380727fe95b941384ae71f022626cdf23db53)) +* **deps:** update dependency microsoft.net.test.sdk to 17.14.0 ([#482](https://github.com/open-feature/dotnet-sdk/issues/482)) ([520d383](https://github.com/open-feature/dotnet-sdk/commit/520d38305c6949c88b057f28e5dfe3305257e437)) +* **deps:** update dependency microsoft.net.test.sdk to 17.14.1 ([#485](https://github.com/open-feature/dotnet-sdk/issues/485)) ([78bfdbf](https://github.com/open-feature/dotnet-sdk/commit/78bfdbf0850e2d5eb80cfbae3bfac8208f6c45b1)) +* **deps:** update dependency opentelemetry.instrumentation.aspnetcore to 1.12.0 ([#505](https://github.com/open-feature/dotnet-sdk/issues/505)) ([241d880](https://github.com/open-feature/dotnet-sdk/commit/241d88024ff13ddd57f4e9c5719add95b5864043)) +* **deps:** update dependency reqnroll.xunit to 2.4.1 ([#483](https://github.com/open-feature/dotnet-sdk/issues/483)) ([99f7584](https://github.com/open-feature/dotnet-sdk/commit/99f7584c91882ba59412e2306167172470cd4677)) +* **deps:** update dependency system.valuetuple to 4.6.1 ([#503](https://github.com/open-feature/dotnet-sdk/issues/503)) ([39f884d](https://github.com/open-feature/dotnet-sdk/commit/39f884df420f1a9346852159948c288e728672b8)) +* **deps:** update github/codeql-action digest to 39edc49 ([#504](https://github.com/open-feature/dotnet-sdk/issues/504)) ([08ff43c](https://github.com/open-feature/dotnet-sdk/commit/08ff43ce3426c8bb9f24446bdf62e56b10534c1f)) +* **deps:** update github/codeql-action digest to ce28f5b ([#492](https://github.com/open-feature/dotnet-sdk/issues/492)) ([cce224f](https://github.com/open-feature/dotnet-sdk/commit/cce224fcf81aede5a626936a26546fe710fbcc30)) +* **deps:** update github/codeql-action digest to fca7ace ([#486](https://github.com/open-feature/dotnet-sdk/issues/486)) ([e18ad50](https://github.com/open-feature/dotnet-sdk/commit/e18ad50e3298cb0dd19143678c3ef0fdcb4484d9)) +* **deps:** update opentelemetry-dotnet monorepo to 1.12.0 ([#506](https://github.com/open-feature/dotnet-sdk/issues/506)) ([69dc186](https://github.com/open-feature/dotnet-sdk/commit/69dc18611399ab5e573268c35d414a028c77f0ff)) +* **deps:** update spec digest to 1965aae ([#499](https://github.com/open-feature/dotnet-sdk/issues/499)) ([2e3dffd](https://github.com/open-feature/dotnet-sdk/commit/2e3dffd0ebbba4a9d95763e2ce9f3e2ac051a317)) +* **deps:** update spec digest to 42340bb ([#493](https://github.com/open-feature/dotnet-sdk/issues/493)) ([909c51d](https://github.com/open-feature/dotnet-sdk/commit/909c51d4e25917d6a9a5ae9bb04cfe48665186ba)) +* **deps:** update spec digest to c37ac17 ([#502](https://github.com/open-feature/dotnet-sdk/issues/502)) ([38f63fc](https://github.com/open-feature/dotnet-sdk/commit/38f63fceb5516cd474fd0e867aa25eae252cf2c1)) +* **deps:** update spec digest to f014806 ([#479](https://github.com/open-feature/dotnet-sdk/issues/479)) ([dbe8b08](https://github.com/open-feature/dotnet-sdk/commit/dbe8b082c28739a1b81b74b29ed28fbccc94f7bc)) +* fix sample build warning ([#498](https://github.com/open-feature/dotnet-sdk/issues/498)) ([08a00e1](https://github.com/open-feature/dotnet-sdk/commit/08a00e1d35834635ca296fe8a13507001ad25c57)) + + +### ๐Ÿ“š Documentation + +* add XML comment on FeatureClient ([#507](https://github.com/open-feature/dotnet-sdk/issues/507)) ([f923cea](https://github.com/open-feature/dotnet-sdk/commit/f923cea14eb552098edb987950ad4bc82bbadab1)) +* updated contributing link on the README ([8435bf7](https://github.com/open-feature/dotnet-sdk/commit/8435bf7d8131307e627e59453008124ac4c71906)) + ## [2.6.0](https://github.com/open-feature/dotnet-sdk/compare/v2.5.0...v2.6.0) (2025-05-23) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 98800faf8..e3c6300b7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -18,6 +18,26 @@ On all platforms, the minimum requirements are: - JetBrains Rider 2022.2+ or Visual Studio 2022+ or Visual Studio Code - .NET Framework 4.6.2+ +### Development Containers + +This repository includes support for [Development Containers](https://containers.dev/) (devcontainers), which provide a consistent, containerized development environment. The devcontainer configuration includes all necessary dependencies and tools pre-configured. + +To use the devcontainer: + +1. **Prerequisites**: Install [Docker](https://www.docker.com/) and either: + - [Visual Studio Code](https://code.visualstudio.com/) with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) + - [GitHub Codespaces](https://github.com/features/codespaces) + +2. **Using with VS Code**: + - Open the repository in VS Code + - When prompted, click "Reopen in Container" or use the Command Palette (`Ctrl+Shift+P` / `Cmd+Shift+P`) and select "Dev Containers: Reopen in Container" + +3. **Using with GitHub Codespaces**: + - Navigate to the repository on GitHub + - Click the "Code" button and select "Create codespace on [branch-name]" + +The devcontainer provides a pre-configured environment with the .NET SDK and all necessary tools for development and testing. + ## Pull Request All contributions to the OpenFeature project are welcome via GitHub pull requests. @@ -130,6 +150,16 @@ Please make sure you follow the latest [conventions](https://www.conventionalcom If you want to point out a breaking change, you should use `!` after the type. For example: `feat!: excellent new feature`. +### Changelog Visibility and Release Triggers + +Only certain types are visible in the generated changelog: + +- `feat`: โœจ New Features - New functionality added +- `fix`: ๐Ÿ› Bug Fixes - Bug fixes and corrections +- `perf`: ๐Ÿš€ Performance - Performance improvements +- `refactor`: ๐Ÿ”ง Refactoring - Code changes that neither fix bugs nor add features +- `revert`: ๐Ÿ”™ Reverts - Reverted changes + ## Design Choices As with other OpenFeature SDKs, dotnet-sdk follows the diff --git a/Directory.Packages.props b/Directory.Packages.props index 6bdfa4553..0f6a8448b 100644 --- a/Directory.Packages.props +++ b/Directory.Packages.props @@ -10,26 +10,37 @@ - - - - + + + + + + + - + - + - + + - + + + @@ -39,4 +50,4 @@ - \ No newline at end of file + diff --git a/OpenFeature.slnx b/OpenFeature.slnx index d6778e50e..936079f40 100644 --- a/OpenFeature.slnx +++ b/OpenFeature.slnx @@ -5,7 +5,7 @@ - + @@ -14,9 +14,6 @@ - - - @@ -51,18 +48,22 @@ - - + + + - + + + + - + \ No newline at end of file diff --git a/README.md b/README.md index 5f1b725b5..4eb02b551 100644 --- a/README.md +++ b/README.md @@ -10,8 +10,8 @@ [![Specification](https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.8.0) [ -![Release](https://img.shields.io/static/v1?label=release&message=v2.6.0&color=blue&style=for-the-badge) -](https://github.com/open-feature/dotnet-sdk/releases/tag/v2.6.0) +![Release](https://img.shields.io/static/v1?label=release&message=v2.9.0&color=blue&style=for-the-badge) +](https://github.com/open-feature/dotnet-sdk/releases/tag/v2.9.0) [![Slack](https://img.shields.io/badge/slack-%40cncf%2Fopenfeature-brightgreen?style=flat&logo=slack)](https://cloud-native.slack.com/archives/C0344AANLA1) [![Codecov](https://codecov.io/gh/open-feature/dotnet-sdk/branch/main/graph/badge.svg?token=MONAVJBXUJ)](https://codecov.io/gh/open-feature/dotnet-sdk) @@ -33,6 +33,12 @@ Note that the packages will aim to support all current .NET versions. Refer to the currently supported versions [.NET](https://dotnet.microsoft.com/download/dotnet) and [.NET Framework](https://dotnet.microsoft.com/download/dotnet-framework) excluding .NET Framework 3.5 +### NativeAOT Support + +โœ… **Full NativeAOT Compatibility** - The OpenFeature .NET SDK is fully compatible with .NET NativeAOT compilation for fast startup and small deployment size. See the [AOT Compatibility Guide](docs/AOT_COMPATIBILITY.md) for detailed instructions. + +> While the core OpenFeature SDK is fully NativeAOT compatible, contrib and community-provided providers, hooks, and extensions may not be. Please check with individual provider/hook documentation for their NativeAOT compatibility status. + ### Install Use the following to initialize your project: @@ -79,25 +85,25 @@ public async Task Example() The [`samples/`](./samples) folder contains example applications demonstrating how to use OpenFeature in different .NET scenarios. -| Sample Name | Description | -|---------------------------------------------------|----------------------------------------------------------------| -| [AspNetCore](/samples/AspNetCore/README.md) | Feature flags in an ASP.NET Core Web API. | +| Sample Name | Description | +| ------------------------------------------- | ----------------------------------------- | +| [AspNetCore](/samples/AspNetCore/README.md) | Feature flags in an ASP.NET Core Web API. | **Getting Started with a Sample:** 1. Navigate to the sample directory - ```shell - cd samples/AspNetCore - ``` + ```shell + cd samples/AspNetCore + ``` 2. Restore dependencies and run - ```shell - dotnet run - ``` + ```shell + dotnet run + ``` -Want to contribute a new sample? See our [CONTRIBUTING](#-contributing) guide! +Want to contribute a new sample? See our [CONTRIBUTING](CONTRIBUTING.md) guide! ## ๐ŸŒŸ Features @@ -113,7 +119,8 @@ Want to contribute a new sample? See our [CONTRIBUTING](#-contributing) guide! | โœ… | [Shutdown](#shutdown) | Gracefully clean up a provider during application shutdown. | | โœ… | [Transaction Context Propagation](#transaction-context-propagation) | Set a specific [evaluation context](https://openfeature.dev/docs/reference/concepts/evaluation-context) for a transaction (e.g. an HTTP request or a thread). | | โœ… | [Extending](#extending) | Extend OpenFeature with custom providers and hooks. | -| ๐Ÿ”ฌ | [DependencyInjection](#DependencyInjection) | Integrate OpenFeature with .NET's dependency injection for streamlined provider setup. | +| ๐Ÿ”ฌ | [Multi-Provider](#multi-provider) | Use multiple feature flag providers simultaneously with configurable evaluation strategies. | +| ๐Ÿ”ฌ | [DependencyInjection](#dependency-injection) | Integrate OpenFeature with .NET's dependency injection for streamlined provider setup. | > Implemented: โœ… | In-progress: โš ๏ธ | Not implemented yet: โŒ | Experimental: ๐Ÿ”ฌ @@ -433,17 +440,106 @@ Hooks support passing per-evaluation data between that stages using `hook data`. Built a new hook? [Let us know](https://github.com/open-feature/openfeature.dev/issues/new?assignees=&labels=hook&projects=&template=document-hook.yaml&title=%5BHook%5D%3A+) so we can add it to the docs! -### DependencyInjection +### Multi-Provider > [!NOTE] -> The OpenFeature.DependencyInjection and OpenFeature.Hosting packages are currently experimental. They streamline the integration of OpenFeature within .NET applications, allowing for seamless configuration and lifecycle management of feature flag providers using dependency injection and hosting services. +> The Multi-Provider feature is currently experimental. + +The Multi-Provider enables the use of multiple underlying feature flag providers simultaneously, allowing different providers to be used for different flag keys or based on specific evaluation strategies. + +The Multi-Provider supports provider hooks and executes them in accordance with the OpenFeature specification. Each provider's hooks are executed with context isolation, ensuring that context modifications by one provider's hooks do not affect other providers. + +#### Basic Usage + +```csharp +using OpenFeature.Providers.MultiProvider; +using OpenFeature.Providers.MultiProvider.Models; +using OpenFeature.Providers.MultiProvider.Strategies; + +// Create provider entries +var providerEntries = new List +{ + new(new InMemoryProvider(provider1Flags), "Provider1"), + new(new InMemoryProvider(provider2Flags), "Provider2") +}; + +// Create multi-provider with FirstMatchStrategy (default) +var multiProvider = new MultiProvider(providerEntries, new FirstMatchStrategy()); + +// Set as the default provider +await Api.Instance.SetProviderAsync(multiProvider); + +// Use normally - the multi-provider will handle delegation +var client = Api.Instance.GetClient(); +var flagValue = await client.GetBooleanValueAsync("my-flag", false); +``` + +#### Evaluation Strategies + +The Multi-Provider supports different evaluation strategies that determine how multiple providers are used: + +##### FirstMatchStrategy (Default) + +Evaluates providers sequentially and returns the first result that is not "flag not found". If any provider returns an error, that error is returned immediately. + +```csharp +var multiProvider = new MultiProvider(providerEntries, new FirstMatchStrategy()); +``` + +##### FirstSuccessfulStrategy + +Evaluates providers sequentially and returns the first successful result, ignoring errors. Only if all providers fail will errors be returned. + +```csharp +var multiProvider = new MultiProvider(providerEntries, new FirstSuccessfulStrategy()); +``` + +##### ComparisonStrategy + +Evaluates all providers in parallel and compares results. If values agree, returns the agreed value. If they disagree, returns the fallback provider's value (or first provider if no fallback is specified) and optionally calls a mismatch callback. + +```csharp +// Basic comparison +var multiProvider = new MultiProvider(providerEntries, new ComparisonStrategy()); + +// With fallback provider +var multiProvider = new MultiProvider(providerEntries, + new ComparisonStrategy(fallbackProvider: provider1)); + +// With mismatch callback +var multiProvider = new MultiProvider(providerEntries, + new ComparisonStrategy(onMismatch: (mismatchDetails) => { + // Log or handle mismatches between providers + foreach (var kvp in mismatchDetails) + { + Console.WriteLine($"Provider {kvp.Key}: {kvp.Value}"); + } + })); +``` + +#### Evaluation Modes + +The Multi-Provider supports two evaluation modes: + +- **Sequential**: Providers are evaluated one after another (used by `FirstMatchStrategy` and `FirstSuccessfulStrategy`) +- **Parallel**: All providers are evaluated simultaneously (used by `ComparisonStrategy`) + +#### Limitations + +- **Experimental status**: The API may change in future releases + +For a complete example, see the [AspNetCore sample](./samples/AspNetCore/README.md) which demonstrates Multi-Provider usage. + +### Dependency Injection + +> [!NOTE] +> The OpenFeature.Hosting package is currently experimental. The Hosting package streamlines the integration of OpenFeature within .NET applications, allowing for seamless configuration and lifecycle management of feature flag providers using dependency injection and hosting services. #### Installation -To set up dependency injection and hosting capabilities for OpenFeature, install the following packages: +To set up dependency injection and hosting capabilities for OpenFeature, install the following package: ```sh -dotnet add package OpenFeature.DependencyInjection dotnet add package OpenFeature.Hosting ``` @@ -456,7 +552,6 @@ For a basic configuration, you can use the InMemoryProvider. This provider is si ```csharp builder.Services.AddOpenFeature(featureBuilder => { featureBuilder - .AddHostedFeatureLifecycle() // From Hosting package .AddInMemoryProvider(); }); ``` @@ -478,9 +573,9 @@ builder.Services.AddOpenFeature(featureBuilder => { ```csharp builder.Services.AddOpenFeature(featureBuilder => { featureBuilder - .AddHostedFeatureLifecycle() .AddContext((contextBuilder, serviceProvider) => { /* Custom context configuration */ }) .AddHook((serviceProvider) => new LoggingHook( /* Custom configuration */ )) + .AddHook(new MetricsHook()) .AddInMemoryProvider("name1") .AddInMemoryProvider("name2") .AddPolicyName(options => { @@ -534,6 +629,171 @@ services.AddOpenFeature(builder => }); ``` +### Trace Enricher Hook + +The `TraceEnricherHook` enriches telemetry traces with additional information during the feature flag evaluation lifecycle. This hook adds relevant flag evaluation details as tags and events to the current `Activity` for tracing purposes. + +For this hook to function correctly, an active span must be set in the current `Activity`, otherwise the hook will no-op. + +Below are the tags added to the trace event: + +| Tag Name | Description | Source | +| --------------------------- | ---------------------------------------------------------------------------- | ----------------------------- | +| feature_flag.key | The lookup key of the feature flag | Hook context flag key | +| feature_flag.provider.name | The name of the feature flag provider | Provider metadata | +| feature_flag.result.reason | The reason code which shows how a feature flag value was determined | Evaluation details | +| feature_flag.result.variant | A semantic identifier for an evaluated flag value | Evaluation details | +| feature_flag.result.value | The evaluated value of the feature flag | Evaluation details | +| feature_flag.context.id | The unique identifier for the flag evaluation context | Flag metadata (if available) | +| feature_flag.set.id | The identifier of the flag set to which the feature flag belongs | Flag metadata (if available) | +| feature_flag.version | The version of the ruleset used during the evaluation | Flag metadata (if available) | +| error.type | Describes a class of error the operation ended with | Evaluation details (if error) | +| error.message | A message explaining the nature of an error occurring during flag evaluation | Evaluation details (if error) | + +#### Example + +The following example demonstrates the use of the `TraceEnricherHook` with the `OpenFeature dotnet-sdk`. The traces are sent to a `jaeger` OTLP collector running at `localhost:4317`. + +```csharp +using OpenFeature.Contrib.Providers.Flagd; +using OpenFeature.Hooks; +using OpenTelemetry.Exporter; +using OpenTelemetry.Resources; +using OpenTelemetry; +using OpenTelemetry.Trace; + +namespace OpenFeatureTestApp +{ + class Hello { + static void Main(string[] args) { + + // set up the OpenTelemetry OTLP exporter + var tracerProvider = Sdk.CreateTracerProviderBuilder() + .AddSource("my-tracer") + .ConfigureResource(r => r.AddService("jaeger-test")) + .AddOtlpExporter(o => + { + o.ExportProcessorType = ExportProcessorType.Simple; + }) + .Build(); + + // add the TraceEnricherHook to the OpenFeature instance + OpenFeature.Api.Instance.AddHooks(new TraceEnricherHook()); + + var flagdProvider = new FlagdProvider(new Uri("http://localhost:8013")); + + // Set the flagdProvider as the provider for the OpenFeature SDK + OpenFeature.Api.Instance.SetProvider(flagdProvider); + + var client = OpenFeature.Api.Instance.GetClient("my-app"); + + var val = client.GetBooleanValueAsync("myBoolFlag", false, null); + + // Print the value of the 'myBoolFlag' feature flag + System.Console.WriteLine(val.Result.ToString()); + } + } +} +``` + +After running this example, you will be able to see the traces, including the events sent by the hook in your Jaeger UI. + +You can specify custom tags on spans created by the `TraceEnricherHook` by providing `TraceEnricherHookOptions` when adding the hook: + +```csharp +var options = TraceEnricherHookOptions.CreateBuilder() + .WithTag("custom_dimension_key", "custom_dimension_value") + .Build(); + +OpenFeature.Api.Instance.AddHooks(new TraceEnricherHook(options)); +``` + +You can also write your own extraction logic against the Flag metadata by providing a callback to `WithFlagEvaluationMetadata`. The below example will add a tag to the span with the key `boolean` and a value specified by the callback. + +```csharp +var options = TraceEnricherHookOptions.CreateBuilder() + .WithFlagEvaluationMetadata("boolean", s => s.GetBool("boolean")) + .Build(); +``` + +### Metrics Hook + +For this hook to function correctly a global `MeterProvider` must be set. +`MetricsHook` performs metric collection by tapping into various hook stages. + +Below are the metrics extracted by this hook and dimensions they carry: + +| Metric key | Description | Unit | Dimensions | +| -------------------------------------- | ------------------------------- | ---------- | ----------------------------- | +| feature_flag.evaluation_requests_total | Number of evaluation requests | request | key, provider name | +| feature_flag.evaluation_success_total | Flag evaluation successes | impression | key, provider name, reason | +| feature_flag.evaluation_error_total | Flag evaluation errors | 1 | key, provider name, exception | +| feature_flag.evaluation_active_count | Active flag evaluations counter | 1 | key, provider name | + +Consider the following code example for usage. + +#### Example + +The following example demonstrates the use of the `MetricsHook` with the `OpenFeature dotnet-sdk`. The metrics are sent to the `console`. + +```csharp +using OpenFeature.Contrib.Providers.Flagd; +using OpenFeature; +using OpenFeature.Hooks; +using OpenTelemetry; +using OpenTelemetry.Metrics; + +namespace OpenFeatureTestApp +{ + class Hello { + static void Main(string[] args) { + + // set up the OpenTelemetry OTLP exporter + var meterProvider = Sdk.CreateMeterProviderBuilder() + .AddMeter("OpenFeature") + .ConfigureResource(r => r.AddService("openfeature-test")) + .AddConsoleExporter() + .Build(); + + // add the MetricsHook to the OpenFeature instance + OpenFeature.Api.Instance.AddHooks(new MetricsHook()); + + var flagdProvider = new FlagdProvider(new Uri("http://localhost:8013")); + + // Set the flagdProvider as the provider for the OpenFeature SDK + OpenFeature.Api.Instance.SetProvider(flagdProvider); + + var client = OpenFeature.Api.Instance.GetClient("my-app"); + + var val = client.GetBooleanValueAsync("myBoolFlag", false, null); + + // Print the value of the 'myBoolFlag' feature flag + System.Console.WriteLine(val.Result.ToString()); + } + } +} +``` + +After running this example, you should be able to see some metrics being generated into the console. + +You can specify custom dimensions on all instruments by the `MetricsHook` by providing `MetricsHookOptions` when adding the hook: + +```csharp +var options = MetricsHookOptions.CreateBuilder() + .WithCustomDimension("custom_dimension_key", "custom_dimension_value") + .Build(); + +OpenFeature.Api.Instance.AddHooks(new MetricsHook(options)); +``` + +You can also write your own extraction logic against the Flag metadata by providing a callback to `WithFlagEvaluationMetadata`. + +```csharp +var options = MetricsHookOptions.CreateBuilder() + .WithFlagEvaluationMetadata("boolean", s => s.GetBool("boolean")) + .Build(); +``` + ## โญ๏ธ Support the project diff --git a/build/Common.prod.props b/build/Common.prod.props index 55264b3c0..f1a21cc26 100644 --- a/build/Common.prod.props +++ b/build/Common.prod.props @@ -1,5 +1,5 @@ - + true @@ -9,7 +9,7 @@ - 2.6.0 + 2.9.0 git https://github.com/open-feature/dotnet-sdk OpenFeature is an open standard for feature flag management, created to support a robust feature flag ecosystem using cloud native technologies. OpenFeature will provide a unified API and SDK, and a developer-first, cloud-native implementation, with extensibility for open source and commercial offerings. @@ -24,8 +24,13 @@ $(VersionNumber) + + + true + + - + diff --git a/docs/AOT_COMPATIBILITY.md b/docs/AOT_COMPATIBILITY.md new file mode 100644 index 000000000..afa6f1e73 --- /dev/null +++ b/docs/AOT_COMPATIBILITY.md @@ -0,0 +1,152 @@ +# OpenFeature .NET SDK - NativeAOT Compatibility + +The OpenFeature .NET SDK is compatible with .NET NativeAOT compilation, allowing you to create self-contained, native executables with faster startup times and lower memory usage. + +## Compatibility Status + +**Fully Compatible** - The SDK can be used in NativeAOT applications without any issues. + +### What's AOT-Compatible + +- Core API functionality (`Api.Instance`, `GetClient()`, flag evaluations) +- All built-in providers (`NoOpProvider`, etc.) +- JSON serialization of `Value`, `Structure`, and `EvaluationContext` +- Error handling and enum descriptions +- Hook system +- Event handling +- Metrics collection +- Dependency injection + +## Using OpenFeature with NativeAOT + +### 1. Project Configuration + +To enable NativeAOT in your project, add these properties to your `.csproj` file: + +```xml + + + net8.0 + Exe + + + true + + + + + + +``` + +### 2. Basic Usage + +```csharp +using OpenFeature; +using OpenFeature.Model; + +// Basic OpenFeature usage - fully AOT compatible +var api = Api.Instance; +var client = api.GetClient("my-app"); + +// All flag evaluation methods work +var boolFlag = await client.GetBooleanValueAsync("feature-enabled", false); +var stringFlag = await client.GetStringValueAsync("welcome-message", "Hello"); +var intFlag = await client.GetIntegerValueAsync("max-items", 10); +``` + +### 3. JSON Serialization (Recommended) + +For optimal AOT performance, use the provided `JsonSerializerContext`: + +```csharp +using System.Text.Json; +using OpenFeature.Model; +using OpenFeature.Serialization; + +var value = new Value(Structure.Builder() + .Set("name", "test") + .Set("enabled", true) + .Build()); + +// Use AOT-compatible serialization +var json = JsonSerializer.Serialize(value, OpenFeatureJsonSerializerContext.Default.Value); +var deserialized = JsonSerializer.Deserialize(json, OpenFeatureJsonSerializerContext.Default.Value); +``` + +### 4. Publishing for NativeAOT + +Build and publish your AOT application: + +```bash +# Build with AOT analysis +dotnet build -c Release + +# Publish as native executable +dotnet publish -c Release + +# Run the native executable (example path for macOS ARM64) +./bin/Release/net9.0/osx-arm64/publish/MyApp +``` + +## Performance Benefits + +NativeAOT compilation provides several benefits: + +- **Faster Startup**: Native executables start faster than JIT-compiled applications +- **Lower Memory Usage**: Reduced memory footprint +- **Self-Contained**: No .NET runtime dependency required +- **Smaller Deployment**: Optimized for size with trimming + +## Testing AOT Compatibility + +The SDK includes an AOT compatibility test project at `test/OpenFeature.AotCompatibility/` that: + +- Tests all core SDK functionality +- Validates JSON serialization with source generation +- Verifies error handling works correctly +- Can be compiled and run as a native executable + +Run the test: + +```bash +cd test/OpenFeature.AotCompatibility +dotnet publish -c Release +./bin/Release/net9.0/[runtime]/publish/OpenFeature.AotCompatibility +``` + +## Limitations + +Currently, there are no known limitations when using OpenFeature with NativeAOT. All core functionality is fully supported. + +## Provider Compatibility + +When using third-party providers, ensure they are also AOT-compatible. Check the provider's documentation for AOT support. + +## Troubleshooting + +### Trimming Warnings + +If you encounter trimming warnings, you can: + +1. Use the provided `JsonSerializerContext` for JSON operations +2. Ensure your providers are AOT-compatible +3. Add appropriate `[DynamicallyAccessedMembers]` attributes if needed + +### Build Issues + +- Ensure you're targeting .NET 8.0 or later +- Verify all dependencies support NativeAOT +- Check that `PublishAot` is set to `true` + +## Migration Guide + +If migrating from a non-AOT setup: + +1. **JSON Serialization**: Replace direct `JsonSerializer` calls with the provided context +2. **Reflection**: The SDK no longer uses reflection, but ensure your custom code doesn't +3. **Dynamic Loading**: Avoid dynamic assembly loading; register providers at compile time + +## Example AOT Application + +See the complete example in `test/OpenFeature.AotCompatibility/Program.cs` for a working AOT application that demonstrates all SDK features. diff --git a/nuget.config b/nuget.config deleted file mode 100644 index 5a0edf435..000000000 --- a/nuget.config +++ /dev/null @@ -1,22 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - diff --git a/release-please-config.json b/release-please-config.json index 5a0201f6d..6baeed441 100644 --- a/release-please-config.json +++ b/release-please-config.json @@ -8,7 +8,8 @@ "versioning": "default", "extra-files": [ "build/Common.prod.props", - "README.md" + "README.md", + "src/OpenFeature.DependencyInjection/README.md" ] } }, @@ -23,10 +24,12 @@ }, { "type": "chore", + "hidden": true, "section": "๐Ÿงน Chore" }, { "type": "docs", + "hidden": true, "section": "๐Ÿ“š Documentation" }, { @@ -40,6 +43,7 @@ }, { "type": "deps", + "hidden": true, "section": "๐Ÿ“ฆ Dependencies" }, { @@ -49,7 +53,7 @@ }, { "type": "refactor", - "section": "๐Ÿ”„ Refactoring" + "section": "๐Ÿ”ง Refactoring" }, { "type": "revert", diff --git a/samples/AspNetCore/Program.cs b/samples/AspNetCore/Program.cs index 462370861..3dc0203b1 100644 --- a/samples/AspNetCore/Program.cs +++ b/samples/AspNetCore/Program.cs @@ -1,23 +1,63 @@ +using System.Text.Json; +using System.Text.Json.Serialization; using Microsoft.AspNetCore.Mvc; using OpenFeature; -using OpenFeature.DependencyInjection.Providers.Memory; using OpenFeature.Hooks; +using OpenFeature.Hosting.Providers.Memory; +using OpenFeature.Model; using OpenFeature.Providers.Memory; +using OpenFeature.Providers.MultiProvider; +using OpenFeature.Providers.MultiProvider.Models; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenTelemetry.Metrics; +using OpenTelemetry.Resources; +using OpenTelemetry.Trace; -var builder = WebApplication.CreateBuilder(args); +var builder = WebApplication.CreateSlimBuilder(args); // Add services to the container. +builder.Services.ConfigureHttpJsonOptions(options => +{ + options.SerializerOptions.TypeInfoResolverChain.Insert(0, AppJsonSerializerContext.Default); +}); + builder.Services.AddProblemDetails(); -builder.Services.AddOpenFeature(builder => +// Configure OpenTelemetry +builder.Services.AddOpenTelemetry() + .ConfigureResource(resource => resource.AddService("openfeature-aspnetcore-sample")) + .WithTracing(tracing => tracing + .AddAspNetCoreInstrumentation() + .AddOtlpExporter()) + .WithMetrics(metrics => metrics + .AddAspNetCoreInstrumentation() + .AddMeter("OpenFeature") + .AddOtlpExporter()); + +builder.Services.AddOpenFeature(featureBuilder => { - builder.AddHostedFeatureLifecycle() + var metricsHookOptions = MetricsHookOptions.CreateBuilder() + .WithCustomDimension("custom_dimension_key", "custom_dimension_value") + .WithFlagEvaluationMetadata("boolean", s => s.GetBool("boolean")) + .Build(); + + featureBuilder .AddHook(sp => new LoggingHook(sp.GetRequiredService>())) - .AddInMemoryProvider("InMemory", provider => new Dictionary() + .AddHook(_ => new MetricsHook(metricsHookOptions)) + .AddHook() + .AddInMemoryProvider("InMemory", _ => new Dictionary() { { "welcome-message", new Flag( new Dictionary { { "show", true }, { "hide", false } }, "show") + }, + { + "test-config", new Flag(new Dictionary() + { + { "enable", new Value(Structure.Builder().Set(nameof(TestConfig.Threshold), 100).Build()) }, + { "half", new Value(Structure.Builder().Set(nameof(TestConfig.Threshold), 50).Build()) }, + { "disable", new Value(Structure.Builder().Set(nameof(TestConfig.Threshold), 0).Build()) } + }, "disable") } }); }); @@ -39,4 +79,74 @@ return TypedResults.Ok("Hello world!"); }); +app.MapGet("/test-config", async ([FromServices] IFeatureClient featureClient) => +{ + var testConfigValue = await featureClient.GetObjectValueAsync("test-config", + new Value(Structure.Builder().Set("Threshold", 50).Build()) + ); + var json = JsonSerializer.Serialize(testConfigValue, AppJsonSerializerContext.Default.Value); + var config = JsonSerializer.Deserialize(json, AppJsonSerializerContext.Default.TestConfig); + return Results.Ok(config); +}); + +app.MapGet("/multi-provider", async () => +{ + // Create first in-memory provider with some flags + var provider1Flags = new Dictionary + { + { "providername", new Flag(new Dictionary { { "enabled", "enabled-provider1" }, { "disabled", "disabled-provider1" } }, "enabled") }, + { "max-items", new Flag(new Dictionary { { "low", 10 }, { "high", 100 } }, "high") }, + }; + var provider1 = new InMemoryProvider(provider1Flags); + + // Create second in-memory provider with different flags + var provider2Flags = new Dictionary + { + { "providername", new Flag(new Dictionary { { "enabled", "enabled-provider2" }, { "disabled", "disabled-provider2" } }, "enabled") }, + }; + var provider2 = new InMemoryProvider(provider2Flags); + + // Create provider entries + var providerEntries = new List + { + new(provider1, "Provider1"), + new(provider2, "Provider2") + }; + + // Create multi-provider with FirstMatchStrategy (default) + var multiProvider = new MultiProvider(providerEntries, new FirstMatchStrategy()); + + // Set the multi-provider as the default provider using OpenFeature API + await Api.Instance.SetProviderAsync(multiProvider); + + // Create a client directly using the API + var client = Api.Instance.GetClient(); + + try + { + // Test flag evaluation from different providers + var maxItemsFlag = await client.GetIntegerDetailsAsync("max-items", 0); + var providerNameFlag = await client.GetStringDetailsAsync("providername", "default"); + + // Test a flag that doesn't exist in any provider + var unknownFlag = await client.GetBooleanDetailsAsync("unknown-flag", false); + + return Results.Ok(); + } + catch (Exception) + { + return Results.InternalServerError(); + } +}); + app.Run(); + + +public class TestConfig +{ + public int Threshold { get; set; } = 10; +} + +[JsonSerializable(typeof(TestConfig))] +[JsonSerializable(typeof(Value))] +public partial class AppJsonSerializerContext : JsonSerializerContext; diff --git a/samples/AspNetCore/Samples.AspNetCore.csproj b/samples/AspNetCore/Samples.AspNetCore.csproj index 01e452d77..6945e6692 100644 --- a/samples/AspNetCore/Samples.AspNetCore.csproj +++ b/samples/AspNetCore/Samples.AspNetCore.csproj @@ -1,9 +1,21 @@ ๏ปฟ + + false + true + true + + - + + + + + + + diff --git a/spec b/spec index edf0debe0..969e11c4d 160000 --- a/spec +++ b/spec @@ -1 +1 @@ -Subproject commit edf0debe0b4547d1f13e49f8e58a6d182237b43b +Subproject commit 969e11c4d5df4ab16b400965ef1b3e313dcb923e diff --git a/src/Directory.Build.props b/src/Directory.Build.props index 992a61958..3b7879044 100644 --- a/src/Directory.Build.props +++ b/src/Directory.Build.props @@ -1,3 +1,7 @@ + + + $([MSBuild]::IsTargetFrameworkCompatible('$(TargetFramework)', 'net8.0')) + diff --git a/src/OpenFeature.DependencyInjection/OpenFeature.DependencyInjection.csproj b/src/OpenFeature.DependencyInjection/OpenFeature.DependencyInjection.csproj index 855ab2ab2..9ae3029df 100644 --- a/src/OpenFeature.DependencyInjection/OpenFeature.DependencyInjection.csproj +++ b/src/OpenFeature.DependencyInjection/OpenFeature.DependencyInjection.csproj @@ -3,6 +3,7 @@ netstandard2.0;net8.0;net9.0;net462 OpenFeature.DependencyInjection + README.md @@ -17,6 +18,7 @@ + diff --git a/src/OpenFeature.DependencyInjection/OpenFeatureBuilderExtensions.cs b/src/OpenFeature.DependencyInjection/OpenFeatureBuilderExtensions.cs index 317589606..d676dc5e9 100644 --- a/src/OpenFeature.DependencyInjection/OpenFeatureBuilderExtensions.cs +++ b/src/OpenFeature.DependencyInjection/OpenFeatureBuilderExtensions.cs @@ -272,12 +272,51 @@ public static OpenFeatureBuilder AddPolicyName(this OpenFeatureBuilder builder, /// The instance. /// Optional factory for controlling how will be created in the DI container. /// The instance. - public static OpenFeatureBuilder AddHook(this OpenFeatureBuilder builder, Func? implementationFactory = null) + public static OpenFeatureBuilder AddHook< +#if NET + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] +#endif + THook>(this OpenFeatureBuilder builder, Func? implementationFactory = null) where THook : Hook { return builder.AddHook(typeof(THook).Name, implementationFactory); } + /// + /// Adds a feature hook to the service collection. Hooks added here are not domain-bound. + /// + /// The type of to be added. + /// The instance. + /// Instance of Hook to inject into the OpenFeature context. + /// The instance. + public static OpenFeatureBuilder AddHook< +#if NET + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] +#endif + THook>(this OpenFeatureBuilder builder, THook hook) + where THook : Hook + { + return builder.AddHook(typeof(THook).Name, hook); + } + + /// + /// Adds a feature hook to the service collection with a specified name. Hooks added here are not domain-bound. + /// + /// The type of to be added. + /// The instance. + /// The name of the that is being added. + /// Instance of Hook to inject into the OpenFeature context. + /// The instance. + public static OpenFeatureBuilder AddHook< +#if NET + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] +#endif + THook>(this OpenFeatureBuilder builder, string hookName, THook hook) + where THook : Hook + { + return builder.AddHook(hookName, _ => hook); + } + /// /// Adds a feature hook to the service collection using a factory method and specified name. Hooks added here are not domain-bound. /// @@ -286,7 +325,12 @@ public static OpenFeatureBuilder AddHook(this OpenFeatureBuilder builder, /// The name of the that is being added. /// Optional factory for controlling how will be created in the DI container. /// The instance. - public static OpenFeatureBuilder AddHook(this OpenFeatureBuilder builder, string hookName, Func? implementationFactory = null) + public static OpenFeatureBuilder AddHook< +#if NET + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] +#endif + THook> + (this OpenFeatureBuilder builder, string hookName, Func? implementationFactory = null) where THook : Hook { builder.Services.PostConfigure(options => options.AddHookName(hookName)); diff --git a/src/OpenFeature.DependencyInjection/OpenFeatureServiceCollectionExtensions.cs b/src/OpenFeature.DependencyInjection/OpenFeatureServiceCollectionExtensions.cs index 74d01ad3a..a24c67e78 100644 --- a/src/OpenFeature.DependencyInjection/OpenFeatureServiceCollectionExtensions.cs +++ b/src/OpenFeature.DependencyInjection/OpenFeatureServiceCollectionExtensions.cs @@ -24,7 +24,9 @@ public static IServiceCollection AddOpenFeature(this IServiceCollection services Guard.ThrowIfNull(configure); // Register core OpenFeature services as singletons. - services.TryAddSingleton(Api.Instance); + var api = new Api(); + Api.SetInstance(api); + services.TryAddSingleton(api); services.TryAddSingleton(); var builder = new OpenFeatureBuilder(services); diff --git a/src/OpenFeature.DependencyInjection/README.md b/src/OpenFeature.DependencyInjection/README.md new file mode 100644 index 000000000..6b9fcfe72 --- /dev/null +++ b/src/OpenFeature.DependencyInjection/README.md @@ -0,0 +1,48 @@ +# OpenFeature.DependencyInjection + +> **โš ๏ธ DEPRECATED**: This library is now deprecated. The OpenTelemetry Dependency Injection library has been moved to the OpenFeature Hosting integration in version 2.9.0. + +OpenFeature is an open standard for feature flag management, created to support a robust feature flag ecosystem using cloud native technologies. OpenFeature will provide a unified API and SDK, and a developer-first, cloud-native implementation, with extensibility for open source and commercial offerings. + +## Migration Guide + +If you are using `OpenFeature.DependencyInjection`, you should migrate to the `OpenFeature.Hosting` package. The hosting package provides the same functionality but in one package. + +### 1. Update dependencies + +Remove this package: + +```xml + +``` + +Update or install the latest `OpenFeature.Hosting` package: + +```xml + +``` + +### 2. Update your `Program.cs` + +Remove the `AddHostedFeatureLifecycle` method call. + +#### Before + +```csharp +builder.Services.AddOpenFeature(featureBuilder => +{ + featureBuilder + .AddHostedFeatureLifecycle(); + + // Omit for code brevity +}); +``` + +#### After + +```csharp +builder.Services.AddOpenFeature(featureBuilder => +{ + // Omit for code brevity +}); +``` diff --git a/src/OpenFeature.Hosting/Diagnostics/FeatureCodes.cs b/src/OpenFeature.Hosting/Diagnostics/FeatureCodes.cs new file mode 100644 index 000000000..f7ecf81cb --- /dev/null +++ b/src/OpenFeature.Hosting/Diagnostics/FeatureCodes.cs @@ -0,0 +1,38 @@ +namespace OpenFeature.Hosting.Diagnostics; + +/// +/// Contains identifiers for experimental features and diagnostics in the OpenFeature framework. +/// +/// +/// Experimental - This class includes identifiers that allow developers to track and conditionally enable +/// experimental features. Each identifier follows a structured code format to indicate the feature domain, +/// maturity level, and unique identifier. Note that experimental features are subject to change or removal +/// in future releases. +/// +/// Basic Information
+/// These identifiers conform to OpenFeatureโ€™s Diagnostics Specifications, allowing developers to recognize +/// and manage experimental features effectively. +/// +/// +/// +/// +/// Code Structure: +/// - "OF" - Represents the OpenFeature library. +/// - "DI" - Indicates the Dependency Injection domain. +/// - "001" - Unique identifier for a specific feature. +/// +/// +internal static class FeatureCodes +{ + /// + /// Identifier for the experimental Dependency Injection features within the OpenFeature framework. + /// + /// + /// OFDI001 identifier marks experimental features in the Dependency Injection (DI) domain. + /// + /// Usage: + /// Developers can use this identifier to conditionally enable or test experimental DI features. + /// It is part of the OpenFeature diagnostics system to help track experimental functionality. + /// + public const string NewDi = "OFDI001"; +} diff --git a/src/OpenFeature.Hosting/Guard.cs b/src/OpenFeature.Hosting/Guard.cs new file mode 100644 index 000000000..2d37ef54d --- /dev/null +++ b/src/OpenFeature.Hosting/Guard.cs @@ -0,0 +1,14 @@ +using System.Diagnostics; +using System.Runtime.CompilerServices; + +namespace OpenFeature.Hosting; + +[DebuggerStepThrough] +internal static class Guard +{ + public static void ThrowIfNull(object? argument, [CallerArgumentExpression(nameof(argument))] string? paramName = null) + { + if (argument is null) + throw new ArgumentNullException(paramName); + } +} diff --git a/src/OpenFeature.Hosting/HostedFeatureLifecycleService.cs b/src/OpenFeature.Hosting/HostedFeatureLifecycleService.cs index 5209a5257..4411c21bb 100644 --- a/src/OpenFeature.Hosting/HostedFeatureLifecycleService.cs +++ b/src/OpenFeature.Hosting/HostedFeatureLifecycleService.cs @@ -1,7 +1,6 @@ using Microsoft.Extensions.Hosting; using Microsoft.Extensions.Logging; using Microsoft.Extensions.Options; -using OpenFeature.DependencyInjection; namespace OpenFeature.Hosting; diff --git a/src/OpenFeature.Hosting/IFeatureLifecycleManager.cs b/src/OpenFeature.Hosting/IFeatureLifecycleManager.cs new file mode 100644 index 000000000..54f791fbc --- /dev/null +++ b/src/OpenFeature.Hosting/IFeatureLifecycleManager.cs @@ -0,0 +1,24 @@ +namespace OpenFeature.Hosting; + +/// +/// Defines the contract for managing the lifecycle of a feature api. +/// +public interface IFeatureLifecycleManager +{ + /// + /// Ensures that the feature provider is properly initialized and ready to be used. + /// This method should handle all necessary checks, configuration, and setup required to prepare the feature provider. + /// + /// Propagates notification that operations should be canceled. + /// A Task representing the asynchronous operation of initializing the feature provider. + /// Thrown when the feature provider is not registered or is in an invalid state. + ValueTask EnsureInitializedAsync(CancellationToken cancellationToken = default); + + /// + /// Gracefully shuts down the feature api, ensuring all resources are properly disposed of and any persistent state is saved. + /// This method should handle all necessary cleanup and shutdown operations for the feature provider. + /// + /// Propagates notification that operations should be canceled. + /// A Task representing the asynchronous operation of shutting down the feature provider. + ValueTask ShutdownAsync(CancellationToken cancellationToken = default); +} diff --git a/src/OpenFeature.Hosting/Internal/EventHandlerDelegateWrapper.cs b/src/OpenFeature.Hosting/Internal/EventHandlerDelegateWrapper.cs new file mode 100644 index 000000000..34e000ce2 --- /dev/null +++ b/src/OpenFeature.Hosting/Internal/EventHandlerDelegateWrapper.cs @@ -0,0 +1,8 @@ +using OpenFeature.Constant; +using OpenFeature.Model; + +namespace OpenFeature.Hosting.Internal; + +internal record EventHandlerDelegateWrapper( + ProviderEventTypes ProviderEventType, + EventHandlerDelegate EventHandlerDelegate); diff --git a/src/OpenFeature.Hosting/Internal/FeatureLifecycleManager.cs b/src/OpenFeature.Hosting/Internal/FeatureLifecycleManager.cs new file mode 100644 index 000000000..4d915946b --- /dev/null +++ b/src/OpenFeature.Hosting/Internal/FeatureLifecycleManager.cs @@ -0,0 +1,66 @@ +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Options; + +namespace OpenFeature.Hosting.Internal; + +internal sealed partial class FeatureLifecycleManager : IFeatureLifecycleManager +{ + private readonly Api _featureApi; + private readonly IServiceProvider _serviceProvider; + private readonly ILogger _logger; + + public FeatureLifecycleManager(Api featureApi, IServiceProvider serviceProvider, ILogger logger) + { + _featureApi = featureApi; + _serviceProvider = serviceProvider; + _logger = logger; + } + + /// + public async ValueTask EnsureInitializedAsync(CancellationToken cancellationToken = default) + { + this.LogStartingInitializationOfFeatureProvider(); + + var options = _serviceProvider.GetRequiredService>().Value; + if (options.HasDefaultProvider) + { + var featureProvider = _serviceProvider.GetRequiredService(); + await _featureApi.SetProviderAsync(featureProvider).ConfigureAwait(false); + } + + foreach (var name in options.ProviderNames) + { + var featureProvider = _serviceProvider.GetRequiredKeyedService(name); + await _featureApi.SetProviderAsync(name, featureProvider).ConfigureAwait(false); + } + + var hooks = new List(); + foreach (var hookName in options.HookNames) + { + var hook = _serviceProvider.GetRequiredKeyedService(hookName); + hooks.Add(hook); + } + + _featureApi.AddHooks(hooks); + + var handlers = _serviceProvider.GetServices(); + foreach (var handler in handlers) + { + _featureApi.AddHandler(handler.ProviderEventType, handler.EventHandlerDelegate); + } + } + + /// + public async ValueTask ShutdownAsync(CancellationToken cancellationToken = default) + { + this.LogShuttingDownFeatureProvider(); + await _featureApi.ShutdownAsync().ConfigureAwait(false); + } + + [LoggerMessage(200, LogLevel.Information, "Starting initialization of the feature provider")] + partial void LogStartingInitializationOfFeatureProvider(); + + [LoggerMessage(200, LogLevel.Information, "Shutting down the feature provider")] + partial void LogShuttingDownFeatureProvider(); +} diff --git a/src/OpenFeature.Hosting/MultiTarget/CallerArgumentExpressionAttribute.cs b/src/OpenFeature.Hosting/MultiTarget/CallerArgumentExpressionAttribute.cs new file mode 100644 index 000000000..afbec6b06 --- /dev/null +++ b/src/OpenFeature.Hosting/MultiTarget/CallerArgumentExpressionAttribute.cs @@ -0,0 +1,23 @@ +// @formatter:off +// ReSharper disable All +#if NETCOREAPP3_0_OR_GREATER +// https://github.com/dotnet/runtime/issues/96197 +[assembly: System.Runtime.CompilerServices.TypeForwardedTo(typeof(System.Runtime.CompilerServices.CallerArgumentExpressionAttribute))] +#else +#pragma warning disable +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +namespace System.Runtime.CompilerServices; + +[AttributeUsage(AttributeTargets.Parameter, AllowMultiple = false, Inherited = false)] +internal sealed class CallerArgumentExpressionAttribute : Attribute +{ + public CallerArgumentExpressionAttribute(string parameterName) + { + ParameterName = parameterName; + } + + public string ParameterName { get; } +} +#endif diff --git a/src/OpenFeature.Hosting/MultiTarget/IsExternalInit.cs b/src/OpenFeature.Hosting/MultiTarget/IsExternalInit.cs new file mode 100644 index 000000000..877141115 --- /dev/null +++ b/src/OpenFeature.Hosting/MultiTarget/IsExternalInit.cs @@ -0,0 +1,21 @@ +// @formatter:off +// ReSharper disable All +#if NET5_0_OR_GREATER +// https://github.com/dotnet/runtime/issues/96197 +[assembly: System.Runtime.CompilerServices.TypeForwardedTo(typeof(System.Runtime.CompilerServices.IsExternalInit))] +#else +#pragma warning disable +// Licensed to the .NET Foundation under one or more agreements. +// The .NET Foundation licenses this file to you under the MIT license. + +using System.ComponentModel; + +namespace System.Runtime.CompilerServices; + +/// +/// Reserved to be used by the compiler for tracking metadata. +/// This class should not be used by developers in source code. +/// +[EditorBrowsable(EditorBrowsableState.Never)] +static class IsExternalInit { } +#endif diff --git a/src/OpenFeature.Hosting/OpenFeature.Hosting.csproj b/src/OpenFeature.Hosting/OpenFeature.Hosting.csproj index 1d54ff02e..84e5efa61 100644 --- a/src/OpenFeature.Hosting/OpenFeature.Hosting.csproj +++ b/src/OpenFeature.Hosting/OpenFeature.Hosting.csproj @@ -1,8 +1,9 @@ - +๏ปฟ - net8.0;net9.0 + netstandard2.0;net8.0;net9.0;net462 OpenFeature + README.md @@ -10,7 +11,13 @@ - + + + + + + + diff --git a/src/OpenFeature.Hosting/OpenFeatureBuilder.cs b/src/OpenFeature.Hosting/OpenFeatureBuilder.cs new file mode 100644 index 000000000..177a9fac3 --- /dev/null +++ b/src/OpenFeature.Hosting/OpenFeatureBuilder.cs @@ -0,0 +1,60 @@ +using Microsoft.Extensions.DependencyInjection; + +namespace OpenFeature.Hosting; + +/// +/// Describes a backed by an . +/// +/// The services being configured. +public class OpenFeatureBuilder(IServiceCollection services) +{ + /// The services being configured. + public IServiceCollection Services { get; } = services; + + /// + /// Indicates whether the evaluation context has been configured. + /// This property is used to determine if specific configurations or services + /// should be initialized based on the presence of an evaluation context. + /// + public bool IsContextConfigured { get; internal set; } + + /// + /// Indicates whether the policy has been configured. + /// + public bool IsPolicyConfigured { get; internal set; } + + /// + /// Gets a value indicating whether a default provider has been registered. + /// + public bool HasDefaultProvider { get; internal set; } + + /// + /// Gets the count of domain-bound providers that have been registered. + /// This count does not include the default provider. + /// + public int DomainBoundProviderRegistrationCount { get; internal set; } + + /// + /// Validates the current configuration, ensuring that a policy is set when multiple providers are registered + /// or when a default provider is registered alongside another provider. + /// + /// + /// Thrown if multiple providers are registered without a policy, or if both a default provider + /// and an additional provider are registered without a policy configuration. + /// + public void Validate() + { + if (!IsPolicyConfigured) + { + if (DomainBoundProviderRegistrationCount > 1) + { + throw new InvalidOperationException("Multiple providers have been registered, but no policy has been configured."); + } + + if (HasDefaultProvider && DomainBoundProviderRegistrationCount == 1) + { + throw new InvalidOperationException("A default provider and an additional provider have been registered without a policy configuration."); + } + } + } +} diff --git a/src/OpenFeature.Hosting/OpenFeatureBuilderExtensions.cs b/src/OpenFeature.Hosting/OpenFeatureBuilderExtensions.cs index 80e760d9d..52c66c42e 100644 --- a/src/OpenFeature.Hosting/OpenFeatureBuilderExtensions.cs +++ b/src/OpenFeature.Hosting/OpenFeatureBuilderExtensions.cs @@ -1,6 +1,10 @@ using Microsoft.Extensions.DependencyInjection; -using OpenFeature.DependencyInjection; +using Microsoft.Extensions.DependencyInjection.Extensions; +using Microsoft.Extensions.Options; +using OpenFeature.Constant; using OpenFeature.Hosting; +using OpenFeature.Hosting.Internal; +using OpenFeature.Model; namespace OpenFeature; @@ -9,6 +13,370 @@ namespace OpenFeature; /// public static partial class OpenFeatureBuilderExtensions { + /// + /// This method is used to add a new context to the service collection. + /// + /// The instance. + /// the desired configuration + /// The instance. + /// Thrown when the or action is null. + public static OpenFeatureBuilder AddContext(this OpenFeatureBuilder builder, Action configure) + { + Guard.ThrowIfNull(builder); + Guard.ThrowIfNull(configure); + + return builder.AddContext((b, _) => configure(b)); + } + + /// + /// This method is used to add a new context to the service collection. + /// + /// The instance. + /// the desired configuration + /// The instance. + /// Thrown when the or action is null. + public static OpenFeatureBuilder AddContext(this OpenFeatureBuilder builder, Action configure) + { + Guard.ThrowIfNull(builder); + Guard.ThrowIfNull(configure); + + builder.IsContextConfigured = true; + builder.Services.TryAddTransient(provider => + { + var contextBuilder = EvaluationContext.Builder(); + configure(contextBuilder, provider); + return contextBuilder.Build(); + }); + + return builder; + } + + /// + /// Adds a feature provider using a factory method without additional configuration options. + /// This method adds the feature provider as a transient service and sets it as the default provider within the application. + /// + /// The used to configure feature flags. + /// + /// A factory method that creates and returns a + /// instance based on the provided service provider. + /// + /// The updated instance with the default feature provider set and configured. + /// Thrown if the is null, as a valid builder is required to add and configure providers. + public static OpenFeatureBuilder AddProvider(this OpenFeatureBuilder builder, Func implementationFactory) + => AddProvider(builder, implementationFactory, null); + + /// + /// Adds a feature provider using a factory method to create the provider instance and optionally configures its settings. + /// This method adds the feature provider as a transient service and sets it as the default provider within the application. + /// + /// Type derived from used to configure the feature provider. + /// The used to configure feature flags. + /// + /// A factory method that creates and returns a + /// instance based on the provided service provider. + /// + /// An optional delegate to configure the provider-specific options. + /// The updated instance with the default feature provider set and configured. + /// Thrown if the is null, as a valid builder is required to add and configure providers. + public static OpenFeatureBuilder AddProvider(this OpenFeatureBuilder builder, Func implementationFactory, Action? configureOptions) + where TOptions : OpenFeatureOptions + { + Guard.ThrowIfNull(builder); + + builder.HasDefaultProvider = true; + builder.Services.PostConfigure(options => options.AddDefaultProviderName()); + if (configureOptions != null) + { + builder.Services.Configure(configureOptions); + } + + builder.Services.TryAddTransient(implementationFactory); + builder.AddClient(); + return builder; + } + + /// + /// Adds a feature provider for a specific domain using provided options and a configuration builder. + /// + /// Type derived from used to configure the feature provider. + /// The used to configure feature flags. + /// The unique name of the provider. + /// + /// A factory method that creates a feature provider instance. + /// It adds the provider as a transient service unless it is already added. + /// + /// An optional delegate to configure the provider-specific options. + /// The updated instance with the new feature provider configured. + /// + /// Thrown if either or is null or if the is empty. + /// + public static OpenFeatureBuilder AddProvider(this OpenFeatureBuilder builder, string domain, Func implementationFactory, Action? configureOptions) + where TOptions : OpenFeatureOptions + { + Guard.ThrowIfNull(builder); + + builder.DomainBoundProviderRegistrationCount++; + + builder.Services.PostConfigure(options => options.AddProviderName(domain)); + if (configureOptions != null) + { + builder.Services.Configure(domain, configureOptions); + } + + builder.Services.TryAddKeyedTransient(domain, (provider, key) => + { + if (key == null) + { + throw new ArgumentNullException(nameof(key)); + } + return implementationFactory(provider, key.ToString()!); + }); + + builder.AddClient(domain); + return builder; + } + + /// + /// Adds a feature provider for a specified domain using the default options. + /// This method configures a feature provider without custom options, delegating to the more generic AddProvider method. + /// + /// The used to configure feature flags. + /// The unique name of the provider. + /// + /// A factory method that creates a feature provider instance. + /// It adds the provider as a transient service unless it is already added. + /// + /// The updated instance with the new feature provider configured. + /// + /// Thrown if either or is null or if the is empty. + /// + public static OpenFeatureBuilder AddProvider(this OpenFeatureBuilder builder, string domain, Func implementationFactory) + => AddProvider(builder, domain, implementationFactory, configureOptions: null); + + /// + /// Adds a feature client to the service collection, configuring it to work with a specific context if provided. + /// + /// The instance. + /// Optional: The name for the feature client instance. + /// The instance. + internal static OpenFeatureBuilder AddClient(this OpenFeatureBuilder builder, string? name = null) + { + if (string.IsNullOrWhiteSpace(name)) + { + if (builder.IsContextConfigured) + { + builder.Services.TryAddScoped(static provider => + { + var api = provider.GetRequiredService(); + var client = api.GetClient(); + var context = provider.GetRequiredService(); + client.SetContext(context); + return client; + }); + } + else + { + builder.Services.TryAddScoped(static provider => + { + var api = provider.GetRequiredService(); + return api.GetClient(); + }); + } + } + else + { + if (builder.IsContextConfigured) + { + builder.Services.TryAddKeyedScoped(name, static (provider, key) => + { + var api = provider.GetRequiredService(); + var client = api.GetClient(key!.ToString()); + var context = provider.GetRequiredService(); + client.SetContext(context); + return client; + }); + } + else + { + builder.Services.TryAddKeyedScoped(name, static (provider, key) => + { + var api = provider.GetRequiredService(); + return api.GetClient(key!.ToString()); + }); + } + } + + return builder; + } + + /// + /// Adds a default to the based on the policy name options. + /// This method configures the dependency injection container to resolve the appropriate + /// depending on the policy name selected. + /// If no name is selected (i.e., null), it retrieves the default client. + /// + /// The instance. + /// The configured instance. + internal static OpenFeatureBuilder AddPolicyBasedClient(this OpenFeatureBuilder builder) + { + builder.Services.AddScoped(provider => + { + var policy = provider.GetRequiredService>().Value; + var name = policy.DefaultNameSelector(provider); + if (name == null) + { + return provider.GetRequiredService(); + } + return provider.GetRequiredKeyedService(name); + }); + + return builder; + } + + /// + /// Configures policy name options for OpenFeature using the specified options type. + /// + /// The type of options used to configure . + /// The instance. + /// A delegate to configure . + /// The configured instance. + /// Thrown when the or is null. + public static OpenFeatureBuilder AddPolicyName(this OpenFeatureBuilder builder, Action configureOptions) + where TOptions : PolicyNameOptions + { + Guard.ThrowIfNull(builder); + Guard.ThrowIfNull(configureOptions); + + builder.IsPolicyConfigured = true; + + builder.Services.Configure(configureOptions); + return builder; + } + + /// + /// Configures the default policy name options for OpenFeature. + /// + /// The instance. + /// A delegate to configure . + /// The configured instance. + public static OpenFeatureBuilder AddPolicyName(this OpenFeatureBuilder builder, Action configureOptions) + => AddPolicyName(builder, configureOptions); + + /// + /// Adds a feature hook to the service collection using a factory method. Hooks added here are not domain-bound. + /// + /// The type of to be added. + /// The instance. + /// Optional factory for controlling how will be created in the DI container. + /// The instance. + public static OpenFeatureBuilder AddHook< +#if NET + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] +#endif + THook>(this OpenFeatureBuilder builder, Func? implementationFactory = null) + where THook : Hook + { + return builder.AddHook(typeof(THook).Name, implementationFactory); + } + + /// + /// Adds a feature hook to the service collection. Hooks added here are not domain-bound. + /// + /// The type of to be added. + /// The instance. + /// Instance of Hook to inject into the OpenFeature context. + /// The instance. + public static OpenFeatureBuilder AddHook< +#if NET + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] +#endif + THook>(this OpenFeatureBuilder builder, THook hook) + where THook : Hook + { + return builder.AddHook(typeof(THook).Name, hook); + } + + /// + /// Adds a feature hook to the service collection with a specified name. Hooks added here are not domain-bound. + /// + /// The type of to be added. + /// The instance. + /// The name of the that is being added. + /// Instance of Hook to inject into the OpenFeature context. + /// The instance. + public static OpenFeatureBuilder AddHook< +#if NET + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] +#endif + THook>(this OpenFeatureBuilder builder, string hookName, THook hook) + where THook : Hook + { + return builder.AddHook(hookName, _ => hook); + } + + /// + /// Adds a feature hook to the service collection using a factory method and specified name. Hooks added here are not domain-bound. + /// + /// The type of to be added. + /// The instance. + /// The name of the that is being added. + /// Optional factory for controlling how will be created in the DI container. + /// The instance. + public static OpenFeatureBuilder AddHook< +#if NET + [System.Diagnostics.CodeAnalysis.DynamicallyAccessedMembers(System.Diagnostics.CodeAnalysis.DynamicallyAccessedMemberTypes.PublicConstructors)] +#endif + THook> + (this OpenFeatureBuilder builder, string hookName, Func? implementationFactory = null) + where THook : Hook + { + builder.Services.PostConfigure(options => options.AddHookName(hookName)); + + if (implementationFactory is not null) + { + builder.Services.TryAddKeyedSingleton(hookName, (serviceProvider, key) => + { + return implementationFactory(serviceProvider); + }); + } + else + { + builder.Services.TryAddKeyedSingleton(hookName); + } + + return builder; + } + + /// + /// Add a to allow you to react to state changes in the provider or underlying flag management system, such as flag definition changes, provider readiness, or error conditions + /// + /// The instance. + /// The type to handle. + /// The handler which reacts to . + /// The instance. + public static OpenFeatureBuilder AddHandler(this OpenFeatureBuilder builder, ProviderEventTypes type, EventHandlerDelegate eventHandlerDelegate) + { + return AddHandler(builder, type, _ => eventHandlerDelegate); + } + + /// + /// Add a to allow you to react to state changes in the provider or underlying flag management system, such as flag definition changes, provider readiness, or error conditions + /// + /// The instance. + /// The type to handle. + /// The handler factory for creating a handler which reacts to . + /// The instance. + public static OpenFeatureBuilder AddHandler(this OpenFeatureBuilder builder, ProviderEventTypes type, Func implementationFactory) + { + builder.Services.AddSingleton((serviceProvider) => + { + var handler = implementationFactory(serviceProvider); + return new EventHandlerDelegateWrapper(type, handler); + }); + + return builder; + } + /// /// Adds the to the OpenFeatureBuilder, /// which manages the lifecycle of features within the application. It also allows @@ -17,6 +385,7 @@ public static partial class OpenFeatureBuilderExtensions /// The instance. /// An optional action to configure . /// The instance. + [Obsolete("Calling AddHostedFeatureLifecycle() is no longer necessary. OpenFeature will inject this automatically when you call AddOpenFeature().")] public static OpenFeatureBuilder AddHostedFeatureLifecycle(this OpenFeatureBuilder builder, Action? configureOptions = null) { if (configureOptions is not null) diff --git a/src/OpenFeature.Hosting/OpenFeatureOptions.cs b/src/OpenFeature.Hosting/OpenFeatureOptions.cs new file mode 100644 index 000000000..9d3dd818e --- /dev/null +++ b/src/OpenFeature.Hosting/OpenFeatureOptions.cs @@ -0,0 +1,61 @@ +namespace OpenFeature.Hosting; + +/// +/// Options to configure OpenFeature +/// +public class OpenFeatureOptions +{ + private readonly HashSet _providerNames = []; + + /// + /// Determines if a default provider has been registered. + /// + public bool HasDefaultProvider { get; private set; } + + /// + /// The type of the configured feature provider. + /// + public Type FeatureProviderType { get; protected internal set; } = null!; + + /// + /// Gets a read-only list of registered provider names. + /// + public IReadOnlyCollection ProviderNames => _providerNames; + + /// + /// Registers the default provider name if no specific name is provided. + /// Sets to true. + /// + protected internal void AddDefaultProviderName() => AddProviderName(null); + + /// + /// Registers a new feature provider name. This operation is thread-safe. + /// + /// The name of the feature provider to register. Registers as default if null. + protected internal void AddProviderName(string? name) + { + if (string.IsNullOrWhiteSpace(name)) + { + HasDefaultProvider = true; + } + else + { + lock (_providerNames) + { + _providerNames.Add(name!); + } + } + } + + private readonly HashSet _hookNames = []; + + internal IReadOnlyCollection HookNames => _hookNames; + + internal void AddHookName(string name) + { + lock (_hookNames) + { + _hookNames.Add(name); + } + } +} diff --git a/src/OpenFeature.Hosting/OpenFeatureServiceCollectionExtensions.cs b/src/OpenFeature.Hosting/OpenFeatureServiceCollectionExtensions.cs new file mode 100644 index 000000000..236dc62b0 --- /dev/null +++ b/src/OpenFeature.Hosting/OpenFeatureServiceCollectionExtensions.cs @@ -0,0 +1,62 @@ +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.DependencyInjection.Extensions; +using Microsoft.Extensions.Options; +using OpenFeature.Hosting; +using OpenFeature.Hosting.Internal; + +namespace OpenFeature; + +/// +/// Contains extension methods for the class. +/// +public static partial class OpenFeatureServiceCollectionExtensions +{ + /// + /// Adds and configures OpenFeature services to the provided . + /// + /// The instance. + /// A configuration action for customizing OpenFeature setup via + /// The modified instance + /// Thrown if or is null. + public static IServiceCollection AddOpenFeature(this IServiceCollection services, Action configure) + { + Guard.ThrowIfNull(services); + Guard.ThrowIfNull(configure); + + // Register core OpenFeature services as singletons. + services.TryAddSingleton(Api.Instance); + services.TryAddSingleton(); + + var builder = new OpenFeatureBuilder(services); + configure(builder); + + builder.Services.AddHostedService(); + + // If a default provider is specified without additional providers, + // return early as no extra configuration is needed. + if (builder.HasDefaultProvider && builder.DomainBoundProviderRegistrationCount == 0) + { + return services; + } + + // Validate builder configuration to ensure consistency and required setup. + builder.Validate(); + + if (!builder.IsPolicyConfigured) + { + // Add a default name selector policy to use the first registered provider name as the default. + builder.AddPolicyName(options => + { + options.DefaultNameSelector = provider => + { + var options = provider.GetRequiredService>().Value; + return options.ProviderNames.First(); + }; + }); + } + + builder.AddPolicyBasedClient(); + + return services; + } +} diff --git a/src/OpenFeature.Hosting/PolicyNameOptions.cs b/src/OpenFeature.Hosting/PolicyNameOptions.cs new file mode 100644 index 000000000..3dfa76f89 --- /dev/null +++ b/src/OpenFeature.Hosting/PolicyNameOptions.cs @@ -0,0 +1,12 @@ +namespace OpenFeature.Hosting; + +/// +/// Options to configure the default feature client name. +/// +public class PolicyNameOptions +{ + /// + /// A delegate to select the default feature client name. + /// + public Func DefaultNameSelector { get; set; } = null!; +} diff --git a/src/OpenFeature.Hosting/Providers/Memory/FeatureBuilderExtensions.cs b/src/OpenFeature.Hosting/Providers/Memory/FeatureBuilderExtensions.cs new file mode 100644 index 000000000..d63009d62 --- /dev/null +++ b/src/OpenFeature.Hosting/Providers/Memory/FeatureBuilderExtensions.cs @@ -0,0 +1,126 @@ +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Options; +using OpenFeature.Providers.Memory; + +namespace OpenFeature.Hosting.Providers.Memory; + +/// +/// Extension methods for configuring feature providers with . +/// +#if NET8_0_OR_GREATER +[System.Diagnostics.CodeAnalysis.Experimental(Diagnostics.FeatureCodes.NewDi)] +#endif +public static partial class FeatureBuilderExtensions +{ + /// + /// Adds an in-memory feature provider to the with a factory for flags. + /// + /// The instance to configure. + /// + /// A factory function to provide an of flags. + /// If null, an empty provider will be created. + /// + /// The instance for chaining. + public static OpenFeatureBuilder AddInMemoryProvider(this OpenFeatureBuilder builder, Func?> flagsFactory) + => builder.AddProvider(provider => + { + var flags = flagsFactory(provider); + if (flags == null) + { + return new InMemoryProvider(); + } + + return new InMemoryProvider(flags); + }); + + /// + /// Adds an in-memory feature provider to the with a domain and factory for flags. + /// + /// The instance to configure. + /// The unique domain of the provider. + /// + /// A factory function to provide an of flags. + /// If null, an empty provider will be created. + /// + /// The instance for chaining. + public static OpenFeatureBuilder AddInMemoryProvider(this OpenFeatureBuilder builder, string domain, Func?> flagsFactory) + => builder.AddInMemoryProvider(domain, (provider, _) => flagsFactory(provider)); + + /// + /// Adds an in-memory feature provider to the with a domain and contextual flag factory. + /// If null, an empty provider will be created. + /// + /// The instance to configure. + /// The unique domain of the provider. + /// + /// A factory function to provide an of flags based on service provider and domain. + /// + /// The instance for chaining. + public static OpenFeatureBuilder AddInMemoryProvider(this OpenFeatureBuilder builder, string domain, Func?> flagsFactory) + => builder.AddProvider(domain, (provider, key) => + { + var flags = flagsFactory(provider, key); + if (flags == null) + { + return new InMemoryProvider(); + } + + return new InMemoryProvider(flags); + }); + + /// + /// Adds an in-memory feature provider to the with optional flag configuration. + /// + /// The instance to configure. + /// + /// An optional delegate to configure feature flags in the in-memory provider. + /// If null, an empty provider will be created. + /// + /// The instance for chaining. + public static OpenFeatureBuilder AddInMemoryProvider(this OpenFeatureBuilder builder, Action>? configure = null) + => builder.AddProvider(CreateProvider, options => ConfigureFlags(options, configure)); + + /// + /// Adds an in-memory feature provider with a specific domain to the with optional flag configuration. + /// + /// The instance to configure. + /// The unique domain of the provider + /// + /// An optional delegate to configure feature flags in the in-memory provider. + /// If null, an empty provider will be created. + /// + /// The instance for chaining. + public static OpenFeatureBuilder AddInMemoryProvider(this OpenFeatureBuilder builder, string domain, Action>? configure = null) + => builder.AddProvider(domain, CreateProvider, options => ConfigureFlags(options, configure)); + + private static FeatureProvider CreateProvider(IServiceProvider provider, string domain) + { + var options = provider.GetRequiredService>().Get(domain); + if (options.Flags == null) + { + return new InMemoryProvider(); + } + + return new InMemoryProvider(options.Flags); + } + + private static FeatureProvider CreateProvider(IServiceProvider provider) + { + var options = provider.GetRequiredService>().Value; + if (options.Flags == null) + { + return new InMemoryProvider(); + } + + return new InMemoryProvider(options.Flags); + } + + private static void ConfigureFlags(InMemoryProviderOptions options, Action>? configure) + { + if (configure != null) + { + options.Flags = new Dictionary(); + configure.Invoke(options.Flags); + } + } +} diff --git a/src/OpenFeature.Hosting/Providers/Memory/InMemoryProviderOptions.cs b/src/OpenFeature.Hosting/Providers/Memory/InMemoryProviderOptions.cs new file mode 100644 index 000000000..3e7431eef --- /dev/null +++ b/src/OpenFeature.Hosting/Providers/Memory/InMemoryProviderOptions.cs @@ -0,0 +1,19 @@ +using OpenFeature.Providers.Memory; + +namespace OpenFeature.Hosting.Providers.Memory; + +/// +/// Options for configuring the in-memory feature flag provider. +/// +public class InMemoryProviderOptions : OpenFeatureOptions +{ + /// + /// Gets or sets the feature flags to be used by the in-memory provider. + /// + /// + /// This property allows you to specify a dictionary of flags where the key is the flag name + /// and the value is the corresponding instance. + /// If no flags are provided, the in-memory provider will start with an empty set of flags. + /// + public IDictionary? Flags { get; set; } +} diff --git a/src/OpenFeature.Hosting/README.md b/src/OpenFeature.Hosting/README.md new file mode 100644 index 000000000..3b530d214 --- /dev/null +++ b/src/OpenFeature.Hosting/README.md @@ -0,0 +1,141 @@ +# OpenFeature.Hosting + +[![NuGet](https://img.shields.io/nuget/vpre/OpenFeature.Hosting?label=OpenFeature.Hosting&style=for-the-badge)](https://www.nuget.org/packages/OpenFeature.Hosting) +[![Specification](https://img.shields.io/static/v1?label=specification&message=v0.8.0&color=yellow&style=for-the-badge)](https://github.com/open-feature/spec/releases/tag/v0.8.0) + +OpenFeature.Hosting is an extension for the [OpenFeature .NET SDK](https://github.com/open-feature/dotnet-sdk) that streamlines integration with .NET applications using dependency injection and hosting. It enables seamless configuration and lifecycle management of feature flag providers, hooks, and evaluation context using idiomatic .NET patterns. + +**๐Ÿงช The OpenFeature.Hosting package is still considered experimental and may undergo significant changes. Feedback and contributions are welcome!** + +## ๐Ÿš€ Quick Start + +### Requirements + +- .NET 8+ +- .NET Framework 4.6.2+ + +### Installation + +Add the package to your project: + +```sh +dotnet add package OpenFeature.Hosting +``` + +### Basic Usage + +Register OpenFeature in your application's dependency injection container (e.g., in `Program.cs` for ASP.NET Core): + +```csharp +builder.Services.AddOpenFeature(featureBuilder => { + featureBuilder + .AddInMemoryProvider(); +}); +``` + +You can add global evaluation context, hooks, and event handlers as needed: + +```csharp +builder.Services.AddOpenFeature(featureBuilder => { + featureBuilder + .AddContext((contextBuilder, serviceProvider) => { + // Custom context configuration + }) + .AddHook() + .AddHandler(ProviderEventTypes.ProviderReady, (eventDetails) => { + // Handle provider ready event + }); +}); +``` + +### Domain-Scoped Providers + +To register multiple providers and select a default provider by domain: + +```csharp +builder.Services.AddOpenFeature(featureBuilder => { + featureBuilder + .AddInMemoryProvider("default") + .AddInMemoryProvider("beta") + .AddPolicyName(options => { + options.DefaultNameSelector = serviceProvider => "default"; + }); +}); +``` + +### Registering a Custom Provider + +You can register a custom provider using a factory: + +```csharp +builder.Services.AddOpenFeature(featureBuilder => { + featureBuilder.AddProvider(provider => { + // Resolve services or configuration as needed + return new MyCustomProvider(); + }); +}); +``` + +## ๐Ÿงฉ Features + +- **Dependency Injection**: Register providers, hooks, and context using the .NET DI container. +- **Domain Support**: Assign providers to logical domains for multi-tenancy or environment separation. +- **Event Handlers**: React to provider lifecycle events (e.g., readiness). +- **Extensibility**: Add custom hooks, context, and providers. + +## ๐Ÿ› ๏ธ Example: ASP.NET Core Integration + +Below is a simple example of integrating OpenFeature with an ASP.NET Core application using an in-memory provider and a logging hook. + +```csharp +var builder = WebApplication.CreateBuilder(args); + +builder.Services.AddOpenFeature(featureBuilder => { + featureBuilder + .AddInMemoryProvider() + .AddHook(); +}); + +var app = builder.Build(); + +app.MapGet("/", async (IFeatureClient client) => { + bool enabled = await client.GetBooleanValueAsync("my-flag", false); + return enabled ? "Feature enabled!" : "Feature disabled."; +}); + +app.Run(); +``` + +If you have multiple providers registered, you can specify which client and provider to resolve by using the `FromKeyedServices` attribute: + +```csharp +var builder = WebApplication.CreateBuilder(args); + +builder.Services.AddOpenFeature(featureBuilder => { + featureBuilder + .AddInMemoryProvider("default") + .AddInMemoryProvider("beta") + .AddPolicyName(options => { + options.DefaultNameSelector = serviceProvider => "default"; + }); +}); + +var app = builder.Build(); + +app.MapGet("/", async ([FromKeyedServices("beta")] IFeatureClient client) => { + bool enabled = await client.GetBooleanValueAsync("my-flag", false); + return enabled ? "Feature enabled!" : "Feature disabled."; +}); + +app.Run(); +``` + +## ๐Ÿ“š Further Reading + +- [OpenFeature .NET SDK Documentation](https://github.com/open-feature/dotnet-sdk) +- [OpenFeature Specification](https://openfeature.dev) +- [Samples](https://github.com/open-feature/dotnet-sdk/blob/main/samples/AspNetCore/README.md) + +## ๐Ÿค Contributing + +Contributions are welcome! See the [CONTRIBUTING](https://github.com/open-feature/dotnet-sdk/blob/main/CONTRIBUTING.md) guide for details. diff --git a/src/OpenFeature.Providers.MultiProvider/Models/ChildProviderStatus.cs b/src/OpenFeature.Providers.MultiProvider/Models/ChildProviderStatus.cs new file mode 100644 index 000000000..f66f8fae7 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Models/ChildProviderStatus.cs @@ -0,0 +1,7 @@ +namespace OpenFeature.Providers.MultiProvider.Models; + +internal class ChildProviderStatus +{ + public string ProviderName { get; set; } = string.Empty; + public Exception? Error { get; set; } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Models/ProviderEntry.cs b/src/OpenFeature.Providers.MultiProvider/Models/ProviderEntry.cs new file mode 100644 index 000000000..da720da6c --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Models/ProviderEntry.cs @@ -0,0 +1,29 @@ +namespace OpenFeature.Providers.MultiProvider.Models; + +/// +/// Represents an entry for a provider in the multi-provider configuration. +/// +public class ProviderEntry +{ + /// + /// Initializes a new instance of the class. + /// + /// The feature provider instance. + /// Optional custom name for the provider. If not provided, the provider's metadata name will be used. + public ProviderEntry(FeatureProvider provider, string? name = null) + { + this.Provider = provider ?? throw new ArgumentNullException(nameof(provider)); + this.Name = name; + } + + /// + /// Gets the feature provider instance. + /// + public FeatureProvider Provider { get; } + + /// + /// Gets the optional custom name for the provider. + /// If null, the provider's metadata name should be used. + /// + public string? Name { get; } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Models/RegisteredProvider.cs b/src/OpenFeature.Providers.MultiProvider/Models/RegisteredProvider.cs new file mode 100644 index 000000000..ee62fd006 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Models/RegisteredProvider.cs @@ -0,0 +1,41 @@ +namespace OpenFeature.Providers.MultiProvider.Models; + +internal class RegisteredProvider +{ +#if NET9_0_OR_GREATER + private readonly Lock _statusLock = new(); +#else + private readonly object _statusLock = new object(); +#endif + + private Constant.ProviderStatus _status = Constant.ProviderStatus.NotReady; + + internal RegisteredProvider(FeatureProvider provider, string name) + { + this.Provider = provider ?? throw new ArgumentNullException(nameof(provider)); + this.Name = name ?? throw new ArgumentNullException(nameof(name)); + } + + internal FeatureProvider Provider { get; } + + internal string Name { get; } + + internal Constant.ProviderStatus Status + { + get + { + lock (this._statusLock) + { + return this._status; + } + } + } + + internal void SetStatus(Constant.ProviderStatus status) + { + lock (this._statusLock) + { + this._status = status; + } + } +} diff --git a/src/OpenFeature.Providers.MultiProvider/MultiProvider.cs b/src/OpenFeature.Providers.MultiProvider/MultiProvider.cs new file mode 100644 index 000000000..9737198f0 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/MultiProvider.cs @@ -0,0 +1,641 @@ +using System.Collections.Concurrent; +using System.Collections.ObjectModel; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Models; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider; + +/// +/// A feature provider that enables the use of multiple underlying providers, allowing different providers +/// to be used for different flag keys or based on specific routing logic. +/// +/// +/// The MultiProvider acts as a composite provider that can delegate flag resolution to different +/// underlying providers based on configuration or routing rules. This enables scenarios where +/// different feature flags may be served by different sources or providers within the same application. +/// +/// Multi Provider specification +public sealed partial class MultiProvider : FeatureProvider, IAsyncDisposable +{ + private readonly BaseEvaluationStrategy _evaluationStrategy; + private readonly IReadOnlyList _registeredProviders; + private readonly Metadata _metadata; + + private readonly SemaphoreSlim _initializationSemaphore = new(1, 1); + private readonly SemaphoreSlim _shutdownSemaphore = new(1, 1); + private readonly object _providerStatusLock = new(); + private ProviderStatus _providerStatus = ProviderStatus.NotReady; + // 0 = Not disposed, 1 = Disposed + // This is to handle the dispose pattern correctly with the async initialization and shutdown methods + private volatile int _disposed; + + // Event handling infrastructure + private readonly ConcurrentDictionary _eventListeningTasks = new(); + private readonly CancellationTokenSource _eventProcessingCancellation = new(); + private readonly ILogger _logger; + + /// + /// Initializes a new instance of the class with the specified provider entries and evaluation strategy. + /// + /// A collection of provider entries containing the feature providers and their optional names. + /// The base evaluation strategy to use for determining how to evaluate features across multiple providers. If not specified, the first matching strategy will be used. + /// The logger for the client. + public MultiProvider(IEnumerable providerEntries, BaseEvaluationStrategy? evaluationStrategy = null, ILogger? logger = null) + { + if (providerEntries == null) + { + throw new ArgumentNullException(nameof(providerEntries)); + } + + var entries = providerEntries.ToList(); + if (entries.Count == 0) + { + throw new ArgumentException("At least one provider entry must be provided.", nameof(providerEntries)); + } + + this._evaluationStrategy = evaluationStrategy ?? new FirstMatchStrategy(); + this._registeredProviders = RegisterProviders(entries); + + // Create aggregate metadata + this._metadata = new Metadata(MultiProviderConstants.ProviderName); + + // Start listening to events from all registered providers + this.StartListeningToProviderEvents(); + + // Set logger + this._logger = logger ?? NullLogger.Instance; + } + + /// + public override Metadata GetMetadata() => this._metadata; + + /// + internal override ProviderStatus Status + { + get + { + lock (this._providerStatusLock) + { + return this._providerStatus; + } + } + set + { + lock (this._providerStatusLock) + { + this._providerStatus = value; + } + } + } + + /// + public override Task> ResolveBooleanValueAsync(string flagKey, bool defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) => + this.EvaluateAsync(flagKey, defaultValue, context, cancellationToken); + + /// + public override Task> ResolveDoubleValueAsync(string flagKey, double defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) => + this.EvaluateAsync(flagKey, defaultValue, context, cancellationToken); + + /// + public override Task> ResolveIntegerValueAsync(string flagKey, int defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) => + this.EvaluateAsync(flagKey, defaultValue, context, cancellationToken); + + /// + public override Task> ResolveStringValueAsync(string flagKey, string defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) => + this.EvaluateAsync(flagKey, defaultValue, context, cancellationToken); + + /// + public override Task> ResolveStructureValueAsync(string flagKey, Value defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) => + this.EvaluateAsync(flagKey, defaultValue, context, cancellationToken); + + /// + public override async Task InitializeAsync(EvaluationContext context, CancellationToken cancellationToken = default) + { + if (this._disposed == 1) + { + throw new ObjectDisposedException(nameof(MultiProvider)); + } + + await this._initializationSemaphore.WaitAsync(cancellationToken).ConfigureAwait(false); + try + { + if (this.Status != ProviderStatus.NotReady || this._disposed == 1) + { + return; + } + + var initializationTasks = this._registeredProviders.Select(async rp => + { + try + { + await rp.Provider.InitializeAsync(context, cancellationToken).ConfigureAwait(false); + rp.SetStatus(ProviderStatus.Ready); + return new ChildProviderStatus { ProviderName = rp.Name }; + } + catch (Exception ex) + { + rp.SetStatus(ProviderStatus.Fatal); + return new ChildProviderStatus { ProviderName = rp.Name, Error = ex }; + } + }); + + var results = await Task.WhenAll(initializationTasks).ConfigureAwait(false); + var failures = results.Where(r => r.Error != null).ToList(); + + if (failures.Count != 0) + { + var exceptions = failures.Select(f => f.Error!).ToList(); + var failedProviders = failures.Select(f => f.ProviderName).ToList(); + this.Status = ProviderStatus.Fatal; + + // Emit error event + await this.EmitEvent(new ProviderEventPayload + { + ProviderName = this._metadata.Name, + Type = ProviderEventTypes.ProviderError, + Message = $"Failed to initialize providers: {string.Join(", ", failedProviders)}", + ErrorType = ErrorType.ProviderFatal + }, cancellationToken).ConfigureAwait(false); + + throw new AggregateException( + $"Failed to initialize providers: {string.Join(", ", failedProviders)}", + exceptions); + } + else + { + this.Status = ProviderStatus.Ready; + + // Emit ready event + await this.EmitEvent(new ProviderEventPayload + { + ProviderName = this._metadata.Name, + Type = ProviderEventTypes.ProviderReady, + Message = "MultiProvider successfully initialized" + }, cancellationToken).ConfigureAwait(false); + } + } + finally + { + this._initializationSemaphore.Release(); + } + } + + /// + public override async Task ShutdownAsync(CancellationToken cancellationToken = default) + { + if (this._disposed == 1) + { + throw new ObjectDisposedException(nameof(MultiProvider)); + } + + await this.InternalShutdownAsync(cancellationToken).ConfigureAwait(false); + } + + private async Task> EvaluateAsync(string key, T defaultValue, EvaluationContext? evaluationContext = null, CancellationToken cancellationToken = default) + { + // Check if the provider has been disposed + // This is to handle the dispose pattern correctly with the async initialization and shutdown methods + // It is checked here to avoid the check in every public EvaluateAsync method + if (this._disposed == 1) + { + throw new ObjectDisposedException(nameof(MultiProvider)); + } + + try + { + var strategyContext = new StrategyEvaluationContext(key); + var resolutions = this._evaluationStrategy.RunMode switch + { + RunMode.Parallel => await this + .ParallelEvaluationAsync(key, defaultValue, evaluationContext, cancellationToken) + .ConfigureAwait(false), + RunMode.Sequential => await this + .SequentialEvaluationAsync(key, defaultValue, evaluationContext, cancellationToken) + .ConfigureAwait(false), + _ => throw new NotSupportedException($"Unsupported run mode: {this._evaluationStrategy.RunMode}") + }; + + var finalResult = this._evaluationStrategy.DetermineFinalResult(strategyContext, key, defaultValue, + evaluationContext, resolutions); + return finalResult.Details; + } + catch (NotSupportedException ex) + { + // Emit error event for unsupported run mode + await this.EmitEvent(new ProviderEventPayload + { + ProviderName = this._metadata.Name, + Type = ProviderEventTypes.ProviderError, + Message = $"Error evaluating flag '{key}' with run mode {this._evaluationStrategy.RunMode}", + ErrorType = ErrorType.ProviderFatal + }, cancellationToken).ConfigureAwait(false); + + return new ResolutionDetails(key, defaultValue, ErrorType.ProviderFatal, Reason.Error, errorMessage: ex.Message); + } + catch (Exception ex) + { + // Emit error event for evaluation failures + await this.EmitEvent(new ProviderEventPayload + { + ProviderName = this._metadata.Name, + Type = ProviderEventTypes.ProviderError, + Message = $"Error evaluating flag '{key}': {ex.Message}", + ErrorType = ErrorType.General, + FlagsChanged = [key] + }, cancellationToken).ConfigureAwait(false); + + return new ResolutionDetails(key, defaultValue, ErrorType.General, Reason.Error, errorMessage: ex.Message); + } + } + + private async Task>> SequentialEvaluationAsync(string key, T defaultValue, EvaluationContext? evaluationContext, CancellationToken cancellationToken) + { + var resolutions = new List>(); + + foreach (var registeredProvider in this._registeredProviders) + { + var providerContext = new StrategyPerProviderContext( + registeredProvider.Provider, + registeredProvider.Name, + registeredProvider.Status, + key); + + if (!this._evaluationStrategy.ShouldEvaluateThisProvider(providerContext, evaluationContext)) + { + continue; + } + + var result = await registeredProvider.Provider.EvaluateAsync(providerContext, evaluationContext, defaultValue, this._logger, cancellationToken).ConfigureAwait(false); + resolutions.Add(result); + + if (!this._evaluationStrategy.ShouldEvaluateNextProvider(providerContext, evaluationContext, result)) + { + break; + } + } + + return resolutions; + } + + private async Task>> ParallelEvaluationAsync(string key, T defaultValue, EvaluationContext? evaluationContext, CancellationToken cancellationToken) + { + var resolutions = new List>(); + var tasks = new List>>(); + + foreach (var registeredProvider in this._registeredProviders) + { + var providerContext = new StrategyPerProviderContext( + registeredProvider.Provider, + registeredProvider.Name, + registeredProvider.Status, + key); + + if (this._evaluationStrategy.ShouldEvaluateThisProvider(providerContext, evaluationContext)) + { + tasks.Add(registeredProvider.Provider.EvaluateAsync(providerContext, evaluationContext, defaultValue, this._logger, cancellationToken)); + } + } + + var results = await Task.WhenAll(tasks).ConfigureAwait(false); + resolutions.AddRange(results); + + return resolutions; + } + + private void StartListeningToProviderEvents() + { + foreach (var registeredProvider in this._registeredProviders) + { + if (!this._eventListeningTasks.TryAdd(registeredProvider.Provider, this.ProcessProviderEventsAsync(registeredProvider))) + { + // Log a warning if the provider is already being listened to + this.LogProviderAlreadyBeingListenedTo(registeredProvider.Name); + } + } + } + + private async Task ProcessProviderEventsAsync(RegisteredProvider registeredProvider) + { + var eventChannel = registeredProvider.Provider.GetEventChannel(); + + // Get the cancellation token safely for this provider's event processing (this prevents ObjectDisposedException during concurrent shutdown) + CancellationToken cancellationToken; + try + { + cancellationToken = this._eventProcessingCancellation.Token; + } + catch (ObjectDisposedException) + { + // Already disposed, exit early + return; + } + + while (await eventChannel.Reader.WaitToReadAsync(cancellationToken).ConfigureAwait(false)) + { + while (eventChannel.Reader.TryRead(out var item)) + { + if (cancellationToken.IsCancellationRequested) + { + return; + } + + if (item is not Event { EventPayload: { } eventPayload }) + { + continue; + } + + await this.HandleProviderEventAsync(registeredProvider, eventPayload, cancellationToken).ConfigureAwait(false); + } + } + } + + private async Task HandleProviderEventAsync(RegisteredProvider registeredProvider, ProviderEventPayload eventPayload, CancellationToken cancellationToken = default) + { + try + { + // Handle PROVIDER_CONFIGURATION_CHANGED events specially - these are always re-emitted + if (eventPayload.Type == ProviderEventTypes.ProviderConfigurationChanged) + { + await this.EmitEvent(new ProviderEventPayload + { + ProviderName = $"{this._metadata.Name}/{registeredProvider.Name}", + Type = eventPayload.Type, + Message = eventPayload.Message ?? $"Configuration changed in provider {registeredProvider.Name}", + FlagsChanged = eventPayload.FlagsChanged, + EventMetadata = eventPayload.EventMetadata + }, cancellationToken).ConfigureAwait(false); + return; + } + + // For status-changing events, update provider status and check if MultiProvider status should change + UpdateProviderStatusFromEvent(registeredProvider, eventPayload); + + // Check if MultiProvider status has changed due to this provider's status change + var providerStatuses = this._registeredProviders.Select(rp => rp.Status).ToList(); + var newMultiProviderStatus = DetermineAggregateStatus(providerStatuses); + + ProviderStatus previousStatus; + ProviderEventTypes? eventType = null; + + // Only emit event if MultiProvider status actually changed + lock (this._providerStatusLock) + { + if (newMultiProviderStatus != this._providerStatus) + { + previousStatus = this._providerStatus; + this._providerStatus = newMultiProviderStatus; + + eventType = newMultiProviderStatus switch + { + ProviderStatus.Ready => ProviderEventTypes.ProviderReady, + ProviderStatus.Error or ProviderStatus.Fatal => ProviderEventTypes.ProviderError, + ProviderStatus.Stale => ProviderEventTypes.ProviderStale, + _ => (ProviderEventTypes?)null + }; + } + else + { + return; // No status change, no event to emit + } + } + + if (eventType.HasValue) + { + await this.EmitEvent(new ProviderEventPayload + { + ProviderName = this._metadata.Name, + Type = eventType.Value, + Message = $"MultiProvider status changed from {previousStatus} to {newMultiProviderStatus} due to provider {registeredProvider.Name}", + ErrorType = newMultiProviderStatus == ProviderStatus.Fatal ? ErrorType.ProviderFatal : eventPayload.ErrorType, + FlagsChanged = eventPayload.FlagsChanged, + EventMetadata = eventPayload.EventMetadata + }, cancellationToken).ConfigureAwait(false); + } + } + catch (Exception ex) + { + // If there's an error processing the event, emit an error event + await this.EmitEvent(new ProviderEventPayload + { + ProviderName = this._metadata.Name, + Type = ProviderEventTypes.ProviderError, + Message = $"Error processing event from provider {registeredProvider.Name}: {ex.Message}", + ErrorType = ErrorType.General + }, cancellationToken).ConfigureAwait(false); + } + } + + private static void UpdateProviderStatusFromEvent(RegisteredProvider registeredProvider, ProviderEventPayload eventPayload) + { + var newStatus = eventPayload.Type switch + { + ProviderEventTypes.ProviderReady => ProviderStatus.Ready, + ProviderEventTypes.ProviderError => eventPayload.ErrorType == ErrorType.ProviderFatal + ? ProviderStatus.Fatal + : ProviderStatus.Error, + ProviderEventTypes.ProviderStale => ProviderStatus.Stale, + _ => registeredProvider.Status // No status change for PROVIDER_CONFIGURATION_CHANGED + }; + + if (newStatus != registeredProvider.Status) + { + registeredProvider.SetStatus(newStatus); + } + } + + private async Task EmitEvent(ProviderEventPayload eventPayload, CancellationToken cancellationToken) + { + try + { + await this.EventChannel.Writer.WriteAsync(eventPayload, cancellationToken).ConfigureAwait(false); + } + catch (Exception) + { + // If we can't write to the event channel (e.g., it's closed), ignore the error + } + } + + private static ProviderStatus DetermineAggregateStatus(List providerStatuses) + { + // Check in precedence order as per specification + if (providerStatuses.Any(status => status == ProviderStatus.Fatal)) + { + return ProviderStatus.Fatal; + } + + if (providerStatuses.Any(status => status == ProviderStatus.NotReady)) + { + return ProviderStatus.NotReady; + } + + if (providerStatuses.Any(status => status == ProviderStatus.Error)) + { + return ProviderStatus.Error; + } + + if (providerStatuses.Any(status => status == ProviderStatus.Stale)) + { + return ProviderStatus.Stale; + } + + return providerStatuses.All(status => status == ProviderStatus.Ready) ? ProviderStatus.Ready : + // Default to NotReady if we have mixed statuses not covered above + ProviderStatus.NotReady; + } + + private static ReadOnlyCollection RegisterProviders(IEnumerable providerEntries) + { + var entries = providerEntries.ToList(); + var registeredProviders = new List(); + var nameGroups = entries.GroupBy(e => e.Name ?? e.Provider.GetMetadata()?.Name ?? "UnknownProvider").ToList(); + + // Check for duplicate explicit names + var duplicateExplicitNames = nameGroups + .FirstOrDefault(g => g.Count(e => e.Name != null) > 1)?.Key; + + if (duplicateExplicitNames != null) + { + throw new ArgumentException($"Multiple providers cannot have the same explicit name: '{duplicateExplicitNames}'"); + } + + // Assign unique names + foreach (var group in nameGroups) + { + var baseName = group.Key; + var groupEntries = group.ToList(); + + if (groupEntries.Count == 1) + { + var entry = groupEntries[0]; + registeredProviders.Add(new RegisteredProvider(entry.Provider, entry.Name ?? baseName)); + } + else + { + // Multiple providers with same metadata name - add indices + var index = 1; + foreach (var entry in groupEntries) + { + var finalName = entry.Name ?? $"{baseName}-{index++}"; + registeredProviders.Add(new RegisteredProvider(entry.Provider, finalName)); + } + } + } + + return registeredProviders.AsReadOnly(); + } + + /// + /// Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + /// + public async ValueTask DisposeAsync() + { + if (Interlocked.Exchange(ref this._disposed, 1) == 1) + { + // Already disposed + return; + } + + try + { + await this.InternalShutdownAsync(CancellationToken.None).ConfigureAwait(false); + } + finally + { + this._initializationSemaphore.Dispose(); + this._shutdownSemaphore.Dispose(); + this._providerStatus = ProviderStatus.Fatal; + this._eventProcessingCancellation.Dispose(); + } + } + + private async Task ShutdownEventProcessingAsync() + { + // Cancel event processing - protect against ObjectDisposedException during concurrent shutdown + try + { + this._eventProcessingCancellation.Cancel(); + } + catch (ObjectDisposedException) + { + // Expected if already disposed during concurrent shutdown + } + + // Wait for all event listening tasks to complete, ignoring cancellation exceptions + if (this._eventListeningTasks.Count != 0) + { + try + { + await Task.WhenAll(this._eventListeningTasks.Values).ConfigureAwait(false); + } + catch (OperationCanceledException) + { + // Expected when shutting down + } + } + } + + private async Task InternalShutdownAsync(CancellationToken cancellationToken) + { + await this.ShutdownEventProcessingAsync().ConfigureAwait(false); + await this._shutdownSemaphore.WaitAsync(cancellationToken).ConfigureAwait(false); + try + { + // We should be able to shut down the provider when it is in Ready or Fatal status. + if ((this.Status != ProviderStatus.Ready && this.Status != ProviderStatus.Fatal) || this._disposed == 1) + { + return; + } + + var shutdownTasks = this._registeredProviders.Select(async rp => + { + try + { + await rp.Provider.ShutdownAsync(cancellationToken).ConfigureAwait(false); + rp.SetStatus(ProviderStatus.NotReady); + return new ChildProviderStatus { ProviderName = rp.Name }; + } + catch (Exception ex) + { + rp.SetStatus(ProviderStatus.Fatal); + return new ChildProviderStatus { ProviderName = rp.Name, Error = ex }; + } + }); + + var results = await Task.WhenAll(shutdownTasks).ConfigureAwait(false); + var failures = results.Where(r => r.Error != null).ToList(); + + if (failures.Count != 0) + { + var exceptions = failures.Select(f => f.Error!).ToList(); + var failedProviders = failures.Select(f => f.ProviderName).ToList(); + throw new AggregateException( + $"Failed to shutdown providers: {string.Join(", ", failedProviders)}", + exceptions); + } + + this.Status = ProviderStatus.NotReady; + this._eventListeningTasks.Clear(); + } + finally + { + this._shutdownSemaphore.Release(); + } + } + + /// + /// This should only be used for testing purposes. + /// + /// The status to set. + internal void SetStatus(ProviderStatus providerStatus) + { + this.Status = providerStatus; + } + + [LoggerMessage(EventId = 1, Level = LogLevel.Debug, Message = "Provider {ProviderName} is already being listened to")] + private partial void LogProviderAlreadyBeingListenedTo(string providerName); +} diff --git a/src/OpenFeature.Providers.MultiProvider/MultiProviderConstants.cs b/src/OpenFeature.Providers.MultiProvider/MultiProviderConstants.cs new file mode 100644 index 000000000..76df24448 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/MultiProviderConstants.cs @@ -0,0 +1,12 @@ +namespace OpenFeature.Providers.MultiProvider; + +/// +/// Constants used by the MultiProvider. +/// +internal static class MultiProviderConstants +{ + /// + /// The provider name for MultiProvider. + /// + public const string ProviderName = "MultiProvider"; +} diff --git a/src/OpenFeature.Providers.MultiProvider/OpenFeature.Providers.MultiProvider.csproj b/src/OpenFeature.Providers.MultiProvider/OpenFeature.Providers.MultiProvider.csproj new file mode 100644 index 000000000..000f223b5 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/OpenFeature.Providers.MultiProvider.csproj @@ -0,0 +1,18 @@ +๏ปฟ + + + net8.0;net9.0;netstandard2.0;net462 + OpenFeature.Providers.MultiProvider + README.md + + + + + + + + + + + + diff --git a/src/OpenFeature.Providers.MultiProvider/ProviderExtensions.cs b/src/OpenFeature.Providers.MultiProvider/ProviderExtensions.cs new file mode 100644 index 000000000..160fc9e00 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/ProviderExtensions.cs @@ -0,0 +1,180 @@ +using System.Collections.Immutable; +using Microsoft.Extensions.Logging; +using OpenFeature.Constant; +using OpenFeature.Error; +using OpenFeature.Extension; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider; + +internal static class ProviderExtensions +{ + internal static async Task> EvaluateAsync( + this FeatureProvider provider, + StrategyPerProviderContext providerContext, + EvaluationContext? evaluationContext, + T defaultValue, + ILogger logger, + CancellationToken cancellationToken = default) + { + var key = providerContext.FlagKey; + + try + { + // Execute provider hooks for this specific provider + var providerHooks = provider.GetProviderHooks(); + EvaluationContext? contextForThisProvider = evaluationContext; + + if (providerHooks.Count > 0) + { + // Execute hooks for this provider with context isolation + var (modifiedContext, hookResult) = await ExecuteBeforeEvaluationHooksAsync( + provider, + providerHooks, + key, + defaultValue, + evaluationContext, + logger, + cancellationToken).ConfigureAwait(false); + + if (hookResult != null) + { + return hookResult; + } + + contextForThisProvider = modifiedContext ?? evaluationContext; + } + + // Evaluate the flag with the (possibly modified) context + var result = defaultValue switch + { + bool boolDefaultValue => (ResolutionDetails)(object)await provider.ResolveBooleanValueAsync(key, boolDefaultValue, contextForThisProvider, cancellationToken).ConfigureAwait(false), + string stringDefaultValue => (ResolutionDetails)(object)await provider.ResolveStringValueAsync(key, stringDefaultValue, contextForThisProvider, cancellationToken).ConfigureAwait(false), + int intDefaultValue => (ResolutionDetails)(object)await provider.ResolveIntegerValueAsync(key, intDefaultValue, contextForThisProvider, cancellationToken).ConfigureAwait(false), + double doubleDefaultValue => (ResolutionDetails)(object)await provider.ResolveDoubleValueAsync(key, doubleDefaultValue, contextForThisProvider, cancellationToken).ConfigureAwait(false), + Value valueDefaultValue => (ResolutionDetails)(object)await provider.ResolveStructureValueAsync(key, valueDefaultValue, contextForThisProvider, cancellationToken).ConfigureAwait(false), + null when typeof(T) == typeof(string) => (ResolutionDetails)(object)await provider.ResolveStringValueAsync(key, (string)(object)defaultValue!, contextForThisProvider, cancellationToken).ConfigureAwait(false), + null when typeof(T) == typeof(Value) => (ResolutionDetails)(object)await provider.ResolveStructureValueAsync(key, (Value)(object)defaultValue!, contextForThisProvider, cancellationToken).ConfigureAwait(false), + _ => throw new ArgumentException($"Unsupported flag type: {typeof(T)}") + }; + + // Execute after/finally hooks for this provider if we have them + if (providerHooks.Count > 0) + { + await ExecuteAfterEvaluationHooksAsync(provider, providerHooks, key, defaultValue, contextForThisProvider, result, logger, cancellationToken).ConfigureAwait(false); + } + + return new ProviderResolutionResult(provider, providerContext.ProviderName, result); + } + catch (Exception ex) + { + // Create an error result + var errorResult = new ResolutionDetails( + key, + defaultValue, + ErrorType.General, + Reason.Error, + errorMessage: ex.Message); + + return new ProviderResolutionResult(provider, providerContext.ProviderName, errorResult, ex); + } + } + + private static async Task<(EvaluationContext?, ProviderResolutionResult?)> ExecuteBeforeEvaluationHooksAsync( + FeatureProvider provider, + IImmutableList hooks, + string key, + T defaultValue, + EvaluationContext? evaluationContext, + ILogger logger, + CancellationToken cancellationToken) + { + try + { + var sharedHookContext = new SharedHookContext( + key, + defaultValue, + GetFlagValueType(), + new ClientMetadata(MultiProviderConstants.ProviderName, null), + provider.GetMetadata() + ); + + var initialContext = evaluationContext ?? EvaluationContext.Empty; + var hookRunner = new HookRunner([.. hooks], initialContext, sharedHookContext, logger); + + // Execute before hooks for this provider + var modifiedContext = await hookRunner.TriggerBeforeHooksAsync(null, cancellationToken).ConfigureAwait(false); + return (modifiedContext, null); + } + catch (Exception hookEx) + { + // If before hooks fail, return error result + var errorResult = new ResolutionDetails( + key, + defaultValue, + ErrorType.General, + Reason.Error, + errorMessage: $"Provider hook execution failed: {hookEx.Message}"); + + var result = new ProviderResolutionResult(provider, provider.GetMetadata()?.Name ?? "unknown", errorResult, hookEx); + return (null, result); + } + } + + private static async Task ExecuteAfterEvaluationHooksAsync( + FeatureProvider provider, + IImmutableList hooks, + string key, + T defaultValue, + EvaluationContext? evaluationContext, + ResolutionDetails result, + ILogger logger, + CancellationToken cancellationToken) + { + try + { + var sharedHookContext = new SharedHookContext( + key, + defaultValue, + GetFlagValueType(), + new ClientMetadata(MultiProviderConstants.ProviderName, null), + provider.GetMetadata() + ); + + var hookRunner = new HookRunner([.. hooks], evaluationContext ?? EvaluationContext.Empty, sharedHookContext, logger); + + var evaluationDetails = result.ToFlagEvaluationDetails(); + + if (result.ErrorType == ErrorType.None) + { + await hookRunner.TriggerAfterHooksAsync(evaluationDetails, null, cancellationToken).ConfigureAwait(false); + } + else + { + var exception = new FeatureProviderException(result.ErrorType, result.ErrorMessage); + await hookRunner.TriggerErrorHooksAsync(exception, null, cancellationToken).ConfigureAwait(false); + } + + await hookRunner.TriggerFinallyHooksAsync(evaluationDetails, null, cancellationToken).ConfigureAwait(false); + } + catch (Exception hookEx) + { + // Log hook execution errors but don't fail the evaluation + logger.LogWarning(hookEx, "Provider after/finally hook execution failed for provider {ProviderName}", provider.GetMetadata()?.Name ?? "unknown"); + } + } + + internal static FlagValueType GetFlagValueType() + { + return typeof(T) switch + { + _ when typeof(T) == typeof(bool) => FlagValueType.Boolean, + _ when typeof(T) == typeof(string) => FlagValueType.String, + _ when typeof(T) == typeof(int) => FlagValueType.Number, + _ when typeof(T) == typeof(double) => FlagValueType.Number, + _ when typeof(T) == typeof(Value) => FlagValueType.Object, + _ => FlagValueType.Object // Default fallback + }; + } +} diff --git a/src/OpenFeature.Providers.MultiProvider/README.md b/src/OpenFeature.Providers.MultiProvider/README.md new file mode 100644 index 000000000..8b12807c0 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/README.md @@ -0,0 +1,255 @@ +# OpenFeature .NET MultiProvider + +[![NuGet](https://img.shields.io/nuget/vpre/OpenFeature.Providers.MultiProvider)](https://www.nuget.org/packages/OpenFeature.Providers.MultiProvider) + +The MultiProvider is a feature provider that enables the use of multiple underlying providers, allowing different providers to be used for different flag keys or based on specific routing logic. This enables scenarios where different feature flags may be served by different sources or providers within the same application. + +## Overview + +The MultiProvider acts as a composite provider that can delegate flag resolution to different underlying providers based on configuration or routing rules. It supports various evaluation strategies to determine how multiple providers should be evaluated and how their results should be combined. + +For more information about the MultiProvider specification, see the [OpenFeature Multi Provider specification](https://openfeature.dev/specification/appendix-a/#multi-provider). + +## Installation + +```shell +dotnet add package OpenFeature.Providers.MultiProvider +``` + +## Usage + +### Basic Setup + +```csharp +using OpenFeature; +using OpenFeature.Providers.MultiProvider; + +// Create your individual providers +var primaryProvider = new YourPrimaryProvider(); +var fallbackProvider = new YourFallbackProvider(); + +// Create provider entries +var providerEntries = new[] +{ + new ProviderEntry(primaryProvider, "primary"), + new ProviderEntry(fallbackProvider, "fallback") +}; + +// Create and set the MultiProvider +var multiProvider = new MultiProvider(providerEntries); +await Api.Instance.SetProviderAsync(multiProvider); + +// Use the client as normal +var client = Api.Instance.GetClient(); +var result = await client.GetBooleanValueAsync("my-flag", false); +``` + +### Evaluation Strategies + +The MultiProvider supports several evaluation strategies to determine how providers are evaluated: + +#### 1. FirstMatchStrategy (Default) + +Returns the first result that does not indicate "flag not found". Providers are evaluated sequentially in the order they were configured. + +```csharp +using OpenFeature.Providers.MultiProvider.Strategies; + +var strategy = new FirstMatchStrategy(); +var multiProvider = new MultiProvider(providerEntries, strategy); +``` + +#### 2. FirstSuccessfulStrategy + +Returns the first result that does not result in an error. If any provider returns an error, it's ignored as long as there is a successful result. + +```csharp +using OpenFeature.Providers.MultiProvider.Strategies; + +var strategy = new FirstSuccessfulStrategy(); +var multiProvider = new MultiProvider(providerEntries, strategy); +``` + +#### 3. ComparisonStrategy + +Evaluates all providers and compares their results. Useful for testing or validation scenarios where you want to ensure providers return consistent values. + +```csharp +using OpenFeature.Providers.MultiProvider.Strategies; + +var strategy = new ComparisonStrategy(); +var multiProvider = new MultiProvider(providerEntries, strategy); +``` + +### Advanced Configuration + +#### Named Providers + +You can assign names to providers for better identification and debugging: + +```csharp +var providerEntries = new[] +{ + new ProviderEntry(new ProviderA(), "provider-a"), + new ProviderEntry(new ProviderB(), "provider-b"), + new ProviderEntry(new ProviderC(), "provider-c") +}; +``` + +#### Custom Evaluation Context + +The MultiProvider respects evaluation context and passes it to underlying providers: + +```csharp +var context = EvaluationContext.Builder() + .Set("userId", "user123") + .Set("environment", "production") + .Build(); + +var result = await client.GetBooleanValueAsync("feature-flag", false, context); +``` + +## Use Cases + +### Primary/Fallback Configuration + +Use multiple providers with fallback capabilities: + +```csharp +var providerEntries = new[] +{ + new ProviderEntry(new RemoteProvider(), "remote"), + new ProviderEntry(new LocalCacheProvider(), "cache"), + new ProviderEntry(new StaticProvider(), "static") +}; + +var multiProvider = new MultiProvider(providerEntries, new FirstSuccessfulStrategy()); +``` + +### A/B Testing Provider Comparison + +Compare results from different providers for testing purposes: + +```csharp +var providerEntries = new[] +{ + new ProviderEntry(new ProviderA(), "provider-a"), + new ProviderEntry(new ProviderB(), "provider-b") +}; + +var multiProvider = new MultiProvider(providerEntries, new ComparisonStrategy()); +``` + +### Migration Scenarios + +Gradually migrate from one provider to another: + +```csharp +var providerEntries = new[] +{ + new ProviderEntry(new NewProvider(), "new-provider"), + new ProviderEntry(new LegacyProvider(), "legacy-provider") +}; + +var multiProvider = new MultiProvider(providerEntries, new FirstMatchStrategy()); +``` + +## Error Handling + +The MultiProvider handles errors from underlying providers according to the chosen evaluation strategy: + +- **FirstMatchStrategy**: Throws errors immediately when encountered +- **FirstSuccessfulStrategy**: Ignores errors if there's a successful result, throws all errors if all providers fail +- **ComparisonStrategy**: Collects and reports all errors for analysis + +## Thread Safety + +The MultiProvider is thread-safe and can be used concurrently across multiple threads. It properly handles initialization and shutdown of underlying providers. + +## Lifecycle Management + +The MultiProvider manages the lifecycle of all registered providers: + +```csharp +// Initialize all providers +await multiProvider.InitializeAsync(context); + +// Shutdown all providers +await multiProvider.ShutdownAsync(); + +// Dispose (implements IAsyncDisposable) +await multiProvider.DisposeAsync(); +``` + +## Events + +The MultiProvider supports OpenFeature events and provides specification-compliant event handling. It follows the [OpenFeature Multi-Provider specification](https://openfeature.dev/specification/appendix-a#status-and-event-handling) for event handling behavior. + +### Event Handling Example + +```csharp +using OpenFeature; +using OpenFeature.Providers.MultiProvider; + +// Create the MultiProvider with multiple providers +var providerEntries = new[] +{ + new ProviderEntry(new ProviderA(), "provider-a"), + new ProviderEntry(new ProviderB(), "provider-b") +}; +var multiProvider = new MultiProvider(providerEntries); + +// Subscribe to MultiProvider events +Api.Instance.AddHandler(ProviderEventTypes.ProviderReady, (eventDetails) => +{ + Console.WriteLine($"MultiProvider is ready: {eventDetails?.ProviderName}"); +}); + +Api.Instance.AddHandler(ProviderEventTypes.ProviderStale, (eventDetails) => +{ + Console.WriteLine($"MultiProvider became stale: {eventDetails?.Message}"); +}); + +Api.Instance.AddHandler(ProviderEventTypes.ProviderConfigurationChanged, (eventDetails) => +{ + Console.WriteLine($"Configuration changed - Flags: {string.Join(", ", eventDetails?.FlagsChanged ?? [])}"); +}); + +Api.Instance.AddHandler(ProviderEventTypes.ProviderError, (eventDetails) => +{ + Console.WriteLine($"MultiProvider error: {eventDetails?.Message}"); +}); + +// Set the provider - this will initialize all underlying providers +// and emit PROVIDER_READY when all are successfully initialized +await Api.Instance.SetProviderAsync(multiProvider); + +// Later, if an underlying provider becomes stale and changes MultiProvider status: +// Only then will a PROVIDER_STALE event be emitted from MultiProvider +``` + +### Event Lifecycle + +1. **During Initialization**: + + - MultiProvider emits `PROVIDER_READY` when all underlying providers initialize successfully + - MultiProvider emits `PROVIDER_ERROR` if any providers fail to initialize (causing aggregate status to become ERROR/FATAL) + +2. **Runtime Status Changes**: + + - Status-changing events from underlying providers are captured internally + - MultiProvider only emits events when its aggregate status changes due to these internal events + - Example: If MultiProvider is READY and one provider becomes STALE, MultiProvider emits `PROVIDER_STALE` + +3. **Configuration Changes**: + - `PROVIDER_CONFIGURATION_CHANGED` events from underlying providers are always re-emitted + +## Requirements + +- .NET 8+ +- .NET Framework 4.6.2+ +- .NET Standard 2.0+ + +## Contributing + +See the [OpenFeature .NET SDK contributing guide](../../CONTRIBUTING.md) for details on how to contribute to this project. diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/BaseEvaluationStrategy.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/BaseEvaluationStrategy.cs new file mode 100644 index 000000000..f31b2c4ab --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/BaseEvaluationStrategy.cs @@ -0,0 +1,129 @@ +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Strategies; + +/// +/// Provides a base class for implementing evaluation strategies that determine how feature flags are evaluated across multiple feature providers. +/// +/// +/// This abstract class serves as the foundation for creating custom evaluation strategies that can handle feature flag resolution +/// across multiple providers. Implementations define the specific logic for how providers are selected, prioritized, or combined +/// when evaluating feature flags. +/// +public abstract class BaseEvaluationStrategy +{ + /// + /// Determines whether providers should be evaluated in parallel or sequentially. + /// + public virtual RunMode RunMode => RunMode.Sequential; + + /// + /// Determines whether a specific provider should be evaluated. + /// + /// The type of the flag value. + /// Context information about the provider and evaluation. + /// The evaluation context for the flag resolution. + /// True if the provider should be evaluated, false otherwise. + public virtual bool ShouldEvaluateThisProvider(StrategyPerProviderContext strategyContext, EvaluationContext? evaluationContext) + { + // Skip providers that are not ready or have fatal errors + return strategyContext.ProviderStatus is not (ProviderStatus.NotReady or ProviderStatus.Fatal); + } + + /// + /// Determines whether the next provider should be evaluated after the current one. + /// This method is only called in sequential mode. + /// + /// The type of the flag value. + /// Context information about the provider and evaluation. + /// The evaluation context for the flag resolution. + /// The result from the current provider evaluation. + /// True if the next provider should be evaluated, false otherwise. + public virtual bool ShouldEvaluateNextProvider(StrategyPerProviderContext strategyContext, EvaluationContext? evaluationContext, ProviderResolutionResult result) + { + return true; + } + + /// + /// Determines the final result from all provider evaluation results. + /// + /// The type of the flag value. + /// Context information about the evaluation. + /// The feature flag key to evaluate. + /// The default value to return if evaluation fails or the flag is not found. + /// The evaluation context for the flag resolution. + /// All resolution results from provider evaluations. + /// The final evaluation result. + public abstract FinalResult DetermineFinalResult(StrategyEvaluationContext strategyContext, string key, T defaultValue, EvaluationContext? evaluationContext, List> resolutions); + + /// + /// Checks if a resolution result represents an error. + /// + /// The type of the resolved value. + /// The resolution result to check. + /// True if the result represents an error, false otherwise. + protected static bool HasError(ProviderResolutionResult resolution) + { + return resolution.ThrownError is not null || resolution.ResolutionDetails switch + { + { } success => success.ErrorType != ErrorType.None, + _ => false + }; + } + + /// + /// Collects errors from provider resolution results. + /// + /// The type of the flag value. + /// The provider resolution results to collect errors from. + /// A list of provider errors. + protected static List CollectProviderErrors(List> resolutions) + { + var errors = new List(); + + foreach (var resolution in resolutions) + { + if (resolution.ThrownError is not null) + { + errors.Add(new ProviderError(resolution.ProviderName, resolution.ThrownError)); + } + else if (resolution.ResolutionDetails?.ErrorType != ErrorType.None) + { + var errorMessage = resolution.ResolutionDetails?.ErrorMessage ?? "unknown error"; + var error = new Exception(errorMessage); // Adjust based on your ErrorWithCode implementation + errors.Add(new ProviderError(resolution.ProviderName, error)); + } + } + + return errors; + } + + /// + /// Checks if a resolution result has a specific error code. + /// + /// The type of the resolved value. + /// The resolution result to check. + /// The error type to check for. + /// True if the result has the specified error type, false otherwise. + protected static bool HasErrorWithCode(ProviderResolutionResult resolution, ErrorType errorType) + { + return resolution.ResolutionDetails switch + { + { } success => success.ErrorType == errorType, + _ => false + }; + } + + /// + /// Converts a resolution result to a final result. + /// + /// The type of the resolved value. + /// The resolution result to convert. + /// The converted final result. + protected static FinalResult ToFinalResult(ProviderResolutionResult resolution) + { + return new FinalResult(resolution.ResolutionDetails, resolution.Provider, resolution.ProviderName, null); + } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/ComparisonStrategy.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/ComparisonStrategy.cs new file mode 100644 index 000000000..b004b6d32 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/ComparisonStrategy.cs @@ -0,0 +1,80 @@ +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Strategies; + +/// +/// Evaluate all providers in parallel and compare the results. +/// If the values agree, return the value. +/// If the values disagree, return the value from the configured "fallback provider" and execute the "onMismatch" +/// callback if defined. +/// +public sealed class ComparisonStrategy : BaseEvaluationStrategy +{ + private readonly FeatureProvider? _fallbackProvider; + private readonly Action>? _onMismatch; + + /// + public override RunMode RunMode => RunMode.Parallel; + + /// + /// Initializes a new instance of the class. + /// + /// The provider to use as fallback when values don't match. + /// Optional callback that is called when providers return different values. + public ComparisonStrategy(FeatureProvider? fallbackProvider = null, Action>? onMismatch = null) + { + this._fallbackProvider = fallbackProvider; + this._onMismatch = onMismatch; + } + + /// + public override FinalResult DetermineFinalResult(StrategyEvaluationContext strategyContext, string key, T defaultValue, EvaluationContext? evaluationContext, List> resolutions) + { + var successfulResolutions = resolutions.Where(r => !HasError(r)).ToList(); + + if (successfulResolutions.Count == 0) + { + var errorDetails = new ResolutionDetails(key, defaultValue, ErrorType.ProviderNotReady, Reason.Error, errorMessage: "No providers available or all providers failed"); + var errors = resolutions.Select(r => new ProviderError(r.ProviderName, new InvalidOperationException($"Provider {r.ProviderName} failed"))).ToList(); + return new FinalResult(errorDetails, null!, MultiProviderConstants.ProviderName, errors); + } + + var firstResult = successfulResolutions.First(); + + // Check if all successful results agree on the value + var allAgree = successfulResolutions.All(r => EqualityComparer.Default.Equals(r.ResolutionDetails.Value, firstResult.ResolutionDetails.Value)); + + if (allAgree) + { + return ToFinalResult(firstResult); + } + + ProviderResolutionResult? fallbackResolution = null; + + // Find fallback provider if specified + if (this._fallbackProvider != null) + { + fallbackResolution = successfulResolutions.FirstOrDefault(r => ReferenceEquals(r.Provider, this._fallbackProvider)); + } + + // Values don't agree, trigger mismatch callback if provided + if (this._onMismatch != null) + { + // Create a dictionary with provider names and their values for the callback + var mismatchDetails = successfulResolutions.ToDictionary( + r => r.ProviderName, + r => (object)r.ResolutionDetails.Value! + ); + this._onMismatch(mismatchDetails); + } + + // Return fallback provider result if available + return fallbackResolution != null + ? ToFinalResult(fallbackResolution) + : + // Default to first provider's result + ToFinalResult(firstResult); + } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/FirstMatchStrategy.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/FirstMatchStrategy.cs new file mode 100644 index 000000000..88eba5509 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/FirstMatchStrategy.cs @@ -0,0 +1,36 @@ +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Strategies; + +/// +/// Return the first result that did not indicate "flag not found". +/// Providers are evaluated sequentially in the order they were configured. +/// If any provider in the course of evaluation returns or throws an error, throw that error +/// +public sealed class FirstMatchStrategy : BaseEvaluationStrategy +{ + /// + public override bool ShouldEvaluateNextProvider(StrategyPerProviderContext strategyContext, EvaluationContext? evaluationContext, ProviderResolutionResult result) + { + return HasErrorWithCode(result, ErrorType.FlagNotFound); + } + + /// + public override FinalResult DetermineFinalResult(StrategyEvaluationContext strategyContext, string key, T defaultValue, EvaluationContext? evaluationContext, List> resolutions) + { + var lastResult = resolutions.LastOrDefault(); + if (lastResult != null) + { + return ToFinalResult(lastResult); + } + + var errorDetails = new ResolutionDetails(key, defaultValue, ErrorType.ProviderNotReady, Reason.Error, errorMessage: "No providers available or all providers failed"); + var errors = new List + { + new(MultiProviderConstants.ProviderName, new InvalidOperationException("No providers available or all providers failed")) + }; + return new FinalResult(errorDetails, null!, MultiProviderConstants.ProviderName, errors); + } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/FirstSuccessfulStrategy.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/FirstSuccessfulStrategy.cs new file mode 100644 index 000000000..7caef6a51 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/FirstSuccessfulStrategy.cs @@ -0,0 +1,47 @@ +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Strategies; + +/// +/// Return the first result that did not result in an error. +/// Providers are evaluated sequentially in the order they were configured. +/// If any provider in the course of evaluation returns or throws an error, ignore it as long as there is a successful result. +/// If there is no successful result, throw all errors. +/// +public sealed class FirstSuccessfulStrategy : BaseEvaluationStrategy +{ + /// + public override bool ShouldEvaluateNextProvider(StrategyPerProviderContext strategyContext, EvaluationContext? evaluationContext, ProviderResolutionResult result) + { + // evaluate next only if there was an error + return HasError(result); + } + + /// + public override FinalResult DetermineFinalResult(StrategyEvaluationContext strategyContext, string key, T defaultValue, EvaluationContext? evaluationContext, List> resolutions) + { + if (resolutions.Count == 0) + { + var noProvidersDetails = new ResolutionDetails(key, defaultValue, ErrorType.ProviderNotReady, Reason.Error, errorMessage: "No providers available or all providers failed"); + var noProvidersErrors = new List + { + new(MultiProviderConstants.ProviderName, new InvalidOperationException("No providers available or all providers failed")) + }; + return new FinalResult(noProvidersDetails, null!, MultiProviderConstants.ProviderName, noProvidersErrors); + } + + // Find the first successful result + var successfulResult = resolutions.FirstOrDefault(r => !HasError(r)); + if (successfulResult != null) + { + return ToFinalResult(successfulResult); + } + + // All results had errors - collect them and throw + var collectedErrors = CollectProviderErrors(resolutions); + var allFailedDetails = new ResolutionDetails(key, defaultValue, ErrorType.General, Reason.Error, errorMessage: "All providers failed"); + return new FinalResult(allFailedDetails, null!, "MultiProvider", collectedErrors); + } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/Models/FinalResult.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/FinalResult.cs new file mode 100644 index 000000000..0bcc0bd7d --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/FinalResult.cs @@ -0,0 +1,45 @@ +using OpenFeature.Model; + +namespace OpenFeature.Providers.MultiProvider.Strategies.Models; + +/// +/// Represents the final result of a feature flag resolution operation from a multi-provider strategy. +/// Contains the resolved details, the provider that successfully resolved the flag, and any errors encountered during the resolution process. +/// +public class FinalResult +{ + /// + /// Initializes a new instance of the class. + /// + /// The resolution details containing the resolved value and associated metadata. + /// The provider that successfully resolved the feature flag. + /// The name of the provider that successfully resolved the feature flag. + /// The list of errors encountered during the resolution process. + public FinalResult(ResolutionDetails details, FeatureProvider provider, string providerName, List? errors) + { + this.Details = details; + this.Provider = provider; + this.ProviderName = providerName; + this.Errors = errors ?? []; + } + + /// + /// Gets or sets the resolution details containing the resolved value and associated metadata. + /// + public ResolutionDetails Details { get; private set; } + + /// + /// Gets or sets the provider that successfully resolved the feature flag. + /// + public FeatureProvider Provider { get; private set; } + + /// + /// Gets or sets the name of the provider that successfully resolved the feature flag. + /// + public string ProviderName { get; private set; } + + /// + /// Gets or sets the list of errors encountered during the resolution process. + /// + public List Errors { get; private set; } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/Models/ProviderError.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/ProviderError.cs new file mode 100644 index 000000000..52204ce5a --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/ProviderError.cs @@ -0,0 +1,29 @@ +namespace OpenFeature.Providers.MultiProvider.Strategies.Models; + +/// +/// Represents an error encountered during the resolution process. +/// Contains the name of the provider that encountered the error and the error details. +/// +public class ProviderError +{ + /// + /// Initializes a new instance of the class. + /// + /// The name of the provider that encountered the error. + /// The error details. + public ProviderError(string providerName, Exception? error) + { + this.ProviderName = providerName; + this.Error = error; + } + + /// + /// Gets or sets the name of the provider that encountered the error. + /// + public string ProviderName { get; private set; } + + /// + /// Gets or sets the error details. + /// + public Exception? Error { get; private set; } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/Models/ProviderResolutionResult.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/ProviderResolutionResult.cs new file mode 100644 index 000000000..20eddbe44 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/ProviderResolutionResult.cs @@ -0,0 +1,45 @@ +using OpenFeature.Model; + +namespace OpenFeature.Providers.MultiProvider.Strategies.Models; + +/// +/// Base class for provider resolution results. +/// +public class ProviderResolutionResult +{ + /// + /// Initializes a new instance of the class + /// with the specified provider and resolution details. + /// + /// The feature provider that produced this result. + /// The name of the provider that produced this result. + /// The resolution details. + /// The exception that occurred during resolution, if any. + public ProviderResolutionResult(FeatureProvider provider, string providerName, ResolutionDetails resolutionDetails, Exception? thrownError = null) + { + this.Provider = provider; + this.ProviderName = providerName; + this.ResolutionDetails = resolutionDetails; + this.ThrownError = thrownError; + } + + /// + /// The feature provider that produced this result. + /// + public FeatureProvider Provider { get; private set; } + + /// + /// The resolution details. + /// + public ResolutionDetails ResolutionDetails { get; private set; } + + /// + /// The name of the provider that produced this result. + /// + public string ProviderName { get; private set; } + + /// + /// The exception that occurred during resolution, if any. + /// + public Exception? ThrownError { get; private set; } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/Models/RunMode.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/RunMode.cs new file mode 100644 index 000000000..754cb5a9e --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/RunMode.cs @@ -0,0 +1,17 @@ +namespace OpenFeature.Providers.MultiProvider.Strategies.Models; + +/// +/// Specifies how providers should be evaluated. +/// +public enum RunMode +{ + /// + /// Providers are evaluated one after another in sequence. + /// + Sequential, + + /// + /// Providers are evaluated concurrently in parallel. + /// + Parallel +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/Models/StrategyEvaluationContext.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/StrategyEvaluationContext.cs new file mode 100644 index 000000000..215c85e4d --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/StrategyEvaluationContext.cs @@ -0,0 +1,22 @@ +namespace OpenFeature.Providers.MultiProvider.Strategies.Models; + +/// +/// Evaluation context specific to strategy evaluation containing flag-related information. +/// +/// The type of the flag value being evaluated. +public class StrategyEvaluationContext +{ + /// + /// Initializes a new instance of the class. + /// + /// The feature flag key being evaluated. + public StrategyEvaluationContext(string flagKey) + { + this.FlagKey = flagKey; + } + + /// + /// The feature flag key being evaluated. + /// + public string FlagKey { get; private set; } +} diff --git a/src/OpenFeature.Providers.MultiProvider/Strategies/Models/StrategyPerProviderContext.cs b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/StrategyPerProviderContext.cs new file mode 100644 index 000000000..4abc434a3 --- /dev/null +++ b/src/OpenFeature.Providers.MultiProvider/Strategies/Models/StrategyPerProviderContext.cs @@ -0,0 +1,40 @@ +using OpenFeature.Constant; + +namespace OpenFeature.Providers.MultiProvider.Strategies.Models; + +/// +/// Per-provider context containing provider-specific information for strategy evaluation. +/// +/// The type of the flag value being evaluated. +public class StrategyPerProviderContext : StrategyEvaluationContext +{ + /// + /// Initializes a new instance of the class. + /// + /// The feature provider instance. + /// The name/identifier of the provider. + /// The current status of the provider. + /// The feature flag key being evaluated. + public StrategyPerProviderContext(FeatureProvider provider, string providerName, ProviderStatus providerStatus, string key) + : base(key) + { + this.Provider = provider; + this.ProviderName = providerName; + this.ProviderStatus = providerStatus; + } + + /// + /// The feature provider instance. + /// + public FeatureProvider Provider { get; } + + /// + /// The name/identifier of the provider. + /// + public string ProviderName { get; } + + /// + /// The current status of the provider. + /// + public ProviderStatus ProviderStatus { get; } +} diff --git a/src/OpenFeature/Api.cs b/src/OpenFeature/Api.cs index cea661398..e4a9826c5 100644 --- a/src/OpenFeature/Api.cs +++ b/src/OpenFeature/Api.cs @@ -32,7 +32,7 @@ public sealed class Api : IEventBus // not to mark type as beforeFieldInit // IE Lazy way of ensuring this is thread safe without using locks static Api() { } - private Api() { } + internal Api() { } /// /// Sets the default feature provider. In order to wait for the provider to be set, and initialization to complete, @@ -85,7 +85,7 @@ public FeatureProvider GetProvider() /// Gets the feature provider with given domain /// /// An identifier which logically binds clients with providers - /// A provider associated with the given domain, if domain is empty or doesn't + /// A provider associated with the given domain, if domain is empty, null, whitespace or doesn't /// have a corresponding provider the default provider will be returned public FeatureProvider GetProvider(string domain) { @@ -114,14 +114,14 @@ public FeatureProvider GetProvider(string domain) /// /// Create a new instance of using the current provider /// - /// Name of client + /// Name of client, if the is not provided a default name will be used /// Version of client /// Logger instance used by client /// Context given to this client /// public FeatureClient GetClient(string? name = null, string? version = null, ILogger? logger = null, EvaluationContext? context = null) => - new FeatureClient(() => this._repository.GetProvider(name), name, version, logger, context); + new FeatureClient(this, () => this._repository.GetProvider(name), name, version, logger, context); /// /// Appends list of hooks to global hooks list @@ -360,4 +360,12 @@ internal static void ResetApi() { Instance = new Api(); } + + /// + /// This method should only be used in the Dependency Injection setup. It will set the singleton instance of the API using the provided instance. + /// + internal static void SetInstance(Api api) + { + Instance = api; + } } diff --git a/src/OpenFeature/EventExecutor.cs b/src/OpenFeature/EventExecutor.cs index db2b6fb10..f65f41a1a 100644 --- a/src/OpenFeature/EventExecutor.cs +++ b/src/OpenFeature/EventExecutor.cs @@ -14,6 +14,9 @@ internal sealed partial class EventExecutor : IAsyncDisposable private readonly Dictionary _namedProviderReferences = []; private readonly List _activeSubscriptions = []; + /// placeholder for anonymous clients + private static Guid _defaultClientName = Guid.NewGuid(); + private readonly Dictionary> _apiHandlers = []; private readonly Dictionary>> _clientHandlers = []; @@ -58,25 +61,27 @@ internal void RemoveApiLevelHandler(ProviderEventTypes type, EventHandlerDelegat internal void AddClientHandler(string client, ProviderEventTypes eventType, EventHandlerDelegate handler) { + var clientName = GetClientName(client); + lock (this._lockObj) { // check if there is already a list of handlers for the given client and event type - if (!this._clientHandlers.TryGetValue(client, out var registry)) + if (!this._clientHandlers.TryGetValue(clientName, out var registry)) { registry = []; - this._clientHandlers[client] = registry; + this._clientHandlers[clientName] = registry; } - if (!this._clientHandlers[client].TryGetValue(eventType, out var eventHandlers)) + if (!this._clientHandlers[clientName].TryGetValue(eventType, out var eventHandlers)) { eventHandlers = []; - this._clientHandlers[client][eventType] = eventHandlers; + this._clientHandlers[clientName][eventType] = eventHandlers; } - this._clientHandlers[client][eventType].Add(handler); + this._clientHandlers[clientName][eventType].Add(handler); this.EmitOnRegistration( - this._namedProviderReferences.TryGetValue(client, out var clientProviderReference) + this._namedProviderReferences.TryGetValue(clientName, out var clientProviderReference) ? clientProviderReference : this._defaultProvider, eventType, handler); } @@ -84,9 +89,11 @@ internal void AddClientHandler(string client, ProviderEventTypes eventType, Even internal void RemoveClientHandler(string client, ProviderEventTypes type, EventHandlerDelegate handler) { + var clientName = GetClientName(client); + lock (this._lockObj) { - if (this._clientHandlers.TryGetValue(client, out var clientEventHandlers)) + if (this._clientHandlers.TryGetValue(clientName, out var clientEventHandlers)) { if (clientEventHandlers.TryGetValue(type, out var eventHandlers)) { @@ -118,15 +125,18 @@ internal void RegisterClientFeatureProvider(string client, FeatureProvider? prov { return; } + + var clientName = GetClientName(client); + lock (this._lockObj) { FeatureProvider? oldProvider = null; - if (this._namedProviderReferences.TryGetValue(client, out var foundOldProvider)) + if (this._namedProviderReferences.TryGetValue(clientName, out var foundOldProvider)) { oldProvider = foundOldProvider; } - this._namedProviderReferences[client] = provider; + this._namedProviderReferences[clientName] = provider; this.StartListeningAndShutdownOld(provider, oldProvider); } @@ -303,6 +313,14 @@ private void ProcessDefaultProviderHandlers(Event e) } } + private static string GetClientName(string client) + { + if (string.IsNullOrWhiteSpace(client)) + { + return _defaultClientName.ToString(); + } + return client; + } // map events to provider status as per spec: https://openfeature.dev/specification/sections/events/#requirement-535 private static void UpdateProviderStatus(FeatureProvider provider, ProviderEventPayload eventPayload) diff --git a/src/OpenFeature/Extension/EnumExtensions.cs b/src/OpenFeature/Extension/EnumExtensions.cs index 73c391250..be84ca3f0 100644 --- a/src/OpenFeature/Extension/EnumExtensions.cs +++ b/src/OpenFeature/Extension/EnumExtensions.cs @@ -1,13 +1,32 @@ -using System.ComponentModel; +using OpenFeature.Constant; namespace OpenFeature.Extension; internal static class EnumExtensions { + /// + /// Gets the description of an enum value without using reflection. + /// This is AOT-compatible and only supports specific known enum types. + /// + /// The enum value to get the description for + /// The description string or the enum value as string if no description is available public static string GetDescription(this Enum value) { - var field = value.GetType().GetField(value.ToString()); - var attribute = field?.GetCustomAttributes(typeof(DescriptionAttribute), false).FirstOrDefault() as DescriptionAttribute; - return attribute?.Description ?? value.ToString(); + return value switch + { + // ErrorType descriptions + ErrorType.None => "NONE", + ErrorType.ProviderNotReady => "PROVIDER_NOT_READY", + ErrorType.FlagNotFound => "FLAG_NOT_FOUND", + ErrorType.ParseError => "PARSE_ERROR", + ErrorType.TypeMismatch => "TYPE_MISMATCH", + ErrorType.General => "GENERAL", + ErrorType.InvalidContext => "INVALID_CONTEXT", + ErrorType.TargetingKeyMissing => "TARGETING_KEY_MISSING", + ErrorType.ProviderFatal => "PROVIDER_FATAL", + + // Fallback for any other enum types + _ => value.ToString() + }; } } diff --git a/src/OpenFeature/Hooks/MetricsConstants.cs b/src/OpenFeature/Hooks/MetricsConstants.cs new file mode 100644 index 000000000..e54dd61cf --- /dev/null +++ b/src/OpenFeature/Hooks/MetricsConstants.cs @@ -0,0 +1,16 @@ +namespace OpenFeature.Hooks; + +internal static class MetricsConstants +{ + internal const string ActiveCountName = "feature_flag.evaluation_active_count"; + internal const string RequestsTotalName = "feature_flag.evaluation_requests_total"; + internal const string SuccessTotalName = "feature_flag.evaluation_success_total"; + internal const string ErrorTotalName = "feature_flag.evaluation_error_total"; + + internal const string ActiveDescription = "active flag evaluations counter"; + internal const string RequestsDescription = "feature flag evaluation request counter"; + internal const string SuccessDescription = "feature flag evaluation success counter"; + internal const string ErrorDescription = "feature flag evaluation error counter"; + + internal const string ExceptionAttr = "exception"; +} diff --git a/src/OpenFeature/Hooks/MetricsHook.cs b/src/OpenFeature/Hooks/MetricsHook.cs new file mode 100644 index 000000000..6852b47c6 --- /dev/null +++ b/src/OpenFeature/Hooks/MetricsHook.cs @@ -0,0 +1,135 @@ +using System.Diagnostics; +using System.Diagnostics.Metrics; +using System.Reflection; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Telemetry; + +namespace OpenFeature.Hooks; + +/// +/// Represents a hook for capturing metrics related to flag evaluations. +/// The meter instrumentation name is "OpenFeature". +/// +/// This is still experimental and subject to change. +public class MetricsHook : Hook +{ + private static readonly AssemblyName AssemblyName = typeof(MetricsHook).Assembly.GetName(); + private static readonly string InstrumentationName = AssemblyName.Name ?? "OpenFeature"; + private static readonly string InstrumentationVersion = AssemblyName.Version?.ToString() ?? "1.0.0"; + private static readonly Meter Meter = new(InstrumentationName, InstrumentationVersion); + + internal readonly UpDownCounter _evaluationActiveUpDownCounter; + internal readonly Counter _evaluationRequestCounter; + internal readonly Counter _evaluationSuccessCounter; + internal readonly Counter _evaluationErrorCounter; + + private readonly MetricsHookOptions _options; + + /// + /// Initializes a new instance of the class. + /// + /// Optional configuration for the metrics hook. + public MetricsHook(MetricsHookOptions? options = null) + { + this._evaluationActiveUpDownCounter = Meter.CreateUpDownCounter(MetricsConstants.ActiveCountName, description: MetricsConstants.ActiveDescription); + this._evaluationRequestCounter = Meter.CreateCounter(MetricsConstants.RequestsTotalName, "{request}", MetricsConstants.RequestsDescription); + this._evaluationSuccessCounter = Meter.CreateCounter(MetricsConstants.SuccessTotalName, "{impression}", MetricsConstants.SuccessDescription); + this._evaluationErrorCounter = Meter.CreateCounter(MetricsConstants.ErrorTotalName, description: MetricsConstants.ErrorDescription); + this._options = options ?? MetricsHookOptions.Default; + } + + /// + public override ValueTask BeforeAsync(HookContext context, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + var tagList = new TagList + { + { TelemetryConstants.Key, context.FlagKey }, + { TelemetryConstants.Provider, context.ProviderMetadata.Name } + }; + + this.AddCustomDimensions(ref tagList); + + this._evaluationActiveUpDownCounter.Add(1, tagList); + this._evaluationRequestCounter.Add(1, tagList); + + return base.BeforeAsync(context, hints, cancellationToken); + } + + + /// + public override ValueTask AfterAsync(HookContext context, FlagEvaluationDetails details, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + var tagList = new TagList + { + { TelemetryConstants.Key, context.FlagKey }, + { TelemetryConstants.Provider, context.ProviderMetadata.Name }, + { TelemetryConstants.Reason, details.Reason ?? Reason.Unknown.ToString() } + }; + + this.AddCustomDimensions(ref tagList); + this.AddFlagMetadataDimensions(details.FlagMetadata, ref tagList); + + this._evaluationSuccessCounter.Add(1, tagList); + + return base.AfterAsync(context, details, hints, cancellationToken); + } + + /// + public override ValueTask ErrorAsync(HookContext context, Exception error, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + var tagList = new TagList + { + { TelemetryConstants.Key, context.FlagKey }, + { TelemetryConstants.Provider, context.ProviderMetadata.Name }, + { MetricsConstants.ExceptionAttr, error.Message } + }; + + this.AddCustomDimensions(ref tagList); + + this._evaluationErrorCounter.Add(1, tagList); + + return base.ErrorAsync(context, error, hints, cancellationToken); + } + + /// + public override ValueTask FinallyAsync(HookContext context, + FlagEvaluationDetails evaluationDetails, + IReadOnlyDictionary? hints = null, + CancellationToken cancellationToken = default) + { + var tagList = new TagList + { + { TelemetryConstants.Key, context.FlagKey }, + { TelemetryConstants.Provider, context.ProviderMetadata.Name } + }; + + this.AddCustomDimensions(ref tagList); + this.AddFlagMetadataDimensions(evaluationDetails.FlagMetadata, ref tagList); + + this._evaluationActiveUpDownCounter.Add(-1, tagList); + + return base.FinallyAsync(context, evaluationDetails, hints, cancellationToken); + } + + private void AddCustomDimensions(ref TagList tagList) + { + foreach (var customDimension in this._options.CustomDimensions) + { + tagList.Add(customDimension.Key, customDimension.Value); + } + } + + private void AddFlagMetadataDimensions(ImmutableMetadata? flagMetadata, ref TagList tagList) + { + flagMetadata ??= new ImmutableMetadata(); + + foreach (var item in this._options.FlagMetadataCallbacks) + { + var flagMetadataCallback = item.Value; + var value = flagMetadataCallback(flagMetadata); + + tagList.Add(item.Key, value); + } + } +} diff --git a/src/OpenFeature/Hooks/MetricsHookOptions.cs b/src/OpenFeature/Hooks/MetricsHookOptions.cs new file mode 100644 index 000000000..553431496 --- /dev/null +++ b/src/OpenFeature/Hooks/MetricsHookOptions.cs @@ -0,0 +1,91 @@ +using OpenFeature.Model; + +namespace OpenFeature.Hooks; + +/// +/// Configuration options for the . +/// +public sealed class MetricsHookOptions +{ + /// + /// The default options for the . + /// + public static MetricsHookOptions Default { get; } = new MetricsHookOptions(); + + /// + /// Custom dimensions or tags to be associated with Meters in . + /// + public IReadOnlyCollection> CustomDimensions { get; } + + /// + /// + /// + internal IReadOnlyCollection>> FlagMetadataCallbacks { get; } + + /// + /// Initializes a new instance of the class with default values. + /// + private MetricsHookOptions() : this(null, null) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// Optional custom dimensions to tag Counter increments with. + /// + internal MetricsHookOptions(IReadOnlyCollection>? customDimensions = null, + IReadOnlyCollection>>? flagMetadataSelectors = null) + { + this.CustomDimensions = customDimensions ?? []; + this.FlagMetadataCallbacks = flagMetadataSelectors ?? []; + } + + /// + /// Creates a new builder for . + /// + public static MetricsHookOptionsBuilder CreateBuilder() => new MetricsHookOptionsBuilder(); + + /// + /// A builder for constructing instances. + /// + public sealed class MetricsHookOptionsBuilder + { + private readonly List> _customDimensions = new List>(); + private readonly List>> _flagMetadataExpressions = new List>>(); + + /// + /// Adds a custom dimension. + /// + /// The key for the custom dimension. + /// The value for the custom dimension. + public MetricsHookOptionsBuilder WithCustomDimension(string key, object? value) + { + this._customDimensions.Add(new KeyValuePair(key, value)); + return this; + } + + /// + /// Provide a callback to evaluate flag metadata for a specific flag key. + /// + /// The key for the custom dimension. + /// The callback to retrieve the value to tag successful flag evaluations. + /// + public MetricsHookOptionsBuilder WithFlagEvaluationMetadata(string key, Func flagMetadataCallback) + { + var kvp = new KeyValuePair>(key, flagMetadataCallback); + + this._flagMetadataExpressions.Add(kvp); + + return this; + } + + /// + /// Builds the instance. + /// + public MetricsHookOptions Build() + { + return new MetricsHookOptions(this._customDimensions.AsReadOnly(), this._flagMetadataExpressions.AsReadOnly()); + } + } +} diff --git a/src/OpenFeature/Hooks/TraceEnricherHook.cs b/src/OpenFeature/Hooks/TraceEnricherHook.cs new file mode 100644 index 000000000..26a4f91ba --- /dev/null +++ b/src/OpenFeature/Hooks/TraceEnricherHook.cs @@ -0,0 +1,73 @@ +using System.Diagnostics; +using OpenFeature.Model; +using OpenFeature.Telemetry; + +namespace OpenFeature.Hooks; + +/// +/// A hook that enriches telemetry traces with additional information during the feature flag evaluation lifecycle. +/// This hook adds relevant flag evaluation details as tags and events to the current for tracing purposes. +/// On error, it attaches exception information to the trace, using the appropriate API depending on the .NET version. +/// +/// This is still experimental and subject to change. +public class TraceEnricherHook : Hook +{ + private readonly TraceEnricherHookOptions _options; + + /// + /// Initializes a new instance of the class. + /// + /// Optional configuration for the traces hook. + public TraceEnricherHook(TraceEnricherHookOptions? options = null) + { + _options = options ?? TraceEnricherHookOptions.Default; + } + + /// + /// Adds tags and events to the current for tracing purposes. + /// + /// The type of the flag value being evaluated. + /// The hook context containing metadata about the evaluation. + /// Details about the flag evaluation including the key, value, and variant. + /// Optional dictionary of hints that can modify hook behavior. + /// A token to cancel the operation. + /// A completed representing the asynchronous operation. + public override ValueTask FinallyAsync(HookContext context, FlagEvaluationDetails details, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + var evaluationEvent = EvaluationEventBuilder.Build(context, details); + + var tags = new ActivityTagsCollection(); + foreach (var kvp in evaluationEvent.Attributes) + { + tags[kvp.Key] = kvp.Value; + } + + this.AddCustomTags(tags); + this.AddFlagMetadataTags(details.FlagMetadata, tags); + + Activity.Current?.AddEvent(new ActivityEvent(evaluationEvent.Name, tags: tags)); + + return base.FinallyAsync(context, details, hints, cancellationToken); + } + + private void AddCustomTags(ActivityTagsCollection tagList) + { + foreach (var customDimension in this._options.Tags) + { + tagList.Add(customDimension.Key, customDimension.Value); + } + } + + private void AddFlagMetadataTags(ImmutableMetadata? flagMetadata, ActivityTagsCollection tagList) + { + flagMetadata ??= new ImmutableMetadata(); + + foreach (var item in this._options.FlagMetadataCallbacks) + { + var flagMetadataCallback = item.Value; + var value = flagMetadataCallback(flagMetadata); + + tagList.Add(item.Key, value); + } + } +} diff --git a/src/OpenFeature/Hooks/TraceEnricherHookOptions.cs b/src/OpenFeature/Hooks/TraceEnricherHookOptions.cs new file mode 100644 index 000000000..da3aa604c --- /dev/null +++ b/src/OpenFeature/Hooks/TraceEnricherHookOptions.cs @@ -0,0 +1,91 @@ +using OpenFeature.Model; + +namespace OpenFeature.Hooks; + +/// +/// Configuration options for the . +/// +public sealed class TraceEnricherHookOptions +{ + /// + /// The default options for the . + /// + public static TraceEnricherHookOptions Default { get; } = new TraceEnricherHookOptions(); + + /// + /// Custom tags to be associated with current in . + /// + public IReadOnlyCollection> Tags { get; } + + /// + /// Flag metadata callbacks to be associated with current . + /// + internal IReadOnlyCollection>> FlagMetadataCallbacks { get; } + + /// + /// Initializes a new instance of the class with default values. + /// + private TraceEnricherHookOptions() : this(null, null) + { + } + + /// + /// Initializes a new instance of the class. + /// + /// Optional custom tags to tag Counter increments with. + /// Optional flag metadata callbacks to be associated with current . + internal TraceEnricherHookOptions(IReadOnlyCollection>? tags = null, + IReadOnlyCollection>>? flagMetadataSelectors = null) + { + this.Tags = tags ?? []; + this.FlagMetadataCallbacks = flagMetadataSelectors ?? []; + } + + /// + /// Creates a new builder for . + /// + public static TraceEnricherHookOptionsBuilder CreateBuilder() => new TraceEnricherHookOptionsBuilder(); + + /// + /// A builder for constructing instances. + /// + public sealed class TraceEnricherHookOptionsBuilder + { + private readonly List> _customTags = new List>(); + private readonly List>> _flagMetadataExpressions = new List>>(); + + /// + /// Adds a custom tag to the . + /// + /// The key for the custom dimension. + /// The value for the custom dimension. + public TraceEnricherHookOptionsBuilder WithTag(string key, object? value) + { + this._customTags.Add(new KeyValuePair(key, value)); + return this; + } + + /// + /// Provide a callback to evaluate flag metadata and add it as a custom tag on the current . + /// + /// The key for the custom tag. + /// The callback to retrieve the value to tag successful flag evaluations. + /// + public TraceEnricherHookOptionsBuilder WithFlagEvaluationMetadata(string key, Func flagMetadataCallback) + { + var kvp = new KeyValuePair>(key, flagMetadataCallback); + + this._flagMetadataExpressions.Add(kvp); + + return this; + } + + /// + /// Builds the instance. + /// + public TraceEnricherHookOptions Build() + { + return new TraceEnricherHookOptions(this._customTags.AsReadOnly(), this._flagMetadataExpressions.AsReadOnly()); + } + } +} diff --git a/src/OpenFeature/IFeatureClient.cs b/src/OpenFeature/IFeatureClient.cs index acf38804f..5ea19458a 100644 --- a/src/OpenFeature/IFeatureClient.cs +++ b/src/OpenFeature/IFeatureClient.cs @@ -55,8 +55,8 @@ public interface IFeatureClient : IEventBus /// Returns the current status of the associated provider. /// /// - ProviderStatus ProviderStatus { get; } - + ProviderStatus ProviderStatus { get; } + /// /// Resolves a boolean feature flag /// @@ -166,4 +166,13 @@ public interface IFeatureClient : IEventBus /// The . /// Resolved flag details Task> GetObjectDetailsAsync(string flagKey, Value defaultValue, EvaluationContext? context = null, FlagEvaluationOptions? config = null, CancellationToken cancellationToken = default); + + /// + /// Use this method to track user interactions and the application state. + /// + /// The name associated with this tracking event + /// The evaluation context used in the evaluation of the flag (optional) + /// Data pertinent to the tracking event (Optional) + /// When trackingEventName is null or empty + void Track(string trackingEventName, EvaluationContext? evaluationContext = default, TrackingEventDetails? trackingEventDetails = default); } diff --git a/src/OpenFeature/Model/ImmutableMetadata.cs b/src/OpenFeature/Model/ImmutableMetadata.cs index 5af7b5559..7295d8b56 100644 --- a/src/OpenFeature/Model/ImmutableMetadata.cs +++ b/src/OpenFeature/Model/ImmutableMetadata.cs @@ -42,20 +42,32 @@ public ImmutableMetadata(Dictionary metadata) /// Gets the integer value associated with the specified key. /// /// The key of the value to retrieve. - /// The integer value associated with the key, or null if the key is not found. + /// The value associated with the key as an integer, if it is of type double or int; otherwise, null. public int? GetInt(string key) { - return this.GetValue(key); + var hasValue = this._metadata.TryGetValue(key, out var value); + if (!hasValue) + { + return null; + } + + return value is double || value is int ? Convert.ToInt32(value) : null; } /// /// Gets the double value associated with the specified key. /// /// The key of the value to retrieve. - /// The double value associated with the key, or null if the key is not found. + /// The value associated with the key as a double, if it is of type double or int; otherwise, null. public double? GetDouble(string key) { - return this.GetValue(key); + var hasValue = this._metadata.TryGetValue(key, out var value); + if (!hasValue) + { + return null; + } + + return value is double || value is int ? Convert.ToDouble(value) : null; } /// diff --git a/src/OpenFeature/Model/Value.cs b/src/OpenFeature/Model/Value.cs index f09a24667..524ac4c4c 100644 --- a/src/OpenFeature/Model/Value.cs +++ b/src/OpenFeature/Model/Value.cs @@ -1,4 +1,5 @@ using System.Collections.Immutable; +using System.Text.Json.Serialization; namespace OpenFeature.Model; @@ -6,7 +7,8 @@ namespace OpenFeature.Model; /// Values serve as a return type for provider objects. Providers may deal in JSON, protobuf, XML or some other data-interchange format. /// This intermediate representation provides a good medium of exchange. /// -public sealed class Value +[JsonConverter(typeof(ValueJsonConverter))] +public sealed class Value : IEquatable { private readonly object? _innerValue; @@ -184,4 +186,196 @@ public Value(Object value) /// /// Value as DateTime public DateTime? AsDateTime => this.IsDateTime ? (DateTime?)this._innerValue : null; + + /// + /// Determines whether the specified is equal to the current . + /// + /// The to compare with the current . + /// true if the specified is equal to the current ; otherwise, false. + public bool Equals(Value? other) + { + if (other is null) return false; + if (ReferenceEquals(this, other)) return true; + + // Both are null + if (this.IsNull && other.IsNull) return true; + + // One is null, the other is not + if (this.IsNull != other.IsNull) return false; + + // Different types + if (this.GetValueType() != other.GetValueType()) return false; + + // Compare based on type + return this.GetValueType() switch + { + ValueType.Boolean => this.AsBoolean == other.AsBoolean, + ValueType.Number => this.AsDouble == other.AsDouble, + ValueType.String => this.AsString == other.AsString, + ValueType.DateTime => this.AsDateTime == other.AsDateTime, + ValueType.Structure => this.StructureEquals(other), + ValueType.List => this.ListEquals(other), + _ => false + }; + } + + /// + /// Determines whether the specified object is equal to the current . + /// + /// The object to compare with the current . + /// true if the specified object is equal to the current ; otherwise, false. + public override bool Equals(object? obj) => this.Equals(obj as Value); + + /// + /// Returns the hash code for this . + /// + /// A hash code for the current . + public override int GetHashCode() + { + if (this.IsNull) return 0; + + return this.GetValueType() switch + { + ValueType.Boolean => this.AsBoolean!.GetHashCode(), + ValueType.Number => this.AsDouble!.GetHashCode(), + ValueType.String => this.AsString!.GetHashCode(), + ValueType.DateTime => this.AsDateTime!.GetHashCode(), + ValueType.Structure => this.GetStructureHashCode(), + ValueType.List => this.GetListHashCode(), + _ => 0 + }; + } + + /// + /// Determines whether two instances are equal. + /// + /// The first to compare. + /// The second to compare. + /// true if the values are equal; otherwise, false. + public static bool operator ==(Value? left, Value? right) + { + if (left is null && right is null) return true; + if (left is null || right is null) return false; + return left.Equals(right); + } + + /// + /// Determines whether two instances are not equal. + /// + /// The first to compare. + /// The second to compare. + /// true if the values are not equal; otherwise, false. + public static bool operator !=(Value? left, Value? right) => !(left == right); + + /// + /// Gets the type of the current value. + /// + /// The of the current value. + private ValueType GetValueType() + { + if (this.IsNull) return ValueType.Null; + if (this.IsBoolean) return ValueType.Boolean; + if (this.IsNumber) return ValueType.Number; + if (this.IsString) return ValueType.String; + if (this.IsDateTime) return ValueType.DateTime; + if (this.IsStructure) return ValueType.Structure; + if (this.IsList) return ValueType.List; + return ValueType.Unknown; + } + + /// + /// Compares two Structure values for equality. + /// + /// The other to compare. + /// true if the structures are equal; otherwise, false. + private bool StructureEquals(Value other) + { + var thisStructure = this.AsStructure!; + var otherStructure = other.AsStructure!; + + if (thisStructure.Count != otherStructure.Count) return false; + + foreach (var kvp in thisStructure) + { + if (!otherStructure.TryGetValue(kvp.Key, out var otherValue) || !kvp.Value.Equals(otherValue)) + { + return false; + } + } + + return true; + } + + /// + /// Compares two List values for equality. + /// + /// The other to compare. + /// true if the lists are equal; otherwise, false. + private bool ListEquals(Value other) + { + var thisList = this.AsList!; + var otherList = other.AsList!; + + if (thisList.Count != otherList.Count) return false; + + for (int i = 0; i < thisList.Count; i++) + { + if (!thisList[i].Equals(otherList[i])) + { + return false; + } + } + + return true; + } + + /// + /// Gets the hash code for a Structure value. + /// + /// The hash code of the structure. + private int GetStructureHashCode() + { + var structure = this.AsStructure!; + var hash = new HashCode(); + + foreach (var kvp in structure) + { + hash.Add(kvp.Key); + hash.Add(kvp.Value); + } + + return hash.ToHashCode(); + } + + /// + /// Gets the hash code for a List value. + /// + /// The hash code of the list. + private int GetListHashCode() + { + var list = this.AsList!; + var hash = new HashCode(); + + foreach (var item in list) + { + hash.Add(item); + } + + return hash.ToHashCode(); + } + + /// + /// Represents the different types that a can contain. + /// + private enum ValueType + { + Null, + Boolean, + Number, + String, + DateTime, + Structure, + List, + Unknown + } } diff --git a/src/OpenFeature/Model/ValueJsonConverter.cs b/src/OpenFeature/Model/ValueJsonConverter.cs new file mode 100644 index 000000000..7ffbf9c14 --- /dev/null +++ b/src/OpenFeature/Model/ValueJsonConverter.cs @@ -0,0 +1,130 @@ +using System.Diagnostics; +using System.Text.Json; +using System.Text.Json.Serialization; + +namespace OpenFeature.Model; + +/// +/// A for for Json serialization. +/// This converter is AOT-compatible as it uses manual JSON reading/writing +/// instead of reflection-based serialization. +/// +public sealed class ValueJsonConverter : JsonConverter +{ + /// + public override void Write(Utf8JsonWriter writer, Value value, JsonSerializerOptions options) => + WriteJsonValue(value, writer); + + /// + public override Value Read(ref Utf8JsonReader reader, Type typeToConvert, JsonSerializerOptions options) => + ReadJsonValue(ref reader); + + private static void WriteJsonValue(Value value, Utf8JsonWriter writer) + { + if (value.IsNull) + { + writer.WriteNullValue(); + return; + } + + if (value.IsBoolean) + { + writer.WriteBooleanValue(value.AsBoolean.GetValueOrDefault()); + return; + } + + if (value.IsNumber) + { + writer.WriteNumberValue(value.AsDouble!.Value); + return; + } + + if (value.IsString) + { + writer.WriteStringValue(value.AsString); + return; + } + + if (value.IsDateTime) + { + writer.WriteStringValue(value.AsDateTime!.Value); + return; + } + + if (value.IsList) + { + writer.WriteStartArray(); + + foreach (var item in value.AsList ?? []) + { + WriteJsonValue(item, writer); + } + + writer.WriteEndArray(); + return; + } + + if (value.IsStructure) + { + writer.WriteStartObject(); + + var dic = value.AsStructure?.AsDictionary(); + if (dic is { Count: > 0 }) + { + foreach (var pair in dic) + { + writer.WritePropertyName(pair.Key); + WriteJsonValue(pair.Value, writer); + } + } + + writer.WriteEndObject(); + } + } + + private static Value ReadJsonValue(ref Utf8JsonReader reader) + { + switch (reader.TokenType) + { + case JsonTokenType.True: + return new(true); + case JsonTokenType.False: + return new(false); + case JsonTokenType.Number: + if (reader.TryGetInt32(out var intVal)) + return new(intVal); + + return new(reader.GetDouble()); + case JsonTokenType.String: + if (reader.TryGetDateTime(out var dateTime)) + return new(dateTime); + + return new(reader.GetString()!); + case JsonTokenType.StartArray: + var list = new List(); + while (reader.Read()) + { + if (reader.TokenType == JsonTokenType.EndArray) + { + break; + } + list.Add(ReadJsonValue(ref reader)); + } + return new(list); + case JsonTokenType.StartObject: + var objectBuilder = Structure.Builder(); + while (reader.Read() && reader.TokenType != JsonTokenType.EndObject) + { + var name = reader.GetString(); + Debug.Assert(name is not null); + reader.Read(); + objectBuilder.Set(name!, ReadJsonValue(ref reader)); + } + return new(objectBuilder.Build()); + + default: + return new(); + } + } +} + diff --git a/src/OpenFeature/OpenFeature.csproj b/src/OpenFeature/OpenFeature.csproj index c47b109d0..67d00f0ba 100644 --- a/src/OpenFeature/OpenFeature.csproj +++ b/src/OpenFeature/OpenFeature.csproj @@ -8,7 +8,10 @@ + + + @@ -16,6 +19,9 @@ + + + diff --git a/src/OpenFeature/OpenFeatureClient.cs b/src/OpenFeature/OpenFeatureClient.cs index 02acde07c..1f47d2d24 100644 --- a/src/OpenFeature/OpenFeatureClient.cs +++ b/src/OpenFeature/OpenFeatureClient.cs @@ -10,7 +10,7 @@ namespace OpenFeature; /// -/// +/// OpenFeature Client implementation for resolving feature flags and tracking user interactions. /// public sealed partial class FeatureClient : IFeatureClient { @@ -18,6 +18,7 @@ public sealed partial class FeatureClient : IFeatureClient private readonly ConcurrentStack _hooks = new ConcurrentStack(); private readonly ILogger _logger; private readonly Func _providerAccessor; + private readonly Api _api; private EvaluationContext _evaluationContext; private readonly object _evaluationContextLock = new object(); @@ -40,7 +41,7 @@ public sealed partial class FeatureClient : IFeatureClient { // Alias the provider reference so getting the method and returning the provider are // guaranteed to be the same object. - var provider = Api.Instance.GetProvider(this._metadata.Name!); + var provider = this._api.GetProvider(this._metadata.Name!); return (method(provider), provider); } @@ -69,18 +70,20 @@ public void SetContext(EvaluationContext? context) /// /// Initializes a new instance of the class. /// + /// The API instance for accessing global state and providers /// Function to retrieve current provider /// Name of client /// Version of client /// Logger used by client /// Context given to this client /// Throws if any of the required parameters are null - internal FeatureClient(Func providerAccessor, string? name, string? version, ILogger? logger = null, EvaluationContext? context = null) + internal FeatureClient(Api api, Func providerAccessor, string? name, string? version, ILogger? logger = null, EvaluationContext? context = null) { + this._api = api; + this._providerAccessor = providerAccessor; this._metadata = new ClientMetadata(name, version); this._logger = logger ?? NullLogger.Instance; this._evaluationContext = context ?? EvaluationContext.Empty; - this._providerAccessor = providerAccessor; } /// @@ -99,13 +102,13 @@ internal FeatureClient(Func providerAccessor, string? name, str /// public void AddHandler(ProviderEventTypes eventType, EventHandlerDelegate handler) { - Api.Instance.AddClientHandler(this._metadata.Name!, eventType, handler); + this._api.AddClientHandler(this._metadata.Name!, eventType, handler); } /// public void RemoveHandler(ProviderEventTypes type, EventHandlerDelegate handler) { - Api.Instance.RemoveClientHandler(this._metadata.Name!, type, handler); + this._api.RemoveClientHandler(this._metadata.Name!, type, handler); } /// @@ -213,13 +216,13 @@ private async Task> EvaluateFlagAsync( // merge api, client, transaction and invocation context var evaluationContextBuilder = EvaluationContext.Builder(); - evaluationContextBuilder.Merge(Api.Instance.GetContext()); // API context + evaluationContextBuilder.Merge(this._api.GetContext()); // API context evaluationContextBuilder.Merge(this.GetContext()); // Client context - evaluationContextBuilder.Merge(Api.Instance.GetTransactionContext()); // Transaction context + evaluationContextBuilder.Merge(this._api.GetTransactionContext()); // Transaction context evaluationContextBuilder.Merge(context); // Invocation context var allHooks = ImmutableList.CreateBuilder() - .Concat(Api.Instance.GetHooks()) + .Concat(this._api.GetHooks()) .Concat(this.GetHooks()) .Concat(options?.Hooks ?? Enumerable.Empty()) .Concat(provider.GetProviderHooks()) @@ -302,13 +305,7 @@ await hookRunner.TriggerFinallyHooksAsync(evaluation, options?.HookHints, cancel return evaluation; } - /// - /// Use this method to track user interactions and the application state. - /// - /// The name associated with this tracking event - /// The evaluation context used in the evaluation of the flag (optional) - /// Data pertinent to the tracking event (Optional) - /// When trackingEventName is null or empty + /// public void Track(string trackingEventName, EvaluationContext? evaluationContext = default, TrackingEventDetails? trackingEventDetails = default) { if (string.IsNullOrWhiteSpace(trackingEventName)) @@ -316,7 +313,7 @@ public void Track(string trackingEventName, EvaluationContext? evaluationContext throw new ArgumentException("Tracking event cannot be null or empty.", nameof(trackingEventName)); } - var globalContext = Api.Instance.GetContext(); + var globalContext = this._api.GetContext(); var clientContext = this.GetContext(); var evaluationContextBuilder = EvaluationContext.Builder() diff --git a/src/OpenFeature/ProviderRepository.cs b/src/OpenFeature/ProviderRepository.cs index 4f938940d..4cea63b08 100644 --- a/src/OpenFeature/ProviderRepository.cs +++ b/src/OpenFeature/ProviderRepository.cs @@ -4,7 +4,6 @@ using OpenFeature.Constant; using OpenFeature.Model; - namespace OpenFeature; /// @@ -12,12 +11,11 @@ namespace OpenFeature; /// internal sealed partial class ProviderRepository : IAsyncDisposable { - private ILogger _logger = NullLogger.Instance; + private ILogger _logger = NullLogger.Instance; private FeatureProvider _defaultProvider = new NoOpFeatureProvider(); - private readonly ConcurrentDictionary _featureProviders = - new ConcurrentDictionary(); + private readonly ConcurrentDictionary _featureProviders = new(); /// The reader/writer locks is not disposed because the singleton instance should never be disposed. /// @@ -29,7 +27,7 @@ internal sealed partial class ProviderRepository : IAsyncDisposable /// The second is that a concurrent collection doesn't provide any ordering, so we could check a provider /// as it was being added or removed such as two concurrent calls to SetProvider replacing multiple instances /// of that provider under different names. - private readonly ReaderWriterLockSlim _providersLock = new ReaderWriterLockSlim(); + private readonly ReaderWriterLockSlim _providersLock = new(); public async ValueTask DisposeAsync() { @@ -53,11 +51,13 @@ public async ValueTask DisposeAsync() /// called if an error happens during the initialization of the provider, only called if the provider needed /// initialization /// - public async Task SetProviderAsync( + /// a cancellation token to cancel the operation + internal async Task SetProviderAsync( FeatureProvider? featureProvider, EvaluationContext context, Func? afterInitSuccess = null, - Func? afterInitError = null) + Func? afterInitError = null, + CancellationToken cancellationToken = default) { // Cannot unset the feature provider. if (featureProvider == null) @@ -79,14 +79,14 @@ public async Task SetProviderAsync( this._defaultProvider = featureProvider; // We want to allow shutdown to happen concurrently with initialization, and the caller to not // wait for it. - _ = this.ShutdownIfUnusedAsync(oldProvider); + _ = this.ShutdownIfUnusedAsync(oldProvider, cancellationToken); } finally { this._providersLock.ExitWriteLock(); } - await InitProviderAsync(this._defaultProvider, context, afterInitSuccess, afterInitError) + await InitProviderAsync(this._defaultProvider, context, afterInitSuccess, afterInitError, cancellationToken) .ConfigureAwait(false); } @@ -94,7 +94,8 @@ private static async Task InitProviderAsync( FeatureProvider? newProvider, EvaluationContext context, Func? afterInitialization, - Func? afterError) + Func? afterError, + CancellationToken cancellationToken = default) { if (newProvider == null) { @@ -104,7 +105,7 @@ private static async Task InitProviderAsync( { try { - await newProvider.InitializeAsync(context).ConfigureAwait(false); + await newProvider.InitializeAsync(context, cancellationToken).ConfigureAwait(false); if (afterInitialization != null) { await afterInitialization.Invoke(newProvider).ConfigureAwait(false); @@ -134,7 +135,7 @@ private static async Task InitProviderAsync( /// initialization /// /// The to cancel any async side effects. - public async Task SetProviderAsync(string? domain, + internal async Task SetProviderAsync(string domain, FeatureProvider? featureProvider, EvaluationContext context, Func? afterInitSuccess = null, @@ -142,7 +143,7 @@ public async Task SetProviderAsync(string? domain, CancellationToken cancellationToken = default) { // Cannot set a provider for a null domain. - if (domain == null) + if (string.IsNullOrWhiteSpace(domain)) { return; } @@ -166,21 +167,21 @@ public async Task SetProviderAsync(string? domain, // We want to allow shutdown to happen concurrently with initialization, and the caller to not // wait for it. - _ = this.ShutdownIfUnusedAsync(oldProvider); + _ = this.ShutdownIfUnusedAsync(oldProvider, cancellationToken); } finally { this._providersLock.ExitWriteLock(); } - await InitProviderAsync(featureProvider, context, afterInitSuccess, afterInitError).ConfigureAwait(false); + await InitProviderAsync(featureProvider, context, afterInitSuccess, afterInitError, cancellationToken).ConfigureAwait(false); } /// /// Shutdown the feature provider if it is unused. This must be called within a write lock of the _providersLock. /// private async Task ShutdownIfUnusedAsync( - FeatureProvider? targetProvider) + FeatureProvider? targetProvider, CancellationToken cancellationToken = default) { if (ReferenceEquals(this._defaultProvider, targetProvider)) { @@ -192,7 +193,7 @@ private async Task ShutdownIfUnusedAsync( return; } - await this.SafeShutdownProviderAsync(targetProvider).ConfigureAwait(false); + await this.SafeShutdownProviderAsync(targetProvider, cancellationToken).ConfigureAwait(false); } /// @@ -204,7 +205,7 @@ private async Task ShutdownIfUnusedAsync( /// it would not be meaningful to emit an error. /// /// - private async Task SafeShutdownProviderAsync(FeatureProvider? targetProvider) + private async Task SafeShutdownProviderAsync(FeatureProvider? targetProvider, CancellationToken cancellationToken = default) { if (targetProvider == null) { @@ -213,7 +214,7 @@ private async Task SafeShutdownProviderAsync(FeatureProvider? targetProvider) try { - await targetProvider.ShutdownAsync().ConfigureAwait(false); + await targetProvider.ShutdownAsync(cancellationToken).ConfigureAwait(false); } catch (Exception ex) { @@ -221,7 +222,7 @@ private async Task SafeShutdownProviderAsync(FeatureProvider? targetProvider) } } - public FeatureProvider GetProvider() + internal FeatureProvider GetProvider() { this._providersLock.EnterReadLock(); try @@ -234,16 +235,16 @@ public FeatureProvider GetProvider() } } - public FeatureProvider GetProvider(string? domain) + internal FeatureProvider GetProvider(string? domain) { -#if NET6_0_OR_GREATER - if (string.IsNullOrEmpty(domain)) +#if NETFRAMEWORK || NETSTANDARD + // This is a workaround for the issue in .NET Framework where string.IsNullOrEmpty is not nullable compatible. + if (domain == null) { return this.GetProvider(); } #else - // This is a workaround for the issue in .NET Framework where string.IsNullOrEmpty is not nullable compatible. - if (domain == null || string.IsNullOrEmpty(domain)) + if (string.IsNullOrWhiteSpace(domain)) { return this.GetProvider(); } @@ -254,7 +255,7 @@ public FeatureProvider GetProvider(string? domain) : this.GetProvider(); } - public async Task ShutdownAsync(Action? afterError = null, CancellationToken cancellationToken = default) + internal async Task ShutdownAsync(Action? afterError = null, CancellationToken cancellationToken = default) { var providers = new HashSet(); this._providersLock.EnterWriteLock(); @@ -278,7 +279,7 @@ public async Task ShutdownAsync(Action? afterError = foreach (var targetProvider in providers) { // We don't need to take any actions after shutdown. - await this.SafeShutdownProviderAsync(targetProvider).ConfigureAwait(false); + await this.SafeShutdownProviderAsync(targetProvider, cancellationToken).ConfigureAwait(false); } } diff --git a/src/OpenFeature/Serialization/OpenFeatureJsonSerializerContext.cs b/src/OpenFeature/Serialization/OpenFeatureJsonSerializerContext.cs new file mode 100644 index 000000000..820474cb4 --- /dev/null +++ b/src/OpenFeature/Serialization/OpenFeatureJsonSerializerContext.cs @@ -0,0 +1,28 @@ +using System.Collections.Immutable; +using System.Text.Json.Serialization; +using OpenFeature.Model; + +namespace OpenFeature.Serialization; + +/// +/// JSON serializer context for AOT compilation support. +/// This ensures that all necessary types are pre-compiled for JSON serialization +/// when using NativeAOT. +/// +[JsonSerializable(typeof(Value))] +[JsonSerializable(typeof(Structure))] +[JsonSerializable(typeof(EvaluationContext))] +[JsonSerializable(typeof(Dictionary))] +[JsonSerializable(typeof(ImmutableDictionary))] +[JsonSerializable(typeof(List))] +[JsonSerializable(typeof(ImmutableList))] +[JsonSerializable(typeof(bool))] +[JsonSerializable(typeof(string))] +[JsonSerializable(typeof(int))] +[JsonSerializable(typeof(double))] +[JsonSerializable(typeof(DateTime))] +[JsonSourceGenerationOptions( + WriteIndented = false, + PropertyNamingPolicy = JsonKnownNamingPolicy.CamelCase, + DefaultIgnoreCondition = JsonIgnoreCondition.WhenWritingNull)] +public partial class OpenFeatureJsonSerializerContext : JsonSerializerContext; diff --git a/src/OpenFeature/Telemetry/EvaluationEventBuilder.cs b/src/OpenFeature/Telemetry/EvaluationEventBuilder.cs index d9520c124..b17565ce3 100644 --- a/src/OpenFeature/Telemetry/EvaluationEventBuilder.cs +++ b/src/OpenFeature/Telemetry/EvaluationEventBuilder.cs @@ -6,14 +6,14 @@ namespace OpenFeature.Telemetry; /// /// Class for creating evaluation events for feature flags. /// -public sealed class EvaluationEventBuilder +public sealed class EvaluationEventBuilder { private const string EventName = "feature_flag.evaluation"; /// - /// Gets the default instance of the . + /// Gets the default instance of the . /// - public static EvaluationEventBuilder Default { get; } = new(); + public static EvaluationEventBuilder Default { get; } = new(); /// /// Creates an evaluation event based on the provided hook context and flag evaluation details. @@ -21,7 +21,7 @@ public sealed class EvaluationEventBuilder /// The context of the hook containing flag key and provider metadata. /// The details of the flag evaluation including reason, variant, and metadata. /// An instance of containing the event name, attributes, and body. - public EvaluationEvent Build(HookContext hookContext, FlagEvaluationDetails details) + public static EvaluationEvent Build(HookContext hookContext, FlagEvaluationDetails details) { var attributes = new Dictionary { diff --git a/test/OpenFeature.AotCompatibility/OpenFeature.AotCompatibility.csproj b/test/OpenFeature.AotCompatibility/OpenFeature.AotCompatibility.csproj new file mode 100644 index 000000000..d416bd75b --- /dev/null +++ b/test/OpenFeature.AotCompatibility/OpenFeature.AotCompatibility.csproj @@ -0,0 +1,34 @@ + + + + net9.0 + Exe + enable + enable + + + true + true + + + false + NU1903 + OpenFeature.AotCompatibility + + + + + + + + + + + + + + + + + + diff --git a/test/OpenFeature.AotCompatibility/Program.cs b/test/OpenFeature.AotCompatibility/Program.cs new file mode 100644 index 000000000..5529eef21 --- /dev/null +++ b/test/OpenFeature.AotCompatibility/Program.cs @@ -0,0 +1,299 @@ +using System.Text.Json; +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Hosting; +using Microsoft.Extensions.Logging; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider; +using OpenFeature.Providers.MultiProvider.Models; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenFeature.Serialization; + +namespace OpenFeature.AotCompatibility; + +/// +/// This program validates OpenFeature SDK compatibility with NativeAOT. +/// It tests core functionality to ensure everything works correctly when compiled with AOT. +/// +internal class Program +{ + private static async Task Main(string[] args) + { + Console.WriteLine("OpenFeature NativeAOT Compatibility Test"); + Console.WriteLine("=========================================="); + + try + { + // Test basic API functionality + await TestBasicApiAsync(); + + // Test MultiProvider AOT compatibility + await TestMultiProviderAotCompatibilityAsync(); + + // Test JSON serialization with AOT-compatible serializer context + TestJsonSerialization(); + + // Test dependency injection + await TestDependencyInjectionAsync(); + + // Test error handling and enum descriptions + TestErrorHandling(); + + Console.WriteLine("\nAll tests passed! OpenFeature is AOT-compatible."); + } + catch (Exception ex) + { + Console.WriteLine($"\nAOT compatibility test failed: {ex.Message}"); + Console.WriteLine(ex.StackTrace); + Environment.Exit(1); + } + } + + private static async Task TestBasicApiAsync() + { + Console.WriteLine("\nTesting basic API functionality..."); + + // Test singleton instance access + var api = Api.Instance; + Console.WriteLine($"โœ“- API instance created: {api.GetType().Name}"); + + // Test client creation + var client = api.GetClient("test-client", "1.0.0"); + Console.WriteLine($"โœ“- Client created: {client.GetType().Name}"); + + // Test flag evaluation with default provider (NoOpProvider) + var boolResult = await client.GetBooleanValueAsync("test-flag", false); + Console.WriteLine($"โœ“- Boolean flag evaluation: {boolResult}"); + + var stringResult = await client.GetStringValueAsync("test-string-flag", "default"); + Console.WriteLine($"โœ“- String flag evaluation: {stringResult}"); + + var intResult = await client.GetIntegerValueAsync("test-int-flag", 42); + Console.WriteLine($"โœ“- Integer flag evaluation: {intResult}"); + + var doubleResult = await client.GetDoubleValueAsync("test-double-flag", 3.14); + Console.WriteLine($"โœ“- Double flag evaluation: {doubleResult}"); + + // Test evaluation context + var context = EvaluationContext.Builder() + .Set("userId", "user123") + .Set("enabled", true) + .Build(); + api.SetContext(context); + Console.WriteLine($"โœ“- Evaluation context set with {context.Count} attributes"); + + // Test error flag with AOT-compatible GetDescription() + await TestErrorFlagAsync(client); + } + + private static async Task TestErrorFlagAsync(IFeatureClient client) + { + Console.WriteLine("\nTesting error flag with GetDescription()..."); + + // Set a test provider that can return errors + await Api.Instance.SetProviderAsync(new TestProvider()); + + // Test the error flag - this will internally trigger GetDescription() in the SDK's error handling + var errorResult = await client.GetBooleanDetailsAsync("error-flag", false); + Console.WriteLine($"โœ“- Error flag evaluation: {errorResult.Value} (Error: {errorResult.ErrorType})"); + Console.WriteLine($"โœ“- Error message: '{errorResult.ErrorMessage}'"); + Console.WriteLine("โœ“- GetDescription() method was executed internally by the SDK during error handling"); + } + + private static async Task TestMultiProviderAotCompatibilityAsync() + { + Console.WriteLine("\nTesting MultiProvider AOT compatibility..."); + + // Create test providers for MultiProvider + var primaryProvider = new TestProvider(); + var fallbackProvider = new TestProvider(); + + // Create provider entries for MultiProvider + var providerEntries = new List + { + new(primaryProvider, "primary"), new(fallbackProvider, "fallback") + }; + + // Test MultiProvider creation with FirstMatchStrategy (default) + var multiProvider = new MultiProvider(providerEntries); + Console.WriteLine($"โœ“- MultiProvider created with {providerEntries.Count} providers"); + + // Test MultiProvider metadata + var metadata = multiProvider.GetMetadata(); + Console.WriteLine($"โœ“- MultiProvider metadata: {metadata.Name}"); + + await TestStrategy(providerEntries, new FirstMatchStrategy(), "FirstMatchStrategy"); + await TestStrategy(providerEntries, new ComparisonStrategy(), "ComparisonStrategy"); + await TestStrategy(providerEntries, new FirstSuccessfulStrategy(), "FirstSuccessfulStrategy"); + } + + private static async Task TestStrategy(List providerEntries, BaseEvaluationStrategy strategy, string strategyName) + { + // Test MultiProvider with strategy + var multiProvider = new MultiProvider(providerEntries, strategy); + Console.WriteLine($"โœ“- MultiProvider created with {strategyName}"); + + // Test all value types with MultiProvider + var evaluationContext = EvaluationContext.Builder() + .Set("userId", "aot-test-user") + .Set("environment", "test") + .Build(); + + // Test boolean evaluation + var boolResult = await multiProvider.ResolveBooleanValueAsync("test-bool-flag", false, evaluationContext); + Console.WriteLine($"โœ“- MultiProvider boolean evaluation: {boolResult.Value} (from {boolResult.Variant})"); + + // Test string evaluation + var stringResult = + await multiProvider.ResolveStringValueAsync("test-string-flag", "default", evaluationContext); + Console.WriteLine($"โœ“- MultiProvider string evaluation: {stringResult.Value} (from {stringResult.Variant})"); + + // Test integer evaluation + var intResult = await multiProvider.ResolveIntegerValueAsync("test-int-flag", 0, evaluationContext); + Console.WriteLine($"โœ“- MultiProvider integer evaluation: {intResult.Value} (from {intResult.Variant})"); + + // Test double evaluation + var doubleResult = await multiProvider.ResolveDoubleValueAsync("test-double-flag", 0.0, evaluationContext); + Console.WriteLine($"โœ“- MultiProvider double evaluation: {doubleResult.Value} (from {doubleResult.Variant})"); + + // Test structure evaluation + var structureResult = + await multiProvider.ResolveStructureValueAsync("test-structure-flag", new Value("default"), + evaluationContext); + Console.WriteLine( + $"โœ“- MultiProvider structure evaluation: {structureResult.Value} (from {structureResult.Variant})"); + + // Test MultiProvider lifecycle + await multiProvider.InitializeAsync(evaluationContext); + Console.WriteLine("โœ“- MultiProvider initialization completed"); + + await multiProvider.ShutdownAsync(); + Console.WriteLine("โœ“- MultiProvider shutdown completed"); + + // Test MultiProvider disposal + await multiProvider.DisposeAsync(); + Console.WriteLine("โœ“- MultiProvider disposal completed"); + } + + private static void TestJsonSerialization() + { + Console.WriteLine("\nTesting JSON serialization with AOT context..."); + + // Test Value serialization with AOT-compatible context + var structureBuilder = Structure.Builder() + .Set("name", "test") + .Set("enabled", true) + .Set("count", 42) + .Set("score", 98.5); + + var structure = structureBuilder.Build(); + var value = new Value(structure); + + try + { + // Serialize using the AOT-compatible context + var json = JsonSerializer.Serialize(value, OpenFeatureJsonSerializerContext.Default.Value); + Console.WriteLine($"โœ“- Value serialized to JSON: {json}"); + + // Deserialize back + var deserializedValue = JsonSerializer.Deserialize(json, OpenFeatureJsonSerializerContext.Default.Value); + Console.WriteLine($"โœ“- Value deserialized from JSON successfully: {value}", deserializedValue); + } + catch (Exception ex) + { + // Fallback test with the custom converter (should still work) + Console.WriteLine($"X- AOT context serialization failed, testing fallback: {ex.Message}"); + } + } + + private static async Task TestDependencyInjectionAsync() + { + Console.WriteLine("\nTesting dependency injection..."); + + var builder = Host.CreateApplicationBuilder(); + + // Add OpenFeature with DI + builder.Services.AddOpenFeature(of => of.AddProvider(_ => new TestProvider()).AddHook(_ => new TestHook())); + + builder.Services.AddLogging(logging => logging.AddConsole()); + + using var host = builder.Build(); + + var api = host.Services.GetRequiredService(); + Console.WriteLine($"โœ“- FeatureClient resolved from DI: {api.GetType().Name}"); + + var result = await api.GetIntegerValueAsync("di-test-flag", 1); + Console.WriteLine($"โœ“- Flag evaluation via DI: {result}"); + } + + private static void TestErrorHandling() + { + Console.WriteLine("\nTesting error handling and enum descriptions..."); + + // Test ErrorType enum values (GetDescription will be called internally by the SDK) + var errorTypes = new[] + { + ErrorType.None, ErrorType.ProviderNotReady, ErrorType.FlagNotFound, ErrorType.ParseError, + ErrorType.TypeMismatch, ErrorType.General, ErrorType.InvalidContext, ErrorType.TargetingKeyMissing, + ErrorType.ProviderFatal + }; + + foreach (var errorType in errorTypes) + { + // Just validate the enum values exist and are accessible in AOT + Console.WriteLine($"โœ“- ErrorType.{errorType} is accessible in AOT compilation"); + } + + Console.WriteLine("โœ“- All ErrorType enum values validated for AOT compatibility"); + Console.WriteLine("โœ“- GetDescription() method will be exercised internally when errors occur"); + } +} + +/// +/// A simple test provider for validating DI functionality +/// +internal class TestProvider : FeatureProvider +{ + public override Metadata GetMetadata() => new("test-provider"); + + public override Task> ResolveBooleanValueAsync(string flagKey, bool defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) + { + if (flagKey == "error-flag") + { + // Return an error for the "error-flag" key using constructor parameters + return Task.FromResult(new ResolutionDetails( + flagKey: flagKey, + value: defaultValue, + errorType: ErrorType.FlagNotFound, + errorMessage: "The flag key was not found." + )); + } + + return Task.FromResult(new ResolutionDetails(flagKey, true)); + } + + public override Task> ResolveStringValueAsync(string flagKey, string defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) + => Task.FromResult(new ResolutionDetails(flagKey, "test-value")); + + public override Task> ResolveIntegerValueAsync(string flagKey, int defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) + => Task.FromResult(new ResolutionDetails(flagKey, 123)); + + public override Task> ResolveDoubleValueAsync(string flagKey, double defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) + => Task.FromResult(new ResolutionDetails(flagKey, 123.45)); + + public override Task> ResolveStructureValueAsync(string flagKey, Value defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) + => Task.FromResult(new ResolutionDetails(flagKey, new Value("test"))); +} + +/// +/// A simple test hook for validating DI functionality +/// +internal class TestHook : Hook +{ + // No implementation needed for this test +} diff --git a/test/OpenFeature.DependencyInjection.Tests/OpenFeatureBuilderExtensionsTests.cs b/test/OpenFeature.DependencyInjection.Tests/OpenFeatureBuilderExtensionsTests.cs index f1edca4c4..f7cce0dfc 100644 --- a/test/OpenFeature.DependencyInjection.Tests/OpenFeatureBuilderExtensionsTests.cs +++ b/test/OpenFeature.DependencyInjection.Tests/OpenFeatureBuilderExtensionsTests.cs @@ -302,6 +302,40 @@ public void AddHook_WithSpecifiedNameAndImplementationFactory_AsKeyedService() Assert.NotNull(hook); } + [Fact] + public void AddHook_WithInstance_AddsHookAsKeyedService() + { + // Arrange + var expectedHook = new NoOpHook(); + _systemUnderTest.AddHook(expectedHook); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var actualHook = serviceProvider.GetKeyedService("NoOpHook"); + + // Assert + Assert.NotNull(actualHook); + Assert.Equal(expectedHook, actualHook); + } + + [Fact] + public void AddHook_WithSpecifiedNameAndInstance_AddsHookAsKeyedService() + { + // Arrange + var expectedHook = new NoOpHook(); + _systemUnderTest.AddHook("custom-hook", expectedHook); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var actualHook = serviceProvider.GetKeyedService("custom-hook"); + + // Assert + Assert.NotNull(actualHook); + Assert.Equal(expectedHook, actualHook); + } + [Fact] public void AddHandler_AddsEventHandlerDelegateWrapperAsKeyedService() { diff --git a/test/OpenFeature.Hosting.Tests/GuardTests.cs b/test/OpenFeature.Hosting.Tests/GuardTests.cs new file mode 100644 index 000000000..13b8883d5 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/GuardTests.cs @@ -0,0 +1,30 @@ +namespace OpenFeature.Hosting.Tests; + +public class GuardTests +{ + [Fact] + public void ThrowIfNull_WithNullArgument_ThrowsArgumentNullException() + { + // Arrange + object? argument = null; + + // Act + var exception = Assert.Throws(() => Guard.ThrowIfNull(argument)); + + // Assert + Assert.Equal("argument", exception.ParamName); + } + + [Fact] + public void ThrowIfNull_WithNotNullArgument_DoesNotThrowArgumentNullException() + { + // Arrange + object? argument = "Test argument"; + + // Act + var ex = Record.Exception(() => Guard.ThrowIfNull(argument)); + + // Assert + Assert.Null(ex); + } +} diff --git a/test/OpenFeature.Hosting.Tests/Internal/FeatureLifecycleManagerTests.cs b/test/OpenFeature.Hosting.Tests/Internal/FeatureLifecycleManagerTests.cs new file mode 100644 index 000000000..2d379fc4e --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/Internal/FeatureLifecycleManagerTests.cs @@ -0,0 +1,203 @@ +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Logging; +using Microsoft.Extensions.Logging.Abstractions; +using Microsoft.Extensions.Logging.Testing; +using OpenFeature.Constant; +using OpenFeature.Hosting.Internal; + +namespace OpenFeature.Hosting.Tests.Internal; + +public class FeatureLifecycleManagerTests : IAsyncLifetime +{ + [Fact] + public async Task EnsureInitializedAsync_SetsProvider() + { + // Arrange + var services = new ServiceCollection(); + var provider = new NoOpFeatureProvider(); + services.AddOptions().Configure(options => + { + options.AddProviderName(null); + }); + services.AddSingleton(provider); + + var api = Api.Instance; + + // Act + using var serviceProvider = services.BuildServiceProvider(); + var lifecycleManager = new FeatureLifecycleManager(api, serviceProvider, NullLogger.Instance); + await lifecycleManager.EnsureInitializedAsync(); + + // Assert + var actualProvider = api.GetProvider(); + Assert.Equal(provider, actualProvider); + } + + [Fact] + public async Task EnsureInitializedAsync_SetsMultipleProvider() + { + // Arrange + var services = new ServiceCollection(); + var provider1 = new NoOpFeatureProvider(); + var provider2 = new NoOpFeatureProvider(); + services.AddOptions().Configure(options => + { + options.AddProviderName("provider1"); + options.AddProviderName("provider2"); + }); + services.AddKeyedSingleton("provider1", provider1); + services.AddKeyedSingleton("provider2", provider2); + + var api = Api.Instance; + + // Act + using var serviceProvider = services.BuildServiceProvider(); + var lifecycleManager = new FeatureLifecycleManager(api, serviceProvider, NullLogger.Instance); + await lifecycleManager.EnsureInitializedAsync(); + + // Assert + Assert.Equal(provider1, api.GetProvider("provider1")); + Assert.Equal(provider2, api.GetProvider("provider2")); + } + + [Fact] + public async Task EnsureInitializedAsync_AddsHooks() + { + // Arrange + var services = new ServiceCollection(); + var provider = new NoOpFeatureProvider(); + var hook = new NoOpHook(); + services.AddOptions().Configure(options => + { + options.AddProviderName(null); + options.AddHookName("TestHook"); + }); + services.AddSingleton(provider); + services.AddKeyedSingleton("TestHook", hook); + + var api = Api.Instance; + + // Act + using var serviceProvider = services.BuildServiceProvider(); + var lifecycleManager = new FeatureLifecycleManager(api, serviceProvider, NullLogger.Instance); + await lifecycleManager.EnsureInitializedAsync(); + + // Assert + var actualHooks = api.GetHooks(); + Assert.Single(actualHooks); + Assert.Contains(hook, actualHooks); + } + + [Fact] + public async Task EnsureInitializedAsync_AddHandlers() + { + // Arrange + var services = new ServiceCollection(); + var provider = new NoOpFeatureProvider(); + services.AddOptions().Configure(options => + { + options.AddProviderName(null); + }); + services.AddSingleton(provider); + + bool hookExecuted = false; + services.AddSingleton(new EventHandlerDelegateWrapper(ProviderEventTypes.ProviderReady, (p) => { hookExecuted = true; })); + + var api = Api.Instance; + + // Act + using var serviceProvider = services.BuildServiceProvider(); + var lifecycleManager = new FeatureLifecycleManager(api, serviceProvider, NullLogger.Instance); + await lifecycleManager.EnsureInitializedAsync(); + + // Assert + Assert.True(hookExecuted); + } + + [Fact] + public async Task ShutdownAsync_ResetsApi() + { + // Arrange + var services = new ServiceCollection(); + var provider = new NoOpFeatureProvider(); + + var api = Api.Instance; + await api.SetProviderAsync(provider); + api.AddHooks(new NoOpHook()); + + // Act + using var serviceProvider = services.BuildServiceProvider(); + var lifecycleManager = new FeatureLifecycleManager(api, serviceProvider, NullLogger.Instance); + await lifecycleManager.ShutdownAsync(); + + // Assert + var actualProvider = api.GetProvider(); + Assert.NotEqual(provider, actualProvider); // Default provider should be set after shutdown + Assert.Empty(api.GetHooks()); // Hooks should be cleared + } + + [Fact] + public async Task EnsureInitializedAsync_LogStartingInitialization() + { + // Arrange + var services = new ServiceCollection(); + var provider = new NoOpFeatureProvider(); + services.AddOptions().Configure(options => + { + options.AddProviderName(null); + }); + services.AddSingleton(provider); + + var api = Api.Instance; + var logger = new FakeLogger(); + + // Act + using var serviceProvider = services.BuildServiceProvider(); + var lifecycleManager = new FeatureLifecycleManager(api, serviceProvider, logger); + await lifecycleManager.EnsureInitializedAsync(); + + // Assert + var log = logger.LatestRecord; + Assert.Equal(200, log.Id); + Assert.Equal("Starting initialization of the feature provider", log.Message); + Assert.Equal(LogLevel.Information, log.Level); + } + + [Fact] + public async Task ShutdownAsync_LogShuttingDown() + { + // Arrange + var services = new ServiceCollection(); + var provider = new NoOpFeatureProvider(); + services.AddOptions().Configure(options => + { + options.AddProviderName(null); + }); + services.AddSingleton(provider); + + var api = Api.Instance; + var logger = new FakeLogger(); + + // Act + using var serviceProvider = services.BuildServiceProvider(); + var lifecycleManager = new FeatureLifecycleManager(api, serviceProvider, logger); + await lifecycleManager.ShutdownAsync(); + + // Assert + var log = logger.LatestRecord; + Assert.Equal(200, log.Id); + Assert.Equal("Shutting down the feature provider", log.Message); + Assert.Equal(LogLevel.Information, log.Level); + } + + public async Task InitializeAsync() + { + await Api.Instance.ShutdownAsync(); + } + + // Make sure the singleton is cleared between tests + public async Task DisposeAsync() + { + await Api.Instance.ShutdownAsync().ConfigureAwait(false); + } +} diff --git a/test/OpenFeature.Hosting.Tests/NoOpFeatureProvider.cs b/test/OpenFeature.Hosting.Tests/NoOpFeatureProvider.cs new file mode 100644 index 000000000..a19a78b37 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/NoOpFeatureProvider.cs @@ -0,0 +1,52 @@ +using OpenFeature.Model; + +namespace OpenFeature.Hosting.Tests; + +// This class replicates the NoOpFeatureProvider implementation from src/OpenFeature/NoOpFeatureProvider.cs. +// It is used here to facilitate unit testing without relying on the internal NoOpFeatureProvider class. +// If the InternalsVisibleTo attribute is added to the OpenFeature project, +// this class can be removed and the original NoOpFeatureProvider can be directly accessed for testing. +internal sealed class NoOpFeatureProvider : FeatureProvider +{ + private readonly Metadata _metadata = new Metadata(NoOpProvider.NoOpProviderName); + + public override Metadata GetMetadata() + { + return this._metadata; + } + + public override Task> ResolveBooleanValueAsync(string flagKey, bool defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) + { + return Task.FromResult(NoOpResponse(flagKey, defaultValue)); + } + + public override Task> ResolveStringValueAsync(string flagKey, string defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) + { + return Task.FromResult(NoOpResponse(flagKey, defaultValue)); + } + + public override Task> ResolveIntegerValueAsync(string flagKey, int defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) + { + return Task.FromResult(NoOpResponse(flagKey, defaultValue)); + } + + public override Task> ResolveDoubleValueAsync(string flagKey, double defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) + { + return Task.FromResult(NoOpResponse(flagKey, defaultValue)); + } + + public override Task> ResolveStructureValueAsync(string flagKey, Value defaultValue, EvaluationContext? context = null, CancellationToken cancellationToken = default) + { + return Task.FromResult(NoOpResponse(flagKey, defaultValue)); + } + + private static ResolutionDetails NoOpResponse(string flagKey, T defaultValue) + { + return new ResolutionDetails( + flagKey, + defaultValue, + reason: NoOpProvider.ReasonNoOp, + variant: NoOpProvider.Variant + ); + } +} diff --git a/test/OpenFeature.Hosting.Tests/NoOpHook.cs b/test/OpenFeature.Hosting.Tests/NoOpHook.cs new file mode 100644 index 000000000..a0085f3b5 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/NoOpHook.cs @@ -0,0 +1,26 @@ +using OpenFeature.Model; + +namespace OpenFeature.Hosting.Tests; + +internal class NoOpHook : Hook +{ + public override ValueTask BeforeAsync(HookContext context, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + return base.BeforeAsync(context, hints, cancellationToken); + } + + public override ValueTask AfterAsync(HookContext context, FlagEvaluationDetails details, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + return base.AfterAsync(context, details, hints, cancellationToken); + } + + public override ValueTask FinallyAsync(HookContext context, FlagEvaluationDetails evaluationDetails, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + return base.FinallyAsync(context, evaluationDetails, hints, cancellationToken); + } + + public override ValueTask ErrorAsync(HookContext context, Exception error, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + return base.ErrorAsync(context, error, hints, cancellationToken); + } +} diff --git a/test/OpenFeature.Hosting.Tests/NoOpProvider.cs b/test/OpenFeature.Hosting.Tests/NoOpProvider.cs new file mode 100644 index 000000000..423cd3613 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/NoOpProvider.cs @@ -0,0 +1,8 @@ +namespace OpenFeature.Hosting.Tests; + +internal static class NoOpProvider +{ + public const string NoOpProviderName = "No-op Provider"; + public const string ReasonNoOp = "No-op"; + public const string Variant = "No-op"; +} diff --git a/test/OpenFeature.Hosting.Tests/OpenFeature.Hosting.Tests.csproj b/test/OpenFeature.Hosting.Tests/OpenFeature.Hosting.Tests.csproj new file mode 100644 index 000000000..ae8707a85 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/OpenFeature.Hosting.Tests.csproj @@ -0,0 +1,33 @@ + + + + net8.0;net9.0 + $(TargetFrameworks);net462 + OpenFeature.Hosting.Tests + + + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + + + + + diff --git a/test/OpenFeature.Hosting.Tests/OpenFeatureBuilderExtensionsTests.cs b/test/OpenFeature.Hosting.Tests/OpenFeatureBuilderExtensionsTests.cs new file mode 100644 index 000000000..1a284c918 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/OpenFeatureBuilderExtensionsTests.cs @@ -0,0 +1,562 @@ +using Microsoft.Extensions.DependencyInjection; +using Microsoft.Extensions.Options; +using OpenFeature.Hosting.Internal; +using OpenFeature.Model; + +namespace OpenFeature.Hosting.Tests; + +public partial class OpenFeatureBuilderExtensionsTests +{ + private readonly IServiceCollection _services; + private readonly OpenFeatureBuilder _systemUnderTest; + + public OpenFeatureBuilderExtensionsTests() + { + _services = new ServiceCollection(); + _systemUnderTest = new OpenFeatureBuilder(_services); + } + + [Theory] + [InlineData(true)] + [InlineData(false)] + public void AddContext_Delegate_ShouldAddServiceToCollection(bool useServiceProviderDelegate) + { + // Act + var featureBuilder = useServiceProviderDelegate ? + _systemUnderTest.AddContext(_ => { }) : + _systemUnderTest.AddContext((_, _) => { }); + + // Assert + Assert.Equal(_systemUnderTest, featureBuilder); + Assert.True(_systemUnderTest.IsContextConfigured, "The context should be configured."); + Assert.Single(_services, serviceDescriptor => + serviceDescriptor.ServiceType == typeof(EvaluationContext) && + serviceDescriptor.Lifetime == ServiceLifetime.Transient); + } + + [Theory] + [InlineData(true)] + [InlineData(false)] + public void AddContext_Delegate_ShouldCorrectlyHandles(bool useServiceProviderDelegate) + { + // Arrange + var delegateCalled = false; + + _ = useServiceProviderDelegate ? + _systemUnderTest.AddContext(_ => delegateCalled = true) : + _systemUnderTest.AddContext((_, _) => delegateCalled = true); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var context = serviceProvider.GetService(); + + // Assert + Assert.True(_systemUnderTest.IsContextConfigured, "The context should be configured."); + Assert.NotNull(context); + Assert.True(delegateCalled, "The delegate should be invoked."); + } + +#if NET8_0_OR_GREATER + [System.Diagnostics.CodeAnalysis.Experimental(Diagnostics.FeatureCodes.NewDi)] +#endif + [Theory] + [InlineData(1, true, 0)] + [InlineData(2, false, 1)] + [InlineData(3, true, 0)] + [InlineData(4, false, 1)] + public void AddProvider_ShouldAddProviderToCollection(int providerRegistrationType, bool expectsDefaultProvider, int expectsDomainBoundProvider) + { + // Act + var featureBuilder = providerRegistrationType switch + { + 1 => _systemUnderTest.AddProvider(_ => new NoOpFeatureProvider()), + 2 => _systemUnderTest.AddProvider("test", (_, _) => new NoOpFeatureProvider()), + 3 => _systemUnderTest.AddProvider(_ => new NoOpFeatureProvider(), o => { }), + 4 => _systemUnderTest.AddProvider("test", (_, _) => new NoOpFeatureProvider(), o => { }), + _ => throw new InvalidOperationException("Invalid mode.") + }; + + // Assert + Assert.False(_systemUnderTest.IsContextConfigured, "The context should not be configured."); + Assert.Equal(expectsDefaultProvider, _systemUnderTest.HasDefaultProvider); + Assert.False(_systemUnderTest.IsPolicyConfigured, "The policy should not be configured."); + Assert.Equal(expectsDomainBoundProvider, _systemUnderTest.DomainBoundProviderRegistrationCount); + Assert.Equal(_systemUnderTest, featureBuilder); + Assert.Single(_services, serviceDescriptor => + serviceDescriptor.ServiceType == typeof(FeatureProvider) && + serviceDescriptor.Lifetime == ServiceLifetime.Transient); + } + + class TestOptions : OpenFeatureOptions { } + +#if NET8_0_OR_GREATER + [System.Diagnostics.CodeAnalysis.Experimental(Diagnostics.FeatureCodes.NewDi)] +#endif + [Theory] + [InlineData(1)] + [InlineData(2)] + [InlineData(3)] + [InlineData(4)] + public void AddProvider_ShouldResolveCorrectProvider(int providerRegistrationType) + { + // Arrange + _ = providerRegistrationType switch + { + 1 => _systemUnderTest.AddProvider(_ => new NoOpFeatureProvider()), + 2 => _systemUnderTest.AddProvider("test", (_, _) => new NoOpFeatureProvider()), + 3 => _systemUnderTest.AddProvider(_ => new NoOpFeatureProvider(), o => { }), + 4 => _systemUnderTest.AddProvider("test", (_, _) => new NoOpFeatureProvider(), o => { }), + _ => throw new InvalidOperationException("Invalid mode.") + }; + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var provider = providerRegistrationType switch + { + 1 or 3 => serviceProvider.GetService(), + 2 or 4 => serviceProvider.GetKeyedService("test"), + _ => throw new InvalidOperationException("Invalid mode.") + }; + + // Assert + Assert.NotNull(provider); + Assert.IsType(provider); + } + + [Theory] + [InlineData(1, true, 1)] + [InlineData(2, true, 1)] + [InlineData(3, false, 2)] + [InlineData(4, true, 1)] + [InlineData(5, true, 1)] + [InlineData(6, false, 2)] + [InlineData(7, true, 2)] + [InlineData(8, true, 2)] + public void AddProvider_VerifiesDefaultAndDomainBoundProvidersBasedOnConfiguration(int providerRegistrationType, bool expectsDefaultProvider, int expectsDomainBoundProvider) + { + // Act + var featureBuilder = providerRegistrationType switch + { + 1 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider()) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()), + 2 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider()) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()), + 3 => _systemUnderTest + .AddProvider("test1", (_, _) => new NoOpFeatureProvider()) + .AddProvider("test2", (_, _) => new NoOpFeatureProvider()), + 4 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider(), o => { }) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()), + 5 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider(), o => { }) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()), + 6 => _systemUnderTest + .AddProvider("test1", (_, _) => new NoOpFeatureProvider(), o => { }) + .AddProvider("test2", (_, _) => new NoOpFeatureProvider()), + 7 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider()) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()) + .AddProvider("test2", (_, _) => new NoOpFeatureProvider()), + 8 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider(), o => { }) + .AddProvider("test", (_, _) => new NoOpFeatureProvider(), o => { }) + .AddProvider("test2", (_, _) => new NoOpFeatureProvider(), o => { }), + _ => throw new InvalidOperationException("Invalid mode.") + }; + + // Assert + Assert.False(_systemUnderTest.IsContextConfigured, "The context should not be configured."); + Assert.Equal(expectsDefaultProvider, _systemUnderTest.HasDefaultProvider); + Assert.False(_systemUnderTest.IsPolicyConfigured, "The policy should not be configured."); + Assert.Equal(expectsDomainBoundProvider, _systemUnderTest.DomainBoundProviderRegistrationCount); + Assert.Equal(_systemUnderTest, featureBuilder); + } + + [Theory] + [InlineData(1, null)] + [InlineData(2, "test")] + [InlineData(3, "test2")] + [InlineData(4, "test")] + [InlineData(5, null)] + [InlineData(6, "test1")] + [InlineData(7, "test2")] + [InlineData(8, null)] + public void AddProvider_ConfiguresPolicyNameAcrossMultipleProviderSetups(int providerRegistrationType, string? policyName) + { + // Arrange + var featureBuilder = providerRegistrationType switch + { + 1 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider()) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()) + .AddPolicyName(policy => policy.DefaultNameSelector = provider => policyName), + 2 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider()) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()) + .AddPolicyName(policy => policy.DefaultNameSelector = provider => policyName), + 3 => _systemUnderTest + .AddProvider("test1", (_, _) => new NoOpFeatureProvider()) + .AddProvider("test2", (_, _) => new NoOpFeatureProvider()) + .AddPolicyName(policy => policy.DefaultNameSelector = provider => policyName), + 4 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider(), o => { }) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()) + .AddPolicyName(policy => policy.DefaultNameSelector = provider => policyName), + 5 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider(), o => { }) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()) + .AddPolicyName(policy => policy.DefaultNameSelector = provider => policyName), + 6 => _systemUnderTest + .AddProvider("test1", (_, _) => new NoOpFeatureProvider(), o => { }) + .AddProvider("test2", (_, _) => new NoOpFeatureProvider()) + .AddPolicyName(policy => policy.DefaultNameSelector = provider => policyName), + 7 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider()) + .AddProvider("test", (_, _) => new NoOpFeatureProvider()) + .AddProvider("test2", (_, _) => new NoOpFeatureProvider()) + .AddPolicyName(policy => policy.DefaultNameSelector = provider => policyName), + 8 => _systemUnderTest + .AddProvider(_ => new NoOpFeatureProvider(), o => { }) + .AddProvider("test", (_, _) => new NoOpFeatureProvider(), o => { }) + .AddProvider("test2", (_, _) => new NoOpFeatureProvider(), o => { }) + .AddPolicyName(policy => policy.DefaultNameSelector = provider => policyName), + _ => throw new InvalidOperationException("Invalid mode.") + }; + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var policy = serviceProvider.GetRequiredService>().Value; + var name = policy.DefaultNameSelector(serviceProvider); + var provider = name == null ? + serviceProvider.GetService() : + serviceProvider.GetRequiredKeyedService(name); + + // Assert + Assert.True(featureBuilder.IsPolicyConfigured, "The policy should be configured."); + Assert.NotNull(provider); + Assert.IsType(provider); + } + + [Fact] + public void AddProvider_WithNullKey_ThrowsArgumentNullException() + { + // Arrange & Act + _systemUnderTest.AddProvider(null!, (sp, domain) => new NoOpFeatureProvider()); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + var ex = Assert.Throws(() => serviceProvider.GetKeyedService(null)); + + Assert.Equal("key", ex.ParamName); + } + + [Fact] + public void AddHook_AddsHookAsKeyedService() + { + // Arrange + _systemUnderTest.AddHook(); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var hook = serviceProvider.GetKeyedService("NoOpHook"); + + // Assert + Assert.NotNull(hook); + } + + [Fact] + public void AddHook_AddsHookNameToOpenFeatureOptions() + { + // Arrange + _systemUnderTest.AddHook(sp => new NoOpHook()); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var options = serviceProvider.GetRequiredService>(); + + // Assert + Assert.Contains(options.Value.HookNames, t => t == "NoOpHook"); + } + + [Fact] + public void AddHook_WithSpecifiedNameToOpenFeatureOptions() + { + // Arrange + _systemUnderTest.AddHook("my-custom-name"); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var hook = serviceProvider.GetKeyedService("my-custom-name"); + + // Assert + Assert.NotNull(hook); + } + + [Fact] + public void AddHook_WithSpecifiedNameAndImplementationFactory_AsKeyedService() + { + // Arrange + _systemUnderTest.AddHook("my-custom-name", (serviceProvider) => new NoOpHook()); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var hook = serviceProvider.GetKeyedService("my-custom-name"); + + // Assert + Assert.NotNull(hook); + } + + [Fact] + public void AddHook_WithInstance_AddsHookAsKeyedService() + { + // Arrange + var expectedHook = new NoOpHook(); + _systemUnderTest.AddHook(expectedHook); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var actualHook = serviceProvider.GetKeyedService("NoOpHook"); + + // Assert + Assert.NotNull(actualHook); + Assert.Equal(expectedHook, actualHook); + } + + [Fact] + public void AddHook_WithSpecifiedNameAndInstance_AddsHookAsKeyedService() + { + // Arrange + var expectedHook = new NoOpHook(); + _systemUnderTest.AddHook("custom-hook", expectedHook); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var actualHook = serviceProvider.GetKeyedService("custom-hook"); + + // Assert + Assert.NotNull(actualHook); + Assert.Equal(expectedHook, actualHook); + } + + [Fact] + public void AddHandler_AddsEventHandlerDelegateWrapperAsKeyedService() + { + // Arrange + EventHandlerDelegate eventHandler = (eventDetails) => { }; + _systemUnderTest.AddHandler(Constant.ProviderEventTypes.ProviderReady, eventHandler); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var handler = serviceProvider.GetService(); + + // Assert + Assert.NotNull(handler); + Assert.Equal(eventHandler, handler.EventHandlerDelegate); + } + + [Fact] + public void AddHandlerTwice_MultipleEventHandlerDelegateWrappersAsKeyedServices() + { + // Arrange + EventHandlerDelegate eventHandler1 = (eventDetails) => { }; + EventHandlerDelegate eventHandler2 = (eventDetails) => { }; + _systemUnderTest.AddHandler(Constant.ProviderEventTypes.ProviderReady, eventHandler1); + _systemUnderTest.AddHandler(Constant.ProviderEventTypes.ProviderReady, eventHandler2); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var handler = serviceProvider.GetServices(); + + // Assert + Assert.NotEmpty(handler); + Assert.Equal(eventHandler1, handler.ElementAt(0).EventHandlerDelegate); + Assert.Equal(eventHandler2, handler.ElementAt(1).EventHandlerDelegate); + } + + [Fact] + public void AddHandler_WithImplementationFactory_AddsEventHandlerDelegateWrapperAsKeyedService() + { + // Arrange + EventHandlerDelegate eventHandler = (eventDetails) => { }; + _systemUnderTest.AddHandler(Constant.ProviderEventTypes.ProviderReady, _ => eventHandler); + + var serviceProvider = _services.BuildServiceProvider(); + + // Act + var handler = serviceProvider.GetService(); + + // Assert + Assert.NotNull(handler); + Assert.Equal(eventHandler, handler.EventHandlerDelegate); + } + + [Fact] + public void AddClient_AddsFeatureClient() + { + // Arrange + _services.AddSingleton(sp => Api.Instance); + + // Act + _systemUnderTest.AddClient(); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + var client = serviceProvider.GetService(); + + Assert.NotNull(client); + } + + [Fact] + public void AddClient_WithContext_AddsFeatureClient() + { + // Arrange + _services.AddSingleton(sp => Api.Instance); + + _systemUnderTest + .AddContext((a) => a.Set("region", "euw")) + .AddProvider(_systemUnderTest => new NoOpFeatureProvider()); + + // Act + _systemUnderTest.AddClient(); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + var client = serviceProvider.GetService(); + + Assert.NotNull(client); + + var context = client.GetContext(); + var region = context.GetValue("region"); + Assert.Equal("euw", region.AsString); + } + + [Theory] + [InlineData("")] + [InlineData(" ")] + public void AddClient_WithInvalidName_AddsFeatureClient(string? name) + { + // Arrange + _services.AddSingleton(sp => Api.Instance); + + // Act + _systemUnderTest.AddClient(name); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + var client = serviceProvider.GetService(); + Assert.NotNull(client); + + var keyedClients = serviceProvider.GetKeyedServices(name); + Assert.Empty(keyedClients); + } + + [Fact] + public void AddClient_WithNullName_AddsFeatureClient() + { + // Arrange + _services.AddSingleton(sp => Api.Instance); + + // Act + _systemUnderTest.AddClient(null); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + var client = serviceProvider.GetService(); + Assert.NotNull(client); + } + + [Fact] + public void AddClient_WithName_AddsFeatureClient() + { + // Arrange + _services.AddSingleton(sp => Api.Instance); + + // Act + _systemUnderTest.AddClient("client-name"); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + var client = serviceProvider.GetKeyedService("client-name"); + + Assert.NotNull(client); + } + + [Fact] + public void AddClient_WithNameAndContext_AddsFeatureClient() + { + // Arrange + _services.AddSingleton(sp => Api.Instance); + + _systemUnderTest + .AddContext((a) => a.Set("region", "euw")) + .AddProvider(_systemUnderTest => new NoOpFeatureProvider()); + + // Act + _systemUnderTest.AddClient("client-name"); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + var client = serviceProvider.GetKeyedService("client-name"); + + Assert.NotNull(client); + + var context = client.GetContext(); + var region = context.GetValue("region"); + Assert.Equal("euw", region.AsString); + } + + [Fact] + public void AddPolicyBasedClient_AddsScopedFeatureClient() + { + // Arrange + _services.AddSingleton(sp => Api.Instance); + + _services.AddOptions() + .Configure(options => options.DefaultNameSelector = _ => "default-name"); + + _systemUnderTest.AddProvider("default-name", (_, key) => new NoOpFeatureProvider()); + + // Act + _systemUnderTest.AddPolicyBasedClient(); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + using var scope = serviceProvider.CreateScope(); + var client = scope.ServiceProvider.GetService(); + Assert.NotNull(client); + } + + [Fact(Skip = "Bug due to https://github.com/open-feature/dotnet-sdk/issues/543")] + public void AddPolicyBasedClient_WithNoDefaultName_AddsScopedFeatureClient() + { + // Arrange + _services.AddSingleton(sp => Api.Instance); + + _services.AddOptions() + .Configure(options => options.DefaultNameSelector = sp => null); + + _systemUnderTest.AddProvider("default", (_, key) => new NoOpFeatureProvider()); + + // Act + _systemUnderTest.AddPolicyBasedClient(); + + // Assert + using var serviceProvider = _services.BuildServiceProvider(); + using var scope = serviceProvider.CreateScope(); + var client = scope.ServiceProvider.GetService(); + Assert.NotNull(client); + } +} diff --git a/test/OpenFeature.Hosting.Tests/OpenFeatureBuilderTests.cs b/test/OpenFeature.Hosting.Tests/OpenFeatureBuilderTests.cs new file mode 100644 index 000000000..6c4ea9937 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/OpenFeatureBuilderTests.cs @@ -0,0 +1,93 @@ +using Microsoft.Extensions.DependencyInjection; + +namespace OpenFeature.Hosting.Tests; + +public class OpenFeatureBuilderTests +{ + [Fact] + public void Validate_DoesNotThrowException() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services); + + // Act + var ex = Record.Exception(builder.Validate); + + // Assert + Assert.Null(ex); + } + + [Fact] + public void Validate_WithPolicySet_DoesNotThrowException() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services) + { + IsPolicyConfigured = true + }; + + // Act + var ex = Record.Exception(builder.Validate); + + // Assert + Assert.Null(ex); + } + + [Fact] + public void Validate_WithMultipleDomainProvidersRegistered_ThrowInvalidOperationException() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services) + { + IsPolicyConfigured = false, + DomainBoundProviderRegistrationCount = 2 + }; + + // Act + var ex = Assert.Throws(builder.Validate); + + // Assert + Assert.Equal("Multiple providers have been registered, but no policy has been configured.", ex.Message); + } + + [Fact] + public void Validate_WithDefaultAndDomainProvidersRegistered_ThrowInvalidOperationException() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services) + { + IsPolicyConfigured = false, + DomainBoundProviderRegistrationCount = 1, + HasDefaultProvider = true + }; + + // Act + var ex = Assert.Throws(builder.Validate); + + // Assert + Assert.Equal("A default provider and an additional provider have been registered without a policy configuration.", ex.Message); + } + + [Fact] + public void Validate_WithNoDefaultProviderRegistered_DoesNotThrow() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services) + { + IsPolicyConfigured = false, + DomainBoundProviderRegistrationCount = 1, + HasDefaultProvider = false + }; + + // Act + var ex = Record.Exception(builder.Validate); + + // Assert + Assert.Null(ex); + } +} diff --git a/test/OpenFeature.Hosting.Tests/OpenFeatureOptionsTests.cs b/test/OpenFeature.Hosting.Tests/OpenFeatureOptionsTests.cs new file mode 100644 index 000000000..d39d4059f --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/OpenFeatureOptionsTests.cs @@ -0,0 +1,73 @@ +namespace OpenFeature.Hosting.Tests; + +public class OpenFeatureOptionsTests +{ + [Fact] + public void AddProviderName_DoesNotSetHasDefaultProvider() + { + // Arrange + var options = new OpenFeatureOptions(); + + // Act + options.AddProviderName("TestProvider"); + + // Assert + Assert.False(options.HasDefaultProvider); + } + + [Fact] + public void AddProviderName_WithNullName_SetsHasDefaultProvider() + { + // Arrange + var options = new OpenFeatureOptions(); + + // Act + options.AddProviderName(null); + + // Assert + Assert.True(options.HasDefaultProvider); + } + + [Theory] + [InlineData("")] + [InlineData(" ")] + public void AddProviderName_WithEmptyName_SetsHasDefaultProvider(string name) + { + // Arrange + var options = new OpenFeatureOptions(); + + // Act + options.AddProviderName(name); + + // Assert + Assert.True(options.HasDefaultProvider); + } + + [Fact] + public void AddProviderName_WithSameName_OnlyRegistersNameOnce() + { + // Arrange + var options = new OpenFeatureOptions(); + + // Act + options.AddProviderName("test-provider"); + options.AddProviderName("test-provider"); + options.AddProviderName("test-provider"); + + // Assert + Assert.Single(options.ProviderNames); + } + + [Fact] + public void AddHookName_RegistersHookName() + { + // Arrange + var options = new OpenFeatureOptions(); + + // Act + options.AddHookName("test-hook"); + + // Assert + Assert.Single(options.HookNames); + } +} diff --git a/test/OpenFeature.Hosting.Tests/OpenFeatureServiceCollectionExtensionsTests.cs b/test/OpenFeature.Hosting.Tests/OpenFeatureServiceCollectionExtensionsTests.cs new file mode 100644 index 000000000..dc3cc9345 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/OpenFeatureServiceCollectionExtensionsTests.cs @@ -0,0 +1,95 @@ +using Microsoft.Extensions.DependencyInjection; +using NSubstitute; + +namespace OpenFeature.Hosting.Tests; + +public class OpenFeatureServiceCollectionExtensionsTests +{ + private readonly IServiceCollection _systemUnderTest; + private readonly Action _configureAction; + + public OpenFeatureServiceCollectionExtensionsTests() + { + _systemUnderTest = new ServiceCollection(); + _configureAction = Substitute.For>(); + } + + [Fact] + public void AddOpenFeature_ShouldRegisterApiInstanceAndLifecycleManagerAsSingleton() + { + // Act + _systemUnderTest.AddOpenFeature(_configureAction); + + Assert.Single(_systemUnderTest, s => s.ServiceType == typeof(Api) && s.Lifetime == ServiceLifetime.Singleton); + Assert.Single(_systemUnderTest, s => s.ServiceType == typeof(IFeatureLifecycleManager) && s.Lifetime == ServiceLifetime.Singleton); + Assert.Single(_systemUnderTest, s => s.ServiceType == typeof(IFeatureClient) && s.Lifetime == ServiceLifetime.Scoped); + } + + [Fact] + public void AddOpenFeature_ShouldInvokeConfigureAction() + { + // Act + _systemUnderTest.AddOpenFeature(_configureAction); + + // Assert + _configureAction.Received(1).Invoke(Arg.Any()); + } + + [Fact] + public void AddOpenFeature_WithDefaultProvider() + { + // Act + _systemUnderTest.AddOpenFeature(builder => + { + builder.AddProvider(_ => new NoOpFeatureProvider()); + }); + + // Assert + using var serviceProvider = _systemUnderTest.BuildServiceProvider(); + var featureClient = serviceProvider.GetRequiredService(); + Assert.NotNull(featureClient); + } + + [Fact] + public void AddOpenFeature_WithNamedDefaultProvider() + { + // Act + _systemUnderTest.AddOpenFeature(builder => + { + builder.AddProvider("no-opprovider", (_, key) => new NoOpFeatureProvider()); + }); + + // Assert + using var serviceProvider = _systemUnderTest.BuildServiceProvider(); + var featureClient = serviceProvider.GetRequiredService(); + Assert.NotNull(featureClient); + } + + [Fact] + public void AddOpenFeature_WithNamedDefaultProvider_InvokesAddPolicyName() + { + // Arrange + var provider1 = new NoOpFeatureProvider(); + var provider2 = new NoOpFeatureProvider(); + + // Act + _systemUnderTest.AddOpenFeature(builder => + { + builder + .AddPolicyName(ss => + { + ss.DefaultNameSelector = (sp) => "no-opprovider"; + }) + .AddProvider("no-opprovider", (_, key) => provider1) + .AddProvider("no-opprovider-2", (_, key) => provider2); + }); + + // Assert + using var serviceProvider = _systemUnderTest.BuildServiceProvider(); + var client = serviceProvider.GetKeyedService("no-opprovider"); + Assert.NotNull(client); + + var otherClient = serviceProvider.GetService(); + Assert.NotNull(otherClient); + } +} diff --git a/test/OpenFeature.Hosting.Tests/Providers/Memory/FeatureBuilderExtensionsTests.cs b/test/OpenFeature.Hosting.Tests/Providers/Memory/FeatureBuilderExtensionsTests.cs new file mode 100644 index 000000000..b36dc82d6 --- /dev/null +++ b/test/OpenFeature.Hosting.Tests/Providers/Memory/FeatureBuilderExtensionsTests.cs @@ -0,0 +1,257 @@ +using Microsoft.Extensions.DependencyInjection; +using OpenFeature.Hosting.Providers.Memory; +using OpenFeature.Model; +using OpenFeature.Providers.Memory; + +namespace OpenFeature.Hosting.Tests.Providers.Memory; + +public class FeatureBuilderExtensionsTests +{ + [Fact] + public void AddInMemoryProvider_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider(); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetService(); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + } + + [Fact] + public async Task AddInMemoryProvider_WithFlags_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services); + Func enableForAlphaGroup = ctx => ctx.GetValue("group").AsString == "alpha" ? "on" : "off"; + var flags = new Dictionary + { + { "feature1", new Flag(new Dictionary { { "on", true }, { "off", false } }, "on") }, + { "feature2", new Flag(new Dictionary { { "on", true }, { "off", false } }, "on", enableForAlphaGroup) } + }; + + // Act + builder.AddInMemoryProvider((sp) => flags); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetService(); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + + var result = await featureProvider.ResolveBooleanValueAsync("feature1", false); + Assert.True(result.Value); + } + + [Fact] + public void AddInMemoryProvider_WithNullFlagsFactory_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider((sp) => null); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetService(); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + } + + [Fact] + public void AddInMemoryProvider_WithNullConfigure_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider((Action>?)null); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetService(); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + } + + [Fact] + public void AddInMemoryProvider_WithDomain_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider("domain"); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetKeyedService("domain"); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + } + + [Fact] + public async Task AddInMemoryProvider_WithDomainAndFlags_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services); + Func enableForAlphaGroup = ctx => ctx.GetValue("group").AsString == "alpha" ? "on" : "off"; + var flags = new Dictionary + { + { "feature1", new Flag(new Dictionary { { "on", true }, { "off", false } }, "on") }, + { "feature2", new Flag(new Dictionary { { "on", true }, { "off", false } }, "off", enableForAlphaGroup) } + }; + + // Act + builder.AddInMemoryProvider("domain", (sp) => flags); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetKeyedService("domain"); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + + var context = EvaluationContext.Builder().Set("group", "alpha").Build(); + var result = await featureProvider.ResolveBooleanValueAsync("feature2", false, context); + Assert.True(result.Value); + } + + [Fact] + public void AddInMemoryProvider_WithDomainAndNullFlagsFactory_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider("domain", (sp) => null); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetKeyedService("domain"); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + } + + [Fact] + public async Task AddInMemoryProvider_WithOptions_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + services.AddOptions() + .Configure((opts) => + { + opts.Flags = new Dictionary + { + { "new-feature", new Flag(new Dictionary { { "on", true }, { "off", false } }, "off") }, + }; + }); + + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider(); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetService(); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + + var result = await featureProvider.ResolveBooleanValueAsync("new-feature", true); + Assert.False(result.Value); + } + + [Fact] + public async Task AddInMemoryProvider_WithDomainAndOptions_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + services.AddOptions("domain-name") + .Configure((opts) => + { + opts.Flags = new Dictionary + { + { "new-feature", new Flag(new Dictionary { { "on", true }, { "off", false } }, "off") }, + }; + }); + + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider("domain-name"); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetKeyedService("domain-name"); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + + var result = await featureProvider.ResolveBooleanValueAsync("new-feature", true); + Assert.False(result.Value); + } + + [Fact] + public void AddInMemoryProvider_WithDomainAndNullOptions_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + services.AddOptions("domain-name") + .Configure((opts) => + { + opts.Flags = null; + }); + + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider("domain-name"); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetKeyedService("domain-name"); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + } + + [Fact] + public void AddInMemoryProvider_WithDomainAndNullConfigure_AddsProvider() + { + // Arrange + var services = new ServiceCollection(); + + var builder = new OpenFeatureBuilder(services); + + // Act + builder.AddInMemoryProvider("domain-name", (Action>?)null); + + // Assert + using var provider = services.BuildServiceProvider(); + + var featureProvider = provider.GetKeyedService("domain-name"); + Assert.NotNull(featureProvider); + Assert.IsType(featureProvider); + } +} diff --git a/test/OpenFeature.IntegrationTests/FeatureFlagIntegrationTest.cs b/test/OpenFeature.IntegrationTests/FeatureFlagIntegrationTest.cs index ff717f9f1..9638ff8c1 100644 --- a/test/OpenFeature.IntegrationTests/FeatureFlagIntegrationTest.cs +++ b/test/OpenFeature.IntegrationTests/FeatureFlagIntegrationTest.cs @@ -8,9 +8,9 @@ using Microsoft.Extensions.Logging; using Microsoft.Extensions.Logging.Testing; using OpenFeature.Constant; -using OpenFeature.DependencyInjection; -using OpenFeature.DependencyInjection.Providers.Memory; using OpenFeature.Hooks; +using OpenFeature.Hosting; +using OpenFeature.Hosting.Providers.Memory; using OpenFeature.IntegrationTests.Services; using OpenFeature.Providers.Memory; @@ -211,7 +211,6 @@ private static async Task CreateServerAsync(ServiceLifetime serviceL builder.Services.AddHttpContextAccessor(); builder.Services.AddOpenFeature(cfg => { - cfg.AddHostedFeatureLifecycle(); cfg.AddContext((builder, provider) => { // Retrieve the HttpContext from IHttpContextAccessor, ensuring it's not null. diff --git a/test/OpenFeature.IntegrationTests/OpenFeature.IntegrationTests.csproj b/test/OpenFeature.IntegrationTests/OpenFeature.IntegrationTests.csproj index aabe1a599..46f99e213 100644 --- a/test/OpenFeature.IntegrationTests/OpenFeature.IntegrationTests.csproj +++ b/test/OpenFeature.IntegrationTests/OpenFeature.IntegrationTests.csproj @@ -5,7 +5,14 @@ - + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + @@ -18,7 +25,6 @@ - diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Models/ChildProviderEntryTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Models/ChildProviderEntryTests.cs new file mode 100644 index 000000000..7b420f928 --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Models/ChildProviderEntryTests.cs @@ -0,0 +1,86 @@ +using NSubstitute; +using OpenFeature.Providers.MultiProvider.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Models; + +public class ChildProviderEntryTests +{ + private readonly FeatureProvider _mockProvider = Substitute.For(); + + [Fact] + public void Constructor_WithProvider_CreatesProviderEntry() + { + // Act + var providerEntry = new ProviderEntry(this._mockProvider); + + // Assert + Assert.Equal(this._mockProvider, providerEntry.Provider); + Assert.Null(providerEntry.Name); + } + + [Fact] + public void Constructor_WithProviderAndName_CreatesProviderEntry() + { + // Arrange + const string customName = "custom-provider-name"; + + // Act + var providerEntry = new ProviderEntry(this._mockProvider, customName); + + // Assert + Assert.Equal(this._mockProvider, providerEntry.Provider); + Assert.Equal(customName, providerEntry.Name); + } + + [Fact] + public void Constructor_WithNullProvider_ThrowsArgumentNullException() + { + // Act & Assert + var exception = Assert.Throws(() => new ProviderEntry(null!)); + Assert.Equal("provider", exception.ParamName); + } + + [Fact] + public void Constructor_WithNullName_CreatesProviderEntryWithNullName() + { + // Act + var providerEntry = new ProviderEntry(this._mockProvider); + + // Assert + Assert.Equal(this._mockProvider, providerEntry.Provider); + Assert.Null(providerEntry.Name); + } + + [Fact] + public void Constructor_WithEmptyName_CreatesProviderEntryWithEmptyName() + { + // Act + var providerEntry = new ProviderEntry(this._mockProvider, string.Empty); + + // Assert + Assert.Equal(this._mockProvider, providerEntry.Provider); + Assert.Equal(string.Empty, providerEntry.Name); + } + + [Fact] + public void Provider_Property_IsReadOnly() + { + // Act & Assert + // Verify that Provider property is read-only by checking it has no setter + var providerProperty = typeof(ProviderEntry).GetProperty(nameof(ProviderEntry.Provider)); + Assert.NotNull(providerProperty); + Assert.True(providerProperty.CanRead); + Assert.False(providerProperty.CanWrite); + } + + [Fact] + public void Name_Property_IsReadOnly() + { + // Act & Assert + // Verify that Name property is read-only by checking it has no setter + var nameProperty = typeof(ProviderEntry).GetProperty(nameof(ProviderEntry.Name)); + Assert.NotNull(nameProperty); + Assert.True(nameProperty.CanRead); + Assert.False(nameProperty.CanWrite); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Models/ProviderStatusTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Models/ProviderStatusTests.cs new file mode 100644 index 000000000..6deac2ea8 --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Models/ProviderStatusTests.cs @@ -0,0 +1,123 @@ +using OpenFeature.Providers.MultiProvider.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Models; + +public class ProviderStatusTests +{ + [Fact] + public void Constructor_CreatesProviderStatusWithDefaultValues() + { + // Act + var providerStatus = new ChildProviderStatus(); + + // Assert + Assert.Equal(string.Empty, providerStatus.ProviderName); + Assert.Null(providerStatus.Error); + } + + [Fact] + public void ProviderName_CanBeSet() + { + // Arrange + const string providerName = "test-provider"; + var providerStatus = new ChildProviderStatus(); + + // Act + providerStatus.ProviderName = providerName; + + // Assert + Assert.Equal(providerName, providerStatus.ProviderName); + } + + [Fact] + public void ProviderName_CanBeSetToNull() + { + // Arrange + var providerStatus = new ChildProviderStatus { ProviderName = "initial-name" }; + + // Act + providerStatus.ProviderName = null!; + + // Assert + Assert.Null(providerStatus.ProviderName); + } + + [Fact] + public void ProviderName_CanBeSetToEmptyString() + { + // Arrange + var providerStatus = new ChildProviderStatus { ProviderName = "initial-name" }; + + // Act + providerStatus.ProviderName = string.Empty; + + // Assert + Assert.Equal(string.Empty, providerStatus.ProviderName); + } + + [Fact] + public void Exception_CanBeSet() + { + // Arrange + var exception = new InvalidOperationException("Test exception"); + var providerStatus = new ChildProviderStatus(); + + // Act + providerStatus.Error = exception; + + // Assert + Assert.Equal(exception, providerStatus.Error); + } + + [Fact] + public void Exception_CanBeSetToNull() + { + // Arrange + var providerStatus = new ChildProviderStatus { Error = new Exception("initial exception") }; + + // Act + providerStatus.Error = null; + + // Assert + Assert.Null(providerStatus.Error); + } + + [Fact] + public void ProviderStatus_CanBeInitializedWithObjectInitializer() + { + // Arrange + const string providerName = "test-provider"; + var exception = new ArgumentException("Test exception"); + + // Act + var providerStatus = new ChildProviderStatus + { + ProviderName = providerName, + Error = exception + }; + + // Assert + Assert.Equal(providerName, providerStatus.ProviderName); + Assert.Equal(exception, providerStatus.Error); + } + + [Fact] + public void ProviderName_Property_HasGetterAndSetter() + { + // Act & Assert + var providerNameProperty = typeof(ChildProviderStatus).GetProperty(nameof(ChildProviderStatus.ProviderName)); + Assert.NotNull(providerNameProperty); + Assert.True(providerNameProperty.CanRead); + Assert.True(providerNameProperty.CanWrite); + } + + [Fact] + public void Exception_Property_HasGetterAndSetter() + { + // Act & Assert + var exceptionProperty = typeof(ChildProviderStatus).GetProperty(nameof(ChildProviderStatus.Error)); + Assert.NotNull(exceptionProperty); + Assert.True(exceptionProperty.CanRead); + Assert.True(exceptionProperty.CanWrite); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Models/RegisteredProviderTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Models/RegisteredProviderTests.cs new file mode 100644 index 000000000..9c24475ae --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Models/RegisteredProviderTests.cs @@ -0,0 +1,117 @@ +using NSubstitute; +using OpenFeature.Providers.Memory; +using OpenFeature.Providers.MultiProvider.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Models; + +public class RegisteredProviderTests +{ + private readonly FeatureProvider _mockProvider = Substitute.For(); + private const string TestProviderName = "test-provider"; + + [Fact] + public void Constructor_WithValidParameters_CreatesRegisteredProvider() + { + // Act + var registeredProvider = new RegisteredProvider(this._mockProvider, TestProviderName); + + // Assert + Assert.Equal(this._mockProvider, registeredProvider.Provider); + Assert.Equal(TestProviderName, registeredProvider.Name); + } + + [Fact] + public void Constructor_WithNullProvider_ThrowsArgumentNullException() + { + // Act & Assert + var exception = Assert.Throws(() => new RegisteredProvider(null!, TestProviderName)); + Assert.Equal("provider", exception.ParamName); + } + + [Fact] + public void Constructor_WithNullName_ThrowsArgumentNullException() + { + // Act & Assert + var exception = Assert.Throws(() => new RegisteredProvider(this._mockProvider, null!)); + Assert.Equal("name", exception.ParamName); + } + + [Fact] + public void Constructor_WithEmptyName_CreatesRegisteredProviderWithEmptyName() + { + // Act + var registeredProvider = new RegisteredProvider(this._mockProvider, string.Empty); + + // Assert + Assert.Equal(this._mockProvider, registeredProvider.Provider); + Assert.Equal(string.Empty, registeredProvider.Name); + } + + [Fact] + public void Constructor_WithWhitespaceName_CreatesRegisteredProviderWithWhitespaceName() + { + // Arrange + const string whitespaceName = " "; + + // Act + var registeredProvider = new RegisteredProvider(this._mockProvider, whitespaceName); + + // Assert + Assert.Equal(this._mockProvider, registeredProvider.Provider); + Assert.Equal(whitespaceName, registeredProvider.Name); + } + + [Fact] + public void Constructor_WithSameProviderAndDifferentNames_CreatesDistinctInstances() + { + // Arrange + const string name1 = "provider-1"; + const string name2 = "provider-2"; + + // Act + var registeredProvider1 = new RegisteredProvider(this._mockProvider, name1); + var registeredProvider2 = new RegisteredProvider(this._mockProvider, name2); + + // Assert + Assert.Equal(this._mockProvider, registeredProvider1.Provider); + Assert.Equal(this._mockProvider, registeredProvider2.Provider); + Assert.Equal(name1, registeredProvider1.Name); + Assert.Equal(name2, registeredProvider2.Name); + Assert.NotEqual(registeredProvider1.Name, registeredProvider2.Name); + } + + [Fact] + public void Constructor_WithDifferentProvidersAndSameName_CreatesDistinctInstances() + { + // Arrange + var mockProvider2 = Substitute.For(); + + // Act + var registeredProvider1 = new RegisteredProvider(this._mockProvider, TestProviderName); + var registeredProvider2 = new RegisteredProvider(mockProvider2, TestProviderName); + + // Assert + Assert.Equal(this._mockProvider, registeredProvider1.Provider); + Assert.Equal(mockProvider2, registeredProvider2.Provider); + Assert.Equal(TestProviderName, registeredProvider1.Name); + Assert.Equal(TestProviderName, registeredProvider2.Name); + Assert.NotEqual(registeredProvider1.Provider, registeredProvider2.Provider); + } + + [Theory] + [InlineData(Constant.ProviderStatus.Ready)] + [InlineData(Constant.ProviderStatus.Error)] + [InlineData(Constant.ProviderStatus.Fatal)] + [InlineData(Constant.ProviderStatus.NotReady)] + public void SetStatus_WithDifferentStatuses_UpdatesCorrectly(Constant.ProviderStatus status) + { + // Arrange + var registeredProvider = new RegisteredProvider(new InMemoryProvider(), "test"); + + // Act + registeredProvider.SetStatus(status); + + // Assert + Assert.Equal(status, registeredProvider.Status); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/MultiProviderEventTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/MultiProviderEventTests.cs new file mode 100644 index 000000000..d41e91cfa --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/MultiProviderEventTests.cs @@ -0,0 +1,358 @@ +using System.Threading.Channels; +using NSubstitute; +using NSubstitute.ExceptionExtensions; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Models; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenFeature.Providers.MultiProvider.Strategies.Models; +using OpenFeature.Providers.MultiProvider.Tests.Utils; + +namespace OpenFeature.Providers.MultiProvider.Tests; + +/// +/// Tests for the event emission functionality of the MultiProvider. +/// +public class MultiProviderEventTests +{ + private const string TestFlagKey = "test-flag"; + private const string Provider1Name = "provider1"; + private const string Provider2Name = "provider2"; + + private readonly FeatureProvider _provider1 = new TestProvider(Provider1Name); + private readonly FeatureProvider _provider2 = new TestProvider(Provider2Name); + private readonly BaseEvaluationStrategy _strategy = Substitute.For(); + private readonly EvaluationContext _context = new EvaluationContextBuilder().Build(); + + public MultiProviderEventTests() + { + _strategy.RunMode.Returns(RunMode.Sequential); + _strategy.ShouldEvaluateThisProvider(Arg.Any>(), Arg.Any()).Returns(true); + _strategy.ShouldEvaluateNextProvider(Arg.Any>(), Arg.Any(), Arg.Any>()).Returns(false); + } + + [Fact] + public async Task InitializeAsync_OnSuccess_EmitsProviderReadyEvent() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1, _provider2); + + // Act + await multiProvider.InitializeAsync(_context); + + // Assert + var events = await ReadEvents(multiProvider.GetEventChannel()); + Assert.Single(events); + AssertEvent(events[0], "MultiProvider", ProviderEventTypes.ProviderReady, "MultiProvider successfully initialized"); + } + + [Fact] + public async Task InitializeAsync_OnProviderFailure_EmitsProviderErrorEvent() + { + // Arrange + var failedProvider = new TestProvider("failed", new InvalidOperationException("Init failed")); + var multiProvider = CreateMultiProvider(failedProvider, _provider2); + + // Act & Assert + await Assert.ThrowsAsync(() => multiProvider.InitializeAsync(_context)); + + // Verify the error event was emitted + var events = await ReadEvents(multiProvider.GetEventChannel()); + Assert.Single(events); + AssertEvent(events[0], "MultiProvider", ProviderEventTypes.ProviderError, errorType: ErrorType.ProviderFatal); + } + + [Fact] + public async Task EvaluateAsync_OnUnsupportedRunMode_EmitsProviderErrorEvent() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + _strategy.RunMode.Returns((RunMode)999); // Invalid run mode + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, false, _context); + + // Assert + Assert.Equal(ErrorType.ProviderFatal, result.ErrorType); + Assert.Equal(Reason.Error, result.Reason); + + // Verify the error event was emitted + var events = await ReadEvents(multiProvider.GetEventChannel()); + Assert.Single(events); + AssertEvent(events[0], "MultiProvider", ProviderEventTypes.ProviderError, errorType: ErrorType.ProviderFatal); + } + + [Fact] + public async Task EvaluateAsync_OnGeneralException_EmitsProviderErrorEvent() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + + _strategy.DetermineFinalResult(Arg.Any>(), Arg.Any(), Arg.Any(), Arg.Any(), Arg.Any>>()) + .Throws(new InvalidOperationException("Evaluation failed")); + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, false, _context); + + // Assert + Assert.Equal(ErrorType.General, result.ErrorType); + Assert.Equal(Reason.Error, result.Reason); + + // Verify the error event was emitted + var events = await ReadEvents(multiProvider.GetEventChannel()); + Assert.Single(events); + AssertEvent(events[0], "MultiProvider", ProviderEventTypes.ProviderError, errorType: ErrorType.General); + } + + [Fact] + public async Task HandleProviderEvent_OnConfigurationChanged_ReEmitsEventWithCorrectProviderName() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + var configEvent = new ProviderEventPayload + { + ProviderName = Provider1Name, + Type = ProviderEventTypes.ProviderConfigurationChanged, + Message = "Config changed", + FlagsChanged = [TestFlagKey] + }; + + // Act - Simulate child provider emitting configuration changed event + await EmitEventToProvider(_provider1, configEvent); + await Task.Delay(50); + + // Assert + var events = await ReadEvents(multiProvider.GetEventChannel()); + Assert.Single(events); + AssertEvent(events[0], $"MultiProvider/{Provider1Name}", ProviderEventTypes.ProviderConfigurationChanged, "Config changed"); + Assert.Contains(TestFlagKey, events[0].FlagsChanged!); + } + + [Fact] + public async Task HandleProviderEvent_OnProviderReady_EmitsMultiProviderReadyWhenAllReady() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1, _provider2); + multiProvider.SetStatus(ProviderStatus.NotReady); + + // Act - Simulate both child providers becoming ready + await EmitEventToProvider(_provider1, CreateEvent(ProviderEventTypes.ProviderReady)); + await EmitEventToProvider(_provider2, CreateEvent(ProviderEventTypes.ProviderReady)); + await Task.Delay(50); + + // Assert - Should emit MultiProvider ready event when all providers are ready + var events = await ReadEvents(multiProvider.GetEventChannel(), expectedCount: 2); + var readyEvent = events.FirstOrDefault(e => e.Type == ProviderEventTypes.ProviderReady); + Assert.NotNull(readyEvent); + AssertEvent(readyEvent, "MultiProvider", ProviderEventTypes.ProviderReady); + } + + [Fact] + public async Task HandleProviderEvent_OnProviderError_EmitsMultiProviderErrorEvent() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + multiProvider.SetStatus(ProviderStatus.Ready); + + // Act - Simulate child provider emitting error event + await EmitEventToProvider(_provider1, CreateEvent(ProviderEventTypes.ProviderError, ErrorType.ProviderFatal)); + await Task.Delay(50); + + // Assert + var events = await ReadEvents(multiProvider.GetEventChannel()); + Assert.Single(events); + AssertEvent(events[0], "MultiProvider", ProviderEventTypes.ProviderError, errorType: ErrorType.ProviderFatal); + } + + [Fact] + public async Task HandleProviderEvent_OnProviderStale_EmitsMultiProviderStaleEvent() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + multiProvider.SetStatus(ProviderStatus.Ready); + + // Act - Simulate child provider emitting stale event + await EmitEventToProvider(_provider1, CreateEvent(ProviderEventTypes.ProviderStale)); + await Task.Delay(50); + + // Assert + var events = await ReadEvents(multiProvider.GetEventChannel()); + Assert.Single(events); + AssertEvent(events[0], "MultiProvider", ProviderEventTypes.ProviderStale); + } + + [Fact] + public async Task HandleProviderEvent_OnSameStatus_DoesNotEmitEvent() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + multiProvider.SetStatus(ProviderStatus.Ready); + + // Act - Simulate child provider emitting ready event when MultiProvider is already ready + await EmitEventToProvider(_provider1, CreateEvent(ProviderEventTypes.ProviderReady)); + await Task.Delay(50); + + // Assert - Should not emit any events since status didn't change + var events = await ReadEvents(multiProvider.GetEventChannel(), expectedCount: 0, timeoutMs: 300); + Assert.Empty(events); + } + + [Fact] + public async Task MultipleProviders_WithStatusTransitions_EmitsCorrectAggregateEvents() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1, _provider2); + await multiProvider.InitializeAsync(_context); + await Task.Delay(50); + + // Act - Simulate one provider going to error state + await EmitEventToProvider(_provider1, CreateEvent(ProviderEventTypes.ProviderError, ErrorType.General)); + await Task.Delay(50); + // Simulate the error provider recovering + await EmitEventToProvider(_provider1, CreateEvent(ProviderEventTypes.ProviderReady)); + await Task.Delay(50); + + // Assert - Should see: Init Ready -> Error -> Ready + var events = await ReadEvents(multiProvider.GetEventChannel(), expectedCount: 3); + Assert.Contains(events, e => e.Type == ProviderEventTypes.ProviderReady); + Assert.Contains(events, e => e.Type == ProviderEventTypes.ProviderError); + } + + [Fact] + public async Task HandleProviderEvent_WithEventMetadata_PropagatesMetadata() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + var metadata = new Dictionary { { "source", "test" } }; + var eventPayload = new ProviderEventPayload + { + ProviderName = Provider1Name, + Type = ProviderEventTypes.ProviderConfigurationChanged, + EventMetadata = new ImmutableMetadata(metadata) + }; + + // Act + await EmitEventToProvider(_provider1, eventPayload); + await Task.Delay(50); + + // Assert + var events = await ReadEvents(multiProvider.GetEventChannel()); + Assert.Single(events); + Assert.NotNull(events[0].EventMetadata); + Assert.Equal("test", events[0].EventMetadata?.GetString("source")); + } + + [Fact] + public async Task ShutdownAsync_StopsEventProcessing() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + await multiProvider.InitializeAsync(_context); + + // Act + await multiProvider.ShutdownAsync(); + + // Try to emit an event after shutdown - it should not be processed + await EmitEventToProvider(_provider1, CreateEvent(ProviderEventTypes.ProviderReady)); + await Task.Delay(50); + + // Assert - Should not process any events after shutdown + var events = await ReadEvents(multiProvider.GetEventChannel(), expectedCount: 0, timeoutMs: 300); + Assert.Empty(events); + } + + [Fact] + public async Task ShutdownAsync_WithProviderFailures_ThrowsAggregateException() + { + // Arrange + var failingProvider = new TestProvider("failing", shutdownException: new InvalidOperationException("Shutdown failed")); + var multiProvider = CreateMultiProvider(failingProvider, _provider2); + await multiProvider.InitializeAsync(_context); + + // Act & Assert - Should throw AggregateException due to provider shutdown failure + var exception = await Assert.ThrowsAsync(() => multiProvider.ShutdownAsync()); + Assert.Contains("Failed to shutdown providers", exception.Message); + } + + [Fact] + public async Task DisposeAsync_CleansUpEventProcessing() + { + // Arrange + var multiProvider = CreateMultiProvider(_provider1); + await multiProvider.InitializeAsync(_context); + + // Act + await multiProvider.DisposeAsync(); + + // Assert - Should not throw and should handle disposal gracefully + await Task.Delay(100); // Give time for any potential processing + + // Verify that subsequent operations on disposed provider throw + await Assert.ThrowsAsync(() => + multiProvider.ResolveBooleanValueAsync(TestFlagKey, false)); + } + + // Helper methods + private MultiProvider CreateMultiProvider(params FeatureProvider[] providers) + { + var entries = providers.Select((p, i) => new ProviderEntry(p, $"provider{i + 1}")).ToList(); + return new MultiProvider(entries, _strategy); + } + + private static ProviderEventPayload CreateEvent(ProviderEventTypes type, ErrorType? errorType = null) + { + return new ProviderEventPayload + { + Type = type, + ErrorType = errorType, + Message = $"{type} event" + }; + } + + private static async Task EmitEventToProvider(FeatureProvider provider, ProviderEventPayload eventPayload) + { + var eventChannel = provider.GetEventChannel(); + var eventWrapper = new Event { EventPayload = eventPayload, Provider = provider }; + await eventChannel.Writer.WriteAsync(eventWrapper); + } + + private static async Task> ReadEvents(Channel channel, int expectedCount = 1, int timeoutMs = 1000) + { + var events = new List(); + var cts = new CancellationTokenSource(timeoutMs); + + try + { + while (events.Count < expectedCount && !cts.Token.IsCancellationRequested) + { + if (!await channel.Reader.WaitToReadAsync(cts.Token)) + break; + + while (channel.Reader.TryRead(out var item) && events.Count < expectedCount) + { + if (item is ProviderEventPayload payload) + events.Add(payload); + } + } + } + catch (OperationCanceledException) + { + // Timeout - return what we have + } + + return events; + } + + private static void AssertEvent(ProviderEventPayload eventPayload, string expectedProviderName, + ProviderEventTypes expectedType, string? expectedMessage = null, ErrorType? errorType = null) + { + Assert.Equal(expectedProviderName, eventPayload.ProviderName); + Assert.Equal(expectedType, eventPayload.Type); + + if (expectedMessage != null) + Assert.Contains(expectedMessage, eventPayload.Message); + + if (errorType.HasValue) + Assert.Equal(errorType.Value, eventPayload.ErrorType); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/MultiProviderTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/MultiProviderTests.cs new file mode 100644 index 000000000..615b67c7e --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/MultiProviderTests.cs @@ -0,0 +1,1095 @@ +using System.Collections.Immutable; +using System.Reflection; +using NSubstitute; +using NSubstitute.ExceptionExtensions; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Models; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests; + +public class MultiProviderClassTests +{ + private const string TestFlagKey = "test-flag"; + private const string TestVariant = "test-variant"; + private const string Provider1Name = "provider1"; + private const string Provider2Name = "provider2"; + private const string Provider3Name = "provider3"; + + private readonly FeatureProvider _mockProvider1 = Substitute.For(); + private readonly FeatureProvider _mockProvider2 = Substitute.For(); + private readonly FeatureProvider _mockProvider3 = Substitute.For(); + private readonly BaseEvaluationStrategy _mockStrategy = Substitute.For(); + private readonly EvaluationContext _evaluationContext = new EvaluationContextBuilder().Build(); + + public MultiProviderClassTests() + { + // Setup default metadata for providers + this._mockProvider1.GetMetadata().Returns(new Metadata(Provider1Name)); + this._mockProvider2.GetMetadata().Returns(new Metadata(Provider2Name)); + this._mockProvider3.GetMetadata().Returns(new Metadata(Provider3Name)); + + // Setup default strategy behavior + this._mockStrategy.RunMode.Returns(RunMode.Sequential); + this._mockStrategy.ShouldEvaluateThisProvider(Arg.Any>(), Arg.Any()).Returns(true); + this._mockStrategy.ShouldEvaluateNextProvider(Arg.Any>(), Arg.Any(), Arg.Any>()).Returns(false); + } + + [Fact] + public void Constructor_WithValidProviderEntries_CreatesMultiProvider() + { + // Arrange + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + + // Act + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Assert + Assert.NotNull(multiProvider); + var metadata = multiProvider.GetMetadata(); + Assert.Equal("MultiProvider", metadata.Name); + } + + [Fact] + public void Constructor_WithNullProviderEntries_ThrowsArgumentNullException() + { + // Act & Assert + var exception = Assert.Throws(() => new MultiProvider(null!, this._mockStrategy)); + Assert.Equal("providerEntries", exception.ParamName); + } + + [Fact] + public void Constructor_WithEmptyProviderEntries_ThrowsArgumentException() + { + // Act & Assert + var exception = Assert.Throws(() => new MultiProvider([], this._mockStrategy)); + Assert.Contains("At least one provider entry must be provided", exception.Message); + Assert.Equal("providerEntries", exception.ParamName); + } + + [Fact] + public void Constructor_WithNullStrategy_UsesDefaultFirstMatchStrategy() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + + // Act + var multiProvider = new MultiProvider(providerEntries); + + // Assert + Assert.NotNull(multiProvider); + var metadata = multiProvider.GetMetadata(); + Assert.Equal("MultiProvider", metadata.Name); + } + + [Fact] + public void Constructor_WithDuplicateExplicitNames_ThrowsArgumentException() + { + // Arrange + var providerEntries = new List + { + new(this._mockProvider1, "duplicate-name"), + new(this._mockProvider2, "duplicate-name") + }; + + // Act & Assert + var exception = Assert.Throws(() => new MultiProvider(providerEntries, this._mockStrategy)); + Assert.Contains("Multiple providers cannot have the same explicit name: 'duplicate-name'", exception.Message); + } + + [Fact] + public async Task ResolveBooleanValueAsync_CallsEvaluateAsync() + { + // Arrange + const bool defaultValue = false; + const bool resolvedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + + // Assert + Assert.Equal(expectedDetails, result); + this._mockStrategy.Received(1).DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()); + } + + [Fact] + public async Task ResolveStringValueAsync_CallsEvaluateAsync() + { + // Arrange + const string defaultValue = "default"; + const string resolvedValue = "resolved"; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + // Act + var result = await multiProvider.ResolveStringValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + + // Assert + Assert.Equal(expectedDetails, result); + } + + [Fact] + public async Task InitializeAsync_WithAllSuccessfulProviders_InitializesAllProviders() + { + // Arrange + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockProvider1.InitializeAsync(this._evaluationContext, Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider2.InitializeAsync(this._evaluationContext, Arg.Any()).Returns(Task.CompletedTask); + + // Act + await multiProvider.InitializeAsync(this._evaluationContext); + + // Assert + await this._mockProvider1.Received(1).InitializeAsync(this._evaluationContext, Arg.Any()); + await this._mockProvider2.Received(1).InitializeAsync(this._evaluationContext, Arg.Any()); + } + + [Fact] + public async Task InitializeAsync_WithSomeFailingProviders_ThrowsAggregateException() + { + // Arrange + var expectedException = new InvalidOperationException("Initialization failed"); + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockProvider1.InitializeAsync(this._evaluationContext, Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider2.InitializeAsync(this._evaluationContext, Arg.Any()).ThrowsAsync(expectedException); + + // Act & Assert + var exception = await Assert.ThrowsAsync(() => multiProvider.InitializeAsync(this._evaluationContext)); + Assert.Contains("Failed to initialize providers", exception.Message); + Assert.Contains(Provider2Name, exception.Message); + Assert.Contains(expectedException, exception.InnerExceptions); + } + + [Fact] + public async Task ShutdownAsync_WithAllSuccessfulProviders_ShutsDownAllProviders() + { + // Arrange + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + multiProvider.SetStatus(ProviderStatus.Ready); + + this._mockProvider1.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider2.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + + // Act + await multiProvider.ShutdownAsync(); + + // Assert + await this._mockProvider1.Received(1).ShutdownAsync(Arg.Any()); + await this._mockProvider2.Received(1).ShutdownAsync(Arg.Any()); + } + + [Fact] + public async Task ShutdownAsync_WithFatalProvider_ShutsDownAllProviders() + { + // Arrange + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + multiProvider.SetStatus(ProviderStatus.Fatal); + + this._mockProvider1.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider2.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + + // Act + await multiProvider.ShutdownAsync(); + + // Assert + await this._mockProvider1.Received(1).ShutdownAsync(Arg.Any()); + await this._mockProvider2.Received(1).ShutdownAsync(Arg.Any()); + } + + [Fact] + public async Task ShutdownAsync_WithSomeFailingProviders_ThrowsAggregateException() + { + // Arrange + var expectedException = new InvalidOperationException("Shutdown failed"); + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + multiProvider.SetStatus(ProviderStatus.Ready); + + this._mockProvider1.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider2.ShutdownAsync(Arg.Any()).ThrowsAsync(expectedException); + + // Act & Assert + var exception = await Assert.ThrowsAsync(() => multiProvider.ShutdownAsync()); + Assert.Contains("Failed to shutdown providers", exception.Message); + Assert.Contains(Provider2Name, exception.Message); + Assert.Contains(expectedException, exception.InnerExceptions); + } + + [Fact] + public void GetMetadata_ReturnsMultiProviderMetadata() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act + var metadata = multiProvider.GetMetadata(); + + // Assert + Assert.NotNull(metadata); + Assert.Equal("MultiProvider", metadata.Name); + } + + [Fact] + public async Task ResolveDoubleValueAsync_CallsEvaluateAsync() + { + // Arrange + const double defaultValue = 1.0; + const double resolvedValue = 2.5; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + // Act + var result = await multiProvider.ResolveDoubleValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + + // Assert + Assert.Equal(expectedDetails, result); + this._mockStrategy.Received(1).DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()); + } + + [Fact] + public async Task ResolveIntegerValueAsync_CallsEvaluateAsync() + { + // Arrange + const int defaultValue = 10; + const int resolvedValue = 42; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + // Act + var result = await multiProvider.ResolveIntegerValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + + // Assert + Assert.Equal(expectedDetails, result); + } + + [Fact] + public async Task ResolveStructureValueAsync_CallsEvaluateAsync() + { + // Arrange + var defaultValue = new Value("default"); + var resolvedValue = new Value("resolved"); + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + // Act + var result = await multiProvider.ResolveStructureValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + + // Assert + Assert.Equal(expectedDetails, result); + } + + [Fact] + public async Task EvaluateAsync_WithSequentialMode_EvaluatesProvidersSequentially() + { + // Arrange + const bool defaultValue = false; + const bool resolvedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.RunMode.Returns(RunMode.Sequential); + this._mockStrategy.ShouldEvaluateThisProvider(Arg.Any>(), this._evaluationContext).Returns(true); + this._mockStrategy.ShouldEvaluateNextProvider(Arg.Any>(), this._evaluationContext, Arg.Any>()).Returns(false); + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + this._mockProvider1.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()) + .Returns(expectedDetails); + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + + // Assert + Assert.Equal(expectedDetails, result); + await this._mockProvider1.Received(1).ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()); + await this._mockProvider2.DidNotReceive().ResolveBooleanValueAsync(Arg.Any(), Arg.Any(), Arg.Any(), Arg.Any()); + } + + [Fact] + public async Task EvaluateAsync_WithParallelMode_EvaluatesProvidersInParallel() + { + // Arrange + const bool defaultValue = false; + const bool resolvedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.RunMode.Returns(RunMode.Parallel); + this._mockStrategy.ShouldEvaluateThisProvider(Arg.Any>(), this._evaluationContext).Returns(true); + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + this._mockProvider1.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()) + .Returns(expectedDetails); + this._mockProvider2.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()) + .Returns(expectedDetails); + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + + // Assert + Assert.Equal(expectedDetails, result); + await this._mockProvider1.Received(1).ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()); + await this._mockProvider2.Received(1).ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()); + } + + [Fact] + public async Task EvaluateAsync_WithUnsupportedRunMode_ReturnsErrorDetails() + { + // Arrange + const bool defaultValue = false; + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.RunMode.Returns((RunMode)999); // Invalid enum value + + // Act & Assert + var details = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + Assert.Equal(ErrorType.ProviderFatal, details.ErrorType); + Assert.Equal(Reason.Error, details.Reason); + Assert.Contains("Unsupported run mode", details.ErrorMessage); + } + + [Fact] + public async Task EvaluateAsync_WithStrategySkippingProvider_DoesNotCallSkippedProvider() + { + // Arrange + const bool defaultValue = false; + const bool resolvedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.RunMode.Returns(RunMode.Sequential); + this._mockStrategy.ShouldEvaluateThisProvider(Arg.Any>(), this._evaluationContext) + .Returns(callInfo => + { + var context = callInfo.Arg>(); + return context.ProviderName == Provider1Name; // Only evaluate provider1 + }); + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + this._mockProvider1.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()) + .Returns(expectedDetails); + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext); + + // Assert + Assert.Equal(expectedDetails, result); + await this._mockProvider1.Received(1).ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()); + await this._mockProvider2.DidNotReceive().ResolveBooleanValueAsync(Arg.Any(), Arg.Any(), Arg.Any(), Arg.Any()); + } + + [Fact] + public async Task EvaluateAsync_WithCancellationToken_PassesCancellationTokenToProviders() + { + // Arrange + const bool defaultValue = false; + var expectedDetails = new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant); + var finalResult = new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null); + + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockStrategy.RunMode.Returns(RunMode.Sequential); + this._mockStrategy.ShouldEvaluateThisProvider(Arg.Any>(), this._evaluationContext).Returns(true); + this._mockStrategy.ShouldEvaluateNextProvider(Arg.Any>(), this._evaluationContext, Arg.Any>()).Returns(false); + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, defaultValue, this._evaluationContext, Arg.Any>>()) + .Returns(finalResult); + + this._mockProvider1.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, Arg.Any()) + .Returns(expectedDetails); + + using var cts = new CancellationTokenSource(); + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, cts.Token); + + // Assert + Assert.Equal(expectedDetails, result); + await this._mockProvider1.Received(1).ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, cts.Token); + } + + [Fact] + public void Constructor_WithProvidersHavingSameMetadataName_AssignsUniqueNames() + { + // Arrange + var provider1 = Substitute.For(); + var provider2 = Substitute.For(); + provider1.GetMetadata().Returns(new Metadata("SameName")); + provider2.GetMetadata().Returns(new Metadata("SameName")); + + var providerEntries = new List + { + new(provider1), // No explicit name, will use metadata name + new(provider2) // No explicit name, will use metadata name + }; + + // Act + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Assert + Assert.NotNull(multiProvider); + // The internal logic should assign unique names like "SameName-1", "SameName-2" + var metadata = multiProvider.GetMetadata(); + Assert.Equal("MultiProvider", metadata.Name); + } + + [Fact] + public void Constructor_WithProviderHavingNullMetadata_AssignsDefaultName() + { + // Arrange + var provider = Substitute.For(); + provider.GetMetadata().Returns((Metadata?)null); + + var providerEntries = new List { new(provider) }; + + // Act + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Assert + Assert.NotNull(multiProvider); + var metadata = multiProvider.GetMetadata(); + Assert.Equal("MultiProvider", metadata.Name); + } + + [Fact] + public void Constructor_WithProviderHavingNullMetadataName_AssignsDefaultName() + { + // Arrange + var provider = Substitute.For(); + var metadata = new Metadata(null); + provider.GetMetadata().Returns(metadata); + + var providerEntries = new List { new(provider) }; + + // Act + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Assert + Assert.NotNull(multiProvider); + var multiProviderMetadata = multiProvider.GetMetadata(); + Assert.Equal("MultiProvider", multiProviderMetadata.Name); + } + + [Fact] + public async Task InitializeAsync_WithCancellationToken_PassesCancellationTokenToProviders() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockProvider1.InitializeAsync(this._evaluationContext, Arg.Any()).Returns(Task.CompletedTask); + + using var cts = new CancellationTokenSource(); + + // Act + await multiProvider.InitializeAsync(this._evaluationContext, cts.Token); + + // Assert + await this._mockProvider1.Received(1).InitializeAsync(this._evaluationContext, cts.Token); + } + + [Fact] + public async Task ShutdownAsync_WithCancellationToken_PassesCancellationTokenToProviders() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + multiProvider.SetStatus(ProviderStatus.Ready); + + this._mockProvider1.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + + using var cts = new CancellationTokenSource(); + + // Act + await multiProvider.ShutdownAsync(cts.Token); + + // Assert + await this._mockProvider1.Received(1).ShutdownAsync(cts.Token); + } + + [Fact] + public async Task InitializeAsync_WithAllSuccessfulProviders_CompletesWithoutException() + { + // Arrange + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name), + new(this._mockProvider3, Provider3Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + this._mockProvider1.InitializeAsync(this._evaluationContext, Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider2.InitializeAsync(this._evaluationContext, Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider3.InitializeAsync(this._evaluationContext, Arg.Any()).Returns(Task.CompletedTask); + + // Act & Assert + await multiProvider.InitializeAsync(this._evaluationContext); + + // Verify all providers were called + await this._mockProvider1.Received(1).InitializeAsync(this._evaluationContext, Arg.Any()); + await this._mockProvider2.Received(1).InitializeAsync(this._evaluationContext, Arg.Any()); + await this._mockProvider3.Received(1).InitializeAsync(this._evaluationContext, Arg.Any()); + } + + [Fact] + public async Task ShutdownAsync_WithAllSuccessfulProviders_CompletesWithoutException() + { + // Arrange + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name), + new(this._mockProvider3, Provider3Name) + }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + multiProvider.SetStatus(ProviderStatus.Ready); + + this._mockProvider1.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider2.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + this._mockProvider3.ShutdownAsync(Arg.Any()).Returns(Task.CompletedTask); + + // Act & Assert + await multiProvider.ShutdownAsync(); + + // Verify all providers were called + await this._mockProvider1.Received(1).ShutdownAsync(Arg.Any()); + await this._mockProvider2.Received(1).ShutdownAsync(Arg.Any()); + await this._mockProvider3.Received(1).ShutdownAsync(Arg.Any()); + } + + [Fact] + public async Task MultiProvider_ConcurrentInitializationAndShutdown_ShouldMaintainConsistentProviderStatus() + { + // Arrange + const int providerCount = 20; + var providerEntries = new List(); + + for (int i = 0; i < providerCount; i++) + { + var provider = Substitute.For(); + + provider.InitializeAsync(Arg.Any(), Arg.Any()) + .Returns(Task.CompletedTask); + + provider.ShutdownAsync(Arg.Any()) + .Returns(Task.CompletedTask); + + provider.GetMetadata() + .Returns(new Metadata(name: $"provider-{i}")); + + providerEntries.Add(new ProviderEntry(provider)); + } + + var multiProvider = new MultiProvider(providerEntries); + + // Act: simulate concurrent initialization and shutdown with one task each + var initTasks = Enumerable.Range(0, 1).Select(_ => + Task.Run(() => multiProvider.InitializeAsync(Arg.Any(), CancellationToken.None))); + + var shutdownTasks = Enumerable.Range(0, 1).Select(_ => + Task.Run(() => multiProvider.ShutdownAsync(CancellationToken.None))); + + await Task.WhenAll(initTasks.Concat(shutdownTasks)); + + // Assert: ensure that each provider ends in a valid lifecycle state + var statuses = GetRegisteredStatuses().ToList(); + + Assert.All(statuses, status => + { + Assert.True( + status is ProviderStatus.Ready or ProviderStatus.NotReady, + $"Unexpected provider status: {status}"); + }); + + // Local helper: uses reflection to access the private '_registeredProviders' field + // and retrieve the current status of each registered provider. + // Consider replacing this with an internal or public method if testing becomes more frequent. + IEnumerable GetRegisteredStatuses() + { + var field = typeof(MultiProvider).GetField("_registeredProviders", BindingFlags.NonPublic | BindingFlags.Instance); + if (field?.GetValue(multiProvider) is not IEnumerable list) + throw new InvalidOperationException("Could not retrieve registered providers via reflection."); + + foreach (var p in list) + { + var statusProperty = p.GetType().GetProperty("Status", BindingFlags.Public | BindingFlags.NonPublic | BindingFlags.Instance); + if (statusProperty == null) + throw new InvalidOperationException($"'Status' property not found on type {p.GetType().Name}."); + + if (statusProperty.GetValue(p) is not ProviderStatus status) + throw new InvalidOperationException("Unable to read status property value."); + + yield return status; + } + } + } + + [Fact] + public async Task DisposeAsync_ShouldDisposeInternalResources() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act + await multiProvider.DisposeAsync(); + + // Assert - Should not throw any exception + // The internal semaphores should be disposed + Assert.True(true); // If we get here without exception, disposal worked + } + + [Fact] + public async Task DisposeAsync_CalledMultipleTimes_ShouldNotThrow() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act & Assert - Multiple calls to Dispose should not throw + await multiProvider.DisposeAsync(); + await multiProvider.DisposeAsync(); + await multiProvider.DisposeAsync(); + + // If we get here without exception, multiple disposal calls worked correctly + Assert.True(true); + } + + [Fact] + public async Task InitializeAsync_AfterDispose_ShouldThrowObjectDisposedException() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act + await multiProvider.DisposeAsync(); + + // Assert + var exception = await Assert.ThrowsAsync(() => + multiProvider.InitializeAsync(this._evaluationContext)); + Assert.Equal(nameof(MultiProvider), exception.ObjectName); + } + + [Fact] + public async Task ShutdownAsync_AfterDispose_ShouldThrowObjectDisposedException() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act + await multiProvider.DisposeAsync(); + + // Assert + var exception = await Assert.ThrowsAsync(() => + multiProvider.ShutdownAsync()); + Assert.Equal(nameof(MultiProvider), exception.ObjectName); + } + + [Fact] + public async Task InitializeAsync_WhenAlreadyDisposed_DuringExecution_ShouldExitEarly() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Dispose before calling InitializeAsync + await multiProvider.DisposeAsync(); + + // Act & Assert + await Assert.ThrowsAsync(() => + multiProvider.InitializeAsync(this._evaluationContext)); + + // Verify that the underlying provider was never called since the object was disposed + await this._mockProvider1.DidNotReceive().InitializeAsync(Arg.Any(), Arg.Any()); + } + + [Fact] + public async Task ShutdownAsync_WhenAlreadyDisposed_DuringExecution_ShouldExitEarly() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Dispose before calling ShutdownAsync + await multiProvider.DisposeAsync(); + + // Act & Assert + await Assert.ThrowsAsync(() => + multiProvider.ShutdownAsync()); + + // Verify that the underlying provider was never called since the object was disposed + await this._mockProvider1.DidNotReceive().ShutdownAsync(Arg.Any()); + } + + [Fact] + public async Task EvaluateAsync_AfterDispose_ShouldThrowObjectDisposedException() + { + // Arrange + var providerEntries = new List { new(this._mockProvider1, Provider1Name) }; + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act + await multiProvider.DisposeAsync(); + + // Assert - All evaluate methods should throw ObjectDisposedException + var boolException = await Assert.ThrowsAsync(() => + multiProvider.ResolveBooleanValueAsync(TestFlagKey, false)); + Assert.Equal(nameof(MultiProvider), boolException.ObjectName); + + var stringException = await Assert.ThrowsAsync(() => + multiProvider.ResolveStringValueAsync(TestFlagKey, "default")); + Assert.Equal(nameof(MultiProvider), stringException.ObjectName); + + var intException = await Assert.ThrowsAsync(() => + multiProvider.ResolveIntegerValueAsync(TestFlagKey, 0)); + Assert.Equal(nameof(MultiProvider), intException.ObjectName); + + var doubleException = await Assert.ThrowsAsync(() => + multiProvider.ResolveDoubleValueAsync(TestFlagKey, 0.0)); + Assert.Equal(nameof(MultiProvider), doubleException.ObjectName); + + var structureException = await Assert.ThrowsAsync(() => + multiProvider.ResolveStructureValueAsync(TestFlagKey, new Value())); + Assert.Equal(nameof(MultiProvider), structureException.ObjectName); + } + + #region Hook Tests + + [Fact] + public void GetProviderHooks_WithNoProviders_ReturnsEmptyList() + { + // Arrange - Create provider without hooks + var provider = Substitute.For(); + provider.GetProviderHooks().Returns(ImmutableList.Empty); + var providerEntries = new List { new(provider, Provider1Name) }; + + // Act + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + var hooks = multiProvider.GetProviderHooks(); + + // Assert + Assert.Empty(hooks); + } + + [Fact] + public void GetProviderHooks_WithSingleProviderWithHooks_ReturnsEmptyList() + { + // Arrange + var hook1 = Substitute.For(); + var hook2 = Substitute.For(); + var providerHooks = ImmutableList.Create(hook1, hook2); + + var provider = Substitute.For(); + provider.GetProviderHooks().Returns(providerHooks); + var providerEntries = new List { new(provider, Provider1Name) }; + + // Act + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + var hooks = multiProvider.GetProviderHooks(); + + // Assert + Assert.Empty(hooks); + } + + [Fact] + public void GetProviderHooks_WithMultipleProvidersWithHooks_ReturnsEmptyList() + { + // Arrange + var hook1 = Substitute.For(); + var hook2 = Substitute.For(); + var hook3 = Substitute.For(); + + this._mockProvider1.GetProviderHooks().Returns(ImmutableList.Create(hook1, hook2)); + this._mockProvider2.GetProviderHooks().Returns(ImmutableList.Create(hook3)); + + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + + // Act + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + var hooks = multiProvider.GetProviderHooks(); + + // Assert + Assert.Empty(hooks); + } + + [Fact] + public async Task EvaluateAsync_WithProviderHooks_ExecutesHooksForEachProvider() + { + // Arrange + var hook1 = Substitute.For(); + var hook2 = Substitute.For(); + + // Setup hooks to return modified context + var modifiedContext = new EvaluationContextBuilder() + .Set("modified", "value") + .Build(); + + hook1.BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()) + .Returns(modifiedContext); + hook2.BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()) + .Returns(EvaluationContext.Empty); + + this._mockProvider1.GetProviderHooks().Returns(ImmutableList.Create(hook1)); + this._mockProvider2.GetProviderHooks().Returns(ImmutableList.Create(hook2)); + + // Setup providers to return successful results + const bool expectedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, expectedValue, ErrorType.None, Reason.Static, TestVariant); + + this._mockProvider1.ResolveBooleanValueAsync(TestFlagKey, false, Arg.Any(), Arg.Any()) + .Returns(expectedDetails); + this._mockProvider2.ResolveBooleanValueAsync(TestFlagKey, false, Arg.Any(), Arg.Any()) + .Returns(expectedDetails); + + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + + // Setup strategy to evaluate both providers + this._mockStrategy.ShouldEvaluateThisProvider(Arg.Any>(), Arg.Any()).Returns(true); + this._mockStrategy.ShouldEvaluateNextProvider(Arg.Any>(), Arg.Any(), Arg.Any>()).Returns(true); + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, false, Arg.Any(), Arg.Any>>()) + .Returns(new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null)); + + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, false, this._evaluationContext); + + // Assert + Assert.Equal(expectedValue, result.Value); + + // Verify hooks were called + await hook1.Received(1).BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()); + await hook2.Received(1).BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()); + + // Verify after hooks were called + await hook1.Received(1).AfterAsync(Arg.Any>(), Arg.Any>(), Arg.Any>(), Arg.Any()); + await hook2.Received(1).AfterAsync(Arg.Any>(), Arg.Any>(), Arg.Any>(), Arg.Any()); + + // Verify finally hooks were called + await hook1.Received(1).FinallyAsync(Arg.Any>(), Arg.Any>(), Arg.Any>(), Arg.Any()); + await hook2.Received(1).FinallyAsync(Arg.Any>(), Arg.Any>(), Arg.Any>(), Arg.Any()); + } + + [Fact] + public async Task EvaluateAsync_WithHookContextModification_IsolatesContextBetweenProviders() + { + // Arrange + var hook1 = Substitute.For(); + var hook2 = Substitute.For(); + + // Setup hook1 to modify context + var modifiedContext1 = new EvaluationContextBuilder() + .Set("provider1", "modified") + .Build(); + + // Setup hook2 to modify context differently + var modifiedContext2 = new EvaluationContextBuilder() + .Set("provider2", "modified") + .Build(); + + hook1.BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()) + .Returns(modifiedContext1); + hook2.BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()) + .Returns(modifiedContext2); + + this._mockProvider1.GetProviderHooks().Returns(ImmutableList.Create(hook1)); + this._mockProvider2.GetProviderHooks().Returns(ImmutableList.Create(hook2)); + + // Setup providers to return results and capture context + EvaluationContext? capturedContext1 = null; + EvaluationContext? capturedContext2 = null; + + const bool expectedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, expectedValue, ErrorType.None, Reason.Static, TestVariant); + + this._mockProvider1.ResolveBooleanValueAsync(TestFlagKey, false, Arg.Do(ctx => capturedContext1 = ctx), Arg.Any()) + .Returns(expectedDetails); + this._mockProvider2.ResolveBooleanValueAsync(TestFlagKey, false, Arg.Do(ctx => capturedContext2 = ctx), Arg.Any()) + .Returns(expectedDetails); + + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + + // Setup strategy to evaluate both providers + this._mockStrategy.ShouldEvaluateThisProvider(Arg.Any>(), Arg.Any()).Returns(true); + this._mockStrategy.ShouldEvaluateNextProvider(Arg.Any>(), Arg.Any(), Arg.Any>()).Returns(true); + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, false, Arg.Any(), Arg.Any>>()) + .Returns(new FinalResult(expectedDetails, this._mockProvider1, Provider1Name, null)); + + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act + await multiProvider.ResolveBooleanValueAsync(TestFlagKey, false, this._evaluationContext); + + // Assert - Verify context isolation + Assert.NotNull(capturedContext1); + Assert.NotNull(capturedContext2); + + // Provider1 should have received the context modified by hook1 + Assert.True(capturedContext1!.ContainsKey("provider1")); + Assert.Equal("modified", capturedContext1.GetValue("provider1").AsString); + Assert.False(capturedContext1.ContainsKey("provider2")); + + // Provider2 should have received the context modified by hook2 + Assert.True(capturedContext2!.ContainsKey("provider2")); + Assert.Equal("modified", capturedContext2.GetValue("provider2").AsString); + Assert.False(capturedContext2.ContainsKey("provider1")); + } + + [Fact] + public async Task EvaluateAsync_WithHookError_HandlesErrorAndContinuesEvaluation() + { + // Arrange + var throwingHook = Substitute.For(); + var normalHook = Substitute.For(); + + // Setup throwing hook to throw exception in before hook + throwingHook.BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()) + .Throws(new InvalidOperationException("Hook error")); + + // Setup normal hook + normalHook.BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()) + .Returns(EvaluationContext.Empty); + + this._mockProvider1.GetProviderHooks().Returns(ImmutableList.Create(throwingHook)); + this._mockProvider2.GetProviderHooks().Returns(ImmutableList.Create(normalHook)); + + // Setup provider2 to return successful result + const bool expectedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, expectedValue, ErrorType.None, Reason.Static, TestVariant); + + this._mockProvider2.ResolveBooleanValueAsync(TestFlagKey, false, Arg.Any(), Arg.Any()) + .Returns(expectedDetails); + + var providerEntries = new List + { + new(this._mockProvider1, Provider1Name), + new(this._mockProvider2, Provider2Name) + }; + + // Setup strategy to continue evaluation after first provider error + this._mockStrategy.ShouldEvaluateThisProvider(Arg.Any>(), Arg.Any()).Returns(true); + this._mockStrategy.ShouldEvaluateNextProvider(Arg.Any>(), Arg.Any(), Arg.Any>()).Returns(true); + this._mockStrategy.DetermineFinalResult(Arg.Any>(), TestFlagKey, false, Arg.Any(), Arg.Any>>()) + .Returns(new FinalResult(expectedDetails, this._mockProvider2, Provider2Name, null)); + + var multiProvider = new MultiProvider(providerEntries, this._mockStrategy); + + // Act + var result = await multiProvider.ResolveBooleanValueAsync(TestFlagKey, false, this._evaluationContext); + + // Assert + Assert.Equal(expectedValue, result.Value); + + // Verify that the first provider returned an error due to hook failure + // and the second provider succeeded + await this._mockProvider1.DidNotReceive().ResolveBooleanValueAsync(Arg.Any(), Arg.Any(), Arg.Any(), Arg.Any()); + await this._mockProvider2.Received(1).ResolveBooleanValueAsync(TestFlagKey, false, Arg.Any(), Arg.Any()); + } + + #endregion + +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/OpenFeature.Providers.MultiProvider.Tests.csproj b/test/OpenFeature.Providers.MultiProvider.Tests/OpenFeature.Providers.MultiProvider.Tests.csproj new file mode 100644 index 000000000..f1f016c64 --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/OpenFeature.Providers.MultiProvider.Tests.csproj @@ -0,0 +1,35 @@ +๏ปฟ + + + net8.0;net9.0 + $(TargetFrameworks);net462 + OpenFeature.Providers.MultiProvider.Tests + + + + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + all + runtime; build; native; contentfiles; analyzers; buildtransitive + + + + + + + + + runtime; build; native; contentfiles; analyzers; buildtransitive + all + + + + + + + + diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/ProviderExtensionsTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/ProviderExtensionsTests.cs new file mode 100644 index 000000000..afb14fe65 --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/ProviderExtensionsTests.cs @@ -0,0 +1,464 @@ +using System.Collections.Immutable; +using Microsoft.Extensions.Logging; +using NSubstitute; +using NSubstitute.ExceptionExtensions; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests; + +public class ProviderExtensionsTests +{ + private const string TestFlagKey = "test-flag"; + private const string TestProviderName = "test-provider"; + private const string TestVariant = "test-variant"; + + private readonly FeatureProvider _mockProvider = Substitute.For(); + private readonly EvaluationContext _evaluationContext = new EvaluationContextBuilder().Build(); + private readonly CancellationToken _cancellationToken = CancellationToken.None; + private readonly ILogger _mockLogger = Substitute.For(); + + [Fact] + public async Task EvaluateAsync_WithBooleanType_CallsResolveBooleanValueAsync() + { + // Arrange + const bool defaultValue = false; + const bool resolvedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(expectedDetails, result.ResolutionDetails); + Assert.Null(result.ThrownError); + await this._mockProvider.Received(1).ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithStringType_CallsResolveStringValueAsync() + { + // Arrange + const string defaultValue = "default"; + const string resolvedValue = "resolved"; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveStringValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(expectedDetails, result.ResolutionDetails); + Assert.Null(result.ThrownError); + await this._mockProvider.Received(1).ResolveStringValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithIntegerType_CallsResolveIntegerValueAsync() + { + // Arrange + const int defaultValue = 0; + const int resolvedValue = 42; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveIntegerValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(expectedDetails, result.ResolutionDetails); + Assert.Null(result.ThrownError); + await this._mockProvider.Received(1).ResolveIntegerValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithDoubleType_CallsResolveDoubleValueAsync() + { + // Arrange + const double defaultValue = 0.0; + const double resolvedValue = 3.14; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveDoubleValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(expectedDetails, result.ResolutionDetails); + Assert.Null(result.ThrownError); + await this._mockProvider.Received(1).ResolveDoubleValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithValueType_CallsResolveStructureValueAsync() + { + // Arrange + var defaultValue = new Value(); + var resolvedValue = new Value("resolved"); + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveStructureValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(expectedDetails, result.ResolutionDetails); + Assert.Null(result.ThrownError); + await this._mockProvider.Received(1).ResolveStructureValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithUnsupportedType_ThrowsArgumentException() + { + // Arrange + var defaultValue = new DateTime(2023, 1, 1); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(TestFlagKey, result.ResolutionDetails.FlagKey); + Assert.Equal(defaultValue, result.ResolutionDetails.Value); + Assert.Equal(ErrorType.General, result.ResolutionDetails.ErrorType); + Assert.Equal(Reason.Error, result.ResolutionDetails.Reason); + Assert.Contains("Unsupported flag type", result.ResolutionDetails.ErrorMessage); + Assert.NotNull(result.ThrownError); + Assert.IsType(result.ThrownError); + } + + [Fact] + public async Task EvaluateAsync_WhenProviderThrowsException_ReturnsErrorResult() + { + // Arrange + const bool defaultValue = false; + var expectedException = new InvalidOperationException("Provider error"); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, this._cancellationToken) + .ThrowsAsync(expectedException); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(TestFlagKey, result.ResolutionDetails.FlagKey); + Assert.Equal(defaultValue, result.ResolutionDetails.Value); + Assert.Equal(ErrorType.General, result.ResolutionDetails.ErrorType); + Assert.Equal(Reason.Error, result.ResolutionDetails.Reason); + Assert.Equal("Provider error", result.ResolutionDetails.ErrorMessage); + Assert.Equal(expectedException, result.ThrownError); + } + + [Fact] + public async Task EvaluateAsync_WithNullEvaluationContext_CallsProviderWithNullContext() + { + // Arrange + const bool defaultValue = false; + const bool resolvedValue = true; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, null, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, null, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(expectedDetails, result.ResolutionDetails); + Assert.Null(result.ThrownError); + await this._mockProvider.Received(1).ResolveBooleanValueAsync(TestFlagKey, defaultValue, null, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithCancellationToken_PassesToProvider() + { + // Arrange + const string defaultValue = "default"; + const string resolvedValue = "resolved"; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + var customCancellationToken = new CancellationTokenSource().Token; + + this._mockProvider.ResolveStringValueAsync(TestFlagKey, defaultValue, this._evaluationContext, customCancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, customCancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(expectedDetails, result.ResolutionDetails); + await this._mockProvider.Received(1).ResolveStringValueAsync(TestFlagKey, defaultValue, this._evaluationContext, customCancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithNullDefaultValue_PassesNullToProvider() + { + // Arrange + string? defaultValue = null; + const string resolvedValue = "resolved"; + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveStringValueAsync(TestFlagKey, defaultValue!, this._evaluationContext, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue!, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(expectedDetails, result.ResolutionDetails); + await this._mockProvider.Received(1).ResolveStringValueAsync(TestFlagKey, defaultValue!, this._evaluationContext, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithDifferentFlagKeys_UsesCorrectKey() + { + // Arrange + const string customFlagKey = "custom-flag-key"; + const int defaultValue = 0; + const int resolvedValue = 123; + var expectedDetails = new ResolutionDetails(customFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, customFlagKey); + + this._mockProvider.ResolveIntegerValueAsync(customFlagKey, defaultValue, this._evaluationContext, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(expectedDetails, result.ResolutionDetails); + Assert.Equal(customFlagKey, result.ResolutionDetails.FlagKey); + await this._mockProvider.Received(1).ResolveIntegerValueAsync(customFlagKey, defaultValue, this._evaluationContext, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WhenOperationCancelled_ReturnsErrorResult() + { + // Arrange + const bool defaultValue = false; + var cancellationTokenSource = new CancellationTokenSource(); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, this._evaluationContext, cancellationTokenSource.Token) + .Returns(async _ => + { + // net462 does not support CancellationTokenSource.CancelAfter + // ReSharper disable once MethodHasAsyncOverload + cancellationTokenSource.Cancel(); + await Task.Delay(100, cancellationTokenSource.Token); + return new ResolutionDetails(TestFlagKey, true); + }); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, cancellationTokenSource.Token); + + // Assert + Assert.NotNull(result); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(TestFlagKey, result.ResolutionDetails.FlagKey); + Assert.Equal(defaultValue, result.ResolutionDetails.Value); + Assert.Equal(ErrorType.General, result.ResolutionDetails.ErrorType); + Assert.Equal(Reason.Error, result.ResolutionDetails.Reason); + Assert.NotNull(result.ThrownError); + Assert.True(result.ThrownError is OperationCanceledException); + } + + [Fact] + public async Task EvaluateAsync_WithComplexEvaluationContext_PassesContextToProvider() + { + // Arrange + const double defaultValue = 1.0; + const double resolvedValue = 2.5; + var complexContext = new EvaluationContextBuilder() + .Set("user", "test-user") + .Set("environment", "test") + .Build(); + var expectedDetails = new ResolutionDetails(TestFlagKey, resolvedValue, ErrorType.None, Reason.Static, TestVariant); + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveDoubleValueAsync(TestFlagKey, defaultValue, complexContext, this._cancellationToken) + .Returns(expectedDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, complexContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(expectedDetails, result.ResolutionDetails); + await this._mockProvider.Received(1).ResolveDoubleValueAsync(TestFlagKey, defaultValue, complexContext, this._cancellationToken); + } + + [Fact] + public async Task EvaluateAsync_WithProviderHooksAndErrorResult_TriggersErrorHooks() + { + // Arrange + var mockHook = Substitute.For(); + + // Setup hook to return evaluation context successfully + mockHook.BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()) + .Returns(EvaluationContext.Empty); + + // Setup provider metadata + var providerMetadata = new Metadata(TestProviderName); + this._mockProvider.GetMetadata().Returns(providerMetadata); + this._mockProvider.GetProviderHooks().Returns(ImmutableList.Create(mockHook)); + + const bool defaultValue = false; + var errorDetails = new ResolutionDetails( + TestFlagKey, + defaultValue, + ErrorType.FlagNotFound, + Reason.Error, + TestVariant, + errorMessage: "Flag not found"); + + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, Arg.Any(), this._cancellationToken) + .Returns(errorDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(ErrorType.FlagNotFound, result.ResolutionDetails.ErrorType); + Assert.Equal(Reason.Error, result.ResolutionDetails.Reason); + + // Verify before hook was called + await mockHook.Received(1).BeforeAsync(Arg.Any>(), Arg.Any>(), Arg.Any()); + + // Verify error hook was called (not after hook) + await mockHook.Received(1).ErrorAsync(Arg.Any>(), Arg.Any(), Arg.Any>(), Arg.Any()); + await mockHook.DidNotReceive().AfterAsync(Arg.Any>(), Arg.Any>(), Arg.Any>(), Arg.Any()); + + // Verify finally hook was called + await mockHook.Received(1).FinallyAsync(Arg.Any>(), Arg.Any>(), Arg.Any>(), Arg.Any()); + } + + [Theory] + [InlineData(typeof(bool), FlagValueType.Boolean)] + [InlineData(typeof(string), FlagValueType.String)] + [InlineData(typeof(int), FlagValueType.Number)] + [InlineData(typeof(double), FlagValueType.Number)] + [InlineData(typeof(Value), FlagValueType.Object)] + [InlineData(typeof(ProviderExtensionsTests), FlagValueType.Object)] // fallback path + public void GetFlagValueType_ReturnsExpectedFlagValueType(Type inputType, FlagValueType expected) + { + FlagValueType result = inputType == typeof(bool) ? ProviderExtensions.GetFlagValueType() + : inputType == typeof(string) ? ProviderExtensions.GetFlagValueType() + : inputType == typeof(int) ? ProviderExtensions.GetFlagValueType() + : inputType == typeof(double) ? ProviderExtensions.GetFlagValueType() + : inputType == typeof(Value) ? ProviderExtensions.GetFlagValueType() + : ProviderExtensions.GetFlagValueType(); + + Assert.Equal(expected, result); + } + + [Fact] + public async Task EvaluateAsync_WhenAfterHookThrowsException_LogsWarningButSucceeds() + { + // Arrange + var hookException = new InvalidOperationException("After hook failed"); + var throwingHook = new ThrowingAfterHook(hookException); + + // Setup provider metadata and hooks + var providerMetadata = new Metadata(TestProviderName); + this._mockProvider.GetMetadata().Returns(providerMetadata); + this._mockProvider.GetProviderHooks().Returns(ImmutableList.Create(throwingHook)); + + const bool defaultValue = false; + const bool resolvedValue = true; + var successDetails = new ResolutionDetails( + TestFlagKey, + resolvedValue, + ErrorType.None, + Reason.Static, + TestVariant); + + var providerContext = new StrategyPerProviderContext(this._mockProvider, TestProviderName, ProviderStatus.Ready, TestFlagKey); + + this._mockProvider.ResolveBooleanValueAsync(TestFlagKey, defaultValue, Arg.Any(), this._cancellationToken) + .Returns(successDetails); + + // Act + var result = await this._mockProvider.EvaluateAsync(providerContext, this._evaluationContext, defaultValue, this._mockLogger, this._cancellationToken); + + // Assert + Assert.NotNull(result); + Assert.Equal(resolvedValue, result.ResolutionDetails.Value); + Assert.Equal(ErrorType.None, result.ResolutionDetails.ErrorType); + Assert.Null(result.ThrownError); // Hook errors don't propagate + + // Verify warning was logged + this._mockLogger.Received(1).Log( + LogLevel.Warning, + Arg.Any(), + Arg.Is(v => v.ToString()!.Contains("Provider after/finally hook execution failed")), + Arg.Is(ex => ex == hookException), + Arg.Any>()); + } +} + +internal class ThrowingAfterHook : Hook +{ + private InvalidOperationException hookException; + + public ThrowingAfterHook(InvalidOperationException hookException) + { + this.hookException = hookException; + } + + public override ValueTask AfterAsync(HookContext context, FlagEvaluationDetails details, IReadOnlyDictionary? hints = null, CancellationToken cancellationToken = default) + { + throw this.hookException; + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/BaseEvaluationStrategyTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/BaseEvaluationStrategyTests.cs new file mode 100644 index 000000000..a585ef0c9 --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/BaseEvaluationStrategyTests.cs @@ -0,0 +1,500 @@ +using NSubstitute; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Strategies; + +public class BaseEvaluationStrategyTests +{ + private const string TestFlagKey = "test-flag"; + private const bool DefaultBoolValue = false; + private const string TestVariant = "variant1"; + private const string TestErrorMessage = "Test error message"; + private const string Provider1Name = "provider1"; + private const string Provider2Name = "provider2"; + + private readonly TestableBaseEvaluationStrategy _strategy = new(); + private readonly FeatureProvider _mockProvider1 = Substitute.For(); + private readonly FeatureProvider _mockProvider2 = Substitute.For(); + private readonly EvaluationContext _evaluationContext = new EvaluationContextBuilder().Build(); + private readonly StrategyEvaluationContext _strategyContext = new(TestFlagKey); + + [Fact] + public void RunMode_DefaultValue_ReturnsSequential() + { + // Act + var result = this._strategy.RunMode; + + // Assert + Assert.Equal(RunMode.Sequential, result); + } + + [Fact] + public void ShouldEvaluateThisProvider_WithReadyProvider_ReturnsTrue() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + + // Act + var result = this._strategy.ShouldEvaluateThisProvider(strategyContext, this._evaluationContext); + + // Assert + Assert.True(result); + } + + [Fact] + public void ShouldEvaluateThisProvider_WithNotReadyProvider_ReturnsFalse() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.NotReady, TestFlagKey); + + // Act + var result = this._strategy.ShouldEvaluateThisProvider(strategyContext, this._evaluationContext); + + // Assert + Assert.False(result); + } + + [Fact] + public void ShouldEvaluateThisProvider_WithFatalProvider_ReturnsFalse() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Fatal, TestFlagKey); + + // Act + var result = this._strategy.ShouldEvaluateThisProvider(strategyContext, this._evaluationContext); + + // Assert + Assert.False(result); + } + + [Fact] + public void ShouldEvaluateThisProvider_WithStaleProvider_ReturnsTrue() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Stale, TestFlagKey); + + // Act + var result = this._strategy.ShouldEvaluateThisProvider(strategyContext, this._evaluationContext); + + // Assert + Assert.True(result); + } + + [Fact] + public void ShouldEvaluateThisProvider_WithNullEvaluationContext_ReturnsExpectedResult() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + + // Act + var result = this._strategy.ShouldEvaluateThisProvider(strategyContext, null); + + // Assert + Assert.True(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_DefaultImplementation_ReturnsTrue() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var successResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, successResult); + + // Assert + Assert.True(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithErrorResult_ReturnsTrue() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: TestErrorMessage)); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, errorResult); + + // Assert + Assert.True(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithNullEvaluationContext_ReturnsTrue() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var successResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, null, successResult); + + // Assert + Assert.True(result); + } + + [Fact] + public void HasError_WithThrownException_ReturnsTrue() + { + // Arrange + var exception = new InvalidOperationException(TestErrorMessage); + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.None, Reason.Static), + exception); + + // Act + var result = TestableBaseEvaluationStrategy.TestHasError(errorResult); + + // Assert + Assert.True(result); + } + + [Fact] + public void HasError_WithErrorType_ReturnsTrue() + { + // Arrange + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: TestErrorMessage)); + + // Act + var result = TestableBaseEvaluationStrategy.TestHasError(errorResult); + + // Assert + Assert.True(result); + } + + [Fact] + public void HasError_WithNoError_ReturnsFalse() + { + // Arrange + var successResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + // Act + var result = TestableBaseEvaluationStrategy.TestHasError(successResult); + + // Assert + Assert.False(result); + } + + [Fact] + public void CollectProviderErrors_WithThrownExceptions_ReturnsAllErrors() + { + // Arrange + var exception1 = new InvalidOperationException("Error 1"); + var exception2 = new ArgumentException("Error 2"); + + var resolutions = new List> + { + new(this._mockProvider1, Provider1Name, new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.None, Reason.Static), exception1), + new(this._mockProvider2, Provider2Name, new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.None, Reason.Static), exception2) + }; + + // Act + var errors = TestableBaseEvaluationStrategy.TestCollectProviderErrors(resolutions); + + // Assert + Assert.Equal(2, errors.Count); + Assert.Equal(Provider1Name, errors[0].ProviderName); + Assert.Equal(exception1, errors[0].Error); + Assert.Equal(Provider2Name, errors[1].ProviderName); + Assert.Equal(exception2, errors[1].Error); + } + + [Fact] + public void CollectProviderErrors_WithErrorTypes_ReturnsAllErrors() + { + // Arrange + var resolutions = new List> + { + new(this._mockProvider1, Provider1Name, new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: "Error 1")), + new(this._mockProvider2, Provider2Name, new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.FlagNotFound, Reason.Error, errorMessage: "Error 2")) + }; + + // Act + var errors = TestableBaseEvaluationStrategy.TestCollectProviderErrors(resolutions); + + // Assert + Assert.Equal(2, errors.Count); + Assert.Equal(Provider1Name, errors[0].ProviderName); + Assert.Equal("Error 1", errors[0].Error?.Message); + Assert.Equal(Provider2Name, errors[1].ProviderName); + Assert.Equal("Error 2", errors[1].Error?.Message); + } + + [Fact] + public void CollectProviderErrors_WithMixedErrors_ReturnsAllErrors() + { + // Arrange + var thrownException = new InvalidOperationException("Thrown error"); + var resolutions = new List> + { + new(this._mockProvider1, Provider1Name, new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.None, Reason.Static), thrownException), + new(this._mockProvider2, Provider2Name, new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: "Resolution error")), + new(this._mockProvider1, "provider3", new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static)) + }; + + // Act + var errors = TestableBaseEvaluationStrategy.TestCollectProviderErrors(resolutions); + + // Assert + Assert.Equal(2, errors.Count); + Assert.Equal(Provider1Name, errors[0].ProviderName); + Assert.Equal(thrownException, errors[0].Error); + Assert.Equal(Provider2Name, errors[1].ProviderName); + Assert.Equal("Resolution error", errors[1].Error?.Message); + } + + [Fact] + public void CollectProviderErrors_WithNoErrors_ReturnsEmptyList() + { + // Arrange + var resolutions = new List> + { + new(this._mockProvider1, Provider1Name, new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static)), + new(this._mockProvider2, Provider2Name, new ResolutionDetails(TestFlagKey, false, ErrorType.None, Reason.Static)) + }; + + // Act + var errors = TestableBaseEvaluationStrategy.TestCollectProviderErrors(resolutions); + + // Assert + Assert.Empty(errors); + } + + [Fact] + public void CollectProviderErrors_WithNullErrorMessage_UsesDefaultMessage() + { + // Arrange + var resolutions = new List> + { + new(this._mockProvider1, Provider1Name, new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: null)) + }; + + // Act + var errors = TestableBaseEvaluationStrategy.TestCollectProviderErrors(resolutions); + + // Assert + Assert.Single(errors); + Assert.Equal("unknown error", errors[0].Error?.Message); + } + + [Fact] + public void HasErrorWithCode_WithMatchingErrorType_ReturnsTrue() + { + // Arrange + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.FlagNotFound, Reason.Error, errorMessage: TestErrorMessage)); + + // Act + var result = TestableBaseEvaluationStrategy.TestHasErrorWithCode(errorResult, ErrorType.FlagNotFound); + + // Assert + Assert.True(result); + } + + [Fact] + public void HasErrorWithCode_WithDifferentErrorType_ReturnsFalse() + { + // Arrange + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: TestErrorMessage)); + + // Act + var result = TestableBaseEvaluationStrategy.TestHasErrorWithCode(errorResult, ErrorType.FlagNotFound); + + // Assert + Assert.False(result); + } + + [Fact] + public void HasErrorWithCode_WithNoError_ReturnsFalse() + { + // Arrange + var successResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + // Act + var result = TestableBaseEvaluationStrategy.TestHasErrorWithCode(successResult, ErrorType.FlagNotFound); + + // Assert + Assert.False(result); + } + + [Fact] + public void HasErrorWithCode_WithThrownException_ReturnsFalse() + { + // Arrange + var exception = new InvalidOperationException(TestErrorMessage); + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.None, Reason.Static), + exception); + + // Act + var result = TestableBaseEvaluationStrategy.TestHasErrorWithCode(errorResult, ErrorType.General); + + // Assert + Assert.False(result); + } + + [Fact] + public void ToFinalResult_WithSuccessResult_ReturnsCorrectFinalResult() + { + // Arrange + var resolutionDetails = new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant); + var providerResult = new ProviderResolutionResult(this._mockProvider1, Provider1Name, resolutionDetails); + + // Act + var finalResult = TestableBaseEvaluationStrategy.TestToFinalResult(providerResult); + + // Assert + Assert.Equal(resolutionDetails, finalResult.Details); + Assert.Equal(this._mockProvider1, finalResult.Provider); + Assert.Equal(Provider1Name, finalResult.ProviderName); + Assert.Empty(finalResult.Errors); + } + + [Fact] + public void ToFinalResult_WithErrorResult_ReturnsCorrectFinalResult() + { + // Arrange + var resolutionDetails = new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: TestErrorMessage); + var providerResult = new ProviderResolutionResult(this._mockProvider1, Provider1Name, resolutionDetails); + + // Act + var finalResult = TestableBaseEvaluationStrategy.TestToFinalResult(providerResult); + + // Assert + Assert.Equal(resolutionDetails, finalResult.Details); + Assert.Equal(this._mockProvider1, finalResult.Provider); + Assert.Equal(Provider1Name, finalResult.ProviderName); + Assert.Empty(finalResult.Errors); + } + + [Theory] + [InlineData(ProviderStatus.Ready)] + [InlineData(ProviderStatus.Stale)] + [InlineData(ProviderStatus.Error)] + public void ShouldEvaluateThisProvider_WithAllowedStatuses_ReturnsTrue(ProviderStatus status) + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, status, TestFlagKey); + + // Act + var result = this._strategy.ShouldEvaluateThisProvider(strategyContext, this._evaluationContext); + + // Assert + Assert.True(result); + } + + [Theory] + [InlineData(ProviderStatus.NotReady)] + [InlineData(ProviderStatus.Fatal)] + public void ShouldEvaluateThisProvider_WithDisallowedStatuses_ReturnsFalse(ProviderStatus status) + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, status, TestFlagKey); + + // Act + var result = this._strategy.ShouldEvaluateThisProvider(strategyContext, this._evaluationContext); + + // Assert + Assert.False(result); + } + + [Theory] + [InlineData(ErrorType.None)] + [InlineData(ErrorType.FlagNotFound)] + [InlineData(ErrorType.General)] + [InlineData(ErrorType.ParseError)] + [InlineData(ErrorType.TypeMismatch)] + [InlineData(ErrorType.TargetingKeyMissing)] + [InlineData(ErrorType.InvalidContext)] + [InlineData(ErrorType.ProviderNotReady)] + public void HasErrorWithCode_WithAllErrorTypes_ReturnsCorrectResult(ErrorType errorType) + { + // Arrange + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, errorType, Reason.Error, errorMessage: TestErrorMessage)); + + // Act + var result = TestableBaseEvaluationStrategy.TestHasErrorWithCode(errorResult, errorType); + + // Assert + Assert.True(result); + } + + [Fact] + public void DetermineFinalResult_IsAbstractMethod_RequiresImplementation() + { + // This test verifies that DetermineFinalResult is abstract and must be implemented + // by testing our concrete implementation + + // Arrange + var resolutions = new List> + { + new(this._mockProvider1, Provider1Name, new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)) + }; + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result); + Assert.Equal("TestImplementation", result.ProviderName); // From our test implementation + } + + /// + /// Concrete implementation of BaseEvaluationStrategy for testing purposes. + /// + private class TestableBaseEvaluationStrategy : BaseEvaluationStrategy + { + public override FinalResult DetermineFinalResult(StrategyEvaluationContext strategyContext, string key, T defaultValue, EvaluationContext? evaluationContext, List> resolutions) + { + // Simple test implementation that returns the first result or a default + if (resolutions.Count > 0) + { + return new FinalResult(resolutions[0].ResolutionDetails, resolutions[0].Provider, "TestImplementation", null); + } + + var defaultDetails = new ResolutionDetails(key, defaultValue, ErrorType.None, Reason.Default); + return new FinalResult(defaultDetails, null!, "TestImplementation", null); + } + + // Expose protected methods for testing + public static bool TestHasError(ProviderResolutionResult resolution) => HasError(resolution); + public static List TestCollectProviderErrors(List> resolutions) => CollectProviderErrors(resolutions); + public static bool TestHasErrorWithCode(ProviderResolutionResult resolution, ErrorType errorType) => HasErrorWithCode(resolution, errorType); + public static FinalResult TestToFinalResult(ProviderResolutionResult resolution) => ToFinalResult(resolution); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/ComparisonStrategyTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/ComparisonStrategyTests.cs new file mode 100644 index 000000000..e57006eae --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/ComparisonStrategyTests.cs @@ -0,0 +1,475 @@ +using NSubstitute; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Strategies; + +public class ComparisonStrategyTests +{ + private const string TestFlagKey = "test-flag"; + private const bool DefaultBoolValue = false; + private const string TestVariant = "variant1"; + private const string TestErrorMessage = "Test error message"; + private const string Provider1Name = "provider1"; + private const string Provider2Name = "provider2"; + private const string Provider3Name = "provider3"; + private const string MultiProviderName = "MultiProvider"; + + private readonly FeatureProvider _mockProvider1 = Substitute.For(); + private readonly FeatureProvider _mockProvider2 = Substitute.For(); + private readonly FeatureProvider _mockProvider3 = Substitute.For(); + private readonly EvaluationContext _evaluationContext = new EvaluationContextBuilder().Build(); + private readonly StrategyEvaluationContext _strategyContext = new(TestFlagKey); + + [Fact] + public void RunMode_ReturnsParallel() + { + // Arrange + var strategy = new ComparisonStrategy(); + + // Act + var result = strategy.RunMode; + + // Assert + Assert.Equal(RunMode.Parallel, result); + } + + [Fact] + public void Constructor_WithNoParameters_InitializesSuccessfully() + { + // Act + var strategy = new ComparisonStrategy(); + + // Assert + Assert.NotNull(strategy); + Assert.Equal(RunMode.Parallel, strategy.RunMode); + } + + [Fact] + public void Constructor_WithFallbackProvider_InitializesSuccessfully() + { + // Act + var strategy = new ComparisonStrategy(this._mockProvider1); + + // Assert + Assert.NotNull(strategy); + Assert.Equal(RunMode.Parallel, strategy.RunMode); + } + + [Fact] + public void Constructor_WithOnMismatchCallback_InitializesSuccessfully() + { + // Arrange + var onMismatch = Substitute.For>>(); + + // Act + var strategy = new ComparisonStrategy(onMismatch: onMismatch); + + // Assert + Assert.NotNull(strategy); + Assert.Equal(RunMode.Parallel, strategy.RunMode); + } + + [Fact] + public void Constructor_WithBothParameters_InitializesSuccessfully() + { + // Arrange + var onMismatch = Substitute.For>>(); + + // Act + var strategy = new ComparisonStrategy(this._mockProvider1, onMismatch); + + // Assert + Assert.NotNull(strategy); + Assert.Equal(RunMode.Parallel, strategy.RunMode); + } + + [Fact] + public void DetermineFinalResult_WithNoProviders_ReturnsErrorResult() + { + // Arrange + var strategy = new ComparisonStrategy(); + var resolutions = new List>(); + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(DefaultBoolValue, result.Details.Value); + Assert.Equal(ErrorType.ProviderNotReady, result.Details.ErrorType); + Assert.Equal(Reason.Error, result.Details.Reason); + Assert.Equal("No providers available or all providers failed", result.Details.ErrorMessage); + Assert.Equal(MultiProviderName, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithAllFailedProviders_ReturnsErrorResult() + { + // Arrange + var strategy = new ComparisonStrategy(); + var errorResult1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: "Error from provider1")); + + var errorResult2 = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.InvalidContext, Reason.Error, errorMessage: "Error from provider2")); + + var resolutions = new List> { errorResult1, errorResult2 }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(DefaultBoolValue, result.Details.Value); + Assert.Equal(ErrorType.ProviderNotReady, result.Details.ErrorType); + Assert.Equal(Reason.Error, result.Details.Reason); + Assert.Equal("No providers available or all providers failed", result.Details.ErrorMessage); + Assert.Equal(MultiProviderName, result.ProviderName); + Assert.Equal(2, result.Errors.Count); + } + + [Fact] + public void DetermineFinalResult_WithSingleSuccessfulProvider_ReturnsResult() + { + // Arrange + var strategy = new ComparisonStrategy(); + var successfulResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var resolutions = new List> { successfulResult }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithAgreingProviders_ReturnsFirstResult() + { + // Arrange + var strategy = new ComparisonStrategy(); + var result1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var result2 = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, "variant2")); + + var result3 = new ProviderResolutionResult( + this._mockProvider3, + Provider3Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, "variant3")); + + var resolutions = new List> { result1, result2, result3 }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithDisagreeingProviders_ReturnsFirstResult() + { + // Arrange + var strategy = new ComparisonStrategy(); + var result1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var result2 = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.None, Reason.Static, "variant2")); + + var resolutions = new List> { result1, result2 }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithDisagreeingProvidersAndFallback_ReturnsFallbackResult() + { + // Arrange + var strategy = new ComparisonStrategy(this._mockProvider2); + var result1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var result2 = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.None, Reason.Static, "variant2")); + + var resolutions = new List> { result1, result2 }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.False(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal("variant2", result.Details.Variant); + Assert.Equal(this._mockProvider2, result.Provider); + Assert.Equal(Provider2Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithDisagreeingProvidersAndNonExistentFallback_ReturnsFirstResult() + { + // Arrange + var nonExistentProvider = Substitute.For(); + var strategy = new ComparisonStrategy(nonExistentProvider); + var result1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var result2 = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.None, Reason.Static, "variant2")); + + var resolutions = new List> { result1, result2 }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithDisagreeingProvidersAndOnMismatchCallback_CallsCallback() + { + // Arrange + var onMismatchCalled = false; + IDictionary? capturedMismatchDetails = null; + + var onMismatch = new Action>(details => + { + onMismatchCalled = true; + capturedMismatchDetails = details; + }); + + var strategy = new ComparisonStrategy(onMismatch: onMismatch); + var result1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var result2 = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.None, Reason.Static, "variant2")); + + var resolutions = new List> { result1, result2 }; + + // Act + strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.True(onMismatchCalled); + Assert.NotNull(capturedMismatchDetails); + Assert.Equal(2, capturedMismatchDetails.Count); + Assert.True((bool)capturedMismatchDetails[Provider1Name]); + Assert.False((bool)capturedMismatchDetails[Provider2Name]); + } + + [Fact] + public void DetermineFinalResult_WithAgreingProvidersAndOnMismatchCallback_DoesNotCallCallback() + { + // Arrange + var onMismatchCalled = false; + + var onMismatch = new Action>(_ => + { + onMismatchCalled = true; + }); + + var strategy = new ComparisonStrategy(onMismatch: onMismatch); + var result1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var result2 = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, "variant2")); + + var resolutions = new List> { result1, result2 }; + + // Act + strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.False(onMismatchCalled); + } + + [Fact] + public void DetermineFinalResult_WithMixedSuccessAndErrorResults_IgnoresErrors() + { + // Arrange + var strategy = new ComparisonStrategy(); + var successfulResult1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var errorResult = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: TestErrorMessage)); + + var successfulResult2 = new ProviderResolutionResult( + this._mockProvider3, + Provider3Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, "variant3")); + + var resolutions = new List> { successfulResult1, errorResult, successfulResult2 }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithFallbackProviderAndBothSuccessfulAndFallbackAgree_ReturnsFallbackResult() + { + // Arrange + var strategy = new ComparisonStrategy(this._mockProvider2); + var result1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var fallbackResult = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, "variant2")); + + var resolutions = new List> { result1, fallbackResult }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); // Returns first result when all agree + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithFallbackProviderHavingError_UsesFallbackWhenAvailable() + { + // Arrange + var strategy = new ComparisonStrategy(this._mockProvider1); + var result1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var errorResult = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: TestErrorMessage)); + + var result3 = new ProviderResolutionResult( + this._mockProvider3, + Provider3Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.None, Reason.Static, "variant3")); + + var resolutions = new List> { result1, errorResult, result3 }; + + // Act + var result = strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/FirstMatchStrategyTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/FirstMatchStrategyTests.cs new file mode 100644 index 000000000..de89b27bc --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/FirstMatchStrategyTests.cs @@ -0,0 +1,323 @@ +using NSubstitute; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Strategies; + +public class FirstMatchStrategyTests +{ + private const string TestFlagKey = "test-flag"; + private const bool DefaultBoolValue = false; + private const string TestVariant = "variant1"; + private const string TestErrorMessage = "Test error message"; + private const string Provider1Name = "provider1"; + private const string Provider2Name = "provider2"; + private const string MultiProviderName = "MultiProvider"; + private const string NoProvidersErrorMessage = "No providers available or all providers failed"; + + private readonly FirstMatchStrategy _strategy = new(); + private readonly FeatureProvider _mockProvider1 = Substitute.For(); + private readonly FeatureProvider _mockProvider2 = Substitute.For(); + private readonly EvaluationContext _evaluationContext = new EvaluationContextBuilder().Build(); + private readonly StrategyEvaluationContext _strategyContext = new(TestFlagKey); + + [Fact] + public void RunMode_ReturnsSequential() + { + // Act + var result = this._strategy.RunMode; + + // Assert + Assert.Equal(RunMode.Sequential, result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithFlagNotFoundError_ReturnsTrue() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var flagNotFoundResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.FlagNotFound, Reason.Error, errorMessage: "Flag not found")); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, flagNotFoundResult); + + // Assert + Assert.True(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithSuccessfulResult_ReturnsFalse() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var successfulResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, successfulResult); + + // Assert + Assert.False(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithGeneralError_ReturnsFalse() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var generalErrorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: TestErrorMessage)); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, generalErrorResult); + + // Assert + Assert.False(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithInvalidContextError_ReturnsFalse() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var invalidContextResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.InvalidContext, Reason.Error, errorMessage: "Invalid context")); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, invalidContextResult); + + // Assert + Assert.False(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithThrownException_ReturnsFalse() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var exceptionResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue), + new InvalidOperationException("Test exception")); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, exceptionResult); + + // Assert + Assert.False(result); + } + + [Fact] + public void DetermineFinalResult_WithNoProviders_ReturnsErrorResult() + { + // Arrange + var resolutions = new List>(); + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(DefaultBoolValue, result.Details.Value); + Assert.Equal(ErrorType.ProviderNotReady, result.Details.ErrorType); + Assert.Equal(Reason.Error, result.Details.Reason); + Assert.Equal(NoProvidersErrorMessage, result.Details.ErrorMessage); + Assert.Equal(MultiProviderName, result.ProviderName); + Assert.Single(result.Errors); + Assert.Equal(MultiProviderName, result.Errors[0].ProviderName); + Assert.IsType(result.Errors[0].Error); + Assert.Equal(NoProvidersErrorMessage, result.Errors[0].Error?.Message); + } + + [Fact] + public void DetermineFinalResult_WithSingleSuccessfulResult_ReturnsLastResult() + { + // Arrange + var successfulResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var resolutions = new List> { successfulResult }; + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithMultipleResults_ReturnsLastResult() + { + // Arrange + var flagNotFoundResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.FlagNotFound, Reason.Error, errorMessage: "Flag not found")); + + var successfulResult = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, TestVariant)); + + var resolutions = new List> { flagNotFoundResult, successfulResult }; + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(TestVariant, result.Details.Variant); + Assert.Equal(this._mockProvider2, result.Provider); + Assert.Equal(Provider2Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithLastResultHavingError_ReturnsLastResultWithError() + { + // Arrange + var flagNotFoundResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.FlagNotFound, Reason.Error, errorMessage: "Flag not found")); + + var generalErrorResult = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.General, Reason.Error, errorMessage: TestErrorMessage)); + + var resolutions = new List> { flagNotFoundResult, generalErrorResult }; + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(DefaultBoolValue, result.Details.Value); + Assert.Equal(ErrorType.General, result.Details.ErrorType); + Assert.Equal(Reason.Error, result.Details.Reason); + Assert.Equal(TestErrorMessage, result.Details.ErrorMessage); + Assert.Equal(this._mockProvider2, result.Provider); + Assert.Equal(Provider2Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithLastResultHavingException_ReturnsLastResultWithException() + { + // Arrange + var flagNotFoundResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue, ErrorType.FlagNotFound, Reason.Error, errorMessage: "Flag not found")); + + var exceptionResult = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, DefaultBoolValue), + new ArgumentException("Test argument exception")); + + var resolutions = new List> { flagNotFoundResult, exceptionResult }; + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(DefaultBoolValue, result.Details.Value); + Assert.Equal(this._mockProvider2, result.Provider); + Assert.Equal(Provider2Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithStringType_ReturnsCorrectType() + { + // Arrange + const string defaultStringValue = "default"; + const string testStringValue = "test-value"; + const string stringVariant = "string-variant"; + + var successfulResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, testStringValue, ErrorType.None, Reason.Static, stringVariant)); + + var resolutions = new List> { successfulResult }; + var stringStrategyContext = new StrategyEvaluationContext(TestFlagKey); + + // Act + var result = this._strategy.DetermineFinalResult(stringStrategyContext, TestFlagKey, defaultStringValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(testStringValue, result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(stringVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithIntType_ReturnsCorrectType() + { + // Arrange + const int defaultIntValue = 0; + const int testIntValue = 42; + const string intVariant = "int-variant"; + + var successfulResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, testIntValue, ErrorType.None, Reason.Static, intVariant)); + + var resolutions = new List> { successfulResult }; + var intStrategyContext = new StrategyEvaluationContext(TestFlagKey); + + // Act + var result = this._strategy.DetermineFinalResult(intStrategyContext, TestFlagKey, defaultIntValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(testIntValue, result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal(intVariant, result.Details.Variant); + Assert.Equal(this._mockProvider1, result.Provider); + Assert.Equal(Provider1Name, result.ProviderName); + Assert.Empty(result.Errors); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/FirstSuccessfulStrategyTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/FirstSuccessfulStrategyTests.cs new file mode 100644 index 000000000..687579cc2 --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/FirstSuccessfulStrategyTests.cs @@ -0,0 +1,240 @@ +using NSubstitute; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Strategies; + +public class FirstSuccessfulStrategyTests +{ + private const string TestFlagKey = "test-flag"; + private const bool DefaultBoolValue = false; + private const string Provider1Name = "provider1"; + private const string Provider2Name = "provider2"; + private const string Provider3Name = "provider3"; + private const string MultiProviderName = "MultiProvider"; + + private readonly FirstSuccessfulStrategy _strategy = new(); + private readonly FeatureProvider _mockProvider1 = Substitute.For(); + private readonly FeatureProvider _mockProvider2 = Substitute.For(); + private readonly FeatureProvider _mockProvider3 = Substitute.For(); + private readonly EvaluationContext _evaluationContext = new EvaluationContextBuilder().Build(); + private readonly StrategyEvaluationContext _strategyContext = new(TestFlagKey); + + [Fact] + public void RunMode_ReturnsSequential() + { + // Act + var result = this._strategy.RunMode; + + // Assert + Assert.Equal(RunMode.Sequential, result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithSuccessfulResult_ReturnsFalse() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var successfulResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, "variant1")); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, successfulResult); + + // Assert + Assert.False(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithErrorResult_ReturnsTrue() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.General, Reason.Error, errorMessage: "Test error")); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, errorResult); + + // Assert + Assert.True(result); + } + + [Fact] + public void ShouldEvaluateNextProvider_WithThrownException_ReturnsTrue() + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var exceptionResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, false), + new InvalidOperationException("Test exception")); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, exceptionResult); + + // Assert + Assert.True(result); + } + + [Fact] + public void DetermineFinalResult_WithNoProviders_ReturnsErrorResult() + { + // Arrange + var resolutions = new List>(); + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, DefaultBoolValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(DefaultBoolValue, result.Details.Value); + Assert.Equal(ErrorType.ProviderNotReady, result.Details.ErrorType); + Assert.Equal(Reason.Error, result.Details.Reason); + Assert.Equal("No providers available or all providers failed", result.Details.ErrorMessage); + Assert.Equal(MultiProviderName, result.ProviderName); + Assert.Single(result.Errors); + Assert.Equal(MultiProviderName, result.Errors[0].ProviderName); + Assert.IsType(result.Errors[0].Error); + } + + [Fact] + public void DetermineFinalResult_WithFirstSuccessfulResult_ReturnsFirstSuccessfulResult() + { + // Arrange + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.General, Reason.Error, errorMessage: "Error from provider1")); + + var successfulResult = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, "variant1")); + + var anotherSuccessfulResult = new ProviderResolutionResult( + this._mockProvider3, + Provider3Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.None, Reason.Static, "variant2")); + + var resolutions = new List> { errorResult, successfulResult, anotherSuccessfulResult }; + const bool defaultValue = false; + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, defaultValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + Assert.Equal(Reason.Static, result.Details.Reason); + Assert.Equal("variant1", result.Details.Variant); + Assert.Equal(this._mockProvider2, result.Provider); + Assert.Equal(Provider2Name, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void DetermineFinalResult_WithAllFailedResults_ReturnsAllErrorsCollected() + { + // Arrange + var errorResult1 = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.General, Reason.Error, errorMessage: "Error from provider1")); + + var errorResult2 = new ProviderResolutionResult( + this._mockProvider2, + Provider2Name, + new ResolutionDetails(TestFlagKey, false, ErrorType.InvalidContext, Reason.Error, errorMessage: "Error from provider2")); + + var exceptionResult = new ProviderResolutionResult( + this._mockProvider3, + Provider3Name, + new ResolutionDetails(TestFlagKey, false), + new InvalidOperationException("Exception from provider3")); + + var resolutions = new List> { errorResult1, errorResult2, exceptionResult }; + const bool defaultValue = false; + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, defaultValue, this._evaluationContext, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.Equal(defaultValue, result.Details.Value); + Assert.Equal(ErrorType.General, result.Details.ErrorType); + Assert.Equal(Reason.Error, result.Details.Reason); + Assert.Equal("All providers failed", result.Details.ErrorMessage); + Assert.Equal(MultiProviderName, result.ProviderName); + Assert.Equal(3, result.Errors.Count); + + // Verify error from provider1 + Assert.Equal(Provider1Name, result.Errors[0].ProviderName); + Assert.Equal("Error from provider1", result.Errors[0].Error?.Message); + + // Verify error from provider2 + Assert.Equal(Provider2Name, result.Errors[1].ProviderName); + Assert.Equal("Error from provider2", result.Errors[1].Error?.Message); + + // Verify exception from provider3 + Assert.Equal(Provider3Name, result.Errors[2].ProviderName); + Assert.IsType(result.Errors[2].Error); + Assert.Equal("Exception from provider3", result.Errors[2].Error?.Message); + } + + [Fact] + public void DetermineFinalResult_WithNullEvaluationContext_HandlesGracefully() + { + // Arrange + var successfulResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, true, ErrorType.None, Reason.Static, "variant1")); + + var resolutions = new List> { successfulResult }; + const bool defaultValue = false; + + // Act + var result = this._strategy.DetermineFinalResult(this._strategyContext, TestFlagKey, defaultValue, null, resolutions); + + // Assert + Assert.NotNull(result.Details); + Assert.Equal(TestFlagKey, result.Details.FlagKey); + Assert.True(result.Details.Value); + Assert.Equal(ErrorType.None, result.Details.ErrorType); + } + + [Theory] + [InlineData(ErrorType.FlagNotFound)] + [InlineData(ErrorType.ParseError)] + [InlineData(ErrorType.TypeMismatch)] + [InlineData(ErrorType.InvalidContext)] + [InlineData(ErrorType.ProviderNotReady)] + [InlineData(ErrorType.General)] + public void ShouldEvaluateNextProvider_WithDifferentErrorTypes_ReturnsTrue(ErrorType errorType) + { + // Arrange + var strategyContext = new StrategyPerProviderContext(this._mockProvider1, Provider1Name, ProviderStatus.Ready, TestFlagKey); + var errorResult = new ProviderResolutionResult( + this._mockProvider1, + Provider1Name, + new ResolutionDetails(TestFlagKey, false, errorType, Reason.Error, errorMessage: $"Error of type {errorType}")); + + // Act + var result = this._strategy.ShouldEvaluateNextProvider(strategyContext, this._evaluationContext, errorResult); + + // Assert + Assert.True(result); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/Models/FinalResultTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/Models/FinalResultTests.cs new file mode 100644 index 000000000..98b8bc87a --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/Models/FinalResultTests.cs @@ -0,0 +1,260 @@ +using NSubstitute; +using OpenFeature.Constant; +using OpenFeature.Model; +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Strategies.Models; + +public class FinalResultTests +{ + private const string TestFlagKey = "test-flag"; + private const string TestProviderName = "test-provider"; + private const string TestVariant = "test-variant"; + private const bool TestValue = true; + + private readonly FeatureProvider _mockProvider = Substitute.For(); + private readonly ResolutionDetails _testDetails = new(TestFlagKey, TestValue, ErrorType.None, Reason.Static, TestVariant); + + [Fact] + public void Constructor_WithAllParameters_CreatesFinalResult() + { + // Arrange + var errors = new List + { + new("provider1", new InvalidOperationException("Test error")) + }; + + // Act + var result = new FinalResult(this._testDetails, this._mockProvider, TestProviderName, errors); + + // Assert + Assert.Equal(this._testDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(errors, result.Errors); + Assert.Single(result.Errors); + } + + [Fact] + public void Constructor_WithNullErrors_CreatesEmptyErrorsList() + { + // Act + var result = new FinalResult(this._testDetails, this._mockProvider, TestProviderName, null); + + // Assert + Assert.Equal(this._testDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.NotNull(result.Errors); + Assert.Empty(result.Errors); + } + + [Fact] + public void Constructor_WithEmptyErrors_CreatesEmptyErrorsList() + { + // Arrange + var emptyErrors = new List(); + + // Act + var result = new FinalResult(this._testDetails, this._mockProvider, TestProviderName, emptyErrors); + + // Assert + Assert.Equal(this._testDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(emptyErrors, result.Errors); + Assert.Empty(result.Errors); + } + + [Fact] + public void Constructor_WithMultipleErrors_StoresAllErrors() + { + // Arrange + var errors = new List + { + new("provider1", new InvalidOperationException("Error 1")), + new("provider2", new ArgumentException("Error 2")), + new("provider3", null) + }; + + // Act + var result = new FinalResult(this._testDetails, this._mockProvider, TestProviderName, errors); + + // Assert + Assert.Equal(this._testDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Equal(errors, result.Errors); + Assert.Equal(3, result.Errors.Count); + } + + [Fact] + public void Constructor_WithDifferentGenericType_CreatesTypedResult() + { + // Arrange + const string stringValue = "test-string-value"; + var stringDetails = new ResolutionDetails(TestFlagKey, stringValue, ErrorType.None, Reason.Static, TestVariant); + + // Act + var result = new FinalResult(stringDetails, this._mockProvider, TestProviderName, null); + + // Assert + Assert.Equal(stringDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void Constructor_WithIntegerType_CreatesTypedResult() + { + // Arrange + const int intValue = 42; + var intDetails = new ResolutionDetails(TestFlagKey, intValue, ErrorType.None, Reason.Static, TestVariant); + + // Act + var result = new FinalResult(intDetails, this._mockProvider, TestProviderName, null); + + // Assert + Assert.Equal(intDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void Constructor_WithComplexType_CreatesTypedResult() + { + // Arrange + var complexValue = new { Name = "Test", Value = 123 }; + var complexDetails = new ResolutionDetails(TestFlagKey, complexValue, ErrorType.None, Reason.Static, TestVariant); + + // Act + var result = new FinalResult(complexDetails, this._mockProvider, TestProviderName, null); + + // Assert + Assert.Equal(complexDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void Constructor_WithErrorDetails_PreservesErrorInformation() + { + // Arrange + var errorDetails = new ResolutionDetails(TestFlagKey, false, ErrorType.ProviderNotReady, Reason.Error, errorMessage: "Provider not ready"); + var errors = new List + { + new(TestProviderName, new InvalidOperationException("Provider initialization failed")) + }; + + // Act + var result = new FinalResult(errorDetails, this._mockProvider, TestProviderName, errors); + + // Assert + Assert.Equal(errorDetails, result.Details); + Assert.Equal(ErrorType.ProviderNotReady, result.Details.ErrorType); + Assert.Equal(Reason.Error, result.Details.Reason); + Assert.Equal("Provider not ready", result.Details.ErrorMessage); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Single(result.Errors); + } + + [Fact] + public void Details_Property_HasPrivateSetter() + { + // Act & Assert + var detailsProperty = typeof(FinalResult).GetProperty(nameof(FinalResult.Details)); + Assert.NotNull(detailsProperty); + Assert.True(detailsProperty.CanRead); + Assert.True(detailsProperty.CanWrite); + Assert.True(detailsProperty.GetSetMethod(true)?.IsPrivate); + } + + [Fact] + public void Provider_Property_HasPrivateSetter() + { + // Act & Assert + var providerProperty = typeof(FinalResult).GetProperty(nameof(FinalResult.Provider)); + Assert.NotNull(providerProperty); + Assert.True(providerProperty.CanRead); + Assert.True(providerProperty.CanWrite); + Assert.True(providerProperty.GetSetMethod(true)?.IsPrivate); + } + + [Fact] + public void ProviderName_Property_HasPrivateSetter() + { + // Act & Assert + var providerNameProperty = typeof(FinalResult).GetProperty(nameof(FinalResult.ProviderName)); + Assert.NotNull(providerNameProperty); + Assert.True(providerNameProperty.CanRead); + Assert.True(providerNameProperty.CanWrite); + Assert.True(providerNameProperty.GetSetMethod(true)?.IsPrivate); + } + + [Fact] + public void Errors_Property_HasPrivateSetter() + { + // Act & Assert + var errorsProperty = typeof(FinalResult).GetProperty(nameof(FinalResult.Errors)); + Assert.NotNull(errorsProperty); + Assert.True(errorsProperty.CanRead); + Assert.True(errorsProperty.CanWrite); + Assert.True(errorsProperty.GetSetMethod(true)?.IsPrivate); + } + + [Fact] + public void Constructor_WithNullProvider_StoresNullProvider() + { + // Act + var result = new FinalResult(this._testDetails, null!, TestProviderName, null); + + // Assert + Assert.Equal(this._testDetails, result.Details); + Assert.Null(result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void Constructor_WithNullProviderName_StoresNullProviderName() + { + // Act + var result = new FinalResult(this._testDetails, this._mockProvider, null!, null); + + // Assert + Assert.Equal(this._testDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Null(result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void Constructor_WithEmptyProviderName_StoresEmptyProviderName() + { + // Act + var result = new FinalResult(this._testDetails, this._mockProvider, string.Empty, null); + + // Assert + Assert.Equal(this._testDetails, result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(string.Empty, result.ProviderName); + Assert.Empty(result.Errors); + } + + [Fact] + public void Constructor_WithNullDetails_StoresNullDetails() + { + // Act + var result = new FinalResult(null!, this._mockProvider, TestProviderName, null); + + // Assert + Assert.Null(result.Details); + Assert.Equal(this._mockProvider, result.Provider); + Assert.Equal(TestProviderName, result.ProviderName); + Assert.Empty(result.Errors); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/Models/ProviderErrorTests.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/Models/ProviderErrorTests.cs new file mode 100644 index 000000000..35c6f965b --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Strategies/Models/ProviderErrorTests.cs @@ -0,0 +1,146 @@ +using OpenFeature.Providers.MultiProvider.Strategies.Models; + +namespace OpenFeature.Providers.MultiProvider.Tests.Strategies.Models; + +public class ProviderErrorTests +{ + private const string TestProviderName = "test-provider"; + + [Fact] + public void Constructor_WithProviderNameAndException_CreatesProviderError() + { + // Arrange + var exception = new InvalidOperationException("Test exception"); + + // Act + var providerError = new ProviderError(TestProviderName, exception); + + // Assert + Assert.Equal(TestProviderName, providerError.ProviderName); + Assert.Equal(exception, providerError.Error); + } + + [Fact] + public void Constructor_WithProviderNameAndNullException_CreatesProviderError() + { + // Act + var providerError = new ProviderError(TestProviderName, null); + + // Assert + Assert.Equal(TestProviderName, providerError.ProviderName); + Assert.Null(providerError.Error); + } + + [Fact] + public void Constructor_WithNullProviderName_CreatesProviderError() + { + // Arrange + var exception = new ArgumentException("Test exception"); + + // Act + var providerError = new ProviderError(null!, exception); + + // Assert + Assert.Null(providerError.ProviderName); + Assert.Equal(exception, providerError.Error); + } + + [Fact] + public void Constructor_WithEmptyProviderName_CreatesProviderError() + { + // Arrange + var exception = new Exception("Test exception"); + + // Act + var providerError = new ProviderError(string.Empty, exception); + + // Assert + Assert.Equal(string.Empty, providerError.ProviderName); + Assert.Equal(exception, providerError.Error); + } + + [Fact] + public void Constructor_WithWhitespaceProviderName_CreatesProviderError() + { + // Arrange + const string whitespaceName = " "; + var exception = new NotSupportedException("Test exception"); + + // Act + var providerError = new ProviderError(whitespaceName, exception); + + // Assert + Assert.Equal(whitespaceName, providerError.ProviderName); + Assert.Equal(exception, providerError.Error); + } + + [Fact] + public void Constructor_WithDifferentExceptionTypes_CreatesProviderError() + { + // Arrange + var argumentException = new ArgumentException("Argument exception"); + var invalidOperationException = new InvalidOperationException("Invalid operation exception"); + var notImplementedException = new NotImplementedException("Not implemented exception"); + + // Act + var providerError1 = new ProviderError("provider1", argumentException); + var providerError2 = new ProviderError("provider2", invalidOperationException); + var providerError3 = new ProviderError("provider3", notImplementedException); + + // Assert + Assert.Equal("provider1", providerError1.ProviderName); + Assert.Equal(argumentException, providerError1.Error); + Assert.Equal("provider2", providerError2.ProviderName); + Assert.Equal(invalidOperationException, providerError2.Error); + Assert.Equal("provider3", providerError3.ProviderName); + Assert.Equal(notImplementedException, providerError3.Error); + } + + [Fact] + public void ProviderName_Property_HasPrivateSetter() + { + // Act & Assert + var providerNameProperty = typeof(ProviderError).GetProperty(nameof(ProviderError.ProviderName)); + Assert.NotNull(providerNameProperty); + Assert.True(providerNameProperty.CanRead); + Assert.True(providerNameProperty.CanWrite); + Assert.True(providerNameProperty.GetSetMethod(true)?.IsPrivate); + } + + [Fact] + public void Error_Property_HasPrivateSetter() + { + // Act & Assert + var errorProperty = typeof(ProviderError).GetProperty(nameof(ProviderError.Error)); + Assert.NotNull(errorProperty); + Assert.True(errorProperty.CanRead); + Assert.True(errorProperty.CanWrite); + Assert.True(errorProperty.GetSetMethod(true)?.IsPrivate); + } + + [Fact] + public void Constructor_WithNullProviderNameAndNullException_CreatesProviderError() + { + // Act + var providerError = new ProviderError(null!, null); + + // Assert + Assert.Null(providerError.ProviderName); + Assert.Null(providerError.Error); + } + + [Fact] + public void Constructor_WithLongProviderName_CreatesProviderError() + { + // Arrange + var longProviderName = new string('a', 1000); + var exception = new TimeoutException("Test exception"); + + // Act + var providerError = new ProviderError(longProviderName, exception); + + // Assert + Assert.Equal(longProviderName, providerError.ProviderName); + Assert.Equal(exception, providerError.Error); + } +} diff --git a/test/OpenFeature.Providers.MultiProvider.Tests/Utils/TestProvider.cs b/test/OpenFeature.Providers.MultiProvider.Tests/Utils/TestProvider.cs new file mode 100644 index 000000000..883cd6582 --- /dev/null +++ b/test/OpenFeature.Providers.MultiProvider.Tests/Utils/TestProvider.cs @@ -0,0 +1,62 @@ +using OpenFeature.Model; + +namespace OpenFeature.Providers.MultiProvider.Tests.Utils; + +/// +/// A test implementation of FeatureProvider for MultiProvider testing. +/// +public class TestProvider : FeatureProvider +{ + private readonly string _name; + private readonly Exception? _initException; + private readonly Exception? _shutdownException; + + public TestProvider(string name, Exception? initException = null, Exception? shutdownException = null) + { + this._name = name; + this._initException = initException; + this._shutdownException = shutdownException; + } + + public override Metadata GetMetadata() => new(this._name); + + public override async Task InitializeAsync(EvaluationContext context, CancellationToken cancellationToken = default) + { + if (this._initException != null) + { + throw this._initException; + } + + await Task.CompletedTask; + } + + public override async Task ShutdownAsync(CancellationToken cancellationToken = default) + { + if (this._shutdownException != null) + { + throw this._shutdownException; + } + + await Task.CompletedTask; + } + + public override Task> ResolveBooleanValueAsync(string flagKey, bool defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) => + Task.FromResult(new ResolutionDetails(flagKey, defaultValue)); + + public override Task> ResolveStringValueAsync(string flagKey, string defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) => + Task.FromResult(new ResolutionDetails(flagKey, defaultValue)); + + public override Task> ResolveIntegerValueAsync(string flagKey, int defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) => + Task.FromResult(new ResolutionDetails(flagKey, defaultValue)); + + public override Task> ResolveDoubleValueAsync(string flagKey, double defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) => + Task.FromResult(new ResolutionDetails(flagKey, defaultValue)); + + public override Task> ResolveStructureValueAsync(string flagKey, Value defaultValue, + EvaluationContext? context = null, CancellationToken cancellationToken = default) => + Task.FromResult(new ResolutionDetails(flagKey, defaultValue)); +} diff --git a/test/OpenFeature.Tests/EnumExtensionsTests.cs b/test/OpenFeature.Tests/EnumExtensionsTests.cs new file mode 100644 index 000000000..35e61a2e0 --- /dev/null +++ b/test/OpenFeature.Tests/EnumExtensionsTests.cs @@ -0,0 +1,26 @@ +using OpenFeature.Constant; +using OpenFeature.Extension; + +namespace OpenFeature.Tests; + +public class EnumExtensionsTests +{ + [Theory] + [InlineData(ErrorType.None, "NONE")] + [InlineData(ErrorType.ProviderNotReady, "PROVIDER_NOT_READY")] + [InlineData(ErrorType.FlagNotFound, "FLAG_NOT_FOUND")] + [InlineData(ErrorType.ParseError, "PARSE_ERROR")] + [InlineData(ErrorType.TypeMismatch, "TYPE_MISMATCH")] + [InlineData(ErrorType.General, "GENERAL")] + [InlineData(ErrorType.InvalidContext, "INVALID_CONTEXT")] + [InlineData(ErrorType.TargetingKeyMissing, "TARGETING_KEY_MISSING")] + [InlineData(ErrorType.ProviderFatal, "PROVIDER_FATAL")] + public void GetDescription_WithErrorType_ReturnsExpectedDescription(ErrorType errorType, string expectedDescription) + { + // Act + var result = errorType.GetDescription(); + + // Assert + Assert.Equal(expectedDescription, result); + } +} diff --git a/test/OpenFeature.Tests/Hooks/MetricsHookOptionsTests.cs b/test/OpenFeature.Tests/Hooks/MetricsHookOptionsTests.cs new file mode 100644 index 000000000..89f0f56d7 --- /dev/null +++ b/test/OpenFeature.Tests/Hooks/MetricsHookOptionsTests.cs @@ -0,0 +1,84 @@ +using OpenFeature.Hooks; +using OpenFeature.Model; + +namespace OpenFeature.Tests.Hooks; + +public class MetricsHookOptionsTests +{ + [Fact] + public void Default_Options_Should_Be_Initialized_Correctly() + { + // Arrange & Act + var options = MetricsHookOptions.Default; + + // Assert + Assert.NotNull(options); + Assert.Empty(options.CustomDimensions); + Assert.Empty(options.FlagMetadataCallbacks); + } + + [Fact] + public void CreateBuilder_Should_Return_New_Builder_Instance() + { + // Arrange & Act + var builder = MetricsHookOptions.CreateBuilder(); + + // Assert + Assert.NotNull(builder); + Assert.IsType(builder); + } + + [Fact] + public void Build_Should_Return_Options() + { + // Arrange + var builder = MetricsHookOptions.CreateBuilder(); + + // Act + var options = builder.Build(); + + // Assert + Assert.NotNull(options); + Assert.IsType(options); + } + + [Theory] + [InlineData("custom_dimension_value")] + [InlineData(1.0)] + [InlineData(2025)] + [InlineData(null)] + [InlineData(true)] + public void Builder_Should_Allow_Adding_Custom_Dimensions(object? value) + { + // Arrange + var builder = MetricsHookOptions.CreateBuilder(); + var key = "custom_dimension_key"; + + // Act + builder.WithCustomDimension(key, value); + var options = builder.Build(); + + // Assert + Assert.Single(options.CustomDimensions); + Assert.Equal(key, options.CustomDimensions.First().Key); + Assert.Equal(value, options.CustomDimensions.First().Value); + } + + [Fact] + public void Builder_Should_Allow_Adding_Flag_Metadata_Expressions() + { + // Arrange + var builder = MetricsHookOptions.CreateBuilder(); + var key = "flag_metadata_key"; + static object? expression(ImmutableMetadata m) => m.GetString("flag_metadata_key"); + + // Act + builder.WithFlagEvaluationMetadata(key, expression); + var options = builder.Build(); + + // Assert + Assert.Single(options.FlagMetadataCallbacks); + Assert.Equal(key, options.FlagMetadataCallbacks.First().Key); + Assert.Equal(expression, options.FlagMetadataCallbacks.First().Value); + } +} diff --git a/test/OpenFeature.Tests/Hooks/MetricsHookTests.cs b/test/OpenFeature.Tests/Hooks/MetricsHookTests.cs new file mode 100644 index 000000000..f1c3be3ad --- /dev/null +++ b/test/OpenFeature.Tests/Hooks/MetricsHookTests.cs @@ -0,0 +1,342 @@ +using Microsoft.Extensions.Diagnostics.Metrics.Testing; +using OpenFeature.Hooks; +using OpenFeature.Model; + +namespace OpenFeature.Tests.Hooks; + +[CollectionDefinition(nameof(MetricsHookTest), DisableParallelization = true)] +public class MetricsHookTest +{ + [Fact] + public async Task After_Test() + { + // Arrange + var metricsHook = new MetricsHook(); + + using var collector = new MetricCollector(metricsHook._evaluationSuccessCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + // Act + await metricsHook.AfterAsync(ctx, + new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default"), + new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal("STATIC", measurements.Tags["feature_flag.result.reason"]); + } + + [Fact] + public async Task Without_Reason_After_Test_Defaults_To_Unknown() + { + // Arrange + var metricsHook = new MetricsHook(); + + using var collector = new MetricCollector(metricsHook._evaluationSuccessCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + // Act + await metricsHook.AfterAsync(ctx, + new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, reason: null, "default"), + new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal("UNKNOWN", measurements.Tags["feature_flag.result.reason"]); + } + + [Fact] + public async Task With_CustomDimensions_After_Test() + { + // Arrange + var metricHookOptions = MetricsHookOptions.CreateBuilder() + .WithCustomDimension("custom_dimension_key", "custom_dimension_value") + .Build(); + + var metricsHook = new MetricsHook(metricHookOptions); + + using var collector = new MetricCollector(metricsHook._evaluationSuccessCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + // Act + await metricsHook.AfterAsync(ctx, + new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default"), + new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal(1, measurements.Value); + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal("STATIC", measurements.Tags["feature_flag.result.reason"]); + Assert.Equal("custom_dimension_value", measurements.Tags["custom_dimension_key"]); + } + + [Fact] + public async Task With_FlagMetadataCallback_After_Test() + { + // Arrange + var metricHookOptions = MetricsHookOptions.CreateBuilder() + .WithFlagEvaluationMetadata("bool", m => m.GetBool("bool")) + .Build(); + + var metricsHook = new MetricsHook(metricHookOptions); + + using var collector = new MetricCollector(metricsHook._evaluationSuccessCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + var flagMetadata = new ImmutableMetadata(new Dictionary + { + { "bool", true } + }); + + // Act + await metricsHook.AfterAsync(ctx, + new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default", errorMessage: null, flagMetadata), + new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal("STATIC", measurements.Tags["feature_flag.result.reason"]); + Assert.Equal(true, measurements.Tags["bool"]); + } + + [Fact] + public async Task Error_Test() + { + // Arrange + var metricsHook = new MetricsHook(); + + using var collector = new MetricCollector(metricsHook._evaluationErrorCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + var errorMessage = "An error occurred during evaluation"; + + // Act + await metricsHook.ErrorAsync(ctx, new Exception(errorMessage), new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal(errorMessage, measurements.Tags["exception"]); + } + + [Fact] + public async Task With_CustomDimensions_Error_Test() + { + // Arrange + var metricHookOptions = MetricsHookOptions.CreateBuilder() + .WithCustomDimension("custom_dimension_key", "custom_dimension_value") + .Build(); + + var metricsHook = new MetricsHook(metricHookOptions); + + using var collector = new MetricCollector(metricsHook._evaluationErrorCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + var errorMessage = "An error occurred during evaluation"; + + // Act + await metricsHook.ErrorAsync(ctx, new Exception(errorMessage), new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal(errorMessage, measurements.Tags["exception"]); + Assert.Equal("custom_dimension_value", measurements.Tags["custom_dimension_key"]); + } + + [Fact] + public async Task Finally_Test() + { + // Arrange + var metricsHook = new MetricsHook(); + + using var collector = new MetricCollector(metricsHook._evaluationActiveUpDownCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + var evaluationDetails = new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default"); + + // Act + await metricsHook.FinallyAsync(ctx, evaluationDetails, new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal(-1, measurements.Value); + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + } + + [Fact] + public async Task With_CustomDimensions_Finally_Test() + { + // Arrange + var metricHookOptions = MetricsHookOptions.CreateBuilder() + .WithCustomDimension("custom_dimension_key", "custom_dimension_value") + .Build(); + + var metricsHook = new MetricsHook(metricHookOptions); + + using var collector = new MetricCollector(metricsHook._evaluationActiveUpDownCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + var evaluationDetails = new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default"); + + // Act + await metricsHook.FinallyAsync(ctx, evaluationDetails, new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal(-1, measurements.Value); + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal("custom_dimension_value", measurements.Tags["custom_dimension_key"]); + } + + [Fact] + public async Task With_FlagMetadataCallback_Finally_Test() + { + // Arrange + var metricHookOptions = MetricsHookOptions.CreateBuilder() + .WithFlagEvaluationMetadata("status_code", m => m.GetInt("status_code")) + .Build(); + + var metricsHook = new MetricsHook(metricHookOptions); + + using var collector = new MetricCollector(metricsHook._evaluationActiveUpDownCounter); + + var flagMetadata = new ImmutableMetadata(new Dictionary + { + { "status_code", 1521 } + }); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + var evaluationDetails = new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default", flagMetadata: flagMetadata); + + // Act + await metricsHook.FinallyAsync(ctx, evaluationDetails, new Dictionary()).ConfigureAwait(true); + + var measurements = collector.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal(-1, measurements.Value); + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal(1521, measurements.Tags["status_code"]); + } + + [Fact] + public async Task Before_Test() + { + // Arrange + var metricsHook = new MetricsHook(); + + using var collector1 = new MetricCollector(metricsHook._evaluationActiveUpDownCounter); + using var collector2 = new MetricCollector(metricsHook._evaluationRequestCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + // Act + await metricsHook.BeforeAsync(ctx, new Dictionary()).ConfigureAwait(true); + + var measurements = collector1.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal(1, measurements.Value); + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + } + + [Fact] + public async Task With_CustomDimensions_Before_Test() + { + // Arrange + var metricHookOptions = MetricsHookOptions.CreateBuilder() + .WithCustomDimension("custom_dimension_key", "custom_dimension_value") + .Build(); + + var metricsHook = new MetricsHook(metricHookOptions); + + using var collector1 = new MetricCollector(metricsHook._evaluationActiveUpDownCounter); + using var collector2 = new MetricCollector(metricsHook._evaluationRequestCounter); + + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + // Act + await metricsHook.BeforeAsync(ctx, new Dictionary()).ConfigureAwait(true); + + var measurements = collector1.LastMeasurement; + + // Assert + Assert.NotNull(measurements); + + Assert.Equal(1, measurements.Value); + Assert.Equal("my-flag", measurements.Tags["feature_flag.key"]); + Assert.Equal("my-provider", measurements.Tags["feature_flag.provider.name"]); + Assert.Equal("custom_dimension_value", measurements.Tags["custom_dimension_key"]); + } +} diff --git a/test/OpenFeature.Tests/Hooks/TraceEnricherHookOptionsTests.cs b/test/OpenFeature.Tests/Hooks/TraceEnricherHookOptionsTests.cs new file mode 100644 index 000000000..003102a72 --- /dev/null +++ b/test/OpenFeature.Tests/Hooks/TraceEnricherHookOptionsTests.cs @@ -0,0 +1,84 @@ +using OpenFeature.Hooks; +using OpenFeature.Model; + +namespace OpenFeature.Tests.Hooks; + +public class TraceEnricherHookOptionsTests +{ + [Fact] + public void Default_Options_Should_Be_Initialized_Correctly() + { + // Arrange & Act + var options = TraceEnricherHookOptions.Default; + + // Assert + Assert.NotNull(options); + Assert.Empty(options.Tags); + Assert.Empty(options.FlagMetadataCallbacks); + } + + [Fact] + public void CreateBuilder_Should_Return_New_Builder_Instance() + { + // Arrange & Act + var builder = TraceEnricherHookOptions.CreateBuilder(); + + // Assert + Assert.NotNull(builder); + Assert.IsType(builder); + } + + [Fact] + public void Build_Should_Return_Options() + { + // Arrange + var builder = TraceEnricherHookOptions.CreateBuilder(); + + // Act + var options = builder.Build(); + + // Assert + Assert.NotNull(options); + Assert.IsType(options); + } + + [Theory] + [InlineData("custom_dimension_value")] + [InlineData(1.0)] + [InlineData(2025)] + [InlineData(null)] + [InlineData(true)] + public void Builder_Should_Allow_Adding_Custom_Dimensions(object? value) + { + // Arrange + var builder = TraceEnricherHookOptions.CreateBuilder(); + var key = "custom_dimension_key"; + + // Act + builder.WithTag(key, value); + var options = builder.Build(); + + // Assert + Assert.Single(options.Tags); + Assert.Equal(key, options.Tags.First().Key); + Assert.Equal(value, options.Tags.First().Value); + } + + [Fact] + public void Builder_Should_Allow_Adding_Flag_Metadata_Expressions() + { + // Arrange + var builder = TraceEnricherHookOptions.CreateBuilder(); + var key = "flag_metadata_key"; + static object? expression(ImmutableMetadata m) => m.GetString("flag_metadata_key"); + + // Act + builder.WithFlagEvaluationMetadata(key, expression); + var options = builder.Build(); + + // Assert + Assert.Single(options.FlagMetadataCallbacks); + Assert.Equal(key, options.FlagMetadataCallbacks.First().Key); + Assert.Equal(expression, options.FlagMetadataCallbacks.First().Value); + } +} diff --git a/test/OpenFeature.Tests/Hooks/TraceEnricherHookTests.cs b/test/OpenFeature.Tests/Hooks/TraceEnricherHookTests.cs new file mode 100644 index 000000000..5f0b617d3 --- /dev/null +++ b/test/OpenFeature.Tests/Hooks/TraceEnricherHookTests.cs @@ -0,0 +1,169 @@ +using System.Diagnostics; +using OpenFeature.Hooks; +using OpenFeature.Model; +using OpenTelemetry; +using OpenTelemetry.Resources; +using OpenTelemetry.Trace; + +namespace OpenFeature.Tests.Hooks; + +[CollectionDefinition(nameof(TraceEnricherHookTests), DisableParallelization = true)] +public class TraceEnricherHookTests : IDisposable +{ + private readonly List _exportedItems; + private readonly TracerProvider _tracerProvider; + private readonly Tracer _tracer; + + public TraceEnricherHookTests() + { + // List that will be populated with the traces by InMemoryExporter + this._exportedItems = []; + + // Create a new in-memory exporter + this._tracerProvider = Sdk.CreateTracerProviderBuilder() + .AddSource("my-tracer") + .ConfigureResource(r => r.AddService("in-memory-test")) + .AddInMemoryExporter(this._exportedItems) + .Build(); + + this._tracer = this._tracerProvider.GetTracer("my-tracer"); + } + +#pragma warning disable CA1816 + public void Dispose() + { + this._tracerProvider.Shutdown(); + } +#pragma warning restore CA1816 + + [Fact] + public async Task TestFinally() + { + // Arrange + var traceEnricherHook = new TraceEnricherHook(); + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + // Act + var span = this._tracer.StartActiveSpan("my-span"); + await traceEnricherHook.FinallyAsync(ctx, + new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default"), + new Dictionary()).ConfigureAwait(true); + span.End(); + + this._tracerProvider.ForceFlush(); + + // Assert + Assert.Single(this._exportedItems); + var rootSpan = this._exportedItems.First(); + + Assert.Single(rootSpan.Events); + ActivityEvent ev = rootSpan.Events.First(); + Assert.Equal("feature_flag.evaluation", ev.Name); + + Assert.Contains(new KeyValuePair("feature_flag.key", "my-flag"), ev.Tags); + Assert.Contains(new KeyValuePair("feature_flag.result.variant", "default"), ev.Tags); + Assert.Contains(new KeyValuePair("feature_flag.provider.name", "my-provider"), ev.Tags); + Assert.Contains(new KeyValuePair("feature_flag.result.reason", "static"), ev.Tags); + Assert.Contains(new KeyValuePair("feature_flag.result.value", "foo"), ev.Tags); + } + + [Fact] + public async Task TestFinally_WithCustomDimension() + { + // Arrange + var traceHookOptions = TraceEnricherHookOptions.CreateBuilder() + .WithTag("custom_dimension_key", "custom_dimension_value") + .Build(); + var traceEnricherHook = new TraceEnricherHook(traceHookOptions); + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + // Act + var span = this._tracer.StartActiveSpan("my-span"); + await traceEnricherHook.FinallyAsync(ctx, + new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default"), + new Dictionary()).ConfigureAwait(true); + span.End(); + + this._tracerProvider.ForceFlush(); + + // Assert + Assert.Single(this._exportedItems); + var rootSpan = this._exportedItems.First(); + + Assert.Single(rootSpan.Events); + ActivityEvent ev = rootSpan.Events.First(); + Assert.Equal("feature_flag.evaluation", ev.Name); + + Assert.Contains(new KeyValuePair("custom_dimension_key", "custom_dimension_value"), ev.Tags); + } + + [Fact] + public async Task TestFinally_WithFlagEvaluationMetadata() + { + // Arrange + var traceHookOptions = TraceEnricherHookOptions.CreateBuilder() + .WithFlagEvaluationMetadata("double", metadata => metadata.GetDouble("double")) + .WithFlagEvaluationMetadata("int", metadata => metadata.GetInt("int")) + .WithFlagEvaluationMetadata("bool", metadata => metadata.GetBool("bool")) + .WithFlagEvaluationMetadata("string", metadata => metadata.GetString("string")) + .Build(); + var traceEnricherHook = new TraceEnricherHook(traceHookOptions); + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + var flagMetadata = new ImmutableMetadata(new Dictionary + { + { "double", 1.0 }, + { "int", 2025 }, + { "bool", true }, + { "string", "foo" } + }); + + // Act + var span = this._tracer.StartActiveSpan("my-span"); + await traceEnricherHook.FinallyAsync(ctx, + new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default", flagMetadata: flagMetadata), + new Dictionary()).ConfigureAwait(true); + span.End(); + + this._tracerProvider.ForceFlush(); + + // Assert + Assert.Single(this._exportedItems); + var rootSpan = this._exportedItems.First(); + + Assert.Single(rootSpan.Events); + ActivityEvent ev = rootSpan.Events.First(); + Assert.Equal("feature_flag.evaluation", ev.Name); + + Assert.Contains(new KeyValuePair("double", 1.0), ev.Tags); + Assert.Contains(new KeyValuePair("int", 2025), ev.Tags); + Assert.Contains(new KeyValuePair("bool", true), ev.Tags); + Assert.Contains(new KeyValuePair("string", "foo"), ev.Tags); + } + + [Fact] + public async Task TestFinally_NoSpan() + { + // Arrange + var traceEnricherHook = new TraceEnricherHook(); + var evaluationContext = EvaluationContext.Empty; + var ctx = new HookContext("my-flag", "foo", Constant.FlagValueType.String, + new ClientMetadata("my-client", "1.0"), new Metadata("my-provider"), evaluationContext); + + // Act + await traceEnricherHook.FinallyAsync(ctx, + new FlagEvaluationDetails("my-flag", "foo", Constant.ErrorType.None, "STATIC", "default"), + new Dictionary()).ConfigureAwait(true); + + this._tracerProvider.ForceFlush(); + + // Assert + Assert.Empty(this._exportedItems); + } +} diff --git a/test/OpenFeature.Tests/ImmutableMetadataTest.cs b/test/OpenFeature.Tests/ImmutableMetadataTest.cs index e1324a054..7f3cf3b46 100644 --- a/test/OpenFeature.Tests/ImmutableMetadataTest.cs +++ b/test/OpenFeature.Tests/ImmutableMetadataTest.cs @@ -100,6 +100,28 @@ public void GetInt_Should_Return_Value_If_Key_Found() Assert.NotNull(result); Assert.Equal(1, result); } + [Fact] + [Specification("1.4.14", + "If the `flag metadata` field in the `flag resolution` structure returned by the configured `provider` is set, the `evaluation details` structure's `flag metadata` field MUST contain that value. Otherwise, it MUST contain an empty record.")] + [Specification("1.4.14.1", "Condition: `Flag metadata` MUST be immutable.")] + public void GetInt_Should_Return_Value_If_Key_Found_although_double() + { + // Arrange + var metadata = new Dictionary + { + { + "intKey", 1.0 + } + }; + var flagMetadata = new ImmutableMetadata(metadata); + + // Act + var result = flagMetadata.GetInt("intKey"); + + // Assert + Assert.NotNull(result); + Assert.Equal(1, result); + } [Fact] [Specification("1.4.14", @@ -160,6 +182,29 @@ public void GetDouble_Should_Return_Value_If_Key_Found() Assert.Equal(1.2, result); } + [Fact] + [Specification("1.4.14", + "If the `flag metadata` field in the `flag resolution` structure returned by the configured `provider` is set, the `evaluation details` structure's `flag metadata` field MUST contain that value. Otherwise, it MUST contain an empty record.")] + [Specification("1.4.14.1", "Condition: `Flag metadata` MUST be immutable.")] + public void GetDouble_Should_Return_Value_If_Key_Found_Although_Int() + { + // Arrange + var metadata = new Dictionary + { + { + "doubleKey", 1 + } + }; + var flagMetadata = new ImmutableMetadata(metadata); + + // Act + var result = flagMetadata.GetDouble("doubleKey"); + + // Assert + Assert.NotNull(result); + Assert.Equal(1.0, result); + } + [Fact] [Specification("1.4.14", "If the `flag metadata` field in the `flag resolution` structure returned by the configured `provider` is set, the `evaluation details` structure's `flag metadata` field MUST contain that value. Otherwise, it MUST contain an empty record.")] diff --git a/test/OpenFeature.Tests/OpenFeature.Tests.csproj b/test/OpenFeature.Tests/OpenFeature.Tests.csproj index a556655a4..8abb4891f 100644 --- a/test/OpenFeature.Tests/OpenFeature.Tests.csproj +++ b/test/OpenFeature.Tests/OpenFeature.Tests.csproj @@ -19,6 +19,8 @@ + + runtime; build; native; contentfiles; analyzers; buildtransitive diff --git a/test/OpenFeature.Tests/OpenFeatureClientTests.cs b/test/OpenFeature.Tests/OpenFeatureClientTests.cs index cbecddc28..9ea3f0dc7 100644 --- a/test/OpenFeature.Tests/OpenFeatureClientTests.cs +++ b/test/OpenFeature.Tests/OpenFeatureClientTests.cs @@ -597,6 +597,21 @@ public async Task PassingABlankStringAsTrackingEventName_ThrowsArgumentException Assert.Throws(() => client.Track(" \n ")); } + [Theory] + [InlineData(null)] + [InlineData("")] + [InlineData(" ")] + public async Task PassingBlankClientName_DoesNotThrowArgumentNullException(string? clientName) + { + var provider = new TestProvider(); + await Api.Instance.SetProviderAsync(provider); + var client = Api.Instance.GetClient(clientName); + + var ex = Record.Exception(() => client.AddHandler(ProviderEventTypes.ProviderReady, (args) => { })); + + Assert.Null(ex); + } + public static TheoryData GenerateMergeEvaluationContextTestData() { const string key = "key"; diff --git a/test/OpenFeature.Tests/StructureTests.cs b/test/OpenFeature.Tests/StructureTests.cs index b2b4e1c0f..9412e5d33 100644 --- a/test/OpenFeature.Tests/StructureTests.cs +++ b/test/OpenFeature.Tests/StructureTests.cs @@ -1,4 +1,7 @@ using System.Collections.Immutable; +using System.Text.Json; +using System.Text.Json.Nodes; +using System.Text.Json.Serialization; using OpenFeature.Model; namespace OpenFeature.Tests; @@ -113,4 +116,91 @@ public void GetEnumerator_Should_Return_Enumerator() enumerator.MoveNext(); Assert.Equal(VAL, enumerator.Current.Value.AsString); } + + [Theory] + [MemberData(nameof(JsonSerializeTestData))] + public void JsonSerializeTest(Value value, string expectedJson) + { + var serializedJsonNode = JsonSerializer.SerializeToNode(value); + var expectJsonNode = JsonNode.Parse(expectedJson); + Assert.True(JsonNode.DeepEquals(expectJsonNode, serializedJsonNode)); + } + + [Theory] + [MemberData(nameof(JsonSerializeTestData))] + public void JsonSerializeWithGeneratorTest(Value value, string expectedJson) + { + var serializedJsonNode = JsonSerializer.SerializeToNode(value, ValueJsonSerializerContext.Default.Value); + var expectJsonNode = JsonNode.Parse(expectedJson); + Assert.True(JsonNode.DeepEquals(expectJsonNode, serializedJsonNode)); + } + + [Theory] + [MemberData(nameof(JsonSerializeTestData))] + public void JsonDeserializeTest(Value value, string expectedJson) + { + var serializedJsonNode = JsonSerializer.SerializeToNode(value); + var expectValue = JsonSerializer.Deserialize(expectedJson); + var expectJsonNode = JsonSerializer.SerializeToNode(expectValue); + Assert.True(JsonNode.DeepEquals(expectJsonNode, serializedJsonNode)); + } + + [Theory] + [MemberData(nameof(JsonSerializeTestData))] + public void JsonDeserializeWithGeneratorTest(Value value, string expectedJson) + { + var serializedJsonNode = JsonSerializer.SerializeToNode(value, ValueJsonSerializerContext.Default.Value); + var expectValue = JsonSerializer.Deserialize(expectedJson, ValueJsonSerializerContext.Default.Value); + Assert.NotNull(expectValue); + var expectJsonNode = JsonSerializer.SerializeToNode(expectValue, ValueJsonSerializerContext.Default.Value); + Assert.True(JsonNode.DeepEquals(expectJsonNode, serializedJsonNode)); + } + + public static IEnumerable JsonSerializeTestData() + { + yield return [new Value("test"), "\"test\""]; + yield return [new Value(1), "1"]; + yield return [new Value(1.2), "1.2"]; + yield return [new Value(int.MaxValue + 1.0), "2147483648"]; + yield return [new Value(true), "true"]; + yield return [new Value(false), "false"]; + yield return + [ + new Value(Structure.Builder() + .Set("name", "Alice") + .Set("age", 16) + .Set("isMale", false) + .Set("bio", new Value()) + .Set("bornAt", new DateTime(2000, 1, 1)) + .Set("tags", new Value([new Value("girl"), new Value("beauty")])) + .Set("job", Structure.Builder() + .Set("title", "Software Engineer") + .Set("grade", "Senior") + .Build()) + .Build() + ), + """ + { + "name": "Alice", + "age": 16, + "isMale": false, + "bio": null, + "bornAt": "2000-01-01T00:00:00", + "tags": [ + "girl", + "beauty" + ], + "job": { + "title": "Software Engineer", + "grade": "Senior" + } + } + """ + ]; + } +} + +[JsonSerializable(typeof(Value))] +public partial class ValueJsonSerializerContext : JsonSerializerContext +{ } diff --git a/test/OpenFeature.Tests/Telemetry/EvaluationEventBuilderTests.cs b/test/OpenFeature.Tests/Telemetry/EvaluationEventBuilderTests.cs index 8bebd3f5d..79e31df08 100644 --- a/test/OpenFeature.Tests/Telemetry/EvaluationEventBuilderTests.cs +++ b/test/OpenFeature.Tests/Telemetry/EvaluationEventBuilderTests.cs @@ -6,8 +6,6 @@ namespace OpenFeature.Tests.Telemetry; public class EvaluationEventBuilderTests { - private readonly EvaluationEventBuilder _builder = EvaluationEventBuilder.Default; - [Fact] public void Build_ShouldReturnEventWithCorrectAttributes() { @@ -25,7 +23,7 @@ public void Build_ShouldReturnEventWithCorrectAttributes() reason: "reason", variant: "variant", flagMetadata: flagMetadata); // Act - var evaluationEvent = _builder.Build(hookContext, details); + var evaluationEvent = EvaluationEventBuilder.Build(hookContext, details); // Assert Assert.Equal("feature_flag.evaluation", evaluationEvent.Name); @@ -55,7 +53,7 @@ public void Build_ShouldHandleErrorDetails() errorMessage: "errorMessage", reason: "reason", variant: "variant", flagMetadata: flagMetadata); // Act - var evaluationEvent = _builder.Build(hookContext, details); + var evaluationEvent = EvaluationEventBuilder.Build(hookContext, details); // Assert Assert.Equal("general", evaluationEvent.Attributes[TelemetryConstants.ErrorCode]); @@ -79,7 +77,7 @@ public void Build_ShouldHandleMissingVariant() reason: "reason", variant: null, flagMetadata: flagMetadata); // Act - var evaluationEvent = _builder.Build(hookContext, details); + var evaluationEvent = EvaluationEventBuilder.Build(hookContext, details); // Assert Assert.Null(evaluationEvent.Attributes[TelemetryConstants.Variant]); @@ -98,7 +96,7 @@ public void Build_ShouldHandleMissingFlagMetadata() reason: "reason", variant: "", flagMetadata: flagMetadata); // Act - var evaluationEvent = _builder.Build(hookContext, details); + var evaluationEvent = EvaluationEventBuilder.Build(hookContext, details); // Assert Assert.Null(evaluationEvent.Attributes[TelemetryConstants.ContextId]); @@ -122,7 +120,7 @@ public void Build_ShouldHandleMissingReason(string? reason) reason: reason, variant: "", flagMetadata: flagMetadata); // Act - var evaluationEvent = _builder.Build(hookContext, details); + var evaluationEvent = EvaluationEventBuilder.Build(hookContext, details); // Assert Assert.Equal(Reason.Unknown.ToLowerInvariant(), evaluationEvent.Attributes[TelemetryConstants.Reason]); @@ -144,7 +142,7 @@ public void Build_ShouldHandleErrorWithEmptyErrorMessage(string? errorMessage) errorMessage: errorMessage, reason: "reason", variant: "", flagMetadata: flagMetadata); // Act - var evaluationEvent = _builder.Build(hookContext, details); + var evaluationEvent = EvaluationEventBuilder.Build(hookContext, details); // Assert Assert.Equal("general", evaluationEvent.Attributes[TelemetryConstants.ErrorCode]); @@ -164,7 +162,7 @@ public void Build_ShouldIncludeValueAttributeInEvent() reason: "reason", variant: "variant", flagMetadata: new ImmutableMetadata()); // Act - var evaluationEvent = _builder.Build(hookContext, details); + var evaluationEvent = EvaluationEventBuilder.Build(hookContext, details); // Assert Assert.Equal(testValue, evaluationEvent.Attributes[TelemetryConstants.Value]); diff --git a/test/OpenFeature.Tests/ValueTests.cs b/test/OpenFeature.Tests/ValueTests.cs index da76f29ad..9f94b5eaf 100644 --- a/test/OpenFeature.Tests/ValueTests.cs +++ b/test/OpenFeature.Tests/ValueTests.cs @@ -230,4 +230,561 @@ public void AsDateTime_WhenCalledWithNonDateTimeInnerValue_ReturnsNull() // Assert Assert.Null(actualValue); } + + #region Equality Tests + + [Fact] + public void Equals_WithNullValue_ReturnsFalse() + { + // Arrange + var value = new Value("test"); + + // Act & Assert + Assert.False(value.Equals(null)); + } + + [Fact] + public void Equals_WithSameReference_ReturnsTrue() + { + // Arrange + var value = new Value("test"); + + // Act & Assert + Assert.True(value.Equals(value)); + } + + [Fact] + public void Equals_WithBothNull_ReturnsTrue() + { + // Arrange + var value1 = new Value(); + var value2 = new Value(); + + // Act & Assert + Assert.True(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithOneNullOneNotNull_ReturnsFalse() + { + // Arrange + var nullValue = new Value(); + var stringValue = new Value("test"); + + // Act & Assert + Assert.False(nullValue.Equals(stringValue)); + Assert.False(stringValue.Equals(nullValue)); + } + + [Fact] + public void Equals_WithDifferentTypes_ReturnsFalse() + { + // Arrange + var stringValue = new Value("test"); + var intValue = new Value(42); + var boolValue = new Value(true); + + // Act & Assert + Assert.False(stringValue.Equals(intValue)); + Assert.False(stringValue.Equals(boolValue)); + Assert.False(intValue.Equals(boolValue)); + } + + [Fact] + public void Equals_WithSameStringValues_ReturnsTrue() + { + // Arrange + var value1 = new Value("test"); + var value2 = new Value("test"); + + // Act & Assert + Assert.True(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithDifferentStringValues_ReturnsFalse() + { + // Arrange + var value1 = new Value("test1"); + var value2 = new Value("test2"); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithSameBooleanValues_ReturnsTrue() + { + // Arrange + var value1 = new Value(true); + var value2 = new Value(true); + var value3 = new Value(false); + var value4 = new Value(false); + + // Act & Assert + Assert.True(value1.Equals(value2)); + Assert.True(value3.Equals(value4)); + } + + [Fact] + public void Equals_WithDifferentBooleanValues_ReturnsFalse() + { + // Arrange + var value1 = new Value(true); + var value2 = new Value(false); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithSameNumberValues_ReturnsTrue() + { + // Arrange + var value1 = new Value(42.5); + var value2 = new Value(42.5); + var intValue1 = new Value(42); + var intValue2 = new Value(42); + + // Act & Assert + Assert.True(value1.Equals(value2)); + Assert.True(intValue1.Equals(intValue2)); + } + + [Fact] + public void Equals_WithDifferentNumberValues_ReturnsFalse() + { + // Arrange + var value1 = new Value(42.5); + var value2 = new Value(42.6); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithSameDateTimeValues_ReturnsTrue() + { + // Arrange + var dateTime = DateTime.Now; + var value1 = new Value(dateTime); + var value2 = new Value(dateTime); + + // Act & Assert + Assert.True(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithDifferentDateTimeValues_ReturnsFalse() + { + // Arrange + var value1 = new Value(DateTime.Now); + var value2 = new Value(DateTime.Now.AddDays(1)); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithSameStructureValues_ReturnsTrue() + { + // Arrange + var structure1 = Structure.Builder() + .Set("key1", new Value("value1")) + .Set("key2", new Value(42)) + .Build(); + var structure2 = Structure.Builder() + .Set("key1", new Value("value1")) + .Set("key2", new Value(42)) + .Build(); + var value1 = new Value(structure1); + var value2 = new Value(structure2); + + // Act & Assert + Assert.True(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithDifferentStructureValues_ReturnsFalse() + { + // Arrange + var structure1 = Structure.Builder() + .Set("key1", new Value("value1")) + .Build(); + var structure2 = Structure.Builder() + .Set("key1", new Value("value2")) + .Build(); + var value1 = new Value(structure1); + var value2 = new Value(structure2); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithStructuresDifferentKeyCounts_ReturnsFalse() + { + // Arrange + var structure1 = Structure.Builder() + .Set("key1", new Value("value1")) + .Build(); + var structure2 = Structure.Builder() + .Set("key1", new Value("value1")) + .Set("key2", new Value("value2")) + .Build(); + var value1 = new Value(structure1); + var value2 = new Value(structure2); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithSameListValues_ReturnsTrue() + { + // Arrange + var list1 = new List { new("test"), new(42), new(true) }; + var list2 = new List { new("test"), new(42), new(true) }; + var value1 = new Value(list1); + var value2 = new Value(list2); + + // Act & Assert + Assert.True(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithDifferentListValues_ReturnsFalse() + { + // Arrange + var list1 = new List { new("test1"), new(42) }; + var list2 = new List { new("test2"), new(42) }; + var value1 = new Value(list1); + var value2 = new Value(list2); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithListsDifferentLengths_ReturnsFalse() + { + // Arrange + var list1 = new List { new("test") }; + var list2 = new List { new("test"), new(42) }; + var value1 = new Value(list1); + var value2 = new Value(list2); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + [Fact] + public void Equals_WithObject_CallsTypedEquals() + { + // Arrange + var value1 = new Value("test"); + var value2 = new Value("test"); + object obj = value2; + + // Act & Assert + Assert.True(value1.Equals(obj)); + } + + [Fact] + public void Equals_WithNonValueObject_ReturnsFalse() + { + // Arrange + var value = new Value("test"); + object obj = "test"; + + // Act & Assert + Assert.False(value.Equals(obj)); + } + + #endregion + + #region Operator Tests + + [Fact] + public void OperatorEquals_WithBothNull_ReturnsTrue() + { + // Arrange + Value? value1 = null; + Value? value2 = null; + + // Act & Assert + Assert.True(value1 == value2); + } + + [Fact] + public void OperatorEquals_WithOneNull_ReturnsFalse() + { + // Arrange + Value? value1 = null; + Value value2 = new Value("test"); + + // Act & Assert + Assert.False(value1 == value2); + Assert.False(value2 == value1); + } + + [Fact] + public void OperatorEquals_WithEqualValues_ReturnsTrue() + { + // Arrange + var value1 = new Value("test"); + var value2 = new Value("test"); + + // Act & Assert + Assert.True(value1 == value2); + } + + [Fact] + public void OperatorEquals_WithDifferentValues_ReturnsFalse() + { + // Arrange + var value1 = new Value("test1"); + var value2 = new Value("test2"); + + // Act & Assert + Assert.False(value1 == value2); + } + + [Fact] + public void OperatorNotEquals_WithEqualValues_ReturnsFalse() + { + // Arrange + var value1 = new Value("test"); + var value2 = new Value("test"); + + // Act & Assert + Assert.False(value1 != value2); + } + + [Fact] + public void OperatorNotEquals_WithDifferentValues_ReturnsTrue() + { + // Arrange + var value1 = new Value("test1"); + var value2 = new Value("test2"); + + // Act & Assert + Assert.True(value1 != value2); + } + + #endregion + + #region GetHashCode Tests + + [Fact] + public void GetHashCode_WithNullValue_ReturnsZero() + { + // Arrange + var value = new Value(); + + // Act + var hashCode = value.GetHashCode(); + + // Assert + Assert.Equal(0, hashCode); + } + + [Fact] + public void GetHashCode_WithEqualValues_ReturnsSameHashCode() + { + // Arrange + var value1 = new Value("test"); + var value2 = new Value("test"); + + // Act + var hashCode1 = value1.GetHashCode(); + var hashCode2 = value2.GetHashCode(); + + // Assert + Assert.Equal(hashCode1, hashCode2); + } + + [Fact] + public void GetHashCode_WithBooleanValues_ReturnsConsistentHashCode() + { + // Arrange + var value1 = new Value(true); + var value2 = new Value(true); + var value3 = new Value(false); + + // Act + var hashCode1 = value1.GetHashCode(); + var hashCode2 = value2.GetHashCode(); + var hashCode3 = value3.GetHashCode(); + + // Assert + Assert.Equal(hashCode1, hashCode2); + Assert.NotEqual(hashCode1, hashCode3); + } + + [Fact] + public void GetHashCode_WithNumberValues_ReturnsConsistentHashCode() + { + // Arrange + var value1 = new Value(42.5); + var value2 = new Value(42.5); + var value3 = new Value(42.6); + + // Act + var hashCode1 = value1.GetHashCode(); + var hashCode2 = value2.GetHashCode(); + var hashCode3 = value3.GetHashCode(); + + // Assert + Assert.Equal(hashCode1, hashCode2); + Assert.NotEqual(hashCode1, hashCode3); + } + + [Fact] + public void GetHashCode_WithStringValues_ReturnsConsistentHashCode() + { + // Arrange + var value1 = new Value("test"); + var value2 = new Value("test"); + var value3 = new Value("different"); + + // Act + var hashCode1 = value1.GetHashCode(); + var hashCode2 = value2.GetHashCode(); + var hashCode3 = value3.GetHashCode(); + + // Assert + Assert.Equal(hashCode1, hashCode2); + Assert.NotEqual(hashCode1, hashCode3); + } + + [Fact] + public void GetHashCode_WithDateTimeValues_ReturnsConsistentHashCode() + { + // Arrange + var dateTime = DateTime.Now; + var value1 = new Value(dateTime); + var value2 = new Value(dateTime); + var value3 = new Value(dateTime.AddDays(1)); + + // Act + var hashCode1 = value1.GetHashCode(); + var hashCode2 = value2.GetHashCode(); + var hashCode3 = value3.GetHashCode(); + + // Assert + Assert.Equal(hashCode1, hashCode2); + Assert.NotEqual(hashCode1, hashCode3); + } + + [Fact] + public void GetHashCode_WithStructureValues_ReturnsConsistentHashCode() + { + // Arrange + var structure1 = Structure.Builder() + .Set("key1", new Value("value1")) + .Set("key2", new Value(42)) + .Build(); + var structure2 = Structure.Builder() + .Set("key1", new Value("value1")) + .Set("key2", new Value(42)) + .Build(); + var value1 = new Value(structure1); + var value2 = new Value(structure2); + + // Act + var hashCode1 = value1.GetHashCode(); + var hashCode2 = value2.GetHashCode(); + + // Assert + Assert.Equal(hashCode1, hashCode2); + } + + [Fact] + public void GetHashCode_WithListValues_ReturnsConsistentHashCode() + { + // Arrange + var list1 = new List { new("test"), new(42) }; + var list2 = new List { new("test"), new(42) }; + var value1 = new Value(list1); + var value2 = new Value(list2); + + // Act + var hashCode1 = value1.GetHashCode(); + var hashCode2 = value2.GetHashCode(); + + // Assert + Assert.Equal(hashCode1, hashCode2); + } + + #endregion + + #region Complex Nested Tests + + [Fact] + public void Equals_WithNestedStructuresAndLists_ReturnsTrue() + { + // Arrange + var innerList1 = new List { new("nested"), new(123) }; + var innerList2 = new List { new("nested"), new(123) }; + + var innerStructure1 = Structure.Builder() + .Set("nested_key", new Value("nested_value")) + .Set("nested_list", new Value(innerList1)) + .Build(); + var innerStructure2 = Structure.Builder() + .Set("nested_key", new Value("nested_value")) + .Set("nested_list", new Value(innerList2)) + .Build(); + + var outerStructure1 = Structure.Builder() + .Set("outer_key", new Value("outer_value")) + .Set("inner", new Value(innerStructure1)) + .Build(); + var outerStructure2 = Structure.Builder() + .Set("outer_key", new Value("outer_value")) + .Set("inner", new Value(innerStructure2)) + .Build(); + + var value1 = new Value(outerStructure1); + var value2 = new Value(outerStructure2); + + // Act & Assert + Assert.True(value1.Equals(value2)); + Assert.Equal(value1.GetHashCode(), value2.GetHashCode()); + } + + [Fact] + public void Equals_WithDeeplyNestedDifferences_ReturnsFalse() + { + // Arrange + var innerList1 = new List { new("nested"), new(123) }; + var innerList2 = new List { new("nested"), new(124) }; // Different value + + var innerStructure1 = Structure.Builder() + .Set("nested_key", new Value("nested_value")) + .Set("nested_list", new Value(innerList1)) + .Build(); + var innerStructure2 = Structure.Builder() + .Set("nested_key", new Value("nested_value")) + .Set("nested_list", new Value(innerList2)) + .Build(); + + var outerStructure1 = Structure.Builder() + .Set("outer_key", new Value("outer_value")) + .Set("inner", new Value(innerStructure1)) + .Build(); + var outerStructure2 = Structure.Builder() + .Set("outer_key", new Value("outer_value")) + .Set("inner", new Value(innerStructure2)) + .Build(); + + var value1 = new Value(outerStructure1); + var value2 = new Value(outerStructure2); + + // Act & Assert + Assert.False(value1.Equals(value2)); + } + + #endregion } diff --git a/version.txt b/version.txt index e70b4523a..c8e38b614 100644 --- a/version.txt +++ b/version.txt @@ -1 +1 @@ -2.6.0 +2.9.0