Release - 2.4.0

.gitattributes

@@ -0,0 +1,15 @@
+/.github export-ignore
+/dev export-ignore
+/docs export-ignore
+/tests export-ignore
+/.editorconfig export-ignore
+/.env.testing export-ignore
+/.env.testing.slic export-ignore
+/.gitattributes export-ignore
+/.gitignore export-ignore
+/.lando.yml export-ignore
+/codeception.dist.yml export-ignore
+/codeception.slic.yml export-ignore
+/CONTRIBUTING.md export-ignore
+/phpcs.xml.dist export-ignore
+/phpstan.neon.dist export-ignore

.github/workflows/compatibility.yml

@@ -12,31 +12,20 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php-version: ["7.1", "7.2", "7.3", "7.4", "8.0", "8.1", "8.2"]
+        php-version: ["7.1", "7.2", "7.3", "7.4", "8.0", "8.1", "8.2", "8.3"]
 
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - name: Configure PHP environment
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.2'
           extensions: mbstring, intl
           coverage: none
 
-      - name: Get Composer Cache Directory
-        id: composer-cache
-        run: |
-          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
-      - uses: actions/cache@v3
-        with:
-          path: ${{ steps.composer-cache.outputs.dir }}
-          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-composer-
-      - uses: ramsey/composer-install@v2
-        with:
-          dependency-versions: highest
+      - name: Composer Install
+        uses: ramsey/composer-install@v3
 
       - name: Run PHP Compatibility
         run: composer compatibility:php-${{ matrix.php-version }}

.github/workflows/phpcs.yml

@@ -8,12 +8,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Configure PHP environment
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
-      - uses: ramsey/composer-install@v2
+          php-version: '8.2'
+      - uses: ramsey/composer-install@v3
         with:
           composer-options: "--ignore-platform-reqs --optimize-autoloader"
       - name: Run PHPCS

.github/workflows/phpstan.yml

@@ -8,12 +8,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
       - name: Configure PHP environment
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
-      - uses: ramsey/composer-install@v2
+          php-version: '8.2'
+      - uses: ramsey/composer-install@v3
         with:
           composer-options: "--ignore-platform-reqs --optimize-autoloader"
       - name: Run PHPStan

.github/workflows/tests.yml

@@ -10,28 +10,22 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout the repository
-        uses: actions/checkout@v2
-        with:
-          fetch-depth: 1000
-          submodules: recursive
+        uses: actions/checkout@v4
       # ------------------------------------------------------------------------------
       # Checkout slic
       # ------------------------------------------------------------------------------
       - name: Checkout slic
-        uses: actions/checkout@v2
+        uses: actions/checkout@v4
         with:
           repository: stellarwp/slic
           ref: main
           path: slic
           fetch-depth: 1
-      # ------------------------------------------------------------------------------
-      # Prepare our composer cache directory
-      # ------------------------------------------------------------------------------
       - name: Get Composer Cache Directory
         id: get-composer-cache-dir
         run: |
           echo "::set-output name=dir::$(composer config cache-files-dir)"
-      - uses: actions/cache@v2
+      - uses: actions/cache@v4
         id: composer-cache
         with:
           path: ${{ steps.get-composer-cache-dir.outputs.dir }}

.lando.yml

@@ -38,5 +38,6 @@ events:
   post-start:
     - appserver: composer install
     - appserver: /app/dev/lando/install-wp.sh
+    - appserver: cd /app/dev/public/wp-content/plugins/library-testing && composer install
   post-destroy:
     - appserver: rm -rf /app/dev/public/wp

CLAUDE.md

