mirror of
https://github.com/ivuorinen/monolog-gdpr-filter.git
synced 2026-01-26 11:44:04 +00:00
feat: add advanced architecture, documentation, and coverage improvements (#65)
* fix(style): resolve PHPCS line-length warnings in source files * fix(style): resolve PHPCS line-length warnings in test files * feat(audit): add structured audit logging with ErrorContext and AuditContext - ErrorContext: standardized error information with sensitive data sanitization - AuditContext: structured context for audit entries with operation types - StructuredAuditLogger: enhanced audit logger wrapper with timing support * feat(recovery): add recovery mechanism for failed masking operations - FailureMode enum: FAIL_OPEN, FAIL_CLOSED, FAIL_SAFE modes - RecoveryStrategy interface and RecoveryResult value object - RetryStrategy: exponential backoff with configurable attempts - FallbackMaskStrategy: type-aware fallback values * feat(strategies): add CallbackMaskingStrategy for custom masking logic - Wraps custom callbacks as MaskingStrategy implementations - Factory methods: constant(), hash(), partial() for common use cases - Supports exact match and prefix match for field paths * docs: add framework integration guides and examples - symfony-integration.md: Symfony service configuration and Monolog setup - psr3-decorator.md: PSR-3 logger decorator pattern implementation - framework-examples.md: CakePHP, CodeIgniter 4, Laminas, Yii2, PSR-15 - docker-development.md: Docker development environment guide * chore(docker): add Docker development environment - Dockerfile: PHP 8.2-cli-alpine with Xdebug for coverage - docker-compose.yml: development services with volume mounts * feat(demo): add interactive GDPR pattern tester playground - PatternTester.php: pattern testing utility with strategy support - index.php: web API endpoint with JSON response handling - playground.html: interactive web interface for testing patterns * docs(todo): update with completed medium priority items - Mark all PHPCS warnings as fixed (81 → 0) - Document new Audit and Recovery features - Update test count to 1,068 tests with 2,953 assertions - Move remaining items to low priority * feat: add advanced architecture, documentation, and coverage improvements - Add architecture improvements: - ArrayAccessorInterface and DotArrayAccessor for decoupled array access - MaskingOrchestrator for single-responsibility masking coordination - GdprProcessorBuilder for fluent configuration - MaskingPluginInterface and AbstractMaskingPlugin for plugin architecture - PluginAwareProcessor for plugin hook execution - AuditLoggerFactory for instance-based audit logger creation - Add advanced features: - SerializedDataProcessor for handling print_r/var_export/serialize output - KAnonymizer with GeneralizationStrategy for GDPR k-anonymity - RetentionPolicy for configurable data retention periods - StreamingProcessor for memory-efficient large log processing - Add comprehensive documentation: - docs/performance-tuning.md - benchmarking, optimization, caching - docs/troubleshooting.md - common issues and solutions - docs/logging-integrations.md - ELK, Graylog, Datadog, etc. - docs/plugin-development.md - complete plugin development guide - Improve test coverage (84.41% → 85.07%): - ConditionalRuleFactoryInstanceTest (100% coverage) - GdprProcessorBuilderEdgeCasesTest (100% coverage) - StrategyEdgeCasesTest for ReDoS detection and type parsing - 78 new tests, 119 new assertions - Update TODO.md with current statistics: - 141 PHP files, 1,346 tests, 85.07% line coverage * chore: tests, update actions, sonarcloud issues * chore: rector * fix: more sonarcloud fixes * chore: more fixes * refactor: copilot review fix * chore: rector
This commit is contained in:
GitHub
315
docs/docker-development.md
Normal file
315
docs/docker-development.md
Normal file
@@ -0,0 +1,315 @@
|
||||
# Docker Development Environment
|
||||
|
||||
This guide explains how to set up a Docker development environment for working with the Monolog GDPR Filter library.
|
||||
|
||||
## Quick Start
|
||||
|
||||
### Using Docker Compose
|
||||
|
||||
```bash
|
||||
# Clone the repository
|
||||
git clone https://github.com/ivuorinen/monolog-gdpr-filter.git
|
||||
cd monolog-gdpr-filter
|
||||
|
||||
# Start the development environment
|
||||
docker compose up -d
|
||||
|
||||
# Run tests
|
||||
docker compose exec php composer test
|
||||
|
||||
# Run linting
|
||||
docker compose exec php composer lint
|
||||
```
|
||||
|
||||
## Docker Configuration Files
|
||||
|
||||
### docker/Dockerfile
|
||||
|
||||
```dockerfile
|
||||
FROM php:8.2-cli-alpine
|
||||
|
||||
# Install system dependencies
|
||||
RUN apk add --no-cache \
|
||||
git \
|
||||
unzip \
|
||||
curl \
|
||||
libzip-dev \
|
||||
icu-dev \
|
||||
&& docker-php-ext-install \
|
||||
zip \
|
||||
intl \
|
||||
pcntl
|
||||
|
||||
# Install Composer
|
||||
COPY --from=composer:2 /usr/bin/composer /usr/bin/composer
|
||||
|
||||
# Install Xdebug for code coverage
|
||||
RUN apk add --no-cache $PHPIZE_DEPS \
|
||||
&& pecl install xdebug \
|
||||
&& docker-php-ext-enable xdebug
|
||||
|
||||
# Configure Xdebug
|
||||
RUN echo "xdebug.mode=coverage,debug" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini \
|
||||
&& echo "xdebug.client_host=host.docker.internal" >> /usr/local/etc/php/conf.d/docker-php-ext-xdebug.ini
|
||||
|
||||
# Set working directory
|
||||
WORKDIR /app
|
||||
|
||||
# Set recommended PHP settings for development
|
||||
RUN echo "memory_limit=512M" >> /usr/local/etc/php/conf.d/docker-php-memory.ini \
|
||||
&& echo "error_reporting=E_ALL" >> /usr/local/etc/php/conf.d/docker-php-errors.ini \
|
||||
&& echo "display_errors=On" >> /usr/local/etc/php/conf.d/docker-php-errors.ini
|
||||
|
||||
# Create non-root user
|
||||
RUN addgroup -g 1000 developer \
|
||||
&& adduser -D -u 1000 -G developer developer
|
||||
|
||||
USER developer
|
||||
|
||||
CMD ["php", "-v"]
|
||||
```
|
||||
|
||||
### docker/docker-compose.yml
|
||||
|
||||
```yaml
|
||||
version: '3.8'
|
||||
|
||||
services:
|
||||
php:
|
||||
build:
|
||||
context: .
|
||||
dockerfile: Dockerfile
|
||||
volumes:
|
||||
- ..:/app
|
||||
- composer-cache:/home/developer/.composer/cache
|
||||
working_dir: /app
|
||||
environment:
|
||||
- COMPOSER_HOME=/home/developer/.composer
|
||||
- XDEBUG_MODE=coverage
|
||||
stdin_open: true
|
||||
tty: true
|
||||
command: tail -f /dev/null
|
||||
|
||||
# Optional: PHP 8.3 for testing compatibility
|
||||
php83:
|
||||
image: php:8.3-cli-alpine
|
||||
volumes:
|
||||
- ..:/app
|
||||
working_dir: /app
|
||||
profiles:
|
||||
- testing
|
||||
command: php -v
|
||||
|
||||
volumes:
|
||||
composer-cache:
|
||||
```
|
||||
|
||||
## Running Tests
|
||||
|
||||
### All Tests
|
||||
|
||||
```bash
|
||||
docker compose exec php composer test
|
||||
```
|
||||
|
||||
### With Coverage Report
|
||||
|
||||
```bash
|
||||
docker compose exec php composer test:coverage
|
||||
```
|
||||
|
||||
### Specific Test File
|
||||
|
||||
```bash
|
||||
docker compose exec php ./vendor/bin/phpunit tests/GdprProcessorTest.php
|
||||
```
|
||||
|
||||
### Specific Test Method
|
||||
|
||||
```bash
|
||||
docker compose exec php ./vendor/bin/phpunit --filter testEmailMasking
|
||||
```
|
||||
|
||||
## Running Linting Tools
|
||||
|
||||
### All Linting
|
||||
|
||||
```bash
|
||||
docker compose exec php composer lint
|
||||
```
|
||||
|
||||
### Individual Tools
|
||||
|
||||
```bash
|
||||
# PHP CodeSniffer
|
||||
docker compose exec php ./vendor/bin/phpcs
|
||||
|
||||
# Auto-fix with PHPCBF
|
||||
docker compose exec php ./vendor/bin/phpcbf
|
||||
|
||||
# Psalm
|
||||
docker compose exec php ./vendor/bin/psalm
|
||||
|
||||
# PHPStan
|
||||
docker compose exec php ./vendor/bin/phpstan analyse
|
||||
|
||||
# Rector (dry-run)
|
||||
docker compose exec php ./vendor/bin/rector --dry-run
|
||||
```
|
||||
|
||||
## Development Workflow
|
||||
|
||||
### Initial Setup
|
||||
|
||||
```bash
|
||||
# Build containers
|
||||
docker compose build
|
||||
|
||||
# Start services
|
||||
docker compose up -d
|
||||
|
||||
# Install dependencies
|
||||
docker compose exec php composer install
|
||||
|
||||
# Run initial checks
|
||||
docker compose exec php composer lint
|
||||
docker compose exec php composer test
|
||||
```
|
||||
|
||||
### Daily Development
|
||||
|
||||
```bash
|
||||
# Start environment
|
||||
docker compose up -d
|
||||
|
||||
# Make changes...
|
||||
|
||||
# Run tests
|
||||
docker compose exec php composer test
|
||||
|
||||
# Run linting
|
||||
docker compose exec php composer lint
|
||||
|
||||
# Auto-fix issues
|
||||
docker compose exec php composer lint:fix
|
||||
```
|
||||
|
||||
### Testing Multiple PHP Versions
|
||||
|
||||
```bash
|
||||
# Test with PHP 8.3
|
||||
docker compose --profile testing run php83 php -v
|
||||
docker compose --profile testing run php83 ./vendor/bin/phpunit
|
||||
```
|
||||
|
||||
## Debugging
|
||||
|
||||
### Enable Xdebug
|
||||
|
||||
The Docker configuration includes Xdebug. Configure your IDE to listen on port 9003.
|
||||
|
||||
For VS Code, add to `.vscode/launch.json`:
|
||||
|
||||
```json
|
||||
{
|
||||
"version": "0.2.0",
|
||||
"configurations": [
|
||||
{
|
||||
"name": "Listen for Xdebug",
|
||||
"type": "php",
|
||||
"request": "launch",
|
||||
"port": 9003,
|
||||
"pathMappings": {
|
||||
"/app": "${workspaceFolder}"
|
||||
}
|
||||
}
|
||||
]
|
||||
}
|
||||
```
|
||||
|
||||
### Interactive Shell
|
||||
|
||||
```bash
|
||||
docker compose exec php sh
|
||||
```
|
||||
|
||||
### View Logs
|
||||
|
||||
```bash
|
||||
docker compose logs -f php
|
||||
```
|
||||
|
||||
## CI/CD Integration
|
||||
|
||||
### GitHub Actions Example
|
||||
|
||||
```yaml
|
||||
name: Tests
|
||||
|
||||
on: [push, pull_request]
|
||||
|
||||
jobs:
|
||||
test:
|
||||
runs-on: ubuntu-latest
|
||||
strategy:
|
||||
matrix:
|
||||
php: ['8.2', '8.3']
|
||||
|
||||
steps:
|
||||
- uses: actions/checkout@v4
|
||||
|
||||
- name: Setup PHP
|
||||
uses: shivammathur/setup-php@v2
|
||||
with:
|
||||
php-version: ${{ matrix.php }}
|
||||
extensions: intl, zip
|
||||
coverage: xdebug
|
||||
|
||||
- name: Install dependencies
|
||||
run: composer install --prefer-dist --no-progress
|
||||
|
||||
- name: Run linting
|
||||
run: composer lint
|
||||
|
||||
- name: Run tests
|
||||
run: composer test:coverage
|
||||
```
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
### Permission Issues
|
||||
|
||||
If you encounter permission issues:
|
||||
|
||||
```bash
|
||||
# Fix ownership
|
||||
docker compose exec -u root php chown -R developer:developer /app
|
||||
|
||||
# Or run as root temporarily
|
||||
docker compose exec -u root php composer install
|
||||
```
|
||||
|
||||
### Composer Memory Limit
|
||||
|
||||
```bash
|
||||
docker compose exec php php -d memory_limit=-1 /usr/bin/composer install
|
||||
```
|
||||
|
||||
### Clear Caches
|
||||
|
||||
```bash
|
||||
# Clear composer cache
|
||||
docker compose exec php composer clear-cache
|
||||
|
||||
# Clear Psalm cache
|
||||
docker compose exec php ./vendor/bin/psalm --clear-cache
|
||||
|
||||
# Clear PHPStan cache
|
||||
docker compose exec php ./vendor/bin/phpstan clear-result-cache
|
||||
```
|
||||
|
||||
## See Also
|
||||
|
||||
- [Symfony Integration](symfony-integration.md)
|
||||
- [PSR-3 Decorator](psr3-decorator.md)
|
||||
- [Framework Examples](framework-examples.md)
|
||||
Reference in New Issue
Block a user