Add NodeJS bindings to synapse_auto_compressor

.gitignore

@@ -4,4 +4,5 @@
 *.old
 **.sql
 *.csv
-**.log
+**.log
+.idea/

docs/node.md

@@ -0,0 +1,33 @@
+# Running the compressor tools from nodejs
+
+The automatic compressor tool is available through Node bindings.
+
+Currently, the Node bindings wont produce logging. To see output,
+look at the response array for chunk (room) specific results.
+
+## Requirements
+
+NodeJS 16+
+
+## Setting things up
+
+1. Navigate to the correct location  
+
+`$ cd synapse_auto_compressor`   
+
+2. Build and install the library  
+`$ pnpm i && pnpm build`
+
+## Automatic tool example
+
+```node
+const synapseAutoCompressor = require('synapse_auto_compressor');
+
+synapseAutoCompressor.runCompression(
+    "postgresql://localhost/synapse", 
+    500,
+    100,
+).then(results => {
+    console.log(JSON.stringify(results));
+});
+```

docs/python.md

@@ -4,7 +4,8 @@ Both the automatic and manual tools use PyO3 to allow the compressor
 to be run from Python. 
 
 To see any output from the tools, logging must be setup in Python before
-the compressor is run.
+the compressor is run. You can also inspect the returned list of chunks (rooms)
+for information taken on them.
 
 ## Setting things up
 

synapse_auto_compressor/.gitignore

@@ -0,0 +1,6 @@
+.pnp.*
+.yarn/
+synapse_auto_compressor.*
+index.d.ts
+index.js
+node_modules/

synapse_auto_compressor/Cargo.toml

@@ -14,6 +14,8 @@ clap = { workspace = true, optional = true }
 env_logger.workspace = true
 log-panics.workspace = true
 log.workspace = true
+napi = { version = "3.0.0", optional = true }
+napi-derive = { version = "3.0.0", optional = true }
 openssl.workspace = true
 postgres-openssl.workspace = true
 postgres.workspace = true
@@ -28,11 +30,15 @@ path = "../"
 default-features = false
 features = ["no-progress-bars"]
 
+[build-dependencies]
+napi-build = "2"
+
 # Needed for pyo3 support
 [lib]
 crate-type = ["cdylib", "rlib"]
 
 [features]
 default = ["clap", "jemalloc"]
 jemalloc = ["tikv-jemallocator", "synapse_compress_state/jemalloc"]
+node = ["dep:napi", "dep:napi-derive"]
 pyo3 = ["dep:pyo3", "dep:pyo3-log", "synapse_compress_state/pyo3"]

synapse_auto_compressor/README.md

@@ -10,3 +10,7 @@ Bump the version number and run from the root directory of the repo:
 ```
 docker run -it --rm -v $(pwd):/io -e OPENSSL_STATIC=1 konstin2/maturin publish -m synapse_auto_compressor/Cargo.toml --cargo-extra-args "\--features='openssl/vendored'"
 ```
+
+## Publishing to NPM
+
+TODO TBD

synapse_auto_compressor/build.rs

@@ -0,0 +1,4 @@
+// Build NodeJS bindings
+fn main() {
+    napi_build::setup();
+}

synapse_auto_compressor/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "synapse_auto_compressor",
+  "version": "0.1.4",
+  "description": "A tool to compress some state in a Synapse instance's database",
+  "main": "index.js",
+  "repository": {
+    "type": "git",
+    "url": "git+ssh://git@github.com/matrix-org/rust-synapse-compress-state.git"
+  },
+  "license": "Apache-2.0",
+  "files": [
+    "index.d.ts",
+    "index.js"
+  ],
+  "napi": {
+    "binaryName": "synapse_auto_compressor",
+    "targets": [
+      "x86_64-unknown-linux-gnu"
+    ]
+  },
+  "engines": {
+    "node": ">= 12.22.0 < 13 || >= 14.17.0 < 15 || >= 15.12.0 < 16 || >= 16.0.0",
+    "pnpm": ">=8"
+  },
+  "scripts": {
+    "build": "napi build --features node --platform --release",
+    "build:debug": "napi build --features node --platform"
+  },
+  "devDependencies": {
+    "@napi-rs/cli": "^3.6.2",
+    "typescript": "^6.0.0"
+  }
+}