Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,13 @@ composer require awcodes/recently
php artisan recently:install
```

> [!IMPORTANT]
> **Upgrading an existing installation?** Publish and run the new migration so recent entries can reference their record (this powers automatic filtering of deleted records):
> ```bash
> php artisan vendor:publish --tag="recently-migrations"
> php artisan migrate
> ```

> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

Expand DownExpand Up@@ -94,6 +101,10 @@ class ViewUser extends ViewRecord
}
```

### Deleted Records

Recent entries are automatically hidden from the menu and global search once the record they point to no longer exists — including soft-deleted records — so users never follow a stale link to a "Record not found" page. Each entry stores a polymorphic `recordable` reference to its record, and only entries whose record still resolves are displayed. Entries recorded for pages without an underlying record are always kept.

## Configuration
You can enable/disable or customize the plugin's features either globally through the `config` file or per panel.

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
<?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::table('recent_entries', function (Blueprint $table) {
$table->nullableMorphs('recordable');
});
}
};
1 change: 1 addition & 0 deletions src/Concerns/HasRecentHistoryRecorder.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ protected function recordHistory(): void
url: request()->url(),
icon: $resource::getNavigationIcon(),
title: strip_tags((string) $title),
record: $record,
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Facades/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @method static void add(string $url, string $icon, string $title)
* @method static void add(string $url, string|\BackedEnum|null $icon, string $title, ?\Illuminate\Database\Eloquent\Model $record = null)
*
* @see \Awcodes\Recently\Recently
*/
Expand Down
1 change: 1 addition & 0 deletions src/Livewire/RecentlyMenu.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,7 @@ public function getRecords(): void
$model = config('recently.model');

$this->records = $model::query()
->existing()
->orderByDesc('updated_at')
->limit($this->maxItems)
->get();
Expand Down
26 changes: 26 additions & 0 deletions src/Models/RecentEntry.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,20 @@
use Awcodes\Recently\Models\Scopes\RecentEntryScope;
use Carbon\CarbonInterface;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
* @property-read int $id
* @property-read int $user_id
* @property string $url
* @property string|null $icon
* @property string|null $title
* @property string|null $recordable_type
* @property int|string|null $recordable_id
* @property-read CarbonInterface $created_at
* @property-read CarbonInterface $updated_at
*/
Expand All@@ -31,13 +35,35 @@ class RecentEntry extends Model
'url',
'icon',
'title',
'recordable_type',
'recordable_id',
];

public function user(): BelongsTo
{
return $this->belongsTo(config('recently.user_model'));
}

public function recordable(): MorphTo
{
return $this->morphTo();
}

/**
* Limit to entries that still point at a live record — i.e. those with no
* record reference (e.g. non-record pages), or whose referenced record
* still exists. A soft-deleted or hard-deleted record fails the morph
* existence check and is excluded.
*/
public function scopeExisting(Builder $query): void
{
$query->where(function (Builder $query): void {
$query
->whereNull('recordable_type')
->orWhereHasMorph('recordable', '*');
});
}

protected static function newFactory(): RecentEntryFactory
{
return new RecentEntryFactory;
Expand Down
4 changes: 3 additions & 1 deletion src/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@

class Recently
{
public function add(string $url, string|BackedEnum|null $icon, string $title): void
public function add(string $url, string|BackedEnum|null $icon, string $title, ?Model $record = null): void
{
if ($icon instanceof Heroicon) {
$icon = "heroicon-$icon->value";
Expand All@@ -28,6 +28,8 @@ public function add(string $url, string|BackedEnum|null $icon, string $title): v
'url' => $url,
'icon' => $icon ?? '',
'title' => $title,
'recordable_type' => $record?->getMorphClass(),
'recordable_id' => $record?->getKey(),
]);
}
}
1 change: 1 addition & 0 deletions src/RecentlyServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ protected function getMigrations(): array
{
return [
'create_recently_table',
'add_recordable_to_recent_entries_table',
];
}
}
6 changes: 6 additions & 0 deletions src/Resources/RecentEntryResource.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use Awcodes\Recently\RecentlyPlugin;
use Filament\Resources\Resource;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class RecentEntryResource extends Resource
Expand All@@ -21,6 +22,11 @@ public static function getModel(): string
return config('recently.model');
}

public static function getGlobalSearchEloquentQuery(): Builder
{
return parent::getGlobalSearchEloquentQuery()->existing();
}

public static function getGlobalSearchResultUrl(Model $record): ?string
{
return $record->url;
Expand Down
1 change: 1 addition & 0 deletions tests/database/migrations/create_pages_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ public function up(): void
$table->longText('content')->nullable();

$table->timestamps();
$table->softDeletes();
});
}
};
1 change: 1 addition & 0 deletions tests/database/migrations/create_recent_entries_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ public function up()
$table->text('url');
$table->string('icon');
$table->string('title');
$table->nullableMorphs('recordable');

$table->timestamps();
});
Expand Down
67 changes: 67 additions & 0 deletions tests/src/DeletedRecordsTest.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
<?php

declare(strict_types=1);

use Awcodes\Recently\Livewire\RecentlyMenu;
use Awcodes\Recently\Models\RecentEntry;
use Awcodes\Recently\RecentlyPlugin;
use Awcodes\Recently\Resources\RecentEntryResource;
use Awcodes\Recently\Tests\Models\Page;
use Awcodes\Recently\Tests\Models\User;
use Awcodes\Recently\Tests\Resources\Pages\PageResource;
use Filament\Facades\Filament;

use function Pest\Livewire\livewire;

beforeEach(function () {
$this->user = User::factory()->create();
$this->actingAs($this->user);

$this->panel = Filament::getCurrentOrDefaultPanel();
$this->panel->plugins([RecentlyPlugin::make()]);

$this->plugin = Filament::getPlugin('awcodes/recently');
});

it('stores a polymorphic reference to the viewed record', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);

$this->get($url)->assertSuccessful();

$this->assertDatabaseHas(RecentEntry::class, [
'url' => $url,
'recordable_type' => $page->getMorphClass(),
'recordable_id' => $page->getKey(),
]);
});

it('hides entries whose record has been deleted, keeping live and reference-less ones', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);
$this->get($url)->assertSuccessful();

// an entry that points at nothing (no record reference) must always survive
RecentEntry::create([
'user_id' => $this->user->id,
'url' => 'https://example.test/legacy',
'icon' => '',
'title' => 'Legacy',
]);

expect(RecentEntry::existing()->pluck('url')->all())->toContain($url);

$page->delete();

expect(RecentEntry::existing()->pluck('url')->all())
->not->toContain($url)
->toContain('https://example.test/legacy');

// menu surface
$records = livewire(RecentlyMenu::class)->instance()->records;
expect($records->pluck('url')->all())->not->toContain($url);

