Compare commits

..

37 Commits

Author SHA1 Message Date
7d087e39ef 4.0.0 2025-04-28 19:27:13 +00:00
26e1d5142a BREAKING CHANGE(smartnetwork): Enhance documentation and add configurable speed test options with plugin architecture improvements 2025-04-28 19:27:13 +00:00
d6be2e27b0 3.0.5 2025-04-28 15:30:08 +00:00
d6c0af35fa fix(core): Improve logging and error handling by introducing custom error classes and a global logging interface while refactoring network diagnostics methods. 2025-04-28 15:30:08 +00:00
bc19c21949 3.0.4 2025-04-28 12:58:01 +00:00
dba1855eb6 fix(ci/config): Improve CI workflows, update project configuration, and clean up code formatting 2025-04-28 12:58:01 +00:00
db01586eb9 3.0.3 2025-04-28 12:04:08 +00:00
172fce2466 fix(deps): Update dependency namespaces and bump package versions in CI configuration and source imports 2025-04-28 12:04:08 +00:00
f7f009e0d4 update description 2024-05-29 14:14:57 +02:00
e5111f0433 update tsconfig 2024-04-14 18:02:08 +02:00
554a7d9647 update npmextra.json: githost 2024-04-01 21:36:49 +02:00
76d30b7618 update npmextra.json: githost 2024-04-01 19:59:04 +02:00
eee90810da update npmextra.json: githost 2024-03-30 21:48:03 +01:00
5bf7d19bf7 switch to new org scheme 2023-07-11 01:15:20 +02:00
2fa6da38c6 switch to new org scheme 2023-07-10 10:16:49 +02:00
e11157fe44 3.0.2 2022-10-22 17:39:29 +02:00
28d99ecb77 fix(core): update 2022-10-22 17:39:29 +02:00
d8f409c191 3.0.1 2022-10-21 17:13:06 +02:00
bcfa3be58b fix(core): update 2022-10-21 17:13:06 +02:00
15744d3c4e 3.0.0 2022-03-24 23:11:53 +01:00
8b2f541150 BREAKING CHANGE(core): switch to esm 2022-03-24 23:11:53 +01:00
b52bb4b474 2.0.14 2022-02-17 00:33:12 +01:00
42f5d66fc4 fix(core): update 2022-02-17 00:33:11 +01:00
54bb9549a1 2.0.13 2022-02-17 00:18:23 +01:00
95c3314400 fix(core): update 2022-02-17 00:18:23 +01:00
695d047200 2.0.12 2022-02-17 00:03:13 +01:00
c308589d28 fix(core): update 2022-02-17 00:03:13 +01:00
068177b09d 2.0.11 2022-02-16 23:28:12 +01:00
4a299cf3cb fix(core): update 2022-02-16 23:28:12 +01:00
e5c37b1801 2.0.10 2021-04-29 15:12:05 +00:00
5be0586790 fix(core): update 2021-04-29 15:12:05 +00:00
f5e5297d47 2.0.9 2021-04-28 14:32:56 +00:00
718fada493 fix(core): update 2021-04-28 14:32:56 +00:00
a42b1b48b5 2.0.8 2021-04-28 14:31:31 +00:00
5ec50975f3 fix(core): update 2021-04-28 14:31:30 +00:00
ad222abb6a 2.0.7 2021-04-28 14:27:23 +00:00
b29e13b162 fix(core): update 2021-04-28 14:27:22 +00:00
27 changed files with 11424 additions and 13783 deletions

@ -0,0 +1,66 @@
name: Default (not tags)
on:
push:
tags-ignore:
- '**'
env:
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Install pnpm and npmci
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
- name: Run npm prepare
run: npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build

@ -0,0 +1,124 @@
name: Default (tags)
on:
push:
tags:
- '*'
env:
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
NPMCI_URL_CLOUDLY: ${{secrets.NPMCI_URL_CLOUDLY}}
jobs:
security:
runs-on: ubuntu-latest
continue-on-error: true
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Audit production dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --prod
continue-on-error: true
- name: Audit development dependencies
run: |
npmci command npm config set registry https://registry.npmjs.org
npmci command pnpm audit --audit-level=high --dev
continue-on-error: true
test:
if: ${{ always() }}
needs: security
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Test stable
run: |
npmci node install stable
npmci npm install
npmci npm test
- name: Test build
run: |
npmci node install stable
npmci npm install
npmci npm build
release:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Release
run: |
npmci node install stable
npmci npm publish
metadata:
needs: test
if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
runs-on: ubuntu-latest
container:
image: ${{ env.IMAGE }}
continue-on-error: true
steps:
- uses: actions/checkout@v3
- name: Prepare
run: |
pnpm install -g pnpm
pnpm install -g @ship.zone/npmci
npmci npm prepare
- name: Code quality
run: |
npmci command npm install -g typescript
npmci npm install
- name: Trigger
run: npmci trigger
- name: Build docs and upload artifacts
run: |
npmci node install stable
npmci npm install
pnpm install -g @git.zone/tsdoc
npmci command tsdoc
continue-on-error: true

3
.gitignore vendored

@ -3,7 +3,6 @@
# artifacts # artifacts
coverage/ coverage/
public/ public/
pages/
# installs # installs
node_modules/ node_modules/
@ -17,4 +16,4 @@ node_modules/
dist/ dist/
dist_*/ dist_*/
# custom #------# custom

@ -1,137 +0,0 @@
# gitzone ci_default
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
cache:
paths:
- .npmci_cache/
key: '$CI_BUILD_STAGE'
stages:
- security
- test
- release
- metadata
# ====================
# security stage
# ====================
mirror:
stage: security
script:
- npmci git mirror
only:
- tags
tags:
- lossless
- docker
- notpriv
auditProductionDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --production --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=prod --production
tags:
- docker
auditDevDependencies:
image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
stage: security
script:
- npmci npm prepare
- npmci command npm install --ignore-scripts
- npmci command npm config set registry https://registry.npmjs.org
- npmci command npm audit --audit-level=high --only=dev
tags:
- docker
allow_failure: true
# ====================
# test stage
# ====================
testStable:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci npm test
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
testBuild:
stage: test
script:
- npmci npm prepare
- npmci node install stable
- npmci npm install
- npmci command npm run build
coverage: /\d+.?\d+?\%\s*coverage/
tags:
- docker
release:
stage: release
script:
- npmci node install stable
- npmci npm publish
only:
- tags
tags:
- lossless
- docker
- notpriv
# ====================
# metadata stage
# ====================
codequality:
stage: metadata
allow_failure: true
only:
- tags
script:
- npmci command npm install -g tslint typescript
- npmci npm prepare
- npmci npm install
- npmci command "tslint -c tslint.json ./ts/**/*.ts"
tags:
- lossless
- docker
- priv
trigger:
stage: metadata
script:
- npmci trigger
only:
- tags
tags:
- lossless
- docker
- notpriv
pages:
stage: metadata
script:
- npmci node install lts
- npmci command npm install -g @gitzone/tsdoc
- npmci npm prepare
- npmci npm install
- npmci command tsdoc
tags:
- lossless
- docker
- notpriv
only:
- tags
artifacts:
expire_in: 1 week
paths:
- public
allow_failure: true

4
.snyk

@ -1,4 +0,0 @@
# Snyk (https://snyk.io) policy file, patches or ignores known vulnerabilities.
version: v1.13.5
ignore: {}
patch: {}

24
.vscode/launch.json vendored

@ -2,28 +2,10 @@
"version": "0.2.0", "version": "0.2.0",
"configurations": [ "configurations": [
{ {
"name": "current file", "command": "npm test",
"type": "node", "name": "Run npm test",
"request": "launch", "request": "launch",
"args": [ "type": "node-terminal"
"${relativeFile}"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
},
{
"name": "test.ts",
"type": "node",
"request": "launch",
"args": [
"test/test.ts"
],
"runtimeArgs": ["-r", "@gitzone/tsrun"],
"cwd": "${workspaceRoot}",
"protocol": "inspector",
"internalConsoleOptions": "openOnSessionStart"
} }
] ]
} }

210
changelog.md Normal file

