Merge pull request #171 from kelvinhammond/upgrade_9.4.0

Upgrade to libzim 9.4.0

Author: kelson42

.env

@@ -1 +1 @@
-LIBZIM_VERSION=9.3.0
+LIBZIM_VERSION=9.4.0

.github/workflows/ci.yml

@@ -14,7 +14,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        os: [ubuntu-22.04, ubuntu-22.04-arm, ubuntu-24.04, ubuntu-24.04-arm, macos-13, macos-14, macos-15]
+        os: [ubuntu-22.04, ubuntu-22.04-arm, ubuntu-24.04, ubuntu-24.04-arm, macos-14, macos-15, macos-15-intel]
         node: [20, 22, 24]
     runs-on: ${{ matrix.os }}
 

README.md

@@ -96,8 +96,44 @@ import { Archive, SuggestionSearcher, Searcher } from "@openzim/libzim";
     delete archive;
 })();
 
+## Local Development
+
+### Important Files
+`.env` - Set environment variables for local development. Only LIBZIM_VERSION for now
+`bindings.gyp` - Node-gyp build configuration file
+`src/` - Source code for the Node.js bindings
+`test/` - Test cases
+
+### Setup
+
+```bash
+git clone git@github.com:openzim/node-libzim.git
+cd node-libzim
+
+# Will install dependencies, download libzim binary and build the bindings
+npm run install
+
+# Required in order for local binding and tests to work.
+export LD_LIBRARY_PATH=$LD_LIBRARY_PATH:$PWD/download/lib/x86_64-linux-gnu
+```
+
+### Iterating during development
+
+Make your changes in `src/` and then run:
+```bash
+node-gyp rebuild --debug -v && npx jest ./test/zim.test.ts
 ```
 
+### Updating libzim version
+To update the libzim version used, change the `LIBZIM_VERSION` variable in
+`.env` file to the desired version and run:
+```bash
+npm run install
+```
+
+If you are upgrading libzim from a major version you will need to edit the `bundle-libzim.js` file
+and change the `libzim.so*` file names to match the new version.
+
 ## License
 
 [GPLv3](https://www.gnu.org/licenses/gpl-3.0) or later, see

binding.gyp

@@ -34,8 +34,8 @@
                 ],
                 "libraries": [
                   "-Wl,-rpath,'$$ORIGIN'",
-                  "-L<(libzim_dir)/lib/aarch64-linux-gnu",
-                  "<(libzim_dir)/lib/aarch64-linux-gnu/libzim.so.9",
+                  "-L<(libzim_dir)/lib/aarch64-rpi3-linux-gnu",
+                  "<(libzim_dir)/lib/aarch64-rpi3-linux-gnu/libzim.so.9",
                 ],
               }],
               ["libzim_local!='true' and OS=='linux' and target_arch=='arm'", {

bundle-libzim.js

@@ -19,7 +19,7 @@ if (isLinux) {
   const rawArch = os.arch();
   let libDir;
   if (rawArch === "arm64") {
-    libDir = "aarch64-linux-gnu";
+    libDir = "aarch64-rpi3-linux-gnu";
   } else if (rawArch === "arm") {
     libDir = "arm-linux-gnueabihf";
   } else {

download-libzim.js

@@ -5,7 +5,6 @@ import { mkdirp } from "mkdirp";
 import exec from "exec-then";
 import os from "os";
 import fs from "fs";
-import urlParser from "url";
 
 mkdirp.sync("./download");
 
@@ -46,7 +45,7 @@ const urls = [
 
 for (let url of urls) {
   console.info(`Downloading Libzim from: `, url);
-  const filename = urlParser.parse(url).pathname.split("/").slice(-1)[0];
+  const filename = new URL(url).pathname.split("/").slice(-1)[0];
   const dlFile = `./download/${filename}`;
 
   try {