@amazeelabs/silverback-gatsby 3.7.13

package/drupal/silverback_gatsby/tests/src/Kernel/GatsbyBuildTriggerTest.php

@@ -0,0 +1,155 @@
+<?php
+
+namespace Drupal\Tests\silverback_gatsby\Kernel;
+
+use Drupal\Core\Messenger\MessengerInterface;
+use Drupal\graphql\Entity\Server;
+use Drupal\KernelTests\KernelTestBase;
+use Drupal\Tests\silverback_gatsby\Traits\NotificationCheckTrait;
+use GuzzleHttp\Exception\RequestException;
+use GuzzleHttp\Psr7\Request;
+use Prophecy\Argument;
+
+/**
+ *
+ */
+class GatsbyBuildTriggerTest extends KernelTestBase {
+  use NotificationCheckTrait;
+
+  protected $strictConfigSchema = FALSE;
+
+  /**
+   * @var string[]
+   */
+  protected static $modules = [
+    'language',
+    'user',
+    'node',
+    'graphql',
+    'file',
+    'content_translation',
+    'graphql_directives',
+    'silverback_gatsby',
+    'silverback_gatsby_example',
+    'menu_link_content',
+    'path_alias',
+  ];
+
+  /**
+   * @var \Prophecy\Prophecy\ObjectProphecy
+   */
+  protected $messengerProphecy;
+
+  /**
+   * @var \Drupal\silverback_gatsby\GatsbyBuildTrigger
+   */
+  protected $trigger;
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() : void {
+    parent::setUp();
+    $this->setupClientProphecy();
+    $this->messengerProphecy = $this->prophesize(MessengerInterface::class);
+    $this->container->set('messenger', $this->messengerProphecy->reveal());
+
+    $this->installConfig('graphql');
+    $this->installConfig('graphql_directives');
+    $this->installSchema('silverback_gatsby', ['gatsby_update_log']);
+
+    $this->trigger = $this->container->get('silverback_gatsby.build_trigger');
+
+    $schemaDefinition = \Drupal::moduleHandler()->getModule('silverback_gatsby')->getPath()
+      . '/modules/silverback_gatsby_example/graphql/silverback_gatsby_example.graphqls';
+
+    Server::create([
+      'schema' => 'directable',
+      'name' => 'foo',
+      'endpoint' => '/foo',
+      'schema_configuration' => [
+        'directable' => [
+          'extensions' => [
+            'silverback_gatsby' => 'silverback_gatsby',
+          ],
+          'schema_definition' => $schemaDefinition,
+          'autoload_contexts' => 'drupal',
+          'build_webhook' => 'http://localhost:8000/__refresh',
+        ],
+      ],
+    ])->save();
+
+    Server::create([
+      'schema' => 'directable',
+      'name' => 'bar',
+      'endpoint' => '/bar',
+      'schema_configuration' => [
+        'directable' => [
+          'extensions' => [
+            'silverback_gatsby' => 'silverback_gatsby',
+          ],
+          'schema_definition' => $schemaDefinition,
+          'autoload_contexts' => 'drupal',
+          'build_webhook' => 'http://localhost:9000/__refresh',
+        ],
+      ],
+    ])->save();
+
+  }
+
+  /**
+   *
+   */
+  public function testBeforeShutdown() {
+    $this->trigger->trigger('foo', 1);
+    // If _drupal_shutdown_function() is not called, no notifications go out.
+    $this->checkTotalNotifications(0);
+  }
+
+  /**
+   *
+   */
+  public function testRequestException() {
+    $this->clientProphecy->post(Argument::any(), Argument::any())
+      ->willThrow(new RequestException('Invalid!', new Request('post', 'http://localhost:8000/__refresh')));
+    $this->trigger->trigger('foo', 1);
+    _drupal_shutdown_function();
+    $this->messengerProphecy->addError(Argument::any())->shouldHaveBeenCalledTimes(2);
+    $this->messengerProphecy->addError('Invalid!')->shouldHaveBeenCalledTimes(1);
+    $this->messengerProphecy->addError('Could not send build notification to server "http://localhost:8000/__refresh".')->shouldHaveBeenCalledTimes(1);
+  }
+
+  /**
+   *
+   */
+  public function testSingleTrigger() {
+    $this->trigger->trigger('foo', 1);
+    _drupal_shutdown_function();
+    $this->checkTotalNotifications(1);
+    $this->checkBuildNotification('http://localhost:8000/__refresh', 1);
+  }
+
+  /**
+   *
+   */
+  public function testMultipleTriggers() {
+    $this->trigger->trigger('foo', 1);
+    $this->trigger->trigger('foo', 2);
+    _drupal_shutdown_function();
+    $this->checkTotalNotifications(1);
+    $this->checkBuildNotification('http://localhost:8000/__refresh', 2);
+  }
+
+  /**
+   *
+   */
+  public function testMultipleServers() {
+    $this->trigger->trigger('foo', 1);
+    $this->trigger->trigger('bar', 2);
+    _drupal_shutdown_function();
+    $this->checkTotalNotifications(2);
+    $this->checkBuildNotification('http://localhost:8000/__refresh', 1);
+    $this->checkBuildNotification('http://localhost:9000/__refresh', 2);
+  }
+
+}

