feat: Merge feature/superb-gamefowl into main — CI, tests, logging, and packaging improvements #2
Conversation
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
- Centralize hot-path logging with LoggerMessage delegates (Logging/LoggerDelegates.cs) and refactor call sites for CA1848/perf. - Consolidate analyzer rules in .editorconfig; enable language-style rules and apply safe fixes (prefer is null/is not null). - Replace reference-equality null checks, fix IDE0052 unused-private warnings, and resolve duplicate-parameter compile issue. - Improve SimpleFileLoggerProvider and SimpleFileLoggerOptions: streaming-safe CSV header replacement, per-run rotation with seconds, retention by days, and CSV/JSON path resolution fixes. - Harden ExternalConfigurationOptionsMonitor: robust deserialization fallback, legacy-structure migrations (top-level LogLevel and Logging.MinimumLevel), Windows token encryption handling, and normalize Folders to typed WatchedFolderConfig. - Update FileWatchRest.json.example and README to reflect the merged Folders object shape and runtime defaults. - Run dotnet format, dotnet build, and dotnet test to validate; build succeeded and tests passed.
…ttings - Introduced support for `Actions` in the configuration, allowing folders to reference reusable action configurations by name. - Updated `ConfigureFolderActions` method to accept global configuration, enabling per-folder action overrides. - Enhanced `FileWatcherManager` and `Worker` to utilize merged configurations for file processing. - Improved error handling and logging for watcher errors and restart attempts. - Added command-line and environment variable support for overriding the default configuration file path. - Updated README with detailed configuration examples and migration notes for legacy folder formats.
- Implement tests for `WorkerDuplicatePrevention` to ensure already posted files are skipped. - Add tests for `WorkerEnqueueExistingFiles` to verify that existing files are not re-queued. - Create tests for `WorkerHelper` to validate file readiness and content reading. - Develop tests for `WorkerMoveProcessed` to check the movement of processed files and handle timestamp collisions. - Introduce retry logic tests in `WorkerRetry` to confirm correct behavior under failure conditions. - Add streaming upload tests in `WorkerStreaming` to ensure multipart content is used for large files. - Enhance `OptionsMonitorMock` tests to validate change notifications. - Update example configuration files to reflect new features and settings.
- Introduced `ExecutionTimeoutMilliseconds` to specify maximum allowed execution time for actions. - Added `IgnoreOutput` option to suppress stdout/stderr logging for actions. - Updated `ExecutableAction` and `PowerShellScriptAction` to utilize new configuration options. - Enhanced logging to capture exit codes and process start failures. - Modified tests to reflect changes in action configurations. - Updated example configuration and README for clarity on new options.
…d PowerShell actions * Added detailed logging for unauthorized access and process start failures in `ExecutableAction` and `PowerShellScriptAction`. * Improved validation error logging in `ExternalConfigurationOptionsMonitor` to emit structured log entries for each validation failure. * Introduced new log messages for access denial in `FileWatcherManager`. * Updated JSON serialization in `JsonContexts` to include additional configuration types.
* Introduced `GetActionTypeForPath` method in `IFileWatcherManager` to determine the configured action type for a given file path. * Enhanced `FileWatcherManager` to maintain a mapping of folder paths to their respective action types. * Updated `Worker` to conditionally execute actions based on the resolved action type. * Added integration tests for PowerShell script execution based on folder action configuration.
…bles * Implemented logging for missing PowerShell scripts and executables in `PowerShellScriptAction` and `ExecutableAction`. * Enhanced `LoggerDelegates` with new log messages for clearer diagnostics. * Updated `FileWatcherManager` to log missing action scripts and executables during configuration.
…ensive save tests * Refactor `ExecutableAction` and `PowerShellScriptAction` constructors to set default values for `executionTimeoutMilliseconds`. * Update `ExternalConfiguration` properties to remove default values, allowing for more flexible configuration. * Introduce `ExternalConfigurationSaveTests` to ensure actions remain unchanged during configuration save operations. * Improve logging regex handling in `ExternalConfigurationOptionsMonitor`.
… paths * Added checks to ensure the presence of required PowerShell test scripts. * Updated configuration tests to use temporary directories for improved isolation. * Improved file system integration tests to handle existing target files gracefully. * Introduced `MyJsonContext.SaveOptions` for consistent JSON serialization settings. * Enhanced diagnostics service to reflect requested URL prefixes immediately for better test validation.
… improved null handling * Changed `JsonSourceGenerationOptions` to enable `WriteIndented` formatting and ignore null values. * Updated serialization method in `SaveConfigAsync` to use the source-generated context for AOT compatibility.
* Added `MyJsonLogContext` for efficient serialization of log entries. * Updated `SimpleFileLoggerProvider` to utilize the new context for NDJSON formatting. * Enhanced `ExternalConfigurationOptionsMonitor` to handle file locking scenarios gracefully. * Improved diagnostics tests to ensure accurate logging behavior under various conditions.
- Updated `Schedule` method in `FileDebounceService` to be virtual, allowing for easier testing and mocking. - This change enhances the testability of the service by enabling derived classes to override the scheduling behavior. fix(Worker): 🐛 use `await using` for `FileStream` to ensure proper disposal - Changed `using` to `await using` for `FileStream` in `Worker` to ensure asynchronous disposal of the stream. - This prevents potential resource leaks and ensures that file handles are released properly. refactor(Worker): 🔄 improve configuration merging logic for clarity - Enhanced the logic for merging action settings with global defaults in `GetConfigForPath`. - Added comments to clarify the precedence of settings and the handling of null/empty arrays. docs(README): 📚 update configuration options section for clarity - Revised the documentation to clarify the precedence of settings and the behavior of null/empty arrays in configuration. - Improved explanations regarding how action settings override global settings. test(tests): ✅ add comprehensive tests for configuration overrides - Introduced new tests to validate the behavior of configuration overrides, ensuring that action settings correctly override global settings. - Added tests for various scenarios including null and empty array handling for `AllowedExtensions` and `ExcludePatterns`. test(integration): 🔍 add integration tests for filtering behavior - Implemented integration tests to verify that the filtering behavior works as expected when using action-specific settings. - Ensured that files are correctly included or excluded based on the defined action settings.
* Introduced a new `bump-version.ps1` script to increment the build/patch version number in `FileWatchRest.csproj`. * Added a `-VersionBump` switch to the `build.ps1` script to trigger version updates before building. * Enhanced version management by supporting major and minor version increments.
…mprove authorization logic * Removed default value for `DiagnosticsBearerToken` to allow explicit configuration. * Enhanced authorization logic to allow unauthenticated access unless a non-empty bearer token is set. * Added new configuration properties in `DiagnosticsService` for better diagnostics handling. * Updated version bump script to handle git operations based on context.
- Introduced `package.ps1` for creating MSI and ZIP packages for `FileWatchRest`. - Added `release-notes.ps1` to generate release notes from git history. - Created `release.ps1` to orchestrate the release process, including testing, building, packaging, and generating release notes. - Enhanced `bump-version.ps1` to support target version input and dry-run functionality. - Improved XML handling in `bump-version.ps1` for robust version extraction and updates. - Updated project structure to facilitate CI/CD workflows and local packaging.
* Changed `WaitForAllAsync` method to static for better clarity. * Updated array initialization syntax for consistency. * Removed unnecessary using directives to clean up the code.
Replaced global usings check with build and test job, and updated environment to Windows.
Added 'dev' branch to CI workflow triggers and included coverage upload step.
* Added logic to check for WiX CLI availability before MSI creation. * If WiX is not found, attempts to install the dotnet global tool `wix` version 6.0.2. * Improved error handling to skip MSI packaging if installation fails. * Updated release notes script to better determine the last tag based on current tags.
…in CI; fix release-notes tag logic
…ting - Improved project title and description for clarity. - Added a brief overview of the FileWatch Windows Service. - Enhanced formatting for better visual presentation.
Welcome to Codecov 🎉Once you merge this PR into your default branch, you're all set! Codecov will compare coverage reports and display results in all future pull requests. ℹ️ You can also turn on project coverage checks and project coverage reporting on Pull Request comment Thanks for integrating Codecov - We've got you covered ☂️ |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
Merge
feature/superb-gamefowlwhich adds CI/workflow improvements, packaging & release orchestration (WiX), many new and refactored tests, improved logging and JSON contexts, configuration enhancements, and new helpers/services required for current feature work. This is a large feature-branch merge that refactors services, restores/rewires configuration monitors, and adds test coverage and packaging tooling.Why
Prepares repository for reliable CI, packaging, and improved test coverage. Also provides script-based release tooling and consistent logging formats (NDJSON).
Scope
Cross-cutting: CI, build tooling, tests, logging, configuration, services, and new example configs.
Key changes (high level)
.github/workflows/ci.ymland added packaging/release scripts undertools/andtools/wix.xml.tools/wix.xml,tools/release.ps1,tools/package.ps1).FileWatchRest/Logging/andFileWatchRest/Models/.ExternalConfigurationandExternalConfigurationValidatorbehavior.FileDebounceService,FileSenderService, and other service interfaces.FileWatchRest/Action/ExecutableAction.cs,FileWatchRest/Action/PowerShellScriptAction.cs,FileWatchRest/Action/RestPostAction.cs.FileWatchRest.Tests/(integration, unit, helpers, mocks).README.mdand added example configs inexamples/.Commits included (newest → older)
DiagnosticsBearerTokenproperty and improve authorization logicSchedulemethod virtual for testingFiles changed (summary)