Add Windows build (#41)

Author: gitbuda

.github/workflows/ci.yml

@@ -24,12 +24,12 @@ jobs:
       uses: actions/cache@v1
       with:
         path: ~/memgraph
-        key: cache-memgraph-v2.0.1-docker-image
+        key: cache-memgraph-v2.1.1-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.0.1/docker/memgraph-2.0.1-docker.tar.gz > ~/memgraph/memgraph-docker.tar.gz
+        curl -L https://memgraph.com/download/memgraph/v2.1.1/docker/memgraph-2.1.1-docker.tar.gz > ~/memgraph/memgraph-docker.tar.gz
     - name: Load Memgraph Docker image
       run: |
         docker load -i ~/memgraph/memgraph-docker.tar.gz

CMakeLists.txt

@@ -1,11 +1,9 @@
 cmake_minimum_required(VERSION 3.10)
 
-# NOTES
-#
-# HOW TO CHANGE THE COMPILER?
+#### NOTES:
+# * HOW TO CHANGE THE COMPILER?
 # If you want to use specific compiler, consider using -C | --cc | --cxx cmake-js flags.
-#
-# WINDOWS AND MINGW ISSUES?
+# * 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
@@ -15,6 +13,13 @@ cmake_minimum_required(VERSION 3.10)
 
 project(nodemgclient VERSION 0.1.0)
 
+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)
 find_package(OpenSSL REQUIRED)
 
 set(CMAKE_C_STANDARD 11)
@@ -31,60 +36,50 @@ add_library(project_warnings INTERFACE)
 include(cmake/CompilerWarnings.cmake)
 set_project_warnings(project_warnings)
 
-include(ExternalProject)
-
-if (WIN32 AND MINGW)
-    message(FATAL_ERROR "ON WINDOWS BUILD UNDER MINGW NOT YES POSSIBLE")
-elseif (APPLE)
-    message(FATAL_ERROR "ON APPLE BUILD NOT YET POSSIBLE")
-endif()
-
-# Add mgclient as an imported library.
-ExternalProject_Add(mgclient-proj
-                    PREFIX         mgclient
-                    GIT_REPOSITORY https://github.com/memgraph/mgclient.git
-                    GIT_TAG        v1.3.0
-                    CMAKE_ARGS     "-DCMAKE_INSTALL_PREFIX=<INSTALL_DIR>"
-                                   "-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}"
-                                   "-DBUILD_CPP_BINDINGS=ON"
-                    INSTALL_DIR    "${PROJECT_BINARY_DIR}/mgclient")
-ExternalProject_Get_Property(mgclient-proj install_dir)
-set(MGCLIENT_ROOT ${install_dir})
-set(MGCLIENT_INCLUDE_DIRS ${MGCLIENT_ROOT}/include
-    CACHE INTERNAL "Path to mgclient include directory")
+set(MGCLIENT_GIT_TAG "v1.3.0" 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_ROOT}/lib/libmgclient.so)
-elseif (WIN32 AND MINGW)
-    set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_ROOT}/lib/libmgclient.dll)
+  set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_INSTALL_DIR}/lib/libmgclient.so)
+elseif (WIN32)
+  set(MGCLIENT_LIBRARY_PATH ${MGCLIENT_INSTALL_DIR}/lib/mgclient.dll)
 endif()
-message(STATUS "MGCLIENT_LIBRARY_PATH: ${MGCLIENT_LIBRARY_PATH}")
-set(MGCLIENT_LIBRARY mgclient-lib)
+ExternalProject_Add(mgclient-proj
+  PREFIX           mgclient-proj
+  GIT_REPOSITORY   https://github.com/memgraph/mgclient.git
+  GIT_TAG          "${MGCLIENT_GIT_TAG}"
+  CMAKE_ARGS       "-DCMAKE_INSTALL_PREFIX=${MGCLIENT_INSTALL_DIR}"
+                   "-DCMAKE_BUILD_TYPE=${CMAKE_BUILD_TYPE}"
+                   "-DBUILD_CPP_BINDINGS=ON"
+                   "-DCMAKE_POSITION_INDEPENDENT_CODE=ON"
+  BUILD_BYPRODUCTS "${MGCLIENT_LIBRARY_PATH}"
+  INSTALL_DIR      "${PROJECT_BINARY_DIR}/mgclient"
+)
 add_library(${MGCLIENT_LIBRARY} SHARED IMPORTED)
