gristlabs_grist-core/app/server/lib/places.ts

/**
 * Utilities related to the layout of the application and where parts are stored.
 */

import * as path from 'path';

/**
 * codeRoot is the directory containing ./app with all the JS code.
 */
export const codeRoot = path.dirname(path.dirname(path.dirname(__dirname)));

let _cachedAppRoot: string|undefined;

/**
 * Returns the appRoot, i.e. the directory containing ./sandbox, ./node_modules,
 * etc.
 */
export function getAppRoot(): string {
  if (_cachedAppRoot) { return _cachedAppRoot; }
  _cachedAppRoot = getAppRootWithoutCaching();
  return _cachedAppRoot;
}

// Uncached version of getAppRoot()
function getAppRootWithoutCaching(): string {
  if (process.env.APP_ROOT_PATH) { return process.env.APP_ROOT_PATH; }
  if (codeRoot.endsWith('/_build/core') || codeRoot.endsWith('\\_build\\core')) {
    return path.dirname(path.dirname(codeRoot));
  }
  return (codeRoot.endsWith('/_build') || codeRoot.endsWith('\\_build')) ? path.dirname(codeRoot) : codeRoot;
}

/**
 * When packaged as an electron application, most files are stored in a .asar
 * archive.  Most, but not all.  This method takes the "application root"
 * which is that .asar file in packaged form, and returns a directory where
 * remaining files are available on the regular filesystem.
 */
export function getUnpackedAppRoot(appRoot: string = getAppRoot()): string {
  if (path.basename(appRoot) == 'app.asar') {
    return path.resolve(path.dirname(appRoot), 'app.asar.unpacked');
  }
  if (path.dirname(appRoot).endsWith('app.asar')) {
    return path.resolve(path.dirname(path.dirname(appRoot)),
                        'app.asar.unpacked', 'core');
  }
  return path.resolve(path.dirname(appRoot), path.basename(appRoot, '.asar'));
}

/**
 * Return the correct root for a given subdirectory.
 */
export function getAppRootFor(appRoot: string, subdirectory: string): string {
  if (['sandbox', 'plugins', 'public-api'].includes(subdirectory)) {
    return getUnpackedAppRoot(appRoot);
  }
  return appRoot;
}

/**
 * Return the path to a given subdirectory, from the correct appRoot.
 */
export function getAppPathTo(appRoot: string, subdirectory: string): string {
  return path.resolve(getAppRootFor(appRoot, subdirectory), subdirectory);
}

/**
 * Returns the instance root. Defaults to appRoot, unless overridden by GRIST_INST_DIR.
 */
export function getInstanceRoot() {
  return path.resolve(process.env.GRIST_INST_DIR || getAppRoot());
}