commit 9754ce9cf82d6a179d07803dbd6f72b0301be0a9 Author: Anton Nesterov Date: Mon Jul 8 17:38:38 2024 +0200 init diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..9b1ee42 --- /dev/null +++ b/.gitignore @@ -0,0 +1,175 @@ +# Based on https://raw.githubusercontent.com/github/gitignore/main/Node.gitignore + +# Logs + +logs +_.log +npm-debug.log_ +yarn-debug.log* +yarn-error.log* +lerna-debug.log* +.pnpm-debug.log* + +# Caches + +.cache + +# Diagnostic reports (https://nodejs.org/api/report.html) + +report.[0-9]_.[0-9]_.[0-9]_.[0-9]_.json + +# Runtime data + +pids +_.pid +_.seed +*.pid.lock + +# Directory for instrumented libs generated by jscoverage/JSCover + +lib-cov + +# Coverage directory used by tools like istanbul + +coverage +*.lcov + +# nyc test coverage + +.nyc_output + +# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files) + +.grunt + +# Bower dependency directory (https://bower.io/) + +bower_components + +# node-waf configuration + +.lock-wscript + +# Compiled binary addons (https://nodejs.org/api/addons.html) + +build/Release + +# Dependency directories + +node_modules/ +jspm_packages/ + +# Snowpack dependency directory (https://snowpack.dev/) + +web_modules/ + +# TypeScript cache + +*.tsbuildinfo + +# Optional npm cache directory + +.npm + +# Optional eslint cache + +.eslintcache + +# Optional stylelint cache + +.stylelintcache + +# Microbundle cache + +.rpt2_cache/ +.rts2_cache_cjs/ +.rts2_cache_es/ +.rts2_cache_umd/ + +# Optional REPL history + +.node_repl_history + +# Output of 'npm pack' + +*.tgz + +# Yarn Integrity file + +.yarn-integrity + +# dotenv environment variable files + +.env +.env.development.local +.env.test.local +.env.production.local +.env.local + +# parcel-bundler cache (https://parceljs.org/) + +.parcel-cache + +# Next.js build output + +.next +out + +# Nuxt.js build / generate output + +.nuxt +dist + +# Gatsby files + +# Comment in the public line in if your project uses Gatsby and not Next.js + +# https://nextjs.org/blog/next-9-1#public-directory-support + +# public + +# vuepress build output + +.vuepress/dist + +# vuepress v2.x temp and cache directory + +.temp + +# Docusaurus cache and generated files + +.docusaurus + +# Serverless directories + +.serverless/ + +# FuseBox cache + +.fusebox/ + +# DynamoDB Local files + +.dynamodb/ + +# TernJS port file + +.tern-port + +# Stores VSCode versions used for testing VSCode extensions + +.vscode-test + +# yarn v2 + +.yarn/cache +.yarn/unplugged +.yarn/build-state.yml +.yarn/install-state.gz +.pnp.* + +# IntelliJ based IDEs +.idea + +# Finder (MacOS) folder config +.DS_Store diff --git a/README.md b/README.md new file mode 100644 index 0000000..38bb192 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# httplog + +To install dependencies: + +```bash +bun install +``` + +To run: + +```bash +bun run index.ts +``` + +This project was created using `bun init` in bun v1.1.13. [Bun](https://bun.sh) is a fast all-in-one JavaScript runtime. diff --git a/bun.lockb b/bun.lockb new file mode 100755 index 0000000..1bf57f4 Binary files /dev/null and b/bun.lockb differ diff --git a/index.ts b/index.ts new file mode 100644 index 0000000..6eede80 --- /dev/null +++ b/index.ts @@ -0,0 +1,115 @@ + +export type Event = Record; + +export interface IHTTPLogger { + log(event: string, ...tags: string[]): void; +} + +export type HTTPLoggerOptions = { + url: string; + bufferSize?: number; + throttle?: number; + fetch?: typeof fetch; + getMetadata?: () => Event; +}; + +class HTTPLog implements IHTTPLogger { + #url: string; + #buffer: Event[] = []; + #bufferSize: number = 3; + #throttle: number; + #timeout: string | number | undefined = void 0; + #getMetadata: () => Event; + + #fetch: ( + input: RequestInfo | URL, + init?: RequestInit | undefined, + ) => Promise; + + constructor({ + url = "", + bufferSize = 3, + throttle = 1000, + fetch = globalThis.fetch, + getMetadata = () => ({ + title: globalThis.document?.title || "", + url: globalThis.location?.href || "", + }), + }: HTTPLoggerOptions) { + if (url === "") { + throw new Error("URL is required"); + } + this.#url = url; + this.#bufferSize = bufferSize; + this.#throttle = throttle; + this.#fetch = (...args) => fetch(...args); + this.#getMetadata = getMetadata; + if (typeof window === "undefined") { + return; + } + addEventListener("unload", () => { + globalThis?.navigator?.sendBeacon?.( + this.#url, + JSON.stringify(this.#buffer), + ); + }); + } + + async #post() { + const data = this.#buffer.slice(); + if (data.length === 0) { + return; + } + this.#buffer = []; + const body = JSON.stringify(data); + try { + const res = await this.#fetch(this.#url, { + method: "POST", + body: body, + headers: { + "Content-Type": "application/json", + }, + keepalive: true, + credentials: "include", + }); + if (res.status >= 400 && res.status !== 422) { + this.#buffer.push(...data); + } + return res; + } catch (e) { + console.log("Error", e); + this.#buffer.push(...data); + } + } + + async #timer() { + this.#timeout = setTimeout(() => { + this.#post(); + this.#timer(); + }, this.#throttle) as any; + } + + async log(event: string, ...tags: string[]) { + this.#buffer.push({ + event, + tags, + ...this.#getMetadata(), + }); + + if (this.#buffer.length >= this.#bufferSize) { + this.#post(); + } + + if (this.#timeout === void 0) { + this.#post(); + this.#timer(); + } + } +} + +declare global { + var HTTPLogger: IHTTPLogger; +} + +// @ts-ignore +globalThis.HTTPLogger = HTTPLog; \ No newline at end of file diff --git a/package.json b/package.json new file mode 100644 index 0000000..5ac6aee --- /dev/null +++ b/package.json @@ -0,0 +1,14 @@ +{ + "name": "httplog", + "module": "index.ts", + "type": "module", + "devDependencies": { + "@types/bun": "latest" + }, + "peerDependencies": { + "typescript": "^5.0.0" + }, + "scripts": { + "build": "tsc -b" + } +} \ No newline at end of file diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..5e7959e --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,32 @@ +{ + "compilerOptions": { + // Enable latest features + "lib": ["ESNext", "DOM"], + "target": "ESNext", + "module": "ESNext", + "moduleDetection": "force", + "jsx": "react-jsx", + "allowJs": true, + + // Bundler mode + "moduleResolution": "bundler", + "allowImportingTsExtensions": false, + "verbatimModuleSyntax": true, + "noEmit": false, + + // Best practices + "strict": true, + "skipLibCheck": true, + "noFallthroughCasesInSwitch": true, + + // Some stricter flags (disabled by default) + "noUnusedLocals": false, + "noUnusedParameters": false, + "noPropertyAccessFromIndexSignature": false, + "outDir": "./dist", + "sourceMap": true, + "declaration": true, + "declarationMap": true, + }, + "include": ["./*"] +}