+target_compile_definitions(${MGCLIENT_LIBRARY} INTERFACE mgclient_shared_EXPORTS)
 set_property(TARGET ${MGCLIENT_LIBRARY} PROPERTY IMPORTED_LOCATION ${MGCLIENT_LIBRARY_PATH})
-if (WIN32 AND MINGW)
-    set_property(TARGET ${MGCLIENT_LIBRARY} PROPERTY IMPORTED_IMPLIB ${MGCLIENT_ROOT}/lib/libmgclient.dll.a)
+if (WIN32)
+  set_property(TARGET ${MGCLIENT_LIBRARY} PROPERTY IMPORTED_IMPLIB ${MGCLIENT_INSTALL_DIR}/lib/mgclient.lib)
 endif()
 add_dependencies(${MGCLIENT_LIBRARY} mgclient-proj)
-message(STATUS "MGCLIENT_LIBRARY: ${MGCLIENT_LIBRARY}")
 
 # Define the addon.
 include_directories(${CMAKE_JS_INC})
-set(SOURCE_FILES src/addon.cpp
-                 src/client.cpp
-                 src/glue.cpp)
+set(SOURCE_FILES src/addon.cpp src/client.cpp src/glue.cpp)
 add_library(${PROJECT_NAME} SHARED ${SOURCE_FILES} ${CMAKE_JS_SRC})
+target_compile_definitions(${PROJECT_NAME} PRIVATE -Dmgclient_shared_EXPORTS)
 add_dependencies(${PROJECT_NAME} ${MGCLIENT_LIBRARY})
 set_target_properties(${PROJECT_NAME} PROPERTIES PREFIX "" SUFFIX ".node")
-target_link_libraries(${PROJECT_NAME} PRIVATE
-                      ${CMAKE_JS_LIB} ${MGCLIENT_LIBRARY}
-                      project_warnings project_options)
+target_link_libraries(${PROJECT_NAME} PRIVATE ${CMAKE_JS_LIB} ${MGCLIENT_LIBRARY} project_warnings project_options)
+if (WIN32)
+  target_link_libraries(${PROJECT_NAME} PRIVATE Ws2_32)
+endif()
 target_include_directories(${PROJECT_NAME} PRIVATE ${MGCLIENT_INCLUDE_DIRS})
-target_compile_options(${PROJECT_NAME} PRIVATE "")
 # C++ mgclient throws, which means this project has to enable exceptions. If at
 # any time we decide to disable exceptions with the combination of NAPI_THROW +
 # std::nullopt in case of an error, the code should work as is.
 add_definitions(-DNAPI_CPP_EXCEPTIONS)
-
 # Include N-API wrappers.
 execute_process(COMMAND node -p "require('node-addon-api').include"
                 WORKING_DIRECTORY ${CMAKE_SOURCE_DIR}

README.md

@@ -10,8 +10,7 @@
 
 ### Build from Source on Linux
 
-To install `nodemgclient` from sources you will need (only Linux is tested at
-the moment):
+To install `nodemgclient` from source you will need:
 
 * OpenSSL >= 1.0.2
 * A CMake >= 3.10
@@ -44,14 +43,25 @@ To test ([Docker](https://docs.docker.com/engine/install) is required) run:
 ```bash
 npm run test
 ```
+
 ### Build from Source on Windows
 
-NOTE: Not yet possible under MinGW.
+#### Build on Windows using Visual Studio
+
+Since `cmake-js` is used, compiling for Windows is very similar to compiling
+for Linux:
+
+```bash
+npm ci
+npm run build:release
+```
 
 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.
+
 ## Implementation and Interface Notes
 
 ### Temporal Types

cmake/CompilerWarnings.cmake

@@ -36,12 +36,16 @@ function(set_project_warnings project_name)
       -Wuseless-cast # warn if you perform a cast to the same type
   )
 
+  set(MSVC_WARNINGS "")
+
   if (WARNINGS_AS_ERRORS)
     set(CLANG_WARNINGS ${CLANG_WARNINGS} -Werror)
   endif()
 
   if(CMAKE_CXX_COMPILER_ID STREQUAL "Clang")
     set(PROJECT_WARNINGS ${CLANG_WARNINGS})
+  elseif(CMAKE_CXX_COMPILER_ID STREQUAL "MSVC")
+    set(PROJECT_WARNINGS ${MSVC_WARNINGS})
   else()
     set(PROJECT_WARNINGS ${GCC_WARNINGS})
   endif()