element-desktop/scripts/hak/hakEnv.ts

/*
Copyright 2020-2021 The Matrix.org Foundation C.I.C.

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.
*/

import path from 'path';
import os from 'os';
import nodePreGypVersioning from "node-pre-gyp/lib/util/versioning";
import { getElectronVersion } from "app-builder-lib/out/electron/electronVersion";

import { Arch, Target, TARGETS, getHost, isHostId, TargetId } from './target';

async function getRuntime(projectRoot: string): Promise<string> {
    const electronVersion = await getElectronVersion(projectRoot);
    return electronVersion ? 'electron' : 'node-webkit';
}

async function getRuntimeVersion(projectRoot: string): Promise<string> {
    const electronVersion = await getElectronVersion(projectRoot);
    if (electronVersion) {
        return electronVersion;
    } else {
        return process.version.substr(1);
    }
}

export default class HakEnv {
    public readonly target: Target;
    public runtime: string;
    public runtimeVersion: string;
    public dotHakDir: string;

    constructor(public readonly projectRoot: string, targetId: TargetId | null) {
        if (targetId) {
            this.target = TARGETS[targetId];
        } else {
            this.target = getHost();
        }

        if (!this.target) {
            throw new Error(`Unknown target ${targetId}!`);
        }
        this.dotHakDir = path.join(this.projectRoot, '.hak');
    }

    public async init() {
        this.runtime = await getRuntime(this.projectRoot);
        this.runtimeVersion = await getRuntimeVersion(this.projectRoot);
    }

    public getRuntimeAbi(): string {
        return nodePreGypVersioning.get_runtime_abi(
            this.runtime,
            this.runtimeVersion,
        );
    }

    // {node_abi}-{platform}-{arch}
    public getNodeTriple(): string {
        return this.getRuntimeAbi() + '-' + this.target.platform + '-' + this.target.arch;
    }

    public getTargetId(): TargetId {
        return this.target.id;
    }

    public isWin(): boolean {
        return this.target.platform === 'win32';
    }

    public isMac(): boolean {
        return this.target.platform === 'darwin';
    }

    public isLinux(): boolean {
        return this.target.platform === 'linux';
    }

    public getTargetArch(): Arch {
        return this.target.arch;
    }

    public isHost(): boolean {
        return isHostId(this.target.id);
    }

    public makeGypEnv(): Record<string, string> {
        return Object.assign({}, process.env, {
            npm_config_arch: this.target.arch,
            npm_config_target_arch: this.target.arch,
            npm_config_disturl: 'https://electronjs.org/headers',
            npm_config_runtime: this.runtime,
            npm_config_target: this.runtimeVersion,
            npm_config_build_from_source: true,
            npm_config_devdir: path.join(os.homedir(), ".electron-gyp"),
        });
    }

    public getNodeModuleBin(name: string): string {
        return path.join(this.projectRoot, 'node_modules', '.bin', name);
    }

    public wantsStaticSqlCipherUnix(): boolean {
        return this.isMac() || process.env.SQLCIPHER_STATIC == '1';
    }

    public wantsStaticSqlCipher(): boolean {
        return this.isWin() || this.wantsStaticSqlCipherUnix();
    }
}