Skip to content

[4.x] Add a way to determine which entry saved event was the initiator#8605

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
jasonvarga merged 5 commits into from
Aug 22, 2023
Merged

[4.x] Add a way to determine which entry saved event was the initiator #8605

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
1d6d2c5
test
jasonvarga Aug 21, 2023
5786b66
get it passing
jasonvarga Aug 21, 2023
05506ab
use user event in test since it doesnt do extra stuff
jasonvarga Aug 21, 2023
839b015
extract to fluent class
jasonvarga Aug 21, 2023
20c0fb2
add method
jasonvarga Aug 21, 2023
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
5 changes: 5 additions & 0 deletions src/Entries/Entry.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Entries;

use ArrayAccess;
use Facades\Statamic\Entries\InitiatorStack;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Support\Carbon;
Expand DownExpand Up@@ -336,6 +337,8 @@ public function save()

$this->ancestors()->each(fn ($entry) => Blink::forget('entry-descendants-'.$entry->id()));

$stack = InitiatorStack::entry($this)->push();

$this->directDescendants()->each->save();

$this->taxonomize();
Expand All@@ -362,6 +365,8 @@ public function save()
});
}

$stack->pop();

return true;
}

Expand Down
48 changes: 48 additions & 0 deletions src/Entries/InitiatorStack.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
<?php

namespace Statamic\Entries;

use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Blink;

class InitiatorStack
{
private $entry;
private $key;
private $stack;

public function entry($entry)
{
$this->entry = $entry;
$this->key = 'entry-event-initiator-'.$entry->root()->id();
$this->stack = Blink::get($this->key) ?? collect();

return $this;
}

public function push()
{
$initiator = $this->stack->first() ?? $this->entry;

$initiatorIsAncestor = $this->entry
->ancestors()
->contains(fn ($entry) => $entry->id() === $initiator->id());

if ($this->stack->isEmpty() || $initiatorIsAncestor) {
$this->stack->push($this->entry);
Blink::put($this->key, $this->stack);
}

return $this;
}

public function initiator(): ?Entry
{
return $this->stack->first();
}

public function pop()
{
$this->stack->pop();
}
}
8 changes: 8 additions & 0 deletions src/Events/EntrySaved.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,19 +2,27 @@

namespace Statamic\Events;

use Facades\Statamic\Entries\InitiatorStack;
use Statamic\Contracts\Git\ProvidesCommitMessage;

class EntrySaved extends Event implements ProvidesCommitMessage
{
public $entry;
public $initiator;

public function __construct($entry)
{
$this->entry = $entry;
$this->initiator = InitiatorStack::entry($entry)->initiator();
}

public function commitMessage()
{
return __('Entry saved', [], config('statamic.git.locale'));
}

public function isInitiator()
{
return $this->entry->id() === $this->initiator->id();
}
}
50 changes: 50 additions & 0 deletions tests/Data/Entries/EntryTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -2237,4 +2237,54 @@ public function __call($method, $args)
$this->assertCount(2, $fakeBlink->calls['origin-Entry-2']);
$this->assertCount(2, $fakeBlink->calls['origin-Entry-3']);
}

/** @test */
public function initially_saved_entry_gets_put_into_events()
{
Facades\Site::setConfig([
'default' => 'en',
'sites' => [
'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => '/'],
'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => '/fr/'],
'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => '/de/'],
'es' => ['name' => 'Spanish', 'locale' => 'es_ES', 'url' => '/es/'],
],
]);

// Bunch of localizations of the same entry.
$one = EntryFactory::collection('test')->id('1')->locale('en')->data(['foo' => 'root'])->create();
$two = EntryFactory::collection('test')->id('2')->origin('1')->locale('fr')->create();
$three = EntryFactory::collection('test')->id('3')->origin('2')->locale('de')->create();
$four = EntryFactory::collection('test')->id('4')->origin('3')->locale('es')->create();

// Separate entry with localization.
$five = EntryFactory::collection('test')->id('5')->locale('en')->create();
$six = EntryFactory::collection('test')->id('6')->origin('5')->locale('fr')->create();

// Yet another separate entry.
$seven = EntryFactory::collection('test')->id('7')->create();

// Avoid using a fake so we can use a real listener.
$events = collect();
Event::listen(function (EntrySaved $event) use ($five, &$events) {
$events[] = $event;

// Save unrelated entry during the localization recursion.
if ($event->entry->id() === '3') {
$five->save();
}
});

$two->save();
$seven->save();

$this->assertEquals([
['4', '2'],
['3', '2'],
['6', '5'],
['5', '5'],
['2', '2'],
['7', '7'],
], $events->map(fn ($event) => [$event->entry->id(), $event->initiator->id()])->all());
}
}
8 changes: 4 additions & 4 deletions tests/Search/UpdateItemIndexesTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@

use Mockery;
use Statamic\Contracts\Search\Searchable;
use Statamic\Events\EntryDeleted;
use Statamic\Events\EntrySaved;
use Statamic\Events\UserDeleted;
use Statamic\Events\UserSaved;
use Statamic\Facades\Search;
use Statamic\Search\UpdateItemIndexes;
use Tests\TestCase;
Expand All@@ -19,7 +19,7 @@ public function it_updates_indexes_on_save()

Search::shouldReceive('updateWithinIndexes')->with($item)->once();

$event = new EntrySaved($item);
$event = new UserSaved($item);

$listener = new UpdateItemIndexes;

Expand All@@ -33,7 +33,7 @@ public function it_updates_indexes_on_delete()

Search::shouldReceive('deleteFromIndexes')->with($item)->once();

$event = new EntryDeleted($item);
$event = new UserDeleted($item);

$listener = new UpdateItemIndexes;

Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
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;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[4.x] Add a way to determine which entry saved event was the initiator by jasonvarga · Pull Request #8605 · statamic/cms · GitHub
Skip to content
[4.x] Add a way to determine which entry saved event was the initiator#8605

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

jasonvarga
merged 5 commits into

from

Aug 22, 2023
 Merged


