Merge pull request #3 from matheuswsantos/master

Add support to puppeter pdf options + Add kool_global network

Author: fabriciojs

.gitignore

@@ -1,4 +1,3 @@
 node_modules/
 .vscode/
-storage/
 .env

README.md

@@ -20,9 +20,13 @@ If you use Docker Compose (hopefully with [`kool`](https://github.com/kool-dev/k
 ```php
 use GuzzleHttp\Client;
 
-$pdf = (new Client())->post('http://pdf/from-html', [
+$pdf = (new Client())->post('http://pdf_dev/from-html', [
     'form_params' => [
         'html' => '<h1>This is my super kool HTML that I want to turn into an awesome PDF file!</h1> <p> This is a very silly example, but you get the idea of how powerful this is <b>:)</b> </p>',
+        'options' => json_encode([
+            'format' => 'A4',
+            'printBackground' => false,
+        ]),
     ],
 ])->getBody();
 
@@ -31,6 +35,10 @@ file_put_contents('path/to/my/super-kool.pdf', $pdf);
 
 * Important to notice, the code above assumes you are running it from within another container in the same Docker Compose application so the `pdf` domain resolves to our microservice.
 
+* The `options` should be a json data type
+
+* You can see all these `options` in [puppeteer docs](https://github.com/puppeteer/puppeteer/blob/main/docs/api.md#pagepdfoptions)
+
 ## Getting started on developing locally this microservice
 
 To get started with development locally (using [`kool`](https://github.com/kool-dev/kool), of course!):

kool.services.yml

@@ -10,3 +10,12 @@ services:
       - '.:/app'
     ports:
       - '3000:3000'
+    networks:
+      kool_global:
+        aliases:
+          - pdf_dev
+
+networks:
+  kool_global:
+    external: true
+    name: "${KOOL_GLOBAL_NETWORK:-kool_global}"

pdf-service.js

@@ -38,14 +38,15 @@ app.get('/health', (req, res) => {
 app.post('/from-html', async (req, res) => {
     calls.fromHtml++;
     const html = req.body.html;
+    const options = getPdfOptions(req.body.options);
     const htmlFile = md5(html.substr(0, 100)) + '.html';
     const fullHtmlPath = path.join(storagePath, htmlFile);
 
     fs.writeFileSync(fullHtmlPath, html);
 
     let pdfFilePath;
     try {
-        pdfFilePath = await generatePdf(`file://${fullHtmlPath}`, req.query.media);
+        pdfFilePath = await generatePdf(`file://${fullHtmlPath}`, req.query.media, options);
     } catch (err) {
         console.log('/from-html: error generating PDF', e);
         let msg = 'failure generating PDF';
@@ -100,7 +101,7 @@ function deliverPdfFile(res, pdfFilePath) {
     });
 }
 
-async function generatePdf(url, media) {
+async function generatePdf(url, media, options = {}) {
     console.log('generatePdf: browser.newPage');
     const page = await browser.newPage();
 
@@ -127,8 +128,7 @@ async function generatePdf(url, media) {
         scale: parseFloat(1),
         format: 'A4',
         printBackground: true,
-        // displayHeaderFooter: false,
-        // landscape: false,
+        ...options
     });
 
     page.close();
@@ -140,6 +140,40 @@ function md5(seed) {
     return crypto.createHash('md5').update(seed).digest('hex');
 }
 
+function getPdfOptions(options) {
+    if (typeof options !== 'string') {
+        return {};
+    }
+
+    const parsedOptions = JSON.parse(options);
+
+    let mappedOptions = {};
+
+    [
+        'path',
+        'scale',
+        'displayHeaderFooter',
+        'headerTemplate',
+        'footerTemplate',
+        'printBackground',
+        'landscape',
+        'pageRanges',
+        'format',
+        'width',
+        'height',
+        'margin',
+        'preferCSSPageSize',
+    ].forEach(prop => {
+        if (parsedOptions[prop] === undefined) {
+            return;
+        }
+
+        mappedOptions[prop] = parsedOptions[prop];
+    });
+
+    return mappedOptions;
+}
+
 app.listen(port, () => {
     console.log(`Kool PDF service running at port ${port}`);
     console.log('Going to start puppeter');

storage/.gitignore

@@ -0,0 +1,2 @@
+*
+!.gitignore