[5.x] Add ability to specify the queue connection on static:warm command#8634

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 16 commits into from
Jul 16, 2024
Merged

[5.x] Add ability to specify the queue connection on static:warm command #8634

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
8ef9dc8
Add ability to specify the queue connection on static:warm command
grantholle Aug 28, 2023
018e898
Update description
grantholle Aug 28, 2023
1a4af65
Fix code style
grantholle Aug 28, 2023
51a3286
run 'em
jasonvarga Aug 28, 2023
5c10b00
Add config option and additional command option for connection
grantholle Sep 7, 2023
9a619e0
Merge branch 'static-warm-queue-connection' of github.com:grantholle/…
grantholle Sep 7, 2023
b062c96
Add and fix warm tests
grantholle Sep 7, 2023
112a919
Merge branch '4.x' into pr/8634
duncanmcclean Dec 5, 2023
06c7ff1
Merge branch '5.x' into pr/8634
duncanmcclean May 13, 2024
9336646
Merge branch '5.x' into static-warm-queue-connection
jasonvarga Jul 16, 2024
61c614c
these have failed since we switched to component output. using these …
jasonvarga Jul 16, 2024
4aec8f2
nitpick
jasonvarga Jul 16, 2024
e9732c0
get rid of ability to specify connection. if you add the queue flag, …
jasonvarga Jul 16, 2024
f68da4f
prefix config with warm_ for consistency. add env var. group together.
jasonvarga Jul 16, 2024
c3646cb
include queue in test
jasonvarga Jul 16, 2024
45b429f
wip
jasonvarga Jul 16, 2024
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
8 changes: 5 additions & 3 deletions config/static_caching.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,14 @@
| Warm Queue
|--------------------------------------------------------------------------
|
| Here you may define the name of the queue that requests will be pushed
| onto when warming the static cache using the static:warm command.
| Here you may define the queue name and connection
| that will be used when warming the static cache.
|
*/

'warm_queue' => null,
'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),

'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),

