Merge pull request #53 from launchql/wasm/15-latest

Wasm/15 latest

Author: pyramation

.github/workflows/build-dry-run.yml

@@ -0,0 +1,41 @@
+name: Build Dry Run
+
+on:
+  workflow_dispatch:
+
+jobs:
+  build:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [windows-latest, macos-latest, ubuntu-latest]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Build project
+      run: |
+        yarn
+    - uses: actions/upload-artifact@v2
+      with:
+        name: build-artifact-${{ matrix.os }}
+        path: |
+          ${{ matrix.os == 'macos-latest' && './libpg_query/osx/libpg_query.a' || 
+             matrix.os == 'ubuntu-latest' && './libpg_query/linux/libpg_query.a' || 
+             '' }}
+  prepare-and-publish:
+    needs: build
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/download-artifact@v2
+      with:
+        path: downloaded-artifacts
+    - name: Prepare artifacts
+      run: |
+        # move or prepare artifacts
+        ls downloaded-artifacts/* 
+    # - name: Publish to NPM
+    #   run: |
+    #     # Assuming you've set up your package.json and .npmrc correctly
+    #     npm publish
+      # env:
+        # NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/run-tests.yml

@@ -0,0 +1,26 @@
+name: Run Tests 🧪
+
+on:
+  pull_request:
+    types: [opened, push, reopened]
+  workflow_dispatch:
+
+jobs:
+  run-tests:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository 📥
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js 🌐
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20.x'
+          cache: 'yarn'
+
+      - name: Install Dependencies 🧶
+        run: |
+          yarn
+
+      - name: Test 🔍
+        run: yarn test

.gitignore

@@ -4,3 +4,7 @@ libs/
 npm-debug.log
 libpg_query/**/*.a
 libpg_query/**/*.h
