Skip to content

Commit

Permalink
Merge pull request #34 from LN-Zap/fixes
Browse files Browse the repository at this point in the history
Implement pino logging
  • Loading branch information
mrfelton authored Feb 13, 2024
2 parents 3a12797 + 015e26d commit 7285a4e
Show file tree
Hide file tree
Showing 6 changed files with 36 additions and 22 deletions.
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,7 @@ Here are the available configuration options:
| --- | --- | --- | --- |
| `server.port` | The port on which the server runs | `3000` | `PORT` |
| `server.baseUrl` | The base url port on which the server is accessible | `http://localhost:3000` | `BASE_URL` |
| `settings.logLevel` | The log level to use for the application | `debug` | `LOGLEVEL` |
| `settings.timeout` | Timeout to use when fetching data (ms) | `5000` | `TIMEOUT` |
| `settings.feeMultiplier` | The multiplier to apply to the fee estimates | `1` | `FEE_MULTIPLIER` |
| `settings.feeMinimum` | The minimum fee (sat/vB) to use for fee estimates if we could not determine from a configured data source | `2` | `FEE_MINIMUM` |
Expand Down
Binary file modified bun.lockb
Binary file not shown.
1 change: 1 addition & 0 deletions config/custom-environment-variables.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"port": "PORT"
},
"settings": {
"loglevel": "LOGLEVEL",
"timeout": "TIMEOUT",
"feeMultiplier": "FEE_MULTIPLIER",
"feeMinimum" : "FEE_MINIMUM"
Expand Down
1 change: 1 addition & 0 deletions config/default.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
"port": 3000
},
"settings": {
"loglevel": "debug",
"timeout": 5000,
"feeMultiplier": 1,
"feeMinimum": 2
Expand Down
8 changes: 5 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -22,12 +22,14 @@
"bitcoind-rpc": "0.9.1",
"config": "3.3.9",
"hono": "3.11.12",
"node-cache": "5.1.2"
"node-cache": "5.1.2",
"pino": "8.18.0"
},
"devDependencies": {
"@types/bun": "^1.0.0",
"@types/bun": "1.0.0",
"@types/config": "3.3.3",
"@types/node-cache": "4.2.5"
"@types/node-cache": "4.2.5",
"pino-pretty": "10.3.1"
},
"engines": {
"node": ">=14.0.0"
Expand Down
47 changes: 28 additions & 19 deletions src/server.tsx
Original file line number Diff line number Diff line change
@@ -1,12 +1,13 @@
import { Hono } from 'hono'
import { raw } from 'hono/html'
import { logger } from 'hono/logger'
import { logger as honoLogger } from 'hono/logger'
import { etag } from 'hono/etag'
import { cors } from 'hono/cors'
import { serveStatic } from 'hono/bun'
import config from 'config'
import NodeCache from 'node-cache';
import RpcClient from 'bitcoind-rpc'
import pino, { type Logger } from 'pino'

// Get application configuration values from the config package.
const PORT = config.get<number>('server.port');
Expand All @@ -24,15 +25,23 @@ const BITCOIND_USERNAME = config.get<string>('bitcoind.username');
const BITCOIND_PASSWORD = config.get<number>('bitcoind.password');
const BITCOIND_CONF_TARGETS = config.get<number[]>('bitcoind.confTargets');

const LOGLEVEL = config.get<string>('settings.loglevel');
const TIMEOUT = config.get<number>('settings.timeout');
const FEE_MULTIPLIER = config.get<number>('settings.feeMultiplier');
const FEE_MINIMUM = config.get<number>('settings.feeMinimum');
const CACHE_STDTTL = config.get<number>('cache.stdTTL');
const CACHE_CHECKPERIOD = config.get<number>('cache.checkperiod');

let logger : Logger;
if (process.env['NODE_ENV'] !== 'production') {
const pretty = require('pino-pretty');
logger = pino({ level: LOGLEVEL }, pretty());
} else {
logger = pino({ level: LOGLEVEL });
}

// Log the configuration values.
console.info(JSON.stringify({
logger.info({
mempoolSettings: {
baseUrl: MEMPOOL_BASE_URL,
fallbackBaseUrl: MEMPOOL_FALLBACK_BASE_URL,
Expand All @@ -56,7 +65,7 @@ console.info(JSON.stringify({
cacheStdTTL: CACHE_STDTTL,
cacheCheckPeriod: CACHE_CHECKPERIOD
}
}));
});

// Constants
const MEMPOOL_TIP_HASH_URL = MEMPOOL_BASE_URL && `${MEMPOOL_BASE_URL}/api/blocks/tip/hash`;
Expand Down Expand Up @@ -84,7 +93,7 @@ function getValueFromFulfilledPromise(result: PromiseSettledResult<any>) {
// NOTE: fetch signal abortcontroller does not work on Bun.
// See https://github.com/oven-sh/bun/issues/2489
async function fetchWithTimeout(url: string, timeout: number = TIMEOUT): Promise<Response> {
console.debug({ message: `Starting fetch request to ${url}` });
logger.debug({ message: `Starting fetch request to ${url}` });
const fetchPromise = fetch(url);
const timeoutPromise = new Promise((_, reject) =>
setTimeout(() => reject(new Error(`Request timed out after ${timeout} ms`)), timeout)
Expand All @@ -101,7 +110,7 @@ async function fetchAndProcess(url: string, expectedResponseType: ExpectedRespon
if (!response.ok) {
throw new Error(`HTTP error! status: ${response.status}`);
}
console.debug({message: `Successfully fetched data from ${url}` });
logger.debug({message: `Successfully fetched data from ${url}` });

const contentType = response.headers.get("content-type");
if (expectedResponseType === 'json' && contentType?.includes("application/json")) {
Expand Down Expand Up @@ -134,7 +143,7 @@ async function fetchAndHandle(url: string, expectedResponseType: ExpectedRespons
return result;
} catch (error) {
if (fallbackUrl) {
console.debug({ message: 'Trying fallback URL: ${fallbackUrl}' });
logger.debug({ message: 'Trying fallback URL: ${fallbackUrl}' });
return fetchAndProcess(fallbackUrl, expectedResponseType);
} else {
throw new Error(`Fetch request to ${url} failed and no fallback URL was provided.`);
Expand All @@ -155,7 +164,7 @@ async function fetchMempoolFees() : Promise<MempoolFeeEstimates | null> {
}

const data = await Promise.allSettled(tasks);
console.debug({ message: 'Fetched data from mempool: {data}', data });
logger.debug({ message: 'Fetched data from mempool: {data}', data });

let res0 = getValueFromFulfilledPromise(data[0]);
let res1 = getValueFromFulfilledPromise(data[1]);
Expand Down Expand Up @@ -184,7 +193,7 @@ async function fetchEsploraFees() : Promise<FeeByBlockTarget | null> {
}

const data = await Promise.allSettled(tasks);
console.debug({ message: 'Fetched data from esplora: {data}', data });
logger.debug({ message: 'Fetched data from esplora: {data}', data });

let res0 = getValueFromFulfilledPromise(data[0]);
let res1 = getValueFromFulfilledPromise(data[1]);
Expand Down Expand Up @@ -230,7 +239,7 @@ async function fetchBitcoindFees() : Promise<FeeByBlockTarget | null> {

rpc.batch(batchCall, (error: Error | null, response: BitcoindRpcBatchResponse[]) => {
if (error) {
console.error({ message: 'Unable to fetch fee estimates from bitcoind: {error}', error });
logger.error({ message: 'Unable to fetch fee estimates from bitcoind: {error}', error });
resolve(null);
} else {
targets.forEach((target, i) => {
Expand All @@ -240,11 +249,11 @@ async function fetchBitcoindFees() : Promise<FeeByBlockTarget | null> {
const satPerKB : number = feeRate * 1e8;
data[target] = applyFeeMultiplier(satPerKB);
} else {
console.error({ message: `Failed to fetch fee estimate from bitcoind for confirmation target ${target}: {errors}`,
logger.error({ message: `Failed to fetch fee estimate from bitcoind for confirmation target ${target}: {errors}`,
errors: response[i].result?.errors});
}
});
console.debug({ message: 'Fetched data from bitcoind: {data}', data });
logger.debug({ message: 'Fetched data from bitcoind: {data}', data });
resolve(data);
}
});
Expand Down Expand Up @@ -286,7 +295,7 @@ async function getEstimates() : Promise<Estimates> {
let estimates: Estimates | undefined = cache.get(CACHE_KEY);

if (estimates) {
console.info({ message: 'Got estimates from cache: ${estimates}', estimates });
logger.info({ message: 'Got estimates from cache: ${estimates}', estimates });
return estimates;
}

Expand All @@ -309,7 +318,7 @@ async function getEstimates() : Promise<Estimates> {

cache.set(CACHE_KEY, estimates);

console.info({ message: 'Got estimates: {estimates}', estimates });
logger.info({ message: 'Got estimates: {estimates}', estimates });
return estimates;
}

Expand Down Expand Up @@ -403,7 +412,7 @@ function calculateFees(mempoolFeeEstimates: MempoolFeeEstimates, esploraFeeEstim

// Get the minimum fee. If the mempool fee estimates are not available, use a default value of FEE_MINIMUM sat/vbyte as a safety net.
const minFee = (mempoolFeeEstimates?.minimumFee ?? FEE_MINIMUM) * 1000;
console.debug({ message: 'Using minimum fee: {minFee}', minFee });
logger.debug({ message: 'Using minimum fee: {minFee}', minFee });

// Return fees filterd to remove any that are lower than the determined minimum fee.
if (minFee) {
Expand Down Expand Up @@ -469,7 +478,7 @@ const Content = (props: { siteData: SiteData; estimates: Estimates }) => (

// Initialize the Express app.
const app = new Hono();
console.info(`Fee Estimates available at ${BASE_URL}/v1/fee-estimates`);
logger.info(`Fee Estimates available at ${BASE_URL}/v1/fee-estimates`);

// Add a health/ready endpoint.
app.get('/health/ready', async (c) => {
Expand All @@ -482,7 +491,7 @@ app.get('/health/live', async (c) => {
});

// Add middleware.
app.use('*', logger())
app.use('*', honoLogger())
app.use('*', etag())
app.use('*', cors({
origin: '*',
Expand All @@ -504,7 +513,7 @@ app.get('/', async (c) => {
c.res.headers.set('Cache-Control', `public, max-age=${CACHE_STDTTL}`)

} catch (error) {
console.error(error);
logger.error(error);
estimates = {
current_block_hash: null,
fee_by_block_target: {}
Expand Down Expand Up @@ -536,7 +545,7 @@ app.get('/v1/fee-estimates', async (c) => {
return c.json(estimates);

} catch (error) {
console.error(error);
logger.error(error);
return c.text('Error fetching fee estimates', 500);
}
});
Expand All @@ -547,6 +556,6 @@ export default {
}

process.on('SIGINT', function() {
console.info({ message: "Caught interrupt signal. Exiting." });
logger.info({ message: "Caught interrupt signal. Exiting." });
process.exit();
});

0 comments on commit 7285a4e

Please sign in to comment.