From b064ed1a038d8fc1f2990b473b98834739ae9f6d Mon Sep 17 00:00:00 2001
From: lowlighter <22963968+lowlighter@users.noreply.github.com>
Date: Sat, 27 Feb 2021 12:33:35 +0100
Subject: [PATCH] Add plugin_skyline_quality option (#159)

---
 source/plugins/skyline/README.md    |  5 +++--
 source/plugins/skyline/index.mjs    |  4 ++--
 source/plugins/skyline/metadata.yml | 11 ++++++++++-
 source/plugins/skyline/tests.yml    | 11 +++++++++++
 4 files changed, 26 insertions(+), 5 deletions(-)

diff --git a/source/plugins/skyline/README.md b/source/plugins/skyline/README.md
index 953b4a3e..3d8336af 100644
--- a/source/plugins/skyline/README.md
+++ b/source/plugins/skyline/README.md
@@ -22,6 +22,7 @@ This uses puppeteer to generate collect image frames, and use CSS animations to
   with:
     # ... other options
     plugin_skyline: yes
-    plugin_skyline_year: 0    # Set to 0 to display current year
-    plugin_skyline_frames: 60 # Use 60 frames (half-loop)
+    plugin_skyline_year: 0      # Set to 0 to display current year
+    plugin_skyline_frames: 60   # Use 60 frames (half-loop)
+    plugin_skyline_quality: 0.5 # Scale-down quality by half to reduce file-size (⚠️ higher quality increase file size)
 ```
\ No newline at end of file
diff --git a/source/plugins/skyline/index.mjs b/source/plugins/skyline/index.mjs
index 1e1de5a9..920a8af3 100644
--- a/source/plugins/skyline/index.mjs
+++ b/source/plugins/skyline/index.mjs
@@ -7,7 +7,7 @@
             return null
 
         //Load inputs
-          let {year, frames} = imports.metadata.plugins.skyline.inputs({data, account, q})
+          let {year, frames, quality} = imports.metadata.plugins.skyline.inputs({data, account, q})
           if (Number.isNaN(year)) {
             year = new Date().getFullYear()
             console.debug(`metrics/compute/${login}/plugins > skyline > year set to ${year}`)
@@ -32,7 +32,7 @@
 
         //Generate gif
           console.debug(`metrics/compute/${login}/plugins > skyline > generating frames`)
-          const framed = await imports.puppeteergif({page, width, height, frames, scale:0.5})
+          const framed = await imports.puppeteergif({page, width, height, frames, scale:quality})
 
         //Close puppeteer
           await browser.close()
diff --git a/source/plugins/skyline/metadata.yml b/source/plugins/skyline/metadata.yml
index 46d04d36..790b0c56 100644
--- a/source/plugins/skyline/metadata.yml
+++ b/source/plugins/skyline/metadata.yml
@@ -25,4 +25,13 @@ inputs:
     type: number
     default: 60
     min: 1
-    max: 120
\ No newline at end of file
+    max: 120
+
+  # Image quality
+  # Note that it significantly increases output filesize (up to a few Mb) which can cause render/loading issues
+  plugin_skyline_quality:
+    description: Image quality
+    type: number
+    default: 0.5
+    min: 0.1
+    max: 1
\ No newline at end of file
diff --git a/source/plugins/skyline/tests.yml b/source/plugins/skyline/tests.yml
index 2923765b..15ba0bf1 100644
--- a/source/plugins/skyline/tests.yml
+++ b/source/plugins/skyline/tests.yml
@@ -6,3 +6,14 @@
   timeout: 1800000
   modes:
     - action
+
+- name: Skyline plugin (complete)
+  uses: lowlighter/metrics@latest
+  with:
+    token: NOT_NEEDED
+    plugin_skyline: yes
+    plugin_skyline_frames: 12
+    plugin_skyline_quality: 0.7
+  timeout: 1800000
+  modes:
+    - action