[4.x] Add a way to determine which entry saved event was the initiator
#8605
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
1d6d2c5

test


jasonvarga Aug 21, 2023
5786b66

get it passing


jasonvarga Aug 21, 2023
05506ab

use user event in test since it doesnt do extra stuff


jasonvarga Aug 21, 2023
839b015

extract to fluent class


jasonvarga Aug 21, 2023
20c0fb2

add method


jasonvarga Aug 21, 2023

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


5 changes: 5 additions & 0 deletions
src/Entries/Entry.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Entries;

use ArrayAccess;
use Facades\Statamic\Entries\InitiatorStack;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Support\Carbon;
Expand DownExpand Up@@ -336,6 +337,8 @@ public function save()

 $this->ancestors()->each(fn ($entry) => Blink::forget('entry-descendants-'.$entry->id()));

 $stack = InitiatorStack::entry($this)->push();

 $this->directDescendants()->each->save();

 $this->taxonomize();
Expand All@@ -362,6 +365,8 @@ public function save()
 });
 }

 $stack->pop();

 return true;
 }

Expand Down

48 changes: 48 additions & 0 deletions
src/Entries/InitiatorStack.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
<?php

namespace Statamic\Entries;

use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Blink;

class InitiatorStack
{
 private $entry;
 private $key;
 private $stack;

 public function entry($entry)
 {
 $this->entry = $entry;
 $this->key = 'entry-event-initiator-'.$entry->root()->id();
 $this->stack = Blink::get($this->key) ?? collect();

 return $this;
 }

 public function push()
 {
 $initiator = $this->stack->first() ?? $this->entry;

 $initiatorIsAncestor = $this->entry
 ->ancestors()
 ->contains(fn ($entry) => $entry->id() === $initiator->id());

 if ($this->stack->isEmpty() || $initiatorIsAncestor) {
 $this->stack->push($this->entry);
 Blink::put($this->key, $this->stack);
 }

 return $this;
 }

 public function initiator(): ?Entry
 {
 return $this->stack->first();
 }

 public function pop()
 {
 $this->stack->pop();
 }
}

8 changes: 8 additions & 0 deletions
src/Events/EntrySaved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,19 +2,27 @@

namespace Statamic\Events;

use Facades\Statamic\Entries\InitiatorStack;
use Statamic\Contracts\Git\ProvidesCommitMessage;

class EntrySaved extends Event implements ProvidesCommitMessage
{
 public $entry;
 public $initiator;

 public function __construct($entry)
 {
 $this->entry = $entry;
 $this->initiator = InitiatorStack::entry($entry)->initiator();
 }

 public function commitMessage()
 {
 return __('Entry saved', [], config('statamic.git.locale'));
 }

 public function isInitiator()
 {
 return $this->entry->id() === $this->initiator->id();
 }
}

50 changes: 50 additions & 0 deletions
tests/Data/Entries/EntryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2237,4 +2237,54 @@ public function __call($method, $args)
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-2']);
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-3']);
 }

 /** @test */
 public function initially_saved_entry_gets_put_into_events()
 {
 Facades\Site::setConfig([
 'default' => 'en',
 'sites' => [
 'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => '/'],
 'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => '/fr/'],
 'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => '/de/'],
 'es' => ['name' => 'Spanish', 'locale' => 'es_ES', 'url' => '/es/'],
 ],
 ]);

 // Bunch of localizations of the same entry.
 $one = EntryFactory::collection('test')->id('1')->locale('en')->data(['foo' => 'root'])->create();
 $two = EntryFactory::collection('test')->id('2')->origin('1')->locale('fr')->create();
 $three = EntryFactory::collection('test')->id('3')->origin('2')->locale('de')->create();
 $four = EntryFactory::collection('test')->id('4')->origin('3')->locale('es')->create();

 // Separate entry with localization.
 $five = EntryFactory::collection('test')->id('5')->locale('en')->create();
 $six = EntryFactory::collection('test')->id('6')->origin('5')->locale('fr')->create();

 // Yet another separate entry.
 $seven = EntryFactory::collection('test')->id('7')->create();

 // Avoid using a fake so we can use a real listener.
 $events = collect();
 Event::listen(function (EntrySaved $event) use ($five, &$events) {
 $events[] = $event;

 // Save unrelated entry during the localization recursion.
 if ($event->entry->id() === '3') {
 $five->save();
 }
 });

 $two->save();
 $seven->save();

 $this->assertEquals([
 ['4', '2'],
 ['3', '2'],
 ['6', '5'],
 ['5', '5'],
 ['2', '2'],
 ['7', '7'],
 ], $events->map(fn ($event) => [$event->entry->id(), $event->initiator->id()])->all());
 }
}

8 changes: 4 additions & 4 deletions
tests/Search/UpdateItemIndexesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@

use Mockery;
use Statamic\Contracts\Search\Searchable;
use Statamic\Events\EntryDeleted;
use Statamic\Events\EntrySaved;
use Statamic\Events\UserDeleted;
use Statamic\Events\UserSaved;
use Statamic\Facades\Search;
use Statamic\Search\UpdateItemIndexes;
use Tests\TestCase;
Expand All@@ -19,7 +19,7 @@ public function it_updates_indexes_on_save()

 Search::shouldReceive('updateWithinIndexes')->with($item)->once();

 $event = new EntrySaved($item);
 $event = new UserSaved($item);

 $listener = new UpdateItemIndexes;

Expand All@@ -33,7 +33,7 @@ public function it_updates_indexes_on_delete()

 Search::shouldReceive('deleteFromIndexes')->with($item)->once();

 $event = new EntryDeleted($item);
 $event = new UserDeleted($item);

 $listener = new UpdateItemIndexes;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[4.x] Add a way to determine which entry saved event was the initiator by jasonvarga · Pull Request #8605 · statamic/cms · GitHub
Skip to content
[4.x] Add a way to determine which entry saved event was the initiator#8605

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

jasonvarga
merged 5 commits into

from

Aug 22, 2023
 Merged


[4.x] Add a way to determine which entry saved event was the initiator
#8605
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
1d6d2c5

