info-json.ts

/*
Responsible for creating the info.json file that's in the
temporary store (e.g., ~/.smc) for the project.  It is used
by various scripts and programs to get basic information
about the project.
*/

import { writeFile } from "node:fs/promises";
import { networkInterfaces } from "node:os";

import basePath from "@cocalc/backend/base-path";
import { infoJson, project_id, username } from "./data";
import { getOptions } from "./init-program";
import { getLogger } from "./logger";

let INFO: {
  project_id: string;
  location: { host: string; username: string };
  base_path: string;
  base_url: string; // backward compat
};

export { INFO };

export default async function init() {
  const winston = getLogger("info-json init");
  winston.info("initializing the info.json file...");
  let host: string;
  if (process.env.HOST != null) {
    host = process.env.HOST;
  } else if (getOptions().kucalc) {
    // what we want for the Google Compute engine deployment
    // earlier, there was eth0, but newer Ubuntu's on GCP have ens4
    const nics = networkInterfaces();
    const mynic = nics.eth0 ?? nics.ens4;
    host = mynic?.[0].address ?? "127.0.0.1";
  } else {
    // for a single machine (e.g., cocalc-docker)
    host = "127.0.0.1";
  }
  INFO = {
    project_id,
    location: { host, username },
    base_path: basePath,
    base_url: basePath, // for backwards compat userspace code
  };
  await writeFile(infoJson, JSON.stringify(INFO));
  winston.info(`Successfully wrote "${infoJson}"`);
}