Kicking off the PHP SDK

.github/workflows/codeql.yml

@@ -0,0 +1,88 @@
+# PHP is not supported by CodeQL, so this workflow runs PHPStan and uploads
+# its findings as SARIF to GitHub Code Scanning (Security > Code scanning).
+# It is the single PHPStan gate for the repo: findings are uploaded to the
+# Security tab AND fail the workflow (and thus block the PR).
+#
+# Scanner:  PHPStan 2.x (reuses the repo's phpstan.neon)
+# Formatter: jbelien/phpstan-sarif-formatter (installed CI-only, not committed)
+# Upload:   github/codeql-action/upload-sarif@v4
+#
+# Docs: https://docs.github.com/en/code-security/code-scanning/integrating-with-code-scanning/uploading-a-sarif-file-to-github
+name: "Code Scanning (PHP)"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+  schedule:
+    - cron: '15 9 * * 4'
+
+jobs:
+  phpstan-sarif:
+    name: PHPStan → SARIF
+    runs-on: ubuntu-latest
+    permissions:
+      security-events: write
+      contents: read
+      actions: read
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          tools: composer:v2
+          coverage: none
+
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.composer/cache
+          key: composer-${{ hashFiles('composer.json') }}
+          restore-keys: composer-
+
+      - name: Install project dependencies
+        run: composer install --no-interaction --no-progress
+
+      - name: Install PHPStan SARIF formatter (CI-only)
+        run: composer require --dev --no-interaction --no-progress --no-scripts jbelien/phpstan-sarif-formatter
+
+      - name: Generate SARIF PHPStan config
+        run: |
+          cat > phpstan-sarif.neon <<'NEON'
+          includes:
+              - phpstan.neon
+          services:
+              errorFormatter.sarif:
+                  class: PHPStanSarifErrorFormatter\SarifErrorFormatter
+                  arguments:
+                      relativePathHelper: @simpleRelativePathHelper
+                      currentWorkingDirectory: %currentWorkingDirectory%
+                      pretty: true
+          NEON
+
+      - name: Run PHPStan (SARIF output)
+        id: phpstan
+        continue-on-error: true
+        run: |
+          vendor/bin/phpstan analyse \
+            --configuration=phpstan-sarif.neon \
+            --error-format=sarif \
+            --memory-limit=512M \
+            --no-progress \
+            > phpstan.sarif
+
+      - name: Upload SARIF to GitHub Code Scanning
+        if: always()
+        uses: github/codeql-action/upload-sarif@v4
+        with:
+          sarif_file: phpstan.sarif
+          category: phpstan
+
+      - name: Fail workflow if PHPStan reported findings
+        if: steps.phpstan.outcome == 'failure'
+        run: |
+          echo "PHPStan reported findings — see Security → Code scanning for details."
+          exit 1

.github/workflows/qa.yml

