deps-stage.js

/**
 * @license
 * Copyright 2018 Google LLC. All Rights Reserved.
 * 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
 *
 * http://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.
 * =============================================================================
 */
const fs = require('fs');
const path = require('path');
const util = require('util');

const copy = util.promisify(fs.copyFile);
const os = require('os');
const rename = util.promisify(fs.rename);
const symlink = util.promisify(fs.symlink);
const mkdir = util.promisify(fs.mkdir);
const {
  depsLibTensorFlowFrameworkPath,
  depsLibTensorFlowPath,
  destLibTensorFlowFrameworkName,
  destLibTensorFlowName
} = require('./deps-constants.js');

const action = process.argv[2];
let targetDir = process.argv[3];

// This file is Windows only - the libraries must be placed in the correct
// directory to work.
if (os.platform() !== 'win32') {
  throw new Error('Dep staging is only supported on Windows');
}

// Some windows machines contain a trailing " char:
if (targetDir != undefined && targetDir.endsWith('"')) {
  targetDir = targetDir.slice(0, -1);
}

// Setup dest binary paths:
const destLibTensorFlowPath = path.join(targetDir, destLibTensorFlowName);
const destLibTensorFlowFrameworkPath =
    path.join(targetDir, destLibTensorFlowFrameworkName);

/**
 * Symlinks the extracted libtensorflow library to the destination path. If the
 * symlink fails, a copy is made.
 */
async function symlinkDepsLib() {
  if (destLibTensorFlowPath === undefined) {
    throw new Error('Destination path not supplied!');
  }
  try {
    await mkdir(path.dirname(destLibTensorFlowPath), {recursive: true});
    await symlink(
        path.relative(
            path.dirname(destLibTensorFlowPath), depsLibTensorFlowPath),
        destLibTensorFlowPath);
  } catch (e) {
    console.error(`  * Symlink of ${
        destLibTensorFlowPath} failed, creating a copy on disk.`);
    await copy(depsLibTensorFlowPath, destLibTensorFlowPath);
  }
}

/**
 * Moves the deps library path to the destination path.
 */
async function moveDepsLib() {
  await rename(depsLibTensorFlowPath, destLibTensorFlowPath);
  if (os.platform() !== 'win32') {
    await rename(
        depsLibTensorFlowFrameworkPath, destLibTensorFlowFrameworkPath);
  }
}

/**
 * Symlink or move libtensorflow for building the binding.
 */
async function run(action) {
  if (action.endsWith('symlink')) {
    // Symlink will happen during `node-gyp rebuild`
    await symlinkDepsLib();
  } else if (action.endsWith('move')) {
    // Move action is used when installing this module as a package.
    await moveDepsLib();
  } else {
    throw new Error('Invalid action: ' + action);
  }
}

run(action);