Compare commits
46
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3d29fb91d1 | ||
|
|
91b7bf978c | ||
|
|
3e2837ddce | ||
|
|
3048a9d72c | ||
|
|
91f9153ca8 | ||
|
|
eef3e92175 | ||
|
|
ed87cc6ce3 | ||
|
|
af45ad8eaa | ||
|
|
367a6c2423 | ||
|
|
8f2bd5d713 | ||
|
|
7654d97eb6 | ||
|
|
0b2505c754 | ||
|
|
f8a69bc473 | ||
|
|
03eca1b0c7 | ||
|
|
4b12bd3649 | ||
|
|
6cd8286138 | ||
|
|
3abbc6c24c | ||
|
|
d594f1e4b3 | ||
|
|
4a2602dd58 | ||
|
|
745f129332 | ||
|
|
daa24d7958 | ||
|
|
bda035c74d | ||
|
|
79acd5bac4 | ||
|
|
b602df7c05 | ||
|
|
80a66f3298 | ||
|
|
7756e7c4cb | ||
|
|
6d774fcb59 | ||
|
|
f05c940e43 | ||
|
|
a71585a450 | ||
|
|
76ac2fcd59 | ||
|
|
edee7cde32 | ||
|
|
6295f5d25b | ||
|
|
339dd63bec | ||
|
|
d27bf857e6 | ||
|
|
ec5c955c0a | ||
|
|
302a5b31d8 | ||
|
|
ab2b23c50d | ||
|
|
70a01b86d3 | ||
|
|
ff80a82f7c | ||
|
|
0fc0befe24 | ||
|
|
7d95d2cec9 | ||
|
|
c42d30607b | ||
|
|
ac58d176ba | ||
|
|
518ef1b79e | ||
|
|
d496b07cc0 | ||
|
|
7a2eceac36 |
@@ -5,8 +5,8 @@ on:
|
|||||||
inputs:
|
inputs:
|
||||||
package:
|
package:
|
||||||
required: true
|
required: true
|
||||||
description: 'core, artifact, cache, exec, github, glob, io, tool-cache'
|
description: 'core, artifact, cache, exec, github, glob, http-client, io, tool-cache'
|
||||||
|
|
||||||
jobs:
|
jobs:
|
||||||
test:
|
test:
|
||||||
runs-on: macos-latest
|
runs-on: macos-latest
|
||||||
@@ -17,40 +17,40 @@ jobs:
|
|||||||
|
|
||||||
- name: verify package exists
|
- name: verify package exists
|
||||||
run: ls packages/${{ github.event.inputs.package }}
|
run: ls packages/${{ github.event.inputs.package }}
|
||||||
|
|
||||||
- name: Set Node.js 12.x
|
- name: Set Node.js 12.x
|
||||||
uses: actions/setup-node@v1
|
uses: actions/setup-node@v1
|
||||||
with:
|
with:
|
||||||
node-version: 12.x
|
node-version: 12.x
|
||||||
|
|
||||||
- name: npm install
|
- name: npm install
|
||||||
run: npm install
|
run: npm install
|
||||||
|
|
||||||
- name: bootstrap
|
- name: bootstrap
|
||||||
run: npm run bootstrap
|
run: npm run bootstrap
|
||||||
|
|
||||||
- name: build
|
- name: build
|
||||||
run: npm run build
|
run: npm run build
|
||||||
|
|
||||||
- name: test
|
- name: test
|
||||||
run: npm run test
|
run: npm run test
|
||||||
|
|
||||||
- name: pack
|
- name: pack
|
||||||
run: npm pack
|
run: npm pack
|
||||||
working-directory: packages/${{ github.event.inputs.package }}
|
working-directory: packages/${{ github.event.inputs.package }}
|
||||||
|
|
||||||
- name: upload artifact
|
- name: upload artifact
|
||||||
uses: actions/upload-artifact@v2
|
uses: actions/upload-artifact@v2
|
||||||
with:
|
with:
|
||||||
name: ${{ github.event.inputs.package }}
|
name: ${{ github.event.inputs.package }}
|
||||||
path: packages/${{ github.event.inputs.package }}/*.tgz
|
path: packages/${{ github.event.inputs.package }}/*.tgz
|
||||||
|
|
||||||
publish:
|
publish:
|
||||||
runs-on: macos-latest
|
runs-on: macos-latest
|
||||||
needs: test
|
needs: test
|
||||||
environment: npm-publish
|
environment: npm-publish
|
||||||
steps:
|
steps:
|
||||||
|
|
||||||
- name: download artifact
|
- name: download artifact
|
||||||
uses: actions/download-artifact@v2
|
uses: actions/download-artifact@v2
|
||||||
with:
|
with:
|
||||||
@@ -58,7 +58,7 @@ jobs:
|
|||||||
|
|
||||||
- name: setup authentication
|
- name: setup authentication
|
||||||
run: echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> .npmrc
|
run: echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" >> .npmrc
|
||||||
env:
|
env:
|
||||||
NPM_TOKEN: ${{ secrets.TOKEN }}
|
NPM_TOKEN: ${{ secrets.TOKEN }}
|
||||||
|
|
||||||
- name: publish
|
- name: publish
|
||||||
@@ -68,13 +68,13 @@ jobs:
|
|||||||
if: failure()
|
if: failure()
|
||||||
run: |
|
run: |
|
||||||
curl -X POST -H 'Content-type: application/json' --data '{"text":":pb__failed: Failed to publish a new version of ${{ github.event.inputs.package }}"}' $SLACK_WEBHOOK
|
curl -X POST -H 'Content-type: application/json' --data '{"text":":pb__failed: Failed to publish a new version of ${{ github.event.inputs.package }}"}' $SLACK_WEBHOOK
|
||||||
env:
|
env:
|
||||||
SLACK_WEBHOOK: ${{ secrets.SLACK }}
|
SLACK_WEBHOOK: ${{ secrets.SLACK }}
|
||||||
|
|
||||||
- name: notify slack on success
|
- name: notify slack on success
|
||||||
if: success()
|
if: success()
|
||||||
run: |
|
run: |
|
||||||
curl -X POST -H 'Content-type: application/json' --data '{"text":":dance: Successfully published a new version of ${{ github.event.inputs.package }}"}' $SLACK_WEBHOOK
|
curl -X POST -H 'Content-type: application/json' --data '{"text":":dance: Successfully published a new version of ${{ github.event.inputs.package }}"}' $SLACK_WEBHOOK
|
||||||
env:
|
env:
|
||||||
SLACK_WEBHOOK: ${{ secrets.SLACK }}
|
SLACK_WEBHOOK: ${{ secrets.SLACK }}
|
||||||
|
|
||||||
|
|||||||
@@ -46,6 +46,15 @@ $ npm install @actions/glob
|
|||||||
```
|
```
|
||||||
<br/>
|
<br/>
|
||||||
|
|
||||||
|
:phone: [@actions/http-client](packages/http-client)
|
||||||
|
|
||||||
|
A lightweight HTTP client optimized for building actions. Read more [here](packages/http-client)
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ npm install @actions/http-client
|
||||||
|
```
|
||||||
|
<br/>
|
||||||
|
|
||||||
:pencil2: [@actions/io](packages/io)
|
:pencil2: [@actions/io](packages/io)
|
||||||
|
|
||||||
Provides disk i/o functions like cp, mv, rmRF, which etc. Read more [here](packages/io)
|
Provides disk i/o functions like cp, mv, rmRF, which etc. Read more [here](packages/io)
|
||||||
|
|||||||
Generated
+16287
-2997
File diff suppressed because it is too large
Load Diff
+33
-1
@@ -1,5 +1,6 @@
|
|||||||
import {retry} from '../src/internal/requestUtils'
|
import {retry, retryTypedResponse} from '../src/internal/requestUtils'
|
||||||
import {HttpClientError} from '@actions/http-client'
|
import {HttpClientError} from '@actions/http-client'
|
||||||
|
import * as requestUtils from '../src/internal/requestUtils'
|
||||||
|
|
||||||
interface ITestResponse {
|
interface ITestResponse {
|
||||||
statusCode: number
|
statusCode: number
|
||||||
@@ -145,3 +146,34 @@ test('retry converts errors to response object', async () => {
|
|||||||
null
|
null
|
||||||
)
|
)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
test('retryTypedResponse gives an error with error message', async () => {
|
||||||
|
const httpClientError = new HttpClientError(
|
||||||
|
'The cache filesize must be between 0 and 10 * 1024 * 1024 bytes',
|
||||||
|
400
|
||||||
|
)
|
||||||
|
jest.spyOn(requestUtils, 'retry').mockReturnValue(
|
||||||
|
new Promise(resolve => {
|
||||||
|
resolve(httpClientError)
|
||||||
|
})
|
||||||
|
)
|
||||||
|
try {
|
||||||
|
await retryTypedResponse<string>(
|
||||||
|
'reserveCache',
|
||||||
|
async () =>
|
||||||
|
new Promise(resolve => {
|
||||||
|
resolve({
|
||||||
|
statusCode: 400,
|
||||||
|
result: '',
|
||||||
|
headers: {},
|
||||||
|
error: httpClientError
|
||||||
|
})
|
||||||
|
})
|
||||||
|
)
|
||||||
|
} catch (error) {
|
||||||
|
expect(error).toHaveProperty(
|
||||||
|
'message',
|
||||||
|
'The cache filesize must be between 0 and 10 * 1024 * 1024 bytes'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
|||||||
+117
-13
@@ -5,6 +5,12 @@ import * as cacheHttpClient from '../src/internal/cacheHttpClient'
|
|||||||
import * as cacheUtils from '../src/internal/cacheUtils'
|
import * as cacheUtils from '../src/internal/cacheUtils'
|
||||||
import {CacheFilename, CompressionMethod} from '../src/internal/constants'
|
import {CacheFilename, CompressionMethod} from '../src/internal/constants'
|
||||||
import * as tar from '../src/internal/tar'
|
import * as tar from '../src/internal/tar'
|
||||||
|
import {ITypedResponse} from '@actions/http-client/interfaces'
|
||||||
|
import {
|
||||||
|
ReserveCacheResponse,
|
||||||
|
ITypedResponseWithError
|
||||||
|
} from '../src/internal/contracts'
|
||||||
|
import {HttpClientError} from '@actions/http-client'
|
||||||
|
|
||||||
jest.mock('../src/internal/cacheHttpClient')
|
jest.mock('../src/internal/cacheHttpClient')
|
||||||
jest.mock('../src/internal/cacheUtils')
|
jest.mock('../src/internal/cacheUtils')
|
||||||
@@ -16,16 +22,13 @@ beforeAll(() => {
|
|||||||
jest.spyOn(core, 'info').mockImplementation(() => {})
|
jest.spyOn(core, 'info').mockImplementation(() => {})
|
||||||
jest.spyOn(core, 'warning').mockImplementation(() => {})
|
jest.spyOn(core, 'warning').mockImplementation(() => {})
|
||||||
jest.spyOn(core, 'error').mockImplementation(() => {})
|
jest.spyOn(core, 'error').mockImplementation(() => {})
|
||||||
|
|
||||||
jest.spyOn(cacheUtils, 'getCacheFileName').mockImplementation(cm => {
|
jest.spyOn(cacheUtils, 'getCacheFileName').mockImplementation(cm => {
|
||||||
const actualUtils = jest.requireActual('../src/internal/cacheUtils')
|
const actualUtils = jest.requireActual('../src/internal/cacheUtils')
|
||||||
return actualUtils.getCacheFileName(cm)
|
return actualUtils.getCacheFileName(cm)
|
||||||
})
|
})
|
||||||
|
|
||||||
jest.spyOn(cacheUtils, 'resolvePaths').mockImplementation(async filePaths => {
|
jest.spyOn(cacheUtils, 'resolvePaths').mockImplementation(async filePaths => {
|
||||||
return filePaths.map(x => path.resolve(x))
|
return filePaths.map(x => path.resolve(x))
|
||||||
})
|
})
|
||||||
|
|
||||||
jest.spyOn(cacheUtils, 'createTempDirectory').mockImplementation(async () => {
|
jest.spyOn(cacheUtils, 'createTempDirectory').mockImplementation(async () => {
|
||||||
return Promise.resolve('/foo/bar')
|
return Promise.resolve('/foo/bar')
|
||||||
})
|
})
|
||||||
@@ -70,6 +73,98 @@ test('save with large cache outputs should fail', async () => {
|
|||||||
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
||||||
})
|
})
|
||||||
|
|
||||||
|
test('save with large cache outputs should fail in GHES with error message', async () => {
|
||||||
|
const filePath = 'node_modules'
|
||||||
|
const primaryKey = 'Linux-node-bb828da54c148048dd17899ba9fda624811cfb43'
|
||||||
|
const cachePaths = [path.resolve(filePath)]
|
||||||
|
|
||||||
|
const createTarMock = jest.spyOn(tar, 'createTar')
|
||||||
|
|
||||||
|
const cacheSize = 11 * 1024 * 1024 * 1024 //~11GB, over the 10GB limit
|
||||||
|
jest
|
||||||
|
.spyOn(cacheUtils, 'getArchiveFileSizeInBytes')
|
||||||
|
.mockReturnValueOnce(cacheSize)
|
||||||
|
const compression = CompressionMethod.Gzip
|
||||||
|
const getCompressionMock = jest
|
||||||
|
.spyOn(cacheUtils, 'getCompressionMethod')
|
||||||
|
.mockReturnValueOnce(Promise.resolve(compression))
|
||||||
|
|
||||||
|
jest.spyOn(cacheUtils, 'isGhes').mockReturnValueOnce(true)
|
||||||
|
|
||||||
|
const reserveCacheMock = jest
|
||||||
|
.spyOn(cacheHttpClient, 'reserveCache')
|
||||||
|
.mockImplementation(async () => {
|
||||||
|
const response: ITypedResponseWithError<ReserveCacheResponse> = {
|
||||||
|
statusCode: 400,
|
||||||
|
result: null,
|
||||||
|
headers: {},
|
||||||
|
error: new HttpClientError(
|
||||||
|
'The cache filesize must be between 0 and 1073741824 bytes',
|
||||||
|
400
|
||||||
|
)
|
||||||
|
}
|
||||||
|
return response
|
||||||
|
})
|
||||||
|
|
||||||
|
await expect(saveCache([filePath], primaryKey)).rejects.toThrowError(
|
||||||
|
'The cache filesize must be between 0 and 1073741824 bytes'
|
||||||
|
)
|
||||||
|
|
||||||
|
const archiveFolder = '/foo/bar'
|
||||||
|
expect(reserveCacheMock).toHaveBeenCalledTimes(1)
|
||||||
|
expect(createTarMock).toHaveBeenCalledTimes(1)
|
||||||
|
expect(createTarMock).toHaveBeenCalledWith(
|
||||||
|
archiveFolder,
|
||||||
|
cachePaths,
|
||||||
|
compression
|
||||||
|
)
|
||||||
|
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
||||||
|
})
|
||||||
|
|
||||||
|
test('save with large cache outputs should fail in GHES without error message', async () => {
|
||||||
|
const filePath = 'node_modules'
|
||||||
|
const primaryKey = 'Linux-node-bb828da54c148048dd17899ba9fda624811cfb43'
|
||||||
|
const cachePaths = [path.resolve(filePath)]
|
||||||
|
|
||||||
|
const createTarMock = jest.spyOn(tar, 'createTar')
|
||||||
|
|
||||||
|
const cacheSize = 11 * 1024 * 1024 * 1024 //~11GB, over the 10GB limit
|
||||||
|
jest
|
||||||
|
.spyOn(cacheUtils, 'getArchiveFileSizeInBytes')
|
||||||
|
.mockReturnValueOnce(cacheSize)
|
||||||
|
const compression = CompressionMethod.Gzip
|
||||||
|
const getCompressionMock = jest
|
||||||
|
.spyOn(cacheUtils, 'getCompressionMethod')
|
||||||
|
.mockReturnValueOnce(Promise.resolve(compression))
|
||||||
|
|
||||||
|
jest.spyOn(cacheUtils, 'isGhes').mockReturnValueOnce(true)
|
||||||
|
|
||||||
|
const reserveCacheMock = jest
|
||||||
|
.spyOn(cacheHttpClient, 'reserveCache')
|
||||||
|
.mockImplementation(async () => {
|
||||||
|
const response: ITypedResponseWithError<ReserveCacheResponse> = {
|
||||||
|
statusCode: 400,
|
||||||
|
result: null,
|
||||||
|
headers: {}
|
||||||
|
}
|
||||||
|
return response
|
||||||
|
})
|
||||||
|
|
||||||
|
await expect(saveCache([filePath], primaryKey)).rejects.toThrowError(
|
||||||
|
'Cache size of ~11264 MB (11811160064 B) is over the data cap limit, not saving cache.'
|
||||||
|
)
|
||||||
|
|
||||||
|
const archiveFolder = '/foo/bar'
|
||||||
|
expect(reserveCacheMock).toHaveBeenCalledTimes(1)
|
||||||
|
expect(createTarMock).toHaveBeenCalledTimes(1)
|
||||||
|
expect(createTarMock).toHaveBeenCalledWith(
|
||||||
|
archiveFolder,
|
||||||
|
cachePaths,
|
||||||
|
compression
|
||||||
|
)
|
||||||
|
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
||||||
|
})
|
||||||
|
|
||||||
test('save with reserve cache failure should fail', async () => {
|
test('save with reserve cache failure should fail', async () => {
|
||||||
const paths = ['node_modules']
|
const paths = ['node_modules']
|
||||||
const primaryKey = 'Linux-node-bb828da54c148048dd17899ba9fda624811cfb43'
|
const primaryKey = 'Linux-node-bb828da54c148048dd17899ba9fda624811cfb43'
|
||||||
@@ -77,7 +172,12 @@ test('save with reserve cache failure should fail', async () => {
|
|||||||
const reserveCacheMock = jest
|
const reserveCacheMock = jest
|
||||||
.spyOn(cacheHttpClient, 'reserveCache')
|
.spyOn(cacheHttpClient, 'reserveCache')
|
||||||
.mockImplementation(async () => {
|
.mockImplementation(async () => {
|
||||||
return -1
|
const response: ITypedResponse<ReserveCacheResponse> = {
|
||||||
|
statusCode: 500,
|
||||||
|
result: null,
|
||||||
|
headers: {}
|
||||||
|
}
|
||||||
|
return response
|
||||||
})
|
})
|
||||||
|
|
||||||
const createTarMock = jest.spyOn(tar, 'createTar')
|
const createTarMock = jest.spyOn(tar, 'createTar')
|
||||||
@@ -94,7 +194,7 @@ test('save with reserve cache failure should fail', async () => {
|
|||||||
expect(reserveCacheMock).toHaveBeenCalledWith(primaryKey, paths, {
|
expect(reserveCacheMock).toHaveBeenCalledWith(primaryKey, paths, {
|
||||||
compressionMethod: compression
|
compressionMethod: compression
|
||||||
})
|
})
|
||||||
expect(createTarMock).toHaveBeenCalledTimes(0)
|
expect(createTarMock).toHaveBeenCalledTimes(1)
|
||||||
expect(saveCacheMock).toHaveBeenCalledTimes(0)
|
expect(saveCacheMock).toHaveBeenCalledTimes(0)
|
||||||
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
||||||
})
|
})
|
||||||
@@ -108,7 +208,12 @@ test('save with server error should fail', async () => {
|
|||||||
const reserveCacheMock = jest
|
const reserveCacheMock = jest
|
||||||
.spyOn(cacheHttpClient, 'reserveCache')
|
.spyOn(cacheHttpClient, 'reserveCache')
|
||||||
.mockImplementation(async () => {
|
.mockImplementation(async () => {
|
||||||
return cacheId
|
const response: ITypedResponse<ReserveCacheResponse> = {
|
||||||
|
statusCode: 500,
|
||||||
|
result: {cacheId},
|
||||||
|
headers: {}
|
||||||
|
}
|
||||||
|
return response
|
||||||
})
|
})
|
||||||
|
|
||||||
const createTarMock = jest.spyOn(tar, 'createTar')
|
const createTarMock = jest.spyOn(tar, 'createTar')
|
||||||
@@ -130,17 +235,14 @@ test('save with server error should fail', async () => {
|
|||||||
expect(reserveCacheMock).toHaveBeenCalledWith(primaryKey, [filePath], {
|
expect(reserveCacheMock).toHaveBeenCalledWith(primaryKey, [filePath], {
|
||||||
compressionMethod: compression
|
compressionMethod: compression
|
||||||
})
|
})
|
||||||
|
|
||||||
const archiveFolder = '/foo/bar'
|
const archiveFolder = '/foo/bar'
|
||||||
const archiveFile = path.join(archiveFolder, CacheFilename.Zstd)
|
const archiveFile = path.join(archiveFolder, CacheFilename.Zstd)
|
||||||
|
|
||||||
expect(createTarMock).toHaveBeenCalledTimes(1)
|
expect(createTarMock).toHaveBeenCalledTimes(1)
|
||||||
expect(createTarMock).toHaveBeenCalledWith(
|
expect(createTarMock).toHaveBeenCalledWith(
|
||||||
archiveFolder,
|
archiveFolder,
|
||||||
cachePaths,
|
cachePaths,
|
||||||
compression
|
compression
|
||||||
)
|
)
|
||||||
|
|
||||||
expect(saveCacheMock).toHaveBeenCalledTimes(1)
|
expect(saveCacheMock).toHaveBeenCalledTimes(1)
|
||||||
expect(saveCacheMock).toHaveBeenCalledWith(cacheId, archiveFile, undefined)
|
expect(saveCacheMock).toHaveBeenCalledWith(cacheId, archiveFile, undefined)
|
||||||
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
||||||
@@ -155,7 +257,12 @@ test('save with valid inputs uploads a cache', async () => {
|
|||||||
const reserveCacheMock = jest
|
const reserveCacheMock = jest
|
||||||
.spyOn(cacheHttpClient, 'reserveCache')
|
.spyOn(cacheHttpClient, 'reserveCache')
|
||||||
.mockImplementation(async () => {
|
.mockImplementation(async () => {
|
||||||
return cacheId
|
const response: ITypedResponse<ReserveCacheResponse> = {
|
||||||
|
statusCode: 500,
|
||||||
|
result: {cacheId},
|
||||||
|
headers: {}
|
||||||
|
}
|
||||||
|
return response
|
||||||
})
|
})
|
||||||
const createTarMock = jest.spyOn(tar, 'createTar')
|
const createTarMock = jest.spyOn(tar, 'createTar')
|
||||||
|
|
||||||
@@ -171,17 +278,14 @@ test('save with valid inputs uploads a cache', async () => {
|
|||||||
expect(reserveCacheMock).toHaveBeenCalledWith(primaryKey, [filePath], {
|
expect(reserveCacheMock).toHaveBeenCalledWith(primaryKey, [filePath], {
|
||||||
compressionMethod: compression
|
compressionMethod: compression
|
||||||
})
|
})
|
||||||
|
|
||||||
const archiveFolder = '/foo/bar'
|
const archiveFolder = '/foo/bar'
|
||||||
const archiveFile = path.join(archiveFolder, CacheFilename.Zstd)
|
const archiveFile = path.join(archiveFolder, CacheFilename.Zstd)
|
||||||
|
|
||||||
expect(createTarMock).toHaveBeenCalledTimes(1)
|
expect(createTarMock).toHaveBeenCalledTimes(1)
|
||||||
expect(createTarMock).toHaveBeenCalledWith(
|
expect(createTarMock).toHaveBeenCalledWith(
|
||||||
archiveFolder,
|
archiveFolder,
|
||||||
cachePaths,
|
cachePaths,
|
||||||
compression
|
compression
|
||||||
)
|
)
|
||||||
|
|
||||||
expect(saveCacheMock).toHaveBeenCalledTimes(1)
|
expect(saveCacheMock).toHaveBeenCalledTimes(1)
|
||||||
expect(saveCacheMock).toHaveBeenCalledWith(cacheId, archiveFile, undefined)
|
expect(saveCacheMock).toHaveBeenCalledWith(cacheId, archiveFile, undefined)
|
||||||
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
expect(getCompressionMock).toHaveBeenCalledTimes(1)
|
||||||
|
|||||||
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@actions/cache",
|
"name": "@actions/cache",
|
||||||
"version": "2.0.0",
|
"version": "2.0.2",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
|
|||||||
Vendored
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@actions/cache",
|
"name": "@actions/cache",
|
||||||
"version": "2.0.0",
|
"version": "2.0.2",
|
||||||
"preview": true,
|
"preview": true,
|
||||||
"description": "Actions cache lib",
|
"description": "Actions cache lib",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
|
|||||||
Vendored
+29
-13
@@ -152,17 +152,7 @@ export async function saveCache(
|
|||||||
checkKey(key)
|
checkKey(key)
|
||||||
|
|
||||||
const compressionMethod = await utils.getCompressionMethod()
|
const compressionMethod = await utils.getCompressionMethod()
|
||||||
|
let cacheId = null
|
||||||
core.debug('Reserving Cache')
|
|
||||||
const cacheId = await cacheHttpClient.reserveCache(key, paths, {
|
|
||||||
compressionMethod
|
|
||||||
})
|
|
||||||
if (cacheId === -1) {
|
|
||||||
throw new ReserveCacheError(
|
|
||||||
`Unable to reserve cache with key ${key}, another job may be creating this cache.`
|
|
||||||
)
|
|
||||||
}
|
|
||||||
core.debug(`Cache ID: ${cacheId}`)
|
|
||||||
|
|
||||||
const cachePaths = await utils.resolvePaths(paths)
|
const cachePaths = await utils.resolvePaths(paths)
|
||||||
core.debug('Cache Paths:')
|
core.debug('Cache Paths:')
|
||||||
@@ -181,11 +171,12 @@ export async function saveCache(
|
|||||||
if (core.isDebug()) {
|
if (core.isDebug()) {
|
||||||
await listTar(archivePath, compressionMethod)
|
await listTar(archivePath, compressionMethod)
|
||||||
}
|
}
|
||||||
|
|
||||||
const fileSizeLimit = 10 * 1024 * 1024 * 1024 // 10GB per repo limit
|
const fileSizeLimit = 10 * 1024 * 1024 * 1024 // 10GB per repo limit
|
||||||
const archiveFileSize = utils.getArchiveFileSizeInBytes(archivePath)
|
const archiveFileSize = utils.getArchiveFileSizeInBytes(archivePath)
|
||||||
core.debug(`File Size: ${archiveFileSize}`)
|
core.debug(`File Size: ${archiveFileSize}`)
|
||||||
if (archiveFileSize > fileSizeLimit) {
|
|
||||||
|
// For GHES, this check will take place in ReserveCache API with enterprise file size limit
|
||||||
|
if (archiveFileSize > fileSizeLimit && !utils.isGhes()) {
|
||||||
throw new Error(
|
throw new Error(
|
||||||
`Cache size of ~${Math.round(
|
`Cache size of ~${Math.round(
|
||||||
archiveFileSize / (1024 * 1024)
|
archiveFileSize / (1024 * 1024)
|
||||||
@@ -193,6 +184,31 @@ export async function saveCache(
|
|||||||
)
|
)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
core.debug('Reserving Cache')
|
||||||
|
const reserveCacheResponse = await cacheHttpClient.reserveCache(
|
||||||
|
key,
|
||||||
|
paths,
|
||||||
|
{
|
||||||
|
compressionMethod,
|
||||||
|
cacheSize: archiveFileSize
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
if (reserveCacheResponse?.result?.cacheId) {
|
||||||
|
cacheId = reserveCacheResponse?.result?.cacheId
|
||||||
|
} else if (reserveCacheResponse?.statusCode === 400) {
|
||||||
|
throw new Error(
|
||||||
|
reserveCacheResponse?.error?.message ??
|
||||||
|
`Cache size of ~${Math.round(
|
||||||
|
archiveFileSize / (1024 * 1024)
|
||||||
|
)} MB (${archiveFileSize} B) is over the data cap limit, not saving cache.`
|
||||||
|
)
|
||||||
|
} else {
|
||||||
|
throw new ReserveCacheError(
|
||||||
|
`Unable to reserve cache with key ${key}, another job may be creating this cache. More details: ${reserveCacheResponse?.error?.message}`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
core.debug(`Saving Cache (ID: ${cacheId})`)
|
core.debug(`Saving Cache (ID: ${cacheId})`)
|
||||||
await cacheHttpClient.saveCache(cacheId, archivePath, options)
|
await cacheHttpClient.saveCache(cacheId, archivePath, options)
|
||||||
} finally {
|
} finally {
|
||||||
|
|||||||
+6
-4
@@ -13,7 +13,8 @@ import {
|
|||||||
InternalCacheOptions,
|
InternalCacheOptions,
|
||||||
CommitCacheRequest,
|
CommitCacheRequest,
|
||||||
ReserveCacheRequest,
|
ReserveCacheRequest,
|
||||||
ReserveCacheResponse
|
ReserveCacheResponse,
|
||||||
|
ITypedResponseWithError
|
||||||
} from './contracts'
|
} from './contracts'
|
||||||
import {downloadCacheHttpClient, downloadCacheStorageSDK} from './downloadUtils'
|
import {downloadCacheHttpClient, downloadCacheStorageSDK} from './downloadUtils'
|
||||||
import {
|
import {
|
||||||
@@ -143,13 +144,14 @@ export async function reserveCache(
|
|||||||
key: string,
|
key: string,
|
||||||
paths: string[],
|
paths: string[],
|
||||||
options?: InternalCacheOptions
|
options?: InternalCacheOptions
|
||||||
): Promise<number> {
|
): Promise<ITypedResponseWithError<ReserveCacheResponse>> {
|
||||||
const httpClient = createHttpClient()
|
const httpClient = createHttpClient()
|
||||||
const version = getCacheVersion(paths, options?.compressionMethod)
|
const version = getCacheVersion(paths, options?.compressionMethod)
|
||||||
|
|
||||||
const reserveCacheRequest: ReserveCacheRequest = {
|
const reserveCacheRequest: ReserveCacheRequest = {
|
||||||
key,
|
key,
|
||||||
version
|
version,
|
||||||
|
cacheSize: options?.cacheSize
|
||||||
}
|
}
|
||||||
const response = await retryTypedResponse('reserveCache', async () =>
|
const response = await retryTypedResponse('reserveCache', async () =>
|
||||||
httpClient.postJson<ReserveCacheResponse>(
|
httpClient.postJson<ReserveCacheResponse>(
|
||||||
@@ -157,7 +159,7 @@ export async function reserveCache(
|
|||||||
reserveCacheRequest
|
reserveCacheRequest
|
||||||
)
|
)
|
||||||
)
|
)
|
||||||
return response?.result?.cacheId ?? -1
|
return response
|
||||||
}
|
}
|
||||||
|
|
||||||
function getContentRange(start: number, end: number): string {
|
function getContentRange(start: number, end: number): string {
|
||||||
|
|||||||
+7
@@ -123,3 +123,10 @@ export function assertDefined<T>(name: string, value?: T): T {
|
|||||||
|
|
||||||
return value
|
return value
|
||||||
}
|
}
|
||||||
|
|
||||||
|
export function isGhes(): boolean {
|
||||||
|
const ghUrl = new URL(
|
||||||
|
process.env['GITHUB_SERVER_URL'] || 'https://github.com'
|
||||||
|
)
|
||||||
|
return ghUrl.hostname.toUpperCase() !== 'GITHUB.COM'
|
||||||
|
}
|
||||||
|
|||||||
+8
@@ -1,4 +1,10 @@
|
|||||||
import {CompressionMethod} from './constants'
|
import {CompressionMethod} from './constants'
|
||||||
|
import {ITypedResponse} from '@actions/http-client/interfaces'
|
||||||
|
import {HttpClientError} from '@actions/http-client'
|
||||||
|
|
||||||
|
export interface ITypedResponseWithError<T> extends ITypedResponse<T> {
|
||||||
|
error?: HttpClientError
|
||||||
|
}
|
||||||
|
|
||||||
export interface ArtifactCacheEntry {
|
export interface ArtifactCacheEntry {
|
||||||
cacheKey?: string
|
cacheKey?: string
|
||||||
@@ -14,6 +20,7 @@ export interface CommitCacheRequest {
|
|||||||
export interface ReserveCacheRequest {
|
export interface ReserveCacheRequest {
|
||||||
key: string
|
key: string
|
||||||
version?: string
|
version?: string
|
||||||
|
cacheSize?: number
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface ReserveCacheResponse {
|
export interface ReserveCacheResponse {
|
||||||
@@ -22,4 +29,5 @@ export interface ReserveCacheResponse {
|
|||||||
|
|
||||||
export interface InternalCacheOptions {
|
export interface InternalCacheOptions {
|
||||||
compressionMethod?: CompressionMethod
|
compressionMethod?: CompressionMethod
|
||||||
|
cacheSize?: number
|
||||||
}
|
}
|
||||||
|
|||||||
+7
-8
@@ -1,10 +1,8 @@
|
|||||||
import * as core from '@actions/core'
|
import * as core from '@actions/core'
|
||||||
import {HttpCodes, HttpClientError} from '@actions/http-client'
|
import {HttpCodes, HttpClientError} from '@actions/http-client'
|
||||||
import {
|
import {IHttpClientResponse} from '@actions/http-client/interfaces'
|
||||||
IHttpClientResponse,
|
|
||||||
ITypedResponse
|
|
||||||
} from '@actions/http-client/interfaces'
|
|
||||||
import {DefaultRetryDelay, DefaultRetryAttempts} from './constants'
|
import {DefaultRetryDelay, DefaultRetryAttempts} from './constants'
|
||||||
|
import {ITypedResponseWithError} from './contracts'
|
||||||
|
|
||||||
export function isSuccessStatusCode(statusCode?: number): boolean {
|
export function isSuccessStatusCode(statusCode?: number): boolean {
|
||||||
if (!statusCode) {
|
if (!statusCode) {
|
||||||
@@ -94,14 +92,14 @@ export async function retry<T>(
|
|||||||
|
|
||||||
export async function retryTypedResponse<T>(
|
export async function retryTypedResponse<T>(
|
||||||
name: string,
|
name: string,
|
||||||
method: () => Promise<ITypedResponse<T>>,
|
method: () => Promise<ITypedResponseWithError<T>>,
|
||||||
maxAttempts = DefaultRetryAttempts,
|
maxAttempts = DefaultRetryAttempts,
|
||||||
delay = DefaultRetryDelay
|
delay = DefaultRetryDelay
|
||||||
): Promise<ITypedResponse<T>> {
|
): Promise<ITypedResponseWithError<T>> {
|
||||||
return await retry(
|
return await retry(
|
||||||
name,
|
name,
|
||||||
method,
|
method,
|
||||||
(response: ITypedResponse<T>) => response.statusCode,
|
(response: ITypedResponseWithError<T>) => response.statusCode,
|
||||||
maxAttempts,
|
maxAttempts,
|
||||||
delay,
|
delay,
|
||||||
// If the error object contains the statusCode property, extract it and return
|
// If the error object contains the statusCode property, extract it and return
|
||||||
@@ -111,7 +109,8 @@ export async function retryTypedResponse<T>(
|
|||||||
return {
|
return {
|
||||||
statusCode: error.statusCode,
|
statusCode: error.statusCode,
|
||||||
result: null,
|
result: null,
|
||||||
headers: {}
|
headers: {},
|
||||||
|
error
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
return undefined
|
return undefined
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
# @actions/core Releases
|
# @actions/core Releases
|
||||||
|
|
||||||
|
### 1.7.0
|
||||||
|
- [Added `markdownSummary` extension](https://github.com/actions/toolkit/pull/1014)
|
||||||
|
|
||||||
### 1.6.0
|
### 1.6.0
|
||||||
- [Added OIDC Client function `getIDToken`](https://github.com/actions/toolkit/pull/919)
|
- [Added OIDC Client function `getIDToken`](https://github.com/actions/toolkit/pull/919)
|
||||||
- [Added `file` parameter to `AnnotationProperties`](https://github.com/actions/toolkit/pull/896)
|
- [Added `file` parameter to `AnnotationProperties`](https://github.com/actions/toolkit/pull/896)
|
||||||
|
|||||||
@@ -0,0 +1,275 @@
|
|||||||
|
import * as fs from 'fs'
|
||||||
|
import * as os from 'os'
|
||||||
|
import path from 'path'
|
||||||
|
import {summary, SUMMARY_ENV_VAR} from '../src/summary'
|
||||||
|
|
||||||
|
const testDirectoryPath = path.join(__dirname, 'test')
|
||||||
|
const testFilePath = path.join(testDirectoryPath, 'test-summary.md')
|
||||||
|
|
||||||
|
async function assertSummary(expected: string): Promise<void> {
|
||||||
|
const file = await fs.promises.readFile(testFilePath, {encoding: 'utf8'})
|
||||||
|
expect(file).toEqual(expected)
|
||||||
|
}
|
||||||
|
|
||||||
|
const fixtures = {
|
||||||
|
text: 'hello world 🌎',
|
||||||
|
code: `func fork() {
|
||||||
|
for {
|
||||||
|
go fork()
|
||||||
|
}
|
||||||
|
}`,
|
||||||
|
list: ['foo', 'bar', 'baz', '💣'],
|
||||||
|
table: [
|
||||||
|
[
|
||||||
|
{
|
||||||
|
data: 'foo',
|
||||||
|
header: true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
data: 'bar',
|
||||||
|
header: true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
data: 'baz',
|
||||||
|
header: true
|
||||||
|
},
|
||||||
|
{
|
||||||
|
data: 'tall',
|
||||||
|
rowspan: '3'
|
||||||
|
}
|
||||||
|
],
|
||||||
|
['one', 'two', 'three'],
|
||||||
|
[
|
||||||
|
{
|
||||||
|
data: 'wide',
|
||||||
|
colspan: '3'
|
||||||
|
}
|
||||||
|
]
|
||||||
|
],
|
||||||
|
details: {
|
||||||
|
label: 'open me',
|
||||||
|
content: '🎉 surprise'
|
||||||
|
},
|
||||||
|
img: {
|
||||||
|
src: 'https://github.com/actions.png',
|
||||||
|
alt: 'actions logo',
|
||||||
|
options: {
|
||||||
|
width: '32',
|
||||||
|
height: '32'
|
||||||
|
}
|
||||||
|
},
|
||||||
|
quote: {
|
||||||
|
text: 'Where the world builds software',
|
||||||
|
cite: 'https://github.com/about'
|
||||||
|
},
|
||||||
|
link: {
|
||||||
|
text: 'GitHub',
|
||||||
|
href: 'https://github.com/'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('@actions/core/src/summary', () => {
|
||||||
|
beforeEach(async () => {
|
||||||
|
process.env[SUMMARY_ENV_VAR] = testFilePath
|
||||||
|
await fs.promises.mkdir(testDirectoryPath, {recursive: true})
|
||||||
|
await fs.promises.writeFile(testFilePath, '', {encoding: 'utf8'})
|
||||||
|
summary.emptyBuffer()
|
||||||
|
})
|
||||||
|
|
||||||
|
afterAll(async () => {
|
||||||
|
await fs.promises.unlink(testFilePath)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('throws if summary env var is undefined', async () => {
|
||||||
|
process.env[SUMMARY_ENV_VAR] = undefined
|
||||||
|
const write = summary.addRaw(fixtures.text).write()
|
||||||
|
|
||||||
|
await expect(write).rejects.toThrow()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('throws if summary file does not exist', async () => {
|
||||||
|
await fs.promises.unlink(testFilePath)
|
||||||
|
const write = summary.addRaw(fixtures.text).write()
|
||||||
|
|
||||||
|
await expect(write).rejects.toThrow()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('appends text to summary file', async () => {
|
||||||
|
await fs.promises.writeFile(testFilePath, '# ', {encoding: 'utf8'})
|
||||||
|
await summary.addRaw(fixtures.text).write()
|
||||||
|
await assertSummary(`# ${fixtures.text}`)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('overwrites text to summary file', async () => {
|
||||||
|
await fs.promises.writeFile(testFilePath, 'overwrite', {encoding: 'utf8'})
|
||||||
|
await summary.addRaw(fixtures.text).write({overwrite: true})
|
||||||
|
await assertSummary(fixtures.text)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('appends text with EOL to summary file', async () => {
|
||||||
|
await fs.promises.writeFile(testFilePath, '# ', {encoding: 'utf8'})
|
||||||
|
await summary.addRaw(fixtures.text, true).write()
|
||||||
|
await assertSummary(`# ${fixtures.text}${os.EOL}`)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('chains appends text to summary file', async () => {
|
||||||
|
await fs.promises.writeFile(testFilePath, '', {encoding: 'utf8'})
|
||||||
|
await summary
|
||||||
|
.addRaw(fixtures.text)
|
||||||
|
.addRaw(fixtures.text)
|
||||||
|
.addRaw(fixtures.text)
|
||||||
|
.write()
|
||||||
|
await assertSummary([fixtures.text, fixtures.text, fixtures.text].join(''))
|
||||||
|
})
|
||||||
|
|
||||||
|
it('empties buffer after write', async () => {
|
||||||
|
await fs.promises.writeFile(testFilePath, '', {encoding: 'utf8'})
|
||||||
|
await summary.addRaw(fixtures.text).write()
|
||||||
|
await assertSummary(fixtures.text)
|
||||||
|
expect(summary.isEmptyBuffer()).toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns summary buffer as string', () => {
|
||||||
|
summary.addRaw(fixtures.text)
|
||||||
|
expect(summary.stringify()).toEqual(fixtures.text)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('return correct values for isEmptyBuffer', () => {
|
||||||
|
summary.addRaw(fixtures.text)
|
||||||
|
expect(summary.isEmptyBuffer()).toBe(false)
|
||||||
|
|
||||||
|
summary.emptyBuffer()
|
||||||
|
expect(summary.isEmptyBuffer()).toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('clears a buffer and summary file', async () => {
|
||||||
|
await fs.promises.writeFile(testFilePath, 'content', {encoding: 'utf8'})
|
||||||
|
await summary.clear()
|
||||||
|
await assertSummary('')
|
||||||
|
expect(summary.isEmptyBuffer()).toBe(true)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds EOL', async () => {
|
||||||
|
await summary
|
||||||
|
.addRaw(fixtures.text)
|
||||||
|
.addEOL()
|
||||||
|
.write()
|
||||||
|
await assertSummary(fixtures.text + os.EOL)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a code block without language', async () => {
|
||||||
|
await summary.addCodeBlock(fixtures.code).write()
|
||||||
|
const expected = `<pre><code>func fork() {\n for {\n go fork()\n }\n}</code></pre>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a code block with a language', async () => {
|
||||||
|
await summary.addCodeBlock(fixtures.code, 'go').write()
|
||||||
|
const expected = `<pre lang="go"><code>func fork() {\n for {\n go fork()\n }\n}</code></pre>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds an unordered list', async () => {
|
||||||
|
await summary.addList(fixtures.list).write()
|
||||||
|
const expected = `<ul><li>foo</li><li>bar</li><li>baz</li><li>💣</li></ul>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds an ordered list', async () => {
|
||||||
|
await summary.addList(fixtures.list, true).write()
|
||||||
|
const expected = `<ol><li>foo</li><li>bar</li><li>baz</li><li>💣</li></ol>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a table', async () => {
|
||||||
|
await summary.addTable(fixtures.table).write()
|
||||||
|
const expected = `<table><tr><th>foo</th><th>bar</th><th>baz</th><td rowspan="3">tall</td></tr><tr><td>one</td><td>two</td><td>three</td></tr><tr><td colspan="3">wide</td></tr></table>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a details element', async () => {
|
||||||
|
await summary
|
||||||
|
.addDetails(fixtures.details.label, fixtures.details.content)
|
||||||
|
.write()
|
||||||
|
const expected = `<details><summary>open me</summary>🎉 surprise</details>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds an image with alt text', async () => {
|
||||||
|
await summary.addImage(fixtures.img.src, fixtures.img.alt).write()
|
||||||
|
const expected = `<img src="https://github.com/actions.png" alt="actions logo">${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds an image with custom dimensions', async () => {
|
||||||
|
await summary
|
||||||
|
.addImage(fixtures.img.src, fixtures.img.alt, fixtures.img.options)
|
||||||
|
.write()
|
||||||
|
const expected = `<img src="https://github.com/actions.png" alt="actions logo" width="32" height="32">${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds an image with custom dimensions', async () => {
|
||||||
|
await summary
|
||||||
|
.addImage(fixtures.img.src, fixtures.img.alt, fixtures.img.options)
|
||||||
|
.write()
|
||||||
|
const expected = `<img src="https://github.com/actions.png" alt="actions logo" width="32" height="32">${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds headings h1...h6', async () => {
|
||||||
|
for (const i of [1, 2, 3, 4, 5, 6]) {
|
||||||
|
summary.addHeading('heading', i)
|
||||||
|
}
|
||||||
|
await summary.write()
|
||||||
|
const expected = `<h1>heading</h1>${os.EOL}<h2>heading</h2>${os.EOL}<h3>heading</h3>${os.EOL}<h4>heading</h4>${os.EOL}<h5>heading</h5>${os.EOL}<h6>heading</h6>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds h1 if heading level not specified', async () => {
|
||||||
|
await summary.addHeading('heading').write()
|
||||||
|
const expected = `<h1>heading</h1>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('uses h1 if heading level is garbage or out of range', async () => {
|
||||||
|
await summary
|
||||||
|
.addHeading('heading', 'foobar')
|
||||||
|
.addHeading('heading', 1337)
|
||||||
|
.addHeading('heading', -1)
|
||||||
|
.addHeading('heading', Infinity)
|
||||||
|
.write()
|
||||||
|
const expected = `<h1>heading</h1>${os.EOL}<h1>heading</h1>${os.EOL}<h1>heading</h1>${os.EOL}<h1>heading</h1>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a separator', async () => {
|
||||||
|
await summary.addSeparator().write()
|
||||||
|
const expected = `<hr>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a break', async () => {
|
||||||
|
await summary.addBreak().write()
|
||||||
|
const expected = `<br>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a quote', async () => {
|
||||||
|
await summary.addQuote(fixtures.quote.text).write()
|
||||||
|
const expected = `<blockquote>Where the world builds software</blockquote>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a quote with citation', async () => {
|
||||||
|
await summary.addQuote(fixtures.quote.text, fixtures.quote.cite).write()
|
||||||
|
const expected = `<blockquote cite="https://github.com/about">Where the world builds software</blockquote>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('adds a link with href', async () => {
|
||||||
|
await summary.addLink(fixtures.link.text, fixtures.link.href).write()
|
||||||
|
const expected = `<a href="https://github.com/">GitHub</a>${os.EOL}`
|
||||||
|
await assertSummary(expected)
|
||||||
|
})
|
||||||
|
})
|
||||||
Generated
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@actions/core",
|
"name": "@actions/core",
|
||||||
"version": "1.6.0",
|
"version": "1.7.0",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@actions/core",
|
"name": "@actions/core",
|
||||||
"version": "1.6.0",
|
"version": "1.7.0",
|
||||||
"description": "Actions core lib",
|
"description": "Actions core lib",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"github",
|
"github",
|
||||||
|
|||||||
@@ -359,3 +359,8 @@ export function getState(name: string): string {
|
|||||||
export async function getIDToken(aud?: string): Promise<string> {
|
export async function getIDToken(aud?: string): Promise<string> {
|
||||||
return await OidcClient.getIDToken(aud)
|
return await OidcClient.getIDToken(aud)
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Summary exports
|
||||||
|
*/
|
||||||
|
export {summary} from './summary'
|
||||||
|
|||||||
@@ -0,0 +1,358 @@
|
|||||||
|
import {EOL} from 'os'
|
||||||
|
import {constants, promises} from 'fs'
|
||||||
|
const {access, appendFile, writeFile} = promises
|
||||||
|
|
||||||
|
export const SUMMARY_ENV_VAR = 'GITHUB_STEP_SUMMARY'
|
||||||
|
export const SUMMARY_DOCS_URL =
|
||||||
|
'https://docs.github.com/actions/using-workflows/workflow-commands-for-github-actions#adding-a-job-summary'
|
||||||
|
|
||||||
|
export type SummaryTableRow = (SummaryTableCell | string)[]
|
||||||
|
|
||||||
|
export interface SummaryTableCell {
|
||||||
|
/**
|
||||||
|
* Cell content
|
||||||
|
*/
|
||||||
|
data: string
|
||||||
|
/**
|
||||||
|
* Render cell as header
|
||||||
|
* (optional) default: false
|
||||||
|
*/
|
||||||
|
header?: boolean
|
||||||
|
/**
|
||||||
|
* Number of columns the cell extends
|
||||||
|
* (optional) default: '1'
|
||||||
|
*/
|
||||||
|
colspan?: string
|
||||||
|
/**
|
||||||
|
* Number of rows the cell extends
|
||||||
|
* (optional) default: '1'
|
||||||
|
*/
|
||||||
|
rowspan?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SummaryImageOptions {
|
||||||
|
/**
|
||||||
|
* The width of the image in pixels. Must be an integer without a unit.
|
||||||
|
* (optional)
|
||||||
|
*/
|
||||||
|
width?: string
|
||||||
|
/**
|
||||||
|
* The height of the image in pixels. Must be an integer without a unit.
|
||||||
|
* (optional)
|
||||||
|
*/
|
||||||
|
height?: string
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface SummaryWriteOptions {
|
||||||
|
/**
|
||||||
|
* Replace all existing content in summary file with buffer contents
|
||||||
|
* (optional) default: false
|
||||||
|
*/
|
||||||
|
overwrite?: boolean
|
||||||
|
}
|
||||||
|
|
||||||
|
class Summary {
|
||||||
|
private _buffer: string
|
||||||
|
private _filePath?: string
|
||||||
|
|
||||||
|
constructor() {
|
||||||
|
this._buffer = ''
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Finds the summary file path from the environment, rejects if env var is not found or file does not exist
|
||||||
|
* Also checks r/w permissions.
|
||||||
|
*
|
||||||
|
* @returns step summary file path
|
||||||
|
*/
|
||||||
|
private async filePath(): Promise<string> {
|
||||||
|
if (this._filePath) {
|
||||||
|
return this._filePath
|
||||||
|
}
|
||||||
|
|
||||||
|
const pathFromEnv = process.env[SUMMARY_ENV_VAR]
|
||||||
|
if (!pathFromEnv) {
|
||||||
|
throw new Error(
|
||||||
|
`Unable to find environment variable for $${SUMMARY_ENV_VAR}. Check if your runtime environment supports job summaries.`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
try {
|
||||||
|
await access(pathFromEnv, constants.R_OK | constants.W_OK)
|
||||||
|
} catch {
|
||||||
|
throw new Error(
|
||||||
|
`Unable to access summary file: '${pathFromEnv}'. Check if the file has correct read/write permissions.`
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
this._filePath = pathFromEnv
|
||||||
|
return this._filePath
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Wraps content in an HTML tag, adding any HTML attributes
|
||||||
|
*
|
||||||
|
* @param {string} tag HTML tag to wrap
|
||||||
|
* @param {string | null} content content within the tag
|
||||||
|
* @param {[attribute: string]: string} attrs key-value list of HTML attributes to add
|
||||||
|
*
|
||||||
|
* @returns {string} content wrapped in HTML element
|
||||||
|
*/
|
||||||
|
private wrap(
|
||||||
|
tag: string,
|
||||||
|
content: string | null,
|
||||||
|
attrs: {[attribute: string]: string} = {}
|
||||||
|
): string {
|
||||||
|
const htmlAttrs = Object.entries(attrs)
|
||||||
|
.map(([key, value]) => ` ${key}="${value}"`)
|
||||||
|
.join('')
|
||||||
|
|
||||||
|
if (!content) {
|
||||||
|
return `<${tag}${htmlAttrs}>`
|
||||||
|
}
|
||||||
|
|
||||||
|
return `<${tag}${htmlAttrs}>${content}</${tag}>`
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Writes text in the buffer to the summary buffer file and empties buffer. Will append by default.
|
||||||
|
*
|
||||||
|
* @param {SummaryWriteOptions} [options] (optional) options for write operation
|
||||||
|
*
|
||||||
|
* @returns {Promise<Summary>} summary instance
|
||||||
|
*/
|
||||||
|
async write(options?: SummaryWriteOptions): Promise<Summary> {
|
||||||
|
const overwrite = !!options?.overwrite
|
||||||
|
const filePath = await this.filePath()
|
||||||
|
const writeFunc = overwrite ? writeFile : appendFile
|
||||||
|
await writeFunc(filePath, this._buffer, {encoding: 'utf8'})
|
||||||
|
return this.emptyBuffer()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Clears the summary buffer and wipes the summary file
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
async clear(): Promise<Summary> {
|
||||||
|
return this.emptyBuffer().write({overwrite: true})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the current summary buffer as a string
|
||||||
|
*
|
||||||
|
* @returns {string} string of summary buffer
|
||||||
|
*/
|
||||||
|
stringify(): string {
|
||||||
|
return this._buffer
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* If the summary buffer is empty
|
||||||
|
*
|
||||||
|
* @returns {boolen} true if the buffer is empty
|
||||||
|
*/
|
||||||
|
isEmptyBuffer(): boolean {
|
||||||
|
return this._buffer.length === 0
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Resets the summary buffer without writing to summary file
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
emptyBuffer(): Summary {
|
||||||
|
this._buffer = ''
|
||||||
|
return this
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds raw text to the summary buffer
|
||||||
|
*
|
||||||
|
* @param {string} text content to add
|
||||||
|
* @param {boolean} [addEOL=false] (optional) append an EOL to the raw text (default: false)
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addRaw(text: string, addEOL = false): Summary {
|
||||||
|
this._buffer += text
|
||||||
|
return addEOL ? this.addEOL() : this
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds the operating system-specific end-of-line marker to the buffer
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addEOL(): Summary {
|
||||||
|
return this.addRaw(EOL)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML codeblock to the summary buffer
|
||||||
|
*
|
||||||
|
* @param {string} code content to render within fenced code block
|
||||||
|
* @param {string} lang (optional) language to syntax highlight code
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addCodeBlock(code: string, lang?: string): Summary {
|
||||||
|
const attrs = {
|
||||||
|
...(lang && {lang})
|
||||||
|
}
|
||||||
|
const element = this.wrap('pre', this.wrap('code', code), attrs)
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML list to the summary buffer
|
||||||
|
*
|
||||||
|
* @param {string[]} items list of items to render
|
||||||
|
* @param {boolean} [ordered=false] (optional) if the rendered list should be ordered or not (default: false)
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addList(items: string[], ordered = false): Summary {
|
||||||
|
const tag = ordered ? 'ol' : 'ul'
|
||||||
|
const listItems = items.map(item => this.wrap('li', item)).join('')
|
||||||
|
const element = this.wrap(tag, listItems)
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML table to the summary buffer
|
||||||
|
*
|
||||||
|
* @param {SummaryTableCell[]} rows table rows
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addTable(rows: SummaryTableRow[]): Summary {
|
||||||
|
const tableBody = rows
|
||||||
|
.map(row => {
|
||||||
|
const cells = row
|
||||||
|
.map(cell => {
|
||||||
|
if (typeof cell === 'string') {
|
||||||
|
return this.wrap('td', cell)
|
||||||
|
}
|
||||||
|
|
||||||
|
const {header, data, colspan, rowspan} = cell
|
||||||
|
const tag = header ? 'th' : 'td'
|
||||||
|
const attrs = {
|
||||||
|
...(colspan && {colspan}),
|
||||||
|
...(rowspan && {rowspan})
|
||||||
|
}
|
||||||
|
|
||||||
|
return this.wrap(tag, data, attrs)
|
||||||
|
})
|
||||||
|
.join('')
|
||||||
|
|
||||||
|
return this.wrap('tr', cells)
|
||||||
|
})
|
||||||
|
.join('')
|
||||||
|
|
||||||
|
const element = this.wrap('table', tableBody)
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds a collapsable HTML details element to the summary buffer
|
||||||
|
*
|
||||||
|
* @param {string} label text for the closed state
|
||||||
|
* @param {string} content collapsable content
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addDetails(label: string, content: string): Summary {
|
||||||
|
const element = this.wrap('details', this.wrap('summary', label) + content)
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML image tag to the summary buffer
|
||||||
|
*
|
||||||
|
* @param {string} src path to the image you to embed
|
||||||
|
* @param {string} alt text description of the image
|
||||||
|
* @param {SummaryImageOptions} options (optional) addition image attributes
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addImage(src: string, alt: string, options?: SummaryImageOptions): Summary {
|
||||||
|
const {width, height} = options || {}
|
||||||
|
const attrs = {
|
||||||
|
...(width && {width}),
|
||||||
|
...(height && {height})
|
||||||
|
}
|
||||||
|
|
||||||
|
const element = this.wrap('img', null, {src, alt, ...attrs})
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML section heading element
|
||||||
|
*
|
||||||
|
* @param {string} text heading text
|
||||||
|
* @param {number | string} [level=1] (optional) the heading level, default: 1
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addHeading(text: string, level?: number | string): Summary {
|
||||||
|
const tag = `h${level}`
|
||||||
|
const allowedTag = ['h1', 'h2', 'h3', 'h4', 'h5', 'h6'].includes(tag)
|
||||||
|
? tag
|
||||||
|
: 'h1'
|
||||||
|
const element = this.wrap(allowedTag, text)
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML thematic break (<hr>) to the summary buffer
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addSeparator(): Summary {
|
||||||
|
const element = this.wrap('hr', null)
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML line break (<br>) to the summary buffer
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addBreak(): Summary {
|
||||||
|
const element = this.wrap('br', null)
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML blockquote to the summary buffer
|
||||||
|
*
|
||||||
|
* @param {string} text quote text
|
||||||
|
* @param {string} cite (optional) citation url
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addQuote(text: string, cite?: string): Summary {
|
||||||
|
const attrs = {
|
||||||
|
...(cite && {cite})
|
||||||
|
}
|
||||||
|
const element = this.wrap('blockquote', text, attrs)
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Adds an HTML anchor tag to the summary buffer
|
||||||
|
*
|
||||||
|
* @param {string} text link text/content
|
||||||
|
* @param {string} href hyperlink
|
||||||
|
*
|
||||||
|
* @returns {Summary} summary instance
|
||||||
|
*/
|
||||||
|
addLink(text: string, href: string): Summary {
|
||||||
|
const element = this.wrap('a', text, {href})
|
||||||
|
return this.addRaw(element).addEOL()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// singleton export
|
||||||
|
export const summary = new Summary()
|
||||||
@@ -1,5 +1,7 @@
|
|||||||
# @actions/github Releases
|
# @actions/github Releases
|
||||||
|
|
||||||
|
### 5.0.1
|
||||||
|
- [Update Octokit Dependencies](https://github.com/actions/toolkit/pull/1037)
|
||||||
### 5.0.0
|
### 5.0.0
|
||||||
- [Update @actions/github to include latest octokit definitions](https://github.com/actions/toolkit/pull/783)
|
- [Update @actions/github to include latest octokit definitions](https://github.com/actions/toolkit/pull/783)
|
||||||
- [Add urls to context](https://github.com/actions/toolkit/pull/794)
|
- [Add urls to context](https://github.com/actions/toolkit/pull/794)
|
||||||
|
|||||||
Generated
+2
-2
@@ -1,12 +1,12 @@
|
|||||||
{
|
{
|
||||||
"name": "@actions/github",
|
"name": "@actions/github",
|
||||||
"version": "5.0.0",
|
"version": "5.0.1",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
"": {
|
"": {
|
||||||
"name": "@actions/github",
|
"name": "@actions/github",
|
||||||
"version": "5.0.0",
|
"version": "5.0.1",
|
||||||
"license": "MIT",
|
"license": "MIT",
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@actions/http-client": "^1.0.11",
|
"@actions/http-client": "^1.0.11",
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@actions/github",
|
"name": "@actions/github",
|
||||||
"version": "5.0.0",
|
"version": "5.0.1",
|
||||||
"description": "Actions github lib",
|
"description": "Actions github lib",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"github",
|
"github",
|
||||||
|
|||||||
@@ -1,5 +1,8 @@
|
|||||||
# @actions/glob Releases
|
# @actions/glob Releases
|
||||||
|
|
||||||
|
### 0.3.0
|
||||||
|
- Added a `verbose` option to HashFiles [#1052](https://github.com/actions/toolkit/pull/1052/files)
|
||||||
|
|
||||||
### 0.2.1
|
### 0.2.1
|
||||||
- Update `lockfileVersion` to `v2` in `package-lock.json [#1023](https://github.com/actions/toolkit/pull/1023)
|
- Update `lockfileVersion` to `v2` in `package-lock.json [#1023](https://github.com/actions/toolkit/pull/1023)
|
||||||
|
|
||||||
|
|||||||
Generated
+1
-1
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@actions/glob",
|
"name": "@actions/glob",
|
||||||
"version": "0.2.1",
|
"version": "0.3.0",
|
||||||
"lockfileVersion": 2,
|
"lockfileVersion": 2,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"packages": {
|
"packages": {
|
||||||
|
|||||||
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "@actions/glob",
|
"name": "@actions/glob",
|
||||||
"version": "0.2.1",
|
"version": "0.3.0",
|
||||||
"preview": true,
|
"preview": true,
|
||||||
"description": "Actions glob lib",
|
"description": "Actions glob lib",
|
||||||
"keywords": [
|
"keywords": [
|
||||||
|
|||||||
@@ -26,12 +26,13 @@ export async function create(
|
|||||||
*/
|
*/
|
||||||
export async function hashFiles(
|
export async function hashFiles(
|
||||||
patterns: string,
|
patterns: string,
|
||||||
options?: HashFileOptions
|
options?: HashFileOptions,
|
||||||
|
verbose: Boolean = false
|
||||||
): Promise<string> {
|
): Promise<string> {
|
||||||
let followSymbolicLinks = true
|
let followSymbolicLinks = true
|
||||||
if (options && typeof options.followSymbolicLinks === 'boolean') {
|
if (options && typeof options.followSymbolicLinks === 'boolean') {
|
||||||
followSymbolicLinks = options.followSymbolicLinks
|
followSymbolicLinks = options.followSymbolicLinks
|
||||||
}
|
}
|
||||||
const globber = await create(patterns, {followSymbolicLinks})
|
const globber = await create(patterns, {followSymbolicLinks})
|
||||||
return _hashFiles(globber)
|
return _hashFiles(globber, verbose)
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -6,19 +6,23 @@ import * as util from 'util'
|
|||||||
import * as path from 'path'
|
import * as path from 'path'
|
||||||
import {Globber} from './glob'
|
import {Globber} from './glob'
|
||||||
|
|
||||||
export async function hashFiles(globber: Globber): Promise<string> {
|
export async function hashFiles(
|
||||||
|
globber: Globber,
|
||||||
|
verbose: Boolean = false
|
||||||
|
): Promise<string> {
|
||||||
|
const writeDelegate = verbose ? core.info : core.debug
|
||||||
let hasMatch = false
|
let hasMatch = false
|
||||||
const githubWorkspace = process.env['GITHUB_WORKSPACE'] ?? process.cwd()
|
const githubWorkspace = process.env['GITHUB_WORKSPACE'] ?? process.cwd()
|
||||||
const result = crypto.createHash('sha256')
|
const result = crypto.createHash('sha256')
|
||||||
let count = 0
|
let count = 0
|
||||||
for await (const file of globber.globGenerator()) {
|
for await (const file of globber.globGenerator()) {
|
||||||
core.debug(file)
|
writeDelegate(file)
|
||||||
if (!file.startsWith(`${githubWorkspace}${path.sep}`)) {
|
if (!file.startsWith(`${githubWorkspace}${path.sep}`)) {
|
||||||
core.debug(`Ignore '${file}' since it is not under GITHUB_WORKSPACE.`)
|
writeDelegate(`Ignore '${file}' since it is not under GITHUB_WORKSPACE.`)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
if (fs.statSync(file).isDirectory()) {
|
if (fs.statSync(file).isDirectory()) {
|
||||||
core.debug(`Skip directory '${file}'.`)
|
writeDelegate(`Skip directory '${file}'.`)
|
||||||
continue
|
continue
|
||||||
}
|
}
|
||||||
const hash = crypto.createHash('sha256')
|
const hash = crypto.createHash('sha256')
|
||||||
@@ -33,10 +37,10 @@ export async function hashFiles(globber: Globber): Promise<string> {
|
|||||||
result.end()
|
result.end()
|
||||||
|
|
||||||
if (hasMatch) {
|
if (hasMatch) {
|
||||||
core.debug(`Found ${count} files to hash.`)
|
writeDelegate(`Found ${count} files to hash.`)
|
||||||
return result.digest('hex')
|
return result.digest('hex')
|
||||||
} else {
|
} else {
|
||||||
core.debug(`No matches found for glob`)
|
writeDelegate(`No matches found for glob`)
|
||||||
return ''
|
return ''
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
@@ -0,0 +1,2 @@
|
|||||||
|
testoutput.txt
|
||||||
|
npm-debug.log
|
||||||
@@ -0,0 +1,21 @@
|
|||||||
|
Actions Http Client for Node.js
|
||||||
|
|
||||||
|
Copyright (c) GitHub, Inc.
|
||||||
|
|
||||||
|
All rights reserved.
|
||||||
|
|
||||||
|
MIT License
|
||||||
|
|
||||||
|
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and
|
||||||
|
associated documentation files (the "Software"), to deal in the Software without restriction,
|
||||||
|
including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense,
|
||||||
|
and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so,
|
||||||
|
subject to the following conditions:
|
||||||
|
|
||||||
|
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
|
||||||
|
|
||||||
|
THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
|
||||||
|
LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN
|
||||||
|
NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
|
||||||
|
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
|
||||||
|
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
# `@actions/http-client`
|
||||||
|
|
||||||
|
A lightweight HTTP client optimized for building actions.
|
||||||
|
|
||||||
|
## Features
|
||||||
|
|
||||||
|
- HTTP client with TypeScript generics and async/await/Promises
|
||||||
|
- Typings included!
|
||||||
|
- [Proxy support](https://help.github.com/en/actions/automating-your-workflow-with-github-actions/about-self-hosted-runners#using-a-proxy-server-with-self-hosted-runners) just works with actions and the runner
|
||||||
|
- Targets ES2019 (runner runs actions with node 12+). Only supported on node 12+.
|
||||||
|
- Basic, Bearer and PAT Support out of the box. Extensible handlers for others.
|
||||||
|
- Redirects supported
|
||||||
|
|
||||||
|
Features and releases [here](./RELEASES.md)
|
||||||
|
|
||||||
|
## Install
|
||||||
|
|
||||||
|
```
|
||||||
|
npm install @actions/http-client --save
|
||||||
|
```
|
||||||
|
|
||||||
|
## Samples
|
||||||
|
|
||||||
|
See the [tests](./__tests__) for detailed examples.
|
||||||
|
|
||||||
|
## Errors
|
||||||
|
|
||||||
|
### HTTP
|
||||||
|
|
||||||
|
The HTTP client does not throw unless truly exceptional.
|
||||||
|
|
||||||
|
* A request that successfully executes resulting in a 404, 500 etc... will return a response object with a status code and a body.
|
||||||
|
* Redirects (3xx) will be followed by default.
|
||||||
|
|
||||||
|
See the [tests](./__tests__) for detailed examples.
|
||||||
|
|
||||||
|
## Debugging
|
||||||
|
|
||||||
|
To enable detailed console logging of all HTTP requests and responses, set the NODE_DEBUG environment varible:
|
||||||
|
|
||||||
|
```shell
|
||||||
|
export NODE_DEBUG=http
|
||||||
|
```
|
||||||
|
|
||||||
|
## Node support
|
||||||
|
|
||||||
|
The http-client is built using the latest LTS version of Node 12. It may work on previous node LTS versions but it's tested and officially supported on Node12+.
|
||||||
|
|
||||||
|
## Support and Versioning
|
||||||
|
|
||||||
|
We follow semver and will hold compatibility between major versions and increment the minor version with new features and capabilities (while holding compat).
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
We welcome PRs. Please create an issue and if applicable, a design before proceeding with code.
|
||||||
|
|
||||||
|
once:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm install
|
||||||
|
```
|
||||||
|
|
||||||
|
To build:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm run build
|
||||||
|
```
|
||||||
|
|
||||||
|
To run all tests:
|
||||||
|
|
||||||
|
```
|
||||||
|
npm test
|
||||||
|
```
|
||||||
@@ -0,0 +1,36 @@
|
|||||||
|
## Releases
|
||||||
|
|
||||||
|
## 2.0.0
|
||||||
|
- The package is now compiled with TypeScript's [`strict` compiler setting](https://www.typescriptlang.org/tsconfig#strict). To comply with stricter rules:
|
||||||
|
- Some exported types now include `| null` or `| undefined`, matching their actual behavior.
|
||||||
|
- Types implementing the method `RequestHandler.handleAuthentication()` now throw an `Error` rather than returning `null` if they do not support handling an HTTP 401 response. Callers can still use `canHandleAuthentication()` to determine if this handling is supported or not.
|
||||||
|
- Types using `any` have been scoped to more specific types.
|
||||||
|
- Following TypeScript's naming conventions, exported interfaces no longer begin with the prefix `I-`.
|
||||||
|
- Delete the `IHttpClientResponse` interface in favor of the `HttpClientResponse` class.
|
||||||
|
- Delete the `IHeaders` interface in favor of `http.OutgoingHttpHeaders`.
|
||||||
|
- The source code of the package was moved to build with [actions/toolkit](https://github.com/actions/toolkit).
|
||||||
|
|
||||||
|
## 1.0.11
|
||||||
|
|
||||||
|
Contains a bug fix where proxy is defined without a user and password. see [PR here](https://github.com/actions/http-client/pull/42)
|
||||||
|
|
||||||
|
## 1.0.9
|
||||||
|
Throw HttpClientError instead of a generic Error from the \<verb>Json() helper methods when the server responds with a non-successful status code.
|
||||||
|
|
||||||
|
## 1.0.8
|
||||||
|
Fixed security issue where a redirect (e.g. 302) to another domain would pass headers. The fix was to strip the authorization header if the hostname was different. More [details in PR #27](https://github.com/actions/http-client/pull/27)
|
||||||
|
|
||||||
|
## 1.0.7
|
||||||
|
Update NPM dependencies and add 429 to the list of HttpCodes
|
||||||
|
|
||||||
|
## 1.0.6
|
||||||
|
Automatically sends Content-Type and Accept application/json headers for \<verb>Json() helper methods if not set in the client or parameters.
|
||||||
|
|
||||||
|
## 1.0.5
|
||||||
|
Adds \<verb>Json() helper methods for json over http scenarios.
|
||||||
|
|
||||||
|
## 1.0.4
|
||||||
|
Started to add \<verb>Json() helper methods. Do not use this release for that. Use >= 1.0.5 since there was an issue with types.
|
||||||
|
|
||||||
|
## 1.0.1 to 1.0.3
|
||||||
|
Adds proxy support.
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
import * as httpm from '../lib'
|
||||||
|
import * as am from '../lib/auth'
|
||||||
|
|
||||||
|
describe('auth', () => {
|
||||||
|
beforeEach(() => {})
|
||||||
|
|
||||||
|
afterEach(() => {})
|
||||||
|
|
||||||
|
it('does basic http get request with basic auth', async () => {
|
||||||
|
const bh: am.BasicCredentialHandler = new am.BasicCredentialHandler(
|
||||||
|
'johndoe',
|
||||||
|
'password'
|
||||||
|
)
|
||||||
|
const http: httpm.HttpClient = new httpm.HttpClient('http-client-tests', [
|
||||||
|
bh
|
||||||
|
])
|
||||||
|
const res: httpm.HttpClientResponse = await http.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
const auth: string = obj.headers.Authorization
|
||||||
|
const creds: string = Buffer.from(
|
||||||
|
auth.substring('Basic '.length),
|
||||||
|
'base64'
|
||||||
|
).toString()
|
||||||
|
expect(creds).toBe('johndoe:password')
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http get request with pat token auth', async () => {
|
||||||
|
const token = 'scbfb44vxzku5l4xgc3qfazn3lpk4awflfryc76esaiq7aypcbhs'
|
||||||
|
const ph: am.PersonalAccessTokenCredentialHandler = new am.PersonalAccessTokenCredentialHandler(
|
||||||
|
token
|
||||||
|
)
|
||||||
|
|
||||||
|
const http: httpm.HttpClient = new httpm.HttpClient('http-client-tests', [
|
||||||
|
ph
|
||||||
|
])
|
||||||
|
const res: httpm.HttpClientResponse = await http.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
const auth: string = obj.headers.Authorization
|
||||||
|
const creds: string = Buffer.from(
|
||||||
|
auth.substring('Basic '.length),
|
||||||
|
'base64'
|
||||||
|
).toString()
|
||||||
|
expect(creds).toBe(`PAT:${token}`)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http get request with pat token auth', async () => {
|
||||||
|
const token = 'scbfb44vxzku5l4xgc3qfazn3lpk4awflfryc76esaiq7aypcbhs'
|
||||||
|
const ph: am.BearerCredentialHandler = new am.BearerCredentialHandler(token)
|
||||||
|
|
||||||
|
const http: httpm.HttpClient = new httpm.HttpClient('http-client-tests', [
|
||||||
|
ph
|
||||||
|
])
|
||||||
|
const res: httpm.HttpClientResponse = await http.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
const auth: string = obj.headers.Authorization
|
||||||
|
expect(auth).toBe(`Bearer ${token}`)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,374 @@
|
|||||||
|
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||||
|
|
||||||
|
import * as httpm from '..'
|
||||||
|
import * as path from 'path'
|
||||||
|
import * as fs from 'fs'
|
||||||
|
|
||||||
|
const sampleFilePath: string = path.join(__dirname, 'testoutput.txt')
|
||||||
|
|
||||||
|
interface HttpBinData {
|
||||||
|
url: string
|
||||||
|
data: any
|
||||||
|
json: any
|
||||||
|
headers: any
|
||||||
|
args?: any
|
||||||
|
}
|
||||||
|
|
||||||
|
describe('basics', () => {
|
||||||
|
let _http: httpm.HttpClient
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
_http = new httpm.HttpClient('http-client-tests')
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {})
|
||||||
|
|
||||||
|
it('constructs', () => {
|
||||||
|
const http: httpm.HttpClient = new httpm.HttpClient('thttp-client-tests')
|
||||||
|
expect(http).toBeDefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
// responses from httpbin return something like:
|
||||||
|
// {
|
||||||
|
// "args": {},
|
||||||
|
// "headers": {
|
||||||
|
// "Connection": "close",
|
||||||
|
// "Host": "httpbin.org",
|
||||||
|
// "User-Agent": "typed-test-client-tests"
|
||||||
|
// },
|
||||||
|
// "origin": "173.95.152.44",
|
||||||
|
// "url": "https://httpbin.org/get"
|
||||||
|
// }
|
||||||
|
|
||||||
|
it('does basic http get request', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
expect(obj.headers['User-Agent']).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http get request with no user agent', async () => {
|
||||||
|
const http: httpm.HttpClient = new httpm.HttpClient()
|
||||||
|
const res: httpm.HttpClientResponse = await http.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
expect(obj.headers['User-Agent']).toBeFalsy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic https get request', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
'https://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('https://httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http get request with default headers', async () => {
|
||||||
|
const http: httpm.HttpClient = new httpm.HttpClient(
|
||||||
|
'http-client-tests',
|
||||||
|
[],
|
||||||
|
{
|
||||||
|
headers: {
|
||||||
|
Accept: 'application/json',
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
const res: httpm.HttpClientResponse = await http.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.headers.Accept).toBe('application/json')
|
||||||
|
expect(obj.headers['Content-Type']).toBe('application/json')
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http get request with merged headers', async () => {
|
||||||
|
const http: httpm.HttpClient = new httpm.HttpClient(
|
||||||
|
'http-client-tests',
|
||||||
|
[],
|
||||||
|
{
|
||||||
|
headers: {
|
||||||
|
Accept: 'application/json',
|
||||||
|
'Content-Type': 'application/json'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
)
|
||||||
|
const res: httpm.HttpClientResponse = await http.get(
|
||||||
|
'http://httpbin.org/get',
|
||||||
|
{
|
||||||
|
'content-type': 'application/x-www-form-urlencoded'
|
||||||
|
}
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.headers.Accept).toBe('application/json')
|
||||||
|
expect(obj.headers['Content-Type']).toBe(
|
||||||
|
'application/x-www-form-urlencoded'
|
||||||
|
)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('pipes a get request', async () => {
|
||||||
|
return new Promise<void>(async resolve => {
|
||||||
|
const file = fs.createWriteStream(sampleFilePath)
|
||||||
|
;(await _http.get('https://httpbin.org/get')).message
|
||||||
|
.pipe(file)
|
||||||
|
.on('close', () => {
|
||||||
|
const body: string = fs.readFileSync(sampleFilePath).toString()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('https://httpbin.org/get')
|
||||||
|
resolve()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic get request with redirects', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
`https://httpbin.org/redirect-to?url=${encodeURIComponent(
|
||||||
|
'https://httpbin.org/get'
|
||||||
|
)}`
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('https://httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic get request with redirects (303)', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
`https://httpbin.org/redirect-to?url=${encodeURIComponent(
|
||||||
|
'https://httpbin.org/get'
|
||||||
|
)}&status_code=303`
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('https://httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns 404 for not found get request on redirect', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
`https://httpbin.org/redirect-to?url=${encodeURIComponent(
|
||||||
|
'https://httpbin.org/status/404'
|
||||||
|
)}&status_code=303`
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(404)
|
||||||
|
await res.readBody()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not follow redirects if disabled', async () => {
|
||||||
|
const http: httpm.HttpClient = new httpm.HttpClient(
|
||||||
|
'typed-test-client-tests',
|
||||||
|
undefined,
|
||||||
|
{allowRedirects: false}
|
||||||
|
)
|
||||||
|
const res: httpm.HttpClientResponse = await http.get(
|
||||||
|
`https://httpbin.org/redirect-to?url=${encodeURIComponent(
|
||||||
|
'https://httpbin.org/get'
|
||||||
|
)}`
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(302)
|
||||||
|
await res.readBody()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not pass auth with diff hostname redirects', async () => {
|
||||||
|
const headers = {
|
||||||
|
accept: 'application/json',
|
||||||
|
authorization: 'shhh'
|
||||||
|
}
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
`https://httpbin.org/redirect-to?url=${encodeURIComponent(
|
||||||
|
'https://www.httpbin.org/get'
|
||||||
|
)}`,
|
||||||
|
headers
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
// httpbin "fixes" the casing
|
||||||
|
expect(obj.headers['Accept']).toBe('application/json')
|
||||||
|
expect(obj.headers['Authorization']).toBeUndefined()
|
||||||
|
expect(obj.headers['authorization']).toBeUndefined()
|
||||||
|
expect(obj.url).toBe('https://www.httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does not pass Auth with diff hostname redirects', async () => {
|
||||||
|
const headers = {
|
||||||
|
Accept: 'application/json',
|
||||||
|
Authorization: 'shhh'
|
||||||
|
}
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
`https://httpbin.org/redirect-to?url=${encodeURIComponent(
|
||||||
|
'https://www.httpbin.org/get'
|
||||||
|
)}`,
|
||||||
|
headers
|
||||||
|
)
|
||||||
|
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
// httpbin "fixes" the casing
|
||||||
|
expect(obj.headers['Accept']).toBe('application/json')
|
||||||
|
expect(obj.headers['Authorization']).toBeUndefined()
|
||||||
|
expect(obj.headers['authorization']).toBeUndefined()
|
||||||
|
expect(obj.url).toBe('https://www.httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic head request', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.head(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http delete request', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.del(
|
||||||
|
'http://httpbin.org/delete'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
JSON.parse(body)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http post request', async () => {
|
||||||
|
const b = 'Hello World!'
|
||||||
|
const res: httpm.HttpClientResponse = await _http.post(
|
||||||
|
'http://httpbin.org/post',
|
||||||
|
b
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.data).toBe(b)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/post')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http patch request', async () => {
|
||||||
|
const b = 'Hello World!'
|
||||||
|
const res: httpm.HttpClientResponse = await _http.patch(
|
||||||
|
'http://httpbin.org/patch',
|
||||||
|
b
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.data).toBe(b)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/patch')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http options request', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.options(
|
||||||
|
'http://httpbin.org'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
await res.readBody()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('returns 404 for not found get request', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
'http://httpbin.org/status/404'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(404)
|
||||||
|
await res.readBody()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('gets a json object', async () => {
|
||||||
|
const jsonObj = await _http.getJson<HttpBinData>('https://httpbin.org/get')
|
||||||
|
expect(jsonObj.statusCode).toBe(200)
|
||||||
|
expect(jsonObj.result).toBeDefined()
|
||||||
|
expect(jsonObj.result?.url).toBe('https://httpbin.org/get')
|
||||||
|
expect(jsonObj.result?.headers['Accept']).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getting a non existent json object returns null', async () => {
|
||||||
|
const jsonObj = await _http.getJson<HttpBinData>(
|
||||||
|
'https://httpbin.org/status/404'
|
||||||
|
)
|
||||||
|
expect(jsonObj.statusCode).toBe(404)
|
||||||
|
expect(jsonObj.result).toBeNull()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('posts a json object', async () => {
|
||||||
|
const res = {name: 'foo'}
|
||||||
|
const restRes = await _http.postJson<HttpBinData>(
|
||||||
|
'https://httpbin.org/post',
|
||||||
|
res
|
||||||
|
)
|
||||||
|
expect(restRes.statusCode).toBe(200)
|
||||||
|
expect(restRes.result).toBeDefined()
|
||||||
|
expect(restRes.result?.url).toBe('https://httpbin.org/post')
|
||||||
|
expect(restRes.result?.json.name).toBe('foo')
|
||||||
|
expect(restRes.result?.headers['Accept']).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
expect(restRes.result?.headers['Content-Type']).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
expect(restRes.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('puts a json object', async () => {
|
||||||
|
const res = {name: 'foo'}
|
||||||
|
const restRes = await _http.putJson<HttpBinData>(
|
||||||
|
'https://httpbin.org/put',
|
||||||
|
res
|
||||||
|
)
|
||||||
|
expect(restRes.statusCode).toBe(200)
|
||||||
|
expect(restRes.result).toBeDefined()
|
||||||
|
expect(restRes.result?.url).toBe('https://httpbin.org/put')
|
||||||
|
expect(restRes.result?.json.name).toBe('foo')
|
||||||
|
|
||||||
|
expect(restRes.result?.headers['Accept']).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
expect(restRes.result?.headers['Content-Type']).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
expect(restRes.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('patch a json object', async () => {
|
||||||
|
const res = {name: 'foo'}
|
||||||
|
const restRes = await _http.patchJson<HttpBinData>(
|
||||||
|
'https://httpbin.org/patch',
|
||||||
|
res
|
||||||
|
)
|
||||||
|
expect(restRes.statusCode).toBe(200)
|
||||||
|
expect(restRes.result).toBeDefined()
|
||||||
|
expect(restRes.result?.url).toBe('https://httpbin.org/patch')
|
||||||
|
expect(restRes.result?.json.name).toBe('foo')
|
||||||
|
expect(restRes.result?.headers['Accept']).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
expect(restRes.result?.headers['Content-Type']).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
expect(restRes.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,116 @@
|
|||||||
|
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||||
|
|
||||||
|
import * as httpm from '..'
|
||||||
|
|
||||||
|
describe('headers', () => {
|
||||||
|
let _http: httpm.HttpClient
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
_http = new httpm.HttpClient('http-client-tests')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('preserves existing headers on getJson', async () => {
|
||||||
|
const additionalHeaders = {[httpm.Headers.Accept]: 'foo'}
|
||||||
|
let jsonObj = await _http.getJson<any>(
|
||||||
|
'https://httpbin.org/get',
|
||||||
|
additionalHeaders
|
||||||
|
)
|
||||||
|
expect(jsonObj.result.headers['Accept']).toBe('foo')
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
|
||||||
|
const httpWithHeaders = new httpm.HttpClient()
|
||||||
|
httpWithHeaders.requestOptions = {
|
||||||
|
headers: {
|
||||||
|
[httpm.Headers.Accept]: 'baz'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
jsonObj = await httpWithHeaders.getJson<any>('https://httpbin.org/get')
|
||||||
|
expect(jsonObj.result.headers['Accept']).toBe('baz')
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('preserves existing headers on postJson', async () => {
|
||||||
|
const additionalHeaders = {[httpm.Headers.Accept]: 'foo'}
|
||||||
|
let jsonObj = await _http.postJson<any>(
|
||||||
|
'https://httpbin.org/post',
|
||||||
|
{},
|
||||||
|
additionalHeaders
|
||||||
|
)
|
||||||
|
expect(jsonObj.result.headers['Accept']).toBe('foo')
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
|
||||||
|
const httpWithHeaders = new httpm.HttpClient()
|
||||||
|
httpWithHeaders.requestOptions = {
|
||||||
|
headers: {
|
||||||
|
[httpm.Headers.Accept]: 'baz'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
jsonObj = await httpWithHeaders.postJson<any>(
|
||||||
|
'https://httpbin.org/post',
|
||||||
|
{}
|
||||||
|
)
|
||||||
|
expect(jsonObj.result.headers['Accept']).toBe('baz')
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('preserves existing headers on putJson', async () => {
|
||||||
|
const additionalHeaders = {[httpm.Headers.Accept]: 'foo'}
|
||||||
|
let jsonObj = await _http.putJson<any>(
|
||||||
|
'https://httpbin.org/put',
|
||||||
|
{},
|
||||||
|
additionalHeaders
|
||||||
|
)
|
||||||
|
expect(jsonObj.result.headers['Accept']).toBe('foo')
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
|
||||||
|
const httpWithHeaders = new httpm.HttpClient()
|
||||||
|
httpWithHeaders.requestOptions = {
|
||||||
|
headers: {
|
||||||
|
[httpm.Headers.Accept]: 'baz'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
jsonObj = await httpWithHeaders.putJson<any>('https://httpbin.org/put', {})
|
||||||
|
expect(jsonObj.result.headers['Accept']).toBe('baz')
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('preserves existing headers on patchJson', async () => {
|
||||||
|
const additionalHeaders = {[httpm.Headers.Accept]: 'foo'}
|
||||||
|
let jsonObj = await _http.patchJson<any>(
|
||||||
|
'https://httpbin.org/patch',
|
||||||
|
{},
|
||||||
|
additionalHeaders
|
||||||
|
)
|
||||||
|
expect(jsonObj.result.headers['Accept']).toBe('foo')
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
|
||||||
|
const httpWithHeaders = new httpm.HttpClient()
|
||||||
|
httpWithHeaders.requestOptions = {
|
||||||
|
headers: {
|
||||||
|
[httpm.Headers.Accept]: 'baz'
|
||||||
|
}
|
||||||
|
}
|
||||||
|
jsonObj = await httpWithHeaders.patchJson<any>(
|
||||||
|
'https://httpbin.org/patch',
|
||||||
|
{}
|
||||||
|
)
|
||||||
|
expect(jsonObj.result.headers['Accept']).toBe('baz')
|
||||||
|
expect(jsonObj.headers[httpm.Headers.ContentType]).toBe(
|
||||||
|
httpm.MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,73 @@
|
|||||||
|
import * as httpm from '../lib'
|
||||||
|
|
||||||
|
describe('basics', () => {
|
||||||
|
let _http: httpm.HttpClient
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
_http = new httpm.HttpClient('http-client-tests', [], {keepAlive: true})
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
_http.dispose()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http get request with keepAlive true', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic head request with keepAlive true', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.head(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http delete request with keepAlive true', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.del(
|
||||||
|
'http://httpbin.org/delete'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
JSON.parse(body)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http post request with keepAlive true', async () => {
|
||||||
|
const b = 'Hello World!'
|
||||||
|
const res: httpm.HttpClientResponse = await _http.post(
|
||||||
|
'http://httpbin.org/post',
|
||||||
|
b
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.data).toBe(b)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/post')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http patch request with keepAlive true', async () => {
|
||||||
|
const b = 'Hello World!'
|
||||||
|
const res: httpm.HttpClientResponse = await _http.patch(
|
||||||
|
'http://httpbin.org/patch',
|
||||||
|
b
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.data).toBe(b)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/patch')
|
||||||
|
})
|
||||||
|
|
||||||
|
it('does basic http options request with keepAlive true', async () => {
|
||||||
|
const res: httpm.HttpClientResponse = await _http.options(
|
||||||
|
'http://httpbin.org'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
await res.readBody()
|
||||||
|
})
|
||||||
|
})
|
||||||
@@ -0,0 +1,232 @@
|
|||||||
|
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||||
|
|
||||||
|
import * as http from 'http'
|
||||||
|
import * as httpm from '../lib/'
|
||||||
|
import * as pm from '../lib/proxy'
|
||||||
|
// eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-require-imports
|
||||||
|
const proxy = require('proxy')
|
||||||
|
|
||||||
|
let _proxyConnects: string[]
|
||||||
|
let _proxyServer: http.Server
|
||||||
|
const _proxyUrl = 'http://127.0.0.1:8080'
|
||||||
|
|
||||||
|
describe('proxy', () => {
|
||||||
|
beforeAll(async () => {
|
||||||
|
// Start proxy server
|
||||||
|
_proxyServer = proxy()
|
||||||
|
await new Promise<void>(resolve => {
|
||||||
|
const port = Number(_proxyUrl.split(':')[2])
|
||||||
|
_proxyServer.listen(port, () => resolve())
|
||||||
|
})
|
||||||
|
_proxyServer.on('connect', req => {
|
||||||
|
_proxyConnects.push(req.url)
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
_proxyConnects = []
|
||||||
|
_clearVars()
|
||||||
|
})
|
||||||
|
|
||||||
|
afterEach(() => {})
|
||||||
|
|
||||||
|
afterAll(async () => {
|
||||||
|
_clearVars()
|
||||||
|
|
||||||
|
// Stop proxy server
|
||||||
|
await new Promise<void>(resolve => {
|
||||||
|
_proxyServer.once('close', () => resolve())
|
||||||
|
_proxyServer.close()
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getProxyUrl does not return proxyUrl if variables not set', () => {
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL('https://github.com'))
|
||||||
|
expect(proxyUrl).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getProxyUrl returns proxyUrl if https_proxy set for https url', () => {
|
||||||
|
process.env['https_proxy'] = 'https://myproxysvr'
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL('https://github.com'))
|
||||||
|
expect(proxyUrl).toBeDefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getProxyUrl does not return proxyUrl if http_proxy set for https url', () => {
|
||||||
|
process.env['http_proxy'] = 'https://myproxysvr'
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL('https://github.com'))
|
||||||
|
expect(proxyUrl).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getProxyUrl returns proxyUrl if http_proxy set for http url', () => {
|
||||||
|
process.env['http_proxy'] = 'http://myproxysvr'
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL('http://github.com'))
|
||||||
|
expect(proxyUrl).toBeDefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getProxyUrl does not return proxyUrl if https_proxy set and in no_proxy list', () => {
|
||||||
|
process.env['https_proxy'] = 'https://myproxysvr'
|
||||||
|
process.env['no_proxy'] = 'otherserver,myserver,anotherserver:8080'
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL('https://myserver'))
|
||||||
|
expect(proxyUrl).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getProxyUrl returns proxyUrl if https_proxy set and not in no_proxy list', () => {
|
||||||
|
process.env['https_proxy'] = 'https://myproxysvr'
|
||||||
|
process.env['no_proxy'] = 'otherserver,myserver,anotherserver:8080'
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL('https://github.com'))
|
||||||
|
expect(proxyUrl).toBeDefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getProxyUrl does not return proxyUrl if http_proxy set and in no_proxy list', () => {
|
||||||
|
process.env['http_proxy'] = 'http://myproxysvr'
|
||||||
|
process.env['no_proxy'] = 'otherserver,myserver,anotherserver:8080'
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL('http://myserver'))
|
||||||
|
expect(proxyUrl).toBeUndefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('getProxyUrl returns proxyUrl if http_proxy set and not in no_proxy list', () => {
|
||||||
|
process.env['http_proxy'] = 'http://myproxysvr'
|
||||||
|
process.env['no_proxy'] = 'otherserver,myserver,anotherserver:8080'
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL('http://github.com'))
|
||||||
|
expect(proxyUrl).toBeDefined()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns true if host as no_proxy list', () => {
|
||||||
|
process.env['no_proxy'] = 'myserver'
|
||||||
|
const bypass = pm.checkBypass(new URL('https://myserver'))
|
||||||
|
expect(bypass).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns true if host in no_proxy list', () => {
|
||||||
|
process.env['no_proxy'] = 'otherserver,myserver,anotherserver:8080'
|
||||||
|
const bypass = pm.checkBypass(new URL('https://myserver'))
|
||||||
|
expect(bypass).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns true if host in no_proxy list with spaces', () => {
|
||||||
|
process.env['no_proxy'] = 'otherserver, myserver ,anotherserver:8080'
|
||||||
|
const bypass = pm.checkBypass(new URL('https://myserver'))
|
||||||
|
expect(bypass).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns true if host in no_proxy list with port', () => {
|
||||||
|
process.env['no_proxy'] = 'otherserver, myserver:8080 ,anotherserver'
|
||||||
|
const bypass = pm.checkBypass(new URL('https://myserver:8080'))
|
||||||
|
expect(bypass).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns true if host with port in no_proxy list without port', () => {
|
||||||
|
process.env['no_proxy'] = 'otherserver, myserver ,anotherserver'
|
||||||
|
const bypass = pm.checkBypass(new URL('https://myserver:8080'))
|
||||||
|
expect(bypass).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns true if host in no_proxy list with default https port', () => {
|
||||||
|
process.env['no_proxy'] = 'otherserver, myserver:443 ,anotherserver'
|
||||||
|
const bypass = pm.checkBypass(new URL('https://myserver'))
|
||||||
|
expect(bypass).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns true if host in no_proxy list with default http port', () => {
|
||||||
|
process.env['no_proxy'] = 'otherserver, myserver:80 ,anotherserver'
|
||||||
|
const bypass = pm.checkBypass(new URL('http://myserver'))
|
||||||
|
expect(bypass).toBeTruthy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns false if host not in no_proxy list', () => {
|
||||||
|
process.env['no_proxy'] = 'otherserver, myserver ,anotherserver:8080'
|
||||||
|
const bypass = pm.checkBypass(new URL('https://github.com'))
|
||||||
|
expect(bypass).toBeFalsy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('checkBypass returns false if empty no_proxy', () => {
|
||||||
|
process.env['no_proxy'] = ''
|
||||||
|
const bypass = pm.checkBypass(new URL('https://github.com'))
|
||||||
|
expect(bypass).toBeFalsy()
|
||||||
|
})
|
||||||
|
|
||||||
|
it('HttpClient does basic http get request through proxy', async () => {
|
||||||
|
process.env['http_proxy'] = _proxyUrl
|
||||||
|
const httpClient = new httpm.HttpClient()
|
||||||
|
const res: httpm.HttpClientResponse = await httpClient.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
expect(_proxyConnects).toEqual(['httpbin.org:80'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('HttoClient does basic http get request when bypass proxy', async () => {
|
||||||
|
process.env['http_proxy'] = _proxyUrl
|
||||||
|
process.env['no_proxy'] = 'httpbin.org'
|
||||||
|
const httpClient = new httpm.HttpClient()
|
||||||
|
const res: httpm.HttpClientResponse = await httpClient.get(
|
||||||
|
'http://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('http://httpbin.org/get')
|
||||||
|
expect(_proxyConnects).toHaveLength(0)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('HttpClient does basic https get request through proxy', async () => {
|
||||||
|
process.env['https_proxy'] = _proxyUrl
|
||||||
|
const httpClient = new httpm.HttpClient()
|
||||||
|
const res: httpm.HttpClientResponse = await httpClient.get(
|
||||||
|
'https://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('https://httpbin.org/get')
|
||||||
|
expect(_proxyConnects).toEqual(['httpbin.org:443'])
|
||||||
|
})
|
||||||
|
|
||||||
|
it('HttpClient does basic https get request when bypass proxy', async () => {
|
||||||
|
process.env['https_proxy'] = _proxyUrl
|
||||||
|
process.env['no_proxy'] = 'httpbin.org'
|
||||||
|
const httpClient = new httpm.HttpClient()
|
||||||
|
const res: httpm.HttpClientResponse = await httpClient.get(
|
||||||
|
'https://httpbin.org/get'
|
||||||
|
)
|
||||||
|
expect(res.message.statusCode).toBe(200)
|
||||||
|
const body: string = await res.readBody()
|
||||||
|
const obj = JSON.parse(body)
|
||||||
|
expect(obj.url).toBe('https://httpbin.org/get')
|
||||||
|
expect(_proxyConnects).toHaveLength(0)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('proxyAuth not set in tunnel agent when authentication is not provided', async () => {
|
||||||
|
process.env['https_proxy'] = 'http://127.0.0.1:8080'
|
||||||
|
const httpClient = new httpm.HttpClient()
|
||||||
|
const agent: any = httpClient.getAgent('https://some-url')
|
||||||
|
// eslint-disable-next-line no-console
|
||||||
|
console.log(agent)
|
||||||
|
expect(agent.proxyOptions.host).toBe('127.0.0.1')
|
||||||
|
expect(agent.proxyOptions.port).toBe('8080')
|
||||||
|
expect(agent.proxyOptions.proxyAuth).toBe(undefined)
|
||||||
|
})
|
||||||
|
|
||||||
|
it('proxyAuth is set in tunnel agent when authentication is provided', async () => {
|
||||||
|
process.env['https_proxy'] = 'http://user:[email protected]:8080'
|
||||||
|
const httpClient = new httpm.HttpClient()
|
||||||
|
const agent: any = httpClient.getAgent('https://some-url')
|
||||||
|
// eslint-disable-next-line no-console
|
||||||
|
console.log(agent)
|
||||||
|
expect(agent.proxyOptions.host).toBe('127.0.0.1')
|
||||||
|
expect(agent.proxyOptions.port).toBe('8080')
|
||||||
|
expect(agent.proxyOptions.proxyAuth).toBe('user:password')
|
||||||
|
})
|
||||||
|
})
|
||||||
|
|
||||||
|
function _clearVars(): void {
|
||||||
|
delete process.env.http_proxy
|
||||||
|
delete process.env.HTTP_PROXY
|
||||||
|
delete process.env.https_proxy
|
||||||
|
delete process.env.HTTPS_PROXY
|
||||||
|
delete process.env.no_proxy
|
||||||
|
delete process.env.NO_PROXY
|
||||||
|
}
|
||||||
Generated
+332
@@ -0,0 +1,332 @@
|
|||||||
|
{
|
||||||
|
"name": "@actions/http-client",
|
||||||
|
"version": "2.0.0",
|
||||||
|
"lockfileVersion": 2,
|
||||||
|
"requires": true,
|
||||||
|
"packages": {
|
||||||
|
"": {
|
||||||
|
"name": "@actions/http-client",
|
||||||
|
"version": "2.0.0",
|
||||||
|
"license": "MIT",
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/tunnel": "0.0.3",
|
||||||
|
"proxy": "^1.0.1",
|
||||||
|
"tunnel": "0.0.6"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/@types/node": {
|
||||||
|
"version": "12.12.31",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.31.tgz",
|
||||||
|
"integrity": "sha512-T+wnJno8uh27G9c+1T+a1/WYCHzLeDqtsGJkoEdSp2X8RTh3oOCZQcUnjAx90CS8cmmADX51O0FI/tu9s0yssg==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"node_modules/@types/tunnel": {
|
||||||
|
"version": "0.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/tunnel/-/tunnel-0.0.3.tgz",
|
||||||
|
"integrity": "sha512-sOUTGn6h1SfQ+gbgqC364jLFBw2lnFqkgF3q0WovEHRLMrVD1sd5aufqi/aJObLekJO+Aq5z646U4Oxy6shXMA==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"@types/node": "*"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/ansi-styles": {
|
||||||
|
"version": "3.2.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
|
||||||
|
"integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"color-convert": "^1.9.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=4"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/args": {
|
||||||
|
"version": "5.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/args/-/args-5.0.1.tgz",
|
||||||
|
"integrity": "sha512-1kqmFCFsPffavQFGt8OxJdIcETti99kySRUPMpOhaGjL6mRJn8HFU1OxKY5bMqfZKUwTQc1mZkAjmGYaVOHFtQ==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"camelcase": "5.0.0",
|
||||||
|
"chalk": "2.4.2",
|
||||||
|
"leven": "2.1.0",
|
||||||
|
"mri": "1.1.4"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">= 6.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/basic-auth-parser": {
|
||||||
|
"version": "0.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/basic-auth-parser/-/basic-auth-parser-0.0.2.tgz",
|
||||||
|
"integrity": "sha1-zp5xp38jwSee7NJlmypGJEwVbkE=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"node_modules/camelcase": {
|
||||||
|
"version": "5.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.0.0.tgz",
|
||||||
|
"integrity": "sha512-faqwZqnWxbxn+F1d399ygeamQNy3lPp/H9H6rNrqYh4FSVCtcY+3cub1MxA8o9mDd55mM8Aghuu/kuyYA6VTsA==",
|
||||||
|
"dev": true,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=6"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/chalk": {
|
||||||
|
"version": "2.4.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
|
||||||
|
"integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"ansi-styles": "^3.2.1",
|
||||||
|
"escape-string-regexp": "^1.0.5",
|
||||||
|
"supports-color": "^5.3.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=4"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/color-convert": {
|
||||||
|
"version": "1.9.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
|
||||||
|
"integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"color-name": "1.1.3"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/color-name": {
|
||||||
|
"version": "1.1.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
|
||||||
|
"integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"node_modules/debug": {
|
||||||
|
"version": "4.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz",
|
||||||
|
"integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==",
|
||||||
|
"deprecated": "Debug versions >=3.2.0 <3.2.7 || >=4 <4.3.1 have a low-severity ReDos regression when used in a Node.js environment. It is recommended you upgrade to 3.2.7 or 4.3.1. (https://github.com/visionmedia/debug/issues/797)",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"ms": "^2.1.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/escape-string-regexp": {
|
||||||
|
"version": "1.0.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
|
||||||
|
"integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=",
|
||||||
|
"dev": true,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=0.8.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/has-flag": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
|
||||||
|
"integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=",
|
||||||
|
"dev": true,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=4"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/leven": {
|
||||||
|
"version": "2.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/leven/-/leven-2.1.0.tgz",
|
||||||
|
"integrity": "sha1-wuep93IJTe6dNCAq6KzORoeHVYA=",
|
||||||
|
"dev": true,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=0.10.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/mri": {
|
||||||
|
"version": "1.1.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/mri/-/mri-1.1.4.tgz",
|
||||||
|
"integrity": "sha512-6y7IjGPm8AzlvoUrwAaw1tLnUBudaS3752vcd8JtrpGGQn+rXIe63LFVHm/YMwtqAuh+LJPCFdlLYPWM1nYn6w==",
|
||||||
|
"dev": true,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=4"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/ms": {
|
||||||
|
"version": "2.1.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
|
||||||
|
"integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"node_modules/proxy": {
|
||||||
|
"version": "1.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/proxy/-/proxy-1.0.2.tgz",
|
||||||
|
"integrity": "sha512-KNac2ueWRpjbUh77OAFPZuNdfEqNynm9DD4xHT14CccGpW8wKZwEkN0yjlb7X9G9Z9F55N0Q+1z+WfgAhwYdzQ==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"args": "5.0.1",
|
||||||
|
"basic-auth-parser": "0.0.2",
|
||||||
|
"debug": "^4.1.1"
|
||||||
|
},
|
||||||
|
"bin": {
|
||||||
|
"proxy": "bin/proxy.js"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/supports-color": {
|
||||||
|
"version": "5.5.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
|
||||||
|
"integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
|
||||||
|
"dev": true,
|
||||||
|
"dependencies": {
|
||||||
|
"has-flag": "^3.0.0"
|
||||||
|
},
|
||||||
|
"engines": {
|
||||||
|
"node": ">=4"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"node_modules/tunnel": {
|
||||||
|
"version": "0.0.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz",
|
||||||
|
"integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==",
|
||||||
|
"dev": true,
|
||||||
|
"engines": {
|
||||||
|
"node": ">=0.6.11 <=0.7.0 || >=0.7.3"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"@types/node": {
|
||||||
|
"version": "12.12.31",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/node/-/node-12.12.31.tgz",
|
||||||
|
"integrity": "sha512-T+wnJno8uh27G9c+1T+a1/WYCHzLeDqtsGJkoEdSp2X8RTh3oOCZQcUnjAx90CS8cmmADX51O0FI/tu9s0yssg==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"@types/tunnel": {
|
||||||
|
"version": "0.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/@types/tunnel/-/tunnel-0.0.3.tgz",
|
||||||
|
"integrity": "sha512-sOUTGn6h1SfQ+gbgqC364jLFBw2lnFqkgF3q0WovEHRLMrVD1sd5aufqi/aJObLekJO+Aq5z646U4Oxy6shXMA==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"@types/node": "*"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"ansi-styles": {
|
||||||
|
"version": "3.2.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/ansi-styles/-/ansi-styles-3.2.1.tgz",
|
||||||
|
"integrity": "sha512-VT0ZI6kZRdTh8YyJw3SMbYm/u+NqfsAxEpWO0Pf9sq8/e94WxxOpPKx9FR1FlyCtOVDNOQ+8ntlqFxiRc+r5qA==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"color-convert": "^1.9.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"args": {
|
||||||
|
"version": "5.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/args/-/args-5.0.1.tgz",
|
||||||
|
"integrity": "sha512-1kqmFCFsPffavQFGt8OxJdIcETti99kySRUPMpOhaGjL6mRJn8HFU1OxKY5bMqfZKUwTQc1mZkAjmGYaVOHFtQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"camelcase": "5.0.0",
|
||||||
|
"chalk": "2.4.2",
|
||||||
|
"leven": "2.1.0",
|
||||||
|
"mri": "1.1.4"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"basic-auth-parser": {
|
||||||
|
"version": "0.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/basic-auth-parser/-/basic-auth-parser-0.0.2.tgz",
|
||||||
|
"integrity": "sha1-zp5xp38jwSee7NJlmypGJEwVbkE=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"camelcase": {
|
||||||
|
"version": "5.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/camelcase/-/camelcase-5.0.0.tgz",
|
||||||
|
"integrity": "sha512-faqwZqnWxbxn+F1d399ygeamQNy3lPp/H9H6rNrqYh4FSVCtcY+3cub1MxA8o9mDd55mM8Aghuu/kuyYA6VTsA==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"chalk": {
|
||||||
|
"version": "2.4.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/chalk/-/chalk-2.4.2.tgz",
|
||||||
|
"integrity": "sha512-Mti+f9lpJNcwF4tWV8/OrTTtF1gZi+f8FqlyAdouralcFWFQWF2+NgCHShjkCb+IFBLq9buZwE1xckQU4peSuQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"ansi-styles": "^3.2.1",
|
||||||
|
"escape-string-regexp": "^1.0.5",
|
||||||
|
"supports-color": "^5.3.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"color-convert": {
|
||||||
|
"version": "1.9.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/color-convert/-/color-convert-1.9.3.tgz",
|
||||||
|
"integrity": "sha512-QfAUtd+vFdAtFQcC8CCyYt1fYWxSqAiK2cSD6zDB8N3cpsEBAvRxp9zOGg6G/SHHJYAT88/az/IuDGALsNVbGg==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"color-name": "1.1.3"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"color-name": {
|
||||||
|
"version": "1.1.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/color-name/-/color-name-1.1.3.tgz",
|
||||||
|
"integrity": "sha1-p9BVi9icQveV3UIyj3QIMcpTvCU=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"debug": {
|
||||||
|
"version": "4.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/debug/-/debug-4.1.1.tgz",
|
||||||
|
"integrity": "sha512-pYAIzeRo8J6KPEaJ0VWOh5Pzkbw/RetuzehGM7QRRX5he4fPHx2rdKMB256ehJCkX+XRQm16eZLqLNS8RSZXZw==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"ms": "^2.1.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"escape-string-regexp": {
|
||||||
|
"version": "1.0.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
|
||||||
|
"integrity": "sha1-G2HAViGQqN/2rjuyzwIAyhMLhtQ=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"has-flag": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/has-flag/-/has-flag-3.0.0.tgz",
|
||||||
|
"integrity": "sha1-tdRU3CGZriJWmfNGfloH87lVuv0=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"leven": {
|
||||||
|
"version": "2.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/leven/-/leven-2.1.0.tgz",
|
||||||
|
"integrity": "sha1-wuep93IJTe6dNCAq6KzORoeHVYA=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"mri": {
|
||||||
|
"version": "1.1.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/mri/-/mri-1.1.4.tgz",
|
||||||
|
"integrity": "sha512-6y7IjGPm8AzlvoUrwAaw1tLnUBudaS3752vcd8JtrpGGQn+rXIe63LFVHm/YMwtqAuh+LJPCFdlLYPWM1nYn6w==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"ms": {
|
||||||
|
"version": "2.1.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz",
|
||||||
|
"integrity": "sha512-sGkPx+VjMtmA6MX27oA4FBFELFCZZ4S4XqeGOXCv68tT+jb3vk/RyaKWP0PTKyWtmLSM0b+adUTEvbs1PEaH2w==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"proxy": {
|
||||||
|
"version": "1.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/proxy/-/proxy-1.0.2.tgz",
|
||||||
|
"integrity": "sha512-KNac2ueWRpjbUh77OAFPZuNdfEqNynm9DD4xHT14CccGpW8wKZwEkN0yjlb7X9G9Z9F55N0Q+1z+WfgAhwYdzQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"args": "5.0.1",
|
||||||
|
"basic-auth-parser": "0.0.2",
|
||||||
|
"debug": "^4.1.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"supports-color": {
|
||||||
|
"version": "5.5.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
|
||||||
|
"integrity": "sha512-QjVjwdXIt408MIiAqCX4oUKsgU2EqAGzs2Ppkm4aQYbjm+ZEWEcW4SfFNTr4uMNZma0ey4f5lgLrkB0aX0QMow==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"has-flag": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"tunnel": {
|
||||||
|
"version": "0.0.6",
|
||||||
|
"resolved": "https://registry.npmjs.org/tunnel/-/tunnel-0.0.6.tgz",
|
||||||
|
"integrity": "sha512-1h/Lnq9yajKY2PEbBadPXj3VxsDDu844OnaAo52UVmIzIvwwtBPIuNvkjuzBlTWpfJyUbG3ez0KSBibQkj4ojg==",
|
||||||
|
"dev": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,46 @@
|
|||||||
|
{
|
||||||
|
"name": "@actions/http-client",
|
||||||
|
"version": "2.0.0",
|
||||||
|
"description": "Actions Http Client",
|
||||||
|
"keywords": [
|
||||||
|
"github",
|
||||||
|
"actions",
|
||||||
|
"http"
|
||||||
|
],
|
||||||
|
"homepage": "https://github.com/actions/toolkit/tree/main/packages/http-client",
|
||||||
|
"license": "MIT",
|
||||||
|
"main": "lib/index.js",
|
||||||
|
"types": "lib/index.d.ts",
|
||||||
|
"directories": {
|
||||||
|
"lib": "lib",
|
||||||
|
"test": "__tests__"
|
||||||
|
},
|
||||||
|
"files": [
|
||||||
|
"lib",
|
||||||
|
"!.DS_Store"
|
||||||
|
],
|
||||||
|
"publishConfig": {
|
||||||
|
"access": "public"
|
||||||
|
},
|
||||||
|
"repository": {
|
||||||
|
"type": "git",
|
||||||
|
"url": "git+https://github.com/actions/toolkit.git",
|
||||||
|
"directory": "packages/github"
|
||||||
|
},
|
||||||
|
"scripts": {
|
||||||
|
"audit-moderate": "npm install && npm audit --json --audit-level=moderate > audit.json",
|
||||||
|
"test": "echo \"Error: run tests from root\" && exit 1",
|
||||||
|
"build": "tsc",
|
||||||
|
"format": "prettier --write **/*.ts",
|
||||||
|
"format-check": "prettier --check **/*.ts",
|
||||||
|
"tsc": "tsc"
|
||||||
|
},
|
||||||
|
"bugs": {
|
||||||
|
"url": "https://github.com/actions/toolkit/issues"
|
||||||
|
},
|
||||||
|
"devDependencies": {
|
||||||
|
"@types/tunnel": "0.0.3",
|
||||||
|
"proxy": "^1.0.1",
|
||||||
|
"tunnel": "0.0.6"
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,86 @@
|
|||||||
|
import * as http from 'http'
|
||||||
|
import * as ifm from './interfaces'
|
||||||
|
import {HttpClientResponse} from './index'
|
||||||
|
|
||||||
|
export class BasicCredentialHandler implements ifm.RequestHandler {
|
||||||
|
username: string
|
||||||
|
password: string
|
||||||
|
|
||||||
|
constructor(username: string, password: string) {
|
||||||
|
this.username = username
|
||||||
|
this.password = password
|
||||||
|
}
|
||||||
|
|
||||||
|
prepareRequest(options: http.RequestOptions): void {
|
||||||
|
if (!options.headers) {
|
||||||
|
throw Error('The request has no headers')
|
||||||
|
}
|
||||||
|
options.headers['Authorization'] = `Basic ${Buffer.from(
|
||||||
|
`${this.username}:${this.password}`
|
||||||
|
).toString('base64')}`
|
||||||
|
}
|
||||||
|
|
||||||
|
// This handler cannot handle 401
|
||||||
|
canHandleAuthentication(): boolean {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
async handleAuthentication(): Promise<HttpClientResponse> {
|
||||||
|
throw new Error('not implemented')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class BearerCredentialHandler implements ifm.RequestHandler {
|
||||||
|
token: string
|
||||||
|
|
||||||
|
constructor(token: string) {
|
||||||
|
this.token = token
|
||||||
|
}
|
||||||
|
|
||||||
|
// currently implements pre-authorization
|
||||||
|
// TODO: support preAuth = false where it hooks on 401
|
||||||
|
prepareRequest(options: http.RequestOptions): void {
|
||||||
|
if (!options.headers) {
|
||||||
|
throw Error('The request has no headers')
|
||||||
|
}
|
||||||
|
options.headers['Authorization'] = `Bearer ${this.token}`
|
||||||
|
}
|
||||||
|
|
||||||
|
// This handler cannot handle 401
|
||||||
|
canHandleAuthentication(): boolean {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
async handleAuthentication(): Promise<HttpClientResponse> {
|
||||||
|
throw new Error('not implemented')
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export class PersonalAccessTokenCredentialHandler
|
||||||
|
implements ifm.RequestHandler {
|
||||||
|
token: string
|
||||||
|
|
||||||
|
constructor(token: string) {
|
||||||
|
this.token = token
|
||||||
|
}
|
||||||
|
|
||||||
|
// currently implements pre-authorization
|
||||||
|
// TODO: support preAuth = false where it hooks on 401
|
||||||
|
prepareRequest(options: http.RequestOptions): void {
|
||||||
|
if (!options.headers) {
|
||||||
|
throw Error('The request has no headers')
|
||||||
|
}
|
||||||
|
options.headers['Authorization'] = `Basic ${Buffer.from(
|
||||||
|
`PAT:${this.token}`
|
||||||
|
).toString('base64')}`
|
||||||
|
}
|
||||||
|
|
||||||
|
// This handler cannot handle 401
|
||||||
|
canHandleAuthentication(): boolean {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
async handleAuthentication(): Promise<HttpClientResponse> {
|
||||||
|
throw new Error('not implemented')
|
||||||
|
}
|
||||||
|
}
|
||||||
@@ -0,0 +1,773 @@
|
|||||||
|
/* eslint-disable @typescript-eslint/no-explicit-any */
|
||||||
|
|
||||||
|
import * as http from 'http'
|
||||||
|
import * as https from 'https'
|
||||||
|
import * as ifm from './interfaces'
|
||||||
|
import * as net from 'net'
|
||||||
|
import * as pm from './proxy'
|
||||||
|
import * as tunnel from 'tunnel'
|
||||||
|
|
||||||
|
export enum HttpCodes {
|
||||||
|
OK = 200,
|
||||||
|
MultipleChoices = 300,
|
||||||
|
MovedPermanently = 301,
|
||||||
|
ResourceMoved = 302,
|
||||||
|
SeeOther = 303,
|
||||||
|
NotModified = 304,
|
||||||
|
UseProxy = 305,
|
||||||
|
SwitchProxy = 306,
|
||||||
|
TemporaryRedirect = 307,
|
||||||
|
PermanentRedirect = 308,
|
||||||
|
BadRequest = 400,
|
||||||
|
Unauthorized = 401,
|
||||||
|
PaymentRequired = 402,
|
||||||
|
Forbidden = 403,
|
||||||
|
NotFound = 404,
|
||||||
|
MethodNotAllowed = 405,
|
||||||
|
NotAcceptable = 406,
|
||||||
|
ProxyAuthenticationRequired = 407,
|
||||||
|
RequestTimeout = 408,
|
||||||
|
Conflict = 409,
|
||||||
|
Gone = 410,
|
||||||
|
TooManyRequests = 429,
|
||||||
|
InternalServerError = 500,
|
||||||
|
NotImplemented = 501,
|
||||||
|
BadGateway = 502,
|
||||||
|
ServiceUnavailable = 503,
|
||||||
|
GatewayTimeout = 504
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum Headers {
|
||||||
|
Accept = 'accept',
|
||||||
|
ContentType = 'content-type'
|
||||||
|
}
|
||||||
|
|
||||||
|
export enum MediaTypes {
|
||||||
|
ApplicationJson = 'application/json'
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Returns the proxy URL, depending upon the supplied url and proxy environment variables.
|
||||||
|
* @param serverUrl The server URL where the request will be sent. For example, https://api.github.com
|
||||||
|
*/
|
||||||
|
export function getProxyUrl(serverUrl: string): string {
|
||||||
|
const proxyUrl = pm.getProxyUrl(new URL(serverUrl))
|
||||||
|
return proxyUrl ? proxyUrl.href : ''
|
||||||
|
}
|
||||||
|
|
||||||
|
const HttpRedirectCodes: number[] = [
|
||||||
|
HttpCodes.MovedPermanently,
|
||||||
|
HttpCodes.ResourceMoved,
|
||||||
|
HttpCodes.SeeOther,
|
||||||
|
HttpCodes.TemporaryRedirect,
|
||||||
|
HttpCodes.PermanentRedirect
|
||||||
|
]
|
||||||
|
const HttpResponseRetryCodes: number[] = [
|
||||||
|
HttpCodes.BadGateway,
|
||||||
|
HttpCodes.ServiceUnavailable,
|
||||||
|
HttpCodes.GatewayTimeout
|
||||||
|
]
|
||||||
|
const RetryableHttpVerbs: string[] = ['OPTIONS', 'GET', 'DELETE', 'HEAD']
|
||||||
|
const ExponentialBackoffCeiling = 10
|
||||||
|
const ExponentialBackoffTimeSlice = 5
|
||||||
|
|
||||||
|
export class HttpClientError extends Error {
|
||||||
|
constructor(message: string, statusCode: number) {
|
||||||
|
super(message)
|
||||||
|
this.name = 'HttpClientError'
|
||||||
|
this.statusCode = statusCode
|
||||||
|
Object.setPrototypeOf(this, HttpClientError.prototype)
|
||||||
|
}
|
||||||
|
|
||||||
|
statusCode: number
|
||||||
|
result?: any
|
||||||
|
}
|
||||||
|
|
||||||
|
export class HttpClientResponse {
|
||||||
|
constructor(message: http.IncomingMessage) {
|
||||||
|
this.message = message
|
||||||
|
}
|
||||||
|
|
||||||
|
message: http.IncomingMessage
|
||||||
|
async readBody(): Promise<string> {
|
||||||
|
return new Promise<string>(async resolve => {
|
||||||
|
let output = Buffer.alloc(0)
|
||||||
|
|
||||||
|
this.message.on('data', (chunk: Buffer) => {
|
||||||
|
output = Buffer.concat([output, chunk])
|
||||||
|
})
|
||||||
|
|
||||||
|
this.message.on('end', () => {
|
||||||
|
resolve(output.toString())
|
||||||
|
})
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function isHttps(requestUrl: string): boolean {
|
||||||
|
const parsedUrl: URL = new URL(requestUrl)
|
||||||
|
return parsedUrl.protocol === 'https:'
|
||||||
|
}
|
||||||
|
|
||||||
|
export class HttpClient {
|
||||||
|
userAgent: string | undefined
|
||||||
|
handlers: ifm.RequestHandler[]
|
||||||
|
requestOptions: ifm.RequestOptions | undefined
|
||||||
|
|
||||||
|
private _ignoreSslError = false
|
||||||
|
private _socketTimeout: number | undefined
|
||||||
|
private _allowRedirects = true
|
||||||
|
private _allowRedirectDowngrade = false
|
||||||
|
private _maxRedirects = 50
|
||||||
|
private _allowRetries = false
|
||||||
|
private _maxRetries = 1
|
||||||
|
private _agent: any
|
||||||
|
private _proxyAgent: any
|
||||||
|
private _keepAlive = false
|
||||||
|
private _disposed = false
|
||||||
|
|
||||||
|
constructor(
|
||||||
|
userAgent?: string,
|
||||||
|
handlers?: ifm.RequestHandler[],
|
||||||
|
requestOptions?: ifm.RequestOptions
|
||||||
|
) {
|
||||||
|
this.userAgent = userAgent
|
||||||
|
this.handlers = handlers || []
|
||||||
|
this.requestOptions = requestOptions
|
||||||
|
if (requestOptions) {
|
||||||
|
if (requestOptions.ignoreSslError != null) {
|
||||||
|
this._ignoreSslError = requestOptions.ignoreSslError
|
||||||
|
}
|
||||||
|
|
||||||
|
this._socketTimeout = requestOptions.socketTimeout
|
||||||
|
|
||||||
|
if (requestOptions.allowRedirects != null) {
|
||||||
|
this._allowRedirects = requestOptions.allowRedirects
|
||||||
|
}
|
||||||
|
|
||||||
|
if (requestOptions.allowRedirectDowngrade != null) {
|
||||||
|
this._allowRedirectDowngrade = requestOptions.allowRedirectDowngrade
|
||||||
|
}
|
||||||
|
|
||||||
|
if (requestOptions.maxRedirects != null) {
|
||||||
|
this._maxRedirects = Math.max(requestOptions.maxRedirects, 0)
|
||||||
|
}
|
||||||
|
|
||||||
|
if (requestOptions.keepAlive != null) {
|
||||||
|
this._keepAlive = requestOptions.keepAlive
|
||||||
|
}
|
||||||
|
|
||||||
|
if (requestOptions.allowRetries != null) {
|
||||||
|
this._allowRetries = requestOptions.allowRetries
|
||||||
|
}
|
||||||
|
|
||||||
|
if (requestOptions.maxRetries != null) {
|
||||||
|
this._maxRetries = requestOptions.maxRetries
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
async options(
|
||||||
|
requestUrl: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return this.request('OPTIONS', requestUrl, null, additionalHeaders || {})
|
||||||
|
}
|
||||||
|
|
||||||
|
async get(
|
||||||
|
requestUrl: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return this.request('GET', requestUrl, null, additionalHeaders || {})
|
||||||
|
}
|
||||||
|
|
||||||
|
async del(
|
||||||
|
requestUrl: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return this.request('DELETE', requestUrl, null, additionalHeaders || {})
|
||||||
|
}
|
||||||
|
|
||||||
|
async post(
|
||||||
|
requestUrl: string,
|
||||||
|
data: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return this.request('POST', requestUrl, data, additionalHeaders || {})
|
||||||
|
}
|
||||||
|
|
||||||
|
async patch(
|
||||||
|
requestUrl: string,
|
||||||
|
data: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return this.request('PATCH', requestUrl, data, additionalHeaders || {})
|
||||||
|
}
|
||||||
|
|
||||||
|
async put(
|
||||||
|
requestUrl: string,
|
||||||
|
data: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return this.request('PUT', requestUrl, data, additionalHeaders || {})
|
||||||
|
}
|
||||||
|
|
||||||
|
async head(
|
||||||
|
requestUrl: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return this.request('HEAD', requestUrl, null, additionalHeaders || {})
|
||||||
|
}
|
||||||
|
|
||||||
|
async sendStream(
|
||||||
|
verb: string,
|
||||||
|
requestUrl: string,
|
||||||
|
stream: NodeJS.ReadableStream,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return this.request(verb, requestUrl, stream, additionalHeaders)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets a typed object from an endpoint
|
||||||
|
* Be aware that not found returns a null. Other errors (4xx, 5xx) reject the promise
|
||||||
|
*/
|
||||||
|
async getJson<T>(
|
||||||
|
requestUrl: string,
|
||||||
|
additionalHeaders: http.OutgoingHttpHeaders = {}
|
||||||
|
): Promise<ifm.TypedResponse<T>> {
|
||||||
|
additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(
|
||||||
|
additionalHeaders,
|
||||||
|
Headers.Accept,
|
||||||
|
MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
const res: HttpClientResponse = await this.get(
|
||||||
|
requestUrl,
|
||||||
|
additionalHeaders
|
||||||
|
)
|
||||||
|
return this._processResponse<T>(res, this.requestOptions)
|
||||||
|
}
|
||||||
|
|
||||||
|
async postJson<T>(
|
||||||
|
requestUrl: string,
|
||||||
|
obj: any,
|
||||||
|
additionalHeaders: http.OutgoingHttpHeaders = {}
|
||||||
|
): Promise<ifm.TypedResponse<T>> {
|
||||||
|
const data: string = JSON.stringify(obj, null, 2)
|
||||||
|
additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(
|
||||||
|
additionalHeaders,
|
||||||
|
Headers.Accept,
|
||||||
|
MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(
|
||||||
|
additionalHeaders,
|
||||||
|
Headers.ContentType,
|
||||||
|
MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
const res: HttpClientResponse = await this.post(
|
||||||
|
requestUrl,
|
||||||
|
data,
|
||||||
|
additionalHeaders
|
||||||
|
)
|
||||||
|
return this._processResponse<T>(res, this.requestOptions)
|
||||||
|
}
|
||||||
|
|
||||||
|
async putJson<T>(
|
||||||
|
requestUrl: string,
|
||||||
|
obj: any,
|
||||||
|
additionalHeaders: http.OutgoingHttpHeaders = {}
|
||||||
|
): Promise<ifm.TypedResponse<T>> {
|
||||||
|
const data: string = JSON.stringify(obj, null, 2)
|
||||||
|
additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(
|
||||||
|
additionalHeaders,
|
||||||
|
Headers.Accept,
|
||||||
|
MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(
|
||||||
|
additionalHeaders,
|
||||||
|
Headers.ContentType,
|
||||||
|
MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
const res: HttpClientResponse = await this.put(
|
||||||
|
requestUrl,
|
||||||
|
data,
|
||||||
|
additionalHeaders
|
||||||
|
)
|
||||||
|
return this._processResponse<T>(res, this.requestOptions)
|
||||||
|
}
|
||||||
|
|
||||||
|
async patchJson<T>(
|
||||||
|
requestUrl: string,
|
||||||
|
obj: any,
|
||||||
|
additionalHeaders: http.OutgoingHttpHeaders = {}
|
||||||
|
): Promise<ifm.TypedResponse<T>> {
|
||||||
|
const data: string = JSON.stringify(obj, null, 2)
|
||||||
|
additionalHeaders[Headers.Accept] = this._getExistingOrDefaultHeader(
|
||||||
|
additionalHeaders,
|
||||||
|
Headers.Accept,
|
||||||
|
MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
additionalHeaders[Headers.ContentType] = this._getExistingOrDefaultHeader(
|
||||||
|
additionalHeaders,
|
||||||
|
Headers.ContentType,
|
||||||
|
MediaTypes.ApplicationJson
|
||||||
|
)
|
||||||
|
const res: HttpClientResponse = await this.patch(
|
||||||
|
requestUrl,
|
||||||
|
data,
|
||||||
|
additionalHeaders
|
||||||
|
)
|
||||||
|
return this._processResponse<T>(res, this.requestOptions)
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Makes a raw http request.
|
||||||
|
* All other methods such as get, post, patch, and request ultimately call this.
|
||||||
|
* Prefer get, del, post and patch
|
||||||
|
*/
|
||||||
|
async request(
|
||||||
|
verb: string,
|
||||||
|
requestUrl: string,
|
||||||
|
data: string | NodeJS.ReadableStream | null,
|
||||||
|
headers?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
if (this._disposed) {
|
||||||
|
throw new Error('Client has already been disposed.')
|
||||||
|
}
|
||||||
|
|
||||||
|
const parsedUrl = new URL(requestUrl)
|
||||||
|
let info: ifm.RequestInfo = this._prepareRequest(verb, parsedUrl, headers)
|
||||||
|
|
||||||
|
// Only perform retries on reads since writes may not be idempotent.
|
||||||
|
const maxTries: number =
|
||||||
|
this._allowRetries && RetryableHttpVerbs.includes(verb)
|
||||||
|
? this._maxRetries + 1
|
||||||
|
: 1
|
||||||
|
let numTries = 0
|
||||||
|
|
||||||
|
let response: HttpClientResponse | undefined
|
||||||
|
do {
|
||||||
|
response = await this.requestRaw(info, data)
|
||||||
|
|
||||||
|
// Check if it's an authentication challenge
|
||||||
|
if (
|
||||||
|
response &&
|
||||||
|
response.message &&
|
||||||
|
response.message.statusCode === HttpCodes.Unauthorized
|
||||||
|
) {
|
||||||
|
let authenticationHandler: ifm.RequestHandler | undefined
|
||||||
|
|
||||||
|
for (const handler of this.handlers) {
|
||||||
|
if (handler.canHandleAuthentication(response)) {
|
||||||
|
authenticationHandler = handler
|
||||||
|
break
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
if (authenticationHandler) {
|
||||||
|
return authenticationHandler.handleAuthentication(this, info, data)
|
||||||
|
} else {
|
||||||
|
// We have received an unauthorized response but have no handlers to handle it.
|
||||||
|
// Let the response return to the caller.
|
||||||
|
return response
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let redirectsRemaining: number = this._maxRedirects
|
||||||
|
while (
|
||||||
|
response.message.statusCode &&
|
||||||
|
HttpRedirectCodes.includes(response.message.statusCode) &&
|
||||||
|
this._allowRedirects &&
|
||||||
|
redirectsRemaining > 0
|
||||||
|
) {
|
||||||
|
const redirectUrl: string | undefined =
|
||||||
|
response.message.headers['location']
|
||||||
|
if (!redirectUrl) {
|
||||||
|
// if there's no location to redirect to, we won't
|
||||||
|
break
|
||||||
|
}
|
||||||
|
const parsedRedirectUrl = new URL(redirectUrl)
|
||||||
|
if (
|
||||||
|
parsedUrl.protocol === 'https:' &&
|
||||||
|
parsedUrl.protocol !== parsedRedirectUrl.protocol &&
|
||||||
|
!this._allowRedirectDowngrade
|
||||||
|
) {
|
||||||
|
throw new Error(
|
||||||
|
'Redirect from HTTPS to HTTP protocol. This downgrade is not allowed for security reasons. If you want to allow this behavior, set the allowRedirectDowngrade option to true.'
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
// we need to finish reading the response before reassigning response
|
||||||
|
// which will leak the open socket.
|
||||||
|
await response.readBody()
|
||||||
|
|
||||||
|
// strip authorization header if redirected to a different hostname
|
||||||
|
if (parsedRedirectUrl.hostname !== parsedUrl.hostname) {
|
||||||
|
for (const header in headers) {
|
||||||
|
// header names are case insensitive
|
||||||
|
if (header.toLowerCase() === 'authorization') {
|
||||||
|
delete headers[header]
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
// let's make the request with the new redirectUrl
|
||||||
|
info = this._prepareRequest(verb, parsedRedirectUrl, headers)
|
||||||
|
response = await this.requestRaw(info, data)
|
||||||
|
redirectsRemaining--
|
||||||
|
}
|
||||||
|
|
||||||
|
if (
|
||||||
|
!response.message.statusCode ||
|
||||||
|
!HttpResponseRetryCodes.includes(response.message.statusCode)
|
||||||
|
) {
|
||||||
|
// If not a retry code, return immediately instead of retrying
|
||||||
|
return response
|
||||||
|
}
|
||||||
|
|
||||||
|
numTries += 1
|
||||||
|
|
||||||
|
if (numTries < maxTries) {
|
||||||
|
await response.readBody()
|
||||||
|
await this._performExponentialBackoff(numTries)
|
||||||
|
}
|
||||||
|
} while (numTries < maxTries)
|
||||||
|
|
||||||
|
return response
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Needs to be called if keepAlive is set to true in request options.
|
||||||
|
*/
|
||||||
|
dispose(): void {
|
||||||
|
if (this._agent) {
|
||||||
|
this._agent.destroy()
|
||||||
|
}
|
||||||
|
|
||||||
|
this._disposed = true
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Raw request.
|
||||||
|
* @param info
|
||||||
|
* @param data
|
||||||
|
*/
|
||||||
|
async requestRaw(
|
||||||
|
info: ifm.RequestInfo,
|
||||||
|
data: string | NodeJS.ReadableStream | null
|
||||||
|
): Promise<HttpClientResponse> {
|
||||||
|
return new Promise<HttpClientResponse>((resolve, reject) => {
|
||||||
|
function callbackForResult(err?: Error, res?: HttpClientResponse): void {
|
||||||
|
if (err) {
|
||||||
|
reject(err)
|
||||||
|
} else if (!res) {
|
||||||
|
// If `err` is not passed, then `res` must be passed.
|
||||||
|
reject(new Error('Unknown error'))
|
||||||
|
} else {
|
||||||
|
resolve(res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
this.requestRawWithCallback(info, data, callbackForResult)
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Raw request with callback.
|
||||||
|
* @param info
|
||||||
|
* @param data
|
||||||
|
* @param onResult
|
||||||
|
*/
|
||||||
|
requestRawWithCallback(
|
||||||
|
info: ifm.RequestInfo,
|
||||||
|
data: string | NodeJS.ReadableStream | null,
|
||||||
|
onResult: (err?: Error, res?: HttpClientResponse) => void
|
||||||
|
): void {
|
||||||
|
if (typeof data === 'string') {
|
||||||
|
if (!info.options.headers) {
|
||||||
|
info.options.headers = {}
|
||||||
|
}
|
||||||
|
info.options.headers['Content-Length'] = Buffer.byteLength(data, 'utf8')
|
||||||
|
}
|
||||||
|
|
||||||
|
let callbackCalled = false
|
||||||
|
function handleResult(err?: Error, res?: HttpClientResponse): void {
|
||||||
|
if (!callbackCalled) {
|
||||||
|
callbackCalled = true
|
||||||
|
onResult(err, res)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const req: http.ClientRequest = info.httpModule.request(
|
||||||
|
info.options,
|
||||||
|
(msg: http.IncomingMessage) => {
|
||||||
|
const res: HttpClientResponse = new HttpClientResponse(msg)
|
||||||
|
handleResult(undefined, res)
|
||||||
|
}
|
||||||
|
)
|
||||||
|
|
||||||
|
let socket: net.Socket
|
||||||
|
req.on('socket', sock => {
|
||||||
|
socket = sock
|
||||||
|
})
|
||||||
|
|
||||||
|
// If we ever get disconnected, we want the socket to timeout eventually
|
||||||
|
req.setTimeout(this._socketTimeout || 3 * 60000, () => {
|
||||||
|
if (socket) {
|
||||||
|
socket.end()
|
||||||
|
}
|
||||||
|
handleResult(new Error(`Request timeout: ${info.options.path}`))
|
||||||
|
})
|
||||||
|
|
||||||
|
req.on('error', function(err) {
|
||||||
|
// err has statusCode property
|
||||||
|
// res should have headers
|
||||||
|
handleResult(err)
|
||||||
|
})
|
||||||
|
|
||||||
|
if (data && typeof data === 'string') {
|
||||||
|
req.write(data, 'utf8')
|
||||||
|
}
|
||||||
|
|
||||||
|
if (data && typeof data !== 'string') {
|
||||||
|
data.on('close', function() {
|
||||||
|
req.end()
|
||||||
|
})
|
||||||
|
|
||||||
|
data.pipe(req)
|
||||||
|
} else {
|
||||||
|
req.end()
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Gets an http agent. This function is useful when you need an http agent that handles
|
||||||
|
* routing through a proxy server - depending upon the url and proxy environment variables.
|
||||||
|
* @param serverUrl The server URL where the request will be sent. For example, https://api.github.com
|
||||||
|
*/
|
||||||
|
getAgent(serverUrl: string): http.Agent {
|
||||||
|
const parsedUrl = new URL(serverUrl)
|
||||||
|
return this._getAgent(parsedUrl)
|
||||||
|
}
|
||||||
|
|
||||||
|
private _prepareRequest(
|
||||||
|
method: string,
|
||||||
|
requestUrl: URL,
|
||||||
|
headers?: http.OutgoingHttpHeaders
|
||||||
|
): ifm.RequestInfo {
|
||||||
|
const info: ifm.RequestInfo = <ifm.RequestInfo>{}
|
||||||
|
|
||||||
|
info.parsedUrl = requestUrl
|
||||||
|
const usingSsl: boolean = info.parsedUrl.protocol === 'https:'
|
||||||
|
info.httpModule = usingSsl ? https : http
|
||||||
|
const defaultPort: number = usingSsl ? 443 : 80
|
||||||
|
|
||||||
|
info.options = <http.RequestOptions>{}
|
||||||
|
info.options.host = info.parsedUrl.hostname
|
||||||
|
info.options.port = info.parsedUrl.port
|
||||||
|
? parseInt(info.parsedUrl.port)
|
||||||
|
: defaultPort
|
||||||
|
info.options.path =
|
||||||
|
(info.parsedUrl.pathname || '') + (info.parsedUrl.search || '')
|
||||||
|
info.options.method = method
|
||||||
|
info.options.headers = this._mergeHeaders(headers)
|
||||||
|
if (this.userAgent != null) {
|
||||||
|
info.options.headers['user-agent'] = this.userAgent
|
||||||
|
}
|
||||||
|
|
||||||
|
info.options.agent = this._getAgent(info.parsedUrl)
|
||||||
|
|
||||||
|
// gives handlers an opportunity to participate
|
||||||
|
if (this.handlers) {
|
||||||
|
for (const handler of this.handlers) {
|
||||||
|
handler.prepareRequest(info.options)
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return info
|
||||||
|
}
|
||||||
|
|
||||||
|
private _mergeHeaders(
|
||||||
|
headers?: http.OutgoingHttpHeaders
|
||||||
|
): http.OutgoingHttpHeaders {
|
||||||
|
if (this.requestOptions && this.requestOptions.headers) {
|
||||||
|
return Object.assign(
|
||||||
|
{},
|
||||||
|
lowercaseKeys(this.requestOptions.headers),
|
||||||
|
lowercaseKeys(headers || {})
|
||||||
|
)
|
||||||
|
}
|
||||||
|
|
||||||
|
return lowercaseKeys(headers || {})
|
||||||
|
}
|
||||||
|
|
||||||
|
private _getExistingOrDefaultHeader(
|
||||||
|
additionalHeaders: http.OutgoingHttpHeaders,
|
||||||
|
header: string,
|
||||||
|
_default: string
|
||||||
|
): string | number | string[] {
|
||||||
|
let clientHeader: string | undefined
|
||||||
|
if (this.requestOptions && this.requestOptions.headers) {
|
||||||
|
clientHeader = lowercaseKeys(this.requestOptions.headers)[header]
|
||||||
|
}
|
||||||
|
return additionalHeaders[header] || clientHeader || _default
|
||||||
|
}
|
||||||
|
|
||||||
|
private _getAgent(parsedUrl: URL): http.Agent {
|
||||||
|
let agent
|
||||||
|
const proxyUrl = pm.getProxyUrl(parsedUrl)
|
||||||
|
const useProxy = proxyUrl && proxyUrl.hostname
|
||||||
|
|
||||||
|
if (this._keepAlive && useProxy) {
|
||||||
|
agent = this._proxyAgent
|
||||||
|
}
|
||||||
|
|
||||||
|
if (this._keepAlive && !useProxy) {
|
||||||
|
agent = this._agent
|
||||||
|
}
|
||||||
|
|
||||||
|
// if agent is already assigned use that agent.
|
||||||
|
if (agent) {
|
||||||
|
return agent
|
||||||
|
}
|
||||||
|
|
||||||
|
const usingSsl = parsedUrl.protocol === 'https:'
|
||||||
|
let maxSockets = 100
|
||||||
|
if (this.requestOptions) {
|
||||||
|
maxSockets = this.requestOptions.maxSockets || http.globalAgent.maxSockets
|
||||||
|
}
|
||||||
|
|
||||||
|
// This is `useProxy` again, but we need to check `proxyURl` directly for TypeScripts's flow analysis.
|
||||||
|
if (proxyUrl && proxyUrl.hostname) {
|
||||||
|
const agentOptions = {
|
||||||
|
maxSockets,
|
||||||
|
keepAlive: this._keepAlive,
|
||||||
|
proxy: {
|
||||||
|
...((proxyUrl.username || proxyUrl.password) && {
|
||||||
|
proxyAuth: `${proxyUrl.username}:${proxyUrl.password}`
|
||||||
|
}),
|
||||||
|
host: proxyUrl.hostname,
|
||||||
|
port: proxyUrl.port
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
let tunnelAgent: Function
|
||||||
|
const overHttps = proxyUrl.protocol === 'https:'
|
||||||
|
if (usingSsl) {
|
||||||
|
tunnelAgent = overHttps ? tunnel.httpsOverHttps : tunnel.httpsOverHttp
|
||||||
|
} else {
|
||||||
|
tunnelAgent = overHttps ? tunnel.httpOverHttps : tunnel.httpOverHttp
|
||||||
|
}
|
||||||
|
|
||||||
|
agent = tunnelAgent(agentOptions)
|
||||||
|
this._proxyAgent = agent
|
||||||
|
}
|
||||||
|
|
||||||
|
// if reusing agent across request and tunneling agent isn't assigned create a new agent
|
||||||
|
if (this._keepAlive && !agent) {
|
||||||
|
const options = {keepAlive: this._keepAlive, maxSockets}
|
||||||
|
agent = usingSsl ? new https.Agent(options) : new http.Agent(options)
|
||||||
|
this._agent = agent
|
||||||
|
}
|
||||||
|
|
||||||
|
// if not using private agent and tunnel agent isn't setup then use global agent
|
||||||
|
if (!agent) {
|
||||||
|
agent = usingSsl ? https.globalAgent : http.globalAgent
|
||||||
|
}
|
||||||
|
|
||||||
|
if (usingSsl && this._ignoreSslError) {
|
||||||
|
// we don't want to set NODE_TLS_REJECT_UNAUTHORIZED=0 since that will affect request for entire process
|
||||||
|
// http.RequestOptions doesn't expose a way to modify RequestOptions.agent.options
|
||||||
|
// we have to cast it to any and change it directly
|
||||||
|
agent.options = Object.assign(agent.options || {}, {
|
||||||
|
rejectUnauthorized: false
|
||||||
|
})
|
||||||
|
}
|
||||||
|
|
||||||
|
return agent
|
||||||
|
}
|
||||||
|
|
||||||
|
private async _performExponentialBackoff(retryNumber: number): Promise<void> {
|
||||||
|
retryNumber = Math.min(ExponentialBackoffCeiling, retryNumber)
|
||||||
|
const ms: number = ExponentialBackoffTimeSlice * Math.pow(2, retryNumber)
|
||||||
|
return new Promise(resolve => setTimeout(() => resolve(), ms))
|
||||||
|
}
|
||||||
|
|
||||||
|
private async _processResponse<T>(
|
||||||
|
res: HttpClientResponse,
|
||||||
|
options?: ifm.RequestOptions
|
||||||
|
): Promise<ifm.TypedResponse<T>> {
|
||||||
|
return new Promise<ifm.TypedResponse<T>>(async (resolve, reject) => {
|
||||||
|
const statusCode = res.message.statusCode || 0
|
||||||
|
|
||||||
|
const response: ifm.TypedResponse<T> = {
|
||||||
|
statusCode,
|
||||||
|
result: null,
|
||||||
|
headers: {}
|
||||||
|
}
|
||||||
|
|
||||||
|
// not found leads to null obj returned
|
||||||
|
if (statusCode === HttpCodes.NotFound) {
|
||||||
|
resolve(response)
|
||||||
|
}
|
||||||
|
|
||||||
|
// get the result from the body
|
||||||
|
|
||||||
|
function dateTimeDeserializer(key: any, value: any): any {
|
||||||
|
if (typeof value === 'string') {
|
||||||
|
const a = new Date(value)
|
||||||
|
if (!isNaN(a.valueOf())) {
|
||||||
|
return a
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return value
|
||||||
|
}
|
||||||
|
|
||||||
|
let obj: any
|
||||||
|
let contents: string | undefined
|
||||||
|
|
||||||
|
try {
|
||||||
|
contents = await res.readBody()
|
||||||
|
if (contents && contents.length > 0) {
|
||||||
|
if (options && options.deserializeDates) {
|
||||||
|
obj = JSON.parse(contents, dateTimeDeserializer)
|
||||||
|
} else {
|
||||||
|
obj = JSON.parse(contents)
|
||||||
|
}
|
||||||
|
|
||||||
|
response.result = obj
|
||||||
|
}
|
||||||
|
|
||||||
|
response.headers = res.message.headers
|
||||||
|
} catch (err) {
|
||||||
|
// Invalid resource (contents not json); leaving result obj null
|
||||||
|
}
|
||||||
|
|
||||||
|
// note that 3xx redirects are handled by the http layer.
|
||||||
|
if (statusCode > 299) {
|
||||||
|
let msg: string
|
||||||
|
|
||||||
|
// if exception/error in body, attempt to get better error
|
||||||
|
if (obj && obj.message) {
|
||||||
|
msg = obj.message
|
||||||
|
} else if (contents && contents.length > 0) {
|
||||||
|
// it may be the case that the exception is in the body message as string
|
||||||
|
msg = contents
|
||||||
|
} else {
|
||||||
|
msg = `Failed request: (${statusCode})`
|
||||||
|
}
|
||||||
|
|
||||||
|
const err = new HttpClientError(msg, statusCode)
|
||||||
|
err.result = response.result
|
||||||
|
|
||||||
|
reject(err)
|
||||||
|
} else {
|
||||||
|
resolve(response)
|
||||||
|
}
|
||||||
|
})
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
const lowercaseKeys = (obj: {[index: string]: any}): any =>
|
||||||
|
Object.keys(obj).reduce((c: any, k) => ((c[k.toLowerCase()] = obj[k]), c), {})
|
||||||
@@ -0,0 +1,91 @@
|
|||||||
|
import * as http from 'http'
|
||||||
|
import * as https from 'https'
|
||||||
|
import {HttpClientResponse} from './index'
|
||||||
|
|
||||||
|
export interface HttpClient {
|
||||||
|
options(
|
||||||
|
requestUrl: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
get(
|
||||||
|
requestUrl: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
del(
|
||||||
|
requestUrl: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
post(
|
||||||
|
requestUrl: string,
|
||||||
|
data: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
patch(
|
||||||
|
requestUrl: string,
|
||||||
|
data: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
put(
|
||||||
|
requestUrl: string,
|
||||||
|
data: string,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
sendStream(
|
||||||
|
verb: string,
|
||||||
|
requestUrl: string,
|
||||||
|
stream: NodeJS.ReadableStream,
|
||||||
|
additionalHeaders?: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
request(
|
||||||
|
verb: string,
|
||||||
|
requestUrl: string,
|
||||||
|
data: string | NodeJS.ReadableStream,
|
||||||
|
headers: http.OutgoingHttpHeaders
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
requestRaw(
|
||||||
|
info: RequestInfo,
|
||||||
|
data: string | NodeJS.ReadableStream
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
requestRawWithCallback(
|
||||||
|
info: RequestInfo,
|
||||||
|
data: string | NodeJS.ReadableStream,
|
||||||
|
onResult: (err?: Error, res?: HttpClientResponse) => void
|
||||||
|
): void
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RequestHandler {
|
||||||
|
prepareRequest(options: http.RequestOptions): void
|
||||||
|
canHandleAuthentication(response: HttpClientResponse): boolean
|
||||||
|
handleAuthentication(
|
||||||
|
httpClient: HttpClient,
|
||||||
|
requestInfo: RequestInfo,
|
||||||
|
data: string | NodeJS.ReadableStream | null
|
||||||
|
): Promise<HttpClientResponse>
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RequestInfo {
|
||||||
|
options: http.RequestOptions
|
||||||
|
parsedUrl: URL
|
||||||
|
httpModule: typeof http | typeof https
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface RequestOptions {
|
||||||
|
headers?: http.OutgoingHttpHeaders
|
||||||
|
socketTimeout?: number
|
||||||
|
ignoreSslError?: boolean
|
||||||
|
allowRedirects?: boolean
|
||||||
|
allowRedirectDowngrade?: boolean
|
||||||
|
maxRedirects?: number
|
||||||
|
maxSockets?: number
|
||||||
|
keepAlive?: boolean
|
||||||
|
deserializeDates?: boolean
|
||||||
|
// Allows retries only on Read operations (since writes may not be idempotent)
|
||||||
|
allowRetries?: boolean
|
||||||
|
maxRetries?: number
|
||||||
|
}
|
||||||
|
|
||||||
|
export interface TypedResponse<T> {
|
||||||
|
statusCode: number
|
||||||
|
result: T | null
|
||||||
|
headers: http.IncomingHttpHeaders
|
||||||
|
}
|
||||||
@@ -0,0 +1,60 @@
|
|||||||
|
export function getProxyUrl(reqUrl: URL): URL | undefined {
|
||||||
|
const usingSsl = reqUrl.protocol === 'https:'
|
||||||
|
|
||||||
|
if (checkBypass(reqUrl)) {
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
|
||||||
|
const proxyVar = (() => {
|
||||||
|
if (usingSsl) {
|
||||||
|
return process.env['https_proxy'] || process.env['HTTPS_PROXY']
|
||||||
|
} else {
|
||||||
|
return process.env['http_proxy'] || process.env['HTTP_PROXY']
|
||||||
|
}
|
||||||
|
})()
|
||||||
|
|
||||||
|
if (proxyVar) {
|
||||||
|
return new URL(proxyVar)
|
||||||
|
} else {
|
||||||
|
return undefined
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export function checkBypass(reqUrl: URL): boolean {
|
||||||
|
if (!reqUrl.hostname) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
const noProxy = process.env['no_proxy'] || process.env['NO_PROXY'] || ''
|
||||||
|
if (!noProxy) {
|
||||||
|
return false
|
||||||
|
}
|
||||||
|
|
||||||
|
// Determine the request port
|
||||||
|
let reqPort: number | undefined
|
||||||
|
if (reqUrl.port) {
|
||||||
|
reqPort = Number(reqUrl.port)
|
||||||
|
} else if (reqUrl.protocol === 'http:') {
|
||||||
|
reqPort = 80
|
||||||
|
} else if (reqUrl.protocol === 'https:') {
|
||||||
|
reqPort = 443
|
||||||
|
}
|
||||||
|
|
||||||
|
// Format the request hostname and hostname with port
|
||||||
|
const upperReqHosts = [reqUrl.hostname.toUpperCase()]
|
||||||
|
if (typeof reqPort === 'number') {
|
||||||
|
upperReqHosts.push(`${upperReqHosts[0]}:${reqPort}`)
|
||||||
|
}
|
||||||
|
|
||||||
|
// Compare request host against noproxy
|
||||||
|
for (const upperNoProxyItem of noProxy
|
||||||
|
.split(',')
|
||||||
|
.map(x => x.trim().toUpperCase())
|
||||||
|
.filter(x => x)) {
|
||||||
|
if (upperReqHosts.some(x => x === upperNoProxyItem)) {
|
||||||
|
return true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
return false
|
||||||
|
}
|
||||||
@@ -0,0 +1,11 @@
|
|||||||
|
{
|
||||||
|
"extends": "../../tsconfig.json",
|
||||||
|
"compilerOptions": {
|
||||||
|
"outDir": "./lib",
|
||||||
|
"rootDir": "./src",
|
||||||
|
"moduleResolution": "node"
|
||||||
|
},
|
||||||
|
"include": [
|
||||||
|
"./src"
|
||||||
|
]
|
||||||
|
}
|
||||||
@@ -332,23 +332,9 @@ describe('rmRF', () => {
|
|||||||
await assertExists(filePath)
|
await assertExists(filePath)
|
||||||
|
|
||||||
const fd = await fs.open(filePath, 'r')
|
const fd = await fs.open(filePath, 'r')
|
||||||
|
await io.rmRF(testPath)
|
||||||
|
|
||||||
let worked: boolean
|
await assertNotExists(testPath)
|
||||||
|
|
||||||
try {
|
|
||||||
await io.rmRF(testPath)
|
|
||||||
worked = true
|
|
||||||
} catch (err) {
|
|
||||||
worked = false
|
|
||||||
}
|
|
||||||
|
|
||||||
if (os.platform() === 'win32') {
|
|
||||||
expect(worked).toBe(false)
|
|
||||||
await assertExists(testPath)
|
|
||||||
} else {
|
|
||||||
expect(worked).toBe(true)
|
|
||||||
await assertNotExists(testPath)
|
|
||||||
}
|
|
||||||
|
|
||||||
await fd.close()
|
await fd.close()
|
||||||
await io.rmRF(testPath)
|
await io.rmRF(testPath)
|
||||||
|
|||||||
Generated
+12
-12
@@ -164,9 +164,9 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/minimist": {
|
"node_modules/minimist": {
|
||||||
"version": "1.2.5",
|
"version": "1.2.6",
|
||||||
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
|
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
|
||||||
"integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==",
|
"integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"node_modules/mkdirp": {
|
"node_modules/mkdirp": {
|
||||||
@@ -217,9 +217,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node_modules/pathval": {
|
"node_modules/pathval": {
|
||||||
"version": "1.1.0",
|
"version": "1.1.1",
|
||||||
"resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz",
|
||||||
"integrity": "sha1-uULm1L3mUwBe9rcTYd74cn0GReA=",
|
"integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": "*"
|
"node": "*"
|
||||||
@@ -404,9 +404,9 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"minimist": {
|
"minimist": {
|
||||||
"version": "1.2.5",
|
"version": "1.2.6",
|
||||||
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz",
|
"resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.6.tgz",
|
||||||
"integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==",
|
"integrity": "sha512-Jsjnk4bw3YJqYzbdyBiNsPWHPfO++UGG749Cxs6peCu5Xg4nrena6OVxOYxrQTqww0Jmwt+Ref8rggumkTLz9Q==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"mkdirp": {
|
"mkdirp": {
|
||||||
@@ -450,9 +450,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"pathval": {
|
"pathval": {
|
||||||
"version": "1.1.0",
|
"version": "1.1.1",
|
||||||
"resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/pathval/-/pathval-1.1.1.tgz",
|
||||||
"integrity": "sha1-uULm1L3mUwBe9rcTYd74cn0GReA=",
|
"integrity": "sha512-Dp6zGqpTdETdR63lehJYPeIOqpiNBNtc7BpWSLrOje7UaIsE5aY92r/AunQA7rsXvet3lrJ3JnZX29UPTKXyKQ==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"propagate": {
|
"propagate": {
|
||||||
|
|||||||
@@ -9,5 +9,5 @@ if [[ -z "$name" ]]; then
|
|||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
lerna create @actions/$name
|
npx lerna create @actions/$name
|
||||||
cp packages/toolkit/tsconfig.json packages/$name/tsconfig.json
|
cp packages/core/tsconfig.json packages/$name/tsconfig.json
|
||||||
Reference in New Issue
Block a user