@@ -0,0 +1,103 @@
+name: Quality Checks
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  lint:
+    name: Code Style
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          tools: composer:v2
+          coverage: none
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.composer/cache
+          key: composer-${{ hashFiles('composer.json') }}
+          restore-keys: composer-
+      - run: composer install --no-interaction --no-progress
+      - run: composer cs-check
+
+  validate:
+    name: Monorepo Validation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          tools: composer:v2
+          coverage: none
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.composer/cache
+          key: composer-${{ hashFiles('composer.json') }}
+          restore-keys: composer-
+      - run: composer install --no-interaction --no-progress
+      - run: composer build:validate
+
+  test:
+    name: Tests (PHP ${{ matrix.php-version }}, ${{ matrix.dependency-preference }})
+    runs-on: ubuntu-latest
+    env:
+      CONVERT_STAGING_SDK_KEY: ${{ secrets.CONVERT_STAGING_SDK_KEY }}
+      CONVERT_STAGING_SDK_KEY2: ${{ secrets.CONVERT_STAGING_SDK_KEY2 }}
+      CONVERT_STAGING_SDK_KEY2_SECRET: ${{ secrets.CONVERT_STAGING_SDK_KEY2_SECRET }}
+    strategy:
+      fail-fast: false
+      matrix:
+        php-version: ['8.2', '8.3', '8.4']
+        dependency-preference: ['prefer-lowest', 'prefer-stable']
+    steps:
+      - uses: actions/checkout@v4
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php-version }}
+          tools: composer:v2
+          coverage: pcov
+      - name: Cache Composer dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.composer/cache
+          key: composer-php${{ matrix.php-version }}-${{ matrix.dependency-preference }}-${{ hashFiles('composer.json') }}
+          restore-keys: |
+            composer-php${{ matrix.php-version }}-${{ matrix.dependency-preference }}-
+            composer-php${{ matrix.php-version }}-
+      - name: Install dependencies
+        run: composer update --${{ matrix.dependency-preference }} --prefer-stable --no-interaction --no-progress
+      - name: Run tests with coverage
+        if: matrix.php-version == '8.4' && matrix.dependency-preference == 'prefer-stable'
+        run: composer test:coverage:ci
+      - name: Enforce 85% coverage threshold
+        if: matrix.php-version == '8.4' && matrix.dependency-preference == 'prefer-stable'
+        run: |
+          php -r "
+            \$x = new SimpleXMLElement(file_get_contents('coverage.xml'));
+            \$m = \$x->project->metrics;
+            \$statements = (int)\$m['statements'];
+            if (\$statements === 0) { echo 'Error: zero statements in coverage report'; exit(1); }
+            \$pct = round(((int)\$m['coveredstatements'] / \$statements) * 100, 2);
+            echo \"Code coverage: {\$pct}%\n\";
+            exit(\$pct >= 85.0 ? 0 : 1);
+          "
+      - name: Upload coverage report
+        if: matrix.php-version == '8.4' && matrix.dependency-preference == 'prefer-stable'
+        uses: actions/upload-artifact@v4
+        with:
+          name: coverage-report
+          path: coverage.xml
+          retention-days: 30
+      - name: Run tests without coverage
+        if: matrix.php-version != '8.4' || matrix.dependency-preference != 'prefer-stable'
+        run: composer test
+      - name: Run cross-SDK parity tests
+        run: composer test:cross-sdk

.github/workflows/release.yml

@@ -0,0 +1,43 @@
+name: Release
+
+on:
+  workflow_run:
+    workflows: ['CI']
+    types: [completed]
+    branches: [main]
+
+permissions:
+  contents: write
+
+jobs:
+  release:
+    name: Semantic Release
+    runs-on: ubuntu-latest
+    if: github.event.workflow_run.conclusion == 'success' && github.event.workflow_run.event == 'push'
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+          persist-credentials: true
+          token: ${{ secrets.GITHUB_TOKEN }}
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 'lts/*'
+
+      - uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.4'
+          tools: composer:v2
+          coverage: none
+
+      - name: Install PHP dependencies
+        run: composer install --no-interaction --no-progress
+
+      - name: Install Node dependencies
+        run: yarn install --immutable
+
+      - name: Run semantic-release
+        run: yarn release
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/split.yml