test


jasonvarga Aug 21, 2023
5786b66

get it passing


jasonvarga Aug 21, 2023
05506ab

use user event in test since it doesnt do extra stuff


jasonvarga Aug 21, 2023
839b015

extract to fluent class


jasonvarga Aug 21, 2023
20c0fb2

add method


jasonvarga Aug 21, 2023

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


5 changes: 5 additions & 0 deletions
src/Entries/Entry.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Entries;

use ArrayAccess;
use Facades\Statamic\Entries\InitiatorStack;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Support\Carbon;
Expand DownExpand Up@@ -336,6 +337,8 @@ public function save()

 $this->ancestors()->each(fn ($entry) => Blink::forget('entry-descendants-'.$entry->id()));

 $stack = InitiatorStack::entry($this)->push();

 $this->directDescendants()->each->save();

 $this->taxonomize();
Expand All@@ -362,6 +365,8 @@ public function save()
 });
 }

 $stack->pop();

 return true;
 }

Expand Down

48 changes: 48 additions & 0 deletions
src/Entries/InitiatorStack.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
<?php

namespace Statamic\Entries;

use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Blink;

class InitiatorStack
{
 private $entry;
 private $key;
 private $stack;

 public function entry($entry)
 {
 $this->entry = $entry;
 $this->key = 'entry-event-initiator-'.$entry->root()->id();
 $this->stack = Blink::get($this->key) ?? collect();

 return $this;
 }

 public function push()
 {
 $initiator = $this->stack->first() ?? $this->entry;

 $initiatorIsAncestor = $this->entry
 ->ancestors()
 ->contains(fn ($entry) => $entry->id() === $initiator->id());

 if ($this->stack->isEmpty() || $initiatorIsAncestor) {
 $this->stack->push($this->entry);
 Blink::put($this->key, $this->stack);
 }

 return $this;
 }

 public function initiator(): ?Entry
 {
 return $this->stack->first();
 }

 public function pop()
 {
 $this->stack->pop();
 }
}

8 changes: 8 additions & 0 deletions
src/Events/EntrySaved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,19 +2,27 @@

namespace Statamic\Events;

use Facades\Statamic\Entries\InitiatorStack;
use Statamic\Contracts\Git\ProvidesCommitMessage;

class EntrySaved extends Event implements ProvidesCommitMessage
{
 public $entry;
 public $initiator;

 public function __construct($entry)
 {
 $this->entry = $entry;
 $this->initiator = InitiatorStack::entry($entry)->initiator();
 }

 public function commitMessage()
 {
 return __('Entry saved', [], config('statamic.git.locale'));
 }

 public function isInitiator()
 {
 return $this->entry->id() === $this->initiator->id();
 }
}

50 changes: 50 additions & 0 deletions
tests/Data/Entries/EntryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2237,4 +2237,54 @@ public function __call($method, $args)
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-2']);
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-3']);
 }

 /** @test */
 public function initially_saved_entry_gets_put_into_events()
 {
 Facades\Site::setConfig([
 'default' => 'en',
 'sites' => [
 'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => '/'],
 'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => '/fr/'],
 'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => '/de/'],
 'es' => ['name' => 'Spanish', 'locale' => 'es_ES', 'url' => '/es/'],
 ],
 ]);

 // Bunch of localizations of the same entry.
 $one = EntryFactory::collection('test')->id('1')->locale('en')->data(['foo' => 'root'])->create();
 $two = EntryFactory::collection('test')->id('2')->origin('1')->locale('fr')->create();
 $three = EntryFactory::collection('test')->id('3')->origin('2')->locale('de')->create();
 $four = EntryFactory::collection('test')->id('4')->origin('3')->locale('es')->create();

 // Separate entry with localization.
 $five = EntryFactory::collection('test')->id('5')->locale('en')->create();
 $six = EntryFactory::collection('test')->id('6')->origin('5')->locale('fr')->create();

 // Yet another separate entry.
 $seven = EntryFactory::collection('test')->id('7')->create();

 // Avoid using a fake so we can use a real listener.
 $events = collect();
 Event::listen(function (EntrySaved $event) use ($five, &$events) {
 $events[] = $event;

 // Save unrelated entry during the localization recursion.
 if ($event->entry->id() === '3') {
 $five->save();
 }
 });

 $two->save();
 $seven->save();

 $this->assertEquals([
 ['4', '2'],
 ['3', '2'],
 ['6', '5'],
 ['5', '5'],
 ['2', '2'],
 ['7', '7'],
 ], $events->map(fn ($event) => [$event->entry->id(), $event->initiator->id()])->all());
 }
}

8 changes: 4 additions & 4 deletions
tests/Search/UpdateItemIndexesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@

use Mockery;
use Statamic\Contracts\Search\Searchable;
use Statamic\Events\EntryDeleted;
use Statamic\Events\EntrySaved;
use Statamic\Events\UserDeleted;
use Statamic\Events\UserSaved;
use Statamic\Facades\Search;
use Statamic\Search\UpdateItemIndexes;
use Tests\TestCase;
Expand All@@ -19,7 +19,7 @@ public function it_updates_indexes_on_save()

 Search::shouldReceive('updateWithinIndexes')->with($item)->once();

 $event = new EntrySaved($item);
 $event = new UserSaved($item);

 $listener = new UpdateItemIndexes;

Expand All@@ -33,7 +33,7 @@ public function it_updates_indexes_on_delete()

 Search::shouldReceive('deleteFromIndexes')->with($item)->once();

 $event = new EntryDeleted($item);
 $event = new UserDeleted($item);

 $listener = new UpdateItemIndexes;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[4.x] Add a way to determine which entry saved event was the initiator by jasonvarga · Pull Request #8605 · statamic/cms · GitHub
Skip to content
[4.x] Add a way to determine which entry saved event was the initiator#8605

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

jasonvarga
merged 5 commits into

from

Aug 22, 2023
 Merged


[4.x] Add a way to determine which entry saved event was the initiator
#8605
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
1d6d2c5

test


jasonvarga Aug 21, 2023
5786b66

