Merge pull request #2 from MattitjaAB/Remove-site

Remove site

.github/workflows/run-tests.yml

@@ -17,7 +17,7 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest, windows-latest]
-        php: [8.4]
+        php: [8.4, 8.3]
         laravel: [11.*]
         stability: [prefer-lowest, prefer-stable]
         include:

.gitignore

@@ -30,3 +30,7 @@ phpstan.neon
 testbench.yaml
 /docs
 /coverage
+
+# Ignore Mac DS_Store files
+.DS_Store
+**/.DS_Store

CHANGELOG.md

@@ -1,3 +1,23 @@
 # Changelog
 
 All notable changes to `laravel-plausible-proxy` will be documented in this file.
+
+## v1.2 - 2025-01-31
+
+**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.1...v1.2
+
+## v1.1 - 2025-01-31
+
+### What's Changed
+
+* Refactor event forwarding and improve test coverage by @mathiaspalmqvist in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/1
+
+### New Contributors
+
+* @mathiaspalmqvist made their first contribution in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/1
+
+**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.0...v1.1
+
+## First release - 2025-01-30
+
+**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/commits/v1.0

README.md

@@ -5,11 +5,11 @@
 [![GitHub Code Style Action Status](https://img.shields.io/github/actions/workflow/status/mattitjaab/laravel-plausible-proxy/fix-php-code-style-issues.yml?branch=main&label=code%20style&style=flat-square)](https://github.com/mattitjaab/laravel-plausible-proxy/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
 [![Total Downloads](https://img.shields.io/packagist/dt/mattitjaab/laravel-plausible-proxy.svg?style=flat-square)](https://packagist.org/packages/mattitjaab/laravel-plausible-proxy)
 
-A Laravel package for proxying Plausible Analytics, improving performance and privacy.
+A Laravel package for proxying Plausible Analytics, improving performance.
 
 ## Requirements
 - Laravel 11
-- PHP 8.4+
+- PHP 8.3+
 
 ## 🚀 Installation
 
@@ -26,27 +26,15 @@ A Laravel package for proxying Plausible Analytics, improving performance and pr
 3. Add the following environment variables to your `.env` file:
    ```env
    PLAUSIBLE_DOMAIN=https://plausible.io
-   PLAUSIBLE_SITE=example.com
-   ```
-
-4. **(Optional)** If you want to use Laravel Queues to send events in the background, ensure your queue driver is set up correctly:
-   ```env
-   QUEUE_CONNECTION=database
-   ```
-   Then run migrations to create the necessary queue tables:
-   ```sh
-   php artisan queue:table
-   php artisan migrate
    ```
 
 ## ⚙️ Configuration
 
-The `config/plausible-proxy.php` file allows you to customize the package settings:
+The `config/plausible-proxy.php` file allows you to customize the plausible domain:
 
 ```php
 return [
     'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
-    'site' => env('PLAUSIBLE_SITE', 'example.com'),
 ];
 ```
 
@@ -63,21 +51,13 @@ After installation, you can include the script like this:
 The route `/js/script.js` is automatically handled and caches the script for **6 hours**.
 
 ### **2. Sending Events to Plausible**
-Instead of sending events directly to `plausible.io`, you can now send them to `/api/event`, and they will be queued and processed asynchronously.
+Instead of sending events directly to plausible.io, the script is loaded from /js/script.js and proxies the request to Plausible via /api/event, helping to prevent blocking by ad blockers.
-
-Example request:
-```sh
-curl -X POST "https://example.com/api/event" \
-     -H "Content-Type: application/json" \
-     -d '{"n":"pageview","u":"https://example.com/page","d":"example.com"}'
-```
 
 ## ✅ Features
 
-- 🚀 **Fast & Optimized**: Caches the Plausible script to reduce external calls.
+- 🚀 **Fast & Optimized**: Caches the Plausible script to reduce external calls. 
-- 🔒 **Privacy-Friendly**: Prevents direct calls to `plausible.io`.
+- ✅ No issues with ad blockers: Proxies the request via a local API endpoint.
-- 📊 **Improved Performance**: Events are processed via Laravel Queues to avoid blocking user interactions.
+- 🛠 **Fully Configurable**: Easily set your own Plausible instance via `.env`.
-- 🛠 **Fully Configurable**: Easily set your own Plausible instance and domain via `.env`.
 
 ## 🛠 Testing
 

composer.json

@@ -18,7 +18,7 @@
         }
     ],
     "require": {
-        "php": "^8.4",
+        "php": "^8.3",
         "spatie/laravel-package-tools": "^1.16",
         "illuminate/contracts": "^10.0||^11.0"
     },

config/plausible-proxy.php

@@ -4,5 +4,4 @@
 
 return [
     'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
-    'site' => env('PLAUSIBLE_SITE', 'example.com'),
 ];

routes/api.php

@@ -1,13 +1,18 @@
 <?php
 
 use Illuminate\Http\Request;
-use Illuminate\Support\Facades\Concurrency;
 use Illuminate\Support\Facades\Http;
 use Illuminate\Support\Facades\Route;
 use Illuminate\Support\Facades\Validator;
 
 Route::post('api/event', function (Request $request) {
-    $validator = Validator::make($request->all(), [
+    $data = json_decode($request->getContent(), true);
+
+    if (json_last_error() !== JSON_ERROR_NONE) {
+        return response()->json(['error' => 'Invalid JSON format'], 422);
+    }
+
+    $validator = Validator::make($data, [
         'n' => 'required|string',
         'u' => 'required|url',
         'd' => 'required|string',
@@ -20,7 +25,11 @@ Route::post('api/event', function (Request $request) {
         return response()->json(['status' => 'error', 'errors' => $validator->errors()], 422);
     }
 
-    Concurrency::defer(fn () => Http::post(config('plausible-proxy.domain').'/api/event', $request->all()));
+    $headers = collect($request->headers->all())
+        ->mapWithKeys(fn ($value, $key) => [$key => is_array($value) ? implode(', ', $value) : $value])
+        ->all();
+
+    Http::withHeaders($headers)->post(config('plausible-proxy.domain').'/api/event', $data);
 
     return response()->json(['status' => 'queued']);
 });

tests/PlausibleProxyTest.php

@@ -15,7 +15,7 @@ it('returns plausible script from cache', function () {
 
 it('fetches plausible script if not cached', function () {
     Http::fake([
-        'https://plausible.io/js/script.js' => Http::response('console.log("Plausible script");', 200),
+        config('plausible-proxy.domain').'/js/script.js' => Http::response('console.log("Plausible script");', 200),
     ]);
 
     $response = $this->get('/js/script.js');
@@ -29,7 +29,7 @@ it('fetches plausible script if not cached', function () {
 
 it('handles failed script fetch', function () {
     Http::fake([
-        'https://plausible.io/js/script.js' => Http::response('', 500),
+        config('plausible-proxy.domain').'/js/script.js' => Http::response('', 500),
     ]);
 
     $response = $this->get('/js/script.js');
@@ -49,26 +49,35 @@ it('rejects invalid event data', function () {
         ->assertJsonStructure(['status', 'errors']);
 });
 
-it('accepts valid event data and defers request', function () {
+it('accepts valid event data and forwards headers', function () {
-    Http::fake();
+    config()->set('plausible-proxy.domain', 'https://plausible.io');
 
-    $concurrencyMock = Mockery::mock('alias:Illuminate\Support\Facades\Concurrency');
+    Http::fake([
-    $concurrencyMock->shouldReceive('defer')->once()->andReturnUsing(function ($callback) {
+        'https://plausible.io/api/event' => function ($request) {
-        $callback();
+            return Http::response(['status' => 'queued'], 200);
-    });
+        },
+    ]);
+
+    $headers = [
+        'User-Agent' => 'TestAgent',
+        'Accept' => 'application/json',
+    ];
 
     $response = $this->postJson('/api/event', [
         'n' => 'pageview',
         'u' => 'https://example.com/page',
         'd' => 'example.com',
-    ]);
+    ], $headers);
 
     $response->assertStatus(200)
         ->assertJson(['status' => 'queued']);
 
-    Http::assertSent(fn ($request) => $request->url() === config('plausible-proxy.domain').'/api/event' &&
+    Http::assertSentCount(1);
-        $request['n'] === 'pageview'
-    );
 
-    Mockery::close();
+    Http::assertSent(function ($request) {
+        return $request->url() === 'https://plausible.io/api/event'
+            && isset($request['n']) && $request['n'] === 'pageview'
+            && isset($request['u']) && $request['u'] === 'https://example.com/page'
+            && isset($request['d']) && $request['d'] === 'example.com';
+    });
 });