@ -0,0 +1,210 @@
# Changelog
## 2025-04-28 - 4.0.0 - BREAKING CHANGE(smartnetwork)
Enhance documentation and add configurable speed test options with plugin architecture improvements
- Expanded README with detailed examples for traceroute, speed test, ping, and remote port checks
- Added optional parameters for getSpeed (parallelStreams and duration) to allow configurable testing modes
- Included plugin architecture usage examples to show runtime registration and unregistration of plugins
- Updated test suite to cover DNS resolution, endpoint health-check, caching behavior, and various network diagnostics
- Removed legacy planning documentation from readme.plan.md
## 2025-04-28 - 3.0.5 - fix(core)
Improve logging and error handling by introducing custom error classes and a global logging interface while refactoring network diagnostics methods.
- Added custom error classes (NetworkError, TimeoutError) for network operations.
- Introduced a global logging interface to replace direct console logging.
- Updated CloudflareSpeed and SmartNetwork classes to use getLogger for improved error reporting.
- Disabled connection pooling in HTTP requests to prevent listener accumulation.
## 2025-04-28 - 3.0.4 - fix(ci/config)
Improve CI workflows, update project configuration, and clean up code formatting
- Added new Gitea workflow files (default_nottags.yaml and default_tags.yaml) to replace GitLab CI
- Updated package.json with new buildDocs script, revised homepage URL, bug tracking info, and pnpm overrides
- Refined code formatting in TypeScript files, including improved error handling in Cloudflare speed tests and consistent callback structure
- Enhanced tsconfig.json by adding baseUrl and paths for better module resolution
- Introduced readme.plan.md outlining future improvements and feature enhancements
## 2025-04-28 - 3.0.3 - fix(deps)
Update dependency namespaces and bump package versions in CI configuration and source imports
- Renamed dependency imports from '@pushrocks/...' to '@push.rocks/...' in package.json, test files, and source files
- Updated devDependencies versions and package references (e.g., tsbuild, tsrun, tstest, smartenv, tapbundle, smartpromise, smartstring, public-ip, and @types packages)
- Fixed CI command to install '@git.zone/tsdoc' instead of the misspelled '@gitzone/tsdoc'
- Updated commit info file to reflect the correct package namespace
## 2024-05-29 - 3.0.2 - misc
Various documentation, configuration, and organizational updates.
- Updated project description.
- Updated tsconfig configuration.
- Updated npmextra.json (githost configuration) across multiple commits.
- Switched to a new organizational scheme.
## 2022-10-22 - 3.0.1 - core
Core fixes and maintenance applied.
- Fixed core issues.
## 2022-10-21 - 3.0.0 - core
Core updates and fixes.
- Fixed core issues.
## 2022-03-24 - 2.0.14 - core
Breaking changes introduced.
- BREAKING CHANGE: Switched core to an ECMAScript Modules (ESM) approach.
## 2022-02-16 - 2.0.13 - core
Core maintenance update.
- Fixed core issues.
## 2022-02-16 - 2.0.12 - core
Core maintenance update.
- Fixed core issues.
## 2022-02-16 - 2.0.11 - core
Core maintenance update.
- Fixed core issues.
## 2022-02-16 - 2.0.10 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-29 - 2.0.9 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-28 - 2.0.8 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-28 - 2.0.7 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-28 - 2.0.6 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-28 - 2.0.5 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-27 - 2.0.4 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-13 - 2.0.3 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-13 - 2.0.2 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-13 - 2.0.1 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-13 - 2.0.0 - core
Core maintenance update.
- Fixed core issues.
## 2021-04-13 - 1.1.22 - core
Breaking update in core functionality.
- BREAKING CHANGE: Updated core functionality.
## 2020-08-13 - 1.1.21 - core
Core maintenance update.
- Fixed core issues.
## 2020-08-13 - 1.1.20 - core
Core maintenance update.
- Fixed core issues.
## 2020-08-12 - 1.1.19 - core
Core maintenance update.
- Fixed core issues.
## 2020-08-12 - 1.1.18 - core
Core maintenance update.
- Fixed core issues.
## 2019-11-23 - 1.1.17 - minor
Release with no notable changes.
- No significant changes.
## 2019-11-23 - 1.1.16 - core
Core maintenance update.
- Fixed core issues.
## 2019-11-19 - 1.1.15 - security
Security enhancement.
- Added Snyk configuration for improved security.
## 2019-11-19 - 1.1.14 - dependencies
Dependency update.
- Updated dependencies.
## 2019-09-08 - 1.1.13 - core
Core maintenance update.
- Fixed core issues.
## 2019-09-08 - 1.1.12 - core
Core maintenance update.
- Fixed core issues.
## 2019-09-08 - 1.1.11 - core
Core maintenance update.
- Fixed core issues.
## 2019-09-08 - 1.1.10 - core
Core maintenance update.
- Fixed core issues.
## 2019-09-08 - 1.1.9 - core
Core maintenance update.
- Fixed core issues.
## 2019-09-06 - 1.1.8 - core
Core maintenance update.
- Fixed core issues.
## 2019-09-06 - 1.1.7 - core
Core maintenance update.
- Fixed core issues.
## 2019-09-06 - 1.1.6 - core
Core maintenance update.
- Fixed core issues.
## 2019-04-17 - 1.1.5 - core
Core maintenance update.
- Fixed core issues.
## 2019-04-17 - 1.1.4 - core
Core maintenance update.
- Fixed core issues.
## 2019-04-17 - 1.1.3 - core
Core maintenance update.
- Fixed core issues.
## 2019-04-17 - 1.1.2 - core
Core maintenance update.
- Fixed core issues.
## 2019-04-16 - 1.1.1 - core
Core maintenance update.
- Fixed core issues.
## 2019-04-16 - 1.1.0 - core
Core maintenance update.
- Fixed core issues.
## 2018-07-17 - 1.0.2 - feature
New feature added.
- Added port checking functionality.
## 2017-12-12 - 1.0.1 - initial
Initial commit.
- Initial project setup.

@ -6,12 +6,27 @@
"gitzone": { "gitzone": {
"projectType": "npm", "projectType": "npm",
"module": { "module": {
"githost": "gitlab.com", "githost": "code.foss.global",
"gitscope": "pushrocks", "gitscope": "push.rocks",
"gitrepo": "smartnetwork", "gitrepo": "smartnetwork",
"shortDescription": "network diagnostics", "description": "A toolkit for network diagnostics including speed tests, port availability checks, and more.",
"npmPackagename": "@pushrocks/smartnetwork", "npmPackagename": "@push.rocks/smartnetwork",
"license": "MIT" "license": "MIT",
"keywords": [
"network diagnostics",
"ping",
"port check",
"speed test",
"network interface",
"public IP retrieval",
"Cloudflare speed test",
"network performance",
"network utility",
"TypeScript"
]
} }
},
"tsdoc": {
"legal": "\n## License and Legal Information\n\nThis repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository. \n\n**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.\n\n### Trademarks\n\nThis project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.\n\n### Company Information\n\nTask Venture Capital GmbH \nRegistered at District court Bremen HRB 35230 HB, Germany\n\nFor any legal inquiries or if you require further information, please contact us via email at hello@task.vc.\n\nBy using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.\n"
} }
} }

13393
package-lock.json generated

File diff suppressed because it is too large Load Diff

@ -1,31 +1,34 @@
{ {
"name": "@pushrocks/smartnetwork", "name": "@push.rocks/smartnetwork",
"version": "2.0.6", "version": "4.0.0",
"private": false, "private": false,
"description": "network diagnostics", "description": "A toolkit for network diagnostics including speed tests, port availability checks, and more.",
"main": "dist_ts/index.js", "main": "dist_ts/index.js",
"typings": "dist_ts/index.d.ts", "typings": "dist_ts/index.d.ts",
"type": "module",
"author": "Lossless GmbH", "author": "Lossless GmbH",
"license": "MIT", "license": "MIT",
"scripts": { "scripts": {
"test": "(tstest test/)", "test": "(tstest test/)",
"build": "(tsbuild --web)" "build": "(tsbuild --web --allowimplicitany)",
"buildDocs": "tsdoc"
}, },
"devDependencies": { "devDependencies": {
"@gitzone/tsbuild": "^2.1.25", "@git.zone/tsbuild": "^2.1.61",
"@gitzone/tstest": "^1.0.52", "@git.zone/tsrun": "^1.2.39",
"@pushrocks/tapbundle": "^3.2.14", "@git.zone/tstest": "^1.0.69",
"tslint": "^6.1.3", "@push.rocks/smartenv": "^5.0.0",
"tslint-config-prettier": "^1.18.0" "@push.rocks/tapbundle": "^5.0.3",
"@types/node": "^22.15.3"
}, },
"dependencies": { "dependencies": {
"@pushrocks/smartpromise": "^3.1.3", "@push.rocks/smartping": "^1.0.7",
"@pushrocks/smartstring": "^3.0.24", "@push.rocks/smartpromise": "^4.2.3",
"@types/default-gateway": "^3.0.1", "@push.rocks/smartstring": "^4.0.2",
"@types/default-gateway": "^7.2.2",
"isopen": "^1.3.0", "isopen": "^1.3.0",
"public-ip": "^4.0.3", "public-ip": "^7.0.1",
"speedtest-net": "^2.1.1", "systeminformation": "^5.11.9"
"systeminformation": "^5.6.12"
}, },
"files": [ "files": [
"ts/**/*", "ts/**/*",
@ -41,5 +44,29 @@
], ],
"browserslist": [ "browserslist": [
"last 1 chrome versions" "last 1 chrome versions"
] ],
"keywords": [
"network diagnostics",
"ping",
"port check",
"speed test",
"network interface",
"public IP retrieval",
"Cloudflare speed test",
"network performance",
"network utility",
"TypeScript"
],
"homepage": "https://code.foss.global/push.rocks/smartnetwork#readme",
"repository": {
"type": "git",
"url": "https://code.foss.global/push.rocks/smartnetwork.git"
},
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6",
"bugs": {
"url": "https://code.foss.global/push.rocks/smartnetwork/issues"
},
"pnpm": {
"overrides": {}
}
} }