// global-search surface
$searchUrls = RecentEntryResource::getGlobalSearchEloquentQuery()->pluck('url')->all();
expect($searchUrls)->not->toContain($url);
});
2 changes: 2 additions & 0 deletions tests/src/Models/Page.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@
use Awcodes\Recently\Tests\Database\Factories\PageFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Page extends Model
{
use HasFactory;
use SoftDeletes;

protected $guarded = [];

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,13 @@ composer require awcodes/recently
php artisan recently:install
```

> [!IMPORTANT]
> **Upgrading an existing installation?** Publish and run the new migration so recent entries can reference their record (this powers automatic filtering of deleted records):
> ```bash
> php artisan vendor:publish --tag="recently-migrations"
> php artisan migrate
> ```

> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

Expand DownExpand Up@@ -94,6 +101,10 @@ class ViewUser extends ViewRecord
}
```

### Deleted Records

Recent entries are automatically hidden from the menu and global search once the record they point to no longer exists — including soft-deleted records — so users never follow a stale link to a "Record not found" page. Each entry stores a polymorphic `recordable` reference to its record, and only entries whose record still resolves are displayed. Entries recorded for pages without an underlying record are always kept.

## Configuration
You can enable/disable or customize the plugin's features either globally through the `config` file or per panel.

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
<?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::table('recent_entries', function (Blueprint $table) {
$table->nullableMorphs('recordable');
});
}
};
1 change: 1 addition & 0 deletions src/Concerns/HasRecentHistoryRecorder.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ protected function recordHistory(): void
url: request()->url(),
icon: $resource::getNavigationIcon(),
title: strip_tags((string) $title),
record: $record,
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Facades/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @method static void add(string $url, string $icon, string $title)
* @method static void add(string $url, string|\BackedEnum|null $icon, string $title, ?\Illuminate\Database\Eloquent\Model $record = null)
*
* @see \Awcodes\Recently\Recently
*/
Expand Down
1 change: 1 addition & 0 deletions src/Livewire/RecentlyMenu.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,7 @@ public function getRecords(): void
$model = config('recently.model');

$this->records = $model::query()
->existing()
->orderByDesc('updated_at')
->limit($this->maxItems)
->get();
Expand Down
26 changes: 26 additions & 0 deletions src/Models/RecentEntry.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,20 @@
use Awcodes\Recently\Models\Scopes\RecentEntryScope;
use Carbon\CarbonInterface;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
* @property-read int $id
* @property-read int $user_id
* @property string $url
* @property string|null $icon
* @property string|null $title
* @property string|null $recordable_type
* @property int|string|null $recordable_id
* @property-read CarbonInterface $created_at
* @property-read CarbonInterface $updated_at
*/
Expand All@@ -31,13 +35,35 @@ class RecentEntry extends Model
'url',
'icon',
'title',
'recordable_type',
'recordable_id',
];

public function user(): BelongsTo
{
return $this->belongsTo(config('recently.user_model'));
}

public function recordable(): MorphTo
{
return $this->morphTo();
}

/**
* Limit to entries that still point at a live record — i.e. those with no
* record reference (e.g. non-record pages), or whose referenced record
* still exists. A soft-deleted or hard-deleted record fails the morph
* existence check and is excluded.
*/
public function scopeExisting(Builder $query): void
{
$query->where(function (Builder $query): void {
$query
->whereNull('recordable_type')
->orWhereHasMorph('recordable', '*');
});
}

protected static function newFactory(): RecentEntryFactory
{
return new RecentEntryFactory;
Expand Down
4 changes: 3 additions & 1 deletion src/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@

class Recently
{
public function add(string $url, string|BackedEnum|null $icon, string $title): void
public function add(string $url, string|BackedEnum|null $icon, string $title, ?Model $record = null): void
{
if ($icon instanceof Heroicon) {
$icon = "heroicon-$icon->value";
Expand All@@ -28,6 +28,8 @@ public function add(string $url, string|BackedEnum|null $icon, string $title): v
'url' => $url,
'icon' => $icon ?? '',
'title' => $title,
'recordable_type' => $record?->getMorphClass(),
'recordable_id' => $record?->getKey(),
]);
}
}
1 change: 1 addition & 0 deletions src/RecentlyServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ protected function getMigrations(): array
{
return [
'create_recently_table',
'add_recordable_to_recent_entries_table',
];
}
}
6 changes: 6 additions & 0 deletions src/Resources/RecentEntryResource.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use Awcodes\Recently\RecentlyPlugin;
use Filament\Resources\Resource;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class RecentEntryResource extends Resource
Expand All@@ -21,6 +22,11 @@ public static function getModel(): string
return config('recently.model');
}

public static function getGlobalSearchEloquentQuery(): Builder
{
return parent::getGlobalSearchEloquentQuery()->existing();
}

public static function getGlobalSearchResultUrl(Model $record): ?string
{
return $record->url;
Expand Down
1 change: 1 addition & 0 deletions tests/database/migrations/create_pages_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ public function up(): void
$table->longText('content')->nullable();

$table->timestamps();
$table->softDeletes();
});
}
};
1 change: 1 addition & 0 deletions tests/database/migrations/create_recent_entries_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ public function up()
$table->text('url');
$table->string('icon');
$table->string('title');
$table->nullableMorphs('recordable');

$table->timestamps();
});
Expand Down
67 changes: 67 additions & 0 deletions tests/src/DeletedRecordsTest.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
<?php

declare(strict_types=1);

use Awcodes\Recently\Livewire\RecentlyMenu;
use Awcodes\Recently\Models\RecentEntry;
use Awcodes\Recently\RecentlyPlugin;
use Awcodes\Recently\Resources\RecentEntryResource;
use Awcodes\Recently\Tests\Models\Page;
use Awcodes\Recently\Tests\Models\User;
use Awcodes\Recently\Tests\Resources\Pages\PageResource;
use Filament\Facades\Filament;

use function Pest\Livewire\livewire;

beforeEach(function () {
$this->user = User::factory()->create();
$this->actingAs($this->user);

$this->panel = Filament::getCurrentOrDefaultPanel();
$this->panel->plugins([RecentlyPlugin::make()]);

$this->plugin = Filament::getPlugin('awcodes/recently');
});

it('stores a polymorphic reference to the viewed record', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);

$this->get($url)->assertSuccessful();

$this->assertDatabaseHas(RecentEntry::class, [
'url' => $url,
'recordable_type' => $page->getMorphClass(),
'recordable_id' => $page->getKey(),
]);
});

it('hides entries whose record has been deleted, keeping live and reference-less ones', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);
$this->get($url)->assertSuccessful();

// an entry that points at nothing (no record reference) must always survive
RecentEntry::create([
'user_id' => $this->user->id,
'url' => 'https://example.test/legacy',
'icon' => '',
'title' => 'Legacy',
]);

expect(RecentEntry::existing()->pluck('url')->all())->toContain($url);

$page->delete();

expect(RecentEntry::existing()->pluck('url')->all())
->not->toContain($url)
->toContain('https://example.test/legacy');

// menu surface
$records = livewire(RecentlyMenu::class)->instance()->records;
expect($records->pluck('url')->all())->not->toContain($url);

