oracledb/package/prunebinaries.js

A Node.js module for Oracle Database access from JavaScript and TypeScript

/* Copyright (c) 2019, 2023, Oracle and/or its affiliates. */

/******************************************************************************
 *
 * This software is dual-licensed to you under the Universal Permissive License
 * (UPL) 1.0 as shown at https://oss.oracle.com/licenses/upl and Apache License
 * 2.0 as shown at https://www.apache.org/licenses/LICENSE-2.0. You may choose
 * either license.
 *
 * If you elect to accept the software under the Apache License, Version 2.0,
 * the following applies:
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *    https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 *
 * NAME
 *   prunebinaries.js
 *
 * DESCRIPTION
 *   Removes pre-built binaries for all other architectures.
 *   This can be used to reduce the footprint of a node-oracledb install.
 *
 * USAGE
 *   Invoke this from the top level directory.
 *   After an 'npm install oracledb' installs pre-built binaries, this file
 *   can be run with 'npm run prune [all]'.
 *   'npm run prune' will keep only the binary files for the platform where
 *   the application using node-oracledb is being run.
 *   Passing the optional 'all' parameter deletes all binary files, so that
 *   only Thin mode will be available.
 *
 *****************************************************************************/

'use strict';

const fs = require('fs');
const nodbUtil = require('../lib/util.js');

const dir = nodbUtil.RELEASE_DIR; // contains the binaries

let re = new RegExp(nodbUtil.BINARY_FILE);

try {
  let f = fs.readdirSync(dir);
  let opt = process.argv[2];

  if (opt) {
    // 'npm run prune <option>' is called
    if (opt.toLowerCase() === 'all') {
      // Remove all the binaries in nodbUtil.RELEASE_DIR
      for (let i = 0; i < f.length; i++) {
        removeFileorDir(dir + '/' + f[i]);
      }
    } else {
      // Invalid option
      throw new Error('Invalid Command option: ' + `'${opt}'. Usage 'npm run prune [all]'`);
    }
  } else {
    // 'npm run prune' is called
    for (let i = 0; i < f.length; i++) {
      if (!f[i].match(re) && (f[i].match(/oracledb.*\.node(-buildinfo.txt)*/))) {
        fs.unlinkSync(dir + '/' + f[i]);
      }
    }
  }
} catch (err) {
  console.error(err.message);
}

async function removeFileorDir(fileOrDirPath) {
  try {
    const isDir = fs.statSync(fileOrDirPath).isDirectory();
    if (isDir) {
      // Remove the directory and its files recursively
      // Use fs.promises for Node.js versions 14.6-14.13,
      // which do not support fs.rmSync()
      const vs = process.version.substring(1).split(".").map(Number);
      if (vs[0] > 14 || (vs[0] === 14 && vs[1] >= 14))
        fs.rmSync(fileOrDirPath, { recursive: true, force: true });
      else
        await fs.promises.rmdir(fileOrDirPath, { recursive: true, force: true });
    } else {
      // Remove the file or the symlink synchronously
      fs.unlinkSync(fileOrDirPath);
    }
  } catch (err) {
    throw new Error('Invalid File or Directory: ' + `'${fileOrDirPath}'`);
  }
}