9958
pnpm-lock.yaml generated Normal file

File diff suppressed because it is too large Load Diff

1
readme.hints.md Normal file

@ -0,0 +1 @@

216
readme.md

@ -1,61 +1,183 @@
# @pushrocks/smartnetwork # @push.rocks/smartnetwork
network diagnostics network diagnostics
## Availabililty and Links ## Install
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartnetwork)
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartnetwork)
* [github.com (source mirror)](https://github.com/pushrocks/smartnetwork)
* [docs (typedoc)](https://pushrocks.gitlab.io/smartnetwork/)
## Status for master To install `@push.rocks/smartnetwork`, run the following command in your terminal:
Status Category | Status Badge ```bash
-- | -- npm install @push.rocks/smartnetwork --save
GitLab Pipelines | [![pipeline status](https://gitlab.com/pushrocks/smartnetwork/badges/master/pipeline.svg)](https://lossless.cloud) ```
GitLab Pipline Test Coverage | [![coverage report](https://gitlab.com/pushrocks/smartnetwork/badges/master/coverage.svg)](https://lossless.cloud)
npm | [![npm downloads per month](https://badgen.net/npm/dy/@pushrocks/smartnetwork)](https://lossless.cloud) ### Performing a Traceroute
Snyk | [![Known Vulnerabilities](https://badgen.net/snyk/pushrocks/smartnetwork)](https://lossless.cloud)
TypeScript Support | [![TypeScript](https://badgen.net/badge/TypeScript/>=%203.x/blue?icon=typescript)](https://lossless.cloud) You can perform a hop-by-hop traceroute to measure latency per hop. Falls back to a single-hop stub if the `traceroute` binary is unavailable.
node Support | [![node](https://img.shields.io/badge/node->=%2010.x.x-blue.svg)](https://nodejs.org/dist/latest-v10.x/docs/api/)
Code Style | [![Code Style](https://badgen.net/badge/style/prettier/purple)](https://lossless.cloud) ```typescript
PackagePhobia (total standalone install weight) | [![PackagePhobia](https://badgen.net/packagephobia/install/@pushrocks/smartnetwork)](https://lossless.cloud) const hops = await myNetwork.traceroute('google.com', { maxHops: 10, timeout: 5000 });
PackagePhobia (package size on registry) | [![PackagePhobia](https://badgen.net/packagephobia/publish/@pushrocks/smartnetwork)](https://lossless.cloud) hops.forEach(h =>
BundlePhobia (total size when bundled) | [![BundlePhobia](https://badgen.net/bundlephobia/minzip/@pushrocks/smartnetwork)](https://lossless.cloud) console.log(`${h.ttl}\t${h.ip}\t${h.rtt === null ? '*' : h.rtt + ' ms'}`),
Platform support | [![Supports Windows 10](https://badgen.net/badge/supports%20Windows%2010/yes/green?icon=windows)](https://lossless.cloud) [![Supports Mac OS X](https://badgen.net/badge/supports%20Mac%20OS%20X/yes/green?icon=apple)](https://lossless.cloud) );
```
This command will download `@push.rocks/smartnetwork` and add it to your project's `package.json` file.
## Usage ## Usage
In this section, we will dive deep into the capabilities of the `@push.rocks/smartnetwork` package, exploring its various features through TypeScript examples. The package is designed to simplify network diagnostics tasks, including speed tests, port availability checks, ping operations, and more.
### Basic Setup
First, import the package into your project:
```typescript ```typescript
import * as smartnetwork from 'smartnetwork'; import { SmartNetwork } from '@push.rocks/smartnetwork';
const testSmartNetwork = new smartnetwork.SmartNetwork();
const run = async () => {
// measure average speed over a period of 5 seconds
// the structure of speedResult is self explanatory using TypeScript (or the linked TypeDoc above)
const speedResult: smartnetwork.SpeedResult = testSmartNetwork.getSpeed(5000);
// you can check for local ports before trying to bind to it from your nodejs program
const isLocalPortUnused: boolean = await testSmartNetwork.isLocalPortUnused(1234);
// you can run basic port checks on remote domains.
const isRemotePortAvailable: boolean = await testSmartNetwork.isRemotePortAvailable(
'google.com:80'
);
// just another way to call for the same thing as above
const isRemotePortAvailable: boolean = await testSmartNetwork.isRemotePortAvailable(
'google.com',
80
);
};
``` ```
## Contribution Then, create an instance of `SmartNetwork`:
We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :) ```typescript
const myNetwork = new SmartNetwork();
```
For further information read the linked docs at the top of this readme. ### Performing a Speed Test
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh) You can measure the network speed using the `getSpeed` method. It supports optional parameters:
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy) - `parallelStreams`: number of concurrent streams (default: 1)
- `duration`: test duration in seconds (default: fixed segments)
[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com) ```typescript
const speedTest = async () => {
// Default fixed-segment test
let r = await myNetwork.getSpeed();
console.log(`Download: ${r.downloadSpeed} Mbps, Upload: ${r.uploadSpeed} Mbps`);
// Parallel + duration-based test
r = await myNetwork.getSpeed({ parallelStreams: 3, duration: 5 });
console.log(`Download: ${r.downloadSpeed} Mbps, Upload: ${r.uploadSpeed} Mbps`);
};
speedTest();
```
### Checking Port Availability Locally
The `isLocalPortUnused` method allows you to check if a specific port on your local machine is available for use.
```typescript
const checkLocalPort = async (port: number) => {
const isUnused = await myNetwork.isLocalPortUnused(port);
if (isUnused) {
console.log(`Port ${port} is available.`);
} else {
console.log(`Port ${port} is in use.`);
}
};
checkLocalPort(8080); // Example port number
```
### Checking Remote Port Availability
To verify if a port is available on a remote server, use `isRemotePortAvailable`. You can specify target as `"host:port"` or host plus a numeric port.
```typescript
// Using "host:port"
await myNetwork.isRemotePortAvailable('example.com:443');
// Using host + port
await myNetwork.isRemotePortAvailable('example.com', 443);
// UDP is not supported:
try {
await myNetwork.isRemotePortAvailable('example.com', { port: 53, protocol: 'udp' });
} catch (e) {
console.error((e as any).code); // ENOTSUP
}
```
### Using Ping
The `ping` method sends ICMP echo requests and optionally repeats them to collect statistics.
```typescript
// Single ping
const p1 = await myNetwork.ping('google.com');
console.log(`Alive: ${p1.alive}, RTT: ${p1.time} ms`);
// Multiple pings with statistics
const stats = await myNetwork.ping('google.com', { count: 5 });
console.log(
`min=${stats.min} ms, max=${stats.max} ms, avg=${stats.avg.toFixed(2)} ms, loss=${stats.packetLoss}%`,
);
```
### Getting Network Gateways
You can also retrieve network interfaces (gateways) and determine the default gateway. Caching with TTL is supported via constructor options.
```typescript
// Create with cache TTL of 60 seconds
const netCached = new SmartNetwork({ cacheTtl: 60000 });
// List all interfaces
const gateways = await netCached.getGateways();
console.log(gateways);
// Get default gateway
const defaultGw = await netCached.getDefaultGateway();
console.log(defaultGw);
```
### Discovering Public IP Addresses
To find out your public IPv4 and IPv6 addresses (with caching):
```typescript
const publicIps = await netCached.getPublicIps();
console.log(`Public IPv4: ${publicIps.v4}`);
console.log(`Public IPv6: ${publicIps.v6}`);
```
The `@push.rocks/smartnetwork` package provides an easy-to-use, comprehensive suite of tools for network diagnostics and monitoring, encapsulating complex network operations into simple asynchronous methods. By leveraging TypeScript, developers can benefit from type checking, ensuring that they can work with clear structures and expectations.
These examples offer a glimpse into the module's utility in real-world scenarios, demonstrating its versatility in handling common network tasks. Whether you're developing a network-sensitive application, diagnosing connectivity issues, or simply curious about your network performance, `@push.rocks/smartnetwork` equips you with the tools you need.
### Plugin Architecture
You can extend `SmartNetwork` with custom plugins by registering them at runtime:
```typescript
import { SmartNetwork } from '@push.rocks/smartnetwork';
// Define your plugin class or constructor
class MyCustomPlugin {
// plugin implementation goes here
}
// Register and unregister your plugin by name
SmartNetwork.registerPlugin('myPlugin', MyCustomPlugin);
// Later, remove it if no longer needed
SmartNetwork.unregisterPlugin('myPlugin');
```
Plugins enable you to dynamically augment the core functionality without altering the library's source.
## License and Legal Information
This repository contains open-source code that is licensed under the MIT License. A copy of the MIT License can be found in the [license](license) file within this repository.
**Please note:** The MIT License does not grant permission to use the trade names, trademarks, service marks, or product names of the project, except as required for reasonable and customary use in describing the origin of the work and reproducing the content of the NOTICE file.
### Trademarks
This project is owned and maintained by Task Venture Capital GmbH. The names and logos associated with Task Venture Capital GmbH and any related products or services are trademarks of Task Venture Capital GmbH and are not included within the scope of the MIT license granted herein. Use of these trademarks must comply with Task Venture Capital GmbH's Trademark Guidelines, and any usage must be approved in writing by Task Venture Capital GmbH.
### Company Information
Task Venture Capital GmbH
Registered at District court Bremen HRB 35230 HB, Germany
For any legal inquiries or if you require further information, please contact us via email at hello@task.vc.
By using this repository, you acknowledge that you have read this section, agree to comply with its terms, and understand that the licensing of the code does not imply endorsement by Task Venture Capital GmbH of any derivative works.

191
test/test.features.ts Normal file

@ -0,0 +1,191 @@
import { tap, expect, expectAsync } from '@push.rocks/tapbundle';
import { SmartNetwork, NetworkError } from '../ts/index.js';
import * as net from 'net';
import type { AddressInfo } from 'net';
// DNS resolution
tap.test('resolveDns should return A records for localhost', async () => {
const sn = new SmartNetwork();
const res = await sn.resolveDns('localhost');
expect(res.A.length).toBeGreaterThan(0);
expect(Array.isArray(res.A)).toBeTrue();
expect(Array.isArray(res.AAAA)).toBeTrue();
expect(Array.isArray(res.MX)).toBeTrue();
});
// DNS resolution edge cases and MX records
tap.test('resolveDns should handle non-existent domains', async () => {
const sn = new SmartNetwork();
const res = await sn.resolveDns('no.such.domain.invalid');
expect(Array.isArray(res.A)).toBeTrue();
expect(Array.isArray(res.AAAA)).toBeTrue();
expect(Array.isArray(res.MX)).toBeTrue();
expect(res.A.length).toEqual(0);
expect(res.AAAA.length).toEqual(0);
expect(res.MX.length).toEqual(0);
});
tap.test('resolveDns MX records for google.com', async () => {
const sn = new SmartNetwork();
const res = await sn.resolveDns('google.com');
expect(Array.isArray(res.MX)).toBeTrue();
if (res.MX.length > 0) {
expect(typeof res.MX[0].exchange).toEqual('string');
expect(typeof res.MX[0].priority).toEqual('number');
}
});
// HTTP endpoint health-check
tap.test('checkEndpoint should return status and headers', async () => {
const sn = new SmartNetwork();
const result = await sn.checkEndpoint('https://example.com');
expect(result.status).toEqual(200);
expect(typeof result.rtt).toEqual('number');
expect(typeof result.headers).toEqual('object');
expect(result.headers).toHaveProperty('content-type');
});
// Traceroute stub
tap.test('traceroute should return at least one hop', async () => {
const sn = new SmartNetwork();
const hops = await sn.traceroute('127.0.0.1');
expect(Array.isArray(hops)).toBeTrue();
expect(hops.length).toBeGreaterThanOrEqual(1);
const hop = hops[0];
expect(typeof hop.ttl).toEqual('number');
expect(typeof hop.ip).toEqual('string');
expect(hop.rtt === null || typeof hop.rtt === 'number').toBeTrue();
});
// Traceroute fallback stub ensures consistent output when binary missing
tap.test('traceroute fallback stub returns a single-hop stub', async () => {
const sn = new SmartNetwork();
const hops = await sn.traceroute('example.com', { maxHops: 5 });
expect(Array.isArray(hops)).toBeTrue();
expect(hops).toHaveLength(1);
expect(hops[0]).toEqual({ ttl: 1, ip: 'example.com', rtt: null });
});
// getSpeed options
tap.test('getSpeed should accept options and return speeds', async () => {
const opts = { parallelStreams: 2, duration: 1 };
const sn = new SmartNetwork();
const result = await sn.getSpeed(opts);
expect(typeof result.downloadSpeed).toEqual('string');
expect(typeof result.uploadSpeed).toEqual('string');
expect(parseFloat(result.downloadSpeed)).toBeGreaterThan(0);
expect(parseFloat(result.uploadSpeed)).toBeGreaterThan(0);
expect(parseFloat(result.downloadSpeed)).toBeGreaterThan(0);
expect(parseFloat(result.uploadSpeed)).toBeGreaterThan(0);
});
// Ping multiple count
tap.test('ping with count > 1 should return stats', async () => {
const sn = new SmartNetwork();
const stats = await sn.ping('127.0.0.1', { count: 3 });
expect(stats.count).toEqual(3);
expect(Array.isArray(stats.times)).toBeTrue();
expect(stats.times.length).toEqual(3);
expect(typeof stats.min).toEqual('number');
expect(typeof stats.max).toEqual('number');
expect(typeof stats.avg).toEqual('number');
expect(typeof stats.stddev).toEqual('number');
expect(typeof stats.packetLoss).toEqual('number');
expect(typeof stats.alive).toEqual('boolean');
});
// Remote port UDP not supported
// Remote port UDP not supported
tap.test('isRemotePortAvailable should throw on UDP', async () => {
const sn = new SmartNetwork();
// should throw NetworkError with code ENOTSUP when protocol is UDP
try {
await sn.isRemotePortAvailable('example.com', { protocol: 'udp' });
// If no error is thrown, the test should fail
throw new Error('Expected isRemotePortAvailable to throw for UDP');
} catch (err: any) {
expect(err).toBeInstanceOf(NetworkError);
expect(err.code).toEqual('ENOTSUP');
}
});
// Plugin registry
tap.test('should register and unregister plugin', async () => {
class Dummy {}
SmartNetwork.registerPlugin('dummy', Dummy);
expect(SmartNetwork.pluginsRegistry.has('dummy')).toBeTrue();
SmartNetwork.unregisterPlugin('dummy');
expect(SmartNetwork.pluginsRegistry.has('dummy')).toBeFalse();
});
tap.test('getGateways should respect cacheTtl', async () => {
const sn = new SmartNetwork({ cacheTtl: 1000 });
const first = await sn.getGateways();
const second = await sn.getGateways();
expect(first).toEqual(second);
});
// Remote port checks: missing port should error
tap.test('isRemotePortAvailable should require a port', async () => {
const sn = new SmartNetwork();
try {
await sn.isRemotePortAvailable('example.com');
throw new Error('Expected error when port is not specified');
} catch (err: any) {
expect(err).toBeInstanceOf(NetworkError);
expect(err.code).toEqual('EINVAL');
}
});
// Remote port checks: detect open TCP port on example.com
tap.test('isRemotePortAvailable should detect open TCP port via string target', async () => {
const sn = new SmartNetwork();
const open = await sn.isRemotePortAvailable('example.com:80');
expect(open).toBeTrue();
});
tap.test('isRemotePortAvailable should detect open TCP port via numeric arg', async () => {
const sn = new SmartNetwork();
const open = await sn.isRemotePortAvailable('example.com', 80);
expect(open).toBeTrue();
});
// Caching public IPs
tap.test('getPublicIps should respect cacheTtl', async () => {
const sn = new SmartNetwork({ cacheTtl: 1000 });
const first = await sn.getPublicIps();
const second = await sn.getPublicIps();
expect(first).toEqual(second);
});
// Local port usage detection
tap.test('isLocalPortUnused should detect used local port', async () => {
const sn = new SmartNetwork();
// start a server on a random port
const server = net.createServer();
await new Promise<void>((res) => server.listen(0, res));
const addr = server.address() as AddressInfo;
// port is now in use
const inUse = await sn.isLocalPortUnused(addr.port);
expect(inUse).toBeFalse();
await new Promise<void>((res) => server.close(res));
});
// Real traceroute integration test (skipped if `traceroute` binary is unavailable)
tap.test('traceroute real integration against google.com', async () => {
const sn = new SmartNetwork();
// detect traceroute binary
const { spawnSync } = await import('child_process');
const probe = spawnSync('traceroute', ['-h']);
if (probe.error || probe.status !== 0) {
// Skip real integration when traceroute is not installed
return;
}
const hops = await sn.traceroute('google.com', { maxHops: 5, timeout: 5000 });
expect(Array.isArray(hops)).toBeTrue();
expect(hops.length).toBeGreaterThan(1);
for (const hop of hops) {
expect(typeof hop.ttl).toEqual('number');
expect(typeof hop.ip).toEqual('string');
expect(hop.rtt === null || typeof hop.rtt === 'number').toBeTrue();
}
});
tap.start();

30
test/test.ping.ts Normal file

@ -0,0 +1,30 @@
import { tap, expect, expectAsync } from '@push.rocks/tapbundle';
import * as smartnetwork from '../ts/index.js';
let testSmartnetwork: smartnetwork.SmartNetwork;
tap.test('should create a vlid instance of SmartNetwork', async () => {
testSmartnetwork = new smartnetwork.SmartNetwork();
expect(testSmartnetwork).toBeInstanceOf(smartnetwork.SmartNetwork);
});
tap.test('should send a ping to Google', async () => {
const res = await testSmartnetwork.ping('google.com');
console.log(res);
// verify basic ping response properties
expect(res.alive).toBeTrue();
expect(res.time).toBeTypeofNumber();
expect(res.output).toBeTypeofString();
expect(res.output).toMatch(/PING google\.com/);
});
tap.test('should state when a ping is not alive ', async () => {
await expectAsync(testSmartnetwork.ping('notthere.lossless.com')).property('alive').toBeFalse();
});
tap.test('should send a ping to an IP', async () => {
await expectAsync(testSmartnetwork.ping('192.168.186.999')).property('alive').toBeFalse();
});
tap.start();

@ -1,41 +1,57 @@
import { expect, tap } from '@pushrocks/tapbundle'; import { expect, expectAsync, tap } from '@push.rocks/tapbundle';
import * as smartnetwork from '../ts/index'; import * as smartnetwork from '../ts/index.js';
let testSmartNetwork: smartnetwork.SmartNetwork; let testSmartNetwork: smartnetwork.SmartNetwork;
tap.test('should create a valid instance of SmartNetwork', async () => { tap.test('should create a valid instance of SmartNetwork', async () => {
testSmartNetwork = new smartnetwork.SmartNetwork(); testSmartNetwork = new smartnetwork.SmartNetwork();
expect(testSmartNetwork).to.be.instanceOf(smartnetwork.SmartNetwork); expect(testSmartNetwork).toBeInstanceOf(smartnetwork.SmartNetwork);
}); });
tap.test('should perform a speedtest', async () => { tap.test('should perform a speedtest', async () => {
const result = await testSmartNetwork.getSpeed(); const result = await testSmartNetwork.getSpeed();
console.log(result); console.log(`Download speed for this instance is ${result.downloadSpeed}`);
console.log(`Upload speed for this instance is ${result.uploadSpeed}`);
// verify speeds are returned as strings and parse to positive numbers
expect(typeof result.downloadSpeed).toEqual('string');
expect(typeof result.uploadSpeed).toEqual('string');
expect(parseFloat(result.downloadSpeed)).toBeGreaterThan(0);
expect(parseFloat(result.uploadSpeed)).toBeGreaterThan(0);
}); });
tap.test('should determine wether a port is free', async () => { tap.test('should determine wether a port is free', async () => {
await expect(testSmartNetwork.isLocalPortUnused(8080)).to.eventually.be.true; await expectAsync(testSmartNetwork.isLocalPortUnused(8080)).toBeTrue();
}); });
tap.test('should scan a port', async () => { tap.test('should scan a port', async () => {
await expect(testSmartNetwork.isRemotePortAvailable('lossless.com:443')).to.eventually.be.true; await expectAsync(testSmartNetwork.isRemotePortAvailable('lossless.com:443')).toBeTrue();
await expect(testSmartNetwork.isRemotePortAvailable('lossless.com', 443)).to.be.eventually.true; await expectAsync(testSmartNetwork.isRemotePortAvailable('lossless.com', 443)).toBeTrue();
// await expect(testSmartNetwork.isRemotePortAvailable('lossless.com:444')).to.eventually.be.false; await expectAsync(testSmartNetwork.isRemotePortAvailable('lossless.com:444')).toBeFalse();
}); });
tap.test('should get gateways', async () => { tap.test('should get gateways', async () => {
const gatewayResult = await testSmartNetwork.getGateways(); const gateways = await testSmartNetwork.getGateways();
console.log(gatewayResult); console.log(gateways);
// verify gateways object has at least one interface
expect(typeof gateways).toEqual('object');
expect(Object.keys(gateways).length).toBeGreaterThan(0);
}); });
tap.test('should get the default gateway', async () => { tap.test('should get the default gateway', async () => {
const gatewayResult = await testSmartNetwork.getDefaultGateway(); const defaultGw = await testSmartNetwork.getDefaultGateway();
console.log(gatewayResult); console.log(defaultGw);
// verify default gateway contains ipv4 and ipv6 info
expect(defaultGw).toBeDefined();
expect(defaultGw.ipv4).toBeDefined();
expect(defaultGw.ipv6).toBeDefined();
}); });
tap.test('should get public ips', async () => { tap.test('should get public ips', async () => {
const ips = await testSmartNetwork.getPublicIps(); const ips = await testSmartNetwork.getPublicIps();
console.log(ips); console.log(ips);
// verify public IPs object contains v4 and v6 properties
expect(ips).toHaveProperty('v4');
expect(ips).toHaveProperty('v6');
}); });
tap.start(); tap.start();

8
ts/00_commitinfo_data.ts Normal file

@ -0,0 +1,8 @@
/**
* autocreated commitinfo by @push.rocks/commitinfo
*/
export const commitinfo = {
name: '@push.rocks/smartnetwork',
version: '4.0.0',
description: 'A toolkit for network diagnostics including speed tests, port availability checks, and more.'
}

20
ts/errors.ts Normal file

@ -0,0 +1,20 @@
/**
* Custom error classes for network operations
*/
export class NetworkError extends Error {
public code?: string;
constructor(message?: string, code?: string) {
super(message);
this.name = 'NetworkError';
this.code = code;
Object.setPrototypeOf(this, new.target.prototype);
}
}
export class TimeoutError extends NetworkError {
constructor(message?: string) {
super(message, 'ETIMEOUT');
this.name = 'TimeoutError';
Object.setPrototypeOf(this, new.target.prototype);
}
}

@ -1,4 +1,4 @@
export function average(values) { export function average(values: number[]) {
let total = 0; let total = 0;
for (let i = 0; i < values.length; i += 1) { for (let i = 0; i < values.length; i += 1) {
@ -8,7 +8,7 @@ export function average(values) {
return total / values.length; return total / values.length;
} }
export function median(values) { export function median(values: number[]) {
const half = Math.floor(values.length / 2); const half = Math.floor(values.length / 2);
values.sort((a, b) => a - b); values.sort((a, b) => a - b);
@ -18,7 +18,7 @@ export function median(values) {
return (values[half - 1] + values[half]) / 2; return (values[half - 1] + values[half]) / 2;
} }
export function quartile(values, percentile) { export function quartile(values: number[], percentile: number) {
values.sort((a, b) => a - b); values.sort((a, b) => a - b);
const pos = (values.length - 1) * percentile; const pos = (values.length - 1) * percentile;
const base = Math.floor(pos); const base = Math.floor(pos);
@ -31,7 +31,7 @@ export function quartile(values, percentile) {
return values[base]; return values[base];
} }
export function jitter(values) { export function jitter(values: number[]) {
// Average distance between consecutive latency measurements... // Average distance between consecutive latency measurements...
let jitters = []; let jitters = [];

@ -1 +1,4 @@
export * from './smartnetwork.classes.smartnetwork'; export * from './smartnetwork.classes.smartnetwork.js';
export type { SmartNetworkOptions, Hop } from './smartnetwork.classes.smartnetwork.js';
export { setLogger, getLogger } from './logging.js';
export { NetworkError, TimeoutError } from './errors.js';

30
ts/logging.ts Normal file

@ -0,0 +1,30 @@
/**
* Injectable logging interface and global logger
*/
export interface Logger {
/** Debug-level messages */
debug?(...args: unknown[]): void;
/** Informational messages */
info(...args: unknown[]): void;
/** Warning messages */
warn?(...args: unknown[]): void;
/** Error messages */
error(...args: unknown[]): void;
}
let globalLogger: Logger = console;
/**
* Replace the global logger implementation
* @param logger Custom logger adhering to Logger interface
*/
export function setLogger(logger: Logger): void {
globalLogger = logger;
}
/**
* Retrieve the current global logger
*/
export function getLogger(): Logger {
return globalLogger;
}

@ -1,8 +1,17 @@
import * as plugins from './smartnetwork.plugins'; import * as plugins from './smartnetwork.plugins.js';
import * as stats from './helpers/stats'; import { getLogger } from './logging.js';
import { NetworkError, TimeoutError } from './errors.js';
import * as stats from './helpers/stats.js';
export interface SpeedOptions {
parallelStreams?: number;
duration?: number;
}
export class CloudflareSpeed { export class CloudflareSpeed {
constructor() {} private opts: SpeedOptions;
constructor(opts?: SpeedOptions) {
this.opts = opts || {};
}
public async speedTest() { public async speedTest() {
const latency = await this.measureLatency(); const latency = await this.measureLatency();
@ -10,6 +19,73 @@ export class CloudflareSpeed {
const serverLocations = await this.fetchServerLocations(); const serverLocations = await this.fetchServerLocations();
const cgiData = await this.fetchCfCdnCgiTrace(); const cgiData = await this.fetchCfCdnCgiTrace();
// speed tests: either fixed segments or duration-based mode
const parallel = this.opts.parallelStreams ?? 1;
const measureDownloadParallel = (bytes: number, iterations: number) => {
if (parallel <= 1) {
return this.measureDownload(bytes, iterations);
}
return Promise.all(
Array(parallel)
.fill(null)
.map(() => this.measureDownload(bytes, iterations)),
).then((arrays) => arrays.flat());
};
let downloadTests: number[];
if (this.opts.duration && this.opts.duration > 0) {
// duration-based download: run for specified seconds
downloadTests = [];
const durMs = this.opts.duration * 1000;
const startMs = Date.now();
// use medium chunk size for download
const chunkBytes = 25001000;
while (Date.now() - startMs < durMs) {
const speeds = await measureDownloadParallel(chunkBytes, 1);
downloadTests.push(...speeds);
}
if (downloadTests.length === 0) downloadTests = [0];
} else {
// fixed download segments
const t1 = await measureDownloadParallel(101000, 10);
const t2 = await measureDownloadParallel(1001000, 8);
const t3 = await measureDownloadParallel(10001000, 6);
const t4 = await measureDownloadParallel(25001000, 4);
const t5 = await measureDownloadParallel(100001000, 1);
downloadTests = [...t1, ...t2, ...t3, ...t4, ...t5];
}
const speedDownload = stats.quartile(downloadTests, 0.9).toFixed(2);
// lets test the upload speed with configurable parallel streams
const measureUploadParallel = (bytes: number, iterations: number) => {
if (parallel <= 1) {
return this.measureUpload(bytes, iterations);
}
return Promise.all(
Array(parallel)
.fill(null)
.map(() => this.measureUpload(bytes, iterations)),
).then((arrays) => arrays.flat());
};
let uploadTests: number[];
if (this.opts.duration && this.opts.duration > 0) {
// duration-based upload: run for specified seconds
uploadTests = [];
const durMsUp = this.opts.duration * 1000;
const startMsUp = Date.now();
const chunkBytesUp = 1001000;
while (Date.now() - startMsUp < durMsUp) {
const speeds = await measureUploadParallel(chunkBytesUp, 1);
uploadTests.push(...speeds);
}
if (uploadTests.length === 0) uploadTests = [0];
} else {
const u1 = await measureUploadParallel(11000, 10);
const u2 = await measureUploadParallel(101000, 10);
const u3 = await measureUploadParallel(1001000, 8);
uploadTests = [...u1, ...u2, ...u3];
}
const speedUpload = stats.quartile(uploadTests, 0.9).toFixed(2);
return { return {
...latency, ...latency,
ip: cgiData.ip, ip: cgiData.ip,
@ -17,7 +93,9 @@ export class CloudflareSpeed {
shortId: cgiData.colo, shortId: cgiData.colo,
name: serverLocations[cgiData.colo], name: serverLocations[cgiData.colo],
availableLocations: serverLocations, availableLocations: serverLocations,
} },
downloadSpeed: speedDownload,
uploadSpeed: speedUpload,
}; };
} }
@ -31,8 +109,8 @@ export class CloudflareSpeed {
measurements.push(response[4] - response[0] - response[6]); measurements.push(response[4] - response[0] - response[6]);
}, },
(error) => { (error) => {
console.log(`Error: ${error}`); getLogger().error('Error measuring latency:', error);
} },
); );
} }
@ -42,21 +120,60 @@ export class CloudflareSpeed {
averageTime: stats.average(measurements), averageTime: stats.average(measurements),
medianTime: stats.median(measurements), medianTime: stats.median(measurements),
jitter: stats.jitter(measurements), jitter: stats.jitter(measurements),
};
} }
; public async measureDownload(bytes: number, iterations: number) {
const measurements: number[] = [];
for (let i = 0; i < iterations; i += 1) {
await this.download(bytes).then(
async (response) => {
const transferTime = response[5] - response[4];
measurements.push(await this.measureSpeed(bytes, transferTime));
},
(error) => {
getLogger().error('Error measuring download chunk:', error);
},
);
} }
public async fetchServerLocations(): Promise<{[key: string]: string}> { return measurements;
const res = JSON.parse(await this.get('speed.cloudflare.com', '/locations')); }
return res.reduce((data, { iata, city }) => { public async measureUpload(bytes: number, iterations: number) {
// Bypass prettier "no-assign-param" rules const measurements: number[] = [];
const data1 = data;
data1[iata] = city; for (let i = 0; i < iterations; i += 1) {
return data1; await this.upload(bytes).then(
}, {}); async (response) => {
const transferTime = response[6];
measurements.push(await this.measureSpeed(bytes, transferTime));
},
(error) => {
getLogger().error('Error measuring upload chunk:', error);
},
);
}
return measurements;
}
public async measureSpeed(bytes: number, duration: number) {
return (bytes * 8) / (duration / 1000) / 1e6;
}
public async fetchServerLocations(): Promise<{ [key: string]: string }> {
const res = JSON.parse(
await this.get('speed.cloudflare.com', '/locations'),
) as Array<{ iata: string; city: string }>;
return res.reduce(
(data: Record<string, string>, optionsArg) => {
data[optionsArg.iata] = optionsArg.city;
return data;
},
{} as Record<string, string>,
);
} }
public async get(hostname: string, path: string): Promise<string> { public async get(hostname: string, path: string): Promise<string> {
@ -66,9 +183,11 @@ export class CloudflareSpeed {
hostname, hostname,
path, path,
method: 'GET', method: 'GET',
// disable connection pooling to avoid listener accumulation
agent: false,
}, },
(res) => { (res) => {
const body = []; const body: Array<Buffer> = [];
res.on('data', (chunk) => { res.on('data', (chunk) => {
body.push(chunk); body.push(chunk);
}); });
@ -79,17 +198,17 @@ export class CloudflareSpeed {
reject(e); reject(e);
} }
}); });
req.on('error', (err) => { req.on('error', (err: Error & { code?: string }) => {
reject(err); reject(new NetworkError(err.message, err.code));
}); });
} },
); );
req.end(); req.end();
}); });
} }
public async download(bytes) { public async download(bytes: number) {
const options = { const options = {
hostname: 'speed.cloudflare.com', hostname: 'speed.cloudflare.com',
path: `/__down?bytes=${bytes}`, path: `/__down?bytes=${bytes}`,
@ -99,17 +218,33 @@ export class CloudflareSpeed {
return this.request(options); return this.request(options);
} }
public async request(options, data = '') { public async upload(bytes: number) {
let started; const data = '0'.repeat(bytes);
let dnsLookup; const options = {
let tcpHandshake; hostname: 'speed.cloudflare.com',
let sslHandshake; path: '/__up',
let ttfb; method: 'POST',
let ended; headers: {
'Content-Length': Buffer.byteLength(data),
},
};
return this.request(options, data);
}
public async request(options: plugins.https.RequestOptions, data = ''): Promise<number[]> {
let started: number;
let dnsLookup: number;
let tcpHandshake: number;
let sslHandshake: number;
let ttfb: number;
let ended: number;
return new Promise((resolve, reject) => { return new Promise((resolve, reject) => {
started = plugins.perfHooks.performance.now(); started = plugins.perfHooks.performance.now();
const req = plugins.https.request(options, (res) => { // disable connection pooling to avoid listener accumulation across requests
const reqOptions = { ...options, agent: false };
const req = plugins.https.request(reqOptions, (res) => {
res.once('readable', () => { res.once('readable', () => {
ttfb = plugins.perfHooks.performance.now(); ttfb = plugins.perfHooks.performance.now();
}); });
@ -123,25 +258,26 @@ export class CloudflareSpeed {
sslHandshake, sslHandshake,
ttfb, ttfb,
ended, ended,
parseFloat(res.headers['server-timing'].slice(22) as any), parseFloat((res.headers['server-timing'] as string).slice(22)),
]); ]);
}); });
}); });
req.on('socket', (socket) => { // Listen for timing events once per new socket
socket.on('lookup', () => { req.once('socket', (socket) => {
socket.once('lookup', () => {
dnsLookup = plugins.perfHooks.performance.now(); dnsLookup = plugins.perfHooks.performance.now();
}); });
socket.on('connect', () => { socket.once('connect', () => {
tcpHandshake = plugins.perfHooks.performance.now(); tcpHandshake = plugins.perfHooks.performance.now();
}); });
socket.on('secureConnect', () => { socket.once('secureConnect', () => {
sslHandshake = plugins.perfHooks.performance.now(); sslHandshake = plugins.perfHooks.performance.now();
}); });
}); });
req.on('error', (error) => { req.on('error', (error: Error & { code?: string }) => {
reject(error); reject(new NetworkError(error.message, error.code));
}); });
req.write(data); req.write(data);
@ -149,39 +285,22 @@ export class CloudflareSpeed {
}); });
} }
public async fetchCfCdnCgiTrace(): Promise<{ /**
fl: string, * Fetch Cloudflare's trace endpoint and parse key=value lines to a record.
h: string, */
ip: string, public async fetchCfCdnCgiTrace(): Promise<Record<string, string>> {
ts: string, const parseCfCdnCgiTrace = (text: string) =>
visit_scheme: string,
uag: string,
colo: string,
http: string,
loc: string,
tls: string,
sni: string,
warp: string,
gateway: string,
}> {
const parseCfCdnCgiTrace = (text) =>
text text
.split('\n') .split('\n')
.map((i) => { .map((i) => {
const j = i.split('='); const parts = i.split('=');
return [parts[0], parts[1]];
return [j[0], j[1]];
}) })
.reduce((data, [k, v]) => { .reduce((data: Record<string, string>, [k, v]) => {
if (v === undefined) return data; if (v === undefined) return data;
data[k] = v;
// Bypass prettier "no-assign-param" rules return data;
const data1 = data; }, {} as Record<string, string>);
// Object.fromEntries is only supported by Node.js 12 or newer
data1[k] = v;
return data1;
}, {});
return this.get('speed.cloudflare.com', '/cdn-cgi/trace').then(parseCfCdnCgiTrace); return this.get('speed.cloudflare.com', '/cdn-cgi/trace').then(parseCfCdnCgiTrace);
} }

@ -1,19 +1,107 @@
import * as plugins from './smartnetwork.plugins'; import * as plugins from './smartnetwork.plugins.js';
import { CloudflareSpeed } from './smartnetwork.classes.cloudflarespeed.js';
import { CloudflareSpeed } from './smartnetwork.classes.cloudflarespeed'; import { getLogger } from './logging.js';
import { NetworkError } from './errors.js';
import * as stats from './helpers/stats.js';
/** /**
* SmartNetwork simplifies actions within the network * SmartNetwork simplifies actions within the network
*/ */
/**
* Configuration options for SmartNetwork
*/
export interface SmartNetworkOptions {
/** Cache time-to-live in milliseconds for gateway and public IP lookups */
cacheTtl?: number;
}
/**
* A hop in a traceroute result
*/
export interface Hop {
ttl: number;
ip: string;
rtt: number | null;
}
export class SmartNetwork { export class SmartNetwork {
/** Static registry for external plugins */
public static pluginsRegistry: Map<string, any> = new Map();
/** Register a plugin by name */
public static registerPlugin(name: string, ctor: any): void {
SmartNetwork.pluginsRegistry.set(name, ctor);
}
/** Unregister a plugin by name */
public static unregisterPlugin(name: string): void {
SmartNetwork.pluginsRegistry.delete(name);
}
private options: SmartNetworkOptions;
private cache: Map<string, { value: any; expiry: number }>;
constructor(options?: SmartNetworkOptions) {
this.options = options || {};
this.cache = new Map();
}
/** /**
* get network speed * get network speed
* @param measurementTime * @param opts optional speed test parameters
*/ */
public async getSpeed() { public async getSpeed(
const cloudflareSpeedInstance = new CloudflareSpeed(); opts?: { parallelStreams?: number; duration?: number },
const test = await cloudflareSpeedInstance.speedTest(); ) {
return test; const cloudflareSpeedInstance = new CloudflareSpeed(opts);
return cloudflareSpeedInstance.speedTest();
}
/**
* Send ICMP pings to a host. Optionally specify count for multiple pings.
*/
public async ping(
host: string,
opts?: { timeout?: number; count?: number },
): Promise<any> {
const timeout = opts?.timeout ?? 500;
const count = opts?.count && opts.count > 1 ? opts.count : 1;
const pinger = new plugins.smartping.Smartping();
if (count === 1) {
// single ping: normalize time to number
const res = await pinger.ping(host, timeout);
return {
...res,
time: typeof res.time === 'number' ? res.time : NaN,
};
}
const times: number[] = [];
let aliveCount = 0;
for (let i = 0; i < count; i++) {
try {
const res = await pinger.ping(host, timeout);
const t = typeof res.time === 'number' ? res.time : NaN;
if (res.alive) aliveCount++;
times.push(t);
} catch {
times.push(NaN);
}
}
const valid = times.filter((t) => !isNaN(t));
const min = valid.length ? Math.min(...valid) : NaN;
const max = valid.length ? Math.max(...valid) : NaN;
const avg = valid.length ? stats.average(valid) : NaN;
const stddev = valid.length
? Math.sqrt(
stats.average(valid.map((v) => (v - avg) ** 2)),
)
: NaN;
const packetLoss = ((count - aliveCount) / count) * 100;
return {
host,
count,
times,
min,
max,
avg,
stddev,
packetLoss,
alive: aliveCount > 0,
};
} }
/** /**
@ -21,6 +109,9 @@ export class SmartNetwork {
* note: false also resolves with false as argument * note: false also resolves with false as argument
* @param port * @param port
*/ */
/**
* Check if a local port is unused (both IPv4 and IPv6)
*/
public async isLocalPortUnused(port: number): Promise<boolean> { public async isLocalPortUnused(port: number): Promise<boolean> {
const doneIpV4 = plugins.smartpromise.defer<boolean>(); const doneIpV4 = plugins.smartpromise.defer<boolean>();
const doneIpV6 = plugins.smartpromise.defer<boolean>(); const doneIpV6 = plugins.smartpromise.defer<boolean>();
@ -28,11 +119,7 @@ export class SmartNetwork {
// test IPv4 space // test IPv4 space
const ipv4Test = net.createServer(); const ipv4Test = net.createServer();
ipv4Test.once('error', (err: any) => { ipv4Test.once('error', () => {
if (err.code !== 'EADDRINUSE') {
doneIpV4.resolve(false);
return;
}
doneIpV4.resolve(false); doneIpV4.resolve(false);
}); });
ipv4Test.once('listening', () => { ipv4Test.once('listening', () => {
@ -47,11 +134,7 @@ export class SmartNetwork {
// test IPv6 space // test IPv6 space
const ipv6Test = net.createServer(); const ipv6Test = net.createServer();
ipv6Test.once('error', function (err: any) { ipv6Test.once('error', () => {
if (err.code !== 'EADDRINUSE') {
doneIpV6.resolve(false);
return;
}
doneIpV6.resolve(false); doneIpV6.resolve(false);
}); });
ipv6Test.once('listening', () => { ipv6Test.once('listening', () => {
@ -73,26 +156,66 @@ export class SmartNetwork {
* checks wether a remote port is available * checks wether a remote port is available
* @param domainArg * @param domainArg
*/ */
public async isRemotePortAvailable(domainArg: string, portArg?: number): Promise<boolean> { /**
const done = plugins.smartpromise.defer<boolean>(); * Check if a remote port is available
const domainPart = domainArg.split(':')[0]; * @param target host or "host:port"
const port = portArg ? portArg : parseInt(domainArg.split(':')[1], 10); * @param opts options including port, protocol (only tcp), retries and timeout
*/
plugins.isopen(domainPart, port, (response) => { /**
console.log(response); * Check if a remote port is available
if (response[port.toString()].isOpen) { * @param target host or "host:port"
done.resolve(true); * @param portOrOpts either a port number (deprecated) or options object
*/
public async isRemotePortAvailable(
target: string,
portOrOpts?: number | { port?: number; protocol?: 'tcp' | 'udp'; timeout?: number; retries?: number },
): Promise<boolean> {
let hostPart: string;
let port: number | undefined;
let protocol: string = 'tcp';
let retries = 1;
let timeout: number | undefined;
// preserve old signature (target, port)
if (typeof portOrOpts === 'number') {
[hostPart] = target.split(':');
port = portOrOpts;
} else { } else {
done.resolve(false); const opts = portOrOpts || {};
protocol = opts.protocol ?? 'tcp';
retries = opts.retries ?? 1;
timeout = opts.timeout;
[hostPart] = target.split(':');
const portPart = target.split(':')[1];
port = opts.port ?? (portPart ? parseInt(portPart, 10) : undefined);
} }
if (protocol === 'udp') {
throw new NetworkError('UDP port check not supported', 'ENOTSUP');
}
if (!port) {
throw new NetworkError('Port not specified', 'EINVAL');
}
let last: boolean = false;
for (let attempt = 0; attempt < retries; attempt++) {
const done = plugins.smartpromise.defer<boolean>();
plugins.isopen(hostPart, port, (response: Record<string, { isOpen: boolean }>) => {
const info = response[port.toString()];
done.resolve(Boolean(info?.isOpen));
}); });
const result = await done.promise; last = await done.promise;
return result; if (last) return true;
}
return last;
} }
public async getGateways() { /**
const result = plugins.os.networkInterfaces(); * List network interfaces (gateways)
return result; */
public async getGateways(): Promise<Record<string, plugins.os.NetworkInterfaceInfo[]>> {
const fetcher = async () => plugins.os.networkInterfaces();
if (this.options.cacheTtl && this.options.cacheTtl > 0) {
return this.getCached('gateways', fetcher);
}
return fetcher();
} }
public async getDefaultGateway(): Promise<{ public async getDefaultGateway(): Promise<{
@ -101,7 +224,7 @@ export class SmartNetwork {
}> { }> {
const defaultGatewayName = await plugins.systeminformation.networkInterfaceDefault(); const defaultGatewayName = await plugins.systeminformation.networkInterfaceDefault();
if (!defaultGatewayName) { if (!defaultGatewayName) {
console.log('Cannot determine default gateway'); getLogger().warn?.('Cannot determine default gateway');
return null; return null;
} }
const gateways = await this.getGateways(); const gateways = await this.getGateways();
@ -112,12 +235,136 @@ export class SmartNetwork {
}; };
} }
public async getPublicIps() { /**
return { * Lookup public IPv4 and IPv6
v4: await plugins.publicIp.v4({ */
timeout: 1000, public async getPublicIps(): Promise<{ v4: string | null; v6: string | null }> {
onlyHttps: true, const fetcher = async () => ({
}), v4: await plugins.publicIp.publicIpv4({ timeout: 1000, onlyHttps: true }).catch(() => null),
}; v6: await plugins.publicIp.publicIpv6({ timeout: 1000, onlyHttps: true }).catch(() => null),
});
if (this.options.cacheTtl && this.options.cacheTtl > 0) {
return this.getCached('publicIps', fetcher);
}
return fetcher();
}
/**
* Resolve DNS records (A, AAAA, MX)
*/
public async resolveDns(host: string): Promise<{ A: string[]; AAAA: string[]; MX: { exchange: string; priority: number }[] }> {
try {
const dns = await import('dns');
const { resolve4, resolve6, resolveMx } = dns.promises;
const [A, AAAA, MX] = await Promise.all([
resolve4(host).catch(() => []),
resolve6(host).catch(() => []),
resolveMx(host).catch(() => []),
]);
return { A, AAAA, MX };
} catch (err: any) {
throw new NetworkError(err.message, err.code);
}
}
/**
* Perform a simple HTTP/HTTPS endpoint health check
*/
public async checkEndpoint(
urlString: string,
opts?: { timeout?: number },
): Promise<{ status: number; headers: Record<string, string>; rtt: number }> {
const start = plugins.perfHooks.performance.now();
try {
const url = new URL(urlString);
const lib = url.protocol === 'https:' ? plugins.https : await import('http');
return new Promise((resolve, reject) => {
const req = lib.request(
url,
{ method: 'GET', timeout: opts?.timeout, agent: false },
(res: any) => {
res.on('data', () => {});
res.once('end', () => {
const rtt = plugins.perfHooks.performance.now() - start;
const headers: Record<string, string> = {};
for (const [k, v] of Object.entries(res.headers)) {
headers[k] = Array.isArray(v) ? v.join(',') : String(v);
}
resolve({ status: res.statusCode, headers, rtt });
});
},
);
req.on('error', (err: any) => reject(new NetworkError(err.message, err.code)));
req.end();
});
} catch (err: any) {
throw new NetworkError(err.message, err.code);
}
}
/**
* Perform a traceroute: hop-by-hop latency using the system traceroute tool.
* Falls back to a single-hop stub if traceroute is unavailable or errors.
*/
public async traceroute(
host: string,
opts?: { maxHops?: number; timeout?: number },
): Promise<Hop[]> {
const maxHops = opts?.maxHops ?? 30;
const timeout = opts?.timeout;
try {
const { exec } = await import('child_process');
const cmd = `traceroute -n -m ${maxHops} ${host}`;
const stdout: string = await new Promise((resolve, reject) => {
exec(
cmd,
{ encoding: 'utf8', timeout },
(err, stdout) => {
if (err) return reject(err);
resolve(stdout);
},
);
});
const hops: Hop[] = [];
for (const raw of stdout.split('\n')) {
const line = raw.trim();
if (!line || line.startsWith('traceroute')) continue;
const parts = line.split(/\s+/);
const ttl = parseInt(parts[0], 10);
let ip: string;
let rtt: number | null;
if (parts[1] === '*' || !parts[1]) {
ip = parts[1] || '';
rtt = null;
} else {
ip = parts[1];
const timePart = parts.find((p, i) => i >= 2 && /^\d+(\.\d+)?$/.test(p));
rtt = timePart ? parseFloat(timePart) : null;
}
hops.push({ ttl, ip, rtt });
}
if (hops.length) {
return hops;
}
} catch {
// traceroute not available or error: fall through to stub
}
// fallback stub
return [{ ttl: 1, ip: host, rtt: null }];
}
/**
* Internal caching helper
*/
private async getCached<T>(key: string, fetcher: () => Promise<T>): Promise<T> {
const now = Date.now();
const entry = this.cache.get(key);
if (entry && entry.expiry > now) {
return entry.value;
}
const value = await fetcher();
const ttl = this.options.cacheTtl || 0;
this.cache.set(key, { value, expiry: now + ttl });
return value;
} }
} }

@ -6,14 +6,17 @@ import * as perfHooks from 'perf_hooks';
export { os, https, perfHooks }; export { os, https, perfHooks };
// @pushrocks scope // @pushrocks scope
import * as smartpromise from '@pushrocks/smartpromise'; import * as smartping from '@push.rocks/smartping';
import * as smartstring from '@pushrocks/smartstring'; import * as smartpromise from '@push.rocks/smartpromise';
import * as smartstring from '@push.rocks/smartstring';
export { smartpromise, smartstring }; export { smartpromise, smartping, smartstring };
// @third party scope // @third party scope
// @ts-ignore
import isopen from 'isopen'; import isopen from 'isopen';
import publicIp from 'public-ip'; // @ts-ignore
import * as publicIp from 'public-ip';
import * as systeminformation from 'systeminformation'; import * as systeminformation from 'systeminformation';
export { isopen, publicIp, systeminformation }; export { isopen, publicIp, systeminformation };

5
ts/tsconfig.json Normal file

@ -0,0 +1,5 @@
{
"compilerOptions": {
"noImplicitAny": true
}
}

16
tsconfig.json Normal file

@ -0,0 +1,16 @@
{
"compilerOptions": {
"experimentalDecorators": true,
"useDefineForClassFields": false,
"target": "ES2022",
"module": "NodeNext",
"moduleResolution": "NodeNext",
"esModuleInterop": true,
"verbatimModuleSyntax": true,
"baseUrl": ".",
"paths": {}
},
"exclude": [
"dist_*/**/*.d.ts"
]
}

@ -1,17 +0,0 @@
{
"extends": ["tslint:latest", "tslint-config-prettier"],
"rules": {
"semicolon": [true, "always"],
"no-console": false,
"ordered-imports": false,
"object-literal-sort-keys": false,
"member-ordering": {
"options":{
"order": [
"static-method"
]
}
}
},
"defaultSeverity": "warning"
}