// global-search surface
$searchUrls = RecentEntryResource::getGlobalSearchEloquentQuery()->pluck('url')->all();
expect($searchUrls)->not->toContain($url);
});
2 changes: 2 additions & 0 deletions tests/src/Models/Page.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@
use Awcodes\Recently\Tests\Database\Factories\PageFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Page extends Model
{
use HasFactory;
use SoftDeletes;

protected $guarded = [];

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix"); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,13 @@ composer require awcodes/recently
php artisan recently:install
```

> [!IMPORTANT]
> **Upgrading an existing installation?** Publish and run the new migration so recent entries can reference their record (this powers automatic filtering of deleted records):
> ```bash
> php artisan vendor:publish --tag="recently-migrations"
> php artisan migrate
> ```

> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

Expand DownExpand Up@@ -94,6 +101,10 @@ class ViewUser extends ViewRecord
}
```

### Deleted Records

Recent entries are automatically hidden from the menu and global search once the record they point to no longer exists — including soft-deleted records — so users never follow a stale link to a "Record not found" page. Each entry stores a polymorphic `recordable` reference to its record, and only entries whose record still resolves are displayed. Entries recorded for pages without an underlying record are always kept.

## Configuration
You can enable/disable or customize the plugin's features either globally through the `config` file or per panel.

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
<?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::table('recent_entries', function (Blueprint $table) {
$table->nullableMorphs('recordable');
});
}
};
1 change: 1 addition & 0 deletions src/Concerns/HasRecentHistoryRecorder.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ protected function recordHistory(): void
url: request()->url(),
icon: $resource::getNavigationIcon(),
title: strip_tags((string) $title),
record: $record,
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Facades/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @method static void add(string $url, string $icon, string $title)
* @method static void add(string $url, string|\BackedEnum|null $icon, string $title, ?\Illuminate\Database\Eloquent\Model $record = null)
*
* @see \Awcodes\Recently\Recently
*/
Expand Down
1 change: 1 addition & 0 deletions src/Livewire/RecentlyMenu.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,7 @@ public function getRecords(): void
$model = config('recently.model');

$this->records = $model::query()
->existing()
->orderByDesc('updated_at')
->limit($this->maxItems)
->get();
Expand Down
26 changes: 26 additions & 0 deletions src/Models/RecentEntry.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,20 @@
use Awcodes\Recently\Models\Scopes\RecentEntryScope;
use Carbon\CarbonInterface;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
* @property-read int $id
* @property-read int $user_id
* @property string $url
* @property string|null $icon
* @property string|null $title
* @property string|null $recordable_type
* @property int|string|null $recordable_id
* @property-read CarbonInterface $created_at
* @property-read CarbonInterface $updated_at
*/
Expand All@@ -31,13 +35,35 @@ class RecentEntry extends Model
'url',
'icon',
'title',
'recordable_type',
'recordable_id',
];

public function user(): BelongsTo
{
return $this->belongsTo(config('recently.user_model'));
}

public function recordable(): MorphTo
{
return $this->morphTo();
}

/**
* Limit to entries that still point at a live record — i.e. those with no
* record reference (e.g. non-record pages), or whose referenced record
* still exists. A soft-deleted or hard-deleted record fails the morph
* existence check and is excluded.
*/
public function scopeExisting(Builder $query): void
{
$query->where(function (Builder $query): void {
$query
->whereNull('recordable_type')
->orWhereHasMorph('recordable', '*');
});
}

protected static function newFactory(): RecentEntryFactory
{
return new RecentEntryFactory;
Expand Down
4 changes: 3 additions & 1 deletion src/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@

class Recently
{
public function add(string $url, string|BackedEnum|null $icon, string $title): void
public function add(string $url, string|BackedEnum|null $icon, string $title, ?Model $record = null): void
{
if ($icon instanceof Heroicon) {
$icon = "heroicon-$icon->value";
Expand All@@ -28,6 +28,8 @@ public function add(string $url, string|BackedEnum|null $icon, string $title): v
'url' => $url,
'icon' => $icon ?? '',
'title' => $title,
'recordable_type' => $record?->getMorphClass(),
'recordable_id' => $record?->getKey(),
]);
}
}
1 change: 1 addition & 0 deletions src/RecentlyServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ protected function getMigrations(): array
{
return [
'create_recently_table',
'add_recordable_to_recent_entries_table',
];
}
}
6 changes: 6 additions & 0 deletions src/Resources/RecentEntryResource.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use Awcodes\Recently\RecentlyPlugin;
use Filament\Resources\Resource;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class RecentEntryResource extends Resource
Expand All@@ -21,6 +22,11 @@ public static function getModel(): string
return config('recently.model');
}

public static function getGlobalSearchEloquentQuery(): Builder
{
return parent::getGlobalSearchEloquentQuery()->existing();
}

public static function getGlobalSearchResultUrl(Model $record): ?string
{
return $record->url;
Expand Down
1 change: 1 addition & 0 deletions tests/database/migrations/create_pages_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ public function up(): void
$table->longText('content')->nullable();

$table->timestamps();
$table->softDeletes();
});
}
};
1 change: 1 addition & 0 deletions tests/database/migrations/create_recent_entries_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ public function up()
$table->text('url');
$table->string('icon');
$table->string('title');
$table->nullableMorphs('recordable');

$table->timestamps();
});
Expand Down
67 changes: 67 additions & 0 deletions tests/src/DeletedRecordsTest.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
<?php

declare(strict_types=1);

use Awcodes\Recently\Livewire\RecentlyMenu;
use Awcodes\Recently\Models\RecentEntry;
use Awcodes\Recently\RecentlyPlugin;
use Awcodes\Recently\Resources\RecentEntryResource;
use Awcodes\Recently\Tests\Models\Page;
use Awcodes\Recently\Tests\Models\User;
use Awcodes\Recently\Tests\Resources\Pages\PageResource;
use Filament\Facades\Filament;

use function Pest\Livewire\livewire;

beforeEach(function () {
$this->user = User::factory()->create();
$this->actingAs($this->user);

$this->panel = Filament::getCurrentOrDefaultPanel();
$this->panel->plugins([RecentlyPlugin::make()]);

$this->plugin = Filament::getPlugin('awcodes/recently');
});

it('stores a polymorphic reference to the viewed record', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);

$this->get($url)->assertSuccessful();

$this->assertDatabaseHas(RecentEntry::class, [
'url' => $url,
'recordable_type' => $page->getMorphClass(),
'recordable_id' => $page->getKey(),
]);
});

it('hides entries whose record has been deleted, keeping live and reference-less ones', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);
$this->get($url)->assertSuccessful();

// an entry that points at nothing (no record reference) must always survive
RecentEntry::create([
'user_id' => $this->user->id,
'url' => 'https://example.test/legacy',
'icon' => '',
'title' => 'Legacy',
]);

expect(RecentEntry::existing()->pluck('url')->all())->toContain($url);

$page->delete();

expect(RecentEntry::existing()->pluck('url')->all())
->not->toContain($url)
->toContain('https://example.test/legacy');

// menu surface
$records = livewire(RecentlyMenu::class)->instance()->records;
expect($records->pluck('url')->all())->not->toContain($url);

