@live-change/print-service 0.8.113 → 0.8.114

package/authentication.js

@@ -0,0 +1,25 @@
+import config from './config.js'
+import definition from './definition.js'
+
+import { ObservableValue } from '@live-change/dao'
+
+const authenticationKey = new ObservableValue(
+  config.printAuthenticationKey
+)
+
+definition.authenticator({
+  async prepareCredentials(credentials) {
+    //console.log("PRINT AUTHENTICATOR", credentials, authenticationKey.getValue())
+    if(credentials.sessionKey === authenticationKey.getValue()) {
+      credentials.roles.push('admin')
+      credentials.internal = true
+    }
+  }
+})
+
+const baseUrl = `http://${config.ssrHost}`+`:${config.ssrPort}`
+
+export async function getAuthenticatedUrl(path, data) {
+  const encodedData = data && encodeURIComponent(JSON.stringify(data))
+  return baseUrl + path + (data ? '/' + encodedData : '') +`?sessionKey=${await authenticationKey.getValue()}`
+}

package/browser.js

@@ -4,7 +4,7 @@ const app = App.app()
 import definition from './definition.js'
 import config from './config.js'
 
-import { chrome } from 'playwright'
+import { chromium } from 'playwright'
 
 import PQueue from 'p-queue'
 import got from "got"