@@ -0,0 +1,50 @@
+name: Split Monorepo
+
+on:
+  workflow_dispatch:
+
+jobs:
+  split:
+    name: Split ${{ matrix.package.name }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        package:
+          - { name: 'Api', local_path: 'packages/Api', split_repository: 'php-sdk-api' }
+          - { name: 'Bucketing', local_path: 'packages/Bucketing', split_repository: 'php-sdk-bucketing' }
+          - { name: 'Data', local_path: 'packages/Data', split_repository: 'php-sdk-data' }
+          - { name: 'Enums', local_path: 'packages/Enums', split_repository: 'php-sdk-enums' }
+          - { name: 'Event', local_path: 'packages/Event', split_repository: 'php-sdk-event' }
+          - { name: 'Experience', local_path: 'packages/Experience', split_repository: 'php-sdk-experience' }
+          - { name: 'Logger', local_path: 'packages/Logger', split_repository: 'php-sdk-logger' }
+          - { name: 'Php-sdk', local_path: 'packages/Php-sdk', split_repository: 'php-sdk' }
+          - { name: 'Rules', local_path: 'packages/Rules', split_repository: 'php-sdk-rules' }
+          - { name: 'Segments', local_path: 'packages/Segments', split_repository: 'php-sdk-segments' }
+          - { name: 'Types', local_path: 'packages/Types', split_repository: 'php-sdk-types' }
+          - { name: 'Utils', local_path: 'packages/Utils', split_repository: 'php-sdk-utils' }
+    env:
+      GITHUB_TOKEN: ${{ secrets.SPLIT_TOKEN }}
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - if: "!startsWith(github.ref, 'refs/tags/')"
+        uses: danharrin/monorepo-split-github-action@v2.4.4
+        with:
+          package_directory: ${{ matrix.package.local_path }}
+          repository_organization: 'convertcom'
+          repository_name: ${{ matrix.package.split_repository }}
+          user_name: 'convert-ci-bot'
+          user_email: 'ci@convert.com'
+
+      - if: "startsWith(github.ref, 'refs/tags/')"
+        uses: danharrin/monorepo-split-github-action@v2.4.4
+        with:
+          tag: ${{ github.ref_name }}
+          package_directory: ${{ matrix.package.local_path }}
+          repository_organization: 'convertcom'
+          repository_name: ${{ matrix.package.split_repository }}
+          user_name: 'convert-ci-bot'
+          user_email: 'ci@convert.com'

.gitignore

@@ -0,0 +1,11 @@
+/vendor/
+/packages/*/vendor/
+/packages/*/composer.lock
+.DS_Store
+.phpunit.result.cache
+coverage-report/
+coverage.xml
+.php-cs-fixer.cache
+node_modules/
+.pnp.*
+.yarn/

.php-cs-fixer.dist.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+$directories = [
+    __DIR__ . '/packages/Api/src',
+    __DIR__ . '/packages/Api/tests',
+    __DIR__ . '/packages/Bucketing/src',
+    __DIR__ . '/packages/Bucketing/tests',
+    __DIR__ . '/packages/Data/src',
+    __DIR__ . '/packages/Data/tests',
+    __DIR__ . '/packages/Enums/src',
+    __DIR__ . '/packages/Event/src',
+    __DIR__ . '/packages/Event/tests',
+    __DIR__ . '/packages/Experience/src',
+    __DIR__ . '/packages/Experience/tests',
+    __DIR__ . '/packages/Logger/src',
+    __DIR__ . '/packages/Logger/tests',
+    __DIR__ . '/packages/Php-sdk/src',
+    __DIR__ . '/packages/Php-sdk/tests',
+    __DIR__ . '/packages/Rules/src',
+    __DIR__ . '/packages/Rules/tests',
+    __DIR__ . '/packages/Segments/src',
+    __DIR__ . '/packages/Segments/tests',
+    __DIR__ . '/packages/Utils/src',
+    __DIR__ . '/packages/Utils/tests',
+    __DIR__ . '/tests/CrossSdk',
+];
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(array_filter($directories, 'is_dir'))
+    ->name('*.php');
+
+return (new PhpCsFixer\Config())
+    ->setRules([
+        '@PSR12' => true,
+        'strict_param' => true,
+        'declare_strict_types' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'no_unused_imports' => true,
+        'ordered_imports' => ['sort_algorithm' => 'alpha'],
+        'single_quote' => true,
+        'trailing_comma_in_multiline' => true,
+    ])
+    ->setFinder($finder)
+    ->setRiskyAllowed(true);

.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules