Merge pull request #546 from Bartel-C8/runtimeElectronCheck

Author: aminya

.gitignore

@@ -21,3 +21,4 @@ test/typings-compatibility/
 /script/*/*.js.map
 tsconfig.tsbuildinfo
 /docs-raw
+.DS_Store

src/incoming_msg.cc

@@ -1,6 +1,7 @@
 /* Copyright (c) 2017-2019 Rolf Timmermans */
 #include "incoming_msg.h"
 
+#include "util/electron_helper.h"
 #include "util/error.h"
 
 namespace zmq {
@@ -14,39 +15,38 @@ IncomingMsg::~IncomingMsg() {
 }
 
 Napi::Value IncomingMsg::IntoBuffer(const Napi::Env& env) {
-#if !(NODE_RUNTIME_ELECTRON && NODE_MODULE_VERSION >= 109)  // 109 is Electron v21 and up
-    if (moved) {
-        /* If ownership has been transferred, do not attempt to read the buffer
-           again in any case. This should not happen of course. */
-        ErrnoException(env, EINVAL).ThrowAsJavaScriptException();
-        return env.Undefined();
+    static auto const noElectronMemoryCage = !hasElectronMemoryCage(env);
+    if (noElectronMemoryCage) {
+        if (moved) {
+            /* If ownership has been transferred, do not attempt to read the buffer
+               again in any case. This should not happen of course. */
+            ErrnoException(env, EINVAL).ThrowAsJavaScriptException();
+            return env.Undefined();
+        }
     }
-
-    static auto constexpr zero_copy_threshold = 1 << 7;
-#endif
-
     auto data = reinterpret_cast<uint8_t*>(zmq_msg_data(*ref));
     auto length = zmq_msg_size(*ref);
 
-#if !(NODE_RUNTIME_ELECTRON && NODE_MODULE_VERSION >= 109)  // 109 is Electron v21 and up
-    if (length > zero_copy_threshold) {
-        /* Reuse existing buffer for external storage. This avoids copying but
-           does include an overhead in having to call a finalizer when the
-           buffer is GC'ed. For very small messages it is faster to copy. */
-        moved = true;
+    if (noElectronMemoryCage) {
+        static auto constexpr zero_copy_threshold = 1 << 7;
+        if (length > zero_copy_threshold) {
+            /* Reuse existing buffer for external storage. This avoids copying but
+               does include an overhead in having to call a finalizer when the
+               buffer is GC'ed. For very small messages it is faster to copy. */
+            moved = true;
 
-        /* Put appropriate GC pressure according to the size of the buffer. */
-        Napi::MemoryManagement::AdjustExternalMemory(env, length);
+            /* Put appropriate GC pressure according to the size of the buffer. */
+            Napi::MemoryManagement::AdjustExternalMemory(env, length);
 
-        auto release = [](const Napi::Env& env, uint8_t*, Reference* ref) {
-            ptrdiff_t length = zmq_msg_size(*ref);
-            Napi::MemoryManagement::AdjustExternalMemory(env, -length);
-            delete ref;
-        };
+            auto release = [](const Napi::Env& env, uint8_t*, Reference* ref) {
+                ptrdiff_t length = zmq_msg_size(*ref);
+                Napi::MemoryManagement::AdjustExternalMemory(env, -length);
+                delete ref;
+            };
 
-        return Napi::Buffer<uint8_t>::New(env, data, length, release, ref);
+            return Napi::Buffer<uint8_t>::New(env, data, length, release, ref);
+        }
     }
-#endif
 
     if (length > 0) {
         return Napi::Buffer<uint8_t>::Copy(env, data, length);

src/util/electron_helper.h

@@ -0,0 +1,46 @@
+#pragma once
+
+#include <napi.h>
+#include <string>
+
+namespace zmq {
+bool hasRun = false;
+bool hasElectronMemoryCageCache = false;
+
+static inline std::string first_component(std::string const& value) {
+    std::string::size_type pos = value.find('.');
+    return pos == value.npos ? value : value.substr(0, pos);
+}
+
+/* Check if runtime is Electron. */
+static inline bool IsElectron(const Napi::Env& env) {
+    auto global = env.Global();
+    auto isElectron = global.Get("process")
+                          .As<Napi::Object>()
+                          .Get("versions")
+                          .As<Napi::Object>()
+                          .Has("electron");
+    return isElectron;
+}
+
+static inline bool hasElectronMemoryCage(const Napi::Env& env) {
+    if (!hasRun) {
+        if (IsElectron(env)) {
+            auto electronVers = env.Global()
+                                    .Get("process")
+                                    .ToObject()
+                                    .Get("versions")
+                                    .ToObject()
+                                    .Get("electron")
+                                    .ToString()
+                                    .Utf8Value();
+            int majorVer = stoi(first_component(electronVers));
+            if (majorVer >= 21) {
+                hasElectronMemoryCageCache = true;
+            }
+        }
+        hasRun = true;
+    }
+    return hasElectronMemoryCageCache;
+}
+}