@ohos-ports/514labs-kafka-javascript 0.0.0-stage → 1.7.1-patch-beta.0

package/deps/librdkafka.gyp

@@ -0,0 +1,83 @@
+{
+  "variables": {
+    "CKJS_LINKING%": "<!(node ../util/get-env.js CKJS_LINKING static)",
+  },
+  'targets': [
+    {
+      "target_name": "librdkafka",
+      "type": "none",
+      "conditions": [
+        [
+          'OS=="win"',
+          {
+          },
+          {
+            "actions": [
+              {
+                "action_name": "configure",
+                "inputs": [],
+                "outputs": [
+                  "librdkafka/config.h",
+                ],
+                "action": [
+                  "node", "../util/configure"
+                ]
+              },
+              {
+                "action_name": "build_dependencies",
+                "inputs": [
+                  "librdkafka/config.h",
+                ],
+                "outputs": [
+                  "deps/librdkafka/src/librdkafka.so",
+                ],
+                "action": [
+                  "make", "-j", "-C", "librdkafka", "libs", "install-subdirs"
+                ],
+                "conditions": [
+                  [
+                    'CKJS_LINKING=="dynamic"',
+                    {
+                      "conditions": [
+                        [
+                          'OS=="mac"',
+                          {
+                            'outputs': [
+                              'deps/librdkafka/src-cpp/librdkafka++.dylib',
+                              'deps/librdkafka/src-cpp/librdkafka++.1.dylib',
+                              'deps/librdkafka/src/librdkafka.dylib',
+                              'deps/librdkafka/src/librdkafka.1.dylib',
+                              'deps/librdkafka/src-cpp/librdkafka++.a',
+                              'deps/librdkafka/src/librdkafka.a',
+                            ]
+                          },
+                          {
+                            'outputs': [
+                              'deps/librdkafka/src-cpp/librdkafka++.so',
+                              'deps/librdkafka/src-cpp/librdkafka++.so.1',
+                              'deps/librdkafka/src/librdkafka.so',
+                              'deps/librdkafka/src/librdkafka.so.1',
+                              'deps/librdkafka/src-cpp/librdkafka++.a',
+                              'deps/librdkafka/src/librdkafka.a',
+                            ],
+                          },
+                        ],
+                      ]
+                    },
+                    {
+                      'outputs': [
+                        'deps/librdkafka/src-cpp/librdkafka++.a',
+                        'deps/librdkafka/src/librdkafka-static.a',
+                      ],
+                    }
+                  ],
+                ],
+              }
+            ]
+          }
+
+        ]
+      ]
+    }
+  ]
+}

package/deps/windows-install.py

@@ -0,0 +1,80 @@
+librdkafkaVersion = ''
+# read librdkafka version from package.json
+import json
+import os
+import glob
+
+# Note: we're using the key 'librdkafka_win' for now since NuGet packages are not
+# available for librdkafka on master. This will be changed to 'librdkafka' once
+# we're out of early access, and we use the latest version of librdkafka rather
+# than master.
+with open('../package.json') as f:
+    librdkafkaVersion = json.load(f)['librdkafka_win']
+librdkafkaWinSufix = '7' if librdkafkaVersion == '0.11.5' else '';
+
+depsPrecompiledDir = '../deps/precompiled'
+depsIncludeDir = '../deps/include'
+buildReleaseDir = 'Release'
+
+# Use publicly documented API to download librdkafka NuGet package.
+# https://api.nuget.org/v3-flatcontainer/{package}/{version}/{package}.{version}.nupkg
+# See https://learn.microsoft.com/en-us/nuget/api/package-base-address-resource#download-package-content-nupkg
+env_dist = os.environ
+downloadBaseUrl = env_dist['NODE_RDKAFKA_NUGET_BASE_URL'] if 'NODE_RDKAFKA_NUGET_BASE_URL' in env_dist else 'https://api.nuget.org/v3-flatcontainer/librdkafka.redist/{version}/'
+librdkafkaNugetUrl = downloadBaseUrl + 'librdkafka.redist.{version}.nupkg'
+librdkafkaNugetUrl = librdkafkaNugetUrl.format(version=librdkafkaVersion.lower())
+print('download librdkafka form ' + librdkafkaNugetUrl)
+outputDir = 'librdkafka.redist'
+outputFile = outputDir + '.zip'
+dllPath = outputDir + '/runtimes/win{}-x64/native'.format(librdkafkaWinSufix)
+libPath = outputDir + '/build/native/lib/win{}/x64/win{}-x64-Release/v142'.format(librdkafkaWinSufix, librdkafkaWinSufix)
+includePath = outputDir + '/build/native/include/librdkafka'
+
+# download librdkafka from nuget
+try:
+    # For Python 3.0 and later
+    from urllib.request import urlopen
+except ImportError:
+    # Fall back to Python 2's urllib2
+    from urllib2 import urlopen
+import ssl
+
+filedata = urlopen(librdkafkaNugetUrl, context=ssl._create_unverified_context())
+
+datatowrite = filedata.read()
+with open(outputFile, 'wb') as f:
+    f.write(datatowrite)
+
+# extract package
+import zipfile
+zip_ref = zipfile.ZipFile(outputFile, 'r')
+zip_ref.extractall(outputDir)
+zip_ref.close()
+
+# copy files
+import shutil, os, errno
+
+def createdir(dir):
+    try:
+        os.makedirs(dir)
+    except OSError as e:
+        if errno.EEXIST != e.errno:
+            raise
+
+createdir(depsPrecompiledDir)
+createdir(depsIncludeDir)
+createdir(buildReleaseDir)
+
+shutil.copy2(libPath + '/librdkafka.lib', depsPrecompiledDir)
+shutil.copy2(libPath + '/librdkafkacpp.lib', depsPrecompiledDir)
+
+shutil.copy2(includePath + '/rdkafka.h', depsIncludeDir)
+shutil.copy2(includePath + '/rdkafkacpp.h', depsIncludeDir)
+
+# copy all the required dlls
+for filename in glob.glob(os.path.join(dllPath, '*.dll')):
+  shutil.copy2(filename, buildReleaseDir)
+
+# clean up
+os.remove(outputFile)
+shutil.rmtree(outputDir)