/*
|--------------------------------------------------------------------------
Expand Down
8 changes: 6 additions & 2 deletions src/Console/Commands/StaticWarm.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ class StaticWarm extends Command
protected $description = 'Warms the static cache by visiting all URLs';

protected $shouldQueue = false;
protected $queueConnection;

private $uris;

Expand All@@ -53,8 +54,9 @@ public function handle()
}

$this->shouldQueue = $this->option('queue');
$this->queueConnection = config('statamic.static_caching.warm_queue_connection') ?? config('queue.default');

if ($this->shouldQueue && config('queue.default') === 'sync') {
if ($this->shouldQueue && $this->queueConnection === 'sync') {
$this->components->error('The queue connection is set to "sync". Queueing will be disabled.');
$this->shouldQueue = false;
}
Expand DownExpand Up@@ -88,7 +90,9 @@ private function warm(): void
$this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));

foreach ($requests as $request) {
StaticWarmJob::dispatch($request, $this->clientConfig())->onQueue($queue);
StaticWarmJob::dispatch($request, $this->clientConfig())
->onConnection($this->queueConnection)
->onQueue($queue);
}
} else {
$this->line('Visiting '.count($requests).' URLs...');
Expand Down
45 changes: 38 additions & 7 deletions tests/Console/Commands/StaticWarmTest.php
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -4,6 +4,7 @@

use Facades\Tests\Factories\EntryFactory;
use Illuminate\Support\Facades\Queue;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Console\Commands\StaticWarmJob;
use Statamic\Facades\Collection;
Expand All@@ -18,10 +19,6 @@ public function setUp(): void
{
parent::setUp();

// Temporarily skip because we get random failures.
// If you spam it_warms_the_static_cache, it'll eventually fail.
$this->markTestIncomplete();

$this->createPage('about');
$this->createPage('contact');
}
Expand All@@ -30,7 +27,7 @@ public function setUp(): void
public function it_exits_with_error_when_static_caching_is_disabled()
{
$this->artisan('statamic:static:warm')
->expectsOutput('Static caching is not enabled.')
->expectsOutputToContain('Static caching is not enabled.')
->assertExitCode(1);
}

Expand All@@ -50,7 +47,7 @@ public function it_doesnt_queue_the_requests_when_connection_is_set_to_sync()
config(['statamic.static_caching.strategy' => 'half']);

$this->artisan('statamic:static:warm', ['--queue' => true])
->expectsOutput('The queue connection is set to "sync". Queueing will be disabled.')
->expectsOutputToContain('The queue connection is set to "sync". Queueing will be disabled.')
->assertExitCode(0);
}

Expand All@@ -65,7 +62,7 @@ public function it_queues_the_requests()
Queue::fake();

$this->artisan('statamic:static:warm', ['--queue' => true])
->expectsOutput('Queueing 2 requests...')
->expectsOutputToContain('Adding 2 requests')
->assertExitCode(0);

Queue::assertPushed(StaticWarmJob::class, function ($job) {
Expand All@@ -76,6 +73,40 @@ public function it_queues_the_requests()
});
}

#[Test, DataProvider('queueConnectionsProvider')]
public function it_queues_the_requests_with_appropriate_queue_and_connection(
$configuredQueue,
$configuredConnection,
$defaultConnection,
$expectedJobQueue,
$expectedJobConnection
) {
config([
'statamic.static_caching.strategy' => 'half',
'statamic.static_caching.warm_queue' => $configuredQueue,
'statamic.static_caching.warm_queue_connection' => $configuredConnection,
'queue.default' => $defaultConnection,
]);

Queue::fake();

$this->artisan('statamic:static:warm', ['--queue' => true])
->expectsOutputToContain('Adding 2 requests')
->assertExitCode(0);

Queue::assertPushed(StaticWarmJob::class, fn ($job) => $job->connection === $expectedJobConnection && $job->queue === $expectedJobQueue);
}

public static function queueConnectionsProvider()
{
return [
[null, null, 'redis', null, 'redis'],
['warm', null, 'redis', 'warm', 'redis'],
[null, 'sqs', 'redis', null, 'sqs'],
['warm', 'sqs', 'redis', 'warm', 'sqs'],
];
}

private function createPage($slug, $attributes = [])
{
$this->makeCollection()->save();
Expand Down
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
[5.x] Add ability to specify the queue connection on static:warm command#8634

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 16 commits into

from

Jul 16, 2024
 Merged


[5.x] Add ability to specify the queue connection on static:warm command
#8634
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
8ef9dc8

Add ability to specify the queue connection on static:warm command


grantholle Aug 28, 2023
018e898

Update description


grantholle Aug 28, 2023
1a4af65

Fix code style


grantholle Aug 28, 2023
51a3286

run 'em


jasonvarga Aug 28, 2023
5c10b00

Add config option and additional command option for connection


grantholle Sep 7, 2023
9a619e0

Merge branch 'static-warm-queue-connection' of github.com:grantholle/…


grantholle Sep 7, 2023
b062c96

Add and fix warm tests


grantholle Sep 7, 2023
112a919

Merge branch '4.x' into pr/8634


duncanmcclean Dec 5, 2023
06c7ff1

Merge branch '5.x' into pr/8634


duncanmcclean May 13, 2024
9336646

Merge branch '5.x' into static-warm-queue-connection


jasonvarga Jul 16, 2024
61c614c

these have failed since we switched to component output. using these …


jasonvarga Jul 16, 2024
4aec8f2

nitpick


jasonvarga Jul 16, 2024
e9732c0

get rid of ability to specify connection. if you add the queue flag, …


jasonvarga Jul 16, 2024
f68da4f

prefix config with warm_ for consistency. add env var. group together.


jasonvarga Jul 16, 2024
c3646cb

include queue in test


jasonvarga Jul 16, 2024
45b429f

wip


jasonvarga Jul 16, 2024

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


8 changes: 5 additions & 3 deletions
config/static_caching.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,14 @@
 | Warm Queue
 |--------------------------------------------------------------------------
 |
 | Here you may define the name of the queue that requests will be pushed
 | onto when warming the static cache using the static:warm command.
 | Here you may define the queue name and connection
 | that will be used when warming the static cache.
 |
 */

 'warm_queue' => null,
 'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),

 'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),

 /*
 |--------------------------------------------------------------------------
Expand Down

8 changes: 6 additions & 2 deletions
src/Console/Commands/StaticWarm.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ class StaticWarm extends Command
 protected $description = 'Warms the static cache by visiting all URLs';

 protected $shouldQueue = false;
 protected $queueConnection;

 private $uris;

Expand All@@ -53,8 +54,9 @@ public function handle()
 }

 $this->shouldQueue = $this->option('queue');
 $this->queueConnection = config('statamic.static_caching.warm_queue_connection') ?? config('queue.default');

 if ($this->shouldQueue && config('queue.default') === 'sync') {
 if ($this->shouldQueue && $this->queueConnection === 'sync') {
 $this->components->error('The queue connection is set to "sync". Queueing will be disabled.');
 $this->shouldQueue = false;
 }
Expand DownExpand Up@@ -88,7 +90,9 @@ private function warm(): void
 $this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));

 foreach ($requests as $request) {
 StaticWarmJob::dispatch($request, $this->clientConfig())->onQueue($queue);
 StaticWarmJob::dispatch($request, $this->clientConfig())
 ->onConnection($this->queueConnection)
 ->onQueue($queue);
 }
 } else {
 $this->line('Visiting '.count($requests).' URLs...');
Expand Down

45 changes: 38 additions & 7 deletions
tests/Console/Commands/StaticWarmTest.php

View file


Open in desktop

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

use Facades\Tests\Factories\EntryFactory;
use Illuminate\Support\Facades\Queue;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Console\Commands\StaticWarmJob;
use Statamic\Facades\Collection;
Expand All@@ -18,10 +19,6 @@ public function setUp(): void
 {
 parent::setUp();

 // Temporarily skip because we get random failures.
 // If you spam it_warms_the_static_cache, it'll eventually fail.
 $this->markTestIncomplete();

 $this->createPage('about');
 $this->createPage('contact');
 }
Expand All@@ -30,7 +27,7 @@ public function setUp(): void
 public function it_exits_with_error_when_static_caching_is_disabled()
 {
 $this->artisan('statamic:static:warm')
 ->expectsOutput('Static caching is not enabled.')
 ->expectsOutputToContain('Static caching is not enabled.')
 ->assertExitCode(1);
 }

Expand All@@ -50,7 +47,7 @@ public function it_doesnt_queue_the_requests_when_connection_is_set_to_sync()
 config(['statamic.static_caching.strategy' => 'half']);

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('The queue connection is set to "sync". Queueing will be disabled.')
 ->expectsOutputToContain('The queue connection is set to "sync". Queueing will be disabled.')
 ->assertExitCode(0);
 }

Expand All@@ -65,7 +62,7 @@ public function it_queues_the_requests()
 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('Queueing 2 requests...')
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, function ($job) {
Expand All@@ -76,6 +73,40 @@ public function it_queues_the_requests()
 });
 }

 #[Test, DataProvider('queueConnectionsProvider')]
 public function it_queues_the_requests_with_appropriate_queue_and_connection(
 $configuredQueue,
 $configuredConnection,
 $defaultConnection,
 $expectedJobQueue,
 $expectedJobConnection
 ) {
 config([
 'statamic.static_caching.strategy' => 'half',
 'statamic.static_caching.warm_queue' => $configuredQueue,
 'statamic.static_caching.warm_queue_connection' => $configuredConnection,
 'queue.default' => $defaultConnection,
 ]);

 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, fn ($job) => $job->connection === $expectedJobConnection && $job->queue === $expectedJobQueue);
 }

 public static function queueConnectionsProvider()
 {
 return [
 [null, null, 'redis', null, 'redis'],
 ['warm', null, 'redis', 'warm', 'redis'],
 [null, 'sqs', 'redis', null, 'sqs'],
 ['warm', 'sqs', 'redis', 'warm', 'sqs'],
 ];
 }

 private function createPage($slug, $attributes = [])
 {
 $this->makeCollection()->save();
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[5.x] Add ability to specify the queue connection on static:warm command#8634

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 16 commits into

from

Jul 16, 2024
 Merged


[5.x] Add ability to specify the queue connection on static:warm command
#8634
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
8ef9dc8

Add ability to specify the queue connection on static:warm command


grantholle Aug 28, 2023
018e898

Update description


grantholle Aug 28, 2023
1a4af65

Fix code style


grantholle Aug 28, 2023
51a3286

run 'em


jasonvarga Aug 28, 2023
5c10b00

Add config option and additional command option for connection


grantholle Sep 7, 2023
9a619e0

Merge branch 'static-warm-queue-connection' of github.com:grantholle/…


grantholle Sep 7, 2023
b062c96

Add and fix warm tests


grantholle Sep 7, 2023
112a919

Merge branch '4.x' into pr/8634


duncanmcclean Dec 5, 2023
06c7ff1

Merge branch '5.x' into pr/8634


duncanmcclean May 13, 2024
9336646

Merge branch '5.x' into static-warm-queue-connection


jasonvarga Jul 16, 2024
61c614c

these have failed since we switched to component output. using these …


jasonvarga Jul 16, 2024
4aec8f2

nitpick


jasonvarga Jul 16, 2024
e9732c0

get rid of ability to specify connection. if you add the queue flag, …


jasonvarga Jul 16, 2024
f68da4f

prefix config with warm_ for consistency. add env var. group together.


jasonvarga Jul 16, 2024
c3646cb

include queue in test


jasonvarga Jul 16, 2024
45b429f

wip


jasonvarga Jul 16, 2024

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


8 changes: 5 additions & 3 deletions
config/static_caching.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,14 @@
 | Warm Queue
 |--------------------------------------------------------------------------
 |
 | Here you may define the name of the queue that requests will be pushed
 | onto when warming the static cache using the static:warm command.
 | Here you may define the queue name and connection
 | that will be used when warming the static cache.
 |
 */

 'warm_queue' => null,
 'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),

 'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),

 /*
 |--------------------------------------------------------------------------
Expand Down

8 changes: 6 additions & 2 deletions
src/Console/Commands/StaticWarm.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ class StaticWarm extends Command
 protected $description = 'Warms the static cache by visiting all URLs';

 protected $shouldQueue = false;
 protected $queueConnection;

 private $uris;

Expand All@@ -53,8 +54,9 @@ public function handle()
 }

 $this->shouldQueue = $this->option('queue');
 $this->queueConnection = config('statamic.static_caching.warm_queue_connection') ?? config('queue.default');

 if ($this->shouldQueue && config('queue.default') === 'sync') {
 if ($this->shouldQueue && $this->queueConnection === 'sync') {
 $this->components->error('The queue connection is set to "sync". Queueing will be disabled.');
 $this->shouldQueue = false;
 }
Expand DownExpand Up@@ -88,7 +90,9 @@ private function warm(): void
 $this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));

 foreach ($requests as $request) {
 StaticWarmJob::dispatch($request, $this->clientConfig())->onQueue($queue);
 StaticWarmJob::dispatch($request, $this->clientConfig())
 ->onConnection($this->queueConnection)
 ->onQueue($queue);
 }
 } else {
 $this->line('Visiting '.count($requests).' URLs...');
Expand Down

45 changes: 38 additions & 7 deletions
tests/Console/Commands/StaticWarmTest.php

View file


Open in desktop

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

use Facades\Tests\Factories\EntryFactory;
use Illuminate\Support\Facades\Queue;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Console\Commands\StaticWarmJob;
use Statamic\Facades\Collection;
Expand All@@ -18,10 +19,6 @@ public function setUp(): void
 {
 parent::setUp();

 // Temporarily skip because we get random failures.
 // If you spam it_warms_the_static_cache, it'll eventually fail.
 $this->markTestIncomplete();

 $this->createPage('about');
 $this->createPage('contact');
 }
Expand All@@ -30,7 +27,7 @@ public function setUp(): void
 public function it_exits_with_error_when_static_caching_is_disabled()
 {
 $this->artisan('statamic:static:warm')
 ->expectsOutput('Static caching is not enabled.')
 ->expectsOutputToContain('Static caching is not enabled.')
 ->assertExitCode(1);
 }

Expand All@@ -50,7 +47,7 @@ public function it_doesnt_queue_the_requests_when_connection_is_set_to_sync()
 config(['statamic.static_caching.strategy' => 'half']);

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('The queue connection is set to "sync". Queueing will be disabled.')
 ->expectsOutputToContain('The queue connection is set to "sync". Queueing will be disabled.')
 ->assertExitCode(0);
 }

Expand All@@ -65,7 +62,7 @@ public function it_queues_the_requests()
 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('Queueing 2 requests...')
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, function ($job) {
Expand All@@ -76,6 +73,40 @@ public function it_queues_the_requests()
 });
 }

 #[Test, DataProvider('queueConnectionsProvider')]
 public function it_queues_the_requests_with_appropriate_queue_and_connection(
 $configuredQueue,
 $configuredConnection,
 $defaultConnection,
 $expectedJobQueue,
 $expectedJobConnection
 ) {
 config([
 'statamic.static_caching.strategy' => 'half',
 'statamic.static_caching.warm_queue' => $configuredQueue,
 'statamic.static_caching.warm_queue_connection' => $configuredConnection,
 'queue.default' => $defaultConnection,
 ]);

 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, fn ($job) => $job->connection === $expectedJobConnection && $job->queue === $expectedJobQueue);
 }

 public static function queueConnectionsProvider()
 {
 return [
 [null, null, 'redis', null, 'redis'],
 ['warm', null, 'redis', 'warm', 'redis'],
 [null, 'sqs', 'redis', null, 'sqs'],
 ['warm', 'sqs', 'redis', 'warm', 'sqs'],
 ];
 }

 private function createPage($slug, $attributes = [])
 {
 $this->makeCollection()->save();
Expand Down

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

Skip to content
[5.x] Add ability to specify the queue connection on static:warm command#8634

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 16 commits into

from

Jul 16, 2024
 Merged


[5.x] Add ability to specify the queue connection on static:warm command
#8634
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
8ef9dc8

Add ability to specify the queue connection on static:warm command


grantholle Aug 28, 2023
018e898

Update description


grantholle Aug 28, 2023
1a4af65

Fix code style


grantholle Aug 28, 2023
51a3286

run 'em


jasonvarga Aug 28, 2023
5c10b00

Add config option and additional command option for connection


grantholle Sep 7, 2023
9a619e0

Merge branch 'static-warm-queue-connection' of github.com:grantholle/…


grantholle Sep 7, 2023
b062c96

Add and fix warm tests


grantholle Sep 7, 2023
112a919

Merge branch '4.x' into pr/8634


duncanmcclean Dec 5, 2023
06c7ff1

Merge branch '5.x' into pr/8634


duncanmcclean May 13, 2024
9336646

Merge branch '5.x' into static-warm-queue-connection


jasonvarga Jul 16, 2024
61c614c

these have failed since we switched to component output. using these …


jasonvarga Jul 16, 2024
4aec8f2

nitpick


jasonvarga Jul 16, 2024
e9732c0

get rid of ability to specify connection. if you add the queue flag, …


jasonvarga Jul 16, 2024
f68da4f

prefix config with warm_ for consistency. add env var. group together.


jasonvarga Jul 16, 2024
c3646cb

include queue in test


jasonvarga Jul 16, 2024
45b429f

wip


jasonvarga Jul 16, 2024

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


8 changes: 5 additions & 3 deletions
config/static_caching.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,14 @@
 | Warm Queue
 |--------------------------------------------------------------------------
 |
 | Here you may define the name of the queue that requests will be pushed
 | onto when warming the static cache using the static:warm command.
 | Here you may define the queue name and connection
 | that will be used when warming the static cache.
 |
 */

 'warm_queue' => null,
 'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),

 'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),

 /*
 |--------------------------------------------------------------------------
Expand Down

8 changes: 6 additions & 2 deletions
src/Console/Commands/StaticWarm.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ class StaticWarm extends Command
 protected $description = 'Warms the static cache by visiting all URLs';

 protected $shouldQueue = false;
 protected $queueConnection;

 private $uris;

Expand All@@ -53,8 +54,9 @@ public function handle()
 }

 $this->shouldQueue = $this->option('queue');
 $this->queueConnection = config('statamic.static_caching.warm_queue_connection') ?? config('queue.default');

 if ($this->shouldQueue && config('queue.default') === 'sync') {
 if ($this->shouldQueue && $this->queueConnection === 'sync') {
 $this->components->error('The queue connection is set to "sync". Queueing will be disabled.');
 $this->shouldQueue = false;
 }
Expand DownExpand Up@@ -88,7 +90,9 @@ private function warm(): void
 $this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));

 foreach ($requests as $request) {
 StaticWarmJob::dispatch($request, $this->clientConfig())->onQueue($queue);
 StaticWarmJob::dispatch($request, $this->clientConfig())
 ->onConnection($this->queueConnection)
 ->onQueue($queue);
 }
 } else {
 $this->line('Visiting '.count($requests).' URLs...');
Expand Down

45 changes: 38 additions & 7 deletions
tests/Console/Commands/StaticWarmTest.php

View file


Open in desktop

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

use Facades\Tests\Factories\EntryFactory;
use Illuminate\Support\Facades\Queue;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Console\Commands\StaticWarmJob;
use Statamic\Facades\Collection;
Expand All@@ -18,10 +19,6 @@ public function setUp(): void
 {
 parent::setUp();

 // Temporarily skip because we get random failures.
 // If you spam it_warms_the_static_cache, it'll eventually fail.
 $this->markTestIncomplete();

 $this->createPage('about');
 $this->createPage('contact');
 }
Expand All@@ -30,7 +27,7 @@ public function setUp(): void
 public function it_exits_with_error_when_static_caching_is_disabled()
 {
 $this->artisan('statamic:static:warm')
 ->expectsOutput('Static caching is not enabled.')
 ->expectsOutputToContain('Static caching is not enabled.')
 ->assertExitCode(1);
 }

Expand All@@ -50,7 +47,7 @@ public function it_doesnt_queue_the_requests_when_connection_is_set_to_sync()
 config(['statamic.static_caching.strategy' => 'half']);

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('The queue connection is set to "sync". Queueing will be disabled.')
 ->expectsOutputToContain('The queue connection is set to "sync". Queueing will be disabled.')
 ->assertExitCode(0);
 }

Expand All@@ -65,7 +62,7 @@ public function it_queues_the_requests()
 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('Queueing 2 requests...')
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, function ($job) {
Expand All@@ -76,6 +73,40 @@ public function it_queues_the_requests()
 });
 }

 #[Test, DataProvider('queueConnectionsProvider')]
 public function it_queues_the_requests_with_appropriate_queue_and_connection(
 $configuredQueue,
 $configuredConnection,
 $defaultConnection,
 $expectedJobQueue,
 $expectedJobConnection
 ) {
 config([
 'statamic.static_caching.strategy' => 'half',
 'statamic.static_caching.warm_queue' => $configuredQueue,
 'statamic.static_caching.warm_queue_connection' => $configuredConnection,
 'queue.default' => $defaultConnection,
 ]);

 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, fn ($job) => $job->connection === $expectedJobConnection && $job->queue === $expectedJobQueue);
 }

 public static function queueConnectionsProvider()
 {
 return [
 [null, null, 'redis', null, 'redis'],
 ['warm', null, 'redis', 'warm', 'redis'],
 [null, 'sqs', 'redis', null, 'sqs'],
 ['warm', 'sqs', 'redis', 'warm', 'sqs'],
 ];
 }

 private function createPage($slug, $attributes = [])
 {
 $this->makeCollection()->save();
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
[5.x] Add ability to specify the queue connection on static:warm command#8634

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 16 commits into

from

Jul 16, 2024
 Merged


[5.x] Add ability to specify the queue connection on static:warm command
#8634
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
8ef9dc8

Add ability to specify the queue connection on static:warm command


grantholle Aug 28, 2023
018e898

Update description


grantholle Aug 28, 2023
1a4af65

Fix code style


grantholle Aug 28, 2023
51a3286

run 'em


jasonvarga Aug 28, 2023
5c10b00

Add config option and additional command option for connection


grantholle Sep 7, 2023
9a619e0

Merge branch 'static-warm-queue-connection' of github.com:grantholle/…


grantholle Sep 7, 2023
b062c96

Add and fix warm tests


grantholle Sep 7, 2023
112a919

Merge branch '4.x' into pr/8634


duncanmcclean Dec 5, 2023
06c7ff1

Merge branch '5.x' into pr/8634


duncanmcclean May 13, 2024
9336646

Merge branch '5.x' into static-warm-queue-connection


jasonvarga Jul 16, 2024
61c614c

these have failed since we switched to component output. using these …


jasonvarga Jul 16, 2024
4aec8f2

nitpick


jasonvarga Jul 16, 2024
e9732c0

get rid of ability to specify connection. if you add the queue flag, …


jasonvarga Jul 16, 2024
f68da4f

prefix config with warm_ for consistency. add env var. group together.


jasonvarga Jul 16, 2024
c3646cb

include queue in test


jasonvarga Jul 16, 2024
45b429f

wip


jasonvarga Jul 16, 2024

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


8 changes: 5 additions & 3 deletions
config/static_caching.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,14 @@
 | Warm Queue
 |--------------------------------------------------------------------------
 |
 | Here you may define the name of the queue that requests will be pushed
 | onto when warming the static cache using the static:warm command.
 | Here you may define the queue name and connection
 | that will be used when warming the static cache.
 |
 */

 'warm_queue' => null,
 'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),

 'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),

 /*
 |--------------------------------------------------------------------------
Expand Down

8 changes: 6 additions & 2 deletions
src/Console/Commands/StaticWarm.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ class StaticWarm extends Command
 protected $description = 'Warms the static cache by visiting all URLs';

 protected $shouldQueue = false;
 protected $queueConnection;

 private $uris;

Expand All@@ -53,8 +54,9 @@ public function handle()
 }

 $this->shouldQueue = $this->option('queue');
 $this->queueConnection = config('statamic.static_caching.warm_queue_connection') ?? config('queue.default');

 if ($this->shouldQueue && config('queue.default') === 'sync') {
 if ($this->shouldQueue && $this->queueConnection === 'sync') {
 $this->components->error('The queue connection is set to "sync". Queueing will be disabled.');
 $this->shouldQueue = false;
 }
Expand DownExpand Up@@ -88,7 +90,9 @@ private function warm(): void
 $this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));

 foreach ($requests as $request) {
 StaticWarmJob::dispatch($request, $this->clientConfig())->onQueue($queue);
 StaticWarmJob::dispatch($request, $this->clientConfig())
 ->onConnection($this->queueConnection)
 ->onQueue($queue);
 }
 } else {
 $this->line('Visiting '.count($requests).' URLs...');
Expand Down

45 changes: 38 additions & 7 deletions
tests/Console/Commands/StaticWarmTest.php

View file


Open in desktop

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

use Facades\Tests\Factories\EntryFactory;
use Illuminate\Support\Facades\Queue;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Console\Commands\StaticWarmJob;
use Statamic\Facades\Collection;
Expand All@@ -18,10 +19,6 @@ public function setUp(): void
 {
 parent::setUp();

 // Temporarily skip because we get random failures.
 // If you spam it_warms_the_static_cache, it'll eventually fail.
 $this->markTestIncomplete();

 $this->createPage('about');
 $this->createPage('contact');
 }
Expand All@@ -30,7 +27,7 @@ public function setUp(): void
 public function it_exits_with_error_when_static_caching_is_disabled()
 {
 $this->artisan('statamic:static:warm')
 ->expectsOutput('Static caching is not enabled.')
 ->expectsOutputToContain('Static caching is not enabled.')
 ->assertExitCode(1);
 }

Expand All@@ -50,7 +47,7 @@ public function it_doesnt_queue_the_requests_when_connection_is_set_to_sync()
 config(['statamic.static_caching.strategy' => 'half']);

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('The queue connection is set to "sync". Queueing will be disabled.')
 ->expectsOutputToContain('The queue connection is set to "sync". Queueing will be disabled.')
 ->assertExitCode(0);
 }

Expand All@@ -65,7 +62,7 @@ public function it_queues_the_requests()
 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('Queueing 2 requests...')
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, function ($job) {
Expand All@@ -76,6 +73,40 @@ public function it_queues_the_requests()
 });
 }

 #[Test, DataProvider('queueConnectionsProvider')]
 public function it_queues_the_requests_with_appropriate_queue_and_connection(
 $configuredQueue,
 $configuredConnection,
 $defaultConnection,
 $expectedJobQueue,
 $expectedJobConnection
 ) {
 config([
 'statamic.static_caching.strategy' => 'half',
 'statamic.static_caching.warm_queue' => $configuredQueue,
 'statamic.static_caching.warm_queue_connection' => $configuredConnection,
 'queue.default' => $defaultConnection,
 ]);

 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, fn ($job) => $job->connection === $expectedJobConnection && $job->queue === $expectedJobQueue);
 }

 public static function queueConnectionsProvider()
 {
 return [
 [null, null, 'redis', null, 'redis'],
 ['warm', null, 'redis', 'warm', 'redis'],
 [null, 'sqs', 'redis', null, 'sqs'],
 ['warm', 'sqs', 'redis', 'warm', 'sqs'],
 ];
 }

 private function createPage($slug, $attributes = [])
 {
 $this->makeCollection()->save();
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[5.x] Add ability to specify the queue connection on static:warm command#8634

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 16 commits into

from

Jul 16, 2024
 Merged


[5.x] Add ability to specify the queue connection on static:warm command
#8634
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
8ef9dc8

Add ability to specify the queue connection on static:warm command


grantholle Aug 28, 2023
018e898

Update description


grantholle Aug 28, 2023
1a4af65

Fix code style


grantholle Aug 28, 2023
51a3286

run 'em


jasonvarga Aug 28, 2023
5c10b00

Add config option and additional command option for connection


grantholle Sep 7, 2023
9a619e0

Merge branch 'static-warm-queue-connection' of github.com:grantholle/…


grantholle Sep 7, 2023
b062c96

Add and fix warm tests


grantholle Sep 7, 2023
112a919

Merge branch '4.x' into pr/8634


duncanmcclean Dec 5, 2023
06c7ff1

Merge branch '5.x' into pr/8634


duncanmcclean May 13, 2024
9336646

Merge branch '5.x' into static-warm-queue-connection


jasonvarga Jul 16, 2024
61c614c

these have failed since we switched to component output. using these …


jasonvarga Jul 16, 2024
4aec8f2

nitpick


jasonvarga Jul 16, 2024
e9732c0

get rid of ability to specify connection. if you add the queue flag, …


jasonvarga Jul 16, 2024
f68da4f

prefix config with warm_ for consistency. add env var. group together.


jasonvarga Jul 16, 2024
c3646cb

include queue in test


jasonvarga Jul 16, 2024
45b429f

wip


jasonvarga Jul 16, 2024

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


8 changes: 5 additions & 3 deletions
config/static_caching.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,14 @@
 | Warm Queue
 |--------------------------------------------------------------------------
 |
 | Here you may define the name of the queue that requests will be pushed
 | onto when warming the static cache using the static:warm command.
 | Here you may define the queue name and connection
 | that will be used when warming the static cache.
 |
 */

 'warm_queue' => null,
 'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),

 'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),

 /*
 |--------------------------------------------------------------------------
Expand Down

8 changes: 6 additions & 2 deletions
src/Console/Commands/StaticWarm.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ class StaticWarm extends Command
 protected $description = 'Warms the static cache by visiting all URLs';

 protected $shouldQueue = false;
 protected $queueConnection;

 private $uris;

Expand All@@ -53,8 +54,9 @@ public function handle()
 }

 $this->shouldQueue = $this->option('queue');
 $this->queueConnection = config('statamic.static_caching.warm_queue_connection') ?? config('queue.default');

 if ($this->shouldQueue && config('queue.default') === 'sync') {
 if ($this->shouldQueue && $this->queueConnection === 'sync') {
 $this->components->error('The queue connection is set to "sync". Queueing will be disabled.');
 $this->shouldQueue = false;
 }
Expand DownExpand Up@@ -88,7 +90,9 @@ private function warm(): void
 $this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));

 foreach ($requests as $request) {
 StaticWarmJob::dispatch($request, $this->clientConfig())->onQueue($queue);
 StaticWarmJob::dispatch($request, $this->clientConfig())
 ->onConnection($this->queueConnection)
 ->onQueue($queue);
 }
 } else {
 $this->line('Visiting '.count($requests).' URLs...');
Expand Down

45 changes: 38 additions & 7 deletions
tests/Console/Commands/StaticWarmTest.php

View file


Open in desktop

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

use Facades\Tests\Factories\EntryFactory;
use Illuminate\Support\Facades\Queue;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Console\Commands\StaticWarmJob;
use Statamic\Facades\Collection;
Expand All@@ -18,10 +19,6 @@ public function setUp(): void
 {
 parent::setUp();

 // Temporarily skip because we get random failures.
 // If you spam it_warms_the_static_cache, it'll eventually fail.
 $this->markTestIncomplete();

 $this->createPage('about');
 $this->createPage('contact');
 }
Expand All@@ -30,7 +27,7 @@ public function setUp(): void
 public function it_exits_with_error_when_static_caching_is_disabled()
 {
 $this->artisan('statamic:static:warm')
 ->expectsOutput('Static caching is not enabled.')
 ->expectsOutputToContain('Static caching is not enabled.')
 ->assertExitCode(1);
 }

Expand All@@ -50,7 +47,7 @@ public function it_doesnt_queue_the_requests_when_connection_is_set_to_sync()
 config(['statamic.static_caching.strategy' => 'half']);

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('The queue connection is set to "sync". Queueing will be disabled.')
 ->expectsOutputToContain('The queue connection is set to "sync". Queueing will be disabled.')
 ->assertExitCode(0);
 }

Expand All@@ -65,7 +62,7 @@ public function it_queues_the_requests()
 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('Queueing 2 requests...')
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, function ($job) {
Expand All@@ -76,6 +73,40 @@ public function it_queues_the_requests()
 });
 }

 #[Test, DataProvider('queueConnectionsProvider')]
 public function it_queues_the_requests_with_appropriate_queue_and_connection(
 $configuredQueue,
 $configuredConnection,
 $defaultConnection,
 $expectedJobQueue,
 $expectedJobConnection
 ) {
 config([
 'statamic.static_caching.strategy' => 'half',
 'statamic.static_caching.warm_queue' => $configuredQueue,
 'statamic.static_caching.warm_queue_connection' => $configuredConnection,
 'queue.default' => $defaultConnection,
 ]);

 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, fn ($job) => $job->connection === $expectedJobConnection && $job->queue === $expectedJobQueue);
 }

 public static function queueConnectionsProvider()
 {
 return [
 [null, null, 'redis', null, 'redis'],
 ['warm', null, 'redis', 'warm', 'redis'],
 [null, 'sqs', 'redis', null, 'sqs'],
 ['warm', 'sqs', 'redis', 'warm', 'sqs'],
 ];
 }

 private function createPage($slug, $attributes = [])
 {
 $this->makeCollection()->save();
Expand Down

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
[5.x] Add ability to specify the queue connection on static:warm command#8634

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 16 commits into

from

Jul 16, 2024
 Merged


[5.x] Add ability to specify the queue connection on static:warm command
#8634
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
8ef9dc8

Add ability to specify the queue connection on static:warm command


grantholle Aug 28, 2023
018e898

Update description


grantholle Aug 28, 2023
1a4af65

Fix code style


grantholle Aug 28, 2023
51a3286

run 'em


jasonvarga Aug 28, 2023
5c10b00

Add config option and additional command option for connection


grantholle Sep 7, 2023
9a619e0

Merge branch 'static-warm-queue-connection' of github.com:grantholle/…


grantholle Sep 7, 2023
b062c96

Add and fix warm tests


grantholle Sep 7, 2023
112a919

Merge branch '4.x' into pr/8634


duncanmcclean Dec 5, 2023
06c7ff1

Merge branch '5.x' into pr/8634


duncanmcclean May 13, 2024
9336646

Merge branch '5.x' into static-warm-queue-connection


jasonvarga Jul 16, 2024
61c614c

these have failed since we switched to component output. using these …


jasonvarga Jul 16, 2024
4aec8f2

nitpick


jasonvarga Jul 16, 2024
e9732c0

get rid of ability to specify connection. if you add the queue flag, …


jasonvarga Jul 16, 2024
f68da4f

prefix config with warm_ for consistency. add env var. group together.


jasonvarga Jul 16, 2024
c3646cb

include queue in test


jasonvarga Jul 16, 2024
45b429f

wip


jasonvarga Jul 16, 2024

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


8 changes: 5 additions & 3 deletions
config/static_caching.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,14 @@
 | Warm Queue
 |--------------------------------------------------------------------------
 |
 | Here you may define the name of the queue that requests will be pushed
 | onto when warming the static cache using the static:warm command.
 | Here you may define the queue name and connection
 | that will be used when warming the static cache.
 |
 */

 'warm_queue' => null,
 'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),

 'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),

 /*
 |--------------------------------------------------------------------------
Expand Down

8 changes: 6 additions & 2 deletions
src/Console/Commands/StaticWarm.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ class StaticWarm extends Command
 protected $description = 'Warms the static cache by visiting all URLs';

 protected $shouldQueue = false;
 protected $queueConnection;

 private $uris;

Expand All@@ -53,8 +54,9 @@ public function handle()
 }

 $this->shouldQueue = $this->option('queue');
 $this->queueConnection = config('statamic.static_caching.warm_queue_connection') ?? config('queue.default');

 if ($this->shouldQueue && config('queue.default') === 'sync') {
 if ($this->shouldQueue && $this->queueConnection === 'sync') {
 $this->components->error('The queue connection is set to "sync". Queueing will be disabled.');
 $this->shouldQueue = false;
 }
Expand DownExpand Up@@ -88,7 +90,9 @@ private function warm(): void
 $this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));

 foreach ($requests as $request) {
 StaticWarmJob::dispatch($request, $this->clientConfig())->onQueue($queue);
 StaticWarmJob::dispatch($request, $this->clientConfig())
 ->onConnection($this->queueConnection)
 ->onQueue($queue);
 }
 } else {
 $this->line('Visiting '.count($requests).' URLs...');
Expand Down

45 changes: 38 additions & 7 deletions
tests/Console/Commands/StaticWarmTest.php

View file


Open in desktop

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

use Facades\Tests\Factories\EntryFactory;
use Illuminate\Support\Facades\Queue;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Console\Commands\StaticWarmJob;
use Statamic\Facades\Collection;
Expand All@@ -18,10 +19,6 @@ public function setUp(): void
 {
 parent::setUp();

 // Temporarily skip because we get random failures.
 // If you spam it_warms_the_static_cache, it'll eventually fail.
 $this->markTestIncomplete();

 $this->createPage('about');
 $this->createPage('contact');
 }
Expand All@@ -30,7 +27,7 @@ public function setUp(): void
 public function it_exits_with_error_when_static_caching_is_disabled()
 {
 $this->artisan('statamic:static:warm')
 ->expectsOutput('Static caching is not enabled.')
 ->expectsOutputToContain('Static caching is not enabled.')
 ->assertExitCode(1);
 }

Expand All@@ -50,7 +47,7 @@ public function it_doesnt_queue_the_requests_when_connection_is_set_to_sync()
 config(['statamic.static_caching.strategy' => 'half']);

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('The queue connection is set to "sync". Queueing will be disabled.')
 ->expectsOutputToContain('The queue connection is set to "sync". Queueing will be disabled.')
 ->assertExitCode(0);
 }

Expand All@@ -65,7 +62,7 @@ public function it_queues_the_requests()
 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('Queueing 2 requests...')
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, function ($job) {
Expand All@@ -76,6 +73,40 @@ public function it_queues_the_requests()
 });
 }

 #[Test, DataProvider('queueConnectionsProvider')]
 public function it_queues_the_requests_with_appropriate_queue_and_connection(
 $configuredQueue,
 $configuredConnection,
 $defaultConnection,
 $expectedJobQueue,
 $expectedJobConnection
 ) {
 config([
 'statamic.static_caching.strategy' => 'half',
 'statamic.static_caching.warm_queue' => $configuredQueue,
 'statamic.static_caching.warm_queue_connection' => $configuredConnection,
 'queue.default' => $defaultConnection,
 ]);

 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, fn ($job) => $job->connection === $expectedJobConnection && $job->queue === $expectedJobQueue);
 }

 public static function queueConnectionsProvider()
 {
 return [
 [null, null, 'redis', null, 'redis'],
 ['warm', null, 'redis', 'warm', 'redis'],
 [null, 'sqs', 'redis', null, 'sqs'],
 ['warm', 'sqs', 'redis', 'warm', 'sqs'],
 ];
 }

 private function createPage($slug, $attributes = [])
 {
 $this->makeCollection()->save();
Expand Down

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

Skip to content
[5.x] Add ability to specify the queue connection on static:warm command#8634

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 16 commits into

from

Jul 16, 2024
 Merged


[5.x] Add ability to specify the queue connection on static:warm command
#8634
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


16 commits


Select commit
Hold shift + click to select a range
8ef9dc8

Add ability to specify the queue connection on static:warm command


grantholle Aug 28, 2023
018e898

Update description


grantholle Aug 28, 2023
1a4af65

Fix code style


grantholle Aug 28, 2023
51a3286

run 'em


jasonvarga Aug 28, 2023
5c10b00

Add config option and additional command option for connection


grantholle Sep 7, 2023
9a619e0

Merge branch 'static-warm-queue-connection' of github.com:grantholle/…


grantholle Sep 7, 2023
b062c96

Add and fix warm tests


grantholle Sep 7, 2023
112a919

Merge branch '4.x' into pr/8634


duncanmcclean Dec 5, 2023
06c7ff1

Merge branch '5.x' into pr/8634


duncanmcclean May 13, 2024
9336646

Merge branch '5.x' into static-warm-queue-connection


jasonvarga Jul 16, 2024
61c614c

these have failed since we switched to component output. using these …


jasonvarga Jul 16, 2024
4aec8f2

nitpick


jasonvarga Jul 16, 2024
e9732c0

get rid of ability to specify connection. if you add the queue flag, …


jasonvarga Jul 16, 2024
f68da4f

prefix config with warm_ for consistency. add env var. group together.


jasonvarga Jul 16, 2024
c3646cb

include queue in test


jasonvarga Jul 16, 2024
45b429f

wip


jasonvarga Jul 16, 2024

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


8 changes: 5 additions & 3 deletions
config/static_caching.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -122,12 +122,14 @@
 | Warm Queue
 |--------------------------------------------------------------------------
 |
 | Here you may define the name of the queue that requests will be pushed
 | onto when warming the static cache using the static:warm command.
 | Here you may define the queue name and connection
 | that will be used when warming the static cache.
 |
 */

 'warm_queue' => null,
 'warm_queue' => env('STATAMIC_STATIC_WARM_QUEUE'),

 'warm_queue_connection' => env('STATAMIC_STATIC_WARM_QUEUE_CONNECTION'),

 /*
 |--------------------------------------------------------------------------
Expand Down

8 changes: 6 additions & 2 deletions
src/Console/Commands/StaticWarm.php

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -41,6 +41,7 @@ class StaticWarm extends Command
 protected $description = 'Warms the static cache by visiting all URLs';

 protected $shouldQueue = false;
 protected $queueConnection;

 private $uris;

Expand All@@ -53,8 +54,9 @@ public function handle()
 }

 $this->shouldQueue = $this->option('queue');
 $this->queueConnection = config('statamic.static_caching.warm_queue_connection') ?? config('queue.default');

 if ($this->shouldQueue && config('queue.default') === 'sync') {
 if ($this->shouldQueue && $this->queueConnection === 'sync') {
 $this->components->error('The queue connection is set to "sync". Queueing will be disabled.');
 $this->shouldQueue = false;
 }
Expand DownExpand Up@@ -88,7 +90,9 @@ private function warm(): void
 $this->line(sprintf('Adding %s requests onto %squeue...', count($requests), $queue ? $queue.' ' : ''));

 foreach ($requests as $request) {
 StaticWarmJob::dispatch($request, $this->clientConfig())->onQueue($queue);
 StaticWarmJob::dispatch($request, $this->clientConfig())
 ->onConnection($this->queueConnection)
 ->onQueue($queue);
 }
 } else {
 $this->line('Visiting '.count($requests).' URLs...');
Expand Down

45 changes: 38 additions & 7 deletions
tests/Console/Commands/StaticWarmTest.php

View file


Open in desktop

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

use Facades\Tests\Factories\EntryFactory;
use Illuminate\Support\Facades\Queue;
use PHPUnit\Framework\Attributes\DataProvider;
use PHPUnit\Framework\Attributes\Test;
use Statamic\Console\Commands\StaticWarmJob;
use Statamic\Facades\Collection;
Expand All@@ -18,10 +19,6 @@ public function setUp(): void
 {
 parent::setUp();

 // Temporarily skip because we get random failures.
 // If you spam it_warms_the_static_cache, it'll eventually fail.
 $this->markTestIncomplete();

 $this->createPage('about');
 $this->createPage('contact');
 }
Expand All@@ -30,7 +27,7 @@ public function setUp(): void
 public function it_exits_with_error_when_static_caching_is_disabled()
 {
 $this->artisan('statamic:static:warm')
 ->expectsOutput('Static caching is not enabled.')
 ->expectsOutputToContain('Static caching is not enabled.')
 ->assertExitCode(1);
 }

Expand All@@ -50,7 +47,7 @@ public function it_doesnt_queue_the_requests_when_connection_is_set_to_sync()
 config(['statamic.static_caching.strategy' => 'half']);

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('The queue connection is set to "sync". Queueing will be disabled.')
 ->expectsOutputToContain('The queue connection is set to "sync". Queueing will be disabled.')
 ->assertExitCode(0);
 }

Expand All@@ -65,7 +62,7 @@ public function it_queues_the_requests()
 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutput('Queueing 2 requests...')
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, function ($job) {
Expand All@@ -76,6 +73,40 @@ public function it_queues_the_requests()
 });
 }

 #[Test, DataProvider('queueConnectionsProvider')]
 public function it_queues_the_requests_with_appropriate_queue_and_connection(
 $configuredQueue,
 $configuredConnection,
 $defaultConnection,
 $expectedJobQueue,
 $expectedJobConnection
 ) {
 config([
 'statamic.static_caching.strategy' => 'half',
 'statamic.static_caching.warm_queue' => $configuredQueue,
 'statamic.static_caching.warm_queue_connection' => $configuredConnection,
 'queue.default' => $defaultConnection,
 ]);

 Queue::fake();

 $this->artisan('statamic:static:warm', ['--queue' => true])
 ->expectsOutputToContain('Adding 2 requests')
 ->assertExitCode(0);

 Queue::assertPushed(StaticWarmJob::class, fn ($job) => $job->connection === $expectedJobConnection && $job->queue === $expectedJobQueue);
 }

 public static function queueConnectionsProvider()
 {
 return [
 [null, null, 'redis', null, 'redis'],
 ['warm', null, 'redis', 'warm', 'redis'],
 [null, 'sqs', 'redis', null, 'sqs'],
 ['warm', 'sqs', 'redis', 'warm', 'sqs'],
 ];
 }

 private function createPage($slug, $attributes = [])
 {
 $this->makeCollection()->save();
Expand Down