@@ -0,0 +1,86 @@
+# CLAUDE.md
+
+This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.
+
+## Project Overview
+
+This is the StellarWP Telemetry Library - a PHP library for WordPress plugins that provides opt-in telemetry data collection. The library is designed to be included via Composer (preferably with Strauss for namespace isolation) and provides a complete telemetry solution with user privacy controls.
+
+## Common Development Commands
+
+### Testing
+```bash
+# Run unit tests using slic (StellarWP's testing framework)
+slic run wpunit
+
+# Run static analysis
+composer test:analysis
+```
+
+### Code Quality
+```bash
+# Check coding standards
+phpcs ./src
+
+# Auto-fix coding standard issues
+phpcbf ./src
+
+# Check PHP compatibility for all supported versions (7.1-8.3)
+composer compatibility
+
+# Check specific PHP version compatibility
+composer compatibility:php-8.0
+```
+
+### Local Development
+```bash
+# Start local development environment
+lando start
+
+# Install dependencies via Lando
+lando composer install
+
+# Local site will be available at: https://telemetry-library.lndo.site/
+```
+
+## High-Level Architecture
+
+### Core Components
+
+1. **Dependency Injection Container**: The library requires a DI container compatible with `stellarwp/container-contract`. The container must be configured before initializing the library.
+
+2. **Opt-In System**: 
+   - `Opt_In/` - Manages user consent through modal interfaces
+   - `Exit_Interview/` - Collects feedback when plugins are deactivated
+   - Privacy-first approach with explicit user consent required
+
+3. **Data Collection**:
+   - `Data_Providers/` - Abstract data collection with providers like `Debug_Data` for Site Health integration
+   - `Events/` - Event tracking system for capturing user actions
+   - `Telemetry/` - Core functionality for sending telemetry data to the server
+
+4. **Integration Points**:
+   - `Admin/` - WordPress admin integration and resource management
+   - `Last_Send/` - Tracks when telemetry was last sent
+   - Uses subscriber pattern (`Abstract_Subscriber`) for WordPress hooks
+
+### Key Design Patterns
+
+- **Subscriber Pattern**: All WordPress hook integrations use the subscriber pattern through `Abstract_Subscriber`
+- **Template System**: UI components use template interfaces for rendering
+- **Modular Design**: Clear separation between opt-in, telemetry, events, and exit interview functionality
+- **Multi-Plugin Support**: Designed to be shared across multiple plugins using `Config::add_stellar_slug()`
+
+### Integration Requirements
+
+1. Initialize with a compatible DI container
+2. Configure server URL and hook prefix
+3. Set a unique stellar slug for plugin identification
+4. Call `Telemetry::instance()->init(__FILE__)` to start
+
+### Testing Approach
+
+- Uses Codeception with WordPress browser testing
+- Tests run via `slic` command in CI/CD
+- PHPStan level 5 for static analysis
+- PHPCS with WordPress VIP Go and TEC standards

README.md

@@ -1,4 +1,8 @@
 # Telemetry Library
+![Tests](https://github.com/stellarwp/telemetry/actions/workflows/tests.yml/badge.svg)
+![Coding Standards](https://github.com/stellarwp/telemetry/actions/workflows/phpcs.yml/badge.svg)
+![PHP Compatibility](https://github.com/stellarwp/telemetry/actions/workflows/compatibility.yml/badge.svg)
+![Static Analysis](https://github.com/stellarwp/telemetry/actions/workflows/phpstan.yml/badge.svg)
 
 A library for Opt-in and Telemetry data to be sent to the StellarWP Telemetry server.
 

composer.json

@@ -29,15 +29,15 @@
     "stellarwp/container-contract": "^1.0"
   },
   "require-dev": {
-    "automattic/vipwpcs": "^2.3",
+    "automattic/vipwpcs": "^3.0.0",
     "dealerdirect/phpcodesniffer-composer-installer": "^0.7.2",
     "lucatume/di52": "3.0.0",
-    "lucatume/wp-browser": "^4.0",
+    "lucatume/wp-browser": "^3.2.3",
     "phpcompatibility/phpcompatibility-wp": "*",
     "phpunit/php-code-coverage": "^9.2",
     "szepeviktor/phpstan-wordpress": "^1.1",
     "the-events-calendar/coding-standards": "dev-master",
-    "wp-coding-standards/wpcs": "^2.3"
+    "wp-coding-standards/wpcs": "^3.0.0"
   },
   "repositories": [
     {
@@ -55,14 +55,16 @@
     "compatibility:php-8.0": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.0",
     "compatibility:php-8.1": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.1",
     "compatibility:php-8.2": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.2",
+    "compatibility:php-8.3": "phpcs ./src -s --standard=PHPCompatibilityWP --runtime-set testVersion 8.3",
     "compatibility": [
       "@compatibility:php-7.1",
       "@compatibility:php-7.2",
       "@compatibility:php-7.3",
       "@compatibility:php-7.4",
       "@compatibility:php-8.0",
       "@compatibility:php-8.1",
-      "@compatibility:php-8.2"
+      "@compatibility:php-8.2",
+      "@compatibility:php-8.3"
     ]
   },
   "scripts-descriptions": {