Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
c1338fad8b | ||
|
|
f235fa0aaa | ||
|
|
8e7bff9e61
|
||
|
|
77c0e38f84 | ||
|
|
91429ccd22 | ||
|
|
513ceb61a0
|
||
|
|
711c4eafbc | ||
|
|
a60e4cbdcf
|
||
|
|
7f8eff628f | ||
|
|
2196ec5d2d | ||
|
|
364fbe7b4b | ||
|
|
576c9803dc | ||
|
|
f451d4f0b8 | ||
|
|
fa4784c8ec | ||
|
|
cd00572702 | ||
|
|
8c042b27cf | ||
|
|
4aa046d7a7 | ||
|
|
859dcf99be | ||
|
|
2893ed0bc6 | ||
|
|
15e9fcc186 | ||
|
|
42404cc2cc | ||
|
|
b53047a28c | ||
|
|
5eff0cafe5 | ||
|
|
0e25ead520 | ||
|
|
67507d036a | ||
|
|
0ce7b51eff | ||
|
|
891c3d8ff8 | ||
|
|
e2062499ae | ||
|
|
1f4bbadab7 |
No files matched your search
@@ -1 +0,0 @@
|
|||||||
github: Mattitja AB
|
|
||||||
@@ -1,11 +1,8 @@
|
|||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
contact_links:
|
||||||
- name: Ask a question
|
- name: Ask a question or request a feature
|
||||||
url: https://github.com/mattitjaab/laravel-plausible-proxy/discussions/new?category=q-a
|
url: https://git.mattitja.se/Github/laravel-plausible-proxy/issues
|
||||||
about: Ask the community for help
|
about: Open an issue in the repository
|
||||||
- name: Request a feature
|
|
||||||
url: https://github.com/mattitjaab/laravel-plausible-proxy/discussions/new?category=ideas
|
|
||||||
about: Share ideas for new features
|
|
||||||
- name: Report a security issue
|
- name: Report a security issue
|
||||||
url: https://github.com/mattitjaab/laravel-plausible-proxy/security/policy
|
url: mailto:hej@mattitja.se
|
||||||
about: Learn how to notify us for sensitive bugs
|
about: Please report security issues privately by email
|
||||||
@@ -14,7 +14,7 @@ jobs:
|
|||||||
|
|
||||||
- name: Dependabot metadata
|
- name: Dependabot metadata
|
||||||
id: metadata
|
id: metadata
|
||||||
uses: dependabot/fetch-metadata@v2.3.0
|
uses: dependabot/fetch-metadata@v2.5.0
|
||||||
with:
|
with:
|
||||||
github-token: "${{ secrets.GITHUB_TOKEN }}"
|
github-token: "${{ secrets.GITHUB_TOKEN }}"
|
||||||
|
|
||||||
|
|||||||
@@ -20,7 +20,7 @@ jobs:
|
|||||||
ref: ${{ github.head_ref }}
|
ref: ${{ github.head_ref }}
|
||||||
|
|
||||||
- name: Fix PHP code style issues
|
- name: Fix PHP code style issues
|
||||||
uses: aglipanci/laravel-pint-action@2.4
|
uses: aglipanci/laravel-pint-action@2.6
|
||||||
|
|
||||||
- name: Commit changes
|
- name: Commit changes
|
||||||
uses: stefanzweifel/git-auto-commit-action@v5
|
uses: stefanzweifel/git-auto-commit-action@v5
|
||||||
|
|||||||
@@ -16,14 +16,35 @@ jobs:
|
|||||||
strategy:
|
strategy:
|
||||||
fail-fast: true
|
fail-fast: true
|
||||||
matrix:
|
matrix:
|
||||||
os: [ubuntu-latest, windows-latest]
|
os: [ubuntu-latest]
|
||||||
php: [8.4, 8.3]
|
php: [8.3, 8.4]
|
||||||
laravel: [11.*]
|
laravel: [11.*, 12.*, 13.*]
|
||||||
stability: [prefer-lowest, prefer-stable]
|
stability: [prefer-lowest, prefer-stable]
|
||||||
include:
|
include:
|
||||||
- laravel: 11.*
|
- laravel: 11.*
|
||||||
|
php: 8.3
|
||||||
testbench: 9.*
|
testbench: 9.*
|
||||||
carbon: ^2.63
|
carbon: ^2.63
|
||||||
|
- laravel: 11.*
|
||||||
|
php: 8.4
|
||||||
|
testbench: 9.*
|
||||||
|
carbon: ^2.63
|
||||||
|
- laravel: 12.*
|
||||||
|
php: 8.3
|
||||||
|
testbench: 10.*
|
||||||
|
carbon: ^3.8.4
|
||||||
|
- laravel: 12.*
|
||||||
|
php: 8.4
|
||||||
|
testbench: 10.*
|
||||||
|
carbon: ^3.8.4
|
||||||
|
- laravel: 13.*
|
||||||
|
php: 8.3
|
||||||
|
testbench: 11.*
|
||||||
|
carbon: ^3.8.4
|
||||||
|
- laravel: 13.*
|
||||||
|
php: 8.4
|
||||||
|
testbench: 11.*
|
||||||
|
carbon: ^3.8.4
|
||||||
|
|
||||||
name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
|
name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
|
||||||
|
|
||||||
@@ -45,7 +66,12 @@ jobs:
|
|||||||
|
|
||||||
- name: Install dependencies
|
- name: Install dependencies
|
||||||
run: |
|
run: |
|
||||||
composer require "laravel/framework:${{ matrix.laravel }}" "orchestra/testbench:${{ matrix.testbench }}" "nesbot/carbon:${{ matrix.os == 'windows-latest' && '^^^' || '' }}${{ matrix.carbon }}" --no-interaction --no-update
|
composer require \
|
||||||
|
"laravel/framework:${{ matrix.laravel }}" \
|
||||||
|
"orchestra/testbench:${{ matrix.testbench }}" \
|
||||||
|
"nesbot/carbon:${{ matrix.carbon }}" \
|
||||||
|
--no-interaction --no-update
|
||||||
|
|
||||||
composer update --${{ matrix.stability }} --prefer-dist --no-interaction
|
composer update --${{ matrix.stability }} --prefer-dist --no-interaction
|
||||||
|
|
||||||
- name: List Installed Dependencies
|
- name: List Installed Dependencies
|
||||||
|
|||||||
@@ -2,6 +2,36 @@
|
|||||||
|
|
||||||
All notable changes to `laravel-plausible-proxy` will be documented in this file.
|
All notable changes to `laravel-plausible-proxy` will be documented in this file.
|
||||||
|
|
||||||
|
## v1.5 - 2025-06-25
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Cleanup by @mathiaspalmqvist in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/8
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.4...v1.5
|
||||||
|
|
||||||
|
## v1.4 - 2025-06-16
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Bump aglipanci/laravel-pint-action from 2.4 to 2.5 by @dependabot in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/3
|
||||||
|
* Bump dependabot/fetch-metadata from 2.3.0 to 2.4.0 by @dependabot in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/4
|
||||||
|
* Added support for L12 by @mathiaspalmqvist in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/7
|
||||||
|
|
||||||
|
### New Contributors
|
||||||
|
|
||||||
|
* @dependabot made their first contribution in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/3
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.3...v1.4
|
||||||
|
|
||||||
|
## v1.3 - 2025-01-31
|
||||||
|
|
||||||
|
### What's Changed
|
||||||
|
|
||||||
|
* Remove site by @mathiaspalmqvist in https://github.com/MattitjaAB/laravel-plausible-proxy/pull/2
|
||||||
|
|
||||||
|
**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.2...v1.3
|
||||||
|
|
||||||
## v1.2 - 2025-01-31
|
## v1.2 - 2025-01-31
|
||||||
|
|
||||||
**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.1...v1.2
|
**Full Changelog**: https://github.com/MattitjaAB/laravel-plausible-proxy/compare/v1.1...v1.2
|
||||||
|
|||||||
@@ -1,21 +1,22 @@
|
|||||||
# laravel-plausible-proxy
|
# laravel-plausible-proxy
|
||||||
|
|
||||||
[](https://packagist.org/packages/mattitjaab/laravel-plausible-proxy)
|
[](https://packagist.org/packages/mattitja/laravel-plausible-proxy)
|
||||||
[](https://github.com/mattitjaab/laravel-plausible-proxy/actions?query=workflow%3Arun-tests+branch%3Amain)
|
[](https://git.mattitja.se/Github/laravel-plausible-proxy/actions?workflow=run-tests.yml)
|
||||||
[](https://github.com/mattitjaab/laravel-plausible-proxy/actions?query=workflow%3A"Fix+PHP+code+style+issues"+branch%3Amain)
|
[](https://git.mattitja.se/Github/laravel-plausible-proxy/actions?workflow=fix-php-code-style-issues.yml)
|
||||||
[](https://packagist.org/packages/mattitjaab/laravel-plausible-proxy)
|
[](https://packagist.org/packages/mattitja/laravel-plausible-proxy)
|
||||||
|
|
||||||
A Laravel package for proxying Plausible Analytics, improving performance.
|
A Laravel package for proxying Plausible Analytics, improving performance and privacy.
|
||||||
|
|
||||||
## Requirements
|
## Requirements
|
||||||
- Laravel 11
|
|
||||||
- PHP 8.3+
|
|
||||||
|
|
||||||
## 🚀 Installation
|
- Laravel 11, 12 or 13
|
||||||
|
- PHP 8.3 or 8.4
|
||||||
|
|
||||||
|
## Installation
|
||||||
|
|
||||||
1. Install the package via Composer:
|
1. Install the package via Composer:
|
||||||
```sh
|
```sh
|
||||||
composer require mattitjaab/laravel-plausible-proxy
|
composer require mattitja/laravel-plausible-proxy
|
||||||
```
|
```
|
||||||
|
|
||||||
2. Publish the configuration file:
|
2. Publish the configuration file:
|
||||||
@@ -23,45 +24,86 @@ A Laravel package for proxying Plausible Analytics, improving performance.
|
|||||||
php artisan vendor:publish --tag=plausible-proxy-config
|
php artisan vendor:publish --tag=plausible-proxy-config
|
||||||
```
|
```
|
||||||
|
|
||||||
3. Add the following environment variables to your `.env` file:
|
3. Add the following environment variable to your `.env` file:
|
||||||
```env
|
```env
|
||||||
PLAUSIBLE_DOMAIN=https://plausible.io
|
PLAUSIBLE_DOMAIN=https://plausible.io
|
||||||
```
|
```
|
||||||
|
|
||||||
## ⚙️ Configuration
|
## Configuration
|
||||||
|
|
||||||
The `config/plausible-proxy.php` file allows you to customize the plausible domain:
|
The `config/plausible-proxy.php` file allows you to customize the Plausible domain:
|
||||||
|
|
||||||
```php
|
```php
|
||||||
return [
|
return [
|
||||||
'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
|
'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
|
||||||
|
'script' => env('PLAUSIBLE_SCRIPT', 'js/script.js'),
|
||||||
];
|
];
|
||||||
```
|
```
|
||||||
|
|
||||||
## 🔥 Usage
|
`PLAUSIBLE_SCRIPT` is the path of the script on your Plausible instance. Whatever script you choose, it is always served locally from `/js/script.js`.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
### 1. Proxying the JavaScript file
|
||||||
|
|
||||||
### **1. Proxying the JavaScript file**
|
|
||||||
This package proxies Plausible's `script.js` while caching it to improve performance and reduce external requests.
|
This package proxies Plausible's `script.js` while caching it to improve performance and reduce external requests.
|
||||||
|
|
||||||
After installation, you can include the script like this:
|
After installation, you can include the script like this:
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<script defer data-domain="example.com" src="/js/script.js"></script>
|
<script defer data-domain="example.com" src="/js/script.js"></script>
|
||||||
```
|
```
|
||||||
|
|
||||||
The route `/js/script.js` is automatically handled and caches the script for **6 hours**.
|
The route `/js/script.js` is handled automatically and caches the script for 6 hours.
|
||||||
|
|
||||||
### **2. Sending Events to Plausible**
|
#### Site-specific script (pa-XXXXX.js)
|
||||||
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.
|
|
||||||
|
|
||||||
## ✅ Features
|
Plausible's current installation instructions use a site-specific script such as `https://plausible.io/js/pa-12345ABCDE.js`, where optional measurements (outbound links, file downloads, etc.) are configured in the Plausible dashboard. To use it, set the script path in your `.env`:
|
||||||
|
|
||||||
- 🚀 **Fast & Optimized**: Caches the Plausible script to reduce external calls.
|
```env
|
||||||
- ✅ No issues with ad blockers: Proxies the request via a local API endpoint.
|
PLAUSIBLE_SCRIPT=js/pa-12345ABCDE.js
|
||||||
- 🛠 **Fully Configurable**: Easily set your own Plausible instance via `.env`.
|
```
|
||||||
|
|
||||||
## 🛠 Testing
|
Then load it locally and tell it to send events through the proxy with the `endpoint` option:
|
||||||
|
|
||||||
|
```html
|
||||||
|
<script async src="/js/script.js"></script>
|
||||||
|
<script>
|
||||||
|
window.plausible=window.plausible||function(){(plausible.q=plausible.q||[]).push(arguments)},plausible.init=plausible.init||function(i){plausible.o=i||{}};
|
||||||
|
plausible.init({ endpoint: '/api/event' })
|
||||||
|
</script>
|
||||||
|
```
|
||||||
|
|
||||||
|
#### Legacy script extensions
|
||||||
|
|
||||||
|
Legacy script variants work the same way, for example:
|
||||||
|
|
||||||
|
```env
|
||||||
|
PLAUSIBLE_SCRIPT=js/script.outbound-links.js
|
||||||
|
```
|
||||||
|
|
||||||
|
### 2. Sending events to Plausible
|
||||||
|
|
||||||
|
The script loaded from `/js/script.js` sends events to `/api/event` on your own domain, which forwards them to Plausible. This helps prevent blocking by ad blockers.
|
||||||
|
|
||||||
|
Only the visitor's `User-Agent` and IP address (as `X-Forwarded-For`) are forwarded to Plausible, which is what Plausible needs to count unique visitors. Cookies and other request headers are never forwarded.
|
||||||
|
|
||||||
|
If your application runs behind a load balancer or reverse proxy, make sure Laravel's [trusted proxies](https://laravel.com/docs/requests#configuring-trusted-proxies) are configured so the correct visitor IP is resolved.
|
||||||
|
|
||||||
|
## Upgrading from mattitjaab/laravel-plausible-proxy
|
||||||
|
|
||||||
|
Version 2.0 renames the package and its namespace:
|
||||||
|
|
||||||
|
1. Replace the package:
|
||||||
|
```sh
|
||||||
|
composer remove mattitjaab/laravel-plausible-proxy
|
||||||
|
composer require mattitja/laravel-plausible-proxy
|
||||||
|
```
|
||||||
|
2. If you reference any package classes directly, change the namespace from `MattitjaAB\LaravelPlausibleProxy` to `Mattitja\LaravelPlausibleProxy`.
|
||||||
|
3. Laravel 10 is no longer supported.
|
||||||
|
|
||||||
|
## Testing
|
||||||
|
|
||||||
You can run tests with:
|
|
||||||
```sh
|
```sh
|
||||||
composer test
|
composer test
|
||||||
```
|
```
|
||||||
@@ -70,18 +112,13 @@ composer test
|
|||||||
|
|
||||||
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
|
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
|
||||||
|
|
||||||
## Contributing
|
|
||||||
|
|
||||||
Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
|
|
||||||
|
|
||||||
## Security Vulnerabilities
|
## Security Vulnerabilities
|
||||||
|
|
||||||
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
|
Please report security vulnerabilities by email to hej@mattitja.se.
|
||||||
|
|
||||||
## Credits
|
## Credits
|
||||||
|
|
||||||
- [Mathias Palmqvist](https://github.com/mathiaspalmqvist)
|
- [Mathias Palmqvist](https://github.com/mathiaspalmqvist)
|
||||||
- [All Contributors](../../contributors)
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
|
|||||||
+16
-22
@@ -1,14 +1,13 @@
|
|||||||
{
|
{
|
||||||
"name": "mattitjaab/laravel-plausible-proxy",
|
"name": "mattitja/laravel-plausible-proxy",
|
||||||
"description": "A Laravel package for proxying Plausible Analytics, improving performance and privacy.",
|
"description": "A Laravel package for proxying Plausible Analytics, improving performance and privacy.",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"Mattitja AB",
|
"Mattitja",
|
||||||
"MattitjaAB",
|
|
||||||
"laravel",
|
"laravel",
|
||||||
"laravel-plausible-proxy",
|
"laravel-plausible-proxy",
|
||||||
"plausible"
|
"plausible"
|
||||||
],
|
],
|
||||||
"homepage": "https://github.com/mattitjaab/laravel-plausible-proxy",
|
"homepage": "https://git.mattitja.se/Github/laravel-plausible-proxy",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"authors": [
|
"authors": [
|
||||||
{
|
{
|
||||||
@@ -20,31 +19,29 @@
|
|||||||
"require": {
|
"require": {
|
||||||
"php": "^8.3",
|
"php": "^8.3",
|
||||||
"spatie/laravel-package-tools": "^1.16",
|
"spatie/laravel-package-tools": "^1.16",
|
||||||
"illuminate/contracts": "^10.0||^11.0"
|
"illuminate/contracts": "^11.0||^12.0||^13.0"
|
||||||
},
|
},
|
||||||
"require-dev": {
|
"require-dev": {
|
||||||
"laravel/pint": "^1.14",
|
"laravel/pint": "^1.14",
|
||||||
"nunomaduro/collision": "^8.1.1||^7.10.0",
|
"nunomaduro/collision": "^8.1",
|
||||||
"larastan/larastan": "^2.9",
|
"larastan/larastan": "^3.0",
|
||||||
"orchestra/testbench": "^9.0.0||^8.22.0",
|
"orchestra/testbench": "^9.0||^10.0||^11.0",
|
||||||
"pestphp/pest": "^3.0",
|
"pestphp/pest": "^3.0||^4.0",
|
||||||
"pestphp/pest-plugin-arch": "^3.0",
|
"pestphp/pest-plugin-arch": "^3.0||^4.0",
|
||||||
"pestphp/pest-plugin-laravel": "^3.0",
|
"pestphp/pest-plugin-laravel": "^3.0||^4.0",
|
||||||
"phpstan/extension-installer": "^1.3",
|
"phpstan/extension-installer": "^1.3",
|
||||||
"phpstan/phpstan-deprecation-rules": "^1.1",
|
"phpstan/phpstan-deprecation-rules": "^2.0",
|
||||||
"phpstan/phpstan-phpunit": "^1.3",
|
"phpstan/phpstan-phpunit": "^2.0",
|
||||||
"spatie/laravel-ray": "^1.35"
|
"spatie/laravel-ray": "^1.35"
|
||||||
},
|
},
|
||||||
"autoload": {
|
"autoload": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"MattitjaAB\\LaravelPlausibleProxy\\": "src/",
|
"Mattitja\\LaravelPlausibleProxy\\": "src/"
|
||||||
"MattitjaAB\\LaravelPlausibleProxy\\Database\\Factories\\": "database/factories/"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"autoload-dev": {
|
"autoload-dev": {
|
||||||
"psr-4": {
|
"psr-4": {
|
||||||
"MattitjaAB\\LaravelPlausibleProxy\\Tests\\": "tests/",
|
"Mattitja\\LaravelPlausibleProxy\\Tests\\": "tests/"
|
||||||
"Workbench\\App\\": "workbench/app/"
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
@@ -65,11 +62,8 @@
|
|||||||
"extra": {
|
"extra": {
|
||||||
"laravel": {
|
"laravel": {
|
||||||
"providers": [
|
"providers": [
|
||||||
"MattitjaAB\\LaravelPlausibleProxy\\LaravelPlausibleProxyServiceProvider"
|
"Mattitja\\LaravelPlausibleProxy\\LaravelPlausibleProxyServiceProvider"
|
||||||
],
|
]
|
||||||
"aliases": {
|
|
||||||
"LaravelPlausibleProxy": "MattitjaAB\\LaravelPlausibleProxy\\Facades\\LaravelPlausibleProxy"
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"minimum-stability": "dev",
|
"minimum-stability": "dev",
|
||||||
|
|||||||
@@ -3,5 +3,17 @@
|
|||||||
// Config for Laravel Plausible Proxy
|
// Config for Laravel Plausible Proxy
|
||||||
|
|
||||||
return [
|
return [
|
||||||
|
/*
|
||||||
|
* The Plausible instance to proxy, e.g. https://plausible.io or your
|
||||||
|
* self-hosted instance.
|
||||||
|
*/
|
||||||
'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
|
'domain' => env('PLAUSIBLE_DOMAIN', 'https://plausible.io'),
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Path of the script to fetch from the Plausible instance. Use this for
|
||||||
|
* site-specific scripts (e.g. js/pa-12345ABCDE.js) or legacy script
|
||||||
|
* extensions (e.g. js/script.outbound-links.js). The script is always
|
||||||
|
* served locally from /js/script.js.
|
||||||
|
*/
|
||||||
|
'script' => env('PLAUSIBLE_SCRIPT', 'js/script.js'),
|
||||||
];
|
];
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace MattitjaAB\LaravelPlausibleProxy\Database\Factories;
|
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
|
||||||
|
|
||||||
/*
|
|
||||||
class ModelFactory extends Factory
|
|
||||||
{
|
|
||||||
protected $model = YourModel::class;
|
|
||||||
|
|
||||||
public function definition()
|
|
||||||
{
|
|
||||||
return [
|
|
||||||
|
|
||||||
];
|
|
||||||
}
|
|
||||||
}
|
|
||||||
*/
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
use Illuminate\Database\Migrations\Migration;
|
|
||||||
use Illuminate\Database\Schema\Blueprint;
|
|
||||||
use Illuminate\Support\Facades\Schema;
|
|
||||||
|
|
||||||
return new class extends Migration
|
|
||||||
{
|
|
||||||
public function up()
|
|
||||||
{
|
|
||||||
Schema::create('laravel_plausible_proxy_table', function (Blueprint $table) {
|
|
||||||
$table->id();
|
|
||||||
|
|
||||||
// add fields
|
|
||||||
|
|
||||||
$table->timestamps();
|
|
||||||
});
|
|
||||||
}
|
|
||||||
};
|
|
||||||
+4
-1
@@ -6,7 +6,10 @@ parameters:
|
|||||||
paths:
|
paths:
|
||||||
- src
|
- src
|
||||||
- config
|
- config
|
||||||
- database
|
|
||||||
tmpDir: build/phpstan
|
tmpDir: build/phpstan
|
||||||
checkOctaneCompatibility: true
|
checkOctaneCompatibility: true
|
||||||
checkModelProperties: true
|
checkModelProperties: true
|
||||||
|
ignoreErrors:
|
||||||
|
-
|
||||||
|
identifier: larastan.noEnvCallsOutsideOfConfig
|
||||||
|
path: config/plausible-proxy.php
|
||||||
+1
-1
@@ -16,7 +16,7 @@
|
|||||||
backupStaticProperties="false"
|
backupStaticProperties="false"
|
||||||
>
|
>
|
||||||
<testsuites>
|
<testsuites>
|
||||||
<testsuite name="MattitjaAB Test Suite">
|
<testsuite name="Mattitja Test Suite">
|
||||||
<directory>tests</directory>
|
<directory>tests</directory>
|
||||||
</testsuite>
|
</testsuite>
|
||||||
</testsuites>
|
</testsuites>
|
||||||
|
|||||||
Whitespace-only changes.
+2
-31
@@ -1,35 +1,6 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
use Illuminate\Http\Request;
|
|
||||||
use Illuminate\Support\Facades\Http;
|
|
||||||
use Illuminate\Support\Facades\Route;
|
use Illuminate\Support\Facades\Route;
|
||||||
use Illuminate\Support\Facades\Validator;
|
use Mattitja\LaravelPlausibleProxy\Http\Controllers\PlausibleEventApiController;
|
||||||
|
|
||||||
Route::post('api/event', function (Request $request) {
|
Route::post('api/event', PlausibleEventApiController::class);
|
||||||
$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',
|
|
||||||
'r' => 'nullable|url',
|
|
||||||
'm' => 'nullable|string',
|
|
||||||
'p' => 'nullable|array',
|
|
||||||
]);
|
|
||||||
|
|
||||||
if ($validator->fails()) {
|
|
||||||
return response()->json(['status' => 'error', 'errors' => $validator->errors()], 422);
|
|
||||||
}
|
|
||||||
|
|
||||||
$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']);
|
|
||||||
});
|
|
||||||
+2
-30
@@ -1,34 +1,6 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
use Illuminate\Support\Facades\Cache;
|
|
||||||
use Illuminate\Support\Facades\Http;
|
|
||||||
use Illuminate\Support\Facades\Route;
|
use Illuminate\Support\Facades\Route;
|
||||||
|
use Mattitja\LaravelPlausibleProxy\Http\Controllers\PlausibleScriptProxyController;
|
||||||
|
|
||||||
Route::get('/js/script.js', function () {
|
Route::get('/js/script.js', PlausibleScriptProxyController::class);
|
||||||
$plausibleDomain = config('plausible-proxy.domain');
|
|
||||||
|
|
||||||
if (Cache::has('plausible_script_js')) {
|
|
||||||
return response(Cache::get('plausible_script_js'))
|
|
||||||
->header('Content-Type', 'application/javascript')
|
|
||||||
->header('Cache-Control', 'public, max-age=86400');
|
|
||||||
}
|
|
||||||
|
|
||||||
$response = Http::timeout(5)->get("{$plausibleDomain}/js/script.js");
|
|
||||||
|
|
||||||
if ($response->successful()) {
|
|
||||||
$script = $response->body();
|
|
||||||
Cache::put('plausible_script_js', $script, now()->addHours(6));
|
|
||||||
|
|
||||||
return response($script)
|
|
||||||
->header('Content-Type', 'application/javascript')
|
|
||||||
->header('Cache-Control', 'public, max-age=86400');
|
|
||||||
}
|
|
||||||
|
|
||||||
return response('Error fetching Plausible script', 500);
|
|
||||||
});
|
|
||||||
|
|
||||||
Route::get('/api/routes', function () {
|
|
||||||
return response()->json(
|
|
||||||
collect(Route::getRoutes())->map(fn ($route) => $route->uri())
|
|
||||||
);
|
|
||||||
});
|
|
||||||
@@ -1,19 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace MattitjaAB\LaravelPlausibleProxy\Commands;
|
|
||||||
|
|
||||||
use Illuminate\Console\Command;
|
|
||||||
|
|
||||||
class LaravelPlausibleProxyCommand extends Command
|
|
||||||
{
|
|
||||||
public $signature = 'laravel-plausible-proxy';
|
|
||||||
|
|
||||||
public $description = 'My command';
|
|
||||||
|
|
||||||
public function handle(): int
|
|
||||||
{
|
|
||||||
$this->comment('All done');
|
|
||||||
|
|
||||||
return self::SUCCESS;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -1,16 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace MattitjaAB\LaravelPlausibleProxy\Facades;
|
|
||||||
|
|
||||||
use Illuminate\Support\Facades\Facade;
|
|
||||||
|
|
||||||
/**
|
|
||||||
* @see \MattitjaAB\LaravelPlausibleProxy\LaravelPlausibleProxy
|
|
||||||
*/
|
|
||||||
class LaravelPlausibleProxy extends Facade
|
|
||||||
{
|
|
||||||
protected static function getFacadeAccessor(): string
|
|
||||||
{
|
|
||||||
return \MattitjaAB\LaravelPlausibleProxy\LaravelPlausibleProxy::class;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Mattitja\LaravelPlausibleProxy\Http\Controllers;
|
||||||
|
|
||||||
|
use Illuminate\Http\Response;
|
||||||
|
use Illuminate\Support\Facades\Http;
|
||||||
|
use Mattitja\LaravelPlausibleProxy\Http\Requests\PlausibleEventRequest;
|
||||||
|
|
||||||
|
class PlausibleEventApiController
|
||||||
|
{
|
||||||
|
public function __invoke(PlausibleEventRequest $request): Response
|
||||||
|
{
|
||||||
|
$upstream = Http::withHeaders([
|
||||||
|
'User-Agent' => (string) $request->userAgent(),
|
||||||
|
'X-Forwarded-For' => (string) $request->ip(),
|
||||||
|
])->post(config('plausible-proxy.domain').'/api/event', $request->all());
|
||||||
|
|
||||||
|
return response($upstream->body(), $upstream->status())
|
||||||
|
->header('Content-Type', $upstream->header('Content-Type') ?: 'text/plain');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,34 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Mattitja\LaravelPlausibleProxy\Http\Controllers;
|
||||||
|
|
||||||
|
use Illuminate\Http\Client\RequestException;
|
||||||
|
use Illuminate\Http\Response;
|
||||||
|
use Illuminate\Support\Facades\Cache;
|
||||||
|
use Illuminate\Support\Facades\Http;
|
||||||
|
use Illuminate\Support\Facades\Log;
|
||||||
|
|
||||||
|
class PlausibleScriptProxyController
|
||||||
|
{
|
||||||
|
public function __invoke(): Response
|
||||||
|
{
|
||||||
|
$url = rtrim((string) config('plausible-proxy.domain'), '/')
|
||||||
|
.'/'.ltrim((string) config('plausible-proxy.script', 'js/script.js'), '/');
|
||||||
|
|
||||||
|
try {
|
||||||
|
$script = Cache::remember(
|
||||||
|
key: 'plausible_script_js:'.md5($url),
|
||||||
|
ttl: now()->addHours(6),
|
||||||
|
callback: fn () => Http::timeout(5)->get($url)->throw()->body(),
|
||||||
|
);
|
||||||
|
} catch (RequestException $e) {
|
||||||
|
Log::error('Failed to fetch Plausible script: '.$e->getMessage());
|
||||||
|
|
||||||
|
return response('Error fetching Plausible script', 500);
|
||||||
|
}
|
||||||
|
|
||||||
|
return response($script)
|
||||||
|
->header('Content-Type', 'application/javascript')
|
||||||
|
->header('Cache-Control', 'public, max-age=86400');
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,33 @@
|
|||||||
|
<?php
|
||||||
|
|
||||||
|
namespace Mattitja\LaravelPlausibleProxy\Http\Requests;
|
||||||
|
|
||||||
|
use Illuminate\Foundation\Http\FormRequest;
|
||||||
|
|
||||||
|
class PlausibleEventRequest extends FormRequest
|
||||||
|
{
|
||||||
|
public function authorize(): bool
|
||||||
|
{
|
||||||
|
return true;
|
||||||
|
}
|
||||||
|
|
||||||
|
public function rules(): array
|
||||||
|
{
|
||||||
|
return [
|
||||||
|
'n' => ['required', 'string'],
|
||||||
|
'u' => ['required', 'url'],
|
||||||
|
'd' => ['required', 'string'],
|
||||||
|
'r' => ['nullable', 'url'],
|
||||||
|
'm' => ['nullable', 'string'],
|
||||||
|
'p' => ['nullable', function (string $attribute, mixed $value, \Closure $fail) {
|
||||||
|
if (is_array($value)) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
if (! is_string($value) || ! is_array(json_decode($value, true))) {
|
||||||
|
$fail("The {$attribute} field must be an object or a JSON-encoded object.");
|
||||||
|
}
|
||||||
|
}],
|
||||||
|
];
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -1,5 +0,0 @@
|
|||||||
<?php
|
|
||||||
|
|
||||||
namespace MattitjaAB\LaravelPlausibleProxy;
|
|
||||||
|
|
||||||
class LaravelPlausibleProxy {}
|
|
||||||
@@ -1,6 +1,6 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace MattitjaAB\LaravelPlausibleProxy;
|
namespace Mattitja\LaravelPlausibleProxy;
|
||||||
|
|
||||||
use Spatie\LaravelPackageTools\Package;
|
use Spatie\LaravelPackageTools\Package;
|
||||||
use Spatie\LaravelPackageTools\PackageServiceProvider;
|
use Spatie\LaravelPackageTools\PackageServiceProvider;
|
||||||
|
|||||||
+1
-1
@@ -1,5 +1,5 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
use MattitjaAB\LaravelPlausibleProxy\Tests\TestCase;
|
use Mattitja\LaravelPlausibleProxy\Tests\TestCase;
|
||||||
|
|
||||||
uses(TestCase::class)->in(__DIR__);
|
uses(TestCase::class)->in(__DIR__);
|
||||||
@@ -1,35 +1,65 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
use Illuminate\Support\Facades\Cache;
|
|
||||||
use Illuminate\Support\Facades\Http;
|
use Illuminate\Support\Facades\Http;
|
||||||
|
|
||||||
it('returns plausible script from cache', function () {
|
it('fetches plausible script and caches it', function () {
|
||||||
Cache::put('plausible_script_js', 'console.log("Cached script");', now()->addHours(6));
|
|
||||||
|
|
||||||
$response = $this->get('/js/script.js');
|
|
||||||
|
|
||||||
$response->assertStatus(200)
|
|
||||||
->assertHeader('Content-Type', 'application/javascript')
|
|
||||||
->assertSee('Cached script');
|
|
||||||
});
|
|
||||||
|
|
||||||
it('fetches plausible script if not cached', function () {
|
|
||||||
Http::fake([
|
Http::fake([
|
||||||
config('plausible-proxy.domain').'/js/script.js' => Http::response('console.log("Plausible script");', 200),
|
'https://plausible.io/js/script.js' => Http::response('console.log("Plausible script");', 200),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
$response = $this->get('/js/script.js');
|
$this->get('/js/script.js')
|
||||||
|
->assertStatus(200)
|
||||||
$response->assertStatus(200)
|
|
||||||
->assertHeader('Content-Type', 'application/javascript')
|
->assertHeader('Content-Type', 'application/javascript')
|
||||||
->assertSee('Plausible script');
|
->assertSee('Plausible script');
|
||||||
|
|
||||||
expect(Cache::get('plausible_script_js'))->toBe('console.log("Plausible script");');
|
$this->get('/js/script.js')
|
||||||
|
->assertStatus(200)
|
||||||
|
->assertSee('Plausible script');
|
||||||
|
|
||||||
|
Http::assertSentCount(1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('fetches a custom script path', function () {
|
||||||
|
config()->set('plausible-proxy.script', 'js/pa-12345ABCDE.js');
|
||||||
|
|
||||||
|
Http::fake([
|
||||||
|
'https://plausible.io/js/pa-12345ABCDE.js' => Http::response('console.log("Custom script");', 200),
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->get('/js/script.js')
|
||||||
|
->assertStatus(200)
|
||||||
|
->assertSee('Custom script');
|
||||||
|
|
||||||
|
Http::assertSent(fn ($request) => $request->url() === 'https://plausible.io/js/pa-12345ABCDE.js');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handles trailing and leading slashes in domain and script path', function () {
|
||||||
|
config()->set('plausible-proxy.domain', 'https://plausible.example.com/');
|
||||||
|
config()->set('plausible-proxy.script', '/js/script.outbound-links.js');
|
||||||
|
|
||||||
|
Http::fake([
|
||||||
|
'https://plausible.example.com/js/script.outbound-links.js' => Http::response('console.log("Outbound");', 200),
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->get('/js/script.js')->assertStatus(200)->assertSee('Outbound');
|
||||||
|
});
|
||||||
|
|
||||||
|
it('does not serve a cached script after the script path changes', function () {
|
||||||
|
Http::fake([
|
||||||
|
'https://plausible.io/js/script.js' => Http::response('console.log("Old script");', 200),
|
||||||
|
'https://plausible.io/js/pa-12345ABCDE.js' => Http::response('console.log("New script");', 200),
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->get('/js/script.js')->assertSee('Old script');
|
||||||
|
|
||||||
|
config()->set('plausible-proxy.script', 'js/pa-12345ABCDE.js');
|
||||||
|
|
||||||
|
$this->get('/js/script.js')->assertSee('New script');
|
||||||
});
|
});
|
||||||
|
|
||||||
it('handles failed script fetch', function () {
|
it('handles failed script fetch', function () {
|
||||||
Http::fake([
|
Http::fake([
|
||||||
config('plausible-proxy.domain').'/js/script.js' => Http::response('', 500),
|
'https://plausible.io/js/script.js' => Http::response('', 500),
|
||||||
]);
|
]);
|
||||||
|
|
||||||
$response = $this->get('/js/script.js');
|
$response = $this->get('/js/script.js');
|
||||||
@@ -46,38 +76,72 @@ it('rejects invalid event data', function () {
|
|||||||
]);
|
]);
|
||||||
|
|
||||||
$response->assertStatus(422)
|
$response->assertStatus(422)
|
||||||
->assertJsonStructure(['status', 'errors']);
|
->assertJsonValidationErrors(['u' => 'The u field must be a valid URL.']);
|
||||||
});
|
});
|
||||||
|
|
||||||
it('accepts valid event data and forwards headers', function () {
|
it('forwards only user agent and client ip to plausible', function () {
|
||||||
config()->set('plausible-proxy.domain', 'https://plausible.io');
|
config()->set('plausible-proxy.domain', 'https://plausible.io');
|
||||||
|
|
||||||
Http::fake([
|
Http::fake([
|
||||||
'https://plausible.io/api/event' => function ($request) {
|
'https://plausible.io/api/event' => Http::response('ok', 202),
|
||||||
return Http::response(['status' => 'queued'], 200);
|
|
||||||
},
|
|
||||||
]);
|
]);
|
||||||
|
|
||||||
$headers = [
|
$response = $this->withServerVariables(['REMOTE_ADDR' => '203.0.113.7'])
|
||||||
'User-Agent' => 'TestAgent',
|
->postJson('/api/event', [
|
||||||
'Accept' => 'application/json',
|
|
||||||
];
|
|
||||||
|
|
||||||
$response = $this->postJson('/api/event', [
|
|
||||||
'n' => 'pageview',
|
'n' => 'pageview',
|
||||||
'u' => 'https://example.com/page',
|
'u' => 'https://example.com/page',
|
||||||
'd' => 'example.com',
|
'd' => 'example.com',
|
||||||
], $headers);
|
], [
|
||||||
|
'User-Agent' => 'TestAgent',
|
||||||
|
'Cookie' => 'laravel_session=secret',
|
||||||
|
'Authorization' => 'Bearer secret',
|
||||||
|
]);
|
||||||
|
|
||||||
$response->assertStatus(200)
|
$response->assertStatus(202);
|
||||||
->assertJson(['status' => 'queued']);
|
expect($response->getContent())->toBe('ok');
|
||||||
|
|
||||||
Http::assertSentCount(1);
|
Http::assertSentCount(1);
|
||||||
|
|
||||||
Http::assertSent(function ($request) {
|
Http::assertSent(function ($request) {
|
||||||
return $request->url() === 'https://plausible.io/api/event'
|
return $request->url() === 'https://plausible.io/api/event'
|
||||||
&& isset($request['n']) && $request['n'] === 'pageview'
|
&& $request->header('User-Agent') === ['TestAgent']
|
||||||
&& isset($request['u']) && $request['u'] === 'https://example.com/page'
|
&& $request->header('X-Forwarded-For') === ['203.0.113.7']
|
||||||
&& isset($request['d']) && $request['d'] === 'example.com';
|
&& ! $request->hasHeader('Cookie')
|
||||||
|
&& ! $request->hasHeader('Authorization')
|
||||||
|
&& $request['n'] === 'pageview'
|
||||||
|
&& $request['u'] === 'https://example.com/page'
|
||||||
|
&& $request['d'] === 'example.com';
|
||||||
});
|
});
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('forwards additional plausible fields', function () {
|
||||||
|
config()->set('plausible-proxy.domain', 'https://plausible.io');
|
||||||
|
|
||||||
|
Http::fake([
|
||||||
|
'https://plausible.io/api/event' => Http::response('ok', 202),
|
||||||
|
]);
|
||||||
|
|
||||||
|
$this->postJson('/api/event', [
|
||||||
|
'n' => 'Purchase',
|
||||||
|
'u' => 'https://example.com/checkout',
|
||||||
|
'd' => 'example.com',
|
||||||
|
'i' => false,
|
||||||
|
'p' => '{"plan":"pro"}',
|
||||||
|
'$' => ['amount' => '9.99', 'currency' => 'EUR'],
|
||||||
|
])->assertStatus(202);
|
||||||
|
|
||||||
|
Http::assertSent(function ($request) {
|
||||||
|
return $request['i'] === false
|
||||||
|
&& $request['p'] === '{"plan":"pro"}'
|
||||||
|
&& $request['$'] === ['amount' => '9.99', 'currency' => 'EUR'];
|
||||||
|
});
|
||||||
|
});
|
||||||
|
|
||||||
|
it('rejects invalid props', function () {
|
||||||
|
$this->postJson('/api/event', [
|
||||||
|
'n' => 'pageview',
|
||||||
|
'u' => 'https://example.com/page',
|
||||||
|
'd' => 'example.com',
|
||||||
|
'p' => 'not-json',
|
||||||
|
])->assertStatus(422)->assertJsonValidationErrors(['p']);
|
||||||
|
});
|
||||||
+2
-12
@@ -1,22 +1,12 @@
|
|||||||
<?php
|
<?php
|
||||||
|
|
||||||
namespace MattitjaAB\LaravelPlausibleProxy\Tests;
|
namespace Mattitja\LaravelPlausibleProxy\Tests;
|
||||||
|
|
||||||
use Illuminate\Database\Eloquent\Factories\Factory;
|
use Mattitja\LaravelPlausibleProxy\LaravelPlausibleProxyServiceProvider;
|
||||||
use MattitjaAB\LaravelPlausibleProxy\LaravelPlausibleProxyServiceProvider;
|
|
||||||
use Orchestra\Testbench\TestCase as Orchestra;
|
use Orchestra\Testbench\TestCase as Orchestra;
|
||||||
|
|
||||||
class TestCase extends Orchestra
|
class TestCase extends Orchestra
|
||||||
{
|
{
|
||||||
protected function setUp(): void
|
|
||||||
{
|
|
||||||
parent::setUp();
|
|
||||||
|
|
||||||
Factory::guessFactoryNamesUsing(
|
|
||||||
fn (string $modelName) => 'MattitjaAB\\LaravelPlausibleProxy\\Database\\Factories\\'.class_basename($modelName).'Factory'
|
|
||||||
);
|
|
||||||
}
|
|
||||||
|
|
||||||
protected function getPackageProviders($app)
|
protected function getPackageProviders($app)
|
||||||
{
|
{
|
||||||
return [
|
return [
|
||||||
|
|||||||
Reference in new issue
Block a user