Merge branch 'rename-win-shortcuts'

Author: dlon

CHANGELOG.md

@@ -22,6 +22,10 @@ Line wrap the file at 100 chars.                                              Th
 * **Security**: in case of vulnerabilities.
 
 ## [Unreleased]
+### Changed
+#### Windows
+- Rename `win-shortcuts` native module to `windows-utils`.
+
 ### Removed
 - Remove "Any" option for tunnel protocol. The default is now WireGuard.
 

Cargo.lock

@@ -11,7 +11,7 @@ resolver = "2"
 members = [
   "android/translations-converter",
   "desktop/packages/nseventforwarder",
-  "desktop/packages/win-shortcuts",
+  "desktop/packages/windows-utils",
   "mullvad-api",
   "mullvad-cli",
   "mullvad-daemon",

Cargo.toml

@@ -41,7 +41,7 @@ task(
     'clean',
     'set-dev-env',
     scripts.buildNseventforwarder,
-    scripts.buildWinShortcuts,
+    scripts.buildWindowsUtils,
     watch.start,
   ),
 );

desktop/package-lock.json

@@ -28,7 +28,7 @@
     "simple-plist": "^1.3.1",
     "sprintf-js": "^1.1.2",
     "styled-components": "^6.1.13",
-    "win-shortcuts": "0.0.0"
+    "windows-utils": "0.0.0"
   },
   "devDependencies": {
     "@playwright/test": "^1.41.1",

desktop/packages/mullvad-vpn/gulpfile.js

@@ -1,7 +1,7 @@
 import { app } from 'electron';
 import fs from 'fs';
 import path from 'path';
-import { readShortcut } from 'win-shortcuts';
+import { readShortcut } from 'windows-utils';
 
 import {
   ISplitTunnelingApplication,

desktop/packages/mullvad-vpn/package.json

@@ -57,7 +57,7 @@ function newConfig() {
       '!node_modules/grpc-tools',
       '!node_modules/@types',
       '!node_modules/nseventforwarder/debug',
-      '!node_modules/win-shortcuts/debug',
+      '!node_modules/windows-utils/debug',
     ],
 
     // Make sure that all files declared in "extraResources" exists and abort if they don't.
@@ -291,15 +291,15 @@ async function packWin() {
             process.env.TARGET_SUBDIR = 'x86_64-pc-windows-msvc';
             process.env.DIST_SUBDIR = '';
 
-            execFileSync('npm', ['-w', 'win-shortcuts', 'run', 'build-x86'], { shell: true });
+            execFileSync('npm', ['-w', 'windows-utils', 'run', 'build-x86'], { shell: true });
             break;
           case 'arm64':
             process.env.TARGET_TRIPLE = 'aarch64-pc-windows-msvc';
             process.env.SETUP_SUBDIR = 'aarch64-pc-windows-msvc';
             process.env.TARGET_SUBDIR = 'aarch64-pc-windows-msvc';
             process.env.DIST_SUBDIR = 'aarch64-pc-windows-msvc';
 
-            execFileSync('npm', ['-w', 'win-shortcuts', 'run', 'build-arm'], { shell: true });
+            execFileSync('npm', ['-w', 'windows-utils', 'run', 'build-arm'], { shell: true });
             break;
           default:
             throw new Error('Invalid or unknown target (only one may be specified)');

desktop/packages/mullvad-vpn/src/main/windows-split-tunneling.ts

@@ -117,22 +117,22 @@ function buildNseventforwarder(callback) {
   }
 }
 
-function buildWinShortcuts(callback) {
+function buildWindowsUtils(callback) {
   if (process.platform === 'win32') {
-    exec('npm -w win-shortcuts run build-debug', (err) => callback(err));
+    exec('npm -w windows-utils run build-debug', (err) => callback(err));
   } else {
     callback();
   }
 }
 
 compileScripts.displayName = 'compile-scripts';
 buildNseventforwarder.displayName = 'build-nseventforwarder';
-buildWinShortcuts.displayName = 'build-win-shortcuts';
+buildWindowsUtils.displayName = 'build-windows-utils';
 
 exports.build = series(
   compileScripts,
   parallel(makeBrowserifyPreload(false), makeBrowserifyRenderer(false)),
 );
 exports.buildNseventforwarder = buildNseventforwarder;
-exports.buildWinShortcuts = buildWinShortcuts;
+exports.buildWindowsUtils = buildWindowsUtils;
 exports.makeWatchCompiler = makeWatchCompiler;

desktop/packages/mullvad-vpn/tasks/distribution.js

@@ -74,7 +74,7 @@ const viteConfig = defineConfig({
                 // Packages in workspace which exports common js
                 /management-interface/,
                 /nseventforwarder/,
-                /win-shortcuts/,
+                /windows-utils/,
                 // External dependencies which exports common js
                 /node_modules/,
               ],
@@ -87,7 +87,7 @@ const viteConfig = defineConfig({
               },
               external: [
                 // Packages in workspace which can not be bundled
-                'win-shortcuts',
+                'windows-utils',
                 // External dependencies
                 '@grpc/grpc-js',
                 'google-protobuf',

desktop/packages/mullvad-vpn/tasks/scripts.js

@@ -1,5 +1,5 @@
 [package]
-name = "win-shortcuts"
+name = "windows-utils"
 description = ""
 authors.workspace = true
 repository.workspace = true
@@ -13,7 +13,7 @@ workspace = true
 
 [lib]
 crate-type = ["cdylib"]
-path = "win-shortcuts-rs/lib.rs"
+path = "windows-utils-rs/lib.rs"
 
 [target.'cfg(target_os = "windows")'.dependencies]
 neon = "1"

desktop/packages/mullvad-vpn/vite.config.ts

@@ -1,8 +1,8 @@
-# win-shortcuts
+# windows-utils
 
-## Building win-shortcuts
+## Building windows-utils
 
-Building win-shortcuts requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).
+Building windows-utils requires a [supported version of Node and Rust](https://github.com/neon-bindings/neon#platform-support).
 
 To run the build, run:
 

desktop/packages/win-shortcuts/.gitignore desktop/packages/windows-utils/.gitignore

@@ -1,16 +1,16 @@
 {
-  "name": "win-shortcuts",
+  "name": "windows-utils",
   "version": "0.0.0",
   "author": "Mullvad VPN",
   "license": "GPL-3.0",
   "description": "",
   "main": "./lib/index.cjs",
   "scripts": {
     "cargo-build": "npm run build-typescript && cargo build",
-    "build-debug": "npm run cargo-build && (test -d debug || mkdir debug) && cp ../../../target/debug/win_shortcuts.dll debug/index.node",
-    "build-arm": "npm run cargo-build -- --release --target aarch64-pc-windows-msvc && (test -d dist || mkdir dist) && (test -d dist/win32-arm64-msvc || mkdir \"dist/win32-arm64-msvc\") && cp ../../../target/aarch64-pc-windows-msvc/release/win_shortcuts.dll dist/win32-arm64-msvc/index.node",
+    "build-debug": "npm run cargo-build && (test -d debug || mkdir debug) && cp ../../../target/debug/windows_utils.dll debug/index.node",
+    "build-arm": "npm run cargo-build -- --release --target aarch64-pc-windows-msvc && (test -d dist || mkdir dist) && (test -d dist/win32-arm64-msvc || mkdir \"dist/win32-arm64-msvc\") && cp ../../../target/aarch64-pc-windows-msvc/release/windows_utils.dll dist/win32-arm64-msvc/index.node",
     "build-typescript": "tsc",
-    "build-x86": "npm run cargo-build -- --release --target x86_64-pc-windows-msvc && (test -d dist || mkdir dist) && (test -d dist/win32-x64-msvc || mkdir \"dist/win32-x64-msvc\") && cp ../../../target/x86_64-pc-windows-msvc/release/win_shortcuts.dll dist/win32-x64-msvc/index.node",
+    "build-x86": "npm run cargo-build -- --release --target x86_64-pc-windows-msvc && (test -d dist || mkdir dist) && (test -d dist/win32-x64-msvc || mkdir \"dist/win32-x64-msvc\") && cp ../../../target/x86_64-pc-windows-msvc/release/windows_utils.dll dist/win32-x64-msvc/index.node",
     "clean": "rm -rf debug; rm -rf dist",
     "lint": "eslint .",
     "lint-fix": "eslint --fix .",

desktop/packages/win-shortcuts/Cargo.toml desktop/packages/windows-utils/Cargo.toml

@@ -0,0 +1,12 @@
+#![cfg(target_os = "windows")]
+
+use neon::{prelude::ModuleContext, result::NeonResult};
+
+mod shortcut;
+
+#[neon::main]
+fn main(mut cx: ModuleContext<'_>) -> NeonResult<()> {
+    cx.export_function("readShortcut", shortcut::read_shortcut)?;
+
+    Ok(())
+}

desktop/packages/win-shortcuts/README.md desktop/packages/windows-utils/README.md

@@ -1,5 +1,3 @@
-#![cfg(target_os = "windows")]
-
 use std::marker::PhantomData;
 use std::string::FromUtf16Error;
 use std::sync::{mpsc, OnceLock};
@@ -51,14 +49,7 @@ enum Error {
 /// 32 KiB: https://learn.microsoft.com/en-us/windows/win32/fileio/maximum-file-path-limitation?tabs=registry
 const MAX_PATH_LEN: usize = 0x7fff;
 
-#[neon::main]
-fn main(mut cx: ModuleContext<'_>) -> NeonResult<()> {
-    cx.export_function("readShortcut", read_shortcut)?;
-
-    Ok(())
-}
-
-fn read_shortcut(mut cx: FunctionContext<'_>) -> JsResult<'_, JsValue> {
+pub fn read_shortcut(mut cx: FunctionContext<'_>) -> JsResult<'_, JsValue> {
     let link_path = cx.argument::<JsString>(0)?.value(&mut cx);
 
     match read_shortcut_inner(link_path) {