// global-search surface
$searchUrls = RecentEntryResource::getGlobalSearchEloquentQuery()->pluck('url')->all();
expect($searchUrls)->not->toContain($url);
});
2 changes: 2 additions & 0 deletions tests/src/Models/Page.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@
use Awcodes\Recently\Tests\Database\Factories\PageFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Page extends Model
{
use HasFactory;
use SoftDeletes;

protected $guarded = [];

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms"); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,13 @@ composer require awcodes/recently
php artisan recently:install
```

> [!IMPORTANT]
> **Upgrading an existing installation?** Publish and run the new migration so recent entries can reference their record (this powers automatic filtering of deleted records):
> ```bash
> php artisan vendor:publish --tag="recently-migrations"
> php artisan migrate
> ```

> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

Expand DownExpand Up@@ -94,6 +101,10 @@ class ViewUser extends ViewRecord
}
```

### Deleted Records

Recent entries are automatically hidden from the menu and global search once the record they point to no longer exists — including soft-deleted records — so users never follow a stale link to a "Record not found" page. Each entry stores a polymorphic `recordable` reference to its record, and only entries whose record still resolves are displayed. Entries recorded for pages without an underlying record are always kept.

## Configuration
You can enable/disable or customize the plugin's features either globally through the `config` file or per panel.

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
<?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::table('recent_entries', function (Blueprint $table) {
$table->nullableMorphs('recordable');
});
}
};
1 change: 1 addition & 0 deletions src/Concerns/HasRecentHistoryRecorder.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ protected function recordHistory(): void
url: request()->url(),
icon: $resource::getNavigationIcon(),
title: strip_tags((string) $title),
record: $record,
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Facades/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @method static void add(string $url, string $icon, string $title)
* @method static void add(string $url, string|\BackedEnum|null $icon, string $title, ?\Illuminate\Database\Eloquent\Model $record = null)
*
* @see \Awcodes\Recently\Recently
*/
Expand Down
1 change: 1 addition & 0 deletions src/Livewire/RecentlyMenu.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,7 @@ public function getRecords(): void
$model = config('recently.model');

$this->records = $model::query()
->existing()
->orderByDesc('updated_at')
->limit($this->maxItems)
->get();
Expand Down
26 changes: 26 additions & 0 deletions src/Models/RecentEntry.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,20 @@
use Awcodes\Recently\Models\Scopes\RecentEntryScope;
use Carbon\CarbonInterface;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
* @property-read int $id
* @property-read int $user_id
* @property string $url
* @property string|null $icon
* @property string|null $title
* @property string|null $recordable_type
* @property int|string|null $recordable_id
* @property-read CarbonInterface $created_at
* @property-read CarbonInterface $updated_at
*/
Expand All@@ -31,13 +35,35 @@ class RecentEntry extends Model
'url',
'icon',
'title',
'recordable_type',
'recordable_id',
];

public function user(): BelongsTo
{
return $this->belongsTo(config('recently.user_model'));
}

public function recordable(): MorphTo
{
return $this->morphTo();
}

/**
* Limit to entries that still point at a live record — i.e. those with no
* record reference (e.g. non-record pages), or whose referenced record
* still exists. A soft-deleted or hard-deleted record fails the morph
* existence check and is excluded.
*/
public function scopeExisting(Builder $query): void
{
$query->where(function (Builder $query): void {
$query
->whereNull('recordable_type')
->orWhereHasMorph('recordable', '*');
});
}

protected static function newFactory(): RecentEntryFactory
{
return new RecentEntryFactory;
Expand Down
4 changes: 3 additions & 1 deletion src/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@

class Recently
{
public function add(string $url, string|BackedEnum|null $icon, string $title): void
public function add(string $url, string|BackedEnum|null $icon, string $title, ?Model $record = null): void
{
if ($icon instanceof Heroicon) {
$icon = "heroicon-$icon->value";
Expand All@@ -28,6 +28,8 @@ public function add(string $url, string|BackedEnum|null $icon, string $title): v
'url' => $url,
'icon' => $icon ?? '',
'title' => $title,
'recordable_type' => $record?->getMorphClass(),
'recordable_id' => $record?->getKey(),
]);
}
}
1 change: 1 addition & 0 deletions src/RecentlyServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ protected function getMigrations(): array
{
return [
'create_recently_table',
'add_recordable_to_recent_entries_table',
];
}
}
6 changes: 6 additions & 0 deletions src/Resources/RecentEntryResource.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use Awcodes\Recently\RecentlyPlugin;
use Filament\Resources\Resource;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class RecentEntryResource extends Resource
Expand All@@ -21,6 +22,11 @@ public static function getModel(): string
return config('recently.model');
}

public static function getGlobalSearchEloquentQuery(): Builder
{
return parent::getGlobalSearchEloquentQuery()->existing();
}

public static function getGlobalSearchResultUrl(Model $record): ?string
{
return $record->url;
Expand Down
1 change: 1 addition & 0 deletions tests/database/migrations/create_pages_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ public function up(): void
$table->longText('content')->nullable();

$table->timestamps();
$table->softDeletes();
});
}
};
1 change: 1 addition & 0 deletions tests/database/migrations/create_recent_entries_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ public function up()
$table->text('url');
$table->string('icon');
$table->string('title');
$table->nullableMorphs('recordable');

$table->timestamps();
});
Expand Down
67 changes: 67 additions & 0 deletions tests/src/DeletedRecordsTest.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
<?php

declare(strict_types=1);

use Awcodes\Recently\Livewire\RecentlyMenu;
use Awcodes\Recently\Models\RecentEntry;
use Awcodes\Recently\RecentlyPlugin;
use Awcodes\Recently\Resources\RecentEntryResource;
use Awcodes\Recently\Tests\Models\Page;
use Awcodes\Recently\Tests\Models\User;
use Awcodes\Recently\Tests\Resources\Pages\PageResource;
use Filament\Facades\Filament;

use function Pest\Livewire\livewire;

beforeEach(function () {
$this->user = User::factory()->create();
$this->actingAs($this->user);

$this->panel = Filament::getCurrentOrDefaultPanel();
$this->panel->plugins([RecentlyPlugin::make()]);

$this->plugin = Filament::getPlugin('awcodes/recently');
});

it('stores a polymorphic reference to the viewed record', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);

$this->get($url)->assertSuccessful();

$this->assertDatabaseHas(RecentEntry::class, [
'url' => $url,
'recordable_type' => $page->getMorphClass(),
'recordable_id' => $page->getKey(),
]);
});

it('hides entries whose record has been deleted, keeping live and reference-less ones', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);
$this->get($url)->assertSuccessful();

// an entry that points at nothing (no record reference) must always survive
RecentEntry::create([
'user_id' => $this->user->id,
'url' => 'https://example.test/legacy',
'icon' => '',
'title' => 'Legacy',
]);

expect(RecentEntry::existing()->pluck('url')->all())->toContain($url);

$page->delete();

expect(RecentEntry::existing()->pluck('url')->all())
->not->toContain($url)
->toContain('https://example.test/legacy');

// menu surface
$records = livewire(RecentlyMenu::class)->instance()->records;
expect($records->pluck('url')->all())->not->toContain($url);

// global-search surface
$searchUrls = RecentEntryResource::getGlobalSearchEloquentQuery()->pluck('url')->all();
expect($searchUrls)->not->toContain($url);
});
2 changes: 2 additions & 0 deletions tests/src/Models/Page.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@
use Awcodes\Recently\Tests\Database\Factories\PageFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Page extends Model
{
use HasFactory;
use SoftDeletes;

protected $guarded = [];

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links"); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,13 @@ composer require awcodes/recently
php artisan recently:install
```

> [!IMPORTANT]
> **Upgrading an existing installation?** Publish and run the new migration so recent entries can reference their record (this powers automatic filtering of deleted records):
> ```bash
> php artisan vendor:publish --tag="recently-migrations"
> php artisan migrate
> ```

> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

Expand DownExpand Up@@ -94,6 +101,10 @@ class ViewUser extends ViewRecord
}
```

### Deleted Records

Recent entries are automatically hidden from the menu and global search once the record they point to no longer exists — including soft-deleted records — so users never follow a stale link to a "Record not found" page. Each entry stores a polymorphic `recordable` reference to its record, and only entries whose record still resolves are displayed. Entries recorded for pages without an underlying record are always kept.

## Configuration
You can enable/disable or customize the plugin's features either globally through the `config` file or per panel.

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
<?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::table('recent_entries', function (Blueprint $table) {
$table->nullableMorphs('recordable');
});
}
};
1 change: 1 addition & 0 deletions src/Concerns/HasRecentHistoryRecorder.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ protected function recordHistory(): void
url: request()->url(),
icon: $resource::getNavigationIcon(),
title: strip_tags((string) $title),
record: $record,
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Facades/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @method static void add(string $url, string $icon, string $title)
* @method static void add(string $url, string|\BackedEnum|null $icon, string $title, ?\Illuminate\Database\Eloquent\Model $record = null)
*
* @see \Awcodes\Recently\Recently
*/
Expand Down
1 change: 1 addition & 0 deletions src/Livewire/RecentlyMenu.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,7 @@ public function getRecords(): void
$model = config('recently.model');

