Skip to content

Commit

Permalink
refactor to make it modular, update account data hourly instead of ev…
Browse files Browse the repository at this point in the history
…ery scrape (#2)
  • Loading branch information
SathyaBhat authored Sep 1, 2023
1 parent 43a1190 commit acc5c25
Show file tree
Hide file tree
Showing 10 changed files with 258 additions and 185 deletions.
3 changes: 2 additions & 1 deletion .prettierrc
Original file line number Diff line number Diff line change
Expand Up @@ -2,5 +2,6 @@
"arrowParens": "always",
"bracketSpacing": true,
"endOfLine": "lf",
"printWidth": 120
"printWidth": 120,
"singleQuote": true
}
173 changes: 151 additions & 22 deletions package-lock.json

Large diffs are not rendered by default.

5 changes: 3 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -17,16 +17,17 @@
},
"license": "MIT",
"dependencies": {

"cron": "^2.4.3",
"express": "^4.18.2",
"prom-client": "^14.2.0",
"ynab": "^1.32.0"
},
"devDependencies": {
"@types/express": "^4.17.17",
"eslint": "^8.48.0",
"@types/node": "^18.11.3",
"@types/node-schedule": "^2.1.0",
"concurrently": "^8.2.1",
"eslint": "^8.48.0",
"eslint-plugin-prettier": "^5.0.0",
"nodemon": "^3.0.1",
"prettier": "3.0.2",
Expand Down
33 changes: 0 additions & 33 deletions src/accounts.ts

This file was deleted.

6 changes: 6 additions & 0 deletions src/api.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
import {API} from "ynab";

export async function ynabClient(): Promise<API> {
const accessToken = process.env.YNAB_TOKEN!;
return new API(accessToken);
}
42 changes: 42 additions & 0 deletions src/collectors.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
import {Gauge, Registry} from "prom-client";
import {Account} from "ynab";


export class YNABMetrics {
accountBalances: Account[] = [];


public async collectAccountBalanceMetrics(register: Registry) {
console.log('Collecting account balance metrics..');

const accountLabels = ['account_name', 'type'];
const accountClearedBalanceGauge = new Gauge({
name: "ynab_cleared_account_balance",
registers: [register],
help: "Account Cleared Balance amounts",
labelNames: accountLabels,
collect: async () => {
console.log(`Collecting Cleared Balance for ${this.accountBalances.length} accounts`);
this.accountBalances.forEach(a => {
accountClearedBalanceGauge.labels({account_name: a.name, type: a.type}).set(a.cleared_balance / 1000);
});
}

});
const accountUnClearedBalanceGauge = new Gauge({
name: "ynab_uncleared_account_balance",
help: "Account Uncleared Balance amounts",
registers: [register],
labelNames: accountLabels,
collect: async () => {
console.log(`Collecting Uncleared Balance for ${this.accountBalances.length} accounts`);
this.accountBalances.forEach(a => {
accountUnClearedBalanceGauge.labels({account_name: a.name, type: a.type}).set(a.uncleared_balance / 1000);
});
}

});

}

}
43 changes: 32 additions & 11 deletions src/index.ts
Original file line number Diff line number Diff line change
@@ -1,22 +1,44 @@

import {ynabClient} from "./ynab";
import {Registry} from "prom-client";


import {Registry, Gauge, collectDefaultMetrics} from "prom-client";
import express, {Express, Request, Response} from 'express';
import {collectAccountBalanceValues} from "./accounts";
import {YNABMetrics} from "./collectors";
import {scheduledAccountBalanceUpdate} from "./jobs/accounts";

import {CronJob} from 'cron';
import {Account} from "ynab";
import {ynabClient} from "./api";



async function main() {
const ynab = await ynabClient();
const registry = new Registry();
const app: Express = express();
const register = new Registry();
const port = process.env.PORT;
app.get('/metrics', (req: Request, res: Response) => {
res.setHeader('Content-Type', registry.contentType);
registry.metrics().then(data => res.status(200).send(data));
const app: Express = express();
const ynabMetrics = new YNABMetrics();

new CronJob({
cronTime: "0 * * * * ",
onTick: async () => {
ynabMetrics.accountBalances = (await scheduledAccountBalanceUpdate(ynab)).accounts;
console.log(`${ynabMetrics.accountBalances.length} accounts refreshed`);
},
start: true,
runOnInit: true
});


// collectDefaultMetrics({register});
collectAccountBalanceValues(ynab, registry);
ynabMetrics.collectAccountBalanceMetrics(register);


app.get('/metrics', async (req: Request, res: Response) => {
res.setHeader('Content-Type', register.contentType);
console.log('getting metrics');
const results = await register.metrics();
res.send(results);
});

app.listen(port || 9100, () => {
console.log('⚡ Hello');
Expand All @@ -27,4 +49,3 @@ if (require.main === module) {
console.log('Starting YNAB Exporter 💰💸');
main();
}

12 changes: 12 additions & 0 deletions src/jobs/accounts.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
import {API, AccountsResponseData, TransactionsResponse} from "ynab";

export type ynabTransactionResponse = (TransactionsResponse & {rateLimit: string | null;}) | undefined;
export const ynabBudgetId = process.env.BUDGET_ID!;

export async function scheduledAccountBalanceUpdate(ynab: API): Promise<AccountsResponseData> {
console.log(`Starting scheduled account balance update at ${new Date().toLocaleString()} ...`);
const accounts = await ynab.accounts.getAccounts(ynabBudgetId);
console.log(`Fetched balances for ${accounts.data.accounts.length} accounts.`);
console.log(`Rate limit: ${accounts.rateLimit}`);
return accounts.data;
}
17 changes: 0 additions & 17 deletions src/ynab.ts

This file was deleted.

109 changes: 10 additions & 99 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,103 +1,14 @@
{
"extends": "@tsconfig/node16/tsconfig.json",
"include": ["**/*.ts"],
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */

/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
"sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
"outDir": "dist", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */

/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
"target": "es2016",
"moduleResolution": "node",
"sourceMap": true,
"outDir": "dist",
"esModuleInterop": true,
"forceConsistentCasingInFileNames": true,
"strict": true,
"skipLibCheck": true
}
}

0 comments on commit acc5c25

Please sign in to comment.