get it passing


jasonvarga Aug 21, 2023
05506ab

use user event in test since it doesnt do extra stuff


jasonvarga Aug 21, 2023
839b015

extract to fluent class


jasonvarga Aug 21, 2023
20c0fb2

add method


jasonvarga Aug 21, 2023

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


5 changes: 5 additions & 0 deletions
src/Entries/Entry.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Entries;

use ArrayAccess;
use Facades\Statamic\Entries\InitiatorStack;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Support\Carbon;
Expand DownExpand Up@@ -336,6 +337,8 @@ public function save()

 $this->ancestors()->each(fn ($entry) => Blink::forget('entry-descendants-'.$entry->id()));

 $stack = InitiatorStack::entry($this)->push();

 $this->directDescendants()->each->save();

 $this->taxonomize();
Expand All@@ -362,6 +365,8 @@ public function save()
 });
 }

 $stack->pop();

 return true;
 }

Expand Down

48 changes: 48 additions & 0 deletions
src/Entries/InitiatorStack.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
<?php

namespace Statamic\Entries;

use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Blink;

class InitiatorStack
{
 private $entry;
 private $key;
 private $stack;

 public function entry($entry)
 {
 $this->entry = $entry;
 $this->key = 'entry-event-initiator-'.$entry->root()->id();
 $this->stack = Blink::get($this->key) ?? collect();

 return $this;
 }

 public function push()
 {
 $initiator = $this->stack->first() ?? $this->entry;

 $initiatorIsAncestor = $this->entry
 ->ancestors()
 ->contains(fn ($entry) => $entry->id() === $initiator->id());

 if ($this->stack->isEmpty() || $initiatorIsAncestor) {
 $this->stack->push($this->entry);
 Blink::put($this->key, $this->stack);
 }

 return $this;
 }

 public function initiator(): ?Entry
 {
 return $this->stack->first();
 }

 public function pop()
 {
 $this->stack->pop();
 }
}

8 changes: 8 additions & 0 deletions
src/Events/EntrySaved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,19 +2,27 @@

namespace Statamic\Events;

use Facades\Statamic\Entries\InitiatorStack;
use Statamic\Contracts\Git\ProvidesCommitMessage;

class EntrySaved extends Event implements ProvidesCommitMessage
{
 public $entry;
 public $initiator;

 public function __construct($entry)
 {
 $this->entry = $entry;
 $this->initiator = InitiatorStack::entry($entry)->initiator();
 }

 public function commitMessage()
 {
 return __('Entry saved', [], config('statamic.git.locale'));
 }

 public function isInitiator()
 {
 return $this->entry->id() === $this->initiator->id();
 }
}

50 changes: 50 additions & 0 deletions
tests/Data/Entries/EntryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2237,4 +2237,54 @@ public function __call($method, $args)
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-2']);
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-3']);
 }

 /** @test */
 public function initially_saved_entry_gets_put_into_events()
 {
 Facades\Site::setConfig([
 'default' => 'en',
 'sites' => [
 'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => '/'],
 'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => '/fr/'],
 'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => '/de/'],
 'es' => ['name' => 'Spanish', 'locale' => 'es_ES', 'url' => '/es/'],
 ],
 ]);

 // Bunch of localizations of the same entry.
 $one = EntryFactory::collection('test')->id('1')->locale('en')->data(['foo' => 'root'])->create();
 $two = EntryFactory::collection('test')->id('2')->origin('1')->locale('fr')->create();
 $three = EntryFactory::collection('test')->id('3')->origin('2')->locale('de')->create();
 $four = EntryFactory::collection('test')->id('4')->origin('3')->locale('es')->create();

 // Separate entry with localization.
 $five = EntryFactory::collection('test')->id('5')->locale('en')->create();
 $six = EntryFactory::collection('test')->id('6')->origin('5')->locale('fr')->create();

 // Yet another separate entry.
 $seven = EntryFactory::collection('test')->id('7')->create();

 // Avoid using a fake so we can use a real listener.
 $events = collect();
 Event::listen(function (EntrySaved $event) use ($five, &$events) {
 $events[] = $event;

 // Save unrelated entry during the localization recursion.
 if ($event->entry->id() === '3') {
 $five->save();
 }
 });

 $two->save();
 $seven->save();

 $this->assertEquals([
 ['4', '2'],
 ['3', '2'],
 ['6', '5'],
 ['5', '5'],
 ['2', '2'],
 ['7', '7'],
 ], $events->map(fn ($event) => [$event->entry->id(), $event->initiator->id()])->all());
 }
}

8 changes: 4 additions & 4 deletions
tests/Search/UpdateItemIndexesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@

use Mockery;
use Statamic\Contracts\Search\Searchable;
use Statamic\Events\EntryDeleted;
use Statamic\Events\EntrySaved;
use Statamic\Events\UserDeleted;
use Statamic\Events\UserSaved;
use Statamic\Facades\Search;
use Statamic\Search\UpdateItemIndexes;
use Tests\TestCase;
Expand All@@ -19,7 +19,7 @@ public function it_updates_indexes_on_save()

 Search::shouldReceive('updateWithinIndexes')->with($item)->once();

 $event = new EntrySaved($item);
 $event = new UserSaved($item);

 $listener = new UpdateItemIndexes;

Expand All@@ -33,7 +33,7 @@ public function it_updates_indexes_on_delete()

 Search::shouldReceive('deleteFromIndexes')->with($item)->once();

 $event = new EntryDeleted($item);
 $event = new UserDeleted($item);

 $listener = new UpdateItemIndexes;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[4.x] Add a way to determine which entry saved event was the initiator by jasonvarga · Pull Request #8605 · statamic/cms · GitHub
Skip to content
[4.x] Add a way to determine which entry saved event was the initiator#8605

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

jasonvarga
merged 5 commits into

from

Aug 22, 2023
 Merged


[4.x] Add a way to determine which entry saved event was the initiator
#8605
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
1d6d2c5

test


jasonvarga Aug 21, 2023
5786b66

get it passing