package/eslint.config.js

@@ -0,0 +1,75 @@
+const js = require("@eslint/js");
+const jest = require('eslint-plugin-jest');
+const ts = require('typescript-eslint');
+const tsdoc = require('eslint-plugin-tsdoc');
+
+const ckjsSpecificSettings = {
+    languageOptions: {
+        globals: {
+            "require": "readonly",
+            "module": "writable",
+            "setImmediate": "readonly",
+            "setTimeout": "readonly",
+            "clearTimeout": "readonly",
+            "setInterval": "readonly",
+            "clearInterval": "readonly",
+            "console": "readonly"
+        }
+    },
+    "rules": {
+        "eqeqeq": ["error", "always"],
+        "no-use-before-define": ["error", "nofunc"],
+        "no-caller": "error",
+        "no-new": "error",
+        "no-eq-null": "error",
+        "no-trailing-spaces": "error",
+        "no-constant-condition": "off",
+        "semi": "error"
+    }
+};
+
+const ckjsSpecificJestSettings = {
+    "rules": {
+       "jest/no-disabled-tests": "off",
+       "jest/no-conditional-expect": "off",
+    }
+};
+
+module.exports = ts.config(
+    {
+        ignores: ["**/dist/"]
+    },
+    {
+        ...js.configs.recommended,
+        files: ["lib/**/*.js", "test/promisified/**/*.js"],
+        ignores: []
+    },
+    {
+        ...ckjsSpecificSettings,
+        files: ["lib/**/*.js", "test/promisified/**/*.js"],
+        ignores: []
+    },
+    {
+        ...jest.configs['flat/recommended'],
+        files: ["test/promisified/**/*.js"]
+    },
+    {
+        ...ckjsSpecificJestSettings,
+        files: ["test/promisified/**/*.js"]
+    },
+    ...ts.configs.recommended.map((config) => ({
+        ...config,
+        ignores: ["**/*.js", "types/rdkafka.d.ts", "types/kafkajs.d.ts", "types/config.d.ts"],
+        plugins: {
+            "@typescript-eslint": ts.plugin,
+            tsdoc,
+        },
+        rules: {
+            ...config.rules,
+            "prefer-const": "warn",
+            "@typescript-eslint/no-explicit-any": "warn",
+            "@typescript-eslint/no-unused-vars": "warn",
+            "tsdoc/syntax": "warn",
+        }
+    })),
+);

package/flake.lock

