Merge pull request #59 from DiffyWebsite/retrieve-screenshot-status

Retrieve screenshot status

Author: gregurcom

README.md

@@ -50,6 +50,27 @@ You can use `--wait` key to wait for the screenshot to be completed.
 
 As a result, you will get an ID of the screenshot.
 
+#### Get screenshot status
+
+```shell script
+diffy screenshot:get-status SCREENSHOT_ID
+```
+
+Prints `1` when the set of screenshots is completed, and nothing while it is still being captured.
+
+Add `--format=json` to get the capture state and progress instead:
+
+```shell script
+diffy screenshot:get-status SCREENSHOT_ID --format=json
+```
+
+```json
+{"id":1421873,"state":3,"completed":true,"name":null,"environment":"Production","executionTime":"2min 6s","status":{"results":84,"items":84,"queue":0,"estimate":"under 1 minute","totalTime":126,"jobs":0,"inProgress":0}}
+```
+
+`state` is `-1` stopped, `0` not started, `1` in progress, `2`/`3`/`4` completed. Note that the plain
+output `1` means completed, while `state` of `1` means the capture is still in progress.
+
 #### Compare screenshots (creating diff)
 
 If you know your screenshots IDs the easiest would be:

src/Commands/ScreenshotCommand.php

@@ -108,6 +108,57 @@ protected function createScreenshotInternal($projectId, $environment, array $opt
         return $screenshotId;
     }
 
+    /**
+     * Get screenshot status
+     *
+     * @command screenshot:get-status
+     *
+     * @param int $screenshotId
+     *
+     * @option format Format of the output (supported: json). Omit it to print 1 when the screenshot set
+     *                is completed and nothing when it is not.
+     *
+     * @return mixed
+     *
+     * @throws \Exception
+     *
+     * @usage screenshot:get-status 12345 Get screenshot status.
+     * @usage screenshot:get-status 12345 --format=json Get screenshot state and capture progress as JSON.
+     */
+    public function getScreenshotStatus(int $screenshotId, array $options = ['format' => ''])
+    {
+        $format = $options['format'] ?? '';
+
+        if ($format && $format !== 'json') {
+            $this->io()->error('Format value is not supported. Provide the following value: json.');
+            return;
+        }
+
+        $apiKey = Config::getConfig()['key'];
+        Diffy::setApiKey($apiKey);
+        $screenshot = Screenshot::retrieve($screenshotId);
+
+        if ($format === 'json') {
+            $this->io()->write(json_encode([
+                'id' => $screenshotId,
+                'state' => $screenshot->data['state'] ?? null,
+                'completed' => $screenshot->isCompleted(),
+                'name' => $screenshot->data['name'] ?? null,
+                'environment' => $screenshot->data['environment'] ?? null,
+                'executionTime' => $screenshot->data['executionTime'] ?? null,
+                'status' => $screenshot->data['status'] ?? null,
+            ]));
+
+            // Successful exit.
+            return new ResultData();
+        }
+
+        $this->io()->write($screenshot->isCompleted());
+
+        // Successful exit.
+        return new ResultData();
+    }
+
     /**
      * Get the list of screenshots
      *