Add lambda support (#14)

* Integrated new email template in cli Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Update help test Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Delete temp img in for error case Signed-off-by: Rupal Mahajan <maharup@amazon.com> * use const for emailTemplateImageBuffer Signed-off-by: Rupal Mahajan <maharup@amazon.com> * embed opensearch logo Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Accept text file for email body and add logic to convert text to html Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Increase wait time after dom modification Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Add dockerfile Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Updates required for working with lambda Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Change path to fix test failure Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Add ora spinner back Signed-off-by: Rupal Mahajan <maharup@amazon.com> * nit Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Add promise for sending email, Update Dockerfile with tgz install Signed-off-by: Rupal Mahajan <maharup@amazon.com> * nit: log Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Update doc Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Address PR comments Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Update Dockerfile Signed-off-by: Rupal Mahajan <maharup@amazon.com> * nit: remove ls Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Move Dockerfile to example doc Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Add Dockerfile for building from source Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Nit: remove ls from Dockerfile Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Adding apt-get remove -y google-chrome-stable Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Update example docs Signed-off-by: Rupal Mahajan <maharup@amazon.com> * nit Signed-off-by: Rupal Mahajan <maharup@amazon.com> * Update docs/examples/lambda_container_image.md Co-authored-by: Joshua Li <joshuali925@gmail.com> --------- Signed-off-by: Rupal Mahajan <maharup@amazon.com> Co-authored-by: Joshua Li <joshuali925@gmail.com>
opensearch-project · Feb 2, 2023 · d98381d · d98381d
1 parent c8ca95f
commit d98381d
Show file tree

Hide file tree

Showing 13 changed files with 1,153 additions and 978 deletions.
diff --git a/DEVELOPER_GUIDE.md b/DEVELOPER_GUIDE.md
@@ -14,11 +14,11 @@ The node version "^12.20.0 || >=14" is required.
 2. Run `yarn` inside `reporting-cli/src`
 3. You can run the below commands inside `reporting-cli/src`
     ```
-    node index.js --url <url>
+    node cli.js --url <url>
     ```
     For additional command line parameter options
     ```
-    node index.js -h
+    node cli.js -h
     ```
 4. Alternatively, you can use npm install to run this command from any directory.
     ```
@@ -31,7 +31,7 @@ The node version "^12.20.0 || >=14" is required.
 
     To uninstall, use  
     ```
-    npm uninstall -g opensearch-reporting-cli
+    npm uninstall -g @opensearch-project/reporting-cli
     ```
 
 ### Running Tests
@@ -48,4 +48,4 @@ curl -XPOST -u 'admin:admin' 'http://localhost:5601/api/sample_data/ecommerce' -
 curl -XPOST -u 'admin:admin' 'http://localhost:5601/api/sample_data/logs' -H 'osd-xsrf:true'  -H 'securitytenant: global'
 curl -XPOST -u 'admin:admin' 'http://localhost:5601/api/sample_data/flights' -H 'osd-xsrf:true'  -H 'securitytenant: admin_tenant'
 ```
-Run `yarn test` inside `reporting-cli`.
+Run `yarn test` inside `reporting-cli`.
diff --git a/docs/examples/lambda_container_image.md b/docs/examples/lambda_container_image.md
@@ -0,0 +1,85 @@
+# Scheduling Reports with Lambda
+
+Opensearch reporting CLI can be used with Lambda for scheduling email reports.
+
+### Prerequisites
+
+- AMD64 Systems
+- Docker
+
+### Creating Lambda container image
+
+1. Create a Dockerfile. Following Dockerfile can be used to create a container image for v1.0.0.
+  ```dockerfile
+  # Define function directory
+  ARG FUNCTION_DIR="/function"
+
+  # Base image of the docker container
+  FROM node:lts-slim as build-image
+
+  # Include global arg in this stage of the build
+  ARG FUNCTION_DIR
+
+  # AWS Lambda runtime dependencies
+  RUN apt-get update && \
+      apt-get install -y \
+          g++ \
+          make \
+          unzip \
+          libcurl4-openssl-dev \
+          autoconf \
+          automake \
+          libtool \
+          cmake \
+          python3 \
+          libkrb5-dev \
+          curl
+
+  # Copy function code
+  WORKDIR ${FUNCTION_DIR}
+  RUN curl -LJO https://artifacts.opensearch.org/reporting-cli/opensearch-reporting-cli-1.0.0.tgz
+  RUN tar -xzf opensearch-reporting-cli-1.0.0.tgz
+  RUN mv package/* .
+  RUN npm install && npm install aws-lambda-ric
+
+  # Build Stage 2: Copy Build Stage 1 files in to Stage 2. Install chromium dependencies and chromium.
+  FROM node:lts-slim
+  # Include global arg in this stage of the build
+  ARG FUNCTION_DIR
+  # Set working directory to function root directory
+  WORKDIR ${FUNCTION_DIR}
+  # Copy in the build image dependencies
+  COPY --from=build-image ${FUNCTION_DIR} ${FUNCTION_DIR}
+
+  # Install latest chrome dev package and fonts to support major charsets (Chinese, Japanese, Arabic, Hebrew, Thai and a few others)
+  # Note: this installs the necessary libs to make the bundled version of Chromium that Puppeteer installs, work.
+  RUN apt-get update \
+      && apt-get install -y wget gnupg \
+      && wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+      && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
+      && apt-get update \
+      && apt-get install -y google-chrome-stable fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-freefont-ttf libxss1 \
+        --no-install-recommends \
+      && apt-get remove -y google-chrome-stable \
+      && rm -rf /var/lib/apt/lists/*
+
+  ENTRYPOINT ["/usr/local/bin/npx", "aws-lambda-ric"]
+
+  ENV HOME="/tmp"
+  CMD [ "/function/src/index.handler" ]
+  ```
+
+2. Run the build command in from the directory where Dockerfile exists.
+
+  ```
+  docker build -t opensearch-reporting-cli .
+  ```
+### Use Lambda container image
+
+1. Push the Docker image to [Amazon ECR](https://docs.aws.amazon.com/AmazonECR/latest/userguide/getting-started-console.html)
+
+2. Create a Lambda Function. Select previously created container image and architecture x86_64'.
+
+3. Update Lambda timeout to 5 min and memory size to at least 1024MB.
+
+
diff --git a/docs/examples/lambda_container_image_from_source.md b/docs/examples/lambda_container_image_from_source.md
@@ -0,0 +1,71 @@
+## Create Lambda container image from source code
+
+1. Checkout this package from version control
+    ```
+    git clone git@github.com:opensearch-project/reporting-cli.git
+    cd reporting-cli
+    ```
+2. Add the following Dockerfile inside `reporting-cli`. 
+    ```dockerfile
+    # Define function directory
+    ARG FUNCTION_DIR="/function"
+
+    # Base image of the docker container
+    FROM node:lts-slim as build-image
+
+    # Include global arg in this stage of the build
+    ARG FUNCTION_DIR
+
+    # AWS Lambda runtime dependencies
+    RUN apt-get update && \
+        apt-get install -y \
+            g++ \
+            make \
+            unzip \
+            libcurl4-openssl-dev \
+            autoconf \
+            automake \
+            libtool \
+            cmake \
+            python3 \
+            libkrb5-dev
+
+    # Copy function code
+    COPY package.json src/ ${FUNCTION_DIR}/
+    WORKDIR ${FUNCTION_DIR}
+    RUN npm install && npm install aws-lambda-ric
+
+    # Build Stage 2: Copy Build Stage 1 files in to Stage 2. Install chromium dependencies and chromium.
+    FROM node:lts-slim
+
+    # Include global arg in this stage of the build
+    ARG FUNCTION_DIR
+
+    # Set working directory to function root directory
+    WORKDIR ${FUNCTION_DIR}
+
+    # Copy in the build image dependencies
+    COPY --from=build-image ${FUNCTION_DIR} ${FUNCTION_DIR}
+
+    # Install latest chrome dev package and fonts to support major charsets (Chinese, Japanese, Arabic, Hebrew, Thai and a few others)
+    # Note: this installs the necessary libs to make the bundled version of Chromium that Puppeteer installs, work.
+    RUN apt-get update \
+        && apt-get install -y wget gnupg \
+        && wget -q -O - https://dl-ssl.google.com/linux/linux_signing_key.pub | apt-key add - \
+        && sh -c 'echo "deb [arch=amd64] http://dl.google.com/linux/chrome/deb/ stable main" >> /etc/apt/sources.list.d/google.list' \
+        && apt-get update \
+        && apt-get install -y google-chrome-stable fonts-ipafont-gothic fonts-wqy-zenhei fonts-thai-tlwg fonts-kacst fonts-freefont-ttf libxss1 \
+        --no-install-recommends \
+        && apt-get remove -y google-chrome-stable \
+        && rm -rf /var/lib/apt/lists/*
+
+    ENTRYPOINT ["/usr/local/bin/npx", "aws-lambda-ric"]
+
+    ENV HOME="/tmp"
+    CMD [ "/function/index.handler" ]
+
+    ```
+3. Run the build command.
+    ```
+    docker build -t opensearch-reporting-cli .
+    ```
diff --git a/package.json b/package.json
@@ -1,8 +1,7 @@
 {
   "name": "@opensearch-project/reporting-cli",
   "description": "Opensearch Reporting CLI to download and email OpenSearch Dashboards reports.",
-  "main": "index.js",
-  "type": "module",
+  "main": "./src/index.js",
   "homepage": "https://www.opensearch.org/",
   "version": "1.0.0",
   "keywords": [
@@ -33,11 +32,11 @@
     "lodash": "^4.17.21",
     "nodemailer": "^6.8.0",
     "nodemailer-express-handlebars": "^5.0.0",
-    "ora": "^6.1.2",
+    "ora": "^5.4.1",
     "puppeteer": "^18.2.0"
   },
   "bin": {
-    "opensearch-reporting-cli": "./src/index.js"
+    "opensearch-reporting-cli": "./src/cli.js"
   },
   "devDependencies": {
     "jest": "^29.3.1"

diff --git a/src/arguments.js b/src/arguments.js
@@ -4,17 +4,16 @@
  * SPDX-License-Identifier: Apache-2.0
  */
 
-import { program, Option } from 'commander';
-import { exit } from 'process';
-import ora from 'ora';
-import fs from 'fs';
-import { AUTH, CLI_COMMAND_NAME, DEFAULT_AUTH, DEFAULT_FILENAME, DEFAULT_FORMAT, DEFAULT_MIN_HEIGHT, DEFAULT_TENANT, DEFAULT_WIDTH, ENV_VAR, FORMAT, TRANSPORT_TYPE, DEFAULT_EMAIL_SUBJECT, DEFAULT_EMAIL_NOTE } from './constants.js';
-import dotenv from "dotenv";
+const { program, Option } = require('commander');
+const { exit } = require('process');
+const fs = require('fs');
+const ora = require('ora');
+const { AUTH, CLI_COMMAND_NAME, DEFAULT_AUTH, DEFAULT_FILENAME, DEFAULT_FORMAT, DEFAULT_MIN_HEIGHT, DEFAULT_TENANT, DEFAULT_WIDTH, ENV_VAR, FORMAT, TRANSPORT_TYPE, DEFAULT_EMAIL_SUBJECT, DEFAULT_EMAIL_NOTE } = require('./constants.js');
+const dotenv = require("dotenv");
 dotenv.config();
+const spinner = ora('');
 
-const spinner = ora();
-
-export async function getCommandArguments() {
+async function getCommandArguments() {
 
     program
         .name(CLI_COMMAND_NAME)
@@ -73,6 +72,27 @@ Note: The tenant in the url has the higher priority than tenant value provided a
     return getOptions(options);
 }
 
+async function getEventArguments(event) {
+    if (event.auth === undefined)
+        event['auth'] = DEFAULT_AUTH;
+    if (event.tenant === undefined)
+        event['tenant'] = DEFAULT_TENANT;
+    if (event.format === undefined)
+        event['format'] = DEFAULT_FORMAT;
+    if (event.width === undefined)
+        event['width'] = DEFAULT_WIDTH;
+    if (event.height === undefined)
+        event['height'] = DEFAULT_MIN_HEIGHT;
+    if (event.filename === undefined)
+        event['filename'] = DEFAULT_FILENAME;
+    if (event.subject === undefined)
+        event['subject'] = DEFAULT_EMAIL_SUBJECT;
+    if (event.note === undefined)
+        event['note'] = DEFAULT_EMAIL_NOTE;
+
+    return getOptions(event);
+}
+
 function getOptions(options) {
     var commandOptions = {
         url: null,
@@ -94,7 +114,8 @@ function getOptions(options) {
         smtppassword: null,
         subject: null,
         time: null,
-        note: null
+        note: null,
+        emailbody: null
     }
 
     // Set url.
@@ -152,6 +173,9 @@ function getOptions(options) {
         ? `${commandOptions.filename}-${commandOptions.time.toISOString().replace(/:/g, '-')}.${commandOptions.format}`
         : `${commandOptions.filename}.${commandOptions.format}`;
 
+    // Set name for email body report image
+    commandOptions.emailbody = `email-body-${commandOptions.time.toISOString().replace(/:/g, '-')}.png`
+
     // Set width and height of the window
     commandOptions.width = Number(options.width);
     commandOptions.height = Number(options.height);
@@ -180,7 +204,7 @@ function getOptions(options) {
     }
     commandOptions.note = getHtml(commandOptions.note);
 
-    spinner.succeed('Fetched argument values')
+    spinner.succeed('Fetched argument values');
     return commandOptions;
 }
 
@@ -194,4 +218,9 @@ function getHtml(text) {
         .replace(/\t/g, "    ")
         .replace(/ /g, "&#8203;&nbsp;&#8203;")
         .replace(/\r\n|\r|\n/g, "<br />");
+}
+
+module.exports = {
+    getCommandArguments,
+    getEventArguments
 }
diff --git a/src/cli.js b/src/cli.js
@@ -0,0 +1,9 @@
+#!/usr/bin/env node
+/*
+ * Copyright OpenSearch Contributors
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+const run = require('./run.js');
+
+run(undefined);