Migrated state:progress command into the new events system, thus it's no longer a task but an event. as such, the related ENVS and command are gone.

Author: arabcoders

FAQ.md

@@ -402,7 +402,7 @@ command via CLI.
 
 > [!IMPORTANT]
 > for environment variables that has `{TASK}` tag, you **MUST** replace it with one
-> of `IMPORT`, `EXPORT`, `PUSH`, `BACKUP`, `PRUNE`, `INDEXES`, `REQUESTS`. To see tasks active settings run
+> of `IMPORT`, `EXPORT`, `PUSH`, `BACKUP`, `PRUNE`, `INDEXES`. To see tasks active settings run
 
 ```bash
 $ docker exec -ti watchstate console system:tasks

README.md

@@ -9,6 +9,14 @@ out of the box, this tool support `Jellyfin`, `Plex` and `Emby` media servers.
 
 ## Updates
 
+### 2024-08-18
+
+We have started migrating the old events system to a new one, so far we have migrated the `progress` and `requests` to it. As such,
+The old tasks `state:progress` and `state:requests` are now gone. To control if you want to enable the watch progress, there is new
+environment variable `WS_SYNC_PROGRESS` which you can set to `true` to enable the watch progress. It's disabled by default.
+
+We will continue to migrate the rest of the events to the new system, and we will keep you updated.
+
 ### 2024-08-10
 
 I have recently added new experimental feature, to play your content directly from the WebUI. This feature is still in

config/config.php

@@ -9,7 +9,6 @@
 use App\Commands\State\BackupCommand;
 use App\Commands\State\ExportCommand;
 use App\Commands\State\ImportCommand;
-use App\Commands\State\ProgressCommand;
 use App\Commands\State\PushCommand;
 use App\Commands\System\IndexCommand;
 use App\Commands\System\PruneCommand;
@@ -75,6 +74,9 @@
             'proxy' => (bool)env('WS_TRUST_PROXY', false),
             'header' => (string)env('WS_TRUST_HEADER', 'X-Forwarded-For'),
         ],
+        'sync' => [
+            'progress' => (bool)env('WS_SYNC_PROGRESS', false),
+        ],
     ];
 
     $config['backends_file'] = fixPath(env('WS_BACKENDS_FILE', ag($config, 'path') . '/config/servers.yaml'));
@@ -272,14 +274,6 @@
                 'timer' => $checkTaskTimer((string)env('WS_CRON_PUSH_AT', '*/10 * * * *'), '*/10 * * * *'),
                 'args' => env('WS_CRON_PUSH_ARGS', '-v'),
             ],
-            ProgressCommand::TASK_NAME => [
-                'command' => ProgressCommand::ROUTE,
-                'name' => ProgressCommand::TASK_NAME,
-                'info' => 'Send play progress to backends.',
-                'enabled' => (bool)env('WS_CRON_PROGRESS', false),
-                'timer' => $checkTaskTimer((string)env('WS_CRON_PROGRESS_AT', '*/45 * * * *'), '*/45 * * * *'),
-                'args' => env('WS_CRON_PROGRESS_ARGS', '-v'),
-            ],
             BackupCommand::TASK_NAME => [
                 'command' => BackupCommand::ROUTE,
                 'name' => BackupCommand::TASK_NAME,

config/env.spec.php

@@ -161,6 +161,11 @@
             'description' => 'All executing all commands in the console. They must be prefixed with $',
             'type' => 'bool',
         ],
+        [
+            'key' => 'WS_SYNC_PROGRESS',
+            'description' => 'Enable watch progress sync.',
+            'type' => 'bool',
+        ],
     ];
 
     $validateCronExpression = function (string $value): string {
@@ -186,7 +191,7 @@
     };
 
     // -- Do not forget to update the tasks list if you add a new task.
-    $tasks = ['import', 'export', 'push', 'progress', 'backup', 'prune', 'indexes'];
+    $tasks = ['import', 'export', 'push', 'backup', 'prune', 'indexes'];
     $task_env = [
         [
             'key' => 'WS_CRON_{TASK}',

frontend/pages/events/view.vue

@@ -85,6 +85,18 @@
             JSON.stringify(item.logs, null, 2)
           }}</code></pre>
       </div>
+      <div class="column is-12" v-if="item.options">
+        <h2 class="title is-4 is-clickable is-unselectable" @click="toggleOptions = !toggleOptions">
+          <span class="icon">
+            <i class="fas" :class="{ 'fa-arrow-down': !toggleOptions, 'fa-arrow-up': toggleOptions }"></i>
+          </span>&nbsp;
+          <span>Show attached options</span>
+        </h2>
+        <pre class="p-0 is-pre-wrap" v-if="toggleOptions"><code
+            style="word-break: break-word" class="language-json">{{
+            JSON.stringify(item.options, null, 2)
+          }}</code></pre>
+      </div>
     </div>
   </div>
 </template>
@@ -105,6 +117,7 @@ const item = ref({})
 
 const toggleLogs = useStorage('events_toggle_logs', true)
 const toggleData = useStorage('events_toggle_data', true)
+const toggleOptions = useStorage('events_toggle_options', true)
 
 onMounted(async () => {
   if (!id.value) {

src/API/Backend/Webhooks.php

@@ -16,7 +16,6 @@
 use App\Libs\Uri;
 use App\Listeners\ProcessRequestEvent;
 use App\Model\Events\EventsTable;
-use DateInterval;
 use Monolog\Handler\StreamHandler;
 use Monolog\Level;
 use Monolog\Logger;
@@ -199,23 +198,14 @@ private function process(string $name, iRequest $request): iResponse
             'id' => ag($entity->getMetadata($entity->via), iState::COLUMN_ID, '??'),
         ]);
 
-        queueEvent(ProcessRequestEvent::NAME, [
-            'options' => [
-                Options::IMPORT_METADATA_ONLY => $metadataOnly,
-            ],
-            'entity' => $entity->getAll(),
-        ], [
-            EventsTable::COLUMN_REFERENCE => $itemId,
+        queueEvent(ProcessRequestEvent::NAME, $entity->getAll(), [
             'unique' => true,
+            EventsTable::COLUMN_REFERENCE => $itemId,
+            EventsTable::COLUMN_OPTIONS => [
+                Options::IMPORT_METADATA_ONLY => $metadataOnly,
+            ]
         ]);
 
-        $pEnabled = (bool)env('WS_CRON_PROGRESS', false);
-        if ($pEnabled && false === $metadataOnly && true === $entity->hasPlayProgress() && !$entity->isWatched()) {
-            $progress = $this->cache->get('progress', []);
-            $progress[str_replace($itemId, ':tainted@', ':untainted@')] = $entity;
-            $this->cache->set('progress', $progress, new DateInterval('P3D'));
-        }
-
         $this->write($request, Level::Info, 'Queued [{backend}: {event}] {item.type} [{item.title}].', [
                 'backend' => $entity->via,
                 'event' => ag($entity->getExtra($entity->via), iState::COLUMN_EXTRA_EVENT),
@@ -225,7 +215,7 @@ private function process(string $name, iRequest $request): iResponse
                     'type' => $entity->type,
                     'played' => $entity->isWatched() ? 'Yes' : 'No',
                     'queue_id' => $itemId,
-                    'progress' => $pEnabled && $entity->hasPlayProgress() ? $entity->getPlayProgress() : null,
+                    'progress' => $entity->hasPlayProgress() ? $entity->getPlayProgress() : null,
                 ]
             ]
         );