Release notes

release-notes/opensearch-reporting.release-notes-2.12.0.0.md

@@ -0,0 +1,10 @@
+## Version 2.10.0.0 Release Notes
+
+Compatible with OpenSearch 2.10.0
+
+### Maintenance
+* Onboard jenkins prod docker images to github actions ([#924](https://github.com/opensearch-project/reporting/pull/924))
+
+### Infrastructure
+* Bumping ktlint to 0.47.1 ([#960](https://github.com/opensearch-project/reporting/pull/960))
+* upgrade gradle to 8.5 ([#941](https://github.com/opensearch-project/reporting/pull/941))

reporting-anything/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "reporting-anything",
+  "description": "Download reports from anywhere",
+  "main": "download_report.js",
+  "type": "module",
+  "dependencies": {
+    "argparse": "^2.0.1",
+    "commander": "^9.2.0",
+    "dompurify": "^2.1.1",
+    "jsdom": "^19.0.0",
+    "lodash": "^4.17.21",
+    "puppeteer-core": "^13.5.2"
+  },
+  "bin": {
+    "reporting-anything": "src/download_report.js"
+  }
+}

reporting-anything/src/constants.js

@@ -0,0 +1,23 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+export const CHROMIUM_PATH = '../.chromium/headless_shell';
+
+export const REPORT_TYPE = {
+  DASHBOARD: 'Dashboard',
+  VISUALIZATION: 'Visualization',
+  NOTEBOOK: 'Notebook',
+}
+
+export const SELECTOR = {
+  DASHBOARD: '#dashboardViewport',
+  VISUALIZATION: '.visEditor__content',
+  NOTEBOOK: '.euiPageBody',
+}
+
+export const FORMAT = {
+  PDF: 'pdf',
+  PNG: 'png'
+}

reporting-anything/src/download_helpers.js

@@ -0,0 +1,341 @@
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+import hbs from "nodemailer-express-handlebars";
+import AWS from "aws-sdk";
+AWS.config.update({region: 'REGION'});
+AWS.config = new AWS.Config();
+const ses = new AWS.SES({region: "us-west-2"});
+import puppeteer from 'puppeteer-core';
+import fs from 'fs';
+import { JSDOM } from 'jsdom';
+import { CHROMIUM_PATH, FORMAT, REPORT_TYPE, SELECTOR } from './constants.js';
+import nodemailer from "nodemailer";
+import {exit} from "process";
+const BASIC_AUTH = 'basic';
+const COGNITO_AUTH = 'cognito';
+const SAML_AUTH = 'SAML';
+const DASHBOARDS = 'dashboards';
+const VISUALIZE = "Visualize";
+const DISCOVER = "discover";
+const NOTEBOOKS = "notebooks"
+
+
+export async function downloadVisualReport(url, format, width, height, filename, authType, username, password) {
+  const window = new JSDOM('').window;
+
+  try {
+    const browser = await puppeteer.launch({
+      headless: true,
+      /**
+       * TODO: temp fix to disable sandbox when launching chromium on Linux instance
+       * https://github.com/puppeteer/puppeteer/blob/main/docs/troubleshooting.md#setting-up-chrome-linux-sandbox
+       */
+      args: [
+        '--no-sandbox',
+        '--disable-setuid-sandbox',
+        '--disable-gpu',
+        '--no-zygote',
+        '--single-process',
+        '--font-render-hinting=none',
+        '--enable-features=NetworkService',
+        '--ignore-certificate-errors',
+      ],
+      executablePath: CHROMIUM_PATH,
+      ignoreHTTPSErrors: true,
+      env: {
+        TZ: 'UTC', // leave as UTC for now
+      },
+    });
+
+    const page = await browser.newPage();
+    const overridePage = await browser.newPage();
+    page.setDefaultNavigationTimeout(0);
+    page.setDefaultTimeout(100000);
+    overridePage.setDefaultNavigationTimeout(0);
+    overridePage.setDefaultTimeout(100000);
+
+    // auth 
+    if (username !== undefined && password !== undefined) {
+      if(authType === BASIC_AUTH){
+        await basicAuthentication(page, overridePage, url, username, password);
+      }
+      else if(authType === SAML_AUTH){
+        await samlAuthentication(page, overridePage, url, username, password);
+      }
+      else if (authType === COGNITO_AUTH){
+        await cognitoAuthentication(page, overridePage, url, username, password);
+      }
+    }
+    // no auth
+    else {
+      await page.goto(url, { waitUntil: 'networkidle0' });
+    }
+
+    await page.setViewport({
+      width: width,
+      height: height,
+    });
+
+    const reportSource = getReportSourceFromURL(url);
+    // if its an OpenSearch report, remove extra elements
+    if (reportSource !== 'Other') {
+      await page.evaluate(
+        (reportSource, REPORT_TYPE) => {
+          // remove buttons
+          document
+            .querySelectorAll("[class^='euiButton']")
+            .forEach((e) => e.remove());
+          // remove top navBar
+          document
+            .querySelectorAll("[class^='euiHeader']")
+            .forEach((e) => e.remove());
+          // remove visualization editor
+          if (reportSource === REPORT_TYPE.VISUALIZATION) {
+            document
+              .querySelector('[data-test-subj="splitPanelResizer"]')
+              ?.remove();
+            document.querySelector('.visEditor__collapsibleSidebar')?.remove();
+          }
+          document.body.style.paddingTop = '0px';
+        },
+        reportSource,
+        REPORT_TYPE
+      );      
+    }
+
+      // force wait for any resize to load after the above DOM modification
+      await page.waitFor(1000);
+      switch (reportSource) {
+        case 'Dashboard':
+          await page.waitForSelector(SELECTOR.DASHBOARD, {
+            visible: true,
+          });
+          break;
+        case 'Visualization':
+          await page.waitForSelector(SELECTOR.VISUALIZATION, {
+            visible: true,
+          });
+          break;
+        case 'Notebook':
+          await page.waitForSelector(SELECTOR.NOTEBOOK, {
+            visible: true,
+          });
+          break;
+        default:
+          break;
+      }
+
+      await waitForDynamicContent(page);
+
+      let bufferPDF, bufferPNG;
+
+        const scrollHeight = await page.evaluate(
+          () => document.documentElement.scrollHeight
+        );
+
+        bufferPDF = await page.pdf({
+          margin: undefined,
+          width: 1680,
+          height: scrollHeight + 'px',
+          printBackground: true,
+          pageRanges: '1',
+        });
+
+        bufferPNG = await page.screenshot({
+          fullPage: true,
+        });
+
+
+      const fileNamePDF = `${filename}.pdf`;
+      const fileNamePNG = `${filename}.png`;
+      const curTime = new Date();
+      const timeCreated = curTime.valueOf();
+      await browser.close();
+      const dataPDF = { timeCreated, dataUrl: bufferPDF.toString('base64'), fileNamePDF };
+      const dataPNG = { timeCreated, dataUrl: bufferPNG.toString('base64'), fileNamePNG };
+      await readStreamToFile(dataPDF.dataUrl, fileNamePDF);
+      await readStreamToFile(dataPNG.dataUrl, fileNamePNG);
+      await sendEmail(fileNamePDF, fileNamePNG, username);
+  } catch (e) {
+    console.log('error is', e);
+    process.exit(1);
+  }
+}
+
+const waitForDynamicContent = async (
+  page,
+  timeout = 30000,
+  interval = 1000,
+  checks = 5
+) => {
+  const maxChecks = timeout / interval;
+  let passedChecks = 0;
+  let previousLength = 0;
+
+  let i = 0;
+  while (i++ <= maxChecks) {
+    let pageContent = await page.content();
+    let currentLength = pageContent.length;
+
+    previousLength === 0 || previousLength != currentLength
+      ? (passedChecks = 0)
+      : passedChecks++;
+    if (passedChecks >= checks) {
+      break;
+    }
+
+    previousLength = currentLength;
+    await page.waitFor(interval);
+  }
+};
+
+const getReportSourceFromURL = (url) => {
+  if (url.includes(DASHBOARDS)) {
+    return 'Dashboard';
+  }
+  else if (url.includes(VISUALIZE)) {
+    return 'Visualization';
+  }
+  else if (url.includes(DISCOVER)) {
+    return 'Saved search';
+  }
+  else if (url.includes(NOTEBOOKS)) {
+    return 'Notebook';
+  }
+  return 'Other';
+}
+
+const getUrl = async (url) =>{
+  let urlExt = url.split("#");
+  let urlRef = "#"+urlExt[1];
+  return urlRef;
+};
+
+const sendEmail = async (fileNamePDF, fileNamePNG, username) => {
+  let mailOptions = {
+    from: username,
+    subject: 'This is an email containing your dashboard report',
+    to: username,
+    attachments: [
+      {
+        filename: fileNamePDF,
+        path: fileNamePDF,
+        contentType: 'application/pdf'
+      },
+      {
+        filename: 'report.png',
+        path: fileNamePNG,
+        cid: 'report'
+      }],
+    //specify the template here
+    template : 'index'
+  };
+
+  console.log('Creating SES transporter');
+  let transporter = nodemailer.createTransport({
+    SES: ses
+  });
+  transporter.use("compile",hbs({
+    viewEngine:{
+      partialsDir:"./views/",
+      defaultLayout:""
+    },
+    viewPath:"./views/",
+    extName:".hbs"
+  }));
+
+  // send email
+  await transporter.sendMail(mailOptions, function (err, info) {
+    if (err) {
+      console.log(err);
+      console.log('Error sending email');
+
+    } else {
+      console.log('Email sent successfully');
+    }
+  });
+}
+
+const basicAuthentication = async (page, overridePage, url, username, password) => {
+  await page.goto(url, { waitUntil: 'networkidle0' });
+  console.log('basic authenticating');
+  await page.waitFor(10000);
+  await page.type('input[data-test-subj="user-name"]', username);
+  await page.type('[data-test-subj="password"]', password);
+  await page.click('button[type=submit]');
+  await page.waitForTimeout(30000);
+  try{
+    await page.click('label[for=global]');
+  }
+  catch(err){
+    console.log('Invalid username or password');
+    exit(1)
+  }
+  await page.click('button[data-test-subj="confirm"]');
+  await page.waitForTimeout(25000);
+  await overridePage.goto(url,{ waitUntil: 'networkidle0' });
+  await overridePage.waitForTimeout(5000);
+  await page.goto(url,{ waitUntil: 'networkidle0' });
+};
+
+const samlAuthentication = async (page, overridePage, url, username, password) => {
+  await page.goto(url, { waitUntil: 'networkidle0' });
+  console.log('SAML authenticating');
+  await page.waitFor(10000);
+  let refUrl;
+  await getUrl(url).then((value) => {
+    refUrl = value;
+  });
+  await page.type('[name="identifier"]', username);
+  await page.type('[name="credentials.passcode"]', password);
+  await page.click('[value="Sign in"]')
+  await page.waitForTimeout(30000);
+  try{
+    await page.click('label[for=global]');
+  }
+  catch(err){
+    console.log('Invalid username or password');
+    exit(1)
+  }
+  await page.click('button[data-test-subj="confirm"]');
+  await page.waitForTimeout(25000);
+  await page.click(`a[href='${refUrl}']`);
+}
+
+const cognitoAuthentication = async (page, overridePage, url, username, password) => {
+  await page.goto(url, { waitUntil: 'networkidle0' });
+  console. log('cognito authenticating');
+  await page.waitFor(10000);
+  await page.type(  '[name="username" ]', username);
+  await page.type( ' [name="password"]', password);
+  await page.click( '[name="signInSubmitButton"]');
+  await page.waitForTimeout(30000);
+  try{
+    await page.click('label[for=global]');
+  }
+  catch(err){
+    console.log('Invalid username or password');
+    exit(1)
+  }
+  await page.click('button[data-test-subj="confirm"]');
+  await page.waitForTimeout(25000);
+  await overridePage.goto(url,{ waitUntil: 'networkidle0' });
+  await overridePage.click('label[for=global]');
+  await overridePage.click('button[data-test-subj="confirm"]');
+  await overridePage.waitForTimeout(5000);
+  await page.goto(url,{ waitUntil: 'networkidle0' });
+}
+
+
+export const readStreamToFile = async (
+  stream,
+  fileName
+) => {
+  let base64Image = stream.split(';base64,').pop();
+  fs.writeFile(fileName, base64Image, {encoding: 'base64'}, function (err) {
+    console.log('Downloaded report');
+  })
+};
+