$this->records = $model::query()
->existing()
->orderByDesc('updated_at')
->limit($this->maxItems)
->get();
Expand Down
26 changes: 26 additions & 0 deletions src/Models/RecentEntry.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,20 @@
use Awcodes\Recently\Models\Scopes\RecentEntryScope;
use Carbon\CarbonInterface;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
* @property-read int $id
* @property-read int $user_id
* @property string $url
* @property string|null $icon
* @property string|null $title
* @property string|null $recordable_type
* @property int|string|null $recordable_id
* @property-read CarbonInterface $created_at
* @property-read CarbonInterface $updated_at
*/
Expand All@@ -31,13 +35,35 @@ class RecentEntry extends Model
'url',
'icon',
'title',
'recordable_type',
'recordable_id',
];

public function user(): BelongsTo
{
return $this->belongsTo(config('recently.user_model'));
}

public function recordable(): MorphTo
{
return $this->morphTo();
}

/**
* Limit to entries that still point at a live record — i.e. those with no
* record reference (e.g. non-record pages), or whose referenced record
* still exists. A soft-deleted or hard-deleted record fails the morph
* existence check and is excluded.
*/
public function scopeExisting(Builder $query): void
{
$query->where(function (Builder $query): void {
$query
->whereNull('recordable_type')
->orWhereHasMorph('recordable', '*');
});
}

protected static function newFactory(): RecentEntryFactory
{
return new RecentEntryFactory;
Expand Down
4 changes: 3 additions & 1 deletion src/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@

class Recently
{
public function add(string $url, string|BackedEnum|null $icon, string $title): void
public function add(string $url, string|BackedEnum|null $icon, string $title, ?Model $record = null): void
{
if ($icon instanceof Heroicon) {
$icon = "heroicon-$icon->value";
Expand All@@ -28,6 +28,8 @@ public function add(string $url, string|BackedEnum|null $icon, string $title): v
'url' => $url,
'icon' => $icon ?? '',
'title' => $title,
'recordable_type' => $record?->getMorphClass(),
'recordable_id' => $record?->getKey(),
]);
}
}
1 change: 1 addition & 0 deletions src/RecentlyServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ protected function getMigrations(): array
{
return [
'create_recently_table',
'add_recordable_to_recent_entries_table',
];
}
}
6 changes: 6 additions & 0 deletions src/Resources/RecentEntryResource.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use Awcodes\Recently\RecentlyPlugin;
use Filament\Resources\Resource;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class RecentEntryResource extends Resource
Expand All@@ -21,6 +22,11 @@ public static function getModel(): string
return config('recently.model');
}

public static function getGlobalSearchEloquentQuery(): Builder
{
return parent::getGlobalSearchEloquentQuery()->existing();
}

public static function getGlobalSearchResultUrl(Model $record): ?string
{
return $record->url;
Expand Down
1 change: 1 addition & 0 deletions tests/database/migrations/create_pages_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ public function up(): void
$table->longText('content')->nullable();

$table->timestamps();
$table->softDeletes();
});
}
};
1 change: 1 addition & 0 deletions tests/database/migrations/create_recent_entries_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ public function up()
$table->text('url');
$table->string('icon');
$table->string('title');
$table->nullableMorphs('recordable');

$table->timestamps();
});
Expand Down
67 changes: 67 additions & 0 deletions tests/src/DeletedRecordsTest.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
<?php

declare(strict_types=1);

use Awcodes\Recently\Livewire\RecentlyMenu;
use Awcodes\Recently\Models\RecentEntry;
use Awcodes\Recently\RecentlyPlugin;
use Awcodes\Recently\Resources\RecentEntryResource;
use Awcodes\Recently\Tests\Models\Page;
use Awcodes\Recently\Tests\Models\User;
use Awcodes\Recently\Tests\Resources\Pages\PageResource;
use Filament\Facades\Filament;

use function Pest\Livewire\livewire;

beforeEach(function () {
$this->user = User::factory()->create();
$this->actingAs($this->user);

$this->panel = Filament::getCurrentOrDefaultPanel();
$this->panel->plugins([RecentlyPlugin::make()]);

$this->plugin = Filament::getPlugin('awcodes/recently');
});

it('stores a polymorphic reference to the viewed record', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);

$this->get($url)->assertSuccessful();

$this->assertDatabaseHas(RecentEntry::class, [
'url' => $url,
'recordable_type' => $page->getMorphClass(),
'recordable_id' => $page->getKey(),
]);
});

it('hides entries whose record has been deleted, keeping live and reference-less ones', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);
$this->get($url)->assertSuccessful();

// an entry that points at nothing (no record reference) must always survive
RecentEntry::create([
'user_id' => $this->user->id,
'url' => 'https://example.test/legacy',
'icon' => '',
'title' => 'Legacy',
]);

expect(RecentEntry::existing()->pluck('url')->all())->toContain($url);

$page->delete();

expect(RecentEntry::existing()->pluck('url')->all())
->not->toContain($url)
->toContain('https://example.test/legacy');

// menu surface
$records = livewire(RecentlyMenu::class)->instance()->records;
expect($records->pluck('url')->all())->not->toContain($url);

// global-search surface
$searchUrls = RecentEntryResource::getGlobalSearchEloquentQuery()->pluck('url')->all();
expect($searchUrls)->not->toContain($url);
});
2 changes: 2 additions & 0 deletions tests/src/Models/Page.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@
use Awcodes\Recently\Tests\Database\Factories\PageFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Page extends Model
{
use HasFactory;
use SoftDeletes;

protected $guarded = [];

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default"); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,13 @@ composer require awcodes/recently
php artisan recently:install
```

> [!IMPORTANT]
> **Upgrading an existing installation?** Publish and run the new migration so recent entries can reference their record (this powers automatic filtering of deleted records):
> ```bash
> php artisan vendor:publish --tag="recently-migrations"
> php artisan migrate
> ```

> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

Expand DownExpand Up@@ -94,6 +101,10 @@ class ViewUser extends ViewRecord
}
```

### Deleted Records

Recent entries are automatically hidden from the menu and global search once the record they point to no longer exists — including soft-deleted records — so users never follow a stale link to a "Record not found" page. Each entry stores a polymorphic `recordable` reference to its record, and only entries whose record still resolves are displayed. Entries recorded for pages without an underlying record are always kept.

## Configuration
You can enable/disable or customize the plugin's features either globally through the `config` file or per panel.

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
<?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::table('recent_entries', function (Blueprint $table) {
$table->nullableMorphs('recordable');
});
}
};
1 change: 1 addition & 0 deletions src/Concerns/HasRecentHistoryRecorder.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ protected function recordHistory(): void
url: request()->url(),
icon: $resource::getNavigationIcon(),
title: strip_tags((string) $title),
record: $record,
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Facades/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @method static void add(string $url, string $icon, string $title)
* @method static void add(string $url, string|\BackedEnum|null $icon, string $title, ?\Illuminate\Database\Eloquent\Model $record = null)
*
* @see \Awcodes\Recently\Recently
*/
Expand Down
1 change: 1 addition & 0 deletions src/Livewire/RecentlyMenu.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,7 @@ public function getRecords(): void
$model = config('recently.model');

