Refactor bit Boilerplate AppEnvironment (#11092) #11093

ysmoradi · 2025-07-11T11:14:16Z

Summary by CodeRabbit

Refactor
- Unified environment naming conventions to use PascalCase (e.g., "Development", "Production") across the application.
- Renamed environment check methods to more descriptive names (e.g., IsDev() → IsDevelopment(), IsProd() → IsProduction()).
- Updated all environment checks throughout the app to use the new method names and naming conventions.
- Adjusted build and deployment configurations to align with the new environment naming.
Chores
- Minor updates to comments and workflow references for consistency with new naming standards.

coderabbitai · 2025-07-11T11:14:24Z

Important

Review skipped

Auto incremental reviews are disabled on this repository.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The codebase refactors the environment detection logic by renaming environment constants and methods in the AppEnvironment class, changing from abbreviated forms (e.g., IsDev(), DEV) to fully descriptive PascalCase names (e.g., IsDevelopment(), Development). All usages across the solution are updated accordingly, with related workflow, solution, and build configuration adjustments.

Changes

File(s)	Change Summary
.../src/Shared/Services/AppEnvironment.cs	Refactored environment constants from uppercase abbreviations to PascalCase; renamed methods to `IsDevelopment()`, `IsProduction()`; updated preprocessor directives.
.../src/Client/Boilerplate.Client.Core/....cs/.razor	Replaced all calls to `AppEnvironment.IsDev()`/`IsProd()` with `IsDevelopment()`/`IsProduction()`.
.../src/Client/Boilerplate.Client.Web/ClientWebSettings.cs, Program.cs	Updated environment check methods to use new `IsDevelopment()`.
.../src/Client/Boilerplate.Client.Maui/App.xaml.cs, MauiProgram.cs	Updated environment check methods to use new `IsDevelopment()`.
.../src/Client/Boilerplate.Client.Windows/...	Updated environment check methods to use new `IsDevelopment()`.
.../src/Server/Boilerplate.Server.Api/ServerApiSettings.cs, .../Services/Identity/AppJwtSecureDataFormat.cs	Updated environment check methods to use new `IsDevelopment()`.
.../src/Server/Boilerplate.Server.Web/Program.cs, Program.Services.cs, .../Services/SimpleJwtSecureDataFormat.cs	Updated environment check methods to use new `IsDevelopment()`.
.../src/Shared/Services/SharedExceptionHandler.cs	Updated environment check method to use new `IsDevelopment()`.
.../src/Directory.Build.props	Removed `.ToUpper()` from environment constant definition for preprocessor symbols.
.../Boilerplate.sln, Boilerplate.slnx	Renamed workflow file references from `cd-prod.yml` to `cd-production.yml`.
.../.github/workflows/cd-production.yml, cd-test.yml	Changed `ENV_NAME` from lowercase to PascalCase ("prod"→"Production", "test"→"Test").

Sequence Diagram(s)

sequenceDiagram
    participant App as Application Code
    participant Env as AppEnvironment

    App->>Env: AppEnvironment.IsDevelopment()
    Env-->>App: Returns true if current environment is Development

    App->>Env: AppEnvironment.IsProduction()
    Env-->>App: Returns true if current environment is Production

    Note right of Env: Internal logic uses PascalCase constants and updated preprocessor directives.

Assessment against linked issues

Objective	Addressed	Explanation
Refactor `AppEnvironment` to use PascalCase environment names and descriptive method names (`IsDevelopment()`, `IsProduction()`) (#11092)	✅
Update all usages of old methods/constants to new naming conventions (#11092)	✅
Update build configuration and workflow references to match new naming (#11092)	✅

Poem

✨ Finishing Touches

🧪 Generate unit tests

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Explain this complex logic.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai explain this code block.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and explain its main purpose.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai generate docstrings to generate docstrings for this PR.
@coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
@coderabbitai auto-generate unit tests to generate unit tests for this PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

Copilot

Pull Request Overview

This PR refactors AppEnvironment to use clear PascalCase identifiers (Development, Test, Staging, Production) and updates all related environment checks, build defines, and workflow references accordingly.

Renamed environment constants and methods (DEV → Development, IsDev() → IsDevelopment(), etc.)
Updated all call sites to use the new IsDevelopment(), IsTest(), IsStaging(), and IsProduction() methods
Adjusted MSBuild define constants in Directory.Build.props and renamed GitHub workflow files and references to match the new environment names

Reviewed Changes

Copilot reviewed 32 out of 32 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Services/AppEnvironment.cs	Renamed constants and methods to PascalCase, updated default `Current` assignment
src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Services/SharedExceptionHandler.cs	Replaced `AppEnvironment.IsDev()` with `IsDevelopment()`
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Services/SimpleJwtSecureDataFormat.cs	Updated environment check to `IsDevelopment()`
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.cs	Updated exception display kind check to `IsDevelopment()`
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Services.cs	Updated diagnostic logger registration to `IsDevelopment()`
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Services/Identity/AppJwtSecureDataFormat.cs	Updated environment check to `IsDevelopment()`
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/ServerApiSettings.cs	Replaced `IsDev()` in JWT key validation with `IsDevelopment()`
src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Build.props	Removed `.ToUpper()` around `$(Environment)` in `DefineConstants`
Multiple client and core files (e.g., `Program.cs`, `AuthManager.cs`, `CacheDelegatingHandler.cs`)	Updated all `AppEnvironment.IsDev()` and negations to `IsDevelopment()`
src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.slnx and `.sln`	Renamed workflow references from `cd-prod.yml` to `cd-production.yml`
.github/workflows/cd-test.yml and cd-production.yml	Updated `ENV_NAME` from lowercase to PascalCase (`Test` / `Production`)

Comments suppressed due to low confidence (3)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Extensions/IClientCoreServiceCollectionExtensions.cs:131

Add or update unit tests for the renamed 'IsDevelopment()' (and other environment checks) to ensure features like sensitive data logging and detailed errors toggle correctly in different environments.

            optionsBuilder.EnableSensitiveDataLogging(AppEnvironment.IsDevelopment())

src/Templates/Boilerplate/Bit.Boilerplate/.github/workflows/cd-test.yml:13

[nitpick] Update any project documentation or README sections that reference the old lowercase 'test' environment name so they reflect the new 'Test' identifier.

      ENV_NAME: Test

src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Build.props:35

Removing 'ToUpper()' on '$(Environment)' may introduce case-sensitivity issues with preprocessor symbols. Verify that the environment values passed here exactly match the symbol names used in the '#if' directives.

        <DefineConstants>$(DefineConstants);$(Environment);$(Configuration)</DefineConstants>

src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Services/AppEnvironment.cs

src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.slnx

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (3)

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Knowledge Base: Disabled due to Reviews > Disable Knowledge Base setting

📥 Commits

Reviewing files that changed from the base of the PR and between 17e153e and 02c14fa.

📒 Files selected for processing (32)

src/Templates/Boilerplate/Bit.Boilerplate/.github/workflows/cd-production.yml (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/.github/workflows/cd-test.yml (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.sln (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.slnx (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/ClientCoreSettings.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/AppErrorBoundary.razor (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/Diagnostic/AppDiagnosticModal.razor.Utils.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/Diagnostic/AppDiagnosticModal.razor.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Pages/Identity/SignIn/SignInPanel.razor.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Pages/Settings/Account/PasswordlessTab.razor.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Extensions/IClientCoreServiceCollectionExtensions.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Extensions/IConfigurationExtensions.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Extensions/ILoggingBuilderExtensions.cs (3 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/AuthManager.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/ClientExceptionHandlerBase.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/CultureService.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/HttpMessageHandlers/CacheDelegatingHandler.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/HttpMessageHandlers/RetryDelegatingHandler.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/App.xaml.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/MauiProgram.cs (3 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/ClientWebSettings.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/Program.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Program.cs (2 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Services/WindowsLocalHttpServer.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Directory.Build.props (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/ServerApiSettings.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Services/Identity/AppJwtSecureDataFormat.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Services.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Services/SimpleJwtSecureDataFormat.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Services/AppEnvironment.cs (1 hunks)
src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Services/SharedExceptionHandler.cs (1 hunks)

🧰 Additional context used

🧬 Code Graph Analysis (19)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Services/SimpleJwtSecureDataFormat.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.Services.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/Services/Identity/AppJwtSecureDataFormat.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Windows/Services/WindowsLocalHttpServer.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/Diagnostic/AppDiagnosticModal.razor.Utils.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/ClientCoreSettings.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/HttpMessageHandlers/RetryDelegatingHandler.cs (2)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Extensions/IClientCoreServiceCollectionExtensions.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Extensions/ILoggingBuilderExtensions.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Components/Layout/Diagnostic/AppDiagnosticModal.razor.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/ClientExceptionHandlerBase.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/AuthManager.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Web/Program.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Services/SharedExceptionHandler.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/MauiProgram.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Core/Services/CultureService.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Maui/App.xaml.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Client/Boilerplate.Client.Web/ClientWebSettings.cs (1)

src/Templates/Boilerplate/Bit.Boilerplate/src/Server/Boilerplate.Server.Api/ServerApiSettings.cs (1)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: build and test

🔇 Additional comments (39)

refactor bit Boilerplate AppEnvironment (#11092)

02c14fa

ysmoradi requested a review from Copilot July 11, 2025 11:14

Copilot AI reviewed Jul 11, 2025

View reviewed changes

src/Templates/Boilerplate/Bit.Boilerplate/src/Shared/Services/AppEnvironment.cs Show resolved Hide resolved

src/Templates/Boilerplate/Bit.Boilerplate/Boilerplate.slnx Show resolved Hide resolved

coderabbitai bot reviewed Jul 11, 2025

View reviewed changes

fix

e03d34a

ysmoradi merged commit c29e28b into bitfoundation:develop Jul 11, 2025
3 checks passed

ysmoradi deleted the 11092 branch July 11, 2025 11:30

dependabot bot mentioned this pull request Jul 22, 2025

Bump Bit.Besql and Microsoft.Playwright VibeNL/GhostfolioSidekick#580

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Refactor bit Boilerplate AppEnvironment (#11092) #11093

Refactor bit Boilerplate AppEnvironment (#11092) #11093

Uh oh!

ysmoradi commented Jul 11, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jul 11, 2025 •

edited

Loading

Review skipped

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

Copilot AI left a comment

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Uh oh!

Refactor bit Boilerplate AppEnvironment (#11092) #11093

Refactor bit Boilerplate AppEnvironment (#11092) #11093

Uh oh!

Conversation

ysmoradi commented Jul 11, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

coderabbitai bot commented Jul 11, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review skipped

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

Support

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

ysmoradi commented Jul 11, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jul 11, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)