@encharm/cws 4.0.2 → 4.3.0

package/CHANGELOG.md

@@ -1,3 +1,6 @@
+## Released 4.1.0
+* Add support for socket.bufferedAmount
+
 ## Released 4.0.2
 * Add support for Node 16
 

package/LICENSE

@@ -1,11 +1,12 @@
-This software is based on uWebSockets 0.14 which has ZLIB license 
+This software is based on ClusterWS/cWS and before on uWebSockets 0.14 which has ZLIB license 
 make sure to check /src/LICENSE.
 
-For the code provided by cWS:
+For the code provided by cWS (ClusterWS) as well as later by Code Charm:
 
 MIT License
 
 Copyright (c) 2018 cWS
+              2021 Code Charm
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -6,7 +6,7 @@
 * **Consider using latest version of uWebSockets if you do not need compatibility with ws or a multi-process architecture.**
 
 * This repository is a fork of [ClusterWS/cWS](https://github.com/ClusterWS/cWS)
-* Prior, this repository was a fork of [uWebSockets v0.14](https://github.com/uNetworking/uWebSockets/tree/v0.14) therefore has two licence [MIT](https://github.com/ClusterWS/uWS/blob/master/LICENSE) and [ZLIB](https://github.com/ClusterWS/uWS/blob/master/src/LICENSE)
+* Prior, this repository was a fork of [uWebSockets v0.14](https://github.com/uNetworking/uWebSockets/tree/v0.14) therefore has two licence [MIT](https://github.com/encharm/cWS/blob/master/LICENSE) and [ZLIB](https://github.com/encharm/cWS/blob/master/src/LICENSE)
 
 ## Supported Node Versions (SSL)
 
@@ -14,7 +14,8 @@ This table is true if you run ssl directly with `cws` (`Node.js`). In case if yo
 
 |  CWS Version | Node 10  | Node 11 | Node 12          |  Node 13  | Node 14 | Node 16  |
 |--------------|----------|---------|------------------|-----------|---------|----------|
-| 4.0.0        | >=10.0   |    X    | >=12.16          | >=13.9    | >=14.5  | >= 16.11 |
+| 4.x.x        | >=10.0   |    X    | >=12.16          | >=13.9    | >=14.5  | >= 16.11 |
+| *The versions below are available via @clusterws/cws*                                   |
 | 3.0.0        | >=10.0   |    X    | >=12.16          | >=13.9    | >=14.5  |    X     |
 | 2.0.0        | >=10.0   |    X    | >=12.16          | >=13.9    |   X     |    X     |
 | 1.6.0        | >=10.0   | >=11.0  | >=12.0 & <12.16  | >=13.9    |   X     |    X     |
@@ -136,6 +137,12 @@ if(socket.readyState === socket.OPEN) {}
 if(socket.readyState === socket.CLOSED) {}
 ```
 
+To find out number of buffered (and not yet sent) bytes:
+```js
+socket.bufferedAmount;
+// useful for implementing back-pressure
+```
+
 To get addresses use `_socket` getter:
 ```js
 socket._socket;

package/binding.gyp

@@ -64,7 +64,7 @@
                             'outputs': [
                                 'cws'
                             ],
-                            'action': ['cp', '<@(PRODUCT_DIR)/cws.node', 'dist/bindings/cws_<!@(node -p process.platform)_<!@(node -p process.versions.modules).node']
+                            'action': ['cp', '<@(PRODUCT_DIR)/cws.node', 'dist/bindings/cws_<!@(node -p process.platform)_<!@(node -p process.arch)_node<!@(node -p process.versions.modules).node']
                         }
                     ]}
                  ],
@@ -78,7 +78,7 @@
                             'outputs': [
                                 'cws'
                             ],
-                            'action': ['copy', '<@(PRODUCT_DIR)/cws.node', 'dist/bindings/cws_<!@(node -p process.platform)_<!@(node -p process.versions.modules).node']
+                            'action': ['copy', '<@(PRODUCT_DIR)/cws.node', 'cws_<!@(node -p process.platform)_<!@(node -p process.arch)_node<!@(node -p process.versions.modules).node']
                         }
                     ]}
                  ]