$this->records = $model::query()
->existing()
->orderByDesc('updated_at')
->limit($this->maxItems)
->get();
Expand Down
26 changes: 26 additions & 0 deletions src/Models/RecentEntry.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,20 @@
use Awcodes\Recently\Models\Scopes\RecentEntryScope;
use Carbon\CarbonInterface;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
* @property-read int $id
* @property-read int $user_id
* @property string $url
* @property string|null $icon
* @property string|null $title
* @property string|null $recordable_type
* @property int|string|null $recordable_id
* @property-read CarbonInterface $created_at
* @property-read CarbonInterface $updated_at
*/
Expand All@@ -31,13 +35,35 @@ class RecentEntry extends Model
'url',
'icon',
'title',
'recordable_type',
'recordable_id',
];

public function user(): BelongsTo
{
return $this->belongsTo(config('recently.user_model'));
}

public function recordable(): MorphTo
{
return $this->morphTo();
}

/**
* Limit to entries that still point at a live record — i.e. those with no
* record reference (e.g. non-record pages), or whose referenced record
* still exists. A soft-deleted or hard-deleted record fails the morph
* existence check and is excluded.
*/
public function scopeExisting(Builder $query): void
{
$query->where(function (Builder $query): void {
$query
->whereNull('recordable_type')
->orWhereHasMorph('recordable', '*');
});
}

protected static function newFactory(): RecentEntryFactory
{
return new RecentEntryFactory;
Expand Down
4 changes: 3 additions & 1 deletion src/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@

class Recently
{
public function add(string $url, string|BackedEnum|null $icon, string $title): void
public function add(string $url, string|BackedEnum|null $icon, string $title, ?Model $record = null): void
{
if ($icon instanceof Heroicon) {
$icon = "heroicon-$icon->value";
Expand All@@ -28,6 +28,8 @@ public function add(string $url, string|BackedEnum|null $icon, string $title): v
'url' => $url,
'icon' => $icon ?? '',
'title' => $title,
'recordable_type' => $record?->getMorphClass(),
'recordable_id' => $record?->getKey(),
]);
}
}
1 change: 1 addition & 0 deletions src/RecentlyServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ protected function getMigrations(): array
{
return [
'create_recently_table',
'add_recordable_to_recent_entries_table',
];
}
}
6 changes: 6 additions & 0 deletions src/Resources/RecentEntryResource.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use Awcodes\Recently\RecentlyPlugin;
use Filament\Resources\Resource;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class RecentEntryResource extends Resource
Expand All@@ -21,6 +22,11 @@ public static function getModel(): string
return config('recently.model');
}

public static function getGlobalSearchEloquentQuery(): Builder
{
return parent::getGlobalSearchEloquentQuery()->existing();
}

public static function getGlobalSearchResultUrl(Model $record): ?string
{
return $record->url;
Expand Down
1 change: 1 addition & 0 deletions tests/database/migrations/create_pages_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ public function up(): void
$table->longText('content')->nullable();

$table->timestamps();
$table->softDeletes();
});
}
};
1 change: 1 addition & 0 deletions tests/database/migrations/create_recent_entries_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ public function up()
$table->text('url');
$table->string('icon');
$table->string('title');
$table->nullableMorphs('recordable');

$table->timestamps();
});
Expand Down
67 changes: 67 additions & 0 deletions tests/src/DeletedRecordsTest.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
<?php

declare(strict_types=1);

use Awcodes\Recently\Livewire\RecentlyMenu;
use Awcodes\Recently\Models\RecentEntry;
use Awcodes\Recently\RecentlyPlugin;
use Awcodes\Recently\Resources\RecentEntryResource;
use Awcodes\Recently\Tests\Models\Page;
use Awcodes\Recently\Tests\Models\User;
use Awcodes\Recently\Tests\Resources\Pages\PageResource;
use Filament\Facades\Filament;

use function Pest\Livewire\livewire;

beforeEach(function () {
$this->user = User::factory()->create();
$this->actingAs($this->user);

$this->panel = Filament::getCurrentOrDefaultPanel();
$this->panel->plugins([RecentlyPlugin::make()]);

$this->plugin = Filament::getPlugin('awcodes/recently');
});

it('stores a polymorphic reference to the viewed record', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);

$this->get($url)->assertSuccessful();

$this->assertDatabaseHas(RecentEntry::class, [
'url' => $url,
'recordable_type' => $page->getMorphClass(),
'recordable_id' => $page->getKey(),
]);
});

it('hides entries whose record has been deleted, keeping live and reference-less ones', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);
$this->get($url)->assertSuccessful();

// an entry that points at nothing (no record reference) must always survive
RecentEntry::create([
'user_id' => $this->user->id,
'url' => 'https://example.test/legacy',
'icon' => '',
'title' => 'Legacy',
]);

expect(RecentEntry::existing()->pluck('url')->all())->toContain($url);

$page->delete();

expect(RecentEntry::existing()->pluck('url')->all())
->not->toContain($url)
->toContain('https://example.test/legacy');

// menu surface
$records = livewire(RecentlyMenu::class)->instance()->records;
expect($records->pluck('url')->all())->not->toContain($url);

// global-search surface
$searchUrls = RecentEntryResource::getGlobalSearchEloquentQuery()->pluck('url')->all();
expect($searchUrls)->not->toContain($url);
});
2 changes: 2 additions & 0 deletions tests/src/Models/Page.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@
use Awcodes\Recently\Tests\Database\Factories\PageFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Page extends Model
{
use HasFactory;
use SoftDeletes;

protected $guarded = [];

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers"); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + '
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,13 @@ composer require awcodes/recently
php artisan recently:install
```

> [!IMPORTANT]
> **Upgrading an existing installation?** Publish and run the new migration so recent entries can reference their record (this powers automatic filtering of deleted records):
> ```bash
> php artisan vendor:publish --tag="recently-migrations"
> php artisan migrate
> ```

> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

Expand DownExpand Up@@ -94,6 +101,10 @@ class ViewUser extends ViewRecord
}
```

### Deleted Records

Recent entries are automatically hidden from the menu and global search once the record they point to no longer exists — including soft-deleted records — so users never follow a stale link to a "Record not found" page. Each entry stores a polymorphic `recordable` reference to its record, and only entries whose record still resolves are displayed. Entries recorded for pages without an underlying record are always kept.

## Configuration
You can enable/disable or customize the plugin's features either globally through the `config` file or per panel.

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
<?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::table('recent_entries', function (Blueprint $table) {
$table->nullableMorphs('recordable');
});
}
};
1 change: 1 addition & 0 deletions src/Concerns/HasRecentHistoryRecorder.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ protected function recordHistory(): void
url: request()->url(),
icon: $resource::getNavigationIcon(),
title: strip_tags((string) $title),
record: $record,
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Facades/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @method static void add(string $url, string $icon, string $title)
* @method static void add(string $url, string|\BackedEnum|null $icon, string $title, ?\Illuminate\Database\Eloquent\Model $record = null)
*
* @see \Awcodes\Recently\Recently
*/
Expand Down
1 change: 1 addition & 0 deletions src/Livewire/RecentlyMenu.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,7 @@ public function getRecords(): void
$model = config('recently.model');

