10 |
11 | # Laravel Haystack
12 | ⚡️ Supercharged job chains for Laravel
13 |
14 | 
15 |
16 | [Click here to read the documentation](https://docs.laravel-haystack.dev)
17 |
18 | 
94 |
95 | Thank you for using Laravel Haystack ❤️
96 |
--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "sammyjo20/laravel-haystack",
3 | "description": "Supercharged job chains for Laravel",
4 | "license": "MIT",
5 | "keywords": [
6 | "Sammyjo20",
7 | "laravel-haystack"
8 | ],
9 | "authors": [
10 | {
11 | "name": "Sammyjo20",
12 | "email": "29132017+Sammyjo20@users.noreply.github.com",
13 | "role": "Developer"
14 | }
15 | ],
16 | "homepage": "https://github.com/sammyjo20/laravel-haystack",
17 | "require": {
18 | "php": "^8.1",
19 | "illuminate/console": "^10.0 || ^11.7",
20 | "illuminate/contracts": "^10.0 || ^11.7",
21 | "illuminate/database": "^10.0 || ^v11.7",
22 | "illuminate/queue": "^10.0 || ^11.7",
23 | "illuminate/support": "^10.0 || ^11.7",
24 | "laravel/serializable-closure": "^1.2"
25 | },
26 | "require-dev": {
27 | "friendsofphp/php-cs-fixer": "^3.5",
28 | "orchestra/testbench": "^8.0 || ^9.0",
29 | "pestphp/pest": "^v2.34",
30 | "pestphp/pest-plugin-laravel": "^1.2 || ^2.0",
31 | "sammyjo20/laravel-chunkable-jobs": "^1.1",
32 | "spatie/laravel-ray": "^1.26"
33 | },
34 | "suggest": {
35 | "sammyjo20/laravel-chunkable-jobs": "Allows you to use the job chunking feature"
36 | },
37 | "minimum-stability": "stable",
38 | "autoload": {
39 | "psr-4": {
40 | "Sammyjo20\\LaravelHaystack\\": "src",
41 | "Sammyjo20\\LaravelHaystack\\Database\\Factories\\": "database/factories"
42 | }
43 | },
44 | "autoload-dev": {
45 | "psr-4": {
46 | "Sammyjo20\\LaravelHaystack\\Tests\\": "tests"
47 | }
48 | },
49 | "config": {
50 | "allow-plugins": {
51 | "pestphp/pest-plugin": true
52 | },
53 | "sort-packages": true
54 | },
55 | "extra": {
56 | "laravel": {
57 | "providers": [
58 | "Sammyjo20\\LaravelHaystack\\HaystackServiceProvider"
59 | ]
60 | }
61 | },
62 | "scripts": {
63 | "post-autoload-dump": [
64 | "@php ./vendor/bin/testbench package:discover --ansi"
65 | ],
66 | "fix-code": [
67 | "./vendor/bin/php-cs-fixer fix --allow-risky=yes"
68 | ],
69 | "pstan": [
70 | "./vendor/bin/phpstan analyse"
71 | ],
72 | "test": [
73 | "./vendor/bin/pest"
74 | ]
75 | }
76 | }
77 |
--------------------------------------------------------------------------------
/config/haystack.php:
--------------------------------------------------------------------------------
1 | true,
19 |
20 | /*
21 | |--------------------------------------------------------------------------
22 | | Queue Haystack Jobs Automatically
23 | |--------------------------------------------------------------------------
24 | |
25 | | This value if set to true, will instruct Laravel Haystack to listen
26 | | out for "Stackable" jobs and automatically queue them after each
27 | | job is processed. If this value is set to false, you will need
28 | | to call "$this->nextJob" inside your jobs manually.
29 | |
30 | */
31 |
32 | 'process_automatically' => true,
33 |
34 | /*
35 | |--------------------------------------------------------------------------
36 | | Stale Haystacks
37 | |--------------------------------------------------------------------------
38 | |
39 | | This value determines how long "stale" haystacks are kept for. These are
40 | | haystacks where the job that controlled them has failed without sending
41 | | the failure signal to laravel-haystack. This shouldn't happen if auto
42 | | processing has been turned on.
43 | |
44 | */
45 |
46 | 'keep_stale_haystacks_for_days' => 3,
47 |
48 | /*
49 | |--------------------------------------------------------------------------
50 | | Delete Finished Haystacks
51 | |--------------------------------------------------------------------------
52 | |
53 | | This value determines if laravel-haystack should automatically delete
54 | | haystacks when they have finished processing. If this value is set
55 | | to false, make sure to use the scheduled command to clean up
56 | | old finished haystacks.
57 | |
58 | */
59 |
60 | 'delete_finished_haystacks' => true,
61 |
62 | /*
63 | |--------------------------------------------------------------------------
64 | | Keep Finished Haystacks For Days
65 | |--------------------------------------------------------------------------
66 | |
67 | | This value determines how long finished haystacks will be retained for
68 | | this is only applicable if "deleted_finished_haystacks" has been disabled.
69 | |
70 | */
71 |
72 | 'keep_finished_haystacks_for_days' => 1,
73 |
74 | /*
75 | |--------------------------------------------------------------------------
76 | | Default Database Connection Name
77 | |--------------------------------------------------------------------------
78 | |
79 | | Here you may specify which database connection you
80 | | use to store haystack jobs.
81 | |
82 | */
83 |
84 | 'db_connection' => env(
85 | 'HAYSTACK_DB_CONNECTION',
86 | env('DB_CONNECTION', 'mysql')
87 | ),
88 | ];
89 |
--------------------------------------------------------------------------------
/database/factories/HaystackBaleFactory.php:
--------------------------------------------------------------------------------
1 | new HaystackOptions,
24 | ];
25 | }
26 | }
27 |
--------------------------------------------------------------------------------
/database/migrations/create_haystack_bales_table.php.stub:
--------------------------------------------------------------------------------
1 | id();
14 | $table->timestamps();
15 | $table->foreignIdFor(Haystack::class)->constrained()->cascadeOnDelete();
16 | $table->mediumText('job');
17 | $table->bigInteger('delay')->default(0);
18 | $table->string('on_queue')->nullable();
19 | $table->string('on_connection')->nullable();
20 | $table->integer('attempts')->default(0);
21 | $table->integer('retry_until')->nullable();
22 | $table->boolean('priority')->default(false);
23 |
24 | $table->index(['priority', 'id']);
25 | });
26 | }
27 |
28 | public function down()
29 | {
30 | Schema::dropIfExists('haystack_bales');
31 | }
32 | };
33 |
--------------------------------------------------------------------------------
/database/migrations/create_haystack_data_table.php.stub:
--------------------------------------------------------------------------------
1 | id();
14 | $table->timestamps();
15 | $table->foreignIdFor(Haystack::class)->constrained()->cascadeOnDelete();
16 | $table->string('key');
17 | $table->longText('value');
18 | $table->string('cast')->nullable();
19 |
20 | $table->unique(['haystack_id', 'key']);
21 | });
22 | }
23 |
24 | public function down()
25 | {
26 | Schema::dropIfExists('haystack_data');
27 | }
28 | };
29 |
--------------------------------------------------------------------------------
/database/migrations/create_haystacks_table.php.stub:
--------------------------------------------------------------------------------
1 | id();
13 | $table->string('name')->nullable();
14 | $table->mediumText('callbacks')->nullable();
15 | $table->mediumText('middleware')->nullable();
16 | $table->text('options');
17 | $table->timestamps();
18 | $table->dateTime('started_at')->nullable();
19 | $table->dateTime('resume_at')->nullable();
20 | $table->dateTime('finished_at')->nullable();
21 | });
22 | }
23 |
24 | public function down()
25 | {
26 | Schema::dropIfExists('haystacks');
27 | }
28 | };
29 |
--------------------------------------------------------------------------------
/phpunit.xml:
--------------------------------------------------------------------------------
1 |
2 |