-
Notifications
You must be signed in to change notification settings - Fork 0
refactor(config): enhance AppConfig with environment-aware configurat… #106
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
69138ac
refactor(config): enhance AppConfig with environment-aware configurat…
fulleni aed207a
docs(README): update environment configuration description
fulleni b6b23a0
docs: remove changelog file
fulleni 21571ff
fix(config): replace FormatException with StateError for environment …
fulleni File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,21 +1,52 @@ | ||
|
|
||
| import 'package:flutter_news_app_web_dashboard_full_source_code/app/config/app_environment.dart'; | ||
|
|
||
| /// A class to hold all environment-specific configurations. | ||
| /// | ||
| /// This class is instantiated in `main.dart` based on the compile-time | ||
| /// environment variable. It provides a type-safe way to access | ||
| /// environment-specific values like API base URLs. | ||
| class AppConfig { | ||
| const AppConfig({required this.environment, required this.baseUrl}); | ||
| /// Creates a new [AppConfig]. | ||
| AppConfig({ | ||
| required this.environment, | ||
| required this.baseUrl, | ||
| // Add other environment-specific configs here (e.g., analytics keys) | ||
| }); | ||
|
|
||
| factory AppConfig.production() => const AppConfig( | ||
| environment: AppEnvironment.production, | ||
| baseUrl: 'http://api.yourproductiondomain.com', | ||
| ); | ||
| /// A factory constructor for the production environment. | ||
| /// | ||
| /// Reads the `BASE_URL` from a compile-time variable. Throws an exception | ||
| /// if the URL is not provided, ensuring a production build cannot proceed | ||
| /// with a missing configuration. This is a critical safety check. | ||
| factory AppConfig.production() { | ||
| const baseUrl = String.fromEnvironment('BASE_URL'); | ||
| if (baseUrl.isEmpty) { | ||
| // This check is crucial for production builds. | ||
| throw const FormatException( | ||
| 'FATAL: The BASE_URL compile-time variable was not provided for this ' | ||
| 'production build. Ensure the build command includes ' | ||
| '--dart-define=BASE_URL=https://your.api.com', | ||
| ); | ||
fulleni marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| } | ||
| return AppConfig(environment: AppEnvironment.production, baseUrl: baseUrl); | ||
| } | ||
|
|
||
| factory AppConfig.demo() => | ||
| const AppConfig(environment: AppEnvironment.demo, baseUrl: ''); | ||
| /// A factory constructor for the demo environment. | ||
| factory AppConfig.demo() => AppConfig( | ||
| environment: AppEnvironment.demo, | ||
| baseUrl: '', // No API access needed for in-memory demo | ||
| ); | ||
|
|
||
| factory AppConfig.development() => const AppConfig( | ||
| /// A factory constructor for the development environment. | ||
| factory AppConfig.development() => AppConfig( | ||
| environment: AppEnvironment.development, | ||
| baseUrl: 'http://localhost:8080', | ||
| baseUrl: const String.fromEnvironment( | ||
| 'BASE_URL', | ||
| defaultValue: 'http://localhost:8080', | ||
| ), | ||
| ); | ||
|
|
||
| final AppEnvironment environment; | ||
| final String baseUrl; | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.