fix(client): Fix CI configuration, prevent socket hangs with auto-drain, and apply various client/core TypeScript fixes and test updates
This commit is contained in:
@@ -6,8 +6,8 @@ on:
|
|||||||
- '**'
|
- '**'
|
||||||
|
|
||||||
env:
|
env:
|
||||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
|
||||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
|
||||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
- name: Install pnpm and npmci
|
- name: Install pnpm and npmci
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
|
|
||||||
- name: Run npm prepare
|
- name: Run npm prepare
|
||||||
run: npmci npm prepare
|
run: npmci npm prepare
|
||||||
|
@@ -6,8 +6,8 @@ on:
|
|||||||
- '*'
|
- '*'
|
||||||
|
|
||||||
env:
|
env:
|
||||||
IMAGE: registry.gitlab.com/hosttoday/ht-docker-node:npmci
|
IMAGE: code.foss.global/host.today/ht-docker-node:npmci
|
||||||
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@gitea.lossless.digital/${{gitea.repository}}.git
|
NPMCI_COMPUTED_REPOURL: https://${{gitea.repository_owner}}:${{secrets.GITEA_TOKEN}}@/${{gitea.repository}}.git
|
||||||
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
NPMCI_TOKEN_NPM: ${{secrets.NPMCI_TOKEN_NPM}}
|
||||||
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
NPMCI_TOKEN_NPM2: ${{secrets.NPMCI_TOKEN_NPM2}}
|
||||||
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
NPMCI_GIT_GITHUBTOKEN: ${{secrets.NPMCI_GIT_GITHUBTOKEN}}
|
||||||
@@ -26,7 +26,7 @@ jobs:
|
|||||||
- name: Prepare
|
- name: Prepare
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
npmci npm prepare
|
npmci npm prepare
|
||||||
|
|
||||||
- name: Audit production dependencies
|
- name: Audit production dependencies
|
||||||
@@ -54,7 +54,7 @@ jobs:
|
|||||||
- name: Prepare
|
- name: Prepare
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
npmci npm prepare
|
npmci npm prepare
|
||||||
|
|
||||||
- name: Test stable
|
- name: Test stable
|
||||||
@@ -82,7 +82,7 @@ jobs:
|
|||||||
- name: Prepare
|
- name: Prepare
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
npmci npm prepare
|
npmci npm prepare
|
||||||
|
|
||||||
- name: Release
|
- name: Release
|
||||||
@@ -104,7 +104,7 @@ jobs:
|
|||||||
- name: Prepare
|
- name: Prepare
|
||||||
run: |
|
run: |
|
||||||
pnpm install -g pnpm
|
pnpm install -g pnpm
|
||||||
pnpm install -g @shipzone/npmci
|
pnpm install -g @ship.zone/npmci
|
||||||
npmci npm prepare
|
npmci npm prepare
|
||||||
|
|
||||||
- name: Code quality
|
- name: Code quality
|
||||||
|
7
.gitignore
vendored
7
.gitignore
vendored
@@ -3,7 +3,6 @@
|
|||||||
# artifacts
|
# artifacts
|
||||||
coverage/
|
coverage/
|
||||||
public/
|
public/
|
||||||
pages/
|
|
||||||
|
|
||||||
# installs
|
# installs
|
||||||
node_modules/
|
node_modules/
|
||||||
@@ -17,4 +16,8 @@ node_modules/
|
|||||||
dist/
|
dist/
|
||||||
dist_*/
|
dist_*/
|
||||||
|
|
||||||
# custom
|
# AI
|
||||||
|
.claude/
|
||||||
|
.serena/
|
||||||
|
|
||||||
|
#------# custom
|
41
changelog.md
41
changelog.md
@@ -1,25 +1,41 @@
|
|||||||
# Changelog
|
# Changelog
|
||||||
|
|
||||||
|
## 2025-08-18 - 4.2.2 - fix(client)
|
||||||
|
Fix CI configuration, prevent socket hangs with auto-drain, and apply various client/core TypeScript fixes and test updates
|
||||||
|
|
||||||
|
- CI/workflow updates: switch container IMAGE to code.foss.global/host.today/ht-docker-node:npmci, adjust NPMCI_COMPUTED_REPOURL, and install @ship.zone/npmci instead of @shipzone/npmci
|
||||||
|
- Prevent socket hanging by adding automatic draining of unconsumed Node.js response bodies (configurable via options.autoDrain / SmartRequest.autoDrain); added logging when auto-drain runs and updated tests to consume bodies
|
||||||
|
- Client improvements: fixes and cleanups in SmartRequest (accept header mapping, formData header handling, options(), pagination helpers, handle429Backoff backoff/Retry-After parsing and callbacks, retry logic and small API ergonomics)
|
||||||
|
- Core fixes: fetch and node implementations corrected (buildUrl, fetch options, request/response constructors, stream conversions to web ReadableStream, proper error messages) and consistent exports
|
||||||
|
- TypeScript and formatting fixes across many files (consistent trailing commas, object layout, newline fixes, typed function signatures, cleaned up exports and module imports)
|
||||||
|
- Package metadata and tooling updates: package.json bug/homepage URLs adjusted to code.foss.global, bumped @git.zone/tstest devDependency, added pnpm overrides field; small .gitignore additions
|
||||||
|
|
||||||
## 2025-07-29 - 4.2.1 - fix(client)
|
## 2025-07-29 - 4.2.1 - fix(client)
|
||||||
|
|
||||||
Fix socket hanging issues and add auto-drain feature
|
Fix socket hanging issues and add auto-drain feature
|
||||||
|
|
||||||
**Fixes:**
|
**Fixes:**
|
||||||
|
|
||||||
- Fixed socket hanging issues caused by unconsumed response bodies
|
- Fixed socket hanging issues caused by unconsumed response bodies
|
||||||
- Resolved test timeout problems where sockets remained open after tests completed
|
- Resolved test timeout problems where sockets remained open after tests completed
|
||||||
|
|
||||||
**Features:**
|
**Features:**
|
||||||
|
|
||||||
- Added automatic response body draining to prevent socket pool exhaustion
|
- Added automatic response body draining to prevent socket pool exhaustion
|
||||||
- Made auto-drain configurable via `autoDrain()` method (enabled by default)
|
- Made auto-drain configurable via `autoDrain()` method (enabled by default)
|
||||||
- Added logging when auto-drain activates for debugging purposes
|
- Added logging when auto-drain activates for debugging purposes
|
||||||
|
|
||||||
**Improvements:**
|
**Improvements:**
|
||||||
|
|
||||||
- Updated all tests to properly consume response bodies
|
- Updated all tests to properly consume response bodies
|
||||||
- Enhanced documentation about the importance of consuming response bodies
|
- Enhanced documentation about the importance of consuming response bodies
|
||||||
|
|
||||||
## 2025-07-29 - 4.2.0 - feat(client)
|
## 2025-07-29 - 4.2.0 - feat(client)
|
||||||
|
|
||||||
Add handle429Backoff method for intelligent rate limit handling
|
Add handle429Backoff method for intelligent rate limit handling
|
||||||
|
|
||||||
**Features:**
|
**Features:**
|
||||||
|
|
||||||
- Added `handle429Backoff()` method to SmartRequest class for automatic HTTP 429 handling
|
- Added `handle429Backoff()` method to SmartRequest class for automatic HTTP 429 handling
|
||||||
- Respects `Retry-After` headers with support for both seconds and HTTP date formats
|
- Respects `Retry-After` headers with support for both seconds and HTTP date formats
|
||||||
- Configurable exponential backoff when no Retry-After header is present
|
- Configurable exponential backoff when no Retry-After header is present
|
||||||
@@ -28,30 +44,37 @@ Add handle429Backoff method for intelligent rate limit handling
|
|||||||
- Maximum wait time capping to prevent excessive delays
|
- Maximum wait time capping to prevent excessive delays
|
||||||
|
|
||||||
**Improvements:**
|
**Improvements:**
|
||||||
|
|
||||||
- Updated test endpoints to use more reliable services (jsonplaceholder, echo.zuplo.io)
|
- Updated test endpoints to use more reliable services (jsonplaceholder, echo.zuplo.io)
|
||||||
- Added timeout parameter to test script for better CI/CD compatibility
|
- Added timeout parameter to test script for better CI/CD compatibility
|
||||||
|
|
||||||
**Documentation:**
|
**Documentation:**
|
||||||
|
|
||||||
- Added comprehensive rate limiting section to README with examples
|
- Added comprehensive rate limiting section to README with examples
|
||||||
- Documented all configuration options for handle429Backoff
|
- Documented all configuration options for handle429Backoff
|
||||||
|
|
||||||
## 2025-07-29 - 4.1.0 - feat(client)
|
## 2025-07-29 - 4.1.0 - feat(client)
|
||||||
|
|
||||||
Add missing options() method to SmartRequest client
|
Add missing options() method to SmartRequest client
|
||||||
|
|
||||||
**Features:**
|
**Features:**
|
||||||
|
|
||||||
- Added `options()` method to SmartRequest class for setting arbitrary request options
|
- Added `options()` method to SmartRequest class for setting arbitrary request options
|
||||||
- Enables setting keepAlive and other platform-specific options via fluent API
|
- Enables setting keepAlive and other platform-specific options via fluent API
|
||||||
- Added test coverage for keepAlive functionality
|
- Added test coverage for keepAlive functionality
|
||||||
|
|
||||||
**Documentation:**
|
**Documentation:**
|
||||||
|
|
||||||
- Updated README with examples of using the `options()` method
|
- Updated README with examples of using the `options()` method
|
||||||
- Added specific examples for enabling keepAlive connections
|
- Added specific examples for enabling keepAlive connections
|
||||||
- Corrected all documentation to use `options()` instead of `option()`
|
- Corrected all documentation to use `options()` instead of `option()`
|
||||||
|
|
||||||
## 2025-07-28 - 4.0.0 - BREAKING CHANGE(core)
|
## 2025-07-28 - 4.0.0 - BREAKING CHANGE(core)
|
||||||
|
|
||||||
Complete architectural overhaul with cross-platform support
|
Complete architectural overhaul with cross-platform support
|
||||||
|
|
||||||
**Breaking Changes:**
|
**Breaking Changes:**
|
||||||
|
|
||||||
- Renamed `SmartRequestClient` to `SmartRequest` for simpler, cleaner API
|
- Renamed `SmartRequestClient` to `SmartRequest` for simpler, cleaner API
|
||||||
- Removed legacy API entirely (no more `/legacy` import path)
|
- Removed legacy API entirely (no more `/legacy` import path)
|
||||||
- Major architectural refactoring:
|
- Major architectural refactoring:
|
||||||
@@ -65,6 +88,7 @@ Complete architectural overhaul with cross-platform support
|
|||||||
- Removed all "Abstract" prefixes from type names
|
- Removed all "Abstract" prefixes from type names
|
||||||
|
|
||||||
**Features:**
|
**Features:**
|
||||||
|
|
||||||
- Full cross-platform support (Node.js and browsers)
|
- Full cross-platform support (Node.js and browsers)
|
||||||
- Automatic platform detection using @push.rocks/smartenv
|
- Automatic platform detection using @push.rocks/smartenv
|
||||||
- Consistent API across platforms with platform-specific capabilities
|
- Consistent API across platforms with platform-specific capabilities
|
||||||
@@ -72,15 +96,18 @@ Complete architectural overhaul with cross-platform support
|
|||||||
- Better error messages for unsupported platform features
|
- Better error messages for unsupported platform features
|
||||||
|
|
||||||
**Documentation:**
|
**Documentation:**
|
||||||
|
|
||||||
- Completely rewritten README with platform-specific examples
|
- Completely rewritten README with platform-specific examples
|
||||||
- Added architecture overview section
|
- Added architecture overview section
|
||||||
- Added migration guide from v2.x and v3.x
|
- Added migration guide from v2.x and v3.x
|
||||||
- Updated all examples to use the new `SmartRequest` class name
|
- Updated all examples to use the new `SmartRequest` class name
|
||||||
|
|
||||||
## 2025-07-27 - 3.0.0 - BREAKING CHANGE(core)
|
## 2025-07-27 - 3.0.0 - BREAKING CHANGE(core)
|
||||||
|
|
||||||
Major architectural refactoring with fetch-like API
|
Major architectural refactoring with fetch-like API
|
||||||
|
|
||||||
**Breaking Changes:**
|
**Breaking Changes:**
|
||||||
|
|
||||||
- Legacy API functions are now imported from `@push.rocks/smartrequest/legacy` instead of the main export
|
- Legacy API functions are now imported from `@push.rocks/smartrequest/legacy` instead of the main export
|
||||||
- Modern API response objects now use fetch-like methods (`.json()`, `.text()`, `.arrayBuffer()`, `.stream()`) instead of direct `.body` access
|
- Modern API response objects now use fetch-like methods (`.json()`, `.text()`, `.arrayBuffer()`, `.stream()`) instead of direct `.body` access
|
||||||
- Renamed `responseType()` method to `accept()` in modern API
|
- Renamed `responseType()` method to `accept()` in modern API
|
||||||
@@ -94,17 +121,20 @@ Major architectural refactoring with fetch-like API
|
|||||||
- Legacy API is now just an adapter over the core module
|
- Legacy API is now just an adapter over the core module
|
||||||
|
|
||||||
**Features:**
|
**Features:**
|
||||||
|
|
||||||
- New fetch-like response API with single-use body consumption
|
- New fetch-like response API with single-use body consumption
|
||||||
- Better TypeScript support and type safety
|
- Better TypeScript support and type safety
|
||||||
- Cleaner separation of concerns between request and response
|
- Cleaner separation of concerns between request and response
|
||||||
- More predictable behavior aligned with fetch API standards
|
- More predictable behavior aligned with fetch API standards
|
||||||
|
|
||||||
**Documentation:**
|
**Documentation:**
|
||||||
|
|
||||||
- Updated all examples to show correct import paths
|
- Updated all examples to show correct import paths
|
||||||
- Added comprehensive examples for the new response API
|
- Added comprehensive examples for the new response API
|
||||||
- Enhanced migration guide
|
- Enhanced migration guide
|
||||||
|
|
||||||
## 2025-04-03 - 2.1.0 - feat(docs)
|
## 2025-04-03 - 2.1.0 - feat(docs)
|
||||||
|
|
||||||
Enhance documentation and tests with modern API usage examples and migration guide
|
Enhance documentation and tests with modern API usage examples and migration guide
|
||||||
|
|
||||||
- Updated README to include detailed examples for the modern fluent API, covering GET, POST, headers, query, timeout, retries, and pagination
|
- Updated README to include detailed examples for the modern fluent API, covering GET, POST, headers, query, timeout, retries, and pagination
|
||||||
@@ -114,6 +144,7 @@ Enhance documentation and tests with modern API usage examples and migration gui
|
|||||||
- Minor formatting improvements in the code and documentation examples
|
- Minor formatting improvements in the code and documentation examples
|
||||||
|
|
||||||
## 2024-11-06 - 2.0.23 - fix(core)
|
## 2024-11-06 - 2.0.23 - fix(core)
|
||||||
|
|
||||||
Enhance type safety for response in binary requests
|
Enhance type safety for response in binary requests
|
||||||
|
|
||||||
- Updated the dependency versions in package.json to their latest versions.
|
- Updated the dependency versions in package.json to their latest versions.
|
||||||
@@ -121,31 +152,37 @@ Enhance type safety for response in binary requests
|
|||||||
- Introduced generic typing to IExtendedIncomingMessage interface for better type safety.
|
- Introduced generic typing to IExtendedIncomingMessage interface for better type safety.
|
||||||
|
|
||||||
## 2024-05-29 - 2.0.22 - Documentation
|
## 2024-05-29 - 2.0.22 - Documentation
|
||||||
|
|
||||||
update description
|
update description
|
||||||
|
|
||||||
## 2024-04-01 - 2.0.21 - Configuration
|
## 2024-04-01 - 2.0.21 - Configuration
|
||||||
|
|
||||||
Updated configuration files
|
Updated configuration files
|
||||||
|
|
||||||
- Updated `tsconfig`
|
- Updated `tsconfig`
|
||||||
- Updated `npmextra.json`: githost
|
- Updated `npmextra.json`: githost
|
||||||
|
|
||||||
## 2023-07-10 - 2.0.15 - Structure
|
## 2023-07-10 - 2.0.15 - Structure
|
||||||
|
|
||||||
Refactored the organization structure
|
Refactored the organization structure
|
||||||
|
|
||||||
- Switched to a new organization scheme
|
- Switched to a new organization scheme
|
||||||
|
|
||||||
## 2022-07-29 - 1.1.57 to 2.0.0 - Major Update
|
## 2022-07-29 - 1.1.57 to 2.0.0 - Major Update
|
||||||
|
|
||||||
Significant changes and improvements leading to a major version update
|
Significant changes and improvements leading to a major version update
|
||||||
|
|
||||||
- **BREAKING CHANGE**: Switched the core to use ECMAScript modules (ESM)
|
- **BREAKING CHANGE**: Switched the core to use ECMAScript modules (ESM)
|
||||||
|
|
||||||
## 2018-08-14 - 1.1.12 to 1.1.13 - Functional Enhancements
|
## 2018-08-14 - 1.1.12 to 1.1.13 - Functional Enhancements
|
||||||
|
|
||||||
Enhanced request capabilities and removed unnecessary dependencies
|
Enhanced request capabilities and removed unnecessary dependencies
|
||||||
|
|
||||||
- Fixed request module to allow sending strings
|
- Fixed request module to allow sending strings
|
||||||
- Removed CI dependencies
|
- Removed CI dependencies
|
||||||
|
|
||||||
## 2018-07-19 - 1.1.1 to 1.1.11 - Various Fixes and Improvements
|
## 2018-07-19 - 1.1.1 to 1.1.11 - Various Fixes and Improvements
|
||||||
|
|
||||||
Improvements and fixes across various components
|
Improvements and fixes across various components
|
||||||
|
|
||||||
- Added formData capability
|
- Added formData capability
|
||||||
@@ -155,11 +192,13 @@ Improvements and fixes across various components
|
|||||||
- Updated request ending method
|
- Updated request ending method
|
||||||
|
|
||||||
## 2018-06-19 - 1.0.14 - Structural Fix
|
## 2018-06-19 - 1.0.14 - Structural Fix
|
||||||
|
|
||||||
Resolved conflicts with file extensions
|
Resolved conflicts with file extensions
|
||||||
|
|
||||||
- Changed `.json.ts` to `.jsonrest.ts` to avoid conflicts
|
- Changed `.json.ts` to `.jsonrest.ts` to avoid conflicts
|
||||||
|
|
||||||
## 2018-06-13 - 1.0.8 to 1.0.10 - Core Updates
|
## 2018-06-13 - 1.0.8 to 1.0.10 - Core Updates
|
||||||
|
|
||||||
Ensured binary handling compliance
|
Ensured binary handling compliance
|
||||||
|
|
||||||
- Enhanced core to uphold latest standards
|
- Enhanced core to uphold latest standards
|
||||||
@@ -167,9 +206,9 @@ Ensured binary handling compliance
|
|||||||
- Fix for handling and returning binary responses
|
- Fix for handling and returning binary responses
|
||||||
|
|
||||||
## 2017-06-09 - 1.0.4 to 1.0.6 - Infrastructure and Type Improvements
|
## 2017-06-09 - 1.0.4 to 1.0.6 - Infrastructure and Type Improvements
|
||||||
|
|
||||||
Types and infrastructure updates
|
Types and infrastructure updates
|
||||||
|
|
||||||
- Improved types
|
- Improved types
|
||||||
- Removed need for content type on post requests
|
- Removed need for content type on post requests
|
||||||
- Updated for new infrastructure
|
- Updated for new infrastructure
|
||||||
|
|
||||||
|
11
package.json
11
package.json
@@ -35,9 +35,9 @@
|
|||||||
"author": "Task Venture Capital GmbH",
|
"author": "Task Venture Capital GmbH",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"bugs": {
|
"bugs": {
|
||||||
"url": "https://gitlab.com/push.rocks/smartrequest/issues"
|
"url": "https://code.foss.global/push.rocks/smartrequest/issues"
|
||||||
},
|
},
|
||||||
"homepage": "https://code.foss.global/push.rocks/smartrequest",
|
"homepage": "https://code.foss.global/push.rocks/smartrequest#readme",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@push.rocks/smartenv": "^5.0.13",
|
"@push.rocks/smartenv": "^5.0.13",
|
||||||
"@push.rocks/smartpath": "^6.0.0",
|
"@push.rocks/smartpath": "^6.0.0",
|
||||||
@@ -49,7 +49,7 @@
|
|||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
"@git.zone/tsbuild": "^2.6.4",
|
"@git.zone/tsbuild": "^2.6.4",
|
||||||
"@git.zone/tsrun": "^1.3.3",
|
"@git.zone/tsrun": "^1.3.3",
|
||||||
"@git.zone/tstest": "^2.3.2",
|
"@git.zone/tstest": "^2.3.4",
|
||||||
"@types/node": "^22.9.0"
|
"@types/node": "^22.9.0"
|
||||||
},
|
},
|
||||||
"files": [
|
"files": [
|
||||||
@@ -67,5 +67,8 @@
|
|||||||
"browserslist": [
|
"browserslist": [
|
||||||
"last 1 chrome versions"
|
"last 1 chrome versions"
|
||||||
],
|
],
|
||||||
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6"
|
"packageManager": "pnpm@10.7.0+sha512.6b865ad4b62a1d9842b61d674a393903b871d9244954f652b8842c2b553c72176b278f64c463e52d40fff8aba385c235c8c9ecf5cc7de4fd78b8bb6d49633ab6",
|
||||||
|
"pnpm": {
|
||||||
|
"overrides": {}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
|
2105
pnpm-lock.yaml
generated
2105
pnpm-lock.yaml
generated
File diff suppressed because it is too large
Load Diff
@@ -1,6 +1,7 @@
|
|||||||
# SmartRequest Architecture Hints
|
# SmartRequest Architecture Hints
|
||||||
|
|
||||||
## Core Features
|
## Core Features
|
||||||
|
|
||||||
- supports http
|
- supports http
|
||||||
- supports https
|
- supports https
|
||||||
- supports unix socks
|
- supports unix socks
|
||||||
@@ -15,6 +16,7 @@
|
|||||||
- used in modules like @push.rocks/smartproxy and @api.global/typedrequest
|
- used in modules like @push.rocks/smartproxy and @api.global/typedrequest
|
||||||
|
|
||||||
## Architecture Overview (as of v3.0.0 major refactoring)
|
## Architecture Overview (as of v3.0.0 major refactoring)
|
||||||
|
|
||||||
- The project now has a multi-layer architecture with platform abstraction
|
- The project now has a multi-layer architecture with platform abstraction
|
||||||
- Base layer (ts/core_base/) contains abstract classes and unified types
|
- Base layer (ts/core_base/) contains abstract classes and unified types
|
||||||
- Node.js implementation (ts/core_node/) uses native http/https modules
|
- Node.js implementation (ts/core_node/) uses native http/https modules
|
||||||
@@ -26,6 +28,7 @@
|
|||||||
## Key Components
|
## Key Components
|
||||||
|
|
||||||
### Core Base Module (ts/core_base/)
|
### Core Base Module (ts/core_base/)
|
||||||
|
|
||||||
- `request.ts`: Abstract CoreRequest class defining the request interface
|
- `request.ts`: Abstract CoreRequest class defining the request interface
|
||||||
- `response.ts`: Abstract CoreResponse class with fetch-like API
|
- `response.ts`: Abstract CoreResponse class with fetch-like API
|
||||||
- Defines `stream()` method that always returns web-style ReadableStream
|
- Defines `stream()` method that always returns web-style ReadableStream
|
||||||
@@ -35,6 +38,7 @@
|
|||||||
- Implementations handle unsupported options by throwing errors
|
- Implementations handle unsupported options by throwing errors
|
||||||
|
|
||||||
### Core Node Module (ts/core_node/)
|
### Core Node Module (ts/core_node/)
|
||||||
|
|
||||||
- `request.ts`: Node.js implementation using http/https modules
|
- `request.ts`: Node.js implementation using http/https modules
|
||||||
- Supports unix socket connections and keep-alive agents
|
- Supports unix socket connections and keep-alive agents
|
||||||
- Converts Node.js specific options from unified interface
|
- Converts Node.js specific options from unified interface
|
||||||
@@ -44,6 +48,7 @@
|
|||||||
- Methods like `json()`, `text()`, `arrayBuffer()` handle parsing
|
- Methods like `json()`, `text()`, `arrayBuffer()` handle parsing
|
||||||
|
|
||||||
### Core Fetch Module (ts/core_fetch/)
|
### Core Fetch Module (ts/core_fetch/)
|
||||||
|
|
||||||
- `request.ts`: Fetch API implementation for browsers
|
- `request.ts`: Fetch API implementation for browsers
|
||||||
- Throws errors for Node.js specific options (agent, socketPath)
|
- Throws errors for Node.js specific options (agent, socketPath)
|
||||||
- Native support for CORS, credentials, and other browser features
|
- Native support for CORS, credentials, and other browser features
|
||||||
@@ -52,27 +57,32 @@
|
|||||||
- `streamNode()` throws error explaining it's not available in browser
|
- `streamNode()` throws error explaining it's not available in browser
|
||||||
|
|
||||||
### Core Module (ts/core/)
|
### Core Module (ts/core/)
|
||||||
|
|
||||||
- Dynamically loads appropriate implementation based on environment
|
- Dynamically loads appropriate implementation based on environment
|
||||||
- Uses @push.rocks/smartenv for environment detection
|
- Uses @push.rocks/smartenv for environment detection
|
||||||
- Exports unified types from core_base
|
- Exports unified types from core_base
|
||||||
|
|
||||||
### Client API (ts/client/)
|
### Client API (ts/client/)
|
||||||
|
|
||||||
- SmartRequest: Fluent API with method chaining
|
- SmartRequest: Fluent API with method chaining
|
||||||
- Returns CoreResponse objects with fetch-like methods
|
- Returns CoreResponse objects with fetch-like methods
|
||||||
- Supports pagination, retries, timeouts, and various response types
|
- Supports pagination, retries, timeouts, and various response types
|
||||||
|
|
||||||
### Stream Handling
|
### Stream Handling
|
||||||
|
|
||||||
- `stream()` method always returns web-style ReadableStream<Uint8Array>
|
- `stream()` method always returns web-style ReadableStream<Uint8Array>
|
||||||
- In Node.js, converts native streams to web streams
|
- In Node.js, converts native streams to web streams
|
||||||
- `streamNode()` available only in Node.js environment for native streams
|
- `streamNode()` available only in Node.js environment for native streams
|
||||||
- Consistent API across platforms while preserving platform-specific capabilities
|
- Consistent API across platforms while preserving platform-specific capabilities
|
||||||
|
|
||||||
### Binary Request Handling
|
### Binary Request Handling
|
||||||
|
|
||||||
- Binary requests handled through ArrayBuffer API
|
- Binary requests handled through ArrayBuffer API
|
||||||
- Response body kept as Buffer/ArrayBuffer without string conversion
|
- Response body kept as Buffer/ArrayBuffer without string conversion
|
||||||
- No automatic transformations applied to binary data
|
- No automatic transformations applied to binary data
|
||||||
|
|
||||||
## Testing
|
## Testing
|
||||||
|
|
||||||
- Use `pnpm test` to run all tests
|
- Use `pnpm test` to run all tests
|
||||||
- Tests use @git.zone/tstest/tapbundle for assertions
|
- Tests use @git.zone/tstest/tapbundle for assertions
|
||||||
- Separate test files for Node.js (test.node.ts) and browser (test.browser.ts)
|
- Separate test files for Node.js (test.node.ts) and browser (test.browser.ts)
|
||||||
|
77
readme.md
77
readme.md
@@ -1,7 +1,9 @@
|
|||||||
# @push.rocks/smartrequest
|
# @push.rocks/smartrequest
|
||||||
|
|
||||||
A modern, cross-platform HTTP/HTTPS request library for Node.js and browsers with a unified API, supporting form data, file uploads, JSON, binary data, streams, and unix sockets.
|
A modern, cross-platform HTTP/HTTPS request library for Node.js and browsers with a unified API, supporting form data, file uploads, JSON, binary data, streams, and unix sockets.
|
||||||
|
|
||||||
## Install
|
## Install
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
# Using npm
|
# Using npm
|
||||||
npm install @push.rocks/smartrequest --save
|
npm install @push.rocks/smartrequest --save
|
||||||
@@ -79,8 +81,8 @@ async function directCoreRequest() {
|
|||||||
const request = new CoreRequest('https://api.example.com/data', {
|
const request = new CoreRequest('https://api.example.com/data', {
|
||||||
method: 'GET',
|
method: 'GET',
|
||||||
headers: {
|
headers: {
|
||||||
'Accept': 'application/json'
|
Accept: 'application/json',
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const response = await request.fire();
|
const response = await request.fire();
|
||||||
@@ -100,7 +102,7 @@ async function searchRepositories(query: string, perPage: number = 10) {
|
|||||||
.header('Accept', 'application/vnd.github.v3+json')
|
.header('Accept', 'application/vnd.github.v3+json')
|
||||||
.query({
|
.query({
|
||||||
q: query,
|
q: query,
|
||||||
per_page: perPage.toString()
|
per_page: perPage.toString(),
|
||||||
})
|
})
|
||||||
.get();
|
.get();
|
||||||
|
|
||||||
@@ -136,8 +138,8 @@ import { SmartRequest } from '@push.rocks/smartrequest';
|
|||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create()
|
||||||
.url('https://api.example.com/data')
|
.url('https://api.example.com/data')
|
||||||
.options({
|
.options({
|
||||||
keepAlive: true, // Enable connection reuse (Node.js)
|
keepAlive: true, // Enable connection reuse (Node.js)
|
||||||
timeout: 10000, // 10 second timeout
|
timeout: 10000, // 10 second timeout
|
||||||
hardDataCuttingTimeout: 15000, // 15 second hard timeout
|
hardDataCuttingTimeout: 15000, // 15 second hard timeout
|
||||||
// Platform-specific options are also supported
|
// Platform-specific options are also supported
|
||||||
})
|
})
|
||||||
@@ -153,18 +155,14 @@ import { SmartRequest } from '@push.rocks/smartrequest';
|
|||||||
|
|
||||||
// JSON response (default)
|
// JSON response (default)
|
||||||
async function fetchJson(url: string) {
|
async function fetchJson(url: string) {
|
||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create().url(url).get();
|
||||||
.url(url)
|
|
||||||
.get();
|
|
||||||
|
|
||||||
return await response.json(); // Parses JSON automatically
|
return await response.json(); // Parses JSON automatically
|
||||||
}
|
}
|
||||||
|
|
||||||
// Text response
|
// Text response
|
||||||
async function fetchText(url: string) {
|
async function fetchText(url: string) {
|
||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create().url(url).get();
|
||||||
.url(url)
|
|
||||||
.get();
|
|
||||||
|
|
||||||
return await response.text(); // Returns response as string
|
return await response.text(); // Returns response as string
|
||||||
}
|
}
|
||||||
@@ -182,9 +180,7 @@ async function downloadImage(url: string) {
|
|||||||
|
|
||||||
// Streaming response (Web Streams API)
|
// Streaming response (Web Streams API)
|
||||||
async function streamLargeFile(url: string) {
|
async function streamLargeFile(url: string) {
|
||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create().url(url).get();
|
||||||
.url(url)
|
|
||||||
.get();
|
|
||||||
|
|
||||||
// Get a web-style ReadableStream (works in both Node.js and browsers)
|
// Get a web-style ReadableStream (works in both Node.js and browsers)
|
||||||
const stream = response.stream();
|
const stream = response.stream();
|
||||||
@@ -206,9 +202,7 @@ async function streamLargeFile(url: string) {
|
|||||||
|
|
||||||
// Node.js specific stream (only in Node.js environment)
|
// Node.js specific stream (only in Node.js environment)
|
||||||
async function streamWithNodeApi(url: string) {
|
async function streamWithNodeApi(url: string) {
|
||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create().url(url).get();
|
||||||
.url(url)
|
|
||||||
.get();
|
|
||||||
|
|
||||||
// Only available in Node.js, throws error in browser
|
// Only available in Node.js, throws error in browser
|
||||||
const nodeStream = response.streamNode();
|
const nodeStream = response.streamNode();
|
||||||
@@ -240,6 +234,7 @@ Each body method can only be called once per response, similar to the fetch API.
|
|||||||
### Important: Always Consume Response Bodies
|
### Important: Always Consume Response Bodies
|
||||||
|
|
||||||
**You should always consume response bodies, even if you don't need the data.** Unconsumed response bodies can cause:
|
**You should always consume response bodies, even if you don't need the data.** Unconsumed response bodies can cause:
|
||||||
|
|
||||||
- Memory leaks as data accumulates in buffers
|
- Memory leaks as data accumulates in buffers
|
||||||
- Socket hanging with keep-alive connections
|
- Socket hanging with keep-alive connections
|
||||||
- Connection pool exhaustion
|
- Connection pool exhaustion
|
||||||
@@ -269,11 +264,12 @@ await response.text(); // Consume the body even if not needed
|
|||||||
In Node.js, SmartRequest automatically drains unconsumed responses to prevent socket hanging, but it's still best practice to explicitly consume response bodies. When auto-drain occurs, you'll see a console log: `Auto-draining unconsumed response body for [URL] (status: [STATUS])`.
|
In Node.js, SmartRequest automatically drains unconsumed responses to prevent socket hanging, but it's still best practice to explicitly consume response bodies. When auto-drain occurs, you'll see a console log: `Auto-draining unconsumed response body for [URL] (status: [STATUS])`.
|
||||||
|
|
||||||
You can disable auto-drain if needed:
|
You can disable auto-drain if needed:
|
||||||
|
|
||||||
```typescript
|
```typescript
|
||||||
// Disable auto-drain (not recommended unless you have specific requirements)
|
// Disable auto-drain (not recommended unless you have specific requirements)
|
||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create()
|
||||||
.url('https://api.example.com/data')
|
.url('https://api.example.com/data')
|
||||||
.autoDrain(false) // Disable auto-drain
|
.autoDrain(false) // Disable auto-drain
|
||||||
.get();
|
.get();
|
||||||
|
|
||||||
// Now you MUST consume the body or the socket will hang
|
// Now you MUST consume the body or the socket will hang
|
||||||
@@ -288,12 +284,14 @@ await response.text();
|
|||||||
import { SmartRequest } from '@push.rocks/smartrequest';
|
import { SmartRequest } from '@push.rocks/smartrequest';
|
||||||
import * as fs from 'fs';
|
import * as fs from 'fs';
|
||||||
|
|
||||||
async function uploadMultipleFiles(files: Array<{name: string, path: string}>) {
|
async function uploadMultipleFiles(
|
||||||
const formFields = files.map(file => ({
|
files: Array<{ name: string; path: string }>,
|
||||||
|
) {
|
||||||
|
const formFields = files.map((file) => ({
|
||||||
name: 'files',
|
name: 'files',
|
||||||
value: fs.readFileSync(file.path),
|
value: fs.readFileSync(file.path),
|
||||||
filename: file.name,
|
filename: file.name,
|
||||||
contentType: 'application/octet-stream'
|
contentType: 'application/octet-stream',
|
||||||
}));
|
}));
|
||||||
|
|
||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create()
|
||||||
@@ -336,7 +334,7 @@ async function fetchAllUsers() {
|
|||||||
limitParam: 'limit',
|
limitParam: 'limit',
|
||||||
startPage: 1,
|
startPage: 1,
|
||||||
pageSize: 20,
|
pageSize: 20,
|
||||||
totalPath: 'meta.total'
|
totalPath: 'meta.total',
|
||||||
});
|
});
|
||||||
|
|
||||||
// Get first page with pagination info
|
// Get first page with pagination info
|
||||||
@@ -362,7 +360,7 @@ async function fetchAllPosts() {
|
|||||||
.withCursorPagination({
|
.withCursorPagination({
|
||||||
cursorParam: 'cursor',
|
cursorParam: 'cursor',
|
||||||
cursorPath: 'meta.nextCursor',
|
cursorPath: 'meta.nextCursor',
|
||||||
hasMorePath: 'meta.hasMore'
|
hasMorePath: 'meta.hasMore',
|
||||||
})
|
})
|
||||||
.getAllPages();
|
.getAllPages();
|
||||||
|
|
||||||
@@ -415,7 +413,7 @@ import { SmartRequest } from '@push.rocks/smartrequest';
|
|||||||
async function fetchWithRateLimitHandling() {
|
async function fetchWithRateLimitHandling() {
|
||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create()
|
||||||
.url('https://api.example.com/data')
|
.url('https://api.example.com/data')
|
||||||
.handle429Backoff() // Automatically retry on 429
|
.handle429Backoff() // Automatically retry on 429
|
||||||
.get();
|
.get();
|
||||||
|
|
||||||
return await response.json();
|
return await response.json();
|
||||||
@@ -426,14 +424,14 @@ async function fetchWithCustomRateLimiting() {
|
|||||||
const response = await SmartRequest.create()
|
const response = await SmartRequest.create()
|
||||||
.url('https://api.example.com/data')
|
.url('https://api.example.com/data')
|
||||||
.handle429Backoff({
|
.handle429Backoff({
|
||||||
maxRetries: 5, // Try up to 5 times (default: 3)
|
maxRetries: 5, // Try up to 5 times (default: 3)
|
||||||
respectRetryAfter: true, // Honor Retry-After header (default: true)
|
respectRetryAfter: true, // Honor Retry-After header (default: true)
|
||||||
maxWaitTime: 30000, // Max 30 seconds wait (default: 60000)
|
maxWaitTime: 30000, // Max 30 seconds wait (default: 60000)
|
||||||
fallbackDelay: 2000, // 2s initial delay if no Retry-After (default: 1000)
|
fallbackDelay: 2000, // 2s initial delay if no Retry-After (default: 1000)
|
||||||
backoffFactor: 2, // Exponential backoff multiplier (default: 2)
|
backoffFactor: 2, // Exponential backoff multiplier (default: 2)
|
||||||
onRateLimit: (attempt, waitTime) => {
|
onRateLimit: (attempt, waitTime) => {
|
||||||
console.log(`Rate limited. Attempt ${attempt}, waiting ${waitTime}ms`);
|
console.log(`Rate limited. Attempt ${attempt}, waiting ${waitTime}ms`);
|
||||||
}
|
},
|
||||||
})
|
})
|
||||||
.get();
|
.get();
|
||||||
|
|
||||||
@@ -448,8 +446,10 @@ class RateLimitedApiClient {
|
|||||||
.handle429Backoff({
|
.handle429Backoff({
|
||||||
maxRetries: 3,
|
maxRetries: 3,
|
||||||
onRateLimit: (attempt, waitTime) => {
|
onRateLimit: (attempt, waitTime) => {
|
||||||
console.log(`API rate limit hit. Waiting ${waitTime}ms before retry ${attempt}`);
|
console.log(
|
||||||
}
|
`API rate limit hit. Waiting ${waitTime}ms before retry ${attempt}`,
|
||||||
|
);
|
||||||
|
},
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -461,6 +461,7 @@ class RateLimitedApiClient {
|
|||||||
```
|
```
|
||||||
|
|
||||||
The rate limiting feature:
|
The rate limiting feature:
|
||||||
|
|
||||||
- Automatically detects 429 responses and retries with backoff
|
- Automatically detects 429 responses and retries with backoff
|
||||||
- Respects the `Retry-After` header when present (supports both seconds and HTTP date formats)
|
- Respects the `Retry-After` header when present (supports both seconds and HTTP date formats)
|
||||||
- Uses exponential backoff when no `Retry-After` header is provided
|
- Uses exponential backoff when no `Retry-After` header is provided
|
||||||
@@ -478,9 +479,9 @@ const response = await SmartRequest.create()
|
|||||||
.url('https://api.example.com/data')
|
.url('https://api.example.com/data')
|
||||||
.options({
|
.options({
|
||||||
credentials: 'include', // Include cookies
|
credentials: 'include', // Include cookies
|
||||||
mode: 'cors', // CORS mode
|
mode: 'cors', // CORS mode
|
||||||
cache: 'no-cache', // Cache mode
|
cache: 'no-cache', // Cache mode
|
||||||
referrerPolicy: 'no-referrer'
|
referrerPolicy: 'no-referrer',
|
||||||
})
|
})
|
||||||
.get();
|
.get();
|
||||||
```
|
```
|
||||||
@@ -496,7 +497,7 @@ const response = await SmartRequest.create()
|
|||||||
.url('https://api.example.com/data')
|
.url('https://api.example.com/data')
|
||||||
.options({
|
.options({
|
||||||
agent: new Agent({ keepAlive: true }), // Custom agent
|
agent: new Agent({ keepAlive: true }), // Custom agent
|
||||||
socketPath: '/var/run/api.sock', // Unix socket
|
socketPath: '/var/run/api.sock', // Unix socket
|
||||||
})
|
})
|
||||||
.get();
|
.get();
|
||||||
```
|
```
|
||||||
@@ -536,9 +537,7 @@ class BlogApiClient {
|
|||||||
}
|
}
|
||||||
|
|
||||||
async createPost(post: Omit<Post, 'id'>): Promise<Post> {
|
async createPost(post: Omit<Post, 'id'>): Promise<Post> {
|
||||||
const response = await this.request('/posts')
|
const response = await this.request('/posts').json(post).post();
|
||||||
.json(post)
|
|
||||||
.post();
|
|
||||||
return response.json<Post>();
|
return response.json<Post>();
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -6,7 +6,9 @@ import { CoreRequest, CoreResponse } from '../ts/core/index.js';
|
|||||||
import type { ICoreRequestOptions } from '../ts/core_base/types.js';
|
import type { ICoreRequestOptions } from '../ts/core_base/types.js';
|
||||||
|
|
||||||
tap.test('browser: should request a JSON document over https', async () => {
|
tap.test('browser: should request a JSON document over https', async () => {
|
||||||
const request = new CoreRequest('https://jsonplaceholder.typicode.com/posts/1');
|
const request = new CoreRequest(
|
||||||
|
'https://jsonplaceholder.typicode.com/posts/1',
|
||||||
|
);
|
||||||
const response = await request.fire();
|
const response = await request.fire();
|
||||||
|
|
||||||
expect(response).not.toBeNull();
|
expect(response).not.toBeNull();
|
||||||
@@ -22,11 +24,14 @@ tap.test('browser: should request a JSON document over https', async () => {
|
|||||||
tap.test('browser: should handle CORS requests', async () => {
|
tap.test('browser: should handle CORS requests', async () => {
|
||||||
const options: ICoreRequestOptions = {
|
const options: ICoreRequestOptions = {
|
||||||
headers: {
|
headers: {
|
||||||
'Accept': 'application/vnd.github.v3+json'
|
Accept: 'application/vnd.github.v3+json',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const request = new CoreRequest('https://api.github.com/users/github', options);
|
const request = new CoreRequest(
|
||||||
|
'https://api.github.com/users/github',
|
||||||
|
options,
|
||||||
|
);
|
||||||
const response = await request.fire();
|
const response = await request.fire();
|
||||||
|
|
||||||
expect(response).not.toBeNull();
|
expect(response).not.toBeNull();
|
||||||
@@ -41,12 +46,15 @@ tap.test('browser: should handle request timeouts', async () => {
|
|||||||
let timedOut = false;
|
let timedOut = false;
|
||||||
|
|
||||||
const options: ICoreRequestOptions = {
|
const options: ICoreRequestOptions = {
|
||||||
timeout: 1 // Extremely short timeout to guarantee failure
|
timeout: 1, // Extremely short timeout to guarantee failure
|
||||||
};
|
};
|
||||||
|
|
||||||
try {
|
try {
|
||||||
// Use a URL that will definitely take longer than 1ms
|
// Use a URL that will definitely take longer than 1ms
|
||||||
const request = new CoreRequest('https://jsonplaceholder.typicode.com/posts/1', options);
|
const request = new CoreRequest(
|
||||||
|
'https://jsonplaceholder.typicode.com/posts/1',
|
||||||
|
options,
|
||||||
|
);
|
||||||
await request.fire();
|
await request.fire();
|
||||||
} catch (error) {
|
} catch (error) {
|
||||||
timedOut = true;
|
timedOut = true;
|
||||||
@@ -61,15 +69,18 @@ tap.test('browser: should handle POST requests with JSON', async () => {
|
|||||||
const testData = {
|
const testData = {
|
||||||
title: 'foo',
|
title: 'foo',
|
||||||
body: 'bar',
|
body: 'bar',
|
||||||
userId: 1
|
userId: 1,
|
||||||
};
|
};
|
||||||
|
|
||||||
const options: ICoreRequestOptions = {
|
const options: ICoreRequestOptions = {
|
||||||
method: 'POST',
|
method: 'POST',
|
||||||
requestBody: testData
|
requestBody: testData,
|
||||||
};
|
};
|
||||||
|
|
||||||
const request = new CoreRequest('https://jsonplaceholder.typicode.com/posts', options);
|
const request = new CoreRequest(
|
||||||
|
'https://jsonplaceholder.typicode.com/posts',
|
||||||
|
options,
|
||||||
|
);
|
||||||
const response = await request.fire();
|
const response = await request.fire();
|
||||||
|
|
||||||
expect(response.status).toEqual(201);
|
expect(response.status).toEqual(201);
|
||||||
@@ -84,11 +95,14 @@ tap.test('browser: should handle POST requests with JSON', async () => {
|
|||||||
tap.test('browser: should handle query parameters', async () => {
|
tap.test('browser: should handle query parameters', async () => {
|
||||||
const options: ICoreRequestOptions = {
|
const options: ICoreRequestOptions = {
|
||||||
queryParams: {
|
queryParams: {
|
||||||
userId: '2'
|
userId: '2',
|
||||||
}
|
},
|
||||||
};
|
};
|
||||||
|
|
||||||
const request = new CoreRequest('https://jsonplaceholder.typicode.com/posts', options);
|
const request = new CoreRequest(
|
||||||
|
'https://jsonplaceholder.typicode.com/posts',
|
||||||
|
options,
|
||||||
|
);
|
||||||
const response = await request.fire();
|
const response = await request.fire();
|
||||||
|
|
||||||
expect(response.status).toEqual(200);
|
expect(response.status).toEqual(200);
|
||||||
|
@@ -51,7 +51,10 @@ tap.test('client: should set headers correctly', async () => {
|
|||||||
|
|
||||||
// Check if the header exists (headers might be lowercase)
|
// Check if the header exists (headers might be lowercase)
|
||||||
const headers = body.headers;
|
const headers = body.headers;
|
||||||
const headerFound = headers[customHeader] || headers[customHeader.toLowerCase()] || headers['x-custom-header'];
|
const headerFound =
|
||||||
|
headers[customHeader] ||
|
||||||
|
headers[customHeader.toLowerCase()] ||
|
||||||
|
headers['x-custom-header'];
|
||||||
expect(headerFound).toEqual(headerValue);
|
expect(headerFound).toEqual(headerValue);
|
||||||
});
|
});
|
||||||
|
|
||||||
@@ -100,29 +103,35 @@ tap.test('client: should handle retry configuration', async () => {
|
|||||||
await response.text();
|
await response.text();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('client: should support keepAlive option for connection reuse', async () => {
|
tap.test(
|
||||||
// Simple test
|
'client: should support keepAlive option for connection reuse',
|
||||||
const response = await SmartRequest.create()
|
async () => {
|
||||||
.url('https://jsonplaceholder.typicode.com/posts/1')
|
// Simple test
|
||||||
.options({ keepAlive: true })
|
const response = await SmartRequest.create()
|
||||||
.get();
|
.url('https://jsonplaceholder.typicode.com/posts/1')
|
||||||
|
.options({ keepAlive: true })
|
||||||
|
.get();
|
||||||
|
|
||||||
expect(response.ok).toBeTrue();
|
expect(response.ok).toBeTrue();
|
||||||
await response.text();
|
await response.text();
|
||||||
});
|
},
|
||||||
|
);
|
||||||
|
|
||||||
tap.test('client: should handle 429 rate limiting with default config', async () => {
|
tap.test(
|
||||||
// Test that handle429Backoff can be configured without errors
|
'client: should handle 429 rate limiting with default config',
|
||||||
const client = SmartRequest.create()
|
async () => {
|
||||||
.url('https://jsonplaceholder.typicode.com/posts/1')
|
// Test that handle429Backoff can be configured without errors
|
||||||
.handle429Backoff();
|
const client = SmartRequest.create()
|
||||||
|
.url('https://jsonplaceholder.typicode.com/posts/1')
|
||||||
|
.handle429Backoff();
|
||||||
|
|
||||||
const response = await client.get();
|
const response = await client.get();
|
||||||
expect(response.status).toEqual(200);
|
expect(response.status).toEqual(200);
|
||||||
|
|
||||||
// Consume the body to prevent socket hanging
|
// Consume the body to prevent socket hanging
|
||||||
await response.text();
|
await response.text();
|
||||||
});
|
},
|
||||||
|
);
|
||||||
|
|
||||||
tap.test('client: should handle 429 with custom config', async () => {
|
tap.test('client: should handle 429 with custom config', async () => {
|
||||||
let rateLimitCallbackCalled = false;
|
let rateLimitCallbackCalled = false;
|
||||||
@@ -139,7 +148,7 @@ tap.test('client: should handle 429 with custom config', async () => {
|
|||||||
rateLimitCallbackCalled = true;
|
rateLimitCallbackCalled = true;
|
||||||
attemptCount = attempt;
|
attemptCount = attempt;
|
||||||
waitTimeReceived = waitTime;
|
waitTimeReceived = waitTime;
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
|
|
||||||
const response = await client.get();
|
const response = await client.get();
|
||||||
@@ -152,52 +161,61 @@ tap.test('client: should handle 429 with custom config', async () => {
|
|||||||
await response.text();
|
await response.text();
|
||||||
});
|
});
|
||||||
|
|
||||||
tap.test('client: should respect Retry-After header format (seconds)', async () => {
|
tap.test(
|
||||||
// Test the configuration works - actual 429 testing would require a mock server
|
'client: should respect Retry-After header format (seconds)',
|
||||||
const client = SmartRequest.create()
|
async () => {
|
||||||
.url('https://jsonplaceholder.typicode.com/posts/1')
|
// Test the configuration works - actual 429 testing would require a mock server
|
||||||
.handle429Backoff({
|
const client = SmartRequest.create()
|
||||||
maxRetries: 1,
|
.url('https://jsonplaceholder.typicode.com/posts/1')
|
||||||
respectRetryAfter: true
|
.handle429Backoff({
|
||||||
});
|
maxRetries: 1,
|
||||||
|
respectRetryAfter: true,
|
||||||
|
});
|
||||||
|
|
||||||
const response = await client.get();
|
const response = await client.get();
|
||||||
expect(response.ok).toBeTrue();
|
expect(response.ok).toBeTrue();
|
||||||
|
|
||||||
// Consume the body to prevent socket hanging
|
// Consume the body to prevent socket hanging
|
||||||
await response.text();
|
await response.text();
|
||||||
});
|
},
|
||||||
|
);
|
||||||
|
|
||||||
tap.test('client: should handle rate limiting with exponential backoff', async () => {
|
tap.test(
|
||||||
// Test exponential backoff configuration
|
'client: should handle rate limiting with exponential backoff',
|
||||||
const client = SmartRequest.create()
|
async () => {
|
||||||
.url('https://jsonplaceholder.typicode.com/posts/1')
|
// Test exponential backoff configuration
|
||||||
.handle429Backoff({
|
const client = SmartRequest.create()
|
||||||
maxRetries: 3,
|
.url('https://jsonplaceholder.typicode.com/posts/1')
|
||||||
fallbackDelay: 100,
|
.handle429Backoff({
|
||||||
backoffFactor: 2,
|
maxRetries: 3,
|
||||||
maxWaitTime: 1000
|
fallbackDelay: 100,
|
||||||
});
|
backoffFactor: 2,
|
||||||
|
maxWaitTime: 1000,
|
||||||
|
});
|
||||||
|
|
||||||
const response = await client.get();
|
const response = await client.get();
|
||||||
expect(response.status).toEqual(200);
|
expect(response.status).toEqual(200);
|
||||||
|
|
||||||
// Consume the body to prevent socket hanging
|
// Consume the body to prevent socket hanging
|
||||||
await response.text();
|
await response.text();
|
||||||
});
|
},
|
||||||
|
);
|
||||||
|
|
||||||
tap.test('client: should not retry non-429 errors with rate limit handler', async () => {
|
tap.test(
|
||||||
// Test that 404 errors are not retried by rate limit handler
|
'client: should not retry non-429 errors with rate limit handler',
|
||||||
const client = SmartRequest.create()
|
async () => {
|
||||||
.url('https://jsonplaceholder.typicode.com/posts/999999')
|
// Test that 404 errors are not retried by rate limit handler
|
||||||
.handle429Backoff();
|
const client = SmartRequest.create()
|
||||||
|
.url('https://jsonplaceholder.typicode.com/posts/999999')
|
||||||
|
.handle429Backoff();
|
||||||
|
|
||||||
const response = await client.get();
|
const response = await client.get();
|
||||||
expect(response.status).toEqual(404);
|
expect(response.status).toEqual(404);
|
||||||
expect(response.ok).toBeFalse();
|
expect(response.ok).toBeFalse();
|
||||||
|
|
||||||
// Consume the body to prevent socket hanging
|
// Consume the body to prevent socket hanging
|
||||||
await response.text();
|
await response.text();
|
||||||
});
|
},
|
||||||
|
);
|
||||||
|
|
||||||
tap.start();
|
tap.start();
|
||||||
|
@@ -3,6 +3,6 @@
|
|||||||
*/
|
*/
|
||||||
export const commitinfo = {
|
export const commitinfo = {
|
||||||
name: '@push.rocks/smartrequest',
|
name: '@push.rocks/smartrequest',
|
||||||
version: '2.1.0',
|
version: '4.2.2',
|
||||||
description: 'A module for modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, streams, and more.'
|
description: 'A module for modern HTTP/HTTPS requests with support for form data, file uploads, JSON, binary data, streams, and more.'
|
||||||
}
|
}
|
||||||
|
@@ -1,6 +1,10 @@
|
|||||||
import { type CoreResponse } from '../../core/index.js';
|
import { type CoreResponse } from '../../core/index.js';
|
||||||
import type { ICoreResponse } from '../../core_base/types.js';
|
import type { ICoreResponse } from '../../core_base/types.js';
|
||||||
import { type TPaginationConfig, PaginationStrategy, type TPaginatedResponse } from '../types/pagination.js';
|
import {
|
||||||
|
type TPaginationConfig,
|
||||||
|
PaginationStrategy,
|
||||||
|
type TPaginatedResponse,
|
||||||
|
} from '../types/pagination.js';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Creates a paginated response from a regular response
|
* Creates a paginated response from a regular response
|
||||||
@@ -9,15 +13,17 @@ export async function createPaginatedResponse<T>(
|
|||||||
response: ICoreResponse<any>,
|
response: ICoreResponse<any>,
|
||||||
paginationConfig: TPaginationConfig,
|
paginationConfig: TPaginationConfig,
|
||||||
queryParams: Record<string, string>,
|
queryParams: Record<string, string>,
|
||||||
fetchNextPage: (params: Record<string, string>) => Promise<TPaginatedResponse<T>>
|
fetchNextPage: (
|
||||||
|
params: Record<string, string>,
|
||||||
|
) => Promise<TPaginatedResponse<T>>,
|
||||||
): Promise<TPaginatedResponse<T>> {
|
): Promise<TPaginatedResponse<T>> {
|
||||||
// Parse response body first
|
// Parse response body first
|
||||||
const body = await response.json() as any;
|
const body = (await response.json()) as any;
|
||||||
|
|
||||||
// Default to response.body for items if response is JSON
|
// Default to response.body for items if response is JSON
|
||||||
let items: T[] = Array.isArray(body)
|
let items: T[] = Array.isArray(body)
|
||||||
? body
|
? body
|
||||||
: (body?.items || body?.data || body?.results || []);
|
: body?.items || body?.data || body?.results || [];
|
||||||
|
|
||||||
let hasNextPage = false;
|
let hasNextPage = false;
|
||||||
let nextPageParams: Record<string, string> = {};
|
let nextPageParams: Record<string, string> = {};
|
||||||
@@ -26,8 +32,14 @@ export async function createPaginatedResponse<T>(
|
|||||||
switch (paginationConfig.strategy) {
|
switch (paginationConfig.strategy) {
|
||||||
case PaginationStrategy.OFFSET: {
|
case PaginationStrategy.OFFSET: {
|
||||||
const config = paginationConfig;
|
const config = paginationConfig;
|
||||||
const currentPage = parseInt(queryParams[config.pageParam || 'page'] || String(config.startPage || 1));
|
const currentPage = parseInt(
|
||||||
const limit = parseInt(queryParams[config.limitParam || 'limit'] || String(config.pageSize || 20));
|
queryParams[config.pageParam || 'page'] ||
|
||||||
|
String(config.startPage || 1),
|
||||||
|
);
|
||||||
|
const limit = parseInt(
|
||||||
|
queryParams[config.limitParam || 'limit'] ||
|
||||||
|
String(config.pageSize || 20),
|
||||||
|
);
|
||||||
const total = getValueByPath(body, config.totalPath || 'total') || 0;
|
const total = getValueByPath(body, config.totalPath || 'total') || 0;
|
||||||
|
|
||||||
hasNextPage = currentPage * limit < total;
|
hasNextPage = currentPage * limit < total;
|
||||||
@@ -35,7 +47,7 @@ export async function createPaginatedResponse<T>(
|
|||||||
if (hasNextPage) {
|
if (hasNextPage) {
|
||||||
nextPageParams = {
|
nextPageParams = {
|
||||||
...queryParams,
|
...queryParams,
|
||||||
[config.pageParam || 'page']: String(currentPage + 1)
|
[config.pageParam || 'page']: String(currentPage + 1),
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
@@ -43,7 +55,10 @@ export async function createPaginatedResponse<T>(
|
|||||||
|
|
||||||
case PaginationStrategy.CURSOR: {
|
case PaginationStrategy.CURSOR: {
|
||||||
const config = paginationConfig;
|
const config = paginationConfig;
|
||||||
const nextCursor = getValueByPath(body, config.cursorPath || 'nextCursor');
|
const nextCursor = getValueByPath(
|
||||||
|
body,
|
||||||
|
config.cursorPath || 'nextCursor',
|
||||||
|
);
|
||||||
const hasMore = getValueByPath(body, config.hasMorePath || 'hasMore');
|
const hasMore = getValueByPath(body, config.hasMorePath || 'hasMore');
|
||||||
|
|
||||||
hasNextPage = !!nextCursor || !!hasMore;
|
hasNextPage = !!nextCursor || !!hasMore;
|
||||||
@@ -51,7 +66,7 @@ export async function createPaginatedResponse<T>(
|
|||||||
if (hasNextPage && nextCursor) {
|
if (hasNextPage && nextCursor) {
|
||||||
nextPageParams = {
|
nextPageParams = {
|
||||||
...queryParams,
|
...queryParams,
|
||||||
[config.cursorParam || 'cursor']: nextCursor
|
[config.cursorParam || 'cursor']: nextCursor,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
break;
|
break;
|
||||||
@@ -60,7 +75,9 @@ export async function createPaginatedResponse<T>(
|
|||||||
case PaginationStrategy.LINK_HEADER: {
|
case PaginationStrategy.LINK_HEADER: {
|
||||||
const linkHeader = response.headers['link'] || '';
|
const linkHeader = response.headers['link'] || '';
|
||||||
// Handle both string and string[] types for the link header
|
// Handle both string and string[] types for the link header
|
||||||
const headerValue = Array.isArray(linkHeader) ? linkHeader[0] : linkHeader;
|
const headerValue = Array.isArray(linkHeader)
|
||||||
|
? linkHeader[0]
|
||||||
|
: linkHeader;
|
||||||
const links = parseLinkHeader(headerValue);
|
const links = parseLinkHeader(headerValue);
|
||||||
|
|
||||||
hasNextPage = !!links.next;
|
hasNextPage = !!links.next;
|
||||||
@@ -100,7 +117,13 @@ export async function createPaginatedResponse<T>(
|
|||||||
// Create a function to fetch all remaining pages
|
// Create a function to fetch all remaining pages
|
||||||
const getAllPages = async (): Promise<T[]> => {
|
const getAllPages = async (): Promise<T[]> => {
|
||||||
const allItems = [...items];
|
const allItems = [...items];
|
||||||
let currentPage: TPaginatedResponse<T> = { items, hasNextPage, getNextPage, getAllPages, response };
|
let currentPage: TPaginatedResponse<T> = {
|
||||||
|
items,
|
||||||
|
hasNextPage,
|
||||||
|
getNextPage,
|
||||||
|
getAllPages,
|
||||||
|
response,
|
||||||
|
};
|
||||||
|
|
||||||
while (currentPage.hasNextPage) {
|
while (currentPage.hasNextPage) {
|
||||||
try {
|
try {
|
||||||
@@ -119,7 +142,7 @@ export async function createPaginatedResponse<T>(
|
|||||||
hasNextPage,
|
hasNextPage,
|
||||||
getNextPage,
|
getNextPage,
|
||||||
getAllPages,
|
getAllPages,
|
||||||
response
|
response,
|
||||||
};
|
};
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -166,7 +189,11 @@ export function getValueByPath(obj: any, path?: string): any {
|
|||||||
let current = obj;
|
let current = obj;
|
||||||
|
|
||||||
for (const key of keys) {
|
for (const key of keys) {
|
||||||
if (current === null || current === undefined || typeof current !== 'object') {
|
if (
|
||||||
|
current === null ||
|
||||||
|
current === undefined ||
|
||||||
|
typeof current !== 'object'
|
||||||
|
) {
|
||||||
return undefined;
|
return undefined;
|
||||||
}
|
}
|
||||||
current = current[key];
|
current = current[key];
|
||||||
|
@@ -5,7 +5,14 @@ export { SmartRequest } from './smartrequest.js';
|
|||||||
export { CoreResponse } from '../core/index.js';
|
export { CoreResponse } from '../core/index.js';
|
||||||
|
|
||||||
// Export types
|
// Export types
|
||||||
export type { HttpMethod, ResponseType, FormField, RetryConfig, TimeoutConfig, RateLimitConfig } from './types/common.js';
|
export type {
|
||||||
|
HttpMethod,
|
||||||
|
ResponseType,
|
||||||
|
FormField,
|
||||||
|
RetryConfig,
|
||||||
|
TimeoutConfig,
|
||||||
|
RateLimitConfig,
|
||||||
|
} from './types/common.js';
|
||||||
export {
|
export {
|
||||||
PaginationStrategy,
|
PaginationStrategy,
|
||||||
type TPaginationConfig as PaginationConfig,
|
type TPaginationConfig as PaginationConfig,
|
||||||
@@ -13,7 +20,7 @@ export {
|
|||||||
type CursorPaginationConfig,
|
type CursorPaginationConfig,
|
||||||
type LinkPaginationConfig,
|
type LinkPaginationConfig,
|
||||||
type CustomPaginationConfig,
|
type CustomPaginationConfig,
|
||||||
type TPaginatedResponse as PaginatedResponse
|
type TPaginatedResponse as PaginatedResponse,
|
||||||
} from './types/pagination.js';
|
} from './types/pagination.js';
|
||||||
|
|
||||||
// Convenience factory functions
|
// Convenience factory functions
|
||||||
|
@@ -1,6 +1,4 @@
|
|||||||
// plugins for client module
|
// plugins for client module
|
||||||
import FormData from 'form-data';
|
import FormData from 'form-data';
|
||||||
|
|
||||||
export {
|
export { FormData as formData };
|
||||||
FormData as formData
|
|
||||||
};
|
|
||||||
|
@@ -3,14 +3,19 @@ import type { ICoreResponse } from '../core_base/types.js';
|
|||||||
import * as plugins from './plugins.js';
|
import * as plugins from './plugins.js';
|
||||||
import type { ICoreRequestOptions } from '../core_base/types.js';
|
import type { ICoreRequestOptions } from '../core_base/types.js';
|
||||||
|
|
||||||
import type { HttpMethod, ResponseType, FormField, RateLimitConfig } from './types/common.js';
|
import type {
|
||||||
|
HttpMethod,
|
||||||
|
ResponseType,
|
||||||
|
FormField,
|
||||||
|
RateLimitConfig,
|
||||||
|
} from './types/common.js';
|
||||||
import {
|
import {
|
||||||
type TPaginationConfig,
|
type TPaginationConfig,
|
||||||
PaginationStrategy,
|
PaginationStrategy,
|
||||||
type OffsetPaginationConfig,
|
type OffsetPaginationConfig,
|
||||||
type CursorPaginationConfig,
|
type CursorPaginationConfig,
|
||||||
type CustomPaginationConfig,
|
type CustomPaginationConfig,
|
||||||
type TPaginatedResponse
|
type TPaginatedResponse,
|
||||||
} from './types/pagination.js';
|
} from './types/pagination.js';
|
||||||
import { createPaginatedResponse } from './features/pagination.js';
|
import { createPaginatedResponse } from './features/pagination.js';
|
||||||
|
|
||||||
@@ -96,7 +101,7 @@ export class SmartRequest<T = any> {
|
|||||||
if (Buffer.isBuffer(item.value)) {
|
if (Buffer.isBuffer(item.value)) {
|
||||||
form.append(item.name, item.value, {
|
form.append(item.name, item.value, {
|
||||||
filename: item.filename || 'file',
|
filename: item.filename || 'file',
|
||||||
contentType: item.contentType || 'application/octet-stream'
|
contentType: item.contentType || 'application/octet-stream',
|
||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
form.append(item.name, item.value);
|
form.append(item.name, item.value);
|
||||||
@@ -109,7 +114,7 @@ export class SmartRequest<T = any> {
|
|||||||
|
|
||||||
this._options.headers = {
|
this._options.headers = {
|
||||||
...this._options.headers,
|
...this._options.headers,
|
||||||
...form.getHeaders()
|
...form.getHeaders(),
|
||||||
};
|
};
|
||||||
|
|
||||||
this._options.requestBody = form;
|
this._options.requestBody = form;
|
||||||
@@ -143,7 +148,7 @@ export class SmartRequest<T = any> {
|
|||||||
maxWaitTime: config?.maxWaitTime ?? 60000,
|
maxWaitTime: config?.maxWaitTime ?? 60000,
|
||||||
fallbackDelay: config?.fallbackDelay ?? 1000,
|
fallbackDelay: config?.fallbackDelay ?? 1000,
|
||||||
backoffFactor: config?.backoffFactor ?? 2,
|
backoffFactor: config?.backoffFactor ?? 2,
|
||||||
onRateLimit: config?.onRateLimit
|
onRateLimit: config?.onRateLimit,
|
||||||
};
|
};
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -157,7 +162,7 @@ export class SmartRequest<T = any> {
|
|||||||
}
|
}
|
||||||
this._options.headers = {
|
this._options.headers = {
|
||||||
...this._options.headers,
|
...this._options.headers,
|
||||||
...headers
|
...headers,
|
||||||
};
|
};
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -179,7 +184,7 @@ export class SmartRequest<T = any> {
|
|||||||
query(params: Record<string, string>): this {
|
query(params: Record<string, string>): this {
|
||||||
this._queryParams = {
|
this._queryParams = {
|
||||||
...this._queryParams,
|
...this._queryParams,
|
||||||
...params
|
...params,
|
||||||
};
|
};
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -190,7 +195,7 @@ export class SmartRequest<T = any> {
|
|||||||
options(options: Partial<ICoreRequestOptions>): this {
|
options(options: Partial<ICoreRequestOptions>): this {
|
||||||
this._options = {
|
this._options = {
|
||||||
...this._options,
|
...this._options,
|
||||||
...options
|
...options,
|
||||||
};
|
};
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -210,10 +215,10 @@ export class SmartRequest<T = any> {
|
|||||||
accept(type: ResponseType): this {
|
accept(type: ResponseType): this {
|
||||||
// Map response types to Accept header values
|
// Map response types to Accept header values
|
||||||
const acceptHeaders: Record<ResponseType, string> = {
|
const acceptHeaders: Record<ResponseType, string> = {
|
||||||
'json': 'application/json',
|
json: 'application/json',
|
||||||
'text': 'text/plain',
|
text: 'text/plain',
|
||||||
'binary': 'application/octet-stream',
|
binary: 'application/octet-stream',
|
||||||
'stream': '*/*'
|
stream: '*/*',
|
||||||
};
|
};
|
||||||
|
|
||||||
return this.header('Accept', acceptHeaders[type]);
|
return this.header('Accept', acceptHeaders[type]);
|
||||||
@@ -230,20 +235,26 @@ export class SmartRequest<T = any> {
|
|||||||
/**
|
/**
|
||||||
* Configure offset-based pagination (page & limit)
|
* Configure offset-based pagination (page & limit)
|
||||||
*/
|
*/
|
||||||
withOffsetPagination(config: Omit<OffsetPaginationConfig, 'strategy'> = {}): this {
|
withOffsetPagination(
|
||||||
|
config: Omit<OffsetPaginationConfig, 'strategy'> = {},
|
||||||
|
): this {
|
||||||
this._paginationConfig = {
|
this._paginationConfig = {
|
||||||
strategy: PaginationStrategy.OFFSET,
|
strategy: PaginationStrategy.OFFSET,
|
||||||
pageParam: config.pageParam || 'page',
|
pageParam: config.pageParam || 'page',
|
||||||
limitParam: config.limitParam || 'limit',
|
limitParam: config.limitParam || 'limit',
|
||||||
startPage: config.startPage || 1,
|
startPage: config.startPage || 1,
|
||||||
pageSize: config.pageSize || 20,
|
pageSize: config.pageSize || 20,
|
||||||
totalPath: config.totalPath || 'total'
|
totalPath: config.totalPath || 'total',
|
||||||
};
|
};
|
||||||
|
|
||||||
// Add initial pagination parameters
|
// Add initial pagination parameters
|
||||||
this.query({
|
this.query({
|
||||||
[this._paginationConfig.pageParam]: String(this._paginationConfig.startPage),
|
[this._paginationConfig.pageParam]: String(
|
||||||
[this._paginationConfig.limitParam]: String(this._paginationConfig.pageSize)
|
this._paginationConfig.startPage,
|
||||||
|
),
|
||||||
|
[this._paginationConfig.limitParam]: String(
|
||||||
|
this._paginationConfig.pageSize,
|
||||||
|
),
|
||||||
});
|
});
|
||||||
|
|
||||||
return this;
|
return this;
|
||||||
@@ -252,12 +263,14 @@ export class SmartRequest<T = any> {
|
|||||||
/**
|
/**
|
||||||
* Configure cursor-based pagination
|
* Configure cursor-based pagination
|
||||||
*/
|
*/
|
||||||
withCursorPagination(config: Omit<CursorPaginationConfig, 'strategy'> = {}): this {
|
withCursorPagination(
|
||||||
|
config: Omit<CursorPaginationConfig, 'strategy'> = {},
|
||||||
|
): this {
|
||||||
this._paginationConfig = {
|
this._paginationConfig = {
|
||||||
strategy: PaginationStrategy.CURSOR,
|
strategy: PaginationStrategy.CURSOR,
|
||||||
cursorParam: config.cursorParam || 'cursor',
|
cursorParam: config.cursorParam || 'cursor',
|
||||||
cursorPath: config.cursorPath || 'nextCursor',
|
cursorPath: config.cursorPath || 'nextCursor',
|
||||||
hasMorePath: config.hasMorePath || 'hasMore'
|
hasMorePath: config.hasMorePath || 'hasMore',
|
||||||
};
|
};
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -267,7 +280,7 @@ export class SmartRequest<T = any> {
|
|||||||
*/
|
*/
|
||||||
withLinkPagination(): this {
|
withLinkPagination(): this {
|
||||||
this._paginationConfig = {
|
this._paginationConfig = {
|
||||||
strategy: PaginationStrategy.LINK_HEADER
|
strategy: PaginationStrategy.LINK_HEADER,
|
||||||
};
|
};
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -279,7 +292,7 @@ export class SmartRequest<T = any> {
|
|||||||
this._paginationConfig = {
|
this._paginationConfig = {
|
||||||
strategy: PaginationStrategy.CUSTOM,
|
strategy: PaginationStrategy.CUSTOM,
|
||||||
hasNextPage: config.hasNextPage,
|
hasNextPage: config.hasNextPage,
|
||||||
getNextPageParams: config.getNextPageParams
|
getNextPageParams: config.getNextPageParams,
|
||||||
};
|
};
|
||||||
return this;
|
return this;
|
||||||
}
|
}
|
||||||
@@ -324,7 +337,9 @@ export class SmartRequest<T = any> {
|
|||||||
*/
|
*/
|
||||||
async getPaginated<ItemType = T>(): Promise<TPaginatedResponse<ItemType>> {
|
async getPaginated<ItemType = T>(): Promise<TPaginatedResponse<ItemType>> {
|
||||||
if (!this._paginationConfig) {
|
if (!this._paginationConfig) {
|
||||||
throw new Error('Pagination not configured. Call one of the pagination methods first.');
|
throw new Error(
|
||||||
|
'Pagination not configured. Call one of the pagination methods first.',
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Default to GET if no method specified
|
// Default to GET if no method specified
|
||||||
@@ -345,7 +360,7 @@ export class SmartRequest<T = any> {
|
|||||||
nextClient._queryParams = nextPageParams;
|
nextClient._queryParams = nextPageParams;
|
||||||
|
|
||||||
return nextClient.getPaginated<ItemType>();
|
return nextClient.getPaginated<ItemType>();
|
||||||
}
|
},
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -375,7 +390,7 @@ export class SmartRequest<T = any> {
|
|||||||
for (let attempt = 0; attempt <= this._retries; attempt++) {
|
for (let attempt = 0; attempt <= this._retries; attempt++) {
|
||||||
try {
|
try {
|
||||||
const request = new CoreRequest(this._url, this._options as any);
|
const request = new CoreRequest(this._url, this._options as any);
|
||||||
const response = await request.fire() as ICoreResponse<R>;
|
const response = (await request.fire()) as ICoreResponse<R>;
|
||||||
|
|
||||||
// Check for 429 status if rate limit handling is enabled
|
// Check for 429 status if rate limit handling is enabled
|
||||||
if (this._rateLimitConfig && response.status === 429) {
|
if (this._rateLimitConfig && response.status === 429) {
|
||||||
@@ -386,7 +401,10 @@ export class SmartRequest<T = any> {
|
|||||||
|
|
||||||
let waitTime: number;
|
let waitTime: number;
|
||||||
|
|
||||||
if (this._rateLimitConfig.respectRetryAfter && response.headers['retry-after']) {
|
if (
|
||||||
|
this._rateLimitConfig.respectRetryAfter &&
|
||||||
|
response.headers['retry-after']
|
||||||
|
) {
|
||||||
// Parse Retry-After header
|
// Parse Retry-After header
|
||||||
waitTime = parseRetryAfter(response.headers['retry-after']);
|
waitTime = parseRetryAfter(response.headers['retry-after']);
|
||||||
|
|
||||||
@@ -395,8 +413,9 @@ export class SmartRequest<T = any> {
|
|||||||
} else {
|
} else {
|
||||||
// Use exponential backoff
|
// Use exponential backoff
|
||||||
waitTime = Math.min(
|
waitTime = Math.min(
|
||||||
this._rateLimitConfig.fallbackDelay * Math.pow(this._rateLimitConfig.backoffFactor, rateLimitAttempt),
|
this._rateLimitConfig.fallbackDelay *
|
||||||
this._rateLimitConfig.maxWaitTime
|
Math.pow(this._rateLimitConfig.backoffFactor, rateLimitAttempt),
|
||||||
|
this._rateLimitConfig.maxWaitTime,
|
||||||
);
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -406,7 +425,7 @@ export class SmartRequest<T = any> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Wait before retrying
|
// Wait before retrying
|
||||||
await new Promise(resolve => setTimeout(resolve, waitTime));
|
await new Promise((resolve) => setTimeout(resolve, waitTime));
|
||||||
|
|
||||||
rateLimitAttempt++;
|
rateLimitAttempt++;
|
||||||
// Decrement attempt to retry this attempt
|
// Decrement attempt to retry this attempt
|
||||||
@@ -425,7 +444,7 @@ export class SmartRequest<T = any> {
|
|||||||
}
|
}
|
||||||
|
|
||||||
// Otherwise, wait before retrying
|
// Otherwise, wait before retrying
|
||||||
await new Promise(resolve => setTimeout(resolve, 1000));
|
await new Promise((resolve) => setTimeout(resolve, 1000));
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -1,7 +1,14 @@
|
|||||||
/**
|
/**
|
||||||
* HTTP Methods supported by the client
|
* HTTP Methods supported by the client
|
||||||
*/
|
*/
|
||||||
export type HttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
export type HttpMethod =
|
||||||
|
| 'GET'
|
||||||
|
| 'POST'
|
||||||
|
| 'PUT'
|
||||||
|
| 'DELETE'
|
||||||
|
| 'PATCH'
|
||||||
|
| 'HEAD'
|
||||||
|
| 'OPTIONS';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Response types supported by the client
|
* Response types supported by the client
|
||||||
@@ -30,11 +37,11 @@ export interface UrlEncodedField {
|
|||||||
* Retry configuration
|
* Retry configuration
|
||||||
*/
|
*/
|
||||||
export interface RetryConfig {
|
export interface RetryConfig {
|
||||||
attempts: number; // Number of retry attempts
|
attempts: number; // Number of retry attempts
|
||||||
initialDelay?: number; // Initial delay in ms
|
initialDelay?: number; // Initial delay in ms
|
||||||
maxDelay?: number; // Maximum delay in ms
|
maxDelay?: number; // Maximum delay in ms
|
||||||
factor?: number; // Backoff factor
|
factor?: number; // Backoff factor
|
||||||
statusCodes?: number[]; // Status codes to retry on
|
statusCodes?: number[]; // Status codes to retry on
|
||||||
shouldRetry?: (error: Error, attemptCount: number) => boolean;
|
shouldRetry?: (error: Error, attemptCount: number) => boolean;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -42,20 +49,20 @@ export interface RetryConfig {
|
|||||||
* Timeout configuration
|
* Timeout configuration
|
||||||
*/
|
*/
|
||||||
export interface TimeoutConfig {
|
export interface TimeoutConfig {
|
||||||
request?: number; // Overall request timeout in ms
|
request?: number; // Overall request timeout in ms
|
||||||
connection?: number; // Connection timeout in ms
|
connection?: number; // Connection timeout in ms
|
||||||
socket?: number; // Socket idle timeout in ms
|
socket?: number; // Socket idle timeout in ms
|
||||||
response?: number; // Response timeout in ms
|
response?: number; // Response timeout in ms
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Rate limit configuration for handling 429 responses
|
* Rate limit configuration for handling 429 responses
|
||||||
*/
|
*/
|
||||||
export interface RateLimitConfig {
|
export interface RateLimitConfig {
|
||||||
maxRetries?: number; // Maximum number of retries (default: 3)
|
maxRetries?: number; // Maximum number of retries (default: 3)
|
||||||
respectRetryAfter?: boolean; // Respect Retry-After header (default: true)
|
respectRetryAfter?: boolean; // Respect Retry-After header (default: true)
|
||||||
maxWaitTime?: number; // Max wait time in ms (default: 60000)
|
maxWaitTime?: number; // Max wait time in ms (default: 60000)
|
||||||
fallbackDelay?: number; // Delay when no Retry-After header (default: 1000)
|
fallbackDelay?: number; // Delay when no Retry-After header (default: 1000)
|
||||||
backoffFactor?: number; // Exponential backoff factor (default: 2)
|
backoffFactor?: number; // Exponential backoff factor (default: 2)
|
||||||
onRateLimit?: (attempt: number, waitTime: number) => void; // Callback for rate limit events
|
onRateLimit?: (attempt: number, waitTime: number) => void; // Callback for rate limit events
|
||||||
}
|
}
|
@@ -5,10 +5,10 @@ import type { ICoreResponse } from '../../core_base/types.js';
|
|||||||
* Pagination strategy options
|
* Pagination strategy options
|
||||||
*/
|
*/
|
||||||
export enum PaginationStrategy {
|
export enum PaginationStrategy {
|
||||||
OFFSET = 'offset', // Uses page & limit parameters
|
OFFSET = 'offset', // Uses page & limit parameters
|
||||||
CURSOR = 'cursor', // Uses a cursor/token for next page
|
CURSOR = 'cursor', // Uses a cursor/token for next page
|
||||||
LINK_HEADER = 'link', // Uses Link headers
|
LINK_HEADER = 'link', // Uses Link headers
|
||||||
CUSTOM = 'custom' // Uses a custom pagination handler
|
CUSTOM = 'custom', // Uses a custom pagination handler
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -16,11 +16,11 @@ export enum PaginationStrategy {
|
|||||||
*/
|
*/
|
||||||
export interface OffsetPaginationConfig {
|
export interface OffsetPaginationConfig {
|
||||||
strategy: PaginationStrategy.OFFSET;
|
strategy: PaginationStrategy.OFFSET;
|
||||||
pageParam?: string; // Parameter name for page number (default: "page")
|
pageParam?: string; // Parameter name for page number (default: "page")
|
||||||
limitParam?: string; // Parameter name for page size (default: "limit")
|
limitParam?: string; // Parameter name for page size (default: "limit")
|
||||||
startPage?: number; // Starting page number (default: 1)
|
startPage?: number; // Starting page number (default: 1)
|
||||||
pageSize?: number; // Number of items per page (default: 20)
|
pageSize?: number; // Number of items per page (default: 20)
|
||||||
totalPath?: string; // JSON path to total item count (default: "total")
|
totalPath?: string; // JSON path to total item count (default: "total")
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -28,9 +28,9 @@ export interface OffsetPaginationConfig {
|
|||||||
*/
|
*/
|
||||||
export interface CursorPaginationConfig {
|
export interface CursorPaginationConfig {
|
||||||
strategy: PaginationStrategy.CURSOR;
|
strategy: PaginationStrategy.CURSOR;
|
||||||
cursorParam?: string; // Parameter name for cursor (default: "cursor")
|
cursorParam?: string; // Parameter name for cursor (default: "cursor")
|
||||||
cursorPath?: string; // JSON path to next cursor (default: "nextCursor")
|
cursorPath?: string; // JSON path to next cursor (default: "nextCursor")
|
||||||
hasMorePath?: string; // JSON path to check if more items exist (default: "hasMore")
|
hasMorePath?: string; // JSON path to check if more items exist (default: "hasMore")
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -47,21 +47,28 @@ export interface LinkPaginationConfig {
|
|||||||
export interface CustomPaginationConfig {
|
export interface CustomPaginationConfig {
|
||||||
strategy: PaginationStrategy.CUSTOM;
|
strategy: PaginationStrategy.CUSTOM;
|
||||||
hasNextPage: (response: ICoreResponse<any>) => boolean;
|
hasNextPage: (response: ICoreResponse<any>) => boolean;
|
||||||
getNextPageParams: (response: ICoreResponse<any>, currentParams: Record<string, string>) => Record<string, string>;
|
getNextPageParams: (
|
||||||
|
response: ICoreResponse<any>,
|
||||||
|
currentParams: Record<string, string>,
|
||||||
|
) => Record<string, string>;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Union type of all pagination configurations
|
* Union type of all pagination configurations
|
||||||
*/
|
*/
|
||||||
export type TPaginationConfig = OffsetPaginationConfig | CursorPaginationConfig | LinkPaginationConfig | CustomPaginationConfig;
|
export type TPaginationConfig =
|
||||||
|
| OffsetPaginationConfig
|
||||||
|
| CursorPaginationConfig
|
||||||
|
| LinkPaginationConfig
|
||||||
|
| CustomPaginationConfig;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Interface for a paginated response
|
* Interface for a paginated response
|
||||||
*/
|
*/
|
||||||
export interface TPaginatedResponse<T> {
|
export interface TPaginatedResponse<T> {
|
||||||
items: T[]; // Current page items
|
items: T[]; // Current page items
|
||||||
hasNextPage: boolean; // Whether there are more pages
|
hasNextPage: boolean; // Whether there are more pages
|
||||||
getNextPage: () => Promise<TPaginatedResponse<T>>; // Function to get the next page
|
getNextPage: () => Promise<TPaginatedResponse<T>>; // Function to get the next page
|
||||||
getAllPages: () => Promise<T[]>; // Function to get all remaining pages and combine
|
getAllPages: () => Promise<T[]>; // Function to get all remaining pages and combine
|
||||||
response: ICoreResponse<any>; // Original response
|
response: ICoreResponse<any>; // Original response
|
||||||
}
|
}
|
@@ -13,8 +13,8 @@ if (smartenvInstance.isNode) {
|
|||||||
// In Node.js, load the node implementation
|
// In Node.js, load the node implementation
|
||||||
const modulePath = plugins.smartpath.join(
|
const modulePath = plugins.smartpath.join(
|
||||||
plugins.smartpath.dirname(import.meta.url),
|
plugins.smartpath.dirname(import.meta.url),
|
||||||
'../core_node/index.js'
|
'../core_node/index.js',
|
||||||
)
|
);
|
||||||
console.log(modulePath);
|
console.log(modulePath);
|
||||||
const impl = await smartenvInstance.getSafeNodeModule(modulePath);
|
const impl = await smartenvInstance.getSafeNodeModule(modulePath);
|
||||||
CoreRequest = impl.CoreRequest;
|
CoreRequest = impl.CoreRequest;
|
||||||
|
@@ -3,7 +3,10 @@ import * as types from './types.js';
|
|||||||
/**
|
/**
|
||||||
* Abstract Core Request class that defines the interface for all HTTP/HTTPS requests
|
* Abstract Core Request class that defines the interface for all HTTP/HTTPS requests
|
||||||
*/
|
*/
|
||||||
export abstract class CoreRequest<TOptions extends types.ICoreRequestOptions = types.ICoreRequestOptions, TResponse = any> {
|
export abstract class CoreRequest<
|
||||||
|
TOptions extends types.ICoreRequestOptions = types.ICoreRequestOptions,
|
||||||
|
TResponse = any,
|
||||||
|
> {
|
||||||
/**
|
/**
|
||||||
* Tests if a URL is a unix socket
|
* Tests if a URL is a unix socket
|
||||||
*/
|
*/
|
||||||
@@ -41,5 +44,4 @@ export abstract class CoreRequest<TOptions extends types.ICoreRequestOptions = t
|
|||||||
* Fire the request and return the raw response (platform-specific)
|
* Fire the request and return the raw response (platform-specific)
|
||||||
*/
|
*/
|
||||||
abstract fireCore(): Promise<any>;
|
abstract fireCore(): Promise<any>;
|
||||||
|
|
||||||
}
|
}
|
@@ -1,7 +1,14 @@
|
|||||||
/**
|
/**
|
||||||
* HTTP Methods supported
|
* HTTP Methods supported
|
||||||
*/
|
*/
|
||||||
export type THttpMethod = 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD' | 'OPTIONS';
|
export type THttpMethod =
|
||||||
|
| 'GET'
|
||||||
|
| 'POST'
|
||||||
|
| 'PUT'
|
||||||
|
| 'DELETE'
|
||||||
|
| 'PATCH'
|
||||||
|
| 'HEAD'
|
||||||
|
| 'OPTIONS';
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Response types supported
|
* Response types supported
|
||||||
|
@@ -5,13 +5,18 @@ import { CoreRequest as AbstractCoreRequest } from '../core_base/request.js';
|
|||||||
/**
|
/**
|
||||||
* Fetch-based implementation of Core Request class
|
* Fetch-based implementation of Core Request class
|
||||||
*/
|
*/
|
||||||
export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions, CoreResponse> {
|
export class CoreRequest extends AbstractCoreRequest<
|
||||||
|
types.ICoreRequestOptions,
|
||||||
|
CoreResponse
|
||||||
|
> {
|
||||||
constructor(url: string, options: types.ICoreRequestOptions = {}) {
|
constructor(url: string, options: types.ICoreRequestOptions = {}) {
|
||||||
super(url, options);
|
super(url, options);
|
||||||
|
|
||||||
// Check for unsupported Node.js-specific options
|
// Check for unsupported Node.js-specific options
|
||||||
if (options.agent || options.socketPath) {
|
if (options.agent || options.socketPath) {
|
||||||
throw new Error('Node.js specific options (agent, socketPath) are not supported in browser/fetch implementation');
|
throw new Error(
|
||||||
|
'Node.js specific options (agent, socketPath) are not supported in browser/fetch implementation',
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -19,7 +24,10 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
* Build the full URL with query parameters
|
* Build the full URL with query parameters
|
||||||
*/
|
*/
|
||||||
private buildUrl(): string {
|
private buildUrl(): string {
|
||||||
if (!this.options.queryParams || Object.keys(this.options.queryParams).length === 0) {
|
if (
|
||||||
|
!this.options.queryParams ||
|
||||||
|
Object.keys(this.options.queryParams).length === 0
|
||||||
|
) {
|
||||||
return this.url;
|
return this.url;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -50,11 +58,13 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
|
|
||||||
// Handle request body
|
// Handle request body
|
||||||
if (this.options.requestBody !== undefined) {
|
if (this.options.requestBody !== undefined) {
|
||||||
if (typeof this.options.requestBody === 'string' ||
|
if (
|
||||||
this.options.requestBody instanceof ArrayBuffer ||
|
typeof this.options.requestBody === 'string' ||
|
||||||
this.options.requestBody instanceof FormData ||
|
this.options.requestBody instanceof ArrayBuffer ||
|
||||||
this.options.requestBody instanceof URLSearchParams ||
|
this.options.requestBody instanceof FormData ||
|
||||||
this.options.requestBody instanceof ReadableStream) {
|
this.options.requestBody instanceof URLSearchParams ||
|
||||||
|
this.options.requestBody instanceof ReadableStream
|
||||||
|
) {
|
||||||
fetchOptions.body = this.options.requestBody;
|
fetchOptions.body = this.options.requestBody;
|
||||||
} else {
|
} else {
|
||||||
// Convert objects to JSON
|
// Convert objects to JSON
|
||||||
@@ -66,7 +76,10 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
if (!fetchOptions.headers.has('Content-Type')) {
|
if (!fetchOptions.headers.has('Content-Type')) {
|
||||||
fetchOptions.headers.set('Content-Type', 'application/json');
|
fetchOptions.headers.set('Content-Type', 'application/json');
|
||||||
}
|
}
|
||||||
} else if (typeof fetchOptions.headers === 'object' && !Array.isArray(fetchOptions.headers)) {
|
} else if (
|
||||||
|
typeof fetchOptions.headers === 'object' &&
|
||||||
|
!Array.isArray(fetchOptions.headers)
|
||||||
|
) {
|
||||||
const headersObj = fetchOptions.headers as Record<string, string>;
|
const headersObj = fetchOptions.headers as Record<string, string>;
|
||||||
if (!headersObj['Content-Type']) {
|
if (!headersObj['Content-Type']) {
|
||||||
headersObj['Content-Type'] = 'application/json';
|
headersObj['Content-Type'] = 'application/json';
|
||||||
@@ -77,7 +90,8 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
|
|
||||||
// Handle timeout
|
// Handle timeout
|
||||||
if (this.options.timeout || this.options.hardDataCuttingTimeout) {
|
if (this.options.timeout || this.options.hardDataCuttingTimeout) {
|
||||||
const timeout = this.options.hardDataCuttingTimeout || this.options.timeout;
|
const timeout =
|
||||||
|
this.options.hardDataCuttingTimeout || this.options.timeout;
|
||||||
const controller = new AbortController();
|
const controller = new AbortController();
|
||||||
setTimeout(() => controller.abort(), timeout);
|
setTimeout(() => controller.abort(), timeout);
|
||||||
fetchOptions.signal = controller.signal;
|
fetchOptions.signal = controller.signal;
|
||||||
@@ -117,7 +131,7 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
*/
|
*/
|
||||||
static async create(
|
static async create(
|
||||||
url: string,
|
url: string,
|
||||||
options: types.ICoreRequestOptions = {}
|
options: types.ICoreRequestOptions = {},
|
||||||
): Promise<CoreResponse> {
|
): Promise<CoreResponse> {
|
||||||
const request = new CoreRequest(url, options);
|
const request = new CoreRequest(url, options);
|
||||||
return request.fire();
|
return request.fire();
|
||||||
|
@@ -4,7 +4,10 @@ import { CoreResponse as AbstractCoreResponse } from '../core_base/response.js';
|
|||||||
/**
|
/**
|
||||||
* Fetch-based implementation of Core Response class
|
* Fetch-based implementation of Core Response class
|
||||||
*/
|
*/
|
||||||
export class CoreResponse<T = any> extends AbstractCoreResponse<T> implements types.IFetchResponse<T> {
|
export class CoreResponse<T = any>
|
||||||
|
extends AbstractCoreResponse<T>
|
||||||
|
implements types.IFetchResponse<T>
|
||||||
|
{
|
||||||
private response: Response;
|
private response: Response;
|
||||||
private responseClone: Response;
|
private responseClone: Response;
|
||||||
|
|
||||||
@@ -73,7 +76,9 @@ export class CoreResponse<T = any> extends AbstractCoreResponse<T> implements ty
|
|||||||
* Node.js stream method - not available in browser
|
* Node.js stream method - not available in browser
|
||||||
*/
|
*/
|
||||||
streamNode(): never {
|
streamNode(): never {
|
||||||
throw new Error('streamNode() is not available in browser/fetch environment. Use stream() for web-style ReadableStream.');
|
throw new Error(
|
||||||
|
'streamNode() is not available in browser/fetch environment. Use stream() for web-style ReadableStream.',
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
@@ -29,21 +29,33 @@ const httpsAgentKeepAliveFalse = new plugins.agentkeepalive.HttpsAgent({
|
|||||||
/**
|
/**
|
||||||
* Node.js implementation of Core Request class that handles all HTTP/HTTPS requests
|
* Node.js implementation of Core Request class that handles all HTTP/HTTPS requests
|
||||||
*/
|
*/
|
||||||
export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions, CoreResponse> {
|
export class CoreRequest extends AbstractCoreRequest<
|
||||||
|
types.ICoreRequestOptions,
|
||||||
|
CoreResponse
|
||||||
|
> {
|
||||||
private requestDataFunc: ((req: plugins.http.ClientRequest) => void) | null;
|
private requestDataFunc: ((req: plugins.http.ClientRequest) => void) | null;
|
||||||
|
|
||||||
constructor(
|
constructor(
|
||||||
url: string,
|
url: string,
|
||||||
options: types.ICoreRequestOptions = {},
|
options: types.ICoreRequestOptions = {},
|
||||||
requestDataFunc: ((req: plugins.http.ClientRequest) => void) | null = null
|
requestDataFunc: ((req: plugins.http.ClientRequest) => void) | null = null,
|
||||||
) {
|
) {
|
||||||
super(url, options);
|
super(url, options);
|
||||||
this.requestDataFunc = requestDataFunc;
|
this.requestDataFunc = requestDataFunc;
|
||||||
|
|
||||||
// Check for unsupported fetch-specific options
|
// Check for unsupported fetch-specific options
|
||||||
if (options.credentials || options.mode || options.cache || options.redirect ||
|
if (
|
||||||
options.referrer || options.referrerPolicy || options.integrity) {
|
options.credentials ||
|
||||||
throw new Error('Fetch API specific options (credentials, mode, cache, redirect, referrer, referrerPolicy, integrity) are not supported in Node.js implementation');
|
options.mode ||
|
||||||
|
options.cache ||
|
||||||
|
options.redirect ||
|
||||||
|
options.referrer ||
|
||||||
|
options.referrerPolicy ||
|
||||||
|
options.integrity
|
||||||
|
) {
|
||||||
|
throw new Error(
|
||||||
|
'Fetch API specific options (credentials, mode, cache, redirect, referrer, referrerPolicy, integrity) are not supported in Node.js implementation',
|
||||||
|
);
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -74,7 +86,9 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
|
|
||||||
// Handle unix socket URLs
|
// Handle unix socket URLs
|
||||||
if (CoreRequest.isUnixSocket(this.url)) {
|
if (CoreRequest.isUnixSocket(this.url)) {
|
||||||
const { socketPath, path } = CoreRequest.parseUnixSocketUrl(this.options.path);
|
const { socketPath, path } = CoreRequest.parseUnixSocketUrl(
|
||||||
|
this.options.path,
|
||||||
|
);
|
||||||
this.options.socketPath = socketPath;
|
this.options.socketPath = socketPath;
|
||||||
this.options.path = path;
|
this.options.path = path;
|
||||||
}
|
}
|
||||||
@@ -83,18 +97,25 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
if (!this.options.agent) {
|
if (!this.options.agent) {
|
||||||
// Only use keep-alive agents if explicitly requested
|
// Only use keep-alive agents if explicitly requested
|
||||||
if (this.options.keepAlive === true) {
|
if (this.options.keepAlive === true) {
|
||||||
this.options.agent = parsedUrl.protocol === 'https:' ? httpsAgent : httpAgent;
|
this.options.agent =
|
||||||
|
parsedUrl.protocol === 'https:' ? httpsAgent : httpAgent;
|
||||||
} else if (this.options.keepAlive === false) {
|
} else if (this.options.keepAlive === false) {
|
||||||
this.options.agent = parsedUrl.protocol === 'https:' ? httpsAgentKeepAliveFalse : httpAgentKeepAliveFalse;
|
this.options.agent =
|
||||||
|
parsedUrl.protocol === 'https:'
|
||||||
|
? httpsAgentKeepAliveFalse
|
||||||
|
: httpAgentKeepAliveFalse;
|
||||||
}
|
}
|
||||||
// If keepAlive is undefined, don't set any agent (more fetch-like behavior)
|
// If keepAlive is undefined, don't set any agent (more fetch-like behavior)
|
||||||
}
|
}
|
||||||
|
|
||||||
// Determine request module
|
// Determine request module
|
||||||
const requestModule = parsedUrl.protocol === 'https:' ? plugins.https : plugins.http;
|
const requestModule =
|
||||||
|
parsedUrl.protocol === 'https:' ? plugins.https : plugins.http;
|
||||||
|
|
||||||
if (!requestModule) {
|
if (!requestModule) {
|
||||||
throw new Error(`The request to ${this.url} is missing a viable protocol. Must be http or https`);
|
throw new Error(
|
||||||
|
`The request to ${this.url} is missing a viable protocol. Must be http or https`,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
// Perform the request
|
// Perform the request
|
||||||
@@ -119,11 +140,12 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
});
|
});
|
||||||
} else {
|
} else {
|
||||||
// Write body as-is - caller is responsible for serialization
|
// Write body as-is - caller is responsible for serialization
|
||||||
const bodyData = typeof this.options.requestBody === 'string'
|
const bodyData =
|
||||||
? this.options.requestBody
|
typeof this.options.requestBody === 'string'
|
||||||
: this.options.requestBody instanceof Buffer
|
|
||||||
? this.options.requestBody
|
? this.options.requestBody
|
||||||
: JSON.stringify(this.options.requestBody); // Still stringify for backward compatibility
|
: this.options.requestBody instanceof Buffer
|
||||||
|
? this.options.requestBody
|
||||||
|
: JSON.stringify(this.options.requestBody); // Still stringify for backward compatibility
|
||||||
request.write(bodyData);
|
request.write(bodyData);
|
||||||
request.end();
|
request.end();
|
||||||
}
|
}
|
||||||
@@ -155,7 +177,7 @@ export class CoreRequest extends AbstractCoreRequest<types.ICoreRequestOptions,
|
|||||||
*/
|
*/
|
||||||
static async create(
|
static async create(
|
||||||
url: string,
|
url: string,
|
||||||
options: types.ICoreRequestOptions = {}
|
options: types.ICoreRequestOptions = {},
|
||||||
): Promise<CoreResponse> {
|
): Promise<CoreResponse> {
|
||||||
const request = new CoreRequest(url, options);
|
const request = new CoreRequest(url, options);
|
||||||
return request.fire();
|
return request.fire();
|
||||||
|
@@ -5,7 +5,10 @@ import { CoreResponse as AbstractCoreResponse } from '../core_base/response.js';
|
|||||||
/**
|
/**
|
||||||
* Node.js implementation of Core Response class that provides a fetch-like API
|
* Node.js implementation of Core Response class that provides a fetch-like API
|
||||||
*/
|
*/
|
||||||
export class CoreResponse<T = any> extends AbstractCoreResponse<T> implements types.INodeResponse<T> {
|
export class CoreResponse<T = any>
|
||||||
|
extends AbstractCoreResponse<T>
|
||||||
|
implements types.INodeResponse<T>
|
||||||
|
{
|
||||||
private incomingMessage: plugins.http.IncomingMessage;
|
private incomingMessage: plugins.http.IncomingMessage;
|
||||||
private bodyBufferPromise: Promise<Buffer> | null = null;
|
private bodyBufferPromise: Promise<Buffer> | null = null;
|
||||||
private _autoDrainTimeout: NodeJS.Immediate | null = null;
|
private _autoDrainTimeout: NodeJS.Immediate | null = null;
|
||||||
@@ -17,7 +20,11 @@ export class CoreResponse<T = any> extends AbstractCoreResponse<T> implements ty
|
|||||||
public readonly headers: plugins.http.IncomingHttpHeaders;
|
public readonly headers: plugins.http.IncomingHttpHeaders;
|
||||||
public readonly url: string;
|
public readonly url: string;
|
||||||
|
|
||||||
constructor(incomingMessage: plugins.http.IncomingMessage, url: string, options: types.ICoreRequestOptions = {}) {
|
constructor(
|
||||||
|
incomingMessage: plugins.http.IncomingMessage,
|
||||||
|
url: string,
|
||||||
|
options: types.ICoreRequestOptions = {},
|
||||||
|
) {
|
||||||
super();
|
super();
|
||||||
this.incomingMessage = incomingMessage;
|
this.incomingMessage = incomingMessage;
|
||||||
this.url = url;
|
this.url = url;
|
||||||
@@ -32,7 +39,9 @@ export class CoreResponse<T = any> extends AbstractCoreResponse<T> implements ty
|
|||||||
if (options.autoDrain !== false) {
|
if (options.autoDrain !== false) {
|
||||||
this._autoDrainTimeout = setImmediate(() => {
|
this._autoDrainTimeout = setImmediate(() => {
|
||||||
if (!this.consumed && !this.incomingMessage.readableEnded) {
|
if (!this.consumed && !this.incomingMessage.readableEnded) {
|
||||||
console.log(`Auto-draining unconsumed response body for ${this.url} (status: ${this.status})`);
|
console.log(
|
||||||
|
`Auto-draining unconsumed response body for ${this.url} (status: ${this.status})`,
|
||||||
|
);
|
||||||
this.incomingMessage.resume(); // Drain without processing
|
this.incomingMessage.resume(); // Drain without processing
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
@@ -106,7 +115,10 @@ export class CoreResponse<T = any> extends AbstractCoreResponse<T> implements ty
|
|||||||
*/
|
*/
|
||||||
async arrayBuffer(): Promise<ArrayBuffer> {
|
async arrayBuffer(): Promise<ArrayBuffer> {
|
||||||
const buffer = await this.collectBody();
|
const buffer = await this.collectBody();
|
||||||
return buffer.buffer.slice(buffer.byteOffset, buffer.byteOffset + buffer.byteLength);
|
return buffer.buffer.slice(
|
||||||
|
buffer.byteOffset,
|
||||||
|
buffer.byteOffset + buffer.byteLength,
|
||||||
|
);
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@@ -140,7 +152,7 @@ export class CoreResponse<T = any> extends AbstractCoreResponse<T> implements ty
|
|||||||
|
|
||||||
cancel() {
|
cancel() {
|
||||||
nodeStream.destroy();
|
nodeStream.destroy();
|
||||||
}
|
},
|
||||||
});
|
});
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -158,5 +170,4 @@ export class CoreResponse<T = any> extends AbstractCoreResponse<T> implements ty
|
|||||||
raw(): plugins.http.IncomingMessage {
|
raw(): plugins.http.IncomingMessage {
|
||||||
return this.incomingMessage;
|
return this.incomingMessage;
|
||||||
}
|
}
|
||||||
|
|
||||||
}
|
}
|
@@ -7,7 +7,8 @@ export * from '../core_base/types.js';
|
|||||||
/**
|
/**
|
||||||
* Extended IncomingMessage with body property (legacy compatibility)
|
* Extended IncomingMessage with body property (legacy compatibility)
|
||||||
*/
|
*/
|
||||||
export interface IExtendedIncomingMessage<T = any> extends plugins.http.IncomingMessage {
|
export interface IExtendedIncomingMessage<T = any>
|
||||||
|
extends plugins.http.IncomingMessage {
|
||||||
body: T;
|
body: T;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
@@ -6,9 +6,9 @@
|
|||||||
"module": "NodeNext",
|
"module": "NodeNext",
|
||||||
"moduleResolution": "NodeNext",
|
"moduleResolution": "NodeNext",
|
||||||
"esModuleInterop": true,
|
"esModuleInterop": true,
|
||||||
"verbatimModuleSyntax": true
|
"verbatimModuleSyntax": true,
|
||||||
|
"baseUrl": ".",
|
||||||
|
"paths": {}
|
||||||
},
|
},
|
||||||
"exclude": [
|
"exclude": ["dist_*/**/*.d.ts"]
|
||||||
"dist_*/**/*.d.ts"
|
|
||||||
]
|
|
||||||
}
|
}
|
||||||
|
Reference in New Issue
Block a user