generate-typescript-types.py

#!/usr/bin/env python

# SPDX-FileCopyrightText: Contributors to the Fedora Project
#
# SPDX-License-Identifier: MIT

import os
import shutil
import signal
import socket
import time
from contextlib import closing, contextmanager
from subprocess import CalledProcessError, Popen, run

DEST = os.path.abspath(os.path.join(os.path.dirname(__file__), "frontend/src/api/generated.ts"))


def find_free_port():
    with closing(socket.socket(socket.AF_INET, socket.SOCK_STREAM)) as s:
        s.bind(("", 0))
        s.setsockopt(socket.SOL_SOCKET, socket.SO_REUSEADDR, 1)
        return s.getsockname()[1]


def find_cmd(cmd):
    path = shutil.which(cmd)
    if path is None:
        raise RuntimeError(f"Can't find the executable {cmd}")
    return path


def call(cmd):
    print(" ".join(cmd))
    run(cmd, check=True)  # noqa: S603


@contextmanager
def running(cmd):
    proc = Popen(cmd)  # noqa: S603
    try:
        yield proc
    finally:
        proc.send_signal(signal.SIGINT)
        proc.wait(timeout=10)
    # The Uvicorn process now returns 1 when it recieves SIGINT
    if proc.returncode not in (0, 1):
        raise CalledProcessError(proc.returncode, proc.args, proc.stdout, proc.stderr)


@contextmanager
def pushd(directory):
    curdir = os.getcwd()
    os.chdir(directory)
    try:
        yield curdir
    finally:
        os.chdir(curdir)


def main():
    port = find_free_port()
    fmn_cmd = find_cmd("fmn")
    npm_cmd = find_cmd("npm")
    os.environ["DATABASE__SQLALCHEMY__URL"] = "sqlite:///"
    print("Running API")
    with running([fmn_cmd, "api", "serve", "--port", str(port)]):
        time.sleep(3)
        with pushd("frontend"):
            print("Building Typescript types")
            call(
                [
                    npm_cmd,
                    "exec",
                    "--yes",
                    "openapi-typescript@latest",
                    "--",
                    f"http://127.0.0.1:{port}/openapi.json",
                    "--output",
                    DEST,
                ]
            )
            call(
                [
                    npm_cmd,
                    "exec",
                    "prettier",
                    "--",
                    "-l",
                    "--write",
                    DEST,
                ]
            )
        print("Shutting down API")


if __name__ == "__main__":
    main()