@bitblit/ratchet-echarts 0.1.4-alpha → 0.1.6-alpha

package/README.md

@@ -6,7 +6,7 @@ indebted.  I have forked it because that library appears to now be dormant, and
 versions of echarts, and the new prebuilt versions of canvas in my Lambda functions.  I also prefer typescript
 and will be bringing in type information.
 
-### Install
+## Install
 
 Note: Since this library depends on Echarts >= 5.x and node-canvas (canvas) >= 2.9.3, it auto-bundles in the 
 correct native libraries (prebuilt) for Windows, OSX, and Linux - see [the canvas github page](https://github.com/Automattic/node-canvas) 
@@ -16,7 +16,62 @@ for details.  Therefore, all you have to do is:
 npm install @bitblit/ratchet-echarts
 ```
 
-### Usage
+### Special notes for AWS Lambda
+
+Most important - you MUST set your lambda to have sufficient memory - probably 512Mb or more.  If you find yourself
+getting timeouts with no errors logged after adding the library, you most likely have insufficient memory set.
+
+
+If you are using AWS Lambda (either Node 14/16, or containers built from the AWS parent container for them), you will
+likely encounter the error "/lib64/libz.so.1: version `ZLIB_1.2.9' not found (required by /var/task/node_modules/canvas/build/Release/libpng16.so.16)"
+
+See [the node-canvas issue for more details](https://github.com/Automattic/node-canvas/issues/1779).  The solution
+varies depending on how you use Lambda.  
+
+### Using a custom docker container (1st way)
+To make sure it is compatible with whatever the current build of the image is, we will build from scratch.  In our
+docker container, we'll add :
+
+```docker
+# To build things in yarn
+RUN yum -y install python3
+RUN yum -y install pkgconfig make
+
+# Specifically for building canvas
+RUN yum -y install gcc-c++ cairo-devel pango-devel libjpeg-turbo-devel giflib-devel
+```
+
+And then, in the container we'll force a clean build, either by using
+```docker
+RUN npm install --build-from-source
+```
+
+or
+
+```docker
+RUN npm_config_build_from_source=true yarn install
+```
+
+### Using a custom docker container (alternate way)
+Add this to your container:
+```docker
+# Bring these in to make echarts work...
+# Also requires setting the LD_LIBRARY_PATH variable in the config
+# https://github.com/Automattic/node-canvas/issues/1779
+RUN yum -y install libuuid-devel libmount-devel
+RUN cp /lib64/{libuuid,libmount,libblkid}.so.1 ${LAMBDA_TASK_ROOT}/node_modules/canvas/build/Release/
+# End charts stuff
+```
+
+And then set an environment variable:
+```
+LD_LIBRARY_PATH="${LAMBDA_TASK_ROOT}/modules/api/node_modules/canvas/build/Release:${LD_LIBRARY_PATH}"
+```
+
+### Using one of the AWS Node options
+Use a [prebuilt layer](https://serverlessrepo.aws.amazon.com/applications/arn:aws:serverlessrepo:us-east-1:990551184979:applications~lambda-layer-canvas-nodejs)
+
+## Usage
 
 ```typescript
 

package/dist/static/build-properties.json

@@ -1,7 +1,7 @@
 {
-  "buildVersion": "4",
-  "buildHash": "df9f733d07443116a0c1b22e5862355579ad1e73",
-  "buildBranch": "alpha-2022-08-06-10",
-  "buildTag": "alpha-2022-08-06-10",
-  "buildTime": "2022-08-06 23:21:55 PM America/Los_Angeles"
+  "buildVersion": "6",
+  "buildHash": "9c183335f67bfe4cd9351c534a7246a6aa373ae3",
+  "buildBranch": "alpha-2023-01-23-9",
+  "buildTag": "alpha-2023-01-23-9",
+  "buildTime": "2023-01-23 23:18:56 PM America/Los_Angeles"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@bitblit/ratchet-echarts",
-  "version": "0.1.4-alpha",
+  "version": "0.1.6-alpha",
   "description": "Library for using echarts on Node",
   "files": [
     "dist"
@@ -30,7 +30,7 @@
     "remove-compiled-tests": "rimraf ./dist/examples && rimraf ./dist/**/*.spec.d.ts && rimraf ./dist/**/*.spec.js && rimraf ./dist/**/*.spec.js.map",
     "clean": "shx rm -Rf dist",
     "compile-test": "yarn compile && yarn test",
-    "apply-ci-vars": "node node_modules/@bitblit/ratchet/dist/node-only/ci/apply-ci-env-variables-to-files github dist/static/build-properties.json",
+    "apply-ci-vars": "yarn ratchet-apply-ci-env-variables-to-files github dist/static/build-properties.json",
     "test": "jest",
     "lint": "eslint src/**/*.ts",
     "lint-fix": "eslint --fix src/**/*.ts",
@@ -49,29 +49,29 @@
   },
   "homepage": "https://github.com/bitblit/ratchet-echarts-echarts#readme",
   "dependencies": {
-    "canvas": "2.9.3",
-    "echarts": "5.3.3"
+    "canvas": "2.11.0",
+    "echarts": "5.4.1"
   },
   "devDependencies": {
-    "@bitblit/ratchet": "0.21.25",
-    "@types/jest": "28.1.4",
+    "@bitblit/ratchet": "3.0.68",
+    "@types/jest": "29.2.6",
     "@types/node": "14.18.1",
-    "@typescript-eslint/eslint-plugin": "5.30.5",
-    "@typescript-eslint/parser": "5.30.5",
-    "barrelsby": "2.3.4",
+    "@typescript-eslint/eslint-plugin": "5.49.0",
+    "@typescript-eslint/parser": "5.49.0",
+    "barrelsby": "2.5.1",
     "cross-fetch": "3.1.5",
     "eslint": "8.19.0",
-    "eslint-config-prettier": "8.5.0",
-    "eslint-plugin-import": "2.26.0",
+    "eslint-config-prettier": "8.6.0",
+    "eslint-plugin-import": "2.27.5",
     "eslint-plugin-prettier": "4.2.1",
-    "husky": "8.0.1",
-    "jest": "28.1.2",
+    "husky": "8.0.3",
+    "jest": "29.3.1",
     "jsonwebtoken": "8.5.1",
-    "prettier": "2.7.1",
+    "prettier": "2.8.3",
     "pretty-quick": "3.1.3",
-    "rimraf": "3.0.2",
+    "rimraf": "4.1.2",
     "shx": "0.3.4",
-    "ts-jest": "28.0.5",
+    "ts-jest": "29.0.5",
     "typescript": "4.6.4"
   }
 }