package/drupal/silverback_gatsby/tests/src/Kernel/GatsbyFeedInfoTest.php

@@ -0,0 +1,319 @@
+<?php
+
+namespace Drupal\Tests\silverback_gatsby\Kernel;
+
+use Drupal\node\Entity\Node;
+
+/**
+ *
+ */
+class GatsbyFeedInfoTest extends EntityFeedTestBase {
+
+  /**
+   *
+   */
+  protected function expectedFeedInfo($changes = []) {
+    return [
+      [
+        'typeName' => 'Page',
+        'translatable' => TRUE,
+        'singleFieldName' => '_loadPage',
+        'listFieldName' => '_queryPages',
+        'changes' => $changes['Page'] ?? [],
+        'pathFieldName' => 'path',
+        'templateFieldName' => NULL,
+
+      ],
+      [
+        'typeName' => 'Post',
+        'translatable' => FALSE,
+        'singleFieldName' => '_loadPost',
+        'listFieldName' => '_queryPosts',
+        'changes' => $changes['Post'] ?? [],
+        'pathFieldName' => 'path',
+        'templateFieldName' => 'template',
+      ],
+      [
+        'typeName' => 'MainMenu',
+        'translatable' => FALSE,
+        'singleFieldName' => '_loadMainMenu',
+        'listFieldName' => '_queryMainMenus',
+        'changes' => $changes['MainMenu'] ?? [],
+        'pathFieldName' => NULL,
+        'templateFieldName' => NULL,
+      ],
+      [
+        'typeName' => 'VisibleMainMenu',
+        'translatable' => FALSE,
+        'singleFieldName' => '_loadVisibleMainMenu',
+        'listFieldName' => '_queryVisibleMainMenus',
+        'changes' => $changes['VisibleMainMenu'] ?? [],
+        'pathFieldName' => NULL,
+        'templateFieldName' => NULL,
+      ],
+    ];
+  }
+
+  /**
+   *
+   */
+  public function testInitialFeed() {
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // When no build happened yet, the build ID is -1.
+      '_drupalBuildId' => -1,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+  }
+
+  /**
+   *
+   */
+  public function testInitialBuild() {
+    $node = Node::create([
+      'type' => 'page',
+      'title' => 'Test',
+      'status' => 0,
+    ]);
+    $node->save();
+
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 1,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+  }
+
+  /**
+   *
+   */
+  public function testInitialPublishedBuild() {
+    $node = Node::create([
+      'type' => 'page',
+      'title' => 'Test',
+    ]);
+    $node->save();
+
+    $this->useBuildServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 1,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+
+    $this->usePreviewServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 2,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+
+    $this->usePublicServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => -1,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+  }
+
+  /**
+   *
+   */
+  public function testMultipleBuilds() {
+    $tracker = $this->container->get('silverback_gatsby.update_tracker');
+    $node = Node::create([
+      'type' => 'page',
+      'title' => 'Test',
+      'status' => 0,
+    ]);
+    $node->save();
+    $tracker->clear();
+    $node->setTitle('Changed');
+    $node->save();
+    $tracker->clear();
+
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      '_drupalBuildId' => 2,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+  }
+
+  /**
+   *
+   */
+  public function testCurrentBuildArgument() {
+    $tracker = $this->container->get('silverback_gatsby.update_tracker');
+    $node = Node::create([
+      'type' => 'page',
+      'title' => 'Test',
+      'status' => 0,
+    ]);
+    $node->save();
+    $tracker->clear();
+    $node->setTitle('Changed');
+    $node->save();
+    $tracker->clear();
+
+    $post = Node::create([
+      'type' => 'blog',
+      'title' => 'Test',
+      'status' => 0,
+    ]);
+    $post->save();
+
+    $query = $this->getQueryFromFile('feed_info.gql');
+    // All changes since build 1. Edited page and created post.
+    $this->assertResults($query, [
+      'lastBuild' => 1,
+      'currentBuild' => 3,
+    ], [
+      '_drupalBuildId' => 3,
+      '_drupalFeedInfo' => $this->expectedFeedInfo([
+        'Page' => [$node->uuid() . ':en'],
+        'Post' => [$post->uuid()],
+      ]),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+
+    // Only the first change that edited the page.
+    $this->assertResults($query, [
+      'lastBuild' => 1,
+      'currentBuild' => 2,
+    ], [
+      '_drupalBuildId' => 3,
+      '_drupalFeedInfo' => $this->expectedFeedInfo([
+        'Page' => [$node->uuid() . ':en'],
+      ]),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+
+    // Only the last change that created a blog post.
+    $this->assertResults($query, [
+      'lastBuild' => 2,
+      'currentBuild' => 3,
+    ], [
+      '_drupalBuildId' => 3,
+      '_drupalFeedInfo' => $this->expectedFeedInfo([
+        'Post' => [$post->uuid()],
+      ]),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+  }
+
+  /**
+   *
+   */
+  public function testNodePublish() {
+    $tracker = $this->container->get('silverback_gatsby.update_tracker');
+    // Create one initial published node so both build and preview server have
+    // a build id we can diff against.
+    Node::create([
+      'type' => 'page',
+      'title' => 'Published',
+    ])->save();
+
+    // Create the second node that we are actually going to test.
+    $node = Node::create([
+      'type' => 'page',
+      'title' => 'Unpublished',
+      'status' => 0,
+    ]);
+    $node->save();
+
+    $tracker->clear();
+
+    // Preview server should be on build 3 (2 for the initial node on preview
+    // & build and 1 for the unpublished node on preview).
+    $this->usePreviewServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 3,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+
+    // Preview should be on build 1 which is the initial node.
+    $this->useBuildServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 1,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+
+    // Publish the unpublished node.
+    // We have to create a new revision, or we get the last cached access result.
+    $node->setTitle('Published');
+    $node->setPublished();
+    $node->save();
+
+    // Build server should be on build 5 now. The 3 from before plus 2 builds
+    // for preview and build. "2:en" is marked as a change to be fetched.
+    $this->useBuildServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [
+      'lastBuild' => 1,
+      'currentBuild' => 5,
+    ], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 5,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(['Page' => [$node->uuid() . ':en']]),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+  }
+
+  /**
+   *
+   */
+  public function testNodeUnpublish() {
+    // Create an initial published node.
+    $tracker = $this->container->get('silverback_gatsby.update_tracker');
+    $node = Node::create([
+      'type' => 'page',
+      'title' => 'Published',
+    ]);
+    $node->save();
+
+    $tracker->clear();
+
+    // Preview server is on build 2. 1 is for the build server.
+    $this->usePreviewServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 2,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+
+    // The build server is on build 1.
+    $this->useBuildServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 1,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+
+    // Unpublish the node.
+    // We have to create a new revision, or we get the last cached access result.
+    $node->setTitle('Unpublished');
+    $node->setUnpublished();
+    $node->save();
+
+    // Build server is on build 3, and '1:en' is marked as changed which will
+    // effectively delete it from the gatsby store since the fetch will return
+    // null.
+    $this->useBuildServer();
+    $query = $this->getQueryFromFile('feed_info.gql');
+    $this->assertResults($query, [
+      'lastBuild' => 1,
+      'currentBuild' => 3,
+    ], [
+      // It should indicate that there has been a first build.
+      '_drupalBuildId' => 3,
+      '_drupalFeedInfo' => $this->expectedFeedInfo(['Page' => [$node->uuid() . ':en']]),
+    ], $this->defaultCacheMetaData()->mergeCacheMaxAge(0));
+  }
+
+}

package/drupal/silverback_gatsby/tests/src/Kernel/GatsbyUpdateHandlerTest.php

@@ -0,0 +1,131 @@
+<?php
+
+namespace Drupal\Tests\silverback_gatsby\Kernel;
+
+use Drupal\Core\DependencyInjection\ContainerBuilder;
+use Drupal\node\Entity\Node;
+use Drupal\silverback_gatsby\GatsbyUpdate;
+use Drupal\silverback_gatsby\GatsbyUpdateTrigger;
+use Drupal\Tests\Traits\Core\PathAliasTestTrait;
+
+/**
+ *
+ */
+class GatsbyUpdateHandlerTest extends EntityFeedTestBase {
+
+  use PathAliasTestTrait;
+  protected static $modules = ['path_alias'];
+
+  /**
+   * @var \Drupal\silverback_gatsby\GatsbyUpdateTracker|object|null
+   */
+  protected $tracker;
+
+  /**
+   * @var \Prophecy\Prophecy\ObjectProphecy
+   */
+  protected $triggerProphecy;
+
+  /**
+   *
+   */
+  public function register(ContainerBuilder $container) {
+    parent::register($container);
+    $this->triggerProphecy = $this->prophesize(GatsbyUpdateTrigger::class);
+    $container->set('silverback_gatsby.update_trigger', $this->triggerProphecy->reveal());
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  protected function setUp() : void {
+    parent::setUp();
+    $this->installEntitySchema('path_alias');
+    $this->tracker = $this->container->get('silverback_gatsby.update_tracker');
+  }
+
+  /**
+   *
+   */
+  public function testLogRelevantChanges() {
+    $node = Node::create([
+      'type' => 'page',
+      'title' => 'Test',
+      'status' => 0,
+    ]);
+    $node->save();
+    $this->tracker->clear();
+
+    $node->addTranslation('de', [
+      'title' => 'Test DE',
+      'status' => 0,
+    ])->save();
+
+    $node->setTitle('Test 2');
+    $node->save();
+
+    $diff = $this->tracker->diff(1, 3, $this->server->id());
+    $this->assertEquals([
+      new GatsbyUpdate('Page', $node->uuid() . ':en'),
+      new GatsbyUpdate('Page', $node->uuid() . ':de'),
+    ], $diff);
+  }
+
+  /**
+   *
+   */
+  public function testIgnoreIrrelevantChanges() {
+    $node = Node::create([
+      'type' => 'article',
+      'title' => 'Test',
+      'status' => 0,
+    ]);
+    $node->save();
+    $node->setTitle('Test 2');
+    $node->save();
+
+    $diff = $this->tracker->diff(1, 2, $this->server->id());
+    $this->assertEmpty($diff);
+  }
+
+  /**
+   *
+   */
+  public function testTriggerUpdates() {
+    $page = Node::create([
+      'type' => 'page',
+      'title' => 'Test',
+      'status' => 0,
+    ]);
+    $page->save();
+
+    $article = Node::create([
+      'type' => 'article',
+      'title' => 'Test',
+      'status' => 0,
+    ]);
+    $article->save();
+
+    $this->triggerProphecy
+      ->trigger($this->server->id(), new GatsbyUpdate('Page', $page->uuid() . ':en'))->shouldHaveBeenCalledTimes(1);
+  }
+
+  /**
+   * Test case for testing the behavior when path alias triggers updates.
+   */
+  public function testPathAliasTriggerUpdates() {
+    $node = Node::create([
+      'type' => 'page',
+      'title' => 'Test',
+    ]);
+    $node->save();
+    $this->tracker->clear();
+    $this->createPathAlias('/node/1', '/test', 'en');
+    $this->tracker->clear();
+    // We expect two calls for the same page, as the path alias
+    // should also trigger a page build.
+    $this->triggerProphecy
+      ->trigger($this->server->id(), new GatsbyUpdate('Page', $node->uuid() . ':en'))->shouldHaveBeenCalledTimes(2);
+  }
+
+}