jasonvarga Aug 21, 2023
05506ab

use user event in test since it doesnt do extra stuff


jasonvarga Aug 21, 2023
839b015

extract to fluent class


jasonvarga Aug 21, 2023
20c0fb2

add method


jasonvarga Aug 21, 2023

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


5 changes: 5 additions & 0 deletions
src/Entries/Entry.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Entries;

use ArrayAccess;
use Facades\Statamic\Entries\InitiatorStack;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Support\Carbon;
Expand DownExpand Up@@ -336,6 +337,8 @@ public function save()

 $this->ancestors()->each(fn ($entry) => Blink::forget('entry-descendants-'.$entry->id()));

 $stack = InitiatorStack::entry($this)->push();

 $this->directDescendants()->each->save();

 $this->taxonomize();
Expand All@@ -362,6 +365,8 @@ public function save()
 });
 }

 $stack->pop();

 return true;
 }

Expand Down

48 changes: 48 additions & 0 deletions
src/Entries/InitiatorStack.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
<?php

namespace Statamic\Entries;

use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Blink;

class InitiatorStack
{
 private $entry;
 private $key;
 private $stack;

 public function entry($entry)
 {
 $this->entry = $entry;
 $this->key = 'entry-event-initiator-'.$entry->root()->id();
 $this->stack = Blink::get($this->key) ?? collect();

 return $this;
 }

 public function push()
 {
 $initiator = $this->stack->first() ?? $this->entry;

 $initiatorIsAncestor = $this->entry
 ->ancestors()
 ->contains(fn ($entry) => $entry->id() === $initiator->id());

 if ($this->stack->isEmpty() || $initiatorIsAncestor) {
 $this->stack->push($this->entry);
 Blink::put($this->key, $this->stack);
 }

 return $this;
 }

 public function initiator(): ?Entry
 {
 return $this->stack->first();
 }

 public function pop()
 {
 $this->stack->pop();
 }
}

8 changes: 8 additions & 0 deletions
src/Events/EntrySaved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,19 +2,27 @@

namespace Statamic\Events;

use Facades\Statamic\Entries\InitiatorStack;
use Statamic\Contracts\Git\ProvidesCommitMessage;

class EntrySaved extends Event implements ProvidesCommitMessage
{
 public $entry;
 public $initiator;

 public function __construct($entry)
 {
 $this->entry = $entry;
 $this->initiator = InitiatorStack::entry($entry)->initiator();
 }

 public function commitMessage()
 {
 return __('Entry saved', [], config('statamic.git.locale'));
 }

 public function isInitiator()
 {
 return $this->entry->id() === $this->initiator->id();
 }
}

50 changes: 50 additions & 0 deletions
tests/Data/Entries/EntryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2237,4 +2237,54 @@ public function __call($method, $args)
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-2']);
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-3']);
 }

 /** @test */
 public function initially_saved_entry_gets_put_into_events()
 {
 Facades\Site::setConfig([
 'default' => 'en',
 'sites' => [
 'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => '/'],
 'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => '/fr/'],
 'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => '/de/'],
 'es' => ['name' => 'Spanish', 'locale' => 'es_ES', 'url' => '/es/'],
 ],
 ]);

 // Bunch of localizations of the same entry.
 $one = EntryFactory::collection('test')->id('1')->locale('en')->data(['foo' => 'root'])->create();
 $two = EntryFactory::collection('test')->id('2')->origin('1')->locale('fr')->create();
 $three = EntryFactory::collection('test')->id('3')->origin('2')->locale('de')->create();
 $four = EntryFactory::collection('test')->id('4')->origin('3')->locale('es')->create();

 // Separate entry with localization.
 $five = EntryFactory::collection('test')->id('5')->locale('en')->create();
 $six = EntryFactory::collection('test')->id('6')->origin('5')->locale('fr')->create();

 // Yet another separate entry.
 $seven = EntryFactory::collection('test')->id('7')->create();

 // Avoid using a fake so we can use a real listener.
 $events = collect();
 Event::listen(function (EntrySaved $event) use ($five, &$events) {
 $events[] = $event;

 // Save unrelated entry during the localization recursion.
 if ($event->entry->id() === '3') {
 $five->save();
 }
 });

 $two->save();
 $seven->save();

 $this->assertEquals([
 ['4', '2'],
 ['3', '2'],
 ['6', '5'],
 ['5', '5'],
 ['2', '2'],
 ['7', '7'],
 ], $events->map(fn ($event) => [$event->entry->id(), $event->initiator->id()])->all());
 }
}

8 changes: 4 additions & 4 deletions
tests/Search/UpdateItemIndexesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@

use Mockery;
use Statamic\Contracts\Search\Searchable;
use Statamic\Events\EntryDeleted;
use Statamic\Events\EntrySaved;
use Statamic\Events\UserDeleted;
use Statamic\Events\UserSaved;
use Statamic\Facades\Search;
use Statamic\Search\UpdateItemIndexes;
use Tests\TestCase;
Expand All@@ -19,7 +19,7 @@ public function it_updates_indexes_on_save()

 Search::shouldReceive('updateWithinIndexes')->with($item)->once();

 $event = new EntrySaved($item);
 $event = new UserSaved($item);

 $listener = new UpdateItemIndexes;

Expand All@@ -33,7 +33,7 @@ public function it_updates_indexes_on_delete()

 Search::shouldReceive('deleteFromIndexes')->with($item)->once();

 $event = new EntryDeleted($item);
 $event = new UserDeleted($item);

 $listener = new UpdateItemIndexes;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[4.x] Add a way to determine which entry saved event was the initiator by jasonvarga · Pull Request #8605 · statamic/cms · GitHub
Skip to content
[4.x] Add a way to determine which entry saved event was the initiator#8605

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

jasonvarga
merged 5 commits into

from

Aug 22, 2023
 Merged


[4.x] Add a way to determine which entry saved event was the initiator
#8605
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
1d6d2c5

test


jasonvarga Aug 21, 2023
5786b66

get it passing


jasonvarga Aug 21, 2023
05506ab