$this->records = $model::query()
->existing()
->orderByDesc('updated_at')
->limit($this->maxItems)
->get();
Expand Down
26 changes: 26 additions & 0 deletions src/Models/RecentEntry.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,20 @@
use Awcodes\Recently\Models\Scopes\RecentEntryScope;
use Carbon\CarbonInterface;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
* @property-read int $id
* @property-read int $user_id
* @property string $url
* @property string|null $icon
* @property string|null $title
* @property string|null $recordable_type
* @property int|string|null $recordable_id
* @property-read CarbonInterface $created_at
* @property-read CarbonInterface $updated_at
*/
Expand All@@ -31,13 +35,35 @@ class RecentEntry extends Model
'url',
'icon',
'title',
'recordable_type',
'recordable_id',
];

public function user(): BelongsTo
{
return $this->belongsTo(config('recently.user_model'));
}

public function recordable(): MorphTo
{
return $this->morphTo();
}

/**
* Limit to entries that still point at a live record — i.e. those with no
* record reference (e.g. non-record pages), or whose referenced record
* still exists. A soft-deleted or hard-deleted record fails the morph
* existence check and is excluded.
*/
public function scopeExisting(Builder $query): void
{
$query->where(function (Builder $query): void {
$query
->whereNull('recordable_type')
->orWhereHasMorph('recordable', '*');
});
}

protected static function newFactory(): RecentEntryFactory
{
return new RecentEntryFactory;
Expand Down
4 changes: 3 additions & 1 deletion src/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@

class Recently
{
public function add(string $url, string|BackedEnum|null $icon, string $title): void
public function add(string $url, string|BackedEnum|null $icon, string $title, ?Model $record = null): void
{
if ($icon instanceof Heroicon) {
$icon = "heroicon-$icon->value";
Expand All@@ -28,6 +28,8 @@ public function add(string $url, string|BackedEnum|null $icon, string $title): v
'url' => $url,
'icon' => $icon ?? '',
'title' => $title,
'recordable_type' => $record?->getMorphClass(),
'recordable_id' => $record?->getKey(),
]);
}
}
1 change: 1 addition & 0 deletions src/RecentlyServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ protected function getMigrations(): array
{
return [
'create_recently_table',
'add_recordable_to_recent_entries_table',
];
}
}
6 changes: 6 additions & 0 deletions src/Resources/RecentEntryResource.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use Awcodes\Recently\RecentlyPlugin;
use Filament\Resources\Resource;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class RecentEntryResource extends Resource
Expand All@@ -21,6 +22,11 @@ public static function getModel(): string
return config('recently.model');
}

public static function getGlobalSearchEloquentQuery(): Builder
{
return parent::getGlobalSearchEloquentQuery()->existing();
}

public static function getGlobalSearchResultUrl(Model $record): ?string
{
return $record->url;
Expand Down
1 change: 1 addition & 0 deletions tests/database/migrations/create_pages_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ public function up(): void
$table->longText('content')->nullable();

$table->timestamps();
$table->softDeletes();
});
}
};
1 change: 1 addition & 0 deletions tests/database/migrations/create_recent_entries_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ public function up()
$table->text('url');
$table->string('icon');
$table->string('title');
$table->nullableMorphs('recordable');

$table->timestamps();
});
Expand Down
67 changes: 67 additions & 0 deletions tests/src/DeletedRecordsTest.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
<?php

declare(strict_types=1);

use Awcodes\Recently\Livewire\RecentlyMenu;
use Awcodes\Recently\Models\RecentEntry;
use Awcodes\Recently\RecentlyPlugin;
use Awcodes\Recently\Resources\RecentEntryResource;
use Awcodes\Recently\Tests\Models\Page;
use Awcodes\Recently\Tests\Models\User;
use Awcodes\Recently\Tests\Resources\Pages\PageResource;
use Filament\Facades\Filament;

use function Pest\Livewire\livewire;

beforeEach(function () {
$this->user = User::factory()->create();
$this->actingAs($this->user);

$this->panel = Filament::getCurrentOrDefaultPanel();
$this->panel->plugins([RecentlyPlugin::make()]);

$this->plugin = Filament::getPlugin('awcodes/recently');
});

it('stores a polymorphic reference to the viewed record', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);

$this->get($url)->assertSuccessful();

$this->assertDatabaseHas(RecentEntry::class, [
'url' => $url,
'recordable_type' => $page->getMorphClass(),
'recordable_id' => $page->getKey(),
]);
});

it('hides entries whose record has been deleted, keeping live and reference-less ones', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);
$this->get($url)->assertSuccessful();

// an entry that points at nothing (no record reference) must always survive
RecentEntry::create([
'user_id' => $this->user->id,
'url' => 'https://example.test/legacy',
'icon' => '',
'title' => 'Legacy',
]);

expect(RecentEntry::existing()->pluck('url')->all())->toContain($url);

$page->delete();

expect(RecentEntry::existing()->pluck('url')->all())
->not->toContain($url)
->toContain('https://example.test/legacy');

// menu surface
$records = livewire(RecentlyMenu::class)->instance()->records;
expect($records->pluck('url')->all())->not->toContain($url);

// global-search surface
$searchUrls = RecentEntryResource::getGlobalSearchEloquentQuery()->pluck('url')->all();
expect($searchUrls)->not->toContain($url);
});
2 changes: 2 additions & 0 deletions tests/src/Models/Page.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@
use Awcodes\Recently\Tests\Database\Factories\PageFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Page extends Model
{
use HasFactory;
use SoftDeletes;

protected $guarded = [];

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode"); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })();
Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
11 changes: 11 additions & 0 deletions README.md
Original file line numberDiff line numberDiff line change
Expand Up@@ -29,6 +29,13 @@ composer require awcodes/recently
php artisan recently:install
```

> [!IMPORTANT]
> **Upgrading an existing installation?** Publish and run the new migration so recent entries can reference their record (this powers automatic filtering of deleted records):
> ```bash
> php artisan vendor:publish --tag="recently-migrations"
> php artisan migrate
> ```

> [!IMPORTANT]
> If you have not set up a custom theme and are using Filament Panels follow the instructions in the [Filament Docs](https://filamentphp.com/docs/4.x/styling/overview#creating-a-custom-theme) first.

Expand DownExpand Up@@ -94,6 +101,10 @@ class ViewUser extends ViewRecord
}
```

### Deleted Records

Recent entries are automatically hidden from the menu and global search once the record they point to no longer exists — including soft-deleted records — so users never follow a stale link to a "Record not found" page. Each entry stores a polymorphic `recordable` reference to its record, and only entries whose record still resolves are displayed. Entries recorded for pages without an underlying record are always kept.

## Configuration
You can enable/disable or customize the plugin's features either globally through the `config` file or per panel.

Expand Down
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
<?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::table('recent_entries', function (Blueprint $table) {
$table->nullableMorphs('recordable');
});
}
};
1 change: 1 addition & 0 deletions src/Concerns/HasRecentHistoryRecorder.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -40,6 +40,7 @@ protected function recordHistory(): void
url: request()->url(),
icon: $resource::getNavigationIcon(),
title: strip_tags((string) $title),
record: $record,
);
}

