All files / core/blong-gogo/src/adapter/impl ngrokTunnels.ts

79.41% Statements 54/68
80% Branches 8/10
66.66% Functions 2/3
79.41% Lines 54/68

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 691x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 1x 11x 11x 11x 1x 1x 1x 1x 1x 1x 1x 1x 1x 7x 7x 7x 7x 7x 11x 11x 11x 7x 7x 7x 7x 1x 1x 1x                              
import got from 'got';
 
/**
 * The tunnel that publishes this process, asked of the agent that runs it.
 *
 * An ngrok hostname changes between runs, and both platforms that need it — Slack for its two request
 * URLs, Viber for `set_webhook` — need the *current* one. The agent already knows it: its status API
 * lists the tunnels it forwards, each with the local address it points at, so the port asks for the
 * tunnel whose `config.addr` names its own listening port. That is what `ngrokUrl` in an rc file was
 * for; naming one is now an override for an agent that is somewhere else, or a fixed hostname.
 */
export interface INgrokTunnel {
    public_url?: string;
    proto?: string;
    name?: string;
    config?: {addr?: string};
}
 
export interface INgrokTunnels {
    tunnels?: INgrokTunnel[];
}
 
/** Where the agent answers by default; a second agent on the same machine is on 4041. */
export const NGROK_AGENT_URL = 'http://127.0.0.1:4040/api/tunnels';
 
/** The port an ngrok `config.addr` names: `http://localhost:8095`, `localhost:8095` or `8095`. */
const addrPort = (addr: string | undefined): number | undefined => {
    const match = /(\d+)\/*$/.exec(addr ?? '');
    return match ? Number(match[1]) : undefined;
};
 
/**
 * The public base of the tunnel that forwards to one local port.
 *
 * `https` wins when both protocols forward the same port, because Slack refuses an `http` request URL
 * and Viber rejects it in production. A tunnel for another port is ignored: a machine often runs two,
 * one per listener, and picking the wrong one points a platform at the other process.
 */
export const ngrokPublicUrl = (
    tunnels: INgrokTunnels | undefined,
    listenerPort: number | undefined,
): string | undefined => {
    const found = (tunnels?.tunnels ?? []).filter(
        tunnel =>
            tunnel.public_url &&
            listenerPort !== undefined &&
            addrPort(tunnel.config?.addr) === listenerPort,
    );
    const chosen = found.find(tunnel => tunnel.proto === 'https') ?? found[0];
    return chosen?.public_url?.replace(/\/+$/, '');
};
 
/** What the agent says it is forwarding, or `undefined` when nothing answers on that address. */
export const ngrokTunnelsGet = async (
    agentUrl = NGROK_AGENT_URL,
): Promise<INgrokTunnels | undefined> => {
    try {
        const answer = await got.get(agentUrl, {
            responseType: 'json',
            throwHttpErrors: false,
            timeout: {request: 3000},
        });
        const body = answer.body as INgrokTunnels | undefined;
        return body && Array.isArray(body.tunnels) ? body : undefined;
    } catch {
        return undefined;
    }
};