use user event in test since it doesnt do extra stuff


jasonvarga Aug 21, 2023
839b015

extract to fluent class


jasonvarga Aug 21, 2023
20c0fb2

add method


jasonvarga Aug 21, 2023

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


5 changes: 5 additions & 0 deletions
src/Entries/Entry.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Entries;

use ArrayAccess;
use Facades\Statamic\Entries\InitiatorStack;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Support\Carbon;
Expand DownExpand Up@@ -336,6 +337,8 @@ public function save()

 $this->ancestors()->each(fn ($entry) => Blink::forget('entry-descendants-'.$entry->id()));

 $stack = InitiatorStack::entry($this)->push();

 $this->directDescendants()->each->save();

 $this->taxonomize();
Expand All@@ -362,6 +365,8 @@ public function save()
 });
 }

 $stack->pop();

 return true;
 }

Expand Down

48 changes: 48 additions & 0 deletions
src/Entries/InitiatorStack.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
<?php

namespace Statamic\Entries;

use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Blink;

class InitiatorStack
{
 private $entry;
 private $key;
 private $stack;

 public function entry($entry)
 {
 $this->entry = $entry;
 $this->key = 'entry-event-initiator-'.$entry->root()->id();
 $this->stack = Blink::get($this->key) ?? collect();

 return $this;
 }

 public function push()
 {
 $initiator = $this->stack->first() ?? $this->entry;

 $initiatorIsAncestor = $this->entry
 ->ancestors()
 ->contains(fn ($entry) => $entry->id() === $initiator->id());

 if ($this->stack->isEmpty() || $initiatorIsAncestor) {
 $this->stack->push($this->entry);
 Blink::put($this->key, $this->stack);
 }

 return $this;
 }

 public function initiator(): ?Entry
 {
 return $this->stack->first();
 }

 public function pop()
 {
 $this->stack->pop();
 }
}

8 changes: 8 additions & 0 deletions
src/Events/EntrySaved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,19 +2,27 @@

namespace Statamic\Events;

use Facades\Statamic\Entries\InitiatorStack;
use Statamic\Contracts\Git\ProvidesCommitMessage;

class EntrySaved extends Event implements ProvidesCommitMessage
{
 public $entry;
 public $initiator;

 public function __construct($entry)
 {
 $this->entry = $entry;
 $this->initiator = InitiatorStack::entry($entry)->initiator();
 }

 public function commitMessage()
 {
 return __('Entry saved', [], config('statamic.git.locale'));
 }

 public function isInitiator()
 {
 return $this->entry->id() === $this->initiator->id();
 }
}

50 changes: 50 additions & 0 deletions
tests/Data/Entries/EntryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2237,4 +2237,54 @@ public function __call($method, $args)
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-2']);
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-3']);
 }

 /** @test */
 public function initially_saved_entry_gets_put_into_events()
 {
 Facades\Site::setConfig([
 'default' => 'en',
 'sites' => [
 'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => '/'],
 'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => '/fr/'],
 'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => '/de/'],
 'es' => ['name' => 'Spanish', 'locale' => 'es_ES', 'url' => '/es/'],
 ],
 ]);

 // Bunch of localizations of the same entry.
 $one = EntryFactory::collection('test')->id('1')->locale('en')->data(['foo' => 'root'])->create();
 $two = EntryFactory::collection('test')->id('2')->origin('1')->locale('fr')->create();
 $three = EntryFactory::collection('test')->id('3')->origin('2')->locale('de')->create();
 $four = EntryFactory::collection('test')->id('4')->origin('3')->locale('es')->create();

 // Separate entry with localization.
 $five = EntryFactory::collection('test')->id('5')->locale('en')->create();
 $six = EntryFactory::collection('test')->id('6')->origin('5')->locale('fr')->create();

 // Yet another separate entry.
 $seven = EntryFactory::collection('test')->id('7')->create();

 // Avoid using a fake so we can use a real listener.
 $events = collect();
 Event::listen(function (EntrySaved $event) use ($five, &$events) {
 $events[] = $event;

 // Save unrelated entry during the localization recursion.
 if ($event->entry->id() === '3') {
 $five->save();
 }
 });

 $two->save();
 $seven->save();

 $this->assertEquals([
 ['4', '2'],
 ['3', '2'],
 ['6', '5'],
 ['5', '5'],
 ['2', '2'],
 ['7', '7'],
 ], $events->map(fn ($event) => [$event->entry->id(), $event->initiator->id()])->all());
 }
}

8 changes: 4 additions & 4 deletions
tests/Search/UpdateItemIndexesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@

use Mockery;
use Statamic\Contracts\Search\Searchable;
use Statamic\Events\EntryDeleted;
use Statamic\Events\EntrySaved;
use Statamic\Events\UserDeleted;
use Statamic\Events\UserSaved;
use Statamic\Facades\Search;
use Statamic\Search\UpdateItemIndexes;
use Tests\TestCase;
Expand All@@ -19,7 +19,7 @@ public function it_updates_indexes_on_save()

 Search::shouldReceive('updateWithinIndexes')->with($item)->once();

 $event = new EntrySaved($item);
 $event = new UserSaved($item);

 $listener = new UpdateItemIndexes;

Expand All@@ -33,7 +33,7 @@ public function it_updates_indexes_on_delete()

 Search::shouldReceive('deleteFromIndexes')->with($item)->once();

 $event = new EntryDeleted($item);
 $event = new UserDeleted($item);

 $listener = new UpdateItemIndexes;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[4.x] Add a way to determine which entry saved event was the initiator by jasonvarga · Pull Request #8605 · statamic/cms · GitHub
Skip to content
[4.x] Add a way to determine which entry saved event was the initiator#8605

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

jasonvarga
merged 5 commits into

from

Aug 22, 2023
 Merged


[4.x] Add a way to determine which entry saved event was the initiator
#8605
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
1d6d2c5

test


jasonvarga Aug 21, 2023
5786b66

get it passing


jasonvarga Aug 21, 2023
05506ab

use user event in test since it doesnt do extra stuff