package/dist/client.d.ts

@@ -13,6 +13,7 @@ export declare class WebSocket {
     private external;
     private socketType;
     constructor(url: string, options?: any);
+    get bufferedAmount(): number;
     get _socket(): SocketAddress;
     get readyState(): number;
     set onopen(listener: () => void);

package/dist/client.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocket = void 0;
 const server_1 = require("./server");
 const shared_1 = require("./shared");
 const clientGroup = shared_1.native.client.group.create(0, shared_1.DEFAULT_PAYLOAD_LIMIT);
@@ -27,6 +28,9 @@ class WebSocket {
             shared_1.native.connect(clientGroup, url, this);
         }
     }
+    get bufferedAmount() {
+        return this.external ? shared_1.native.getBufferedAmount(this.external) : 0;
+    }
     get _socket() {
         const address = this.external ? shared_1.native.getAddress(this.external) : new Array(3);
         return {

package/dist/index.js

@@ -1,7 +1,8 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.secureProtocol = void 0;
 var client_1 = require("./client");
-exports.WebSocket = client_1.WebSocket;
+Object.defineProperty(exports, "WebSocket", { enumerable: true, get: function () { return client_1.WebSocket; } });
 var server_1 = require("./server");
-exports.WebSocketServer = server_1.WebSocketServer;
+Object.defineProperty(exports, "WebSocketServer", { enumerable: true, get: function () { return server_1.WebSocketServer; } });
 exports.secureProtocol = 'TLSv1_2_method';

package/dist/server.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.WebSocketServer = void 0;
 const HTTP = require("http");
 const shared_1 = require("./shared");
 class WebSocketServer {

package/dist/shared.js

@@ -1,5 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.setupNative = exports.native = exports.DEFAULT_PAYLOAD_LIMIT = exports.SLIDING_DEFLATE_WINDOW = exports.PERMESSAGE_DEFLATE = exports.APP_PING_CODE = exports.OPCODE_BINARY = exports.OPCODE_PING = exports.OPCODE_TEXT = exports.noop = void 0;
 const client_1 = require("./client");
 exports.noop = () => { };
 exports.OPCODE_TEXT = 1;
@@ -11,7 +12,7 @@ exports.SLIDING_DEFLATE_WINDOW = 16;
 exports.DEFAULT_PAYLOAD_LIMIT = 16777216;
 exports.native = (() => {
     try {
-        return require(`../dist/bindings/cws_${process.platform}_${process.versions.modules}`);
+        return require(`../dist/bindings/cws_${process.platform}_${process.arch}_node${process.versions.modules}`);
     }
     catch (err) {
         err.message = err.message + ` check './node_modules/@clusterws/cws/build_log.txt' for post install build logs`;

package/package.json

@@ -1,6 +1,6 @@
  {
   "name": "@encharm/cws",
-  "version": "4.0.2",
+  "version": "4.3.0",
   "main": "./dist/index.js",
   "types": "./dist/index.d.ts",
   "description": "cWS - fast C++ WebSocket implementation for Node.js",

package/src/Addon.cpp

@@ -18,6 +18,7 @@ void Initialize(Local<Object> exports) {
   #endif
 
   NODE_SET_METHOD(exports, "getSSLContext", getSSLContext);
+  NODE_SET_METHOD(exports, "getBufferedAmount", getBufferedAmount<cWS::SERVER>);
   NODE_SET_METHOD(exports, "setUserData", setUserData<cWS::SERVER>);
   NODE_SET_METHOD(exports, "getUserData", getUserData<cWS::SERVER>);
   NODE_SET_METHOD(exports, "clearUserData", clearUserData<cWS::SERVER>);

package/src/Addon.h

@@ -32,8 +32,13 @@
   #include "headers/16/base_object-inl.h"
 #endif
 
+#if NODE_MAJOR_VERSION==18
+  #include "headers/18/crypto/crypto_tls.h"
+  #include "headers/18/base_object-inl.h"
+#endif
+
 using BaseObject = node::BaseObject;
-#if NODE_MAJOR_VERSION==16
+#if NODE_MAJOR_VERSION==16 || NODE_MAJOR_VERSION==18
 using TLSWrap = node::crypto::TLSWrap;
 #else
 using TLSWrap = node::TLSWrap;
@@ -125,14 +130,26 @@ class NativeString {
     } else if (value->IsTypedArray()) {
       Local<ArrayBufferView> arrayBufferView =
           Local<ArrayBufferView>::Cast(value);
+#if NODE_MAJOR_VERSION == 18
+      std::shared_ptr<v8::BackingStore> contents = arrayBufferView->Buffer()->GetBackingStore();
+      length = arrayBufferView->ByteLength();
+      data = (char *)contents->Data();
+#else
       ArrayBuffer::Contents contents = arrayBufferView->Buffer()->GetContents();
       length = contents.ByteLength();
       data = (char *)contents.Data();
+#endif
     } else if (value->IsArrayBuffer()) {
       Local<ArrayBuffer> arrayBuffer = Local<ArrayBuffer>::Cast(value);
+#if NODE_MAJOR_VERSION == 18
+      std::shared_ptr<v8::BackingStore> contents = arrayBuffer->GetBackingStore();
+      length = arrayBuffer->ByteLength();
+      data = (char *)contents->Data();
+#else
       ArrayBuffer::Contents contents = arrayBuffer->GetContents();
       length = contents.ByteLength();
       data = (char *)contents.Data();
+#endif
     } else {
       static char empty[] = "";
       data = empty;
@@ -187,7 +204,12 @@ inline Local<Value> wrapMessage(const char *message, size_t length,
                                 cWS::OpCode opCode, Isolate *isolate) {
 
   if (opCode == cWS::OpCode::BINARY) {
-    return (Local<Value>)ArrayBuffer::New(isolate, (char *)message, length);
+    // return (Local<Value>)ArrayBuffer::New(isolate, (char *)message, length);
+    std::unique_ptr<v8::BackingStore> backing = v8::ArrayBuffer::NewBackingStore((char*)message,
+                                       length,
+                                       [](void*, size_t, void*){},
+                                       nullptr);
+    return (Local<Value>)v8::ArrayBuffer::New(isolate, std::move(backing));
   }
 
   #if NODE_MAJOR_VERSION >= 13
@@ -206,6 +228,17 @@ inline Local<Value> getDataV8(cWS::WebSocket<isServer> *webSocket,
              : Local<Value>::Cast(Undefined(isolate));
 }
 
+
+template <bool isServer>
+void getBufferedAmount(const FunctionCallbackInfo<Value> &args) {
+  cWS::WebSocket<isServer> *webSocket =
+    unwrapSocket<isServer>(args[0].As<External>());
+
+  args.GetReturnValue().Set(
+    Integer::NewFromUnsigned(args.GetIsolate(), webSocket->getBufferedAmount())
+  );
+}
+
 template <bool isServer>
 void getUserData(const FunctionCallbackInfo<Value> &args) {
   args.GetReturnValue().Set(getDataV8(

package/src/HTTPSocket.cpp

@@ -247,7 +247,7 @@ void HttpSocket<isServer>::upgrade(const char *secKey, const char *extensions, s
             memcpy(upgradeBuffer + upgradeResponseLength + 24 + subprotocolLength, "\r\n", 2);
             upgradeResponseLength += 24 + subprotocolLength + 2;
         }
-        static char stamp[] = "Sec-WebSocket-Version: 13\r\nWebSocket-Server: cWebSockets\r\n\r\n";
+        static char stamp[] = "Sec-WebSocket-Version: 13\r\n\r\n";
         memcpy(upgradeBuffer + upgradeResponseLength, stamp, sizeof(stamp) - 1);
         upgradeResponseLength += sizeof(stamp) - 1;
 

package/src/LICENSE

@@ -1,3 +1,7 @@
+Code Charm notice:
+
+This software is a modified fork of ClusterWS/cWS. THe original software is available at https://github.com/ClusterWS/cWS
+
 ClusterWS notice:
 
 This software is modified fork of uWebSockets the original software 

package/src/Socket.h

@@ -22,14 +22,13 @@ struct TransferData {
     void (*transferCb)(Poll *);
 };
 
-// perfectly 64 bytes (4 + 60)
+// perfectly 64 bytes (4 + 60) (only for EPoll and if packed)
 struct WIN32_EXPORT Socket : Poll {
-protected:
     struct {
         int poll : 4;
         int shuttingDown : 4;
     } state = {0, false};
-
+protected:
     SSL *ssl;
     void *user = nullptr;
     NodeData *nodeData;
@@ -45,15 +44,19 @@ protected:
         };
 
         Message *head = nullptr, *tail = nullptr;
+        size_t totalLength = 0;
+
         void pop()
         {
             Message *nextMessage;
             if ((nextMessage = head->nextMessage)) {
+                totalLength -= head->length;
                 delete [] (char *) head;
                 head = nextMessage;
             } else {
                 delete [] (char *) head;
                 head = tail = nullptr;
+                totalLength = 0;
             }
         }
 
@@ -70,6 +73,7 @@ protected:
                 head = message;
                 tail = message;
             }
+            totalLength += message->length;
         }
     } messageQueue;
 
@@ -248,6 +252,7 @@ protected:
                         break;
                     } else {
                         messagePtr->length -= sent;
+                        socket->messageQueue.totalLength -= sent;
                         messagePtr->data += sent;
                         break;
                     }
@@ -411,6 +416,10 @@ protected:
     }
 
 public:
+    auto getBufferedAmount() {
+        return messageQueue.totalLength;
+    }
+
     Socket(NodeData *nodeData, Loop *loop, uv_os_sock_t fd, SSL *ssl) : Poll(loop, fd), ssl(ssl), nodeData(nodeData) {
         if (ssl) {
             // OpenSSL treats SOCKETs as int

package/src/headers/{13 → 18}/aliased_buffer.h

@@ -9,6 +9,8 @@
 
 namespace node {
 
+typedef size_t AliasedBufferIndex;
+
 /**
  * Do not use this class directly when creating instances of it - use the
  * Aliased*Array defined at the end of this file instead.
@@ -32,9 +34,15 @@ template <class NativeT,
           typename = std::enable_if_t<std::is_scalar<NativeT>::value>>
 class AliasedBufferBase {
  public:
-  AliasedBufferBase(v8::Isolate* isolate, const size_t count)
-      : isolate_(isolate), count_(count), byte_offset_(0) {
+  AliasedBufferBase(v8::Isolate* isolate,
+                    const size_t count,
+                    const AliasedBufferIndex* index = nullptr)
+      : isolate_(isolate), count_(count), byte_offset_(0), index_(index) {
     CHECK_GT(count, 0);
+    if (index != nullptr) {
+      // Will be deserialized later.
+      return;
+    }
     const v8::HandleScope handle_scope(isolate_);
     const size_t size_in_bytes =
         MultiplyWithOverflowCheck(sizeof(NativeT), count);
@@ -62,10 +70,17 @@ class AliasedBufferBase {
       v8::Isolate* isolate,
       const size_t byte_offset,
       const size_t count,
-      const AliasedBufferBase<uint8_t, v8::Uint8Array>& backing_buffer)
-      : isolate_(isolate), count_(count), byte_offset_(byte_offset) {
+      const AliasedBufferBase<uint8_t, v8::Uint8Array>& backing_buffer,
+      const AliasedBufferIndex* index = nullptr)
+      : isolate_(isolate),
+        count_(count),
+        byte_offset_(byte_offset),
+        index_(index) {
+    if (index != nullptr) {
+      // Will be deserialized later.
+      return;
+    }
     const v8::HandleScope handle_scope(isolate_);
-
     v8::Local<v8::ArrayBuffer> ab = backing_buffer.GetArrayBuffer();
 
     // validate that the byte_offset is aligned with sizeof(NativeT)
@@ -86,10 +101,33 @@ class AliasedBufferBase {
         count_(that.count_),
         byte_offset_(that.byte_offset_),
         buffer_(that.buffer_) {
+    DCHECK_NULL(index_);
     js_array_ = v8::Global<V8T>(that.isolate_, that.GetJSArray());
   }
 
+  AliasedBufferIndex Serialize(v8::Local<v8::Context> context,
+                              v8::SnapshotCreator* creator) {
+    DCHECK_NULL(index_);
+    return creator->AddData(context, GetJSArray());
+  }
+
+  inline void Deserialize(v8::Local<v8::Context> context) {
+    DCHECK_NOT_NULL(index_);
+    v8::Local<V8T> arr =
+        context->GetDataFromSnapshotOnce<V8T>(*index_).ToLocalChecked();
+    // These may not hold true for AliasedBuffers that have grown, so should
+    // be removed when we expand the snapshot support.
+    DCHECK_EQ(count_, arr->Length());
+    DCHECK_EQ(byte_offset_, arr->ByteOffset());
+    uint8_t* raw =
+        static_cast<uint8_t*>(arr->Buffer()->GetBackingStore()->Data());
+    buffer_ = reinterpret_cast<NativeT*>(raw + byte_offset_);
+    js_array_.Reset(isolate_, arr);
+    index_ = nullptr;
+  }
+
   AliasedBufferBase& operator=(AliasedBufferBase&& that) noexcept {
+    DCHECK_NULL(index_);
     this->~AliasedBufferBase();
     isolate_ = that.isolate_;
     count_ = that.count_;
@@ -155,9 +193,15 @@ class AliasedBufferBase {
    *  Get the underlying v8 TypedArray overlayed on top of the native buffer
    */
   v8::Local<V8T> GetJSArray() const {
+    DCHECK_NULL(index_);
     return js_array_.Get(isolate_);
   }
 
+  void Release() {
+    DCHECK_NULL(index_);
+    js_array_.Reset();
+  }
+
   /**
   *  Get the underlying v8::ArrayBuffer underlying the TypedArray and
   *  overlaying the native buffer
@@ -171,6 +215,7 @@ class AliasedBufferBase {
    *  through the GetValue/SetValue/operator[] methods
    */
   inline const NativeT* GetNativeBuffer() const {
+    DCHECK_NULL(index_);
     return buffer_;
   }
 
@@ -186,6 +231,7 @@ class AliasedBufferBase {
    */
   inline void SetValue(const size_t index, NativeT value) {
     DCHECK_LT(index, count_);
+    DCHECK_NULL(index_);
     buffer_[index] = value;
   }
 
@@ -193,6 +239,7 @@ class AliasedBufferBase {
    *  Get value at position index
    */
   inline const NativeT GetValue(const size_t index) const {
+    DCHECK_NULL(index_);
     DCHECK_LT(index, count_);
     return buffer_[index];
   }
@@ -201,6 +248,7 @@ class AliasedBufferBase {
    *  Effectively, a synonym for GetValue/SetValue
    */
   Reference operator[](size_t index) {
+    DCHECK_NULL(index_);
     return Reference(this, index);
   }
 
@@ -216,6 +264,7 @@ class AliasedBufferBase {
   // Should only be used on an owning array, not one created as a sub array of
   // an owning `AliasedBufferBase`.
   void reserve(size_t new_capacity) {
+    DCHECK_NULL(index_);
     DCHECK_GE(new_capacity, count_);
     DCHECK_EQ(byte_offset_, 0);
     const v8::HandleScope handle_scope(isolate_);
@@ -244,11 +293,14 @@ class AliasedBufferBase {
   }
 
  private:
-  v8::Isolate* isolate_;
-  size_t count_;
-  size_t byte_offset_;
-  NativeT* buffer_;
+  v8::Isolate* isolate_ = nullptr;
+  size_t count_ = 0;
+  size_t byte_offset_ = 0;
+  NativeT* buffer_ = nullptr;
   v8::Global<V8T> js_array_;
+
+  // Deserialize data
+  const AliasedBufferIndex* index_ = nullptr;
 };
 
 typedef AliasedBufferBase<int32_t, v8::Int32Array> AliasedInt32Array;

package/src/headers/18/aliased_struct-inl.h

@@ -0,0 +1,54 @@
+#ifndef SRC_ALIASED_STRUCT_INL_H_
+#define SRC_ALIASED_STRUCT_INL_H_
+
+#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+
+#include "aliased_struct.h"
+#include "v8.h"
+#include <memory>
+
+namespace node {
+
+template <typename T>
+template <typename... Args>
+AliasedStruct<T>::AliasedStruct(v8::Isolate* isolate, Args&&... args)
+    : isolate_(isolate) {
+  const v8::HandleScope handle_scope(isolate);
+
+  store_ = v8::ArrayBuffer::NewBackingStore(isolate, sizeof(T));
+  ptr_ = new (store_->Data()) T(std::forward<Args>(args)...);
+  DCHECK_NOT_NULL(ptr_);
+
+  v8::Local<v8::ArrayBuffer> buffer = v8::ArrayBuffer::New(isolate, store_);
+  buffer_ = v8::Global<v8::ArrayBuffer>(isolate, buffer);
+}
+
+template <typename T>
+AliasedStruct<T>::AliasedStruct(const AliasedStruct& that)
+    : AliasedStruct(that.isolate_, *that) {}
+
+template <typename T>
+AliasedStruct<T>& AliasedStruct<T>::operator=(
+    AliasedStruct<T>&& that) noexcept {
+  this->~AliasedStruct();
+  isolate_ = that.isolate_;
+  store_ = that.store_;
+  ptr_ = that.ptr_;
+
+  buffer_ = std::move(that.buffer_);
+
+  that.ptr_ = nullptr;
+  that.store_.reset();
+  return *this;
+}
+
+template <typename T>
+AliasedStruct<T>::~AliasedStruct() {
+  if (ptr_ != nullptr) ptr_->~T();
+}
+
+}  // namespace node
+
+#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+
+#endif  // SRC_ALIASED_STRUCT_INL_H_

package/src/headers/18/aliased_struct.h

@@ -0,0 +1,63 @@
+#ifndef SRC_ALIASED_STRUCT_H_
+#define SRC_ALIASED_STRUCT_H_
+
+#if defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+
+#include "node_internals.h"
+#include "v8.h"
+#include <memory>
+
+namespace node {
+
+// AliasedStruct is a utility that allows uses a V8 Backing Store
+// to be exposed to the C++/C side as a struct and to the
+// JavaScript side as an ArrayBuffer to efficiently share
+// data without marshalling. It is similar in nature to
+// AliasedBuffer.
+//
+//   struct Foo { int x; }
+//
+//   AliasedStruct<Foo> foo;
+//   foo->x = 1;
+//
+//   Local<ArrayBuffer> ab = foo.GetArrayBuffer();
+template <typename T>
+class AliasedStruct final {
+ public:
+  template <typename... Args>
+  explicit AliasedStruct(v8::Isolate* isolate, Args&&... args);
+
+  inline AliasedStruct(const AliasedStruct& that);
+
+  inline ~AliasedStruct();
+
+  inline AliasedStruct& operator=(AliasedStruct&& that) noexcept;
+
+  v8::Local<v8::ArrayBuffer> GetArrayBuffer() const {
+    return buffer_.Get(isolate_);
+  }
+
+  const T* Data() const { return ptr_; }
+
+  T* Data() { return ptr_; }
+
+  const T& operator*() const { return *ptr_; }
+
+  T& operator*()  { return *ptr_; }
+
+  const T* operator->() const { return ptr_; }
+
+  T* operator->() { return ptr_; }
+
+ private:
+  v8::Isolate* isolate_;
+  std::shared_ptr<v8::BackingStore> store_;
+  T* ptr_;
+  v8::Global<v8::ArrayBuffer> buffer_;
+};
+
+}  // namespace node
+
+#endif  // defined(NODE_WANT_INTERNALS) && NODE_WANT_INTERNALS
+
+#endif  // SRC_ALIASED_STRUCT_H_