Skip to content

Document Segment fake usage in tests #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 18, 2025
Merged

Document Segment fake usage in tests #31

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -258,6 +258,24 @@ disabled then the exception will be thrown.
./vendor/bin/pest
```

### Using `Segment::fake()` in tests

To prevent real HTTP requests when running your own test suite, call
`Segment::fake()` before executing the code under test. This swaps the
Segment service with a fake that records events and identity calls. You can
then use assertion helpers to verify what was sent:

```php
use SlashEquip\LaravelSegment\Facades\Segment;

Segment::fake();

// Code that should trigger Segment events

Segment::assertTracked('User Signed Up');
Segment::assertIdentified();
```

## Changelog

Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
Expand Down