Source of file IntegrationTest.php
Size: 50,347 Bytes - Last Modified: 2021-12-23T10:36:11+00:00
/var/www/docs.ssmods.com/process/src/tests/IntegrationTest.php
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514 | <?php namespace SilverStripe\Snapshots\Tests; use DNADesign\Elemental\Extensions\ElementalAreasExtension; use DNADesign\Elemental\Extensions\ElementalPageExtension; use SilverStripe\CMS\Controllers\CMSPageEditController; use SilverStripe\CMS\Model\SiteTree; use SilverStripe\CMSEvents\Listener\Form\Listener; use SilverStripe\Core\Config\Config; use SilverStripe\EventDispatcher\Dispatch\Dispatcher; use SilverStripe\EventDispatcher\Event\EventContextInterface; use SilverStripe\EventDispatcher\Symfony\Event; use SilverStripe\Forms\FieldList; use SilverStripe\Forms\Form; use SilverStripe\ORM\ArrayList; use SilverStripe\ORM\DataObject; use SilverStripe\Snapshots\ActivityEntry; use SilverStripe\Snapshots\ImplicitModification; use SilverStripe\Snapshots\SnapshotEvent; use SilverStripe\Snapshots\SnapshotPublishable; use SilverStripe\Snapshots\Tests\SnapshotTest\BaseJoin; use SilverStripe\Snapshots\Tests\SnapshotTest\Block; use SilverStripe\Snapshots\Tests\SnapshotTest\BlockPage; use SilverStripe\Snapshots\Tests\SnapshotTest\Gallery; use SilverStripe\Snapshots\Tests\SnapshotTest\GalleryImage; use SilverStripe\Snapshots\Tests\SnapshotTest\GalleryImageJoin; use SilverStripe\Versioned\ChangeSetItem; use SilverStripe\Versioned\Versioned; class IntegrationTest extends SnapshotTestAbstract { protected $usesDatabase = true; protected $usesTransactions = false; protected static $extra_dataobjects = [ BlockPage::class, Block::class, Gallery::class, GalleryImage::class, BaseJoin::class, GalleryImageJoin::class, ChangeSetItem::class, ]; /** * @var SiteTree */ private $currentPage; protected function setUp() { parent::setUp(); Config::modify()->set( BlockPage::class, 'snapshot_relation_tracking', ['Blocks'] ); Config::modify()->set( Block::class, 'snapshot_relation_tracking', ['Galleries'] ); Config::modify()->set( Gallery::class, 'snapshot_relation_tracking', ['Images'] ); } public function testFundamentals() { // Model: // BlockPage // -> (has_many/owns) -> Blocks // -> (has_many/owns) -> Gallery // -> (many_many/owns) -> GalleryImage /* @var DataObject|SnapshotPublishable $a1 */ $a1 = new BlockPage(['Title' => 'A1 Block Page']); $this->editingPage($a1); $this->formSaveObject($a1); $this->formPublishObject($a1); /* @var DataObject|SnapshotPublishable $a2 */ $a2 = new BlockPage(['Title' => 'A2 Block Page']); $this->editingPage($a2); $this->formSaveObject($a2); $this->formPublishObject($a2); // A1 Block page edits $this->editingPage($a1); /* @var DataObject|SnapshotPublishable $a1Block1 */ $a1Block1 = new Block(['Title' => 'Block 1 on A1', 'ParentID' => $a1->ID]); $this->formSaveObject($a1Block1); $a1Block2 = new Block(['Title' => 'Block 2 on A1', 'ParentID' => $a1->ID]); $this->formSaveObject($a1Block2); // A1 // block1 (draft, new) * // block2 (draft, new) * $this->editingPage($a2); /* @var DataObject|SnapshotPublishable $a2Block1 */ $a2Block1 = new Block(['Title' => 'Block 1 on A2', 'ParentID' => $a2->ID]); $this->formSaveObject($a2Block1); // A1 // block1 (draft, new) // block2 (draft, new) // A2 // block1 (draft, new) * $this->editingPage($a1); $a1->Title = 'A1 Block Page -- changed'; $this->formSaveObject($a1); // A1 (draft, modified) * // block1 (draft, new) // block2 (draft, new) // A2 // block1 (draft, new) $a1Block1->Title = 'Block 1 on A1 -- changed'; $this->formSaveObject($a1Block1); // A1 (draft, modified) // block1 (draft, modified) * // block2 (draft, new) // A2 // block1 (draft, new) // A1 will publish its two blocks $this->assertTrue($a1->hasOwnedModifications()); // Since publishing: // two new blocks created // one of those was then modified. $activity = $a1->getActivityFeed(); $this->assertCount(4, $activity); $this->assertCount(3, $a1->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$a1Block1, ActivityEntry::CREATED], [$a1Block2, ActivityEntry::CREATED], [$a1, ActivityEntry::MODIFIED], [$a1Block1, ActivityEntry::MODIFIED], ] ); $this->assertPublishableObjectsContains( $a1->getPublishableObjects(), [ $a1Block1, $a1Block2, $a1 ] ); $this->editingPage($a1); // Testing third level /* @var DataObject|SnapshotPublishable|Versioned $gallery1 */ $gallery1 = new Gallery(['Title' => 'Gallery 1 on Block 1 on A1', 'BlockID' => $a1Block1->ID]); $this->formSaveObject($gallery1); // A1 (draft, modified) // block1 (draft, modified) // gallery1 (draft, new) * // block2 (draft, new) // A2 // block1 (draft, new) // A1 will now publish two blocks and a gallery $this->assertTrue($a1->hasOwnedModifications()); // Since last publish: // two blocks were created // one block was modified // one gallery created. $activity = $a1->getActivityFeed(); $this->assertCount(5, $activity); $this->assertCount(4, $a1->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$a1Block1, ActivityEntry::CREATED], [$a1Block2, ActivityEntry::CREATED], [$a1, ActivityEntry::MODIFIED], [$a1Block1, ActivityEntry::MODIFIED], [$gallery1, ActivityEntry::CREATED], ] ); $this->assertPublishableObjectsContains( $a1->getPublishableObjects(), [ $a1Block1, $a1Block2, $a1, $gallery1, ] ); $gallery1->Title = 'Gallery 1 on Block 1 on A1 -- changed'; $this->formSaveObject($gallery1); // A1 (draft, modified) // block1 (draft, modified) // gallery1 (draft, modified) * // block2 (draft, new) // A2 // block1 (draft, new) // A1 will still publish two blocks and a gallery $this->assertTrue($a1->hasOwnedModifications()); // Since last publish: // two blocks were created // one block was modified // one gallery created // one gallery was modified $activity = $a1->getActivityFeed(); $this->assertCount(6, $activity); $this->assertCount(4, $a1->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$a1Block1, ActivityEntry::CREATED], [$a1Block2, ActivityEntry::CREATED], [$a1, ActivityEntry::MODIFIED], [$a1Block1, ActivityEntry::MODIFIED], [$gallery1, ActivityEntry::CREATED], [$gallery1, ActivityEntry::MODIFIED], ] ); $this->assertPublishableObjectsContains( $a1->getPublishableObjects(), [ $a1Block1, $a1Block2, $a1, $gallery1, ] ); // Testing many_many /* @var DataObject|SnapshotPublishable $galleryItem1 */ $galleryItem1 = new GalleryImage(['URL' => '/gallery/image/1']); /* @var DataObject|SnapshotPublishable $galleryItem2 */ $galleryItem2 = new GalleryImage(['URL' => '/gallery/image/2']); $this->formSaveRelations($gallery1, 'Images', [$galleryItem1, $galleryItem2]); // A1 (draft, modified) // block1 (draft, modified) // gallery1 (draft, new) // image1 (draft, new, added) * // image2 (draft, new, added) * // block2 (draft, new) // A2 // block1 (draft, new) $activity = $a1->getActivityFeed(); $this->assertCount(9, $activity); $this->assertCount(7, $a1->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$a1Block1, ActivityEntry::CREATED], [$a1Block2, ActivityEntry::CREATED], [$a1, ActivityEntry::MODIFIED], [$a1Block1, ActivityEntry::MODIFIED], [$gallery1, ActivityEntry::CREATED], [$gallery1, ActivityEntry::MODIFIED], [$galleryItem1, ActivityEntry::ADDED], [$galleryItem2, ActivityEntry::ADDED], [ImplicitModification::singleton(), null], ] ); $this->assertPublishableObjectsContains( $a1->getPublishableObjects(), [ $a1Block1, $a1Block2, $a1, $gallery1, $galleryItem1, $galleryItem2, ] ); $this->editingPage($a2); /* @var DataObject|SnapshotPublishable $gallery1a */ $gallery1a = new Gallery(['Title' => 'Gallery 1 on Block 1 on A2', 'BlockID' => $a2Block1->ID]); $this->formSaveObject($gallery1a); $this->formSaveRelations($gallery1a, 'Images', [$galleryItem1]); // A1 (draft, modified) // block1 (draft, modified) // gallery1 (draft, new) // image1 (draft, new, added) // image2 (draft, new, added) // block2 (draft, new) // A2 // block1 (draft, new) // gallery1a (draft, new) * // image1 (draft, new, added) * $this->assertTrue($a2->hasOwnedModifications()); $activity = $a2->getActivityFeed(); $this->assertCount(4, $activity); $this->assertCount(4, $a2->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$a2Block1, ActivityEntry::CREATED], [$gallery1a, ActivityEntry::CREATED], [$galleryItem1, ActivityEntry::ADDED, $gallery1a], [ImplicitModification::singleton(), null], ] ); $this->assertPublishableObjectsContains( $a2->getPublishableObjects(), [ $a2Block1, $gallery1a, $galleryItem1, ] ); $galleryItem1->URL = '/changed/url'; $this->formSaveObject($galleryItem1); // A1 (draft, modified) // block1 (draft, modified) // gallery1 (draft, new) // image1 (draft, modified, added) * // image2 (draft, new, added) // block2 (draft, new) // A2 // block1 (draft, new) // gallery1a (draft, new) // image1 (draft, modified, added) * $this->assertTrue($a2->hasOwnedModifications()); $activity = $a2->getActivityFeed(); $this->assertCount(5, $activity); $this->assertCount(4, $a2->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$a2Block1, ActivityEntry::CREATED], [$gallery1a, ActivityEntry::CREATED], [$galleryItem1, ActivityEntry::ADDED, $gallery1a], [ImplicitModification::singleton(), null], [$galleryItem1, ActivityEntry::MODIFIED], ] ); $this->assertPublishableObjectsContains( $a2->getPublishableObjects(), [ $a2Block1, $gallery1a, $galleryItem1, ] ); $this->assertTrue($a1->hasOwnedModifications()); $activity = $a1->getActivityFeed(); $this->assertCount(10, $activity); $this->assertCount(7, $a1->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$a1Block1, ActivityEntry::CREATED], [$a1Block2, ActivityEntry::CREATED], [$a1, ActivityEntry::MODIFIED], [$a1Block1, ActivityEntry::MODIFIED], [$gallery1, ActivityEntry::CREATED], [$gallery1, ActivityEntry::MODIFIED], [$galleryItem1, ActivityEntry::ADDED, $gallery1], [$galleryItem2, ActivityEntry::ADDED, $gallery1], [ImplicitModification::singleton(), null], [$galleryItem1, ActivityEntry::MODIFIED], ] ); $this->assertPublishableObjectsContains( $a1->getPublishableObjects(), [ $a1Block1, $a1Block2, $a1, $gallery1, $galleryItem1, $galleryItem2, ] ); $this->editingPage($a1); // Publish, and clear the slate $this->formPublishObject($a1); // A1 (published) * // block1 (published) * // gallery1 (published) * // image1 (published) * // image2 (published) * // block2 (published) * // A2 // block1 (draft, new) // gallery1a (draft, new) // image1 (added) * $this->assertFalse($a1->hasOwnedModifications()); $this->assertTrue($a2->hasOwnedModifications()); $this->editingPage($a2); $this->formPublishObject($a2); // A1 (published) // block1 (published) // gallery1 (published) // image1 (published) // image2 (published) // block2 (published) // A2 // block1 (published) * // gallery1a (published) * // image1 (published) * $this->assertFalse($a1->hasOwnedModifications()); $this->assertFalse($a2->hasOwnedModifications()); $this->assertEmpty($a1->getActivityFeed()); $this->assertEmpty($a2->getActivityFeed()); $this->assertEmpty($a1->getPublishableObjects()); $this->assertEmpty($a2->getPublishableObjects()); } public function testRevertChanges() { /* @var DataObject|SnapshotPublishable $a1 */ /* @var DataObject|SnapshotPublishable $gallery1 */ list ($a1, $a2, $a1Block1, $a1Block2, $a2Block1, $gallery1, $gallery2) = $this->buildState(); $this->editingPage($a1); $this->formPublishObject($a1); $gallery1->Title = 'Gallery 1 is changed'; $this->formSaveObject($gallery1); // A1 (published) // block1 (published) // gallery1 (draft, modified) * // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $this->assertTrue($a1->hasOwnedModifications()); $activity = $a1->getActivityFeed(); $this->assertCount(1, $activity); $this->assertActivityContains($activity, [ [$gallery1, ActivityEntry::MODIFIED], ]); $gallery1->doRevertToLive(); // A1 (published) // block1 (published) // gallery1 (reverted to live) * // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $this->assertEmpty($a1->getActivityFeed()); } public function testIntermediaryObjects() { /* @var DataObject|SnapshotPublishable $a1 */ /* @var DataObject|SnapshotPublishable $a2 */ /* @var DataObject|SnapshotPublishable $a1Block1 */ /* @var DataObject|SnapshotPublishable $gallery1 */ list ($a1, $a2, $a1Block1, $a1Block2, $a2Block1, $gallery1, $gallery2) = $this->buildState(); $this->editingPage($a1); $gallery1->Title = 'Gallery 1 changed'; $this->formSaveObject($gallery1); // A1 (published) // block1 (published) // gallery1 (draft, modified) * // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $this->assertTrue($a1Block1->hasOwnedModifications()); $a1->Title = 'A1 changed'; $this->formSaveObject($a1); // A1 (draft, modified) * // block1 (published) // gallery1 (draft, modified) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) // Publish the intermediary block $this->formPublishObject($a1Block1); // A1 (draft, modified) // block1 (published) // gallery1 (published) * // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) // Block no longer has modified state $this->assertFalse($a1Block1->hasOwnedModifications()); // Nor does the gallery $this->assertFalse($gallery1->hasOwnedModifications()); // Changed block page still does $this->assertTrue($a1->hasOwnedModifications()); $this->formPublishObject($a1); // A1 (published) * // block1 (published) // gallery1 (published) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $this->assertFalse($a1->hasOwnedModifications()); $a1Block1->Title = "A1 is changed again"; $this->formSaveObject($a1Block1); // A1 (draft, modified) * // block1 (published) // gallery1 (published) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $this->assertTrue($a1->hasOwnedModifications()); } public function testChangeOwnershipStructure() { /* @var DataObject|SnapshotPublishable $a1 */ /* @var DataObject|SnapshotPublishable $a2 */ /* @var DataObject|SnapshotPublishable $a1Block1 */ /* @var DataObject|SnapshotPublishable $gallery1 */ /* @var DataObject|SnapshotPublishable $gallery2 */ list ($a1, $a2, $a1Block1, $a1Block2, $a2Block1, $gallery1, $gallery2) = $this->buildState(); $this->editingPage($a1); $this->formPublishObject($a1); $this->formPublishObject($a2); $this->assertFalse($a1->hasOwnedModifications()); $this->assertFalse($a2->hasOwnedModifications()); $a1Block1->Title = 'Block 1 changed'; $this->formSaveObject($a1Block1); // A1 (published) // block1 (draft, modified) * // gallery1 (published) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $this->assertTrue($a1->hasOwnedModifications()); $this->assertFalse($a2->hasOwnedModifications()); $this->editingPage($a2); $a1Block1->ParentID = $a2->ID; $this->formSaveObject($a1Block1); $blockMoved = $a1Block1; // A1 (published) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) // block1-moved-from-A1 (draft, modified) * // gallery1 (published) // Change of ownership. A1 no longer has modifications, but A2 does. $this->assertTrue($a2->hasOwnedModifications()); // A1 doesn't have activity anymore. $activity = $a1->getActivityFeed(); $this->assertEmpty($activity); // A2 has a modified block. // One modification for the local change, and one for the // change of ownership (foreign key) $activity = $a2->getActivityFeed(); $this->assertActivityContains($activity, [ [$blockMoved, ActivityEntry::MODIFIED], [$blockMoved, ActivityEntry::MODIFIED], ]); $this->editingPage($a1); // This should do nothing. A1 has nothing publishable anymore.= $this->formPublishObject($a1); // A1 (published) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) // block1-moved-from-A1 (draft, modified) // gallery1 (published) $this->assertEmpty($a1->getActivityFeed()); // A2 still has the two modification entries listed above $activity = $a2->getActivityFeed(); $this->assertActivityContains($activity, [ [$blockMoved, ActivityEntry::MODIFIED], [$blockMoved, ActivityEntry::MODIFIED], ]); $this->editingPage($a2); $this->formPublishObject($a2); // A1 (published) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) // block1-moved-from-A1 (published) * // gallery1 (published) $this->assertEmpty($a2->getActivityFeed()); $this->assertFalse($a2->hasOwnedModifications()); $this->editingPage($a2); $blockMoved->Title = "The moved block is modified"; $this->formSaveObject($blockMoved); $gallery1->Title = "The gallery that belongs to the moved block is modified"; $this->formSaveObject($gallery1); $item = new GalleryImage(['URL' => '/belongs/to/moved/block']); $item->write(); $this->formSaveRelations($gallery1, 'Images', [$item]); // A1 (published) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) // block1-moved-from-A1 (draft, modified) * // gallery1 (draft, modified) * // image (draft, new, added) * $this->assertTrue($a2->hasOwnedModifications()); $this->assertFalse($a1->hasOwnedModifications()); $activity = $a2->getActivityFeed(); $this->assertCount(4, $activity); $this->assertActivityContains($activity, [ [$blockMoved, ActivityEntry::MODIFIED], [$gallery1, ActivityEntry::MODIFIED], [$item, ActivityEntry::ADDED], [ImplicitModification::singleton(), null], ]); // Move the block back to A1 // Refresh the block so that changed fields flushes $blockMoved = DataObject::get_by_id(Block::class, $blockMoved->ID, false); $blockMoved->ParentID = $a1->ID; $this->editingPage($a1); $this->formSaveObject($blockMoved); // A1 (published) // block1-moved-back-to-A1 (draft, modified) * // gallery1 (draft, modified) * // image (draft, new, added) * // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $this->assertTrue($a1->hasOwnedModifications()); $this->assertFalse($a2->hasOwnedModifications()); $this->assertEmpty($a2->getActivityFeed()); $activity = $a1->getActivityFeed(); $this->assertCount(5, $activity); // Moved block has a modification for the local change, // and also one for the ownership change (foreign key) $this->assertActivityContains($activity, [ [$blockMoved, ActivityEntry::MODIFIED], [$gallery1, ActivityEntry::MODIFIED], [$item, ActivityEntry::ADDED], [ImplicitModification::singleton(), null], [$blockMoved, ActivityEntry::MODIFIED], ]); $this->editingPage($a2); $this->formPublishObject($a2); $this->editingPage($a1); $this->formPublishObject($a1); // A1 (published) // block1-moved-back-to-A1 (published) * // gallery1 (published) * // image (published) * // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $this->assertFalse($a1->hasOwnedModifications()); $this->assertFalse($a2->hasOwnedModifications()); $this->assertEmpty($a1->getActivityFeed()); $this->assertEmpty($a2->getActivityFeed()); // Move a many_many $this->formSaveRelations($gallery1, 'Images', [$item], ActivityEntry::REMOVED); $this->editingPage($a2); $this->formSaveRelations($gallery2, 'Images', [$item], ActivityEntry::ADDED); $item->URL = '/new/url'; $this->formSaveObject($item); // A1 (published) // block1-moved-back-to-A1 (published) // gallery1 (published) // image1 (removed) ---------------> // block2 (published) | // A2 (published) | // block1 (published) | // gallery1a (published) | // image1 (added, modified) <------| $activity = $a1->getActivityFeed(); $this->assertCount(2, $activity); $this->assertActivityContains($activity, [ [$item, ActivityEntry::REMOVED], [ImplicitModification::singleton(), null], ]); $activity = $a2->getActivityFeed(); $this->assertCount(3, $activity); $this->assertActivityContains($activity, [ [$item, ActivityEntry::ADDED], [ImplicitModification::singleton(), null], [$item, ActivityEntry::MODIFIED], ]); } public function testPartialActivityMigration() { /* @var DataObject|SnapshotPublishable $a1 */ /* @var DataObject|SnapshotPublishable $a2 */ /* @var DataObject|SnapshotPublishable $a1Block1 */ /* @var DataObject|SnapshotPublishable $a1Block2 */ list ($a1, $a2, $a1Block1, $a1Block2) = $this->buildState(); // Test that we can transplant a node and relevant activity will be migrated // but unrelated activity will be preserved. $this->editingPage($a1); $this->formPublishObject($a1); $this->formPublishObject($a2); $a1Block1->Title = 'Take one for the team'; $this->formSaveObject($a1Block1); $a1Block2->Title = 'You got this'; $this->formSaveObject($a1Block2); $gallery = new Gallery(['Title' => 'A new gallery for block 2', 'BlockID' => $a1Block2->ID]); $this->formSaveObject($gallery); // A1 (published) // block1 (draft, modified) * // gallery1 (published) // block2 (draft, modified) * // gallery2 (draft, new) * // A2 (published) // block1 (published) // gallery1a (published) $activity = $a1->getActivityFeed(); $this->assertCount(3, $activity); $this->assertActivityContains($activity, [ [$a1Block1, ActivityEntry::MODIFIED], [$a1Block2, ActivityEntry::MODIFIED], [$gallery, ActivityEntry::CREATED], ]); // Move one modified block, but leave the other. $a1Block2->ParentID = $a2->ID; $this->editingPage($a2); $this->formSaveObject($a1Block2); // A1 (published) // block1 (draft, modified) * // gallery1 (published) // A2 (published) // block1 (published) // gallery1a (published) // block2-moved-from-A1 (draft, modified) * // gallery2 (draft, new) * // Now A1 only shows activity for the local change on block 1 $activity = $a1->getActivityFeed(); $this->assertCount(1, $activity); $this->assertActivityContains($activity, [ [$a1Block1, ActivityEntry::MODIFIED], ]); // And the other activity is now on A2 $activity = $a2->getActivityFeed(); $this->assertCount(3, $activity); $this->assertActivityContains($activity, [ [$a1Block2, ActivityEntry::MODIFIED], [$gallery, ActivityEntry::CREATED], [$a1Block2, ActivityEntry::MODIFIED], // <--- the migration ]); } public function testDeletions() { /* @var DataObject|SnapshotPublishable $a1 */ /* @var DataObject|SnapshotPublishable $a2 */ /* @var DataObject|SnapshotPublishable $a1Block1 */ /* @var DataObject|SnapshotPublishable $a1Block2 */ /* @var DataObject|SnapshotPublishable $a2Block1 */ /* @var DataObject|SnapshotPublishable $gallery2 */ list ($a1, $a2, $a1Block1, $a1Block2, $a2Block1, $gallery1, $gallery2) = $this->buildState(); $this->editingPage($a1); $this->formPublishObject($a1); $this->formPublishObject($a2); $this->assertFalse($a1->hasOwnedModifications()); $this->assertFalse($a2->hasOwnedModifications()); $this->formDeleteObject($a1Block1); // A1 (published) // block1 (deleted) * // gallery1 (published) // block2 (published) // A2 (published) // block1 (published) // gallery1a (published) $activity = $a1->getActivityFeed(); $this->assertCount(1, $activity); $this->assertActivityContains($activity, [ [$a1Block1, ActivityEntry::DELETED], ]); $this->editingPage($a2); $a2Block1->Title = 'Change change change'; $this->formSaveObject($a2Block1); $gallery2->Title = 'Changey McChangerson'; $this->formSaveObject($gallery2); // A1 (published) // block1 (deleted) // gallery1 (published) // block2 (published) // A2 (published) // block1 (draft, modified) * // gallery1a (draft, modified) * $activity = $a2->getActivityFeed(); $this->assertCount(2, $activity); $this->assertActivityContains($activity, [ [$a2Block1, ActivityEntry::MODIFIED], [$gallery2, ActivityEntry::MODIFIED], ]); $this->formDeleteObject($a2Block1); // A1 (published) // block1 (deleted) // gallery1 (published) // block2 (published) // A2 (published) // block1 (deleted) * // gallery1a (draft, modified) $activity = $a2->getActivityFeed(); $this->assertCount(3, $activity); $this->assertActivityContains($activity, [ [$a2Block1, ActivityEntry::MODIFIED], [$gallery2, ActivityEntry::MODIFIED], [$a2Block1, ActivityEntry::DELETED], ]); } public function testGetAtSnapshot() { $stamp0 = $this->sleep(1); /* @var DataObject|SnapshotPublishable $a1 */ /* @var DataObject|SnapshotPublishable $a2 */ /* @var DataObject|SnapshotPublishable $a1Block1 */ /* @var DataObject|SnapshotPublishable $a1Block2 */ /* @var DataObject|SnapshotPublishable $a2Block1 */ /* @var DataObject|SnapshotPublishable $gallery2 */ list ($a1, $a2, $a1Block1, $a1Block2, $a2Block1, $gallery1, $gallery2) = $this->buildState(); $this->editingPage($a1); $this->formPublishObject($a1); $this->formPublishObject($a2); $this->assertCount(2, $a1->Blocks()); $this->assertCount(1, $a2->Blocks()); $this->assertCount(1, $a1Block1->Galleries()); $this->assertCount(1, $a2Block1->Galleries()); $stamp1 = $this->sleep(1); $a1Block1->Title = 'A1 Block 1 changed'; $this->formSaveObject($a1Block1); $stamp2 = $this->sleep(1); $a1Block2->Title = 'A1 Block 2 changed'; $this->formSaveObject($a1Block2); $stamp3 = $this->sleep(1); $a1Block1->Title = 'A1 Block 1 changed again'; $this->formSaveObject($a1Block1); $stamp4 = $this->sleep(1); $gallery1->Title = 'new-gallery title'; $this->formSaveObject($gallery1); $stamp5 = $this->sleep(1); $this->editingPage($a2); $a2Block2 = new Block([ 'Title' => 'Block 2 on A2', 'ParentID' => $a2->ID, ]); $this->formSaveObject($a2Block2); $stamp6 = $this->sleep(1); $a2Block1->Title = 'A2 Block 1 changed'; $this->formSaveObject($a2Block1); $stamp7 = $this->sleep(1); $a2->Title = 'The new A2'; $this->formSaveObject($a2); // Sanity check the activity $this->assertCount(4, $a1->getActivityFeed()); $this->assertCount(3, $a2->getActivityFeed()); // Get A1 from its first title change $this->assertEquals('A1 Block 1 changed again', $a1Block1->Title); $oldA1Block1 = $a1Block1->getAtSnapshot($stamp2); $this->assertEquals('A1 Block 1 changed', $oldA1Block1->Title); // Check related objects $a1Blocks = $a1->Blocks()->sort('Created ASC, ID ASC'); $this->assertEquals('new-gallery title', $a1Blocks->first()->Galleries()->first()->Title); $oldA1 = $a1->getAtSnapshot($stamp1); $oldA1Blocks = $oldA1->Blocks()->sort('Created ASC, ID ASC'); $this->assertCount(2, $oldA1Blocks); $this->assertCount(1, $oldA1Blocks->first()->Galleries()); $this->assertEquals('Gallery 1 on Block 1 on A1', $oldA1Blocks->first()->Galleries()->first()->Title); $oldA1 = $a1->getAtSnapshot($stamp1); $oldA1Blocks = $oldA1->Blocks()->sort('Created ASC, ID ASC'); $this->assertCount(2, $oldA1Blocks); $this->assertEquals('A1 Block 1 changed', $oldA1Blocks->first()->Title); $this->assertEquals('Block 2 on A1', $oldA1Blocks->last()->Title); $this->assertCount(1, $oldA1Blocks->first()->Galleries()); $this->assertEquals('Gallery 1 on Block 1 on A1', $oldA1Blocks->first()->Galleries()->first()->Title); $oldA1 = $a1->getAtSnapshot($stamp2); $oldA1Blocks = $oldA1->Blocks()->sort('Created ASC, ID ASC'); $this->assertCount(2, $oldA1Blocks); $this->assertEquals('A1 Block 1 changed', $oldA1Blocks->first()->Title); $this->assertEquals('A1 Block 2 changed', $oldA1Blocks->last()->Title); $this->assertCount(1, $oldA1Blocks->first()->Galleries()); $this->assertEquals('Gallery 1 on Block 1 on A1', $oldA1Blocks->first()->Galleries()->first()->Title); $oldA1 = $a1->getAtSnapshot($stamp3); $oldA1Blocks = $oldA1->Blocks()->sort('Created ASC, ID ASC'); $this->assertCount(2, $oldA1Blocks); $this->assertEquals('A1 Block 1 changed again', $oldA1Blocks->first()->Title); $this->assertEquals('A1 Block 2 changed', $oldA1Blocks->last()->Title); $this->assertCount(1, $oldA1Blocks->first()->Galleries()); $this->assertEquals('Gallery 1 on Block 1 on A1', $oldA1Blocks->first()->Galleries()->first()->Title); $oldA1 = $a1->getAtSnapshot($stamp4); $oldA1Blocks = $oldA1->Blocks()->sort('Created ASC, ID ASC'); $this->assertCount(2, $oldA1Blocks); $this->assertEquals('A1 Block 1 changed again', $oldA1Blocks->first()->Title); $this->assertEquals('A1 Block 2 changed', $oldA1Blocks->last()->Title); $this->assertCount(1, $oldA1Blocks->first()->Galleries()); $this->assertEquals('new-gallery title', $oldA1Blocks->first()->Galleries()->first()->Title); // Get A2 before its title was changed $this->assertEquals('The new A2', $a2->Title); $oldA2 = $a2->getAtSnapshot($stamp5); $this->assertEquals('A2 Block Page', $oldA2->Title); // Get A2 before its second block was added $this->assertCount(2, $a2->Blocks()); $oldA2 = $a2->getAtSnapshot($stamp4); $this->assertCount(1, $oldA2->Blocks()); } public function testWonkyOwner() { $page = new BlockPage(['Title' => 'The Page']); $this->editingPage($page); $this->formSaveObject($page); $this->formPublishObject($page); // This block is saved in isolation $this->editingPage(null); $block = new Block(['Title' => 'The Block', 'ParentID' => 0]); $block->write(); $block->ParentID = $page->ID; $this->editingPage($page); $this->formSaveObject($block); $activity = $page->getActivityFeed(); $this->assertCount(1, $activity); $this->assertActivityContains( $activity, [ [$block, ActivityEntry::MODIFIED] ] ); } public function testChangeToUnpublishedOwner() { $page = new BlockPage(['Title' => 'The Page']); $this->editingPage($page); $this->formSaveObject($page); $this->editingPage(null); $block = new Block(['Title' => 'The Block']); $block->write(); $this->editingPage($page); $block->ParentID = $page->ID; $this->formSaveObject($block); $activity = $page->getActivityFeed(); $this->assertCount(2, $activity); $this->assertActivityContains( $activity, [ [$page, ActivityEntry::CREATED], [$block, ActivityEntry::MODIFIED] ] ); } public function testMany() { $p = new BlockPage(['Title' => 'The Page']); $this->editingPage($p); $this->formSaveObject($p); $b = new Block(['Title' => 'The Block on The Page', 'ParentID' => $p->ID]); $this->formSaveObject($b); $g = new Gallery(['Title' => 'The Gallery on The Block on The Page', 'BlockID' => $b->ID]); $this->formSaveObject($g); $this->formPublishObject($p); $this->assertFalse($p->hasOwnedModifications()); $this->assertCount(0, $p->getActivityFeed()); $this->assertCount(0, $p->getPublishableObjects()); $i = new GalleryImage(['URL' => '/gallery/image/1']); $this->formSaveRelations($g, 'Images', [$i]); $activity = $p->getActivityFeed(); $this->assertCount(2, $activity); $this->assertActivityContains( $activity, [ [$i, ActivityEntry::ADDED, $g], [ImplicitModification::singleton(), null] ] ); } public function testPlainActivityFeed() { $page = new BlockPage(); $this->editingPage($page); $page->Title = 'The Page -- version 1'; $this->formSaveObject($page); $page->Title = 'The Page -- version 2'; $this->formSaveObject($page); $page->Title = 'The Page -- version 3'; $this->formSaveObject($page); $activity = $page->getActivityFeed(); $this->assertCount(3, $activity); $this->assertCount(1, $page->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$page, ActivityEntry::CREATED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::MODIFIED], ] ); $versionedActivity = $page->getActivityFeed(1); $this->assertCount(3, $versionedActivity); $this->assertActivityContains( $versionedActivity, [ [$page, ActivityEntry::CREATED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::MODIFIED], ] ); $this->formPublishObject($page); $activity = $page->getActivityFeed(); $this->assertCount(0, $activity); $this->assertCount(0, $page->getPublishableObjects()); $versionedActivity = $page->getActivityFeed(1); $this->assertCount(4, $versionedActivity); $this->assertActivityContains( $versionedActivity, [ [$page, ActivityEntry::CREATED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::PUBLISHED], ] ); $page->Title = 'The Page -- version 5'; $this->formSaveObject($page); $page->Title = 'The Page -- version 6'; $this->formSaveObject($page); $activity = $page->getActivityFeed(); $this->assertCount(2, $activity); $this->assertCount(1, $page->getPublishableObjects()); $this->assertActivityContains( $activity, [ [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::MODIFIED], ] ); $versionedActivity = $page->getActivityFeed(1); $this->assertCount(6, $versionedActivity); $this->assertActivityContains( $versionedActivity, [ [$page, ActivityEntry::CREATED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::PUBLISHED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::MODIFIED] ] ); $versionedActivity = $page->getActivityFeed(3, 5); $this->assertCount(3, $versionedActivity); $this->assertActivityContains( $versionedActivity, [ [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::PUBLISHED], [$page, ActivityEntry::MODIFIED], ] ); $this->formPublishObject($page); $versionedActivity = $page->getActivityFeed(3); $this->assertCount(5, $versionedActivity); $this->assertActivityContains( $versionedActivity, [ [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::PUBLISHED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::MODIFIED], [$page, ActivityEntry::PUBLISHED], ] ); } public function testNestedActivityFeed() { $p = new BlockPage(['Title' => 'Page -- v01']); $this->editingPage($p); $this->formSaveObject($p); $b = new Block(['Title' => 'Block -- v01', 'ParentID' => $p->ID]); $this->formSaveObject($b); $g = new Gallery(['Title' => 'Gallery -- v01', 'BlockID' => $b->ID]); $this->formSaveObject($g); $this->formPublishObject($p); $this->assertFalse($p->hasOwnedModifications()); $this->assertCount(0, $p->getActivityFeed()); $this->assertCount(0, $p->getPublishableObjects()); $i = new GalleryImage(['URL' => '/gallery/image/1']); $this->formSaveRelations($g, 'Images', [$i]); $activity = $p->getActivityFeed(); $this->assertCount(2, $activity); $this->assertActivityContains( $activity, [ [$i, ActivityEntry::ADDED, $g], [ImplicitModification::singleton(), null], ] ); $b->Title = 'Block -- v02'; $this->formSaveObject($b); $this->formPublishObject($p); $i->URL = '/gallery/image/2'; $this->formSaveObject($i); $activity = $p->getActivityFeed(); $this->assertCount(1, $activity); $this->assertActivityContains( $activity, [ [$i, ActivityEntry::MODIFIED] ] ); $this->formPublishObject($p); $a = $p->getActivityFeed(2); $this->assertCount(6, $a); $this->assertActivityContains($a, [ [$i, ActivityEntry::ADDED], [ImplicitModification::singleton(), null], [$b, ActivityEntry::MODIFIED], [$p, ActivityEntry::PUBLISHED], [$i, ActivityEntry::MODIFIED], [$p, ActivityEntry::PUBLISHED], ]); $a = $p->getActivityFeed(2, 4); $this->assertCount(6, $a); $this->assertActivityContains($a, [ [$i, ActivityEntry::ADDED, $g], [ImplicitModification::singleton(), null], [$b, ActivityEntry::MODIFIED], [$p, ActivityEntry::PUBLISHED], [$i, ActivityEntry::MODIFIED], [$p, ActivityEntry::PUBLISHED], ]); $a = $p->getActivityFeed(2, 3); $this->assertCount(5, $a); $this->assertActivityContains($a, [ [$i, ActivityEntry::ADDED, $g], [ImplicitModification::singleton(), null], [$b, ActivityEntry::MODIFIED], [$p, ActivityEntry::PUBLISHED], [$i, ActivityEntry::MODIFIED] ]); } /** * @param ArrayList $activity * @param array $objs */ private function assertActivityContains(ArrayList $activity, $objs = []) { foreach ($activity as $i => $entry) { /* @var DataObject|SnapshotPublishable $obj */ list ($obj, $action) = $objs[$i]; if ($obj instanceof SnapshotEvent) { continue; } $expectedHash = $obj->isInDB() ? SnapshotPublishable::hashObjectForSnapshot($obj) : SnapshotPublishable::hashForSnapshot($obj->ClassName, $obj->OldID); $this->assertEquals( $expectedHash, SnapshotPublishable::hashObjectForSnapshot($entry->Subject) ); $this->assertEquals($action, $entry->Action); } } /** * @param ArrayList $items * @param array $objs */ private function assertPublishableObjectsContains(ArrayList $items, $objs = []) { foreach ($items as $i => $dataObject) { if ($dataObject instanceof SnapshotEvent) { continue; } $obj= $objs[$i]; $expectedHash = $obj->isInDB() ? SnapshotPublishable::hashObjectForSnapshot($obj) : SnapshotPublishable::hashForSnapshot($obj->ClassName, $obj->OldID); $this->assertEquals( $expectedHash, SnapshotPublishable::hashObjectForSnapshot($dataObject) ); } } private function debugActivity($activity) { $list = []; foreach ($activity as $entry) { $list[] = sprintf( '[%s] %s #%s (%s)', $entry->Action, $entry->Subject->ClassName, $entry->Subject->ID, $entry->Subject->getTitle() ); } return implode("\n", $list); } private function debugPublishable($items) { $list = []; foreach ($items as $item) { $list[] = sprintf( '%s #%s (%s)', $item->ClassName, $item->ID, $item->getTitle() ); } return implode("\n", $list); } private function formSaveObject(DataObject $object) { $object->write(); $actionName = $object instanceof SiteTree ? 'save' : 'doSave'; $event = $this->createEvent($object, $actionName); $this->dispatch($event); $this->sleep(3); } private function formPublishObject(DataObject $object) { $object->write(); $object->publishRecursive(); $event = $this->createEvent($object, 'publish'); $this->dispatch($event); $this->sleep(3); } private function formUnpublishObject(DataObject $object) { $object->doUnpublish(); $event = $this->createEvent($object, 'unpublish'); $this->dispatch($event); $this->sleep(3); } private function formDeleteObject(DataObject $object) { $object->doArchive(); $event = $this->createEvent($object, 'doDelete'); $this->dispatch($event); $this->sleep(3); } /** * Relation saves need to be wrapped in NOW() increments because they rely on * timestamp driven history * @param DataObject $object * @param string $component * @param DataObject[] $items * @param string $type */ private function formSaveRelations(DataObject $object, $component, array $items, $type = ActivityEntry::ADDED) { $this->sleep(2); $method = $type === ActivityEntry::ADDED ? 'add' : 'remove'; foreach ($items as $item) { $object->$component()->$method($item); } $event = $this->createEvent($object, 'doSave'); $this->dispatch($event); $this->sleep(2); } private function dispatch(EventContextInterface $event) { Dispatcher::singleton()->trigger(Listener::EVENT_NAME, $event); } private function createEvent(DataObject $object, string $actionName): Event { if (!$this->currentPage) { return Event::create($actionName); } $form = Form::create( CMSPageEditController::singleton(), 'EditForm', FieldList::create(), FieldList::create() ); $form->loadDataFrom($object); $page = $this->currentPage->isInDB() ? DataObject::get_by_id(get_class($this->currentPage), $this->currentPage->ID) : $this->currentPage; return Event::create( $actionName, [ 'page' => $page, 'form' => $form, ] ); } private function editingPage(?DataObject $page = null) { $this->currentPage = $page; } } |