Expand Down
2 changes: 1 addition & 1 deletion src/Facades/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,7 +7,7 @@
use Illuminate\Support\Facades\Facade;

/**
* @method static void add(string $url, string $icon, string $title)
* @method static void add(string $url, string|\BackedEnum|null $icon, string $title, ?\Illuminate\Database\Eloquent\Model $record = null)
*
* @see \Awcodes\Recently\Recently
*/
Expand Down
1 change: 1 addition & 0 deletions src/Livewire/RecentlyMenu.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -51,6 +51,7 @@ public function getRecords(): void
$model = config('recently.model');

$this->records = $model::query()
->existing()
->orderByDesc('updated_at')
->limit($this->maxItems)
->get();
Expand Down
26 changes: 26 additions & 0 deletions src/Models/RecentEntry.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -8,16 +8,20 @@
use Awcodes\Recently\Models\Scopes\RecentEntryScope;
use Carbon\CarbonInterface;
use Illuminate\Database\Eloquent\Attributes\ScopedBy;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Database\Eloquent\Relations\MorphTo;

/**
* @property-read int $id
* @property-read int $user_id
* @property string $url
* @property string|null $icon
* @property string|null $title
* @property string|null $recordable_type
* @property int|string|null $recordable_id
* @property-read CarbonInterface $created_at
* @property-read CarbonInterface $updated_at
*/
Expand All@@ -31,13 +35,35 @@ class RecentEntry extends Model
'url',
'icon',
'title',
'recordable_type',
'recordable_id',
];

public function user(): BelongsTo
{
return $this->belongsTo(config('recently.user_model'));
}

public function recordable(): MorphTo
{
return $this->morphTo();
}

/**
* Limit to entries that still point at a live record — i.e. those with no
* record reference (e.g. non-record pages), or whose referenced record
* still exists. A soft-deleted or hard-deleted record fails the morph
* existence check and is excluded.
*/
public function scopeExisting(Builder $query): void
{
$query->where(function (Builder $query): void {
$query
->whereNull('recordable_type')
->orWhereHasMorph('recordable', '*');
});
}

protected static function newFactory(): RecentEntryFactory
{
return new RecentEntryFactory;
Expand Down
4 changes: 3 additions & 1 deletion src/Recently.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,7 +11,7 @@

class Recently
{
public function add(string $url, string|BackedEnum|null $icon, string $title): void
public function add(string $url, string|BackedEnum|null $icon, string $title, ?Model $record = null): void
{
if ($icon instanceof Heroicon) {
$icon = "heroicon-$icon->value";
Expand All@@ -28,6 +28,8 @@ public function add(string $url, string|BackedEnum|null $icon, string $title): v
'url' => $url,
'icon' => $icon ?? '',
'title' => $title,
'recordable_type' => $record?->getMorphClass(),
'recordable_id' => $record?->getKey(),
]);
}
}
1 change: 1 addition & 0 deletions src/RecentlyServiceProvider.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -44,6 +44,7 @@ protected function getMigrations(): array
{
return [
'create_recently_table',
'add_recordable_to_recent_entries_table',
];
}
}
6 changes: 6 additions & 0 deletions src/Resources/RecentEntryResource.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -6,6 +6,7 @@

use Awcodes\Recently\RecentlyPlugin;
use Filament\Resources\Resource;
use Illuminate\Database\Eloquent\Builder;
use Illuminate\Database\Eloquent\Model;

class RecentEntryResource extends Resource
Expand All@@ -21,6 +22,11 @@ public static function getModel(): string
return config('recently.model');
}

public static function getGlobalSearchEloquentQuery(): Builder
{
return parent::getGlobalSearchEloquentQuery()->existing();
}

public static function getGlobalSearchResultUrl(Model $record): ?string
{
return $record->url;
Expand Down
1 change: 1 addition & 0 deletions tests/database/migrations/create_pages_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -18,6 +18,7 @@ public function up(): void
$table->longText('content')->nullable();

$table->timestamps();
$table->softDeletes();
});
}
};
1 change: 1 addition & 0 deletions tests/database/migrations/create_recent_entries_table.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -17,6 +17,7 @@ public function up()
$table->text('url');
$table->string('icon');
$table->string('title');
$table->nullableMorphs('recordable');

$table->timestamps();
});
Expand Down
67 changes: 67 additions & 0 deletions tests/src/DeletedRecordsTest.php
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,67 @@
<?php

declare(strict_types=1);

use Awcodes\Recently\Livewire\RecentlyMenu;
use Awcodes\Recently\Models\RecentEntry;
use Awcodes\Recently\RecentlyPlugin;
use Awcodes\Recently\Resources\RecentEntryResource;
use Awcodes\Recently\Tests\Models\Page;
use Awcodes\Recently\Tests\Models\User;
use Awcodes\Recently\Tests\Resources\Pages\PageResource;
use Filament\Facades\Filament;

use function Pest\Livewire\livewire;

beforeEach(function () {
$this->user = User::factory()->create();
$this->actingAs($this->user);

$this->panel = Filament::getCurrentOrDefaultPanel();
$this->panel->plugins([RecentlyPlugin::make()]);

$this->plugin = Filament::getPlugin('awcodes/recently');
});

it('stores a polymorphic reference to the viewed record', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);

$this->get($url)->assertSuccessful();

$this->assertDatabaseHas(RecentEntry::class, [
'url' => $url,
'recordable_type' => $page->getMorphClass(),
'recordable_id' => $page->getKey(),
]);
});

it('hides entries whose record has been deleted, keeping live and reference-less ones', function () {
$page = Page::factory()->create();
$url = PageResource::getUrl('edit', ['record' => $page]);
$this->get($url)->assertSuccessful();

// an entry that points at nothing (no record reference) must always survive
RecentEntry::create([
'user_id' => $this->user->id,
'url' => 'https://example.test/legacy',
'icon' => '',
'title' => 'Legacy',
]);

expect(RecentEntry::existing()->pluck('url')->all())->toContain($url);

$page->delete();

expect(RecentEntry::existing()->pluck('url')->all())
->not->toContain($url)
->toContain('https://example.test/legacy');

// menu surface
$records = livewire(RecentlyMenu::class)->instance()->records;
expect($records->pluck('url')->all())->not->toContain($url);

// global-search surface
$searchUrls = RecentEntryResource::getGlobalSearchEloquentQuery()->pluck('url')->all();
expect($searchUrls)->not->toContain($url);
});
2 changes: 2 additions & 0 deletions tests/src/Models/Page.php
Original file line numberDiff line numberDiff line change
Expand Up@@ -7,10 +7,12 @@
use Awcodes\Recently\Tests\Database\Factories\PageFactory;
use Illuminate\Database\Eloquent\Factories\HasFactory;
use Illuminate\Database\Eloquent\Model;
use Illuminate\Database\Eloquent\SoftDeletes;

class Page extends Model
{
use HasFactory;
use SoftDeletes;

protected $guarded = [];

Expand Down