@@ -13,20 +13,20 @@ const browserQueue = new PQueue({ concurrency: config.concurrency })
 
 async function newBrowser() {
   if(config.browserWebSocketDebuggerUrl) {
-    const browser = await chrome.connect({ wsEndpoint: config.browserWebSocketDebuggerUrl })
+    const browser = await chromium.connect({ wsEndpoint: config.browserWebSocketDebuggerUrl })
     return browser
   } else if(config.browserUrl) {
     const browserInfo = await got.post(config.browserUrl + '/json/version').json()
-    const browser = await chrome.connect({ wsEndpoint: browserInfo.webSocketDebuggerUrl })
+    const browser = await chromium.connect({ wsEndpoint: browserInfo.webSocketDebuggerUrl })
   } else {
-    const browser = await chrome.launch()
+    const browser = await chromium.launch()
     return browser
   }
 }
 
 export async function runWithBrowser(func) {
   return await browserQueue.add(async () => {
-    const browser = newBrowser()
+    const browser = await newBrowser()
     const result = await func(browser)
     await browser.close()
     return result

package/config.js

@@ -1,7 +1,8 @@
 import definition from './definition.js'
+import crypto from 'crypto'
 
 const {
-  browserUrl = 'http://localhost:9222',
+  browserUrl,
   browserWebSocketDebuggerUrl,
   concurrency = 1,
   printAuthenticationKey = crypto.randomBytes(24).toString('hex'),

package/index.js

@@ -3,6 +3,11 @@ const app = App.app()
 
 import definition from './definition.js'
 
-import "./print.js"
+import "./authentication.js"
+import { printToPdfFileTask } from "./printPdf.js"
+import { screenshotToFileTask } from "./screenshot.js"
+
+export { printToPdfFileTask, screenshotToFileTask }
+
 
 export default definition

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@live-change/print-service",
-  "version": "0.8.113",
+  "version": "0.8.114",
   "description": "",
   "main": "index.js",
   "scripts": {
@@ -21,13 +21,13 @@
     "url": "https://www.viamage.com/"
   },
   "dependencies": {
-    "@live-change/framework": "^0.8.113",
-    "@live-change/relations-plugin": "^0.8.113",
-    "@live-change/user-service": "^0.8.113",
+    "@live-change/framework": "^0.8.114",
+    "@live-change/relations-plugin": "^0.8.114",
+    "@live-change/user-service": "^0.8.114",
     "got": "^11.8.6",
     "p-queue": "^8.0.1",
     "playwright": "^1.41.2"
   },
-  "gitHead": "80dd8415e06d849cc00a7711c635a7388143ce1d",
+  "gitHead": "1a5a437aae382d766c2806a11f805370ee8cc40a",
   "type": "module"
 }

package/printPdf.js

@@ -0,0 +1,82 @@
+import App from '@live-change/framework'
+const app = App.app()
+
+import definition from './definition.js'
+import config from './config.js'
+
+import { task } from '@live-change/task-service'
+
+import { runWithBrowser } from './browser.js'
+
+import { getAuthenticatedUrl } from './authentication.js'
+
+async function sleep(time) {
+  return new Promise(resolve => setTimeout(resolve, time))
+}
+
+export const printToPdfFileTask = task({
+  name: "printToPdfFile",
+  properties: {
+    path: {
+      type: String
+    },
+    data: {
+      type: Object
+    },
+    timeout: {
+      type: Number
+    },
+    media: {
+      type: Object
+    },
+    options: {
+      type: Object
+    },
+    waitForSelector: {
+      type: String
+    },
+    outputPath: {
+      type: String
+    }
+  },
+  async execute({ path, data, timeout, media, options, waitForSelector, outputPath }, { task, trigger, triggerService }, emit) {
+    const all = 10
+    let at = 0
+    const url = await getAuthenticatedUrl(path, data)
+    let pdf
+    task.progress(at++, all, 'gettingBrowserReady')
+    await runWithBrowser(async browser => {
+      task.progress(at++, all, 'creatingPage')
+      const page = await browser.newPage()
+      task.progress(at++, all, 'enteringPage')
+      await page.goto(url)
+      task.progress(at++, all, 'waitingForLoading')
+      while(true) {
+        const loadingTasksCount = await page.evaluate(() => api.globals.$allLoadingTasks?.length)
+        if(loadingTasksCount === 0) break
+        await sleep(100)
+      }
+      if(waitForSelector) {
+        task.progress(at++, all, 'waitingForSelector')
+        await page.waitForSelector(waitForSelector)
+      } else {
+        task.progress(at++, all, 'waitingForNetworkIdle')
+        await page.waitForLoadState('networkidle')
+      }
+      task.progress(at++, all, 'waitingForRendering')
+      await sleep(100) // wait for some time to give browser time to render
+      task.progress(at++, all, 'printing')
+      page.emulateMedia(media ?? { media: 'print' })
+      pdf = await page.pdf( options ?? { format: 'A4', printBackground: true })
+      task.progress(at++, all, 'closingPage')
+    })
+    task.progress(at++, all, 'writingPdfToFile')
+    await fs.promises.writeFile(outputPath, pdf)
+    task.progress(at++, all, 'done')
+    return outputPath
+  }
+}, definition)
+
+
+
+

package/screenshot.js

@@ -0,0 +1,138 @@
+import App from '@live-change/framework'
+const app = App.app()
+
+import definition from './definition.js'
+import config from './config.js'
+
+import fs from "fs/promises"
+
+import { task } from '@live-change/task-service'
+
+import { runWithBrowser } from './browser.js'
+
+import { getAuthenticatedUrl } from './authentication.js'
+
+async function sleep(time) {
+  return new Promise(resolve => setTimeout(resolve, time))
+}
+
+export const screenshotToFileTask = task({
+  name: "screenshotToFile",
+  properties: {
+    path: {
+      type: String
+    },
+    data: {
+      type: Object
+    },
+    timeout: {
+      type: Number
+    },
+    viewport: {
+      type: Object,
+      properties: {
+        width: {
+          type: Number
+        },
+        height: {
+          type: Number
+        }
+      }
+    },
+    media: {
+      type: Object
+    },
+    options: {
+      type: Object
+    },
+    waitForSelector: {
+      type: String
+    },
+    clipSelector: {
+      type: String
+    },
+    outputPath: {
+      type: String
+    }
+  },
+  async execute({ path, data, timeout, media, options, waitForSelector, viewport, outputPath, clipSelector },
+                { task, trigger, triggerService }, emit) {
+    const all = 10
+    let at = 0
+    const url = await getAuthenticatedUrl(path, data)
+    let imageData
+    let size
+    task.progress(at++, all, 'gettingBrowserReady')
+    await runWithBrowser(async browser => {
+      console.log("BROWSER", browser)
+      task.progress(at++, all, 'creatingPage')
+      const page = await browser.newPage()
+      if(viewport) page.setViewport(viewport)
+      task.progress(at++, all, 'enteringPage')
+      await page.goto(url)
+      task.progress(at++, all, 'waitingForLoading')
+      while(true) {
+        const loadingTasksCount = await page.evaluate(() => api.globals.$allLoadingTasks?.length)
+        if(loadingTasksCount === 0) break
+        await sleep(100)
+      }
+      if(waitForSelector) {
+        task.progress(at++, all, 'waitingForSelector')
+        console.log("WAITING FOR SELECTOR", waitForSelector, "AT URL", url)
+        const locator = page.locator(waitForSelector)
+        await locator.waitFor({ state: 'attached', timeout })
+      } else {
+        task.progress(at++, all, 'waitingForNetworkIdle')
+        await page.waitForLoadState('networkidle')
+      }
+      task.progress(at++, all, 'waitingForRendering')
+      await sleep(100) // wait for some time to give browser time to render
+      task.progress(at++, all, 'printing')
+      if(media) page.emulateMedia(media)
+      const screenshotOptions = {
+        type: 'png',
+        ...options
+      }
+      if(clipSelector) {
+        const clip = await page.evaluate(selector => {
+          const element = document.querySelector(selector)
+          if(!element) return null
+          const { x, y, width, height } = element.getBoundingClientRect()
+          return { x, y, width, height }
+        }, clipSelector)
+        if(clip) {
+          screenshotOptions.clip = clip
+        }
+      }
+      size = screenshotOptions.clip
+      if(!size) {
+        if(screenshotOptions.fullPage) {
+          const bodyHandle = await page.$('body')
+          const { width, height } = await bodyHandle.boundingBox()
+          await bodyHandle.dispose()
+          size = { width, height }
+        } else {
+          size = await page.evaluate(() => {
+            return {
+              width: document.documentElement.clientWidth,
+              height: document.documentElement.clientHeight
+            }
+          })
+        }
+      }
+      imageData = await page.screenshot(screenshotOptions)
+      task.progress(at++, all, 'closingPage')
+    })
+    task.progress(at++, all, 'writingScreenshotToFile')
+    await fs.writeFile(outputPath, imageData)
+    task.progress(at++, all, 'done')
+    return {
+      path: outputPath,
+      size
+    }
+  }
+}, definition)
+
+
+
+

package/print.js

@@ -1,88 +0,0 @@
-import App from '@live-change/framework'
-const app = App.app()
-
-import definition from './definition.js'
-import config from './config.js'
-
-import { task } from '@live-change/task-service'
-
-import { runWithBrowser } from './browser.js'
-
-const authenticationKey = new ObservableValue(
-  config.printAuthenticationKey
-)
-
-definition.authenticator({
-  async prepareCredentials(credentials) {
-    //console.log("PRINT AUTHENTICATOR", credentials, authenticationKey.getValue())
-    if(credentials.sessionKey === authenticationKey.getValue()) {
-      credentials.roles.push('admin')
-      credentials.internal = true
-    }
-  }
-})
-
-const baseUrl = `http://${config.ssrHost}`+`:${config.ssrPort}`
-
-export async function getPrintUrl(path, data) {
-  const encodedData = encodeURIComponent(JSON.stringify(data))
-  return baseUrl + path+'/' + encodedData +`?sessionKey=${await authenticationKey.getValue()}`
-}
-
-async function sleep(time) {
-  return new Promise(resolve => setTimeout(resolve, time))
-}
-
-const printToPdfFile = task({
-  name: "printToPdfFile",
-  properties: {
-    path: {
-      type: String
-    },
-    data: {
-      type: Object
-    },
-    timeout: {
-      type: Number
-    },
-    media: {
-      type: Object
-    },
-    options: {
-      type: Object
-    },
-    outputPath: {
-      type: String
-    }
-  },
-  async execute({ path, data, timeout, media, options, outputPath }, { task, trigger, triggerService }, emit) {
-    const all = 8
-    const url = await getPrintUrl(path, data)
-    task.progress(0, all, 'gettingBrowserReady')
-    await runWithBrowser(async browser => {
-      task.progress(1, all, 'creatingPage')
-      const page = await browser.newPage()
-      task.progress(2, all, 'enteringPage')
-      await page.goto(url)
-      task.progress(3, all, 'waitingForLoading')
-      while(true) {
-        const loadingTasksCount = await page.evaluate(() => api.globals.$allLoadingTasks?.length)
-        if(loadingTasksCount === 0) break
-        await sleep(100)
-      }
-      task.progress(4, all, 'waitingForNetworkIdle')
-      await page.waitForLoadState('networkidle')
-      task.progress(5, all, 'waitingForRendering')
-      await sleep(100) // wait for some time to give browser time to render
-      task.progress(6, all, 'printing')
-      page.emulateMedia(media ?? { media: 'print' })
-      const pdf = await page.pdf( options ?? { format: 'A4', printBackground: true })
-      task.progress(7, all, 'closingPage')
-    })
-    task.progress(9, all, 'writingPdfToFile')
-    await fs.promises.writeFile(outputPath, pdf)
-    task.progress(10, all, 'done')
-    return outputPath
-  }
-})
-