@flun/nodejs-mobile-gyp 1.0.1

package/lib/configure.js

@@ -0,0 +1,295 @@
+import gracefulFs from 'graceful-fs'
+import path from 'path'
+import * as log from './log.js'
+import os from 'os'
+import { processRelease } from './process-release.js'
+import { findNodeDirectory } from './find-node-directory.js'
+import { createConfigGypi } from './create-config-gypi.js'
+import { format as msgFormat } from 'util'
+import { findAccessibleSync } from './util.js'
+import { PythonFinder } from './find-python.js'
+import { fileURLToPath } from 'url'
+
+const fs = gracefulFs.promises
+const win = process.platform === 'win32'
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+// 条件加载：仅在 Windows 上需要
+let findVisualStudio = null
+if (win) {
+  const { VisualStudioFinder } = await import('./find-visualstudio.js')
+  findVisualStudio = VisualStudioFinder.findVisualStudio
+}
+
+/**
+ * 生成构建文件（Makefile / MSVC 工程）
+ */
+const configure = async (gyp, argv) => {
+  const buildDir = path.resolve('build')
+  const configNames = ['config.gypi', 'common.gypi']
+  const configs = []
+  let nodeDir
+  const release = processRelease(argv, gyp, process.version, process.release)
+
+  const python = await PythonFinder.findPython(gyp.opts.python)
+  return getNodeDir()
+
+  async function getNodeDir () {
+    // 此时 python 已确定
+    process.env.PYTHON = python
+
+    if (gyp.opts.nodedir) {
+      // 指定了 --nodedir，用它作为开发文件目录
+      nodeDir = gyp.opts.nodedir.replace(/^~/, os.homedir())
+      log.verbose('get node dir', 'compiling against specified --nodedir dev files: %s', nodeDir)
+    } else {
+      // 未指定 --nodedir，先确保 Node 依赖已安装
+      if ('v' + release.version !== process.version) {
+        // 指定了 --target，确定目标版本
+        log.verbose('get node dir', 'compiling against --target node version: %s', release.version)
+      } else {
+        // 未指定 --target，使用当前主机 Node 版本
+        log.verbose('get node dir', 'no --target version specified, falling back to host node version: %s', release.version)
+      }
+
+      if (!release.semver) {
+        // 无法用 semver 解析版本字符串
+        throw new Error('Invalid version number: ' + release.version)
+      }
+
+      // 如果指定了 tarball 选项，总是删除并重装 headers 到 devdir，
+      // 否则只在不存在时安装
+      gyp.opts.ensure = !gyp.opts.tarball
+
+      await gyp.commands.install([release.version])
+
+      log.verbose('get node dir', 'target node version installed:', release.versionDir)
+      nodeDir = path.resolve(gyp.devDir, release.versionDir)
+    }
+
+    return createBuildDir()
+  }
+
+  async function createBuildDir () {
+    log.verbose('build dir', 'attempting to create "build" dir: %s', buildDir)
+
+    const isNew = await fs.mkdir(buildDir, { recursive: true })
+    log.verbose(
+      'build dir', '"build" dir needed to be created?', isNew ? 'Yes' : 'No'
+    )
+    const vsInfo = win ? await findVisualStudio(release.semver, gyp.opts['msvs-version']) : null
+    return createConfigFile(vsInfo)
+  }
+
+  async function createConfigFile (vsInfo) {
+    if (win) {
+      process.env.GYP_MSVS_VERSION = Math.min(vsInfo.versionYear, 2015)
+      process.env.GYP_MSVS_OVERRIDE_PATH = vsInfo.path
+    }
+    const configPath = await createConfigGypi({ gyp, buildDir, nodeDir, vsInfo, python })
+    configs.push(configPath)
+    return findConfigs()
+  }
+
+  async function findConfigs () {
+    const name = configNames.shift()
+    if (!name) {
+      return runGyp()
+    }
+
+    const fullPath = path.resolve(name)
+    log.verbose(name, 'checking for gypi file: %s', fullPath)
+    try {
+      await fs.stat(fullPath)
+      log.verbose(name, 'found gypi file')
+      configs.push(fullPath)
+    } catch (err) {
+      // ENOENT 时继续检查下一个 gypi 文件名
+      if (err.code !== 'ENOENT') {
+        throw err
+      }
+    }
+
+    return findConfigs()
+  }
+
+  async function runGyp () {
+    if (!~argv.indexOf('-f') && !~argv.indexOf('--format')) {
+      if (win) {
+        log.verbose('gyp', 'gyp format was not specified; forcing "msvs"')
+        // 非 Windows 强制使用 make 目标
+        argv.push('-f', ('format' in gyp.opts) ? gyp.opts.format : 'msvs')
+      } else {
+        log.verbose('gyp', 'gyp format was not specified; forcing "make"')
+        // 非 Windows 强制使用 make 目标
+        argv.push('-f', ('format' in gyp.opts) ? gyp.opts.format : 'make')
+      }
+    }
+
+    // 引入所有找到的 .gypi 文件
+    configs.forEach(function (config) {
+      argv.push('-I', config)
+    })
+
+    // AIX 和 z/OS 需要设置导出文件路径，其中包含链接所需符号
+    let nodeExpFile
+    let nodeRootDir
+    let candidates
+    let logprefix = 'find exports file'
+    if (process.platform === 'aix' || process.platform === 'os390' || process.platform === 'os400') {
+      const ext = process.platform === 'os390' ? 'x' : 'exp'
+      nodeRootDir = findNodeDirectory()
+
+      if (process.platform === 'aix' || process.platform === 'os400') {
+        candidates = [
+          'include/node/node',
+          'out/Release/node',
+          'out/Debug/node',
+          'node'
+        ].map(function (file) {
+          return file + '.' + ext
+        })
+      } else {
+        candidates = [
+          'out/Release/lib.target/libnode',
+          'out/Debug/lib.target/libnode',
+          'out/Release/obj.target/libnode',
+          'out/Debug/obj.target/libnode',
+          'lib/libnode'
+        ].map(function (file) {
+          return file + '.' + ext
+        })
+      }
+
+      nodeExpFile = findAccessibleSync(logprefix, nodeRootDir, candidates)
+      if (nodeExpFile !== undefined) {
+        log.verbose(logprefix, 'Found exports file: %s', nodeExpFile)
+      } else {
+        const msg = msgFormat('Could not find node.%s file in %s', ext, nodeRootDir)
+        log.error(logprefix, 'Could not find exports file')
+        throw new Error(msg)
+      }
+    }
+
+    // z/OS 需要设置 zoslib 头文件目录，其中包含 v8config.h 引用的头文件
+    let zoslibIncDir
+    if (process.platform === 'os390') {
+      logprefix = "find zoslib's zos-base.h:"
+      let msg
+      let zoslibIncPath = process.env.ZOSLIB_INCLUDES
+      if (zoslibIncPath) {
+        zoslibIncPath = findAccessibleSync(logprefix, zoslibIncPath, ['zos-base.h'])
+        if (zoslibIncPath === undefined) {
+          msg = msgFormat('Could not find zos-base.h file in the directory set ' +
+                          'in ZOSLIB_INCLUDES environment variable: %s; set it ' +
+                          'to the correct path, or unset it to search %s', process.env.ZOSLIB_INCLUDES, nodeRootDir)
+        }
+      } else {
+        candidates = [
+          'include/node/zoslib/zos-base.h',
+          'include/zoslib/zos-base.h',
+          'zoslib/include/zos-base.h',
+          'install/include/node/zoslib/zos-base.h'
+        ]
+        zoslibIncPath = findAccessibleSync(logprefix, nodeRootDir, candidates)
+        if (zoslibIncPath === undefined) {
+          msg = msgFormat('Could not find any of %s in directory %s; set ' +
+                          'environmant variable ZOSLIB_INCLUDES to the path ' +
+                          'that contains zos-base.h', candidates.toString(), nodeRootDir)
+        }
+      }
+      if (zoslibIncPath !== undefined) {
+        zoslibIncDir = path.dirname(zoslibIncPath)
+        log.verbose(logprefix, "Found zoslib's zos-base.h in: %s", zoslibIncDir)
+      } else if (release.version.split('.')[0] >= 16) {
+        // zoslib 只随 Node v16 及以上发布
+        log.error(logprefix, msg)
+        throw new Error(msg)
+      }
+    }
+
+    // 这段逻辑移植自旧的 `gyp_addon` Python 文件
+    const gypScript = path.resolve(__dirname, '..', 'gyp', 'gyp_main.py')
+    const addonGypi = path.resolve(__dirname, '..', 'addon.gypi')
+    let commonGypi = path.resolve(nodeDir, 'include/node/common.gypi')
+    try {
+      await fs.stat(commonGypi)
+    } catch (err) {
+      commonGypi = path.resolve(nodeDir, 'common.gypi')
+    }
+
+    let outputDir = 'build'
+    if (win) {
+      // Windows 需要绝对路径
+      outputDir = buildDir
+    }
+    const nodeGypDir = path.resolve(__dirname, '..')
+
+    let nodeLibFile = path.join(nodeDir,
+      !gyp.opts.nodedir ? '<(target_arch)' : '$(Configuration)',
+      release.name + '.lib')
+
+    argv.push('-I', addonGypi)
+    argv.push('-I', commonGypi)
+    argv.push('-Dlibrary=shared_library')
+    argv.push('-Dvisibility=default')
+    argv.push('-Dnode_root_dir=' + nodeDir)
+    if (process.platform === 'aix' || process.platform === 'os390' || process.platform === 'os400') {
+      argv.push('-Dnode_exp_file=' + nodeExpFile)
+      if (process.platform === 'os390' && zoslibIncDir) {
+        argv.push('-Dzoslib_include_dir=' + zoslibIncDir)
+      }
+    }
+    argv.push('-Dnode_gyp_dir=' + nodeGypDir)
+
+    // 这样做是为了让 Cygwin 环境正常工作，否则未转义的 '\' 会被吃掉，
+    // 导致路径错误，如 c:parentFolderfolderanotherFolder 而非 c:\parentFolder\folder\anotherFolder
+    if (win) {
+      nodeLibFile = nodeLibFile.replace(/\\/g, '\\\\')
+    }
+    argv.push('-Dnode_lib_file=' + nodeLibFile)
+    argv.push('-Dmodule_root_dir=' + process.cwd())
+    argv.push('-Dnode_engine=' +
+        (gyp.opts.node_engine || process.jsEngine || 'v8'))
+    argv.push('--depth=.')
+    argv.push('--no-parallel')
+
+    // 告诉 gyp 把 Makefile/Solution 文件写到 output_dir
+    argv.push('--generator-output', outputDir)
+    if (win) {
+      argv.push('-Gmsvs_toolset=v145')
+    }
+
+    // 告诉 make 把输出写到同一目录
+    argv.push('-Goutput_dir=.')
+
+    // 强制使用 binding.gyp 文件
+    argv.unshift('binding.gyp')
+
+    // 从当前目标 nodedir 执行 `gyp`
+    argv.unshift(gypScript)
+
+    // 确保 python 使用该 node 包自带的文件
+    const pypath = [path.join(__dirname, '..', 'gyp', 'pylib')]
+    if (process.env.PYTHONPATH) {
+      pypath.push(process.env.PYTHONPATH)
+    }
+    process.env.PYTHONPATH = pypath.join(win ? ';' : ':')
+
+    await new Promise((resolve, reject) => {
+      const cp = gyp.spawn(python, argv)
+      cp.on('exit', (code) => {
+        if (code !== 0) {
+          reject(new Error('`gyp` failed with exit code: ' + code))
+        } else {
+          // 完成
+          resolve()
+        }
+      })
+    })
+  }
+}
+
+configure.usage = 'Generates ' + (win ? 'MSVC project files' : 'a Makefile') + ' for the current module'
+
+export { configure }