jasonvarga Aug 21, 2023
839b015

extract to fluent class


jasonvarga Aug 21, 2023
20c0fb2

add method


jasonvarga Aug 21, 2023

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


5 changes: 5 additions & 0 deletions
src/Entries/Entry.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Entries;

use ArrayAccess;
use Facades\Statamic\Entries\InitiatorStack;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Support\Carbon;
Expand DownExpand Up@@ -336,6 +337,8 @@ public function save()

 $this->ancestors()->each(fn ($entry) => Blink::forget('entry-descendants-'.$entry->id()));

 $stack = InitiatorStack::entry($this)->push();

 $this->directDescendants()->each->save();

 $this->taxonomize();
Expand All@@ -362,6 +365,8 @@ public function save()
 });
 }

 $stack->pop();

 return true;
 }

Expand Down

48 changes: 48 additions & 0 deletions
src/Entries/InitiatorStack.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
<?php

namespace Statamic\Entries;

use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Blink;

class InitiatorStack
{
 private $entry;
 private $key;
 private $stack;

 public function entry($entry)
 {
 $this->entry = $entry;
 $this->key = 'entry-event-initiator-'.$entry->root()->id();
 $this->stack = Blink::get($this->key) ?? collect();

 return $this;
 }

 public function push()
 {
 $initiator = $this->stack->first() ?? $this->entry;

 $initiatorIsAncestor = $this->entry
 ->ancestors()
 ->contains(fn ($entry) => $entry->id() === $initiator->id());

 if ($this->stack->isEmpty() || $initiatorIsAncestor) {
 $this->stack->push($this->entry);
 Blink::put($this->key, $this->stack);
 }

 return $this;
 }

 public function initiator(): ?Entry
 {
 return $this->stack->first();
 }

 public function pop()
 {
 $this->stack->pop();
 }
}

8 changes: 8 additions & 0 deletions
src/Events/EntrySaved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,19 +2,27 @@

namespace Statamic\Events;

use Facades\Statamic\Entries\InitiatorStack;
use Statamic\Contracts\Git\ProvidesCommitMessage;

class EntrySaved extends Event implements ProvidesCommitMessage
{
 public $entry;
 public $initiator;

 public function __construct($entry)
 {
 $this->entry = $entry;
 $this->initiator = InitiatorStack::entry($entry)->initiator();
 }

 public function commitMessage()
 {
 return __('Entry saved', [], config('statamic.git.locale'));
 }

 public function isInitiator()
 {
 return $this->entry->id() === $this->initiator->id();
 }
}

50 changes: 50 additions & 0 deletions
tests/Data/Entries/EntryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2237,4 +2237,54 @@ public function __call($method, $args)
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-2']);
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-3']);
 }

 /** @test */
 public function initially_saved_entry_gets_put_into_events()
 {
 Facades\Site::setConfig([
 'default' => 'en',
 'sites' => [
 'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => '/'],
 'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => '/fr/'],
 'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => '/de/'],
 'es' => ['name' => 'Spanish', 'locale' => 'es_ES', 'url' => '/es/'],
 ],
 ]);

 // Bunch of localizations of the same entry.
 $one = EntryFactory::collection('test')->id('1')->locale('en')->data(['foo' => 'root'])->create();
 $two = EntryFactory::collection('test')->id('2')->origin('1')->locale('fr')->create();
 $three = EntryFactory::collection('test')->id('3')->origin('2')->locale('de')->create();
 $four = EntryFactory::collection('test')->id('4')->origin('3')->locale('es')->create();

 // Separate entry with localization.
 $five = EntryFactory::collection('test')->id('5')->locale('en')->create();
 $six = EntryFactory::collection('test')->id('6')->origin('5')->locale('fr')->create();

 // Yet another separate entry.
 $seven = EntryFactory::collection('test')->id('7')->create();

 // Avoid using a fake so we can use a real listener.
 $events = collect();
 Event::listen(function (EntrySaved $event) use ($five, &$events) {
 $events[] = $event;

 // Save unrelated entry during the localization recursion.
 if ($event->entry->id() === '3') {
 $five->save();
 }
 });

 $two->save();
 $seven->save();

 $this->assertEquals([
 ['4', '2'],
 ['3', '2'],
 ['6', '5'],
 ['5', '5'],
 ['2', '2'],
 ['7', '7'],
 ], $events->map(fn ($event) => [$event->entry->id(), $event->initiator->id()])->all());
 }
}

8 changes: 4 additions & 4 deletions
tests/Search/UpdateItemIndexesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@

use Mockery;
use Statamic\Contracts\Search\Searchable;
use Statamic\Events\EntryDeleted;
use Statamic\Events\EntrySaved;
use Statamic\Events\UserDeleted;
use Statamic\Events\UserSaved;
use Statamic\Facades\Search;
use Statamic\Search\UpdateItemIndexes;
use Tests\TestCase;
Expand All@@ -19,7 +19,7 @@ public function it_updates_indexes_on_save()

 Search::shouldReceive('updateWithinIndexes')->with($item)->once();

 $event = new EntrySaved($item);
 $event = new UserSaved($item);

 $listener = new UpdateItemIndexes;

Expand All@@ -33,7 +33,7 @@ public function it_updates_indexes_on_delete()

 Search::shouldReceive('deleteFromIndexes')->with($item)->once();

 $event = new EntryDeleted($item);
 $event = new UserDeleted($item);

 $listener = new UpdateItemIndexes;

Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[4.x] Add a way to determine which entry saved event was the initiator by jasonvarga · Pull Request #8605 · statamic/cms · GitHub
Skip to content
[4.x] Add a way to determine which entry saved event was the initiator#8605

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

jasonvarga
merged 5 commits into

from

Aug 22, 2023
 Merged


[4.x] Add a way to determine which entry saved event was the initiator
#8605
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


5 commits


Select commit
Hold shift + click to select a range
1d6d2c5

test


jasonvarga Aug 21, 2023
5786b66

get it passing


jasonvarga Aug 21, 2023
05506ab

use user event in test since it doesnt do extra stuff


