Polish Linux, Mac and Windows builds (#51)

* move to the latest mgclient v1.4.1

Author: gitbuda

.github/workflows/ci.yml

@@ -11,7 +11,7 @@ jobs:
     - uses: actions/checkout@v1
     - uses: actions/setup-node@v1
       with:
-        node-version: '12.x'
+        node-version: '18.x'
     - name: Install and build addon
       run: |
         npm install
@@ -24,12 +24,12 @@ jobs:
       uses: actions/cache@v1
       with:
         path: ~/memgraph
-        key: cache-memgraph-v2.1.1-docker-image
+        key: cache-memgraph-v2.5.2-docker-image
     - name: Download Memgraph Docker image
       if: steps.cache-memgraph-docker.outputs.cache-hit != 'true'
       run: |
         mkdir ~/memgraph
-        curl -L https://memgraph.com/download/memgraph/v2.1.1/docker/memgraph-2.1.1-docker.tar.gz > ~/memgraph/memgraph-docker.tar.gz
+        curl -L https://memgraph.com/download/memgraph/v2.5.2/docker/memgraph-2.5.2-docker.tar.gz > ~/memgraph/memgraph-docker.tar.gz
     - name: Load Memgraph Docker image
       run: |
         docker load -i ~/memgraph/memgraph-docker.tar.gz

.npmignore

@@ -1,5 +1,6 @@
 node_modules
 build/*
 !build/Release/nodemgclient.node
+!build/Debug/nodemgclient.node
 .cache
 .github

CMakeLists.txt

@@ -2,21 +2,20 @@ cmake_minimum_required(VERSION 3.10)
 
 #### NOTES:
 # * HOW TO CHANGE THE COMPILER?
-# If you want to use specific compiler, consider using -C | --cc | --cxx cmake-js flags.
+#   If you want to use specific compiler, consider using -C | --cc | --cxx cmake-js flags.
+#
 # * WINDOWS AND MINGW ISSUES?
-# cmake-js doesn't support MinGW Makefiles -> https://github.com/cmake-js/cmake-js/issues/195
-# /DELAYLOAD:NODE.EXE: No such file or directory -> https://github.com/cmake-js/cmake-js/issues/200
-# cmake-js adds /DELAYLOAD:NODE.EXE + there is not an easy solution -> Move to node-gyp
-# I've played with paths + setting the CMAKE_SHARED_LINKER_FLAGS but all that is N/A.
-# The following does not work because CMake changes the string to be Windows path.
-# set(CMAKE_SHARED_LINKER_FLAGS "/DELAYLOAD:/c/Program\\ Files/nodejs/node.exe")
+#   cmake-js doesn't support MinGW Makefiles -> https://github.com/cmake-js/cmake-js/issues/195
+#   /DELAYLOAD:NODE.EXE: No such file or directory -> https://github.com/cmake-js/cmake-js/issues/200
+#   cmake-js adds /DELAYLOAD:NODE.EXE + there is not an easy solution.
+#   I've played with paths + setting the CMAKE_SHARED_LINKER_FLAGS but all that is N/A.
+#   The following does not work because CMake changes the string to be Windows path.
+#   set(CMAKE_SHARED_LINKER_FLAGS "/DELAYLOAD:/c/Program\\ Files/nodejs/node.exe")
 
-project(nodemgclient VERSION 0.1.0)
+project(nodemgclient VERSION 0.1.2)
 
 if (WIN32 AND MINGW)
     message(FATAL_ERROR "ON WINDOWS BUILD UNDER MINGW NOT YET POSSIBLE")
-elseif (APPLE)
-    message(FATAL_ERROR "ON APPLE BUILD NOT YET POSSIBLE")
 endif()
 
 include(ExternalProject)
@@ -36,14 +35,16 @@ add_library(project_warnings INTERFACE)
 include(cmake/CompilerWarnings.cmake)
 set_project_warnings(project_warnings)
 
-set(MGCLIENT_GIT_TAG "v1.3.0" CACHE STRING "mgclient git tag")
+set(MGCLIENT_GIT_TAG "v1.4.1" CACHE STRING "mgclient git tag")
 set(MGCLIENT_LIBRARY      mgclient-lib)
 set(MGCLIENT_INSTALL_DIR  ${CMAKE_BINARY_DIR}/mgclient)
 set(MGCLIENT_INCLUDE_DIRS ${MGCLIENT_INSTALL_DIR}/include)
 if (UNIX AND NOT APPLE)
   set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_INSTALL_DIR}/lib/libmgclient.so)
 elseif (WIN32)
   set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_INSTALL_DIR}/lib/mgclient.dll)
+elseif (APPLE)
+  set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_INSTALL_DIR}/lib/libmgclient.dylib)
 endif()
 ExternalProject_Add(mgclient-proj
   PREFIX           mgclient-proj
@@ -53,6 +54,7 @@ ExternalProject_Add(mgclient-proj
                    "-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}"
                    "-DBUILD_CPP_BINDINGS=ON"
                    "-DCMAKE_POSITION_INDEPENDENT_CODE=ON"
+                   "-DOPENSSL_ROOT_DIR=${OPENSSL_ROOT_DIR}"
   BUILD_BYPRODUCTS "${MGCLIENT_LIBRARY_PATH}"
   INSTALL_DIR      "${PROJECT_BINARY_DIR}/mgclient"
 )

README.md

@@ -1,4 +1,5 @@
 [![Actions Status](https://github.com/memgraph/nodemgclient/workflows/CI/badge.svg)](https://github.com/memgraph/nodemgclient/actions)
+[![status: experimental](https://github.com/GIScience/badges/raw/master/status/experimental.svg)](https://www.npmjs.com/package/@memgraph/client)
 
 # nodemgclient - Node.js Memgraph Client
 
@@ -50,7 +51,6 @@ npm run test
 
 Since `cmake-js` is used, compiling for Windows is very similar to compiling
 for Linux:
-
 ```bash
 npm ci
 npm run build:release
@@ -60,7 +60,29 @@ If installing OpenSSL package from
 https://slproweb.com/products/Win32OpenSSL.html, make sure to use the full one
 because of the header files.
 
-NOTE: Compilation doesn NOT work yet under MinGW.
+NOTE: Compilation does NOT work yet under MinGW.
+
+## Build from Source on MacOS
+
+To build on MacOS it's required to install the `openssl` package, e.g.:
+```
+brew install openssl
+```
+Once the package is in place, please set the `OPENSSL_ROOT_DIR` environment variable:
+```
+export OPENSSL_ROOT_DIR="$(brew --prefix openssl)"
+```
+Once OpenSSL is in place, please run:
+```
+npm ci
+npm run build:release
+```
+
+NOTE: For more adventurous folks, since `cmake-js` is used, it's also possible to set
+the OpenSSL path via the following commend:
+```
+npx cmake-js compile --CDOPENSSL_ROOT_DIR="$(brew --prefix openssl)"
+```
 
 ## Implementation and Interface Notes
 

example/event_emitter.js

@@ -36,7 +36,7 @@ const emitter = new EventEmitter()
     // a promise.
     const connection = memgraph.Connect({ host: 'localhost', port: 7687 });
 
-    await connection.ExecuteAndFetchRecords(query.DELETE_ALL);
+    await connection.ExecuteAndFetchAll(query.DELETE_ALL);
 
     const result = await connection.ExecuteLazy(
       `UNWIND [0, 1] AS item RETURN "value_x2" AS x, "value_y2" AS y;`,