+wasm/libpg-query.js
+*.wasm
+.cache
+libpg_query/windows/*.lib

.travis.yml

@@ -0,0 +1,91 @@
+WASM_OUT_DIR := wasm
+WASM_OUT_NAME := libpg-query
+WASM_MODULE_NAME := PgQueryModule
+LIBPG_QUERY_REPO := https://github.com/pganalyze/libpg_query.git
+LIBPG_QUERY_TAG := 15-4.2.4
+CACHE_DIR := .cache
+
+OS ?= $(shell uname -s)
+ARCH ?= $(shell uname -m)
+
+ifdef EMSCRIPTEN
+PLATFORM := emscripten
+else ifeq ($(OS),Darwin)
+PLATFORM := darwin
+else ifeq ($(OS),Linux)
+PLATFORM := linux
+else
+$(error Unsupported platform: $(OS))
+endif
+
+ifdef EMSCRIPTEN
+ARCH := wasm
+endif
+
+PLATFORM_ARCH := $(PLATFORM)-$(ARCH)
+SRC_FILES := $(wildcard src/*.cc)
+LIBPG_QUERY_DIR := $(CACHE_DIR)/$(PLATFORM_ARCH)/libpg_query/$(LIBPG_QUERY_TAG)
+LIBPG_QUERY_ARCHIVE := $(LIBPG_QUERY_DIR)/libpg_query.a
+LIBPG_QUERY_HEADER := $(LIBPG_QUERY_DIR)/pg_query.h
+CXXFLAGS := -O3
+
+ifdef EMSCRIPTEN
+OUT_FILES := $(foreach EXT,.js .wasm,$(WASM_OUT_DIR)/$(WASM_OUT_NAME)$(EXT))
+else
+OUT_FILES := build/Release/queryparser.node $(wildcard build/*)
+endif
+
+# Clone libpg_query source (lives in CACHE_DIR) 
+$(LIBPG_QUERY_DIR):
+	mkdir -p $(CACHE_DIR)
+	git clone -b $(LIBPG_QUERY_TAG) --single-branch $(LIBPG_QUERY_REPO) $(LIBPG_QUERY_DIR)
+	
+$(LIBPG_QUERY_HEADER): $(LIBPG_QUERY_DIR)
+
+# Build libpg_query
+$(LIBPG_QUERY_ARCHIVE): $(LIBPG_QUERY_DIR)
+	cd $(LIBPG_QUERY_DIR); $(MAKE) build
+
+# Build libpg-query-node (based on platform)
+$(OUT_FILES): $(LIBPG_QUERY_ARCHIVE) $(LIBPG_QUERY_HEADER) $(SRC_FILES)
+ifdef EMSCRIPTEN
+	@ $(CXX) \
+		$(CXXFLAGS) \
+		-DNAPI_HAS_THREADS \
+		-I$(LIBPG_QUERY_DIR) \
+		-I./node_modules/emnapi/include \
+		-I./node_modules/node-addon-api \
+		-L./node_modules/emnapi/lib/wasm32-emscripten \
+		-L$(LIBPG_QUERY_DIR) \
+		--js-library=./node_modules/emnapi/dist/library_napi.js \
+		-sEXPORTED_FUNCTIONS="['_malloc','_free','_napi_register_wasm_v1','_node_api_module_get_api_version_v1']" \
+		-sEXPORT_NAME="$(WASM_MODULE_NAME)" \
+		-sENVIRONMENT="web" \
+		-sMODULARIZE=1 \
+		-sEXPORT_ES6=1 \
+		-fexceptions \
+		-lpg_query \
+		-lemnapi-basic \
+		-o $@ \
+		$(SRC_FILES)
+else
+# if not wasm, defer to node-gyp
+	yarn rebuild
+endif
+
+# Commands
+build: $(OUT_FILES)
+
+build-cache: $(LIBPG_QUERY_ARCHIVE) $(LIBPG_QUERY_HEADER)
+
+rebuild: clean build
+
+rebuild-cache: clean-cache build-cache
+
+clean:
+	-@ rm -r $(OUT_FILES) > /dev/null 2>&1
+
+clean-cache:
+	-@ rm -rf $(LIBPG_QUERY_DIR)
+
+.PHONY: build build-cache rebuild rebuild-cache clean clean-cache

Makefile

@@ -8,14 +8,6 @@
         "src/sync.cc",
         "src/async.cc"
       ],
-      "actions": [
-        {
-          "outputs": ['libpg_query/include/pg_query.h'],
-          "inputs": [],
-          "action": ['script/buildAddon.sh'],
-          "action_name": 'prebuild_dependencies'
-        }
-      ],
       'cflags!': [ '-fno-exceptions' ],
       'cflags_cc!': [ '-fno-exceptions' ],
       'include_dirs': [
@@ -25,22 +17,58 @@
       'dependencies': ["<!(node -p \"require('node-addon-api').gyp\")"],
       'conditions': [
         ['OS=="linux"', {
-          "libraries": [ "-L<!(pwd)/libpg_query/linux", "-lpg_query" ]
+          "libraries": [ "-L<!(pwd)/libpg_query/linux", "-lpg_query" ],
+          "actions": [
+            {
+              "outputs": ['libpg_query/include/pg_query.h'],
+              "inputs": [],
+              "action": ['script/buildAddon.sh'],
+              "action_name": 'prebuild_dependencies'
+            }
+          ],
         }],
         ['OS=="mac"', {
           "libraries": [ "-L<!(pwd)/libpg_query/osx", "-lpg_query" ],
           "xcode_settings": {
             "CLANG_CXX_LIBRARY": "libc++",
             'GCC_ENABLE_CPP_EXCEPTIONS': 'YES',
             'MACOSX_DEPLOYMENT_TARGET': '10.7'
-          }
+          },
+          "actions": [
+            {
+              "outputs": ['libpg_query/include/pg_query.h'],
+              "inputs": [],
+              "action": ['script/buildAddon.sh'],
+              "action_name": 'prebuild_dependencies'
+            }
+          ],
         }],
         ['OS=="win"', {
+          "link_settings": {
+            "library_dirs": [
+              "../libpg_query/windows"
+            ],
+            "libraries": [
+              "../libpg_query/windows/pg_query.lib"
+            ],
+          },
           "msvs_settings": {
             "VCCLCompilerTool": {
-              "ExceptionHandling": 1
+              "ExceptionHandling": 0,
+              "AdditionalOptions": ["/EHsc"]
+            }
+          },
+          "defines": [ "NAPI_DISABLE_CPP_EXCEPTIONS" ],
+          "actions":[
+            {
+              "outputs": [
+                ""
+              ],
+              "inputs": [],
+              "action": ['../script/buildAddon.bat'],
+              "action_name": 'prebuild_dependencies'
             }
-          }
+          ]
         }]
       ]
     }

binding.gyp

@@ -1,4 +1,4 @@
-FROM node:12.18.2-alpine3.11
+FROM node:20-alpine
 RUN apk --no-cache add git
 RUN apk add --no-cache bash
 RUN apk add --no-cache make

docker/Dockerfile

@@ -1,4 +1,4 @@
-const PgQuery = require('./build/Release/queryparser');
+const PgQuery = require('./build/Release/queryparser.node');
 
 module.exports = {
   parseQuery(query) {
@@ -26,14 +26,14 @@ module.exports = {
   },
 
   fingerprint(query) {
-    return new Promise((resolve, reject) =>{
+    return new Promise((resolve, reject) => {
       PgQuery.fingerprintAsync(query, (err, result) => {
         err ? reject(err) : resolve(result);
-      })
+      });
     });
   },
 
   fingerprintSync(query) {
     return PgQuery.fingerprintSync(query);
-  }
+  },
 };

index.js

@@ -2,16 +2,42 @@
   "name": "libpg-query",
   "version": "15.0.3",
   "description": "The real PostgreSQL query parser",
-  "homepage": "https://github.com/pyramation/libpg-query-node",
+  "homepage": "https://github.com/launchql/libpg-query-node",
   "main": "index.js",
   "typings": "index.d.ts",
   "publishConfig": {
     "access": "public"
   },
+  "files": [
+    "binding.gyp",
+    "index.js",
+    "index.d.ts",
+    "libpg_query/*",
+    "script/*",
+    "src/*",
+    "wasm/*"
+  ],
+  "exports": {
+    ".": {
+      "types": "./index.d.ts",
+      "browser": "./wasm/index.js",
+      "node": "./index.js",
+      "default": "./index.js"
+    },
+    "./wasm": {
+      "types": "./index.d.ts",
+      "default": "./wasm/index.js"
+    }
+  },
   "scripts": {
     "configure": "node-pre-gyp configure",
     "install": "node-pre-gyp install --fallback-to-build",
     "rebuild": "node-pre-gyp configure rebuild",
+    "make:wasm": "docker run --rm -v $(pwd):/src -u $(id -u):$(id -g) emscripten/emsdk emmake make",
+    "build:wasm": "yarn make:wasm build",
+    "rebuild:wasm": "yarn make:wasm rebuild",
+    "clean:wasm": "yarn make:wasm clean",
+    "clean-cache:wasm": "yarn make:wasm clean-cache",
     "test": "mocha --timeout 5000",
     "binary:build": "node-pre-gyp rebuild package",
     "binary:publish": "AWS_PROFILE=supabase-dev node-pre-gyp publish"
@@ -20,17 +46,19 @@
   "license": "LICENSE IN LICENSE",
   "repository": {
     "type": "git",
-    "url": "git://github.com/pyramation/libpg-query-node.git"
+    "url": "git://github.com/launchql/libpg-query-node.git"
   },
   "devDependencies": {
     "chai": "^3.5.0",
+    "emnapi": "^0.43.1",
     "lodash": "^4.17.15",
     "mocha": "^5.2.0"
   },
   "dependencies": {
+    "@emnapi/runtime": "^0.43.1",
     "@mapbox/node-pre-gyp": "^1.0.8",
-    "node-addon-api": "^1.6.3",
-    "node-gyp": "^8.0.0"
+    "node-addon-api": "^7.0.0",
+    "node-gyp": "^10.0.1"
   },
   "keywords": [
     "sql",
@@ -47,4 +75,4 @@
     "host": "https://supabase-public-artifacts-bucket.s3.amazonaws.com",
     "remote_path": "./libpg-query-node/"
   }
-}
+}