package/lib/create-config-gypi.js

@@ -0,0 +1,163 @@
+import gracefulFs from 'graceful-fs'
+import * as log from './log.js'
+import path from 'path'
+
+const fs = gracefulFs.promises
+
+/**
+ * 解析 config.gypi 内容为 JSON 对象
+ * 逻辑翻译自 Node.js 的 tools/js2c.py
+ */
+const parseConfigGypi = (config) => {
+  // 1. 去掉 # 注释
+  config = config.replace(/#.*/g, '')
+  // 2. 拼接多行字符串
+  config = config.replace(/'$\s+'/mg, '')
+  // 3. 把单引号字符串归一化为双引号
+  config = config.replace(/'/g, '"')
+  return JSON.parse(config)
+}
+
+/**
+ * 读取基础 config.gypi
+ */
+const getBaseConfigGypi = async ({ gyp, nodeDir }) => {
+  // 在以下情况优先读取 $nodeDir/include/node/config.gypi：
+  // 1. 指定了 --dist-url 或 --nodedir
+  // 2. 且没有指定 --force-process-config
+  const useCustomHeaders = gyp.opts.nodedir || gyp.opts.disturl || gyp.opts['dist-url']
+  const shouldReadConfigGypi = useCustomHeaders && !gyp.opts['force-process-config']
+  if (shouldReadConfigGypi && nodeDir) {
+    try {
+      const baseConfigGypiPath = path.resolve(nodeDir, 'include/node/config.gypi')
+      const baseConfigGypi = await fs.readFile(baseConfigGypiPath)
+      return parseConfigGypi(baseConfigGypi.toString())
+    } catch (err) {
+      log.warn('read config.gypi', err.message)
+    }
+  }
+
+  // 回退到 process.config
+  return JSON.parse(JSON.stringify(process.config))
+}
+
+/**
+ * 基于当前环境生成 config.gypi 内容
+ */
+const getCurrentConfigGypi = async ({ gyp, nodeDir, vsInfo, python }) => {
+  const config = await getBaseConfigGypi({ gyp, nodeDir })
+  if (!config.target_defaults) {
+    config.target_defaults = {}
+  }
+  if (!config.variables) {
+    config.variables = {}
+  }
+
+  const defaults = config.target_defaults
+  const variables = config.variables
+
+  // 不要继承 base config.gypi 的 defaults，
+  // 否则当 node 可执行文件在另一台机器编译（lib/include 路径不同）时会出问题
+  defaults.cflags = []
+  defaults.defines = []
+  defaults.include_dirs = []
+  defaults.libraries = []
+
+  // 设置 default_configuration
+  if ('debug' in gyp.opts) {
+    defaults.default_configuration = gyp.opts.debug ? 'Debug' : 'Release'
+  }
+
+  if (!defaults.default_configuration) {
+    defaults.default_configuration = 'Release'
+  }
+
+  // 设置 target_arch
+  variables.target_arch = gyp.opts.arch || process.arch || 'ia32'
+  if (variables.target_arch === 'arm64') {
+    defaults.msvs_configuration_platform = 'ARM64'
+    defaults.xcode_configuration_platform = 'arm64'
+  }
+
+  // 设置 Node 开发目录
+  variables.nodedir = nodeDir
+
+  // 设置 Python 路径
+  variables.python = python
+
+  // 默认禁用 -T "thin" 静态归档
+  variables.standalone_static_library = gyp.opts.thin ? 0 : 1
+
+  if (process.platform === 'win32') {
+    defaults.msbuild_toolset = vsInfo.toolset
+    if (vsInfo.sdk) {
+      defaults.msvs_windows_target_platform_version = vsInfo.sdk
+    }
+    if (variables.target_arch === 'arm64') {
+      if (vsInfo.versionMajor > 15 ||
+          (vsInfo.versionMajor === 15 && vsInfo.versionMajor >= 9)) {
+        defaults.msvs_enable_marmasm = 1
+      } else {
+        log.warn('Compiling ARM64 assembly is only available in\n' +
+          'Visual Studio 2017 version 15.9 and above')
+      }
+    }
+    variables.msbuild_path = vsInfo.msBuild
+    // Windows 原生构建走 MSVC 工具集：必须关闭 clang 与 LTO，
+    // 否则 common.gypi 会把 toolset 设为 ClangCL，并向 MSVC 链接器传入 Clang 专用参数
+    // （-flto=thin、/opt:lldltojobs），导致 MSB8020 或 LNK1117
+    if (!gyp.opts.format || gyp.opts.format === 'msvs') {
+      variables.clang = 0
+      variables.enable_lto = 'false'
+      variables.enable_thin_lto = 'false'
+      variables.lto_jobs = ''
+    }
+  }
+
+  // 把其余未知选项当作变量写入，支持模块自定义 configure 参数，例如：
+  //   $ node-gyp configure --shared-libxml2
+  Object.keys(gyp.opts).forEach(function (opt) {
+    if (opt === 'argv') {
+      return
+    }
+    if (opt in gyp.configDefs) {
+      return
+    }
+    variables[opt.replace(/-/g, '_')] = gyp.opts[opt]
+  })
+
+  return config
+}
+
+/**
+ * 生成并写出 config.gypi 文件
+ */
+const createConfigGypi = async ({ gyp, buildDir, nodeDir, vsInfo, python }) => {
+  const configFilename = 'config.gypi'
+  const configPath = path.resolve(buildDir, configFilename)
+
+  log.verbose('build/' + configFilename, 'creating config file')
+
+  const config = await getCurrentConfigGypi({ gyp, nodeDir, vsInfo, python })
+
+  // 保证 config.gypi 中的布尔值都转成字符串
+  const boolsToString = (k, v) => {
+    if (typeof v === 'boolean') {
+      return String(v)
+    }
+    return v
+  }
+
+  log.silly('build/' + configFilename, config)
+
+  // 把 config.gypi 写入 build/ 目录
+  const prefix = '# Do not edit. File was generated by node-gyp\'s "configure" step'
+
+  const json = JSON.stringify(config, boolsToString, 2)
+  log.verbose('build/' + configFilename, 'writing out config file: %s', configPath)
+  await fs.writeFile(configPath, [prefix, json, ''].join('\n'))
+
+  return configPath
+}
+
+export { createConfigGypi, parseConfigGypi, getCurrentConfigGypi }

package/lib/download.js

@@ -0,0 +1,44 @@
+import fetch from 'make-fetch-happen'
+import gracefulFs from 'graceful-fs'
+import * as log from './log.js'
+
+const { promises: fs } = gracefulFs
+
+/**
+ * 读取 CA 证书文件，按证书边界切分为多个证书
+ */
+const readCAFile = async (filename) => {
+  // CA 文件可能包含多份证书，按证书边界切分
+  // [\S\s]*? 用于匹配包括换行在内的所有内容
+  const ca = await fs.readFile(filename, 'utf8')
+  const re = /(-----BEGIN CERTIFICATE-----[\S\s]*?-----END CERTIFICATE-----)/g
+  return ca.match(re)
+}
+
+/**
+ * 使用 make-fetch-happen 下载指定 URL
+ */
+const download = async (gyp, url) => {
+  log.http('GET', url)
+
+  const requestOpts = {
+    headers: {
+      'User-Agent': `node-gyp v${gyp.version} (node ${process.version})`,
+      Connection: 'keep-alive'
+    },
+    proxy: gyp.opts.proxy,
+    noProxy: gyp.opts.noproxy
+  }
+
+  const cafile = gyp.opts.cafile
+  if (cafile) {
+    requestOpts.ca = await readCAFile(cafile)
+  }
+
+  const res = await fetch(url, requestOpts)
+  log.http(res.status, res.url)
+
+  return res
+}
+
+export { download, readCAFile }

package/lib/find-node-directory.js

@@ -0,0 +1,62 @@
+import path from 'path'
+import { fileURLToPath } from 'url'
+import * as log from './log.js'
+
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
+
+/**
+ * 从脚本位置或进程对象推断 Node 根目录
+ */
+const findNodeDirectory = (scriptLocation, processObj) => {
+  // 未传入时使用默认值，便于回归测试
+  if (scriptLocation === undefined) {
+    scriptLocation = __dirname
+  }
+  if (processObj === undefined) {
+    processObj = process
+  }
+
+  // 看看上层目录结构，判断当前所处位置
+  const npmParentDirectory = path.join(scriptLocation, '../../../..')
+  log.verbose('node-gyp root', 'npm_parent_directory is ' +
+              path.basename(npmParentDirectory))
+  let nodeRootDir = ''
+
+  log.verbose('node-gyp root', 'Finding node root directory')
+  if (path.basename(npmParentDirectory) === 'deps') {
+    // 处于构建目录中，脚本位于 deps/npm/node_modules/node-gyp/lib
+    nodeRootDir = path.join(npmParentDirectory, '..')
+    log.verbose('node-gyp root', 'in build directory, root = ' +
+                nodeRootDir)
+  } else if (path.basename(npmParentDirectory) === 'node_modules') {
+    // 处于 Node 安装目录中，脚本位于
+    // lib/node_modules/npm/node_modules/node-gyp/lib 或
+    // node_modules/npm/node_modules/node-gyp/lib（视平台而定）
+    if (processObj.platform === 'win32') {
+      nodeRootDir = path.join(npmParentDirectory, '..')
+    } else {
+      nodeRootDir = path.join(npmParentDirectory, '../..')
+    }
+    log.verbose('node-gyp root', 'in install directory, root = ' +
+                nodeRootDir)
+  } else {
+    // 无法判断，尝试从 node 可执行文件的位置推断
+    const nodeDir = path.dirname(processObj.execPath)
+    const directoryUp = path.basename(nodeDir)
+    if (directoryUp === 'bin') {
+      nodeRootDir = path.join(nodeDir, '..')
+    } else if (directoryUp === 'Release' || directoryUp === 'Debug') {
+      // 如果是刚构建的 node，且目录结构为仓库结构：
+      // Windows 只需上一层，其余平台两层
+      if (processObj.platform === 'win32') {
+        nodeRootDir = path.join(nodeDir, '..')
+      } else {
+        nodeRootDir = path.join(nodeDir, '../..')
+      }
+    }
+    // 否则返回默认空串 ""
+  }
+  return nodeRootDir
+}
+
+export { findNodeDirectory }