@@ -0,0 +1,61 @@
+{
+  "nodes": {
+    "flake-utils": {
+      "inputs": {
+        "systems": "systems"
+      },
+      "locked": {
+        "lastModified": 1731533236,
+        "narHash": "sha256-l0KFg5HjrsfsO/JpG+r7fRrqm12kzFHyUHqHCVpMMbI=",
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "rev": "11707dc2f618dd54ca8739b309ec4fc024de578b",
+        "type": "github"
+      },
+      "original": {
+        "owner": "numtide",
+        "repo": "flake-utils",
+        "type": "github"
+      }
+    },
+    "nixpkgs": {
+      "locked": {
+        "lastModified": 1765186076,
+        "narHash": "sha256-hM20uyap1a0M9d344I692r+ik4gTMyj60cQWO+hAYP8=",
+        "owner": "NixOS",
+        "repo": "nixpkgs",
+        "rev": "addf7cf5f383a3101ecfba091b98d0a1263dc9b8",
+        "type": "github"
+      },
+      "original": {
+        "owner": "NixOS",
+        "ref": "nixos-unstable",
+        "repo": "nixpkgs",
+        "type": "github"
+      }
+    },
+    "root": {
+      "inputs": {
+        "flake-utils": "flake-utils",
+        "nixpkgs": "nixpkgs"
+      }
+    },
+    "systems": {
+      "locked": {
+        "lastModified": 1681028828,
+        "narHash": "sha256-Vy1rq5AaRuLzOxct8nz4T6wlgyUR7zLU309k9mBC768=",
+        "owner": "nix-systems",
+        "repo": "default",
+        "rev": "da67096a3b9bf56a91d16901293e51ba5b49a27e",
+        "type": "github"
+      },
+      "original": {
+        "owner": "nix-systems",
+        "repo": "default",
+        "type": "github"
+      }
+    }
+  },
+  "root": "root",
+  "version": 7
+}

package/flake.nix

@@ -0,0 +1,76 @@
+{
+  description = "Confluent Kafka JavaScript - Node.js bindings for librdkafka";
+
+  inputs = {
+    nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
+    flake-utils.url = "github:numtide/flake-utils";
+  };
+
+  outputs = { self, nixpkgs, flake-utils }:
+    flake-utils.lib.eachDefaultSystem (system:
+      let
+        pkgs = nixpkgs.legacyPackages.${system};
+      in
+      {
+        devShells.default = pkgs.mkShell {
+          buildInputs = with pkgs; [
+            # Node.js and package manager
+            nodejs_20
+
+            # Python for node-gyp
+            python3
+
+            # Build tools
+            gnumake
+            gcc
+            pkg-config
+
+            # librdkafka and dependencies
+            rdkafka
+
+            # Additional build dependencies
+            cyrus_sasl
+            openssl
+            zlib
+            zstd
+            lz4
+
+            # Git for version control
+            git
+          ];
+
+          shellHook = ''
+            echo "Confluent Kafka JavaScript Development Environment"
+            echo ""
+            echo "Node.js version: $(node --version)"
+            echo "npm version: $(npm --version)"
+            echo "Python version: $(python3 --version)"
+            echo ""
+            echo "Available commands:"
+            echo "  npm ci                 - Install dependencies"
+            echo "  npm run configure      - Configure native build"
+            echo "  npm run build          - Build native addon"
+            echo "  npm test               - Run tests"
+            echo "  make lint              - Run linters"
+            echo "  make test              - Run mocha tests"
+            echo "  make promisified_test  - Run jest tests"
+            echo ""
+            echo "First time setup:"
+            echo "  1. npm ci"
+            echo "  2. npm run build"
+            echo "  3. npm test"
+            echo ""
+
+            # Set up environment for node-gyp
+            export PYTHON="${pkgs.python3}/bin/python3"
+
+            # Help node-gyp find librdkafka
+            export PKG_CONFIG_PATH="${pkgs.rdkafka}/lib/pkgconfig:$PKG_CONFIG_PATH"
+            export CPLUS_INCLUDE_PATH="${pkgs.rdkafka}/include:$CPLUS_INCLUDE_PATH"
+            export LIBRARY_PATH="${pkgs.rdkafka}/lib:$LIBRARY_PATH"
+            export LD_LIBRARY_PATH="${pkgs.rdkafka}/lib:$LD_LIBRARY_PATH"
+          '';
+        };
+      }
+    );
+}

package/index.d.ts

@@ -0,0 +1,3 @@
+export * from './types/rdkafka';
+export * as RdKafka from './types/rdkafka';
+export * as KafkaJS from './types/kafkajs';

package/jest.config.js

@@ -0,0 +1,8 @@
+module.exports = {
+    transform: {
+      '^.+\\.tsx?$': 'ts-jest',
+    },
+    "collectCoverage": true,
+    "coverageReporters": ['json', 'text', 'html'],
+    "coverageDirectory": 'coverage/jest/',
+  };

package/jsdoc.conf

@@ -0,0 +1,23 @@
+{
+    "plugins": [
+        "plugins/markdown"
+    ],
+    "recurseDepth": 10,
+    "source": {
+        "include": ["lib"],
+        "exclude": ["lib/kafkajs/_common.js"],
+        "includePattern": ".+\\.js?$",
+        "excludePattern": ""
+    },
+    "sourceType": "module",
+    "tags": {
+        "allowUnknownTags": true,
+        "dictionaries": ["jsdoc","closure"]
+    },
+    "templates": {
+        "default": {
+            "useLongnameInNav": true,
+            "outputSourceFiles": false
+        }
+    }
+}