jasonvarga Aug 21, 2023
839b015

extract to fluent class


jasonvarga Aug 21, 2023
20c0fb2

add method


jasonvarga Aug 21, 2023

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


5 changes: 5 additions & 0 deletions
src/Entries/Entry.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -3,6 +3,7 @@
namespace Statamic\Entries;

use ArrayAccess;
use Facades\Statamic\Entries\InitiatorStack;
use Illuminate\Contracts\Support\Arrayable;
use Illuminate\Contracts\Support\Responsable;
use Illuminate\Support\Carbon;
Expand DownExpand Up@@ -336,6 +337,8 @@ public function save()

 $this->ancestors()->each(fn ($entry) => Blink::forget('entry-descendants-'.$entry->id()));

 $stack = InitiatorStack::entry($this)->push();

 $this->directDescendants()->each->save();

 $this->taxonomize();
Expand All@@ -362,6 +365,8 @@ public function save()
 });
 }

 $stack->pop();

 return true;
 }

Expand Down

48 changes: 48 additions & 0 deletions
src/Entries/InitiatorStack.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -0,0 +1,48 @@
<?php

namespace Statamic\Entries;

use Statamic\Contracts\Entries\Entry;
use Statamic\Facades\Blink;

class InitiatorStack
{
 private $entry;
 private $key;
 private $stack;

 public function entry($entry)
 {
 $this->entry = $entry;
 $this->key = 'entry-event-initiator-'.$entry->root()->id();
 $this->stack = Blink::get($this->key) ?? collect();

 return $this;
 }

 public function push()
 {
 $initiator = $this->stack->first() ?? $this->entry;

 $initiatorIsAncestor = $this->entry
 ->ancestors()
 ->contains(fn ($entry) => $entry->id() === $initiator->id());

 if ($this->stack->isEmpty() || $initiatorIsAncestor) {
 $this->stack->push($this->entry);
 Blink::put($this->key, $this->stack);
 }

 return $this;
 }

 public function initiator(): ?Entry
 {
 return $this->stack->first();
 }

 public function pop()
 {
 $this->stack->pop();
 }
}

8 changes: 8 additions & 0 deletions
src/Events/EntrySaved.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2,19 +2,27 @@

namespace Statamic\Events;

use Facades\Statamic\Entries\InitiatorStack;
use Statamic\Contracts\Git\ProvidesCommitMessage;

class EntrySaved extends Event implements ProvidesCommitMessage
{
 public $entry;
 public $initiator;

 public function __construct($entry)
 {
 $this->entry = $entry;
 $this->initiator = InitiatorStack::entry($entry)->initiator();
 }

 public function commitMessage()
 {
 return __('Entry saved', [], config('statamic.git.locale'));
 }

 public function isInitiator()
 {
 return $this->entry->id() === $this->initiator->id();
 }
}

50 changes: 50 additions & 0 deletions
tests/Data/Entries/EntryTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -2237,4 +2237,54 @@ public function __call($method, $args)
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-2']);
 $this->assertCount(2, $fakeBlink->calls['origin-Entry-3']);
 }

 /** @test */
 public function initially_saved_entry_gets_put_into_events()
 {
 Facades\Site::setConfig([
 'default' => 'en',
 'sites' => [
 'en' => ['name' => 'English', 'locale' => 'en_US', 'url' => '/'],
 'fr' => ['name' => 'French', 'locale' => 'fr_FR', 'url' => '/fr/'],
 'de' => ['name' => 'German', 'locale' => 'de_DE', 'url' => '/de/'],
 'es' => ['name' => 'Spanish', 'locale' => 'es_ES', 'url' => '/es/'],
 ],
 ]);

 // Bunch of localizations of the same entry.
 $one = EntryFactory::collection('test')->id('1')->locale('en')->data(['foo' => 'root'])->create();
 $two = EntryFactory::collection('test')->id('2')->origin('1')->locale('fr')->create();
 $three = EntryFactory::collection('test')->id('3')->origin('2')->locale('de')->create();
 $four = EntryFactory::collection('test')->id('4')->origin('3')->locale('es')->create();

 // Separate entry with localization.
 $five = EntryFactory::collection('test')->id('5')->locale('en')->create();
 $six = EntryFactory::collection('test')->id('6')->origin('5')->locale('fr')->create();

 // Yet another separate entry.
 $seven = EntryFactory::collection('test')->id('7')->create();

 // Avoid using a fake so we can use a real listener.
 $events = collect();
 Event::listen(function (EntrySaved $event) use ($five, &$events) {
 $events[] = $event;

 // Save unrelated entry during the localization recursion.
 if ($event->entry->id() === '3') {
 $five->save();
 }
 });

 $two->save();
 $seven->save();

 $this->assertEquals([
 ['4', '2'],
 ['3', '2'],
 ['6', '5'],
 ['5', '5'],
 ['2', '2'],
 ['7', '7'],
 ], $events->map(fn ($event) => [$event->entry->id(), $event->initiator->id()])->all());
 }
}

8 changes: 4 additions & 4 deletions
tests/Search/UpdateItemIndexesTest.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -4,8 +4,8 @@

use Mockery;
use Statamic\Contracts\Search\Searchable;
use Statamic\Events\EntryDeleted;
use Statamic\Events\EntrySaved;
use Statamic\Events\UserDeleted;
use Statamic\Events\UserSaved;
use Statamic\Facades\Search;
use Statamic\Search\UpdateItemIndexes;
use Tests\TestCase;
Expand All@@ -19,7 +19,7 @@ public function it_updates_indexes_on_save()

 Search::shouldReceive('updateWithinIndexes')->with($item)->once();

 $event = new EntrySaved($item);
 $event = new UserSaved($item);

 $listener = new UpdateItemIndexes;

Expand All@@ -33,7 +33,7 @@ public function it_updates_indexes_on_delete()

 Search::shouldReceive('deleteFromIndexes')->with($item)->once();

 $event = new EntryDeleted($item);
 $event = new UserDeleted($item);

 $listener = new UpdateItemIndexes;

Expand Down