Add screenshot plugin (#217)

source/plugins/screenshot/README.md

@@ -0,0 +1,26 @@
+### 📸 Website screenshot
+
+The *screenshot* plugin lets you take a screenshot from any website.
+It can be restricted with a [CSS selector](https://developer.mozilla.org/en-US/docs/Web/CSS/CSS_Selectors) or you can take a full page.
+
+<table>
+  <td align="center">
+    <img src="https://github.com/lowlighter/lowlighter/blob/master/metrics.plugin.screenshot.svg">
+    <img width="900" height="1" alt="">
+  </td>
+</table>
+
+#### ℹ️ Examples workflows
+
+[➡️ Available options for this plugin](metadata.yml)
+
+```yaml
+- uses: lowlighter/metrics@latest
+  with:
+    # ... other options
+    plugin_screenshot: yes
+    plugin_screenshot_title: XKCD of the day  # Section title
+    plugin_screenshot_url: https://xkcd.com   # Website url
+    plugin_screenshot_selector: "#comic img"  # CSS selector to take into screenshot
+    plugin_screenshot_background: no          # Remove page background
+```

source/plugins/screenshot/index.mjs

@@ -0,0 +1,42 @@
+//Setup
+  export default async function({login, q, imports, data, account}, {enabled = false} = {}) {
+    //Plugin execution
+      try {
+        //Check if plugin is enabled and requirements are met
+          if ((!enabled)||(!q.screenshot))
+            return null
+
+        //Load inputs
+          let {url, selector, title, background} = imports.metadata.plugins.screenshot.inputs({data, account, q})
+          if (!url)
+            throw {error:{message:"An url is required"}}
+
+        //Start puppeteer and navigate to page
+          console.debug(`metrics/compute/${login}/plugins > screenshot > starting browser`)
+          const browser = await imports.puppeteer.launch()
+          console.debug(`metrics/compute/${login}/plugins > screenshot > started ${await browser.version()}`)
+          const page = await browser.newPage()
+          await page.setViewport({width:600, height:600})
+          console.debug(`metrics/compute/${login}/plugins > screenshot > loading ${url}`)
+          await page.goto(url)
+
+        //Screenshot
+          await page.waitForSelector(selector)
+          const clip = await page.evaluate(selector => {
+            const {x, y, width, height} = document.querySelector(selector).getBoundingClientRect()
+            return {x, y, width, height}
+          }, selector)
+          const [buffer] = await imports.record({page, ...clip, frames:1, background})
+          const screenshot = await (await imports.jimp.read(Buffer.from(buffer.split(",").pop(), "base64"))).resize(454, imports.jimp.AUTO)
+          await browser.close()
+
+        //Results
+          return {image:await screenshot.getBase64Async("image/png"), title, height:screenshot.bitmap.height, width:screenshot.bitmap.width}
+      }
+    //Handle errors
+      catch (error) {
+        if (error.error?.message)
+          throw error
+        throw {title:"Screenshot error", error:{message:"An error occured", instance:error}}
+      }
+  }

source/plugins/screenshot/metadata.yml

@@ -0,0 +1,39 @@
+name: "📸 Website screenshot"
+cost: N/A
+categorie: other
+index: 2
+supports:
+  - user
+  - organization
+  - repository
+inputs:
+
+  # Enable or disable plugin
+  plugin_screenshot:
+    description: Display a screenshot of any website
+    type: boolean
+    default: no
+
+  # Screenshot title caption
+  plugin_screenshot_title:
+    description: Screenshot title caption
+    type: string
+    default: Screenshot
+
+  # Website to take screenshot
+  plugin_screenshot_url:
+    description: Website to take screenshot
+    type: string
+    default: ""
+
+  # Selector to take in screenshot
+  plugin_screenshot_selector:
+    description: Selector to take in screenshot
+    type: string
+    default: body
+
+  # Display or remove default page background
+  plugin_screenshot_background:
+    description: Display or remove default page background
+    type: boolean
+    default: yes

source/plugins/screenshot/tests.yml

@@ -0,0 +1,12 @@
+- name: Screenshot plugin (default)
+  uses: lowlighter/metrics@latest
+  with:
+    token: NOT_NEEDED
+    plugin_screenshot: yes
+    plugin_screenshot_url: https://github.com
+    plugin_screenshot_title: Test
+    plugin_screenshot_selector: body
+    plugin_screenshot_background: no
+  timeout: 1800000
+  modes:
+    - action