Skip to content

Commit

Permalink
Renamed *RequestOrigin*() methods to *Origin*() to make them a li…
Browse files Browse the repository at this point in the history 
…ttle less verbose
  • Loading branch information
@magnetikonline
magnetikonline committed Jan 19, 2022
1 parent 376a261 commit d37bd52
Show file tree
Hide file tree
Showing 5 changed files with 184 additions and 184 deletions.
98 changes: 49 additions & 49 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,15 +20,15 @@ Npm module providing a harness for authoring unit or integration tests against N
- [setUri(uri)](#seturiuri)
- [setBody(data[,isTruncated])](#setbodydataistruncated)
- [addRequestHttpHeader(key,value)](#addrequesthttpheaderkeyvalue)
- [setRequestOriginCustom(domainName[,path])](#setrequestorigincustomdomainnamepath)
- [setRequestOriginKeepaliveTimeout(timeout)](#setrequestoriginkeepalivetimeouttimeout)
- [setRequestOriginPort(port)](#setrequestoriginportport)
- [setRequestOriginHttps(isHttps)](#setrequestoriginhttpsishttps)
- [setRequestOriginReadTimeout(timeout)](#setrequestoriginreadtimeouttimeout)
- [setRequestOriginSslProtocolList(protocolList)](#setrequestoriginsslprotocollistprotocollist)
- [setRequestOriginS3(domainName[,region][,path])](#setrequestorigins3domainnameregionpath)
- [setRequestOriginOAI(isOAI)](#setrequestoriginoaiisoai)
- [addRequestOriginHttpHeader(key,value)](#addrequestoriginhttpheaderkeyvalue)
- [setOriginCustom(domainName[,path])](#setorigincustomdomainnamepath)
- [setOriginKeepaliveTimeout(timeout)](#setoriginkeepalivetimeouttimeout)
- [setOriginPort(port)](#setoriginportport)
- [setOriginHttps(isHttps)](#setoriginhttpsishttps)
- [setOriginReadTimeout(timeout)](#setoriginreadtimeouttimeout)
- [setOriginSslProtocolList(protocolList)](#setoriginsslprotocollistprotocollist)
- [setOriginS3(domainName[,region][,path])](#setorigins3domainnameregionpath)
- [setOriginOAI(isOAI)](#setoriginoaiisoai)
- [addOriginHttpHeader(key,value)](#addoriginhttpheaderkeyvalue)
- [setResponseHttpStatusCode(code)](#setresponsehttpstatuscodecode)
- [addResponseHttpHeader(key,value)](#addresponsehttpheaderkeyvalue)
- [execute(handler)](#executehandler)
Expand Down Expand Up @@ -110,7 +110,7 @@ async function myTest() {
.setHttpMethod('POST')
.setUri('/path/to/api/route')
.addRequestHttpHeader('X-Fancy-Header','apples')
.setRequestOriginS3('mybucket.s3.ap-southeast-2.amazonaws.com','ap-southeast-2');
.setOriginS3('mybucket.s3.ap-southeast-2.amazonaws.com','ap-southeast-2');

const resp = await oReq.execute(
// example edge function
Expand Down Expand Up @@ -153,15 +153,15 @@ Available methods:
- [setUri(uri)](#seturiuri)
- [setBody(data[,isTruncated])](#setbodydataistruncated)
- [addRequestHttpHeader(key,value)](#addrequesthttpheaderkeyvalue)
- [setRequestOriginCustom(domainName[,path])](#setrequestorigincustomdomainnamepath)
- [setRequestOriginKeepaliveTimeout(timeout)](#setrequestoriginkeepalivetimeouttimeout)
- [setRequestOriginPort(port)](#setrequestoriginportport)
- [setRequestOriginHttps(isHttps)](#setrequestoriginhttpsishttps)
- [setRequestOriginReadTimeout(timeout)](#setrequestoriginreadtimeouttimeout)
- [setRequestOriginSslProtocolList(protocolList)](#setrequestoriginsslprotocollistprotocollist)
- [setRequestOriginS3(domainName[,region][,path])](#setrequestorigins3domainnameregionpath)
- [setRequestOriginOAI(isOAI)](#setrequestoriginoaiisoai)
- [addRequestOriginHttpHeader(key,value)](#addrequestoriginhttpheaderkeyvalue)
- [setOriginCustom(domainName[,path])](#setorigincustomdomainnamepath)
- [setOriginKeepaliveTimeout(timeout)](#setoriginkeepalivetimeouttimeout)
- [setOriginPort(port)](#setoriginportport)
- [setOriginHttps(isHttps)](#setoriginhttpsishttps)
- [setOriginReadTimeout(timeout)](#setoriginreadtimeouttimeout)
- [setOriginSslProtocolList(protocolList)](#setoriginsslprotocollistprotocollist)
- [setOriginS3(domainName[,region][,path])](#setorigins3domainnameregionpath)
- [setOriginOAI(isOAI)](#setoriginoaiisoai)
- [addOriginHttpHeader(key,value)](#addoriginhttpheaderkeyvalue)
- [execute(handler)](#executehandler)

### `OriginResponse()`
Expand Down Expand Up @@ -206,15 +206,15 @@ Available methods:
- [setQuerystring(qs)](#setquerystringqs)
- [setUri(uri)](#seturiuri)
- [addRequestHttpHeader(key,value)](#addrequesthttpheaderkeyvalue)
- [setRequestOriginCustom(domainName[,path])](#setrequestorigincustomdomainnamepath)
- [setRequestOriginKeepaliveTimeout(timeout)](#setrequestoriginkeepalivetimeouttimeout)
- [setRequestOriginPort(port)](#setrequestoriginportport)
- [setRequestOriginHttps(isHttps)](#setrequestoriginhttpsishttps)
- [setRequestOriginReadTimeout(timeout)](#setrequestoriginreadtimeouttimeout)
- [setRequestOriginSslProtocolList(protocolList)](#setrequestoriginsslprotocollistprotocollist)
- [setRequestOriginS3(domainName[,region][,path])](#setrequestorigins3domainnameregionpath)
- [setRequestOriginOAI(isOAI)](#setrequestoriginoaiisoai)
- [addRequestOriginHttpHeader(key,value)](#addrequestoriginhttpheaderkeyvalue)
- [setOriginCustom(domainName[,path])](#setorigincustomdomainnamepath)
- [setOriginKeepaliveTimeout(timeout)](#setoriginkeepalivetimeouttimeout)
- [setOriginPort(port)](#setoriginportport)
- [setOriginHttps(isHttps)](#setoriginhttpsishttps)
- [setOriginReadTimeout(timeout)](#setoriginreadtimeouttimeout)
- [setOriginSslProtocolList(protocolList)](#setoriginsslprotocollistprotocollist)
- [setOriginS3(domainName[,region][,path])](#setorigins3domainnameregionpath)
- [setOriginOAI(isOAI)](#setoriginoaiisoai)
- [addOriginHttpHeader(key,value)](#addoriginhttpheaderkeyvalue)
- [setResponseHttpStatusCode(code)](#setresponsehttpstatuscodecode)
- [addResponseHttpHeader(key,value)](#addresponsehttpheaderkeyvalue)
- [execute(handler)](#executehandler)
Expand Down Expand Up @@ -391,29 +391,29 @@ harness
*/
```

### `setRequestOriginCustom(domainName[,path])`
### `setOriginCustom(domainName[,path])`

### `setRequestOriginKeepaliveTimeout(timeout)`
### `setOriginKeepaliveTimeout(timeout)`

### `setRequestOriginPort(port)`
### `setOriginPort(port)`

### `setRequestOriginHttps(isHttps)`
### `setOriginHttps(isHttps)`

### `setRequestOriginReadTimeout(timeout)`
### `setOriginReadTimeout(timeout)`

### `setRequestOriginSslProtocolList(protocolList)`
### `setOriginSslProtocolList(protocolList)`

Methods to define a custom origin property set for the request event payload:

```js
const harness = new edgy.EVENT_TYPE_CONSTRUCTOR();
harness
.setRequestOriginCustom('example.org','/custom/origin/path')
.setRequestOriginKeepaliveTimeout(35)
.setRequestOriginPort(1234)
.setRequestOriginHttps(true)
.setRequestOriginReadTimeout(25)
.setRequestOriginSslProtocolList(['TLSv1.1','TLSv1.2']);
.setOriginCustom('example.org','/custom/origin/path')
.setOriginKeepaliveTimeout(35)
.setOriginPort(1234)
.setOriginHttps(true)
.setOriginReadTimeout(25)
.setOriginSslProtocolList(['TLSv1.1','TLSv1.2']);

/*
{
Expand Down Expand Up @@ -441,20 +441,20 @@ harness
*/
```

### `setRequestOriginS3(domainName[,region][,path])`
### `setOriginS3(domainName[,region][,path])`

### `setRequestOriginOAI(isOAI)`
### `setOriginOAI(isOAI)`

Methods to define an S3 origin property set for the request event payload:

```js
const harness = new edgy.EVENT_TYPE_CONSTRUCTOR();
harness
.setRequestOriginS3(
.setOriginS3(
'mybucket.s3.ap-southeast-2.amazonaws.com',
'ap-southeast-2',
'/s3/bucket/path')
.setRequestOriginOAI(true);
.setOriginOAI(true);

/*
{
Expand All @@ -479,19 +479,19 @@ harness
*/
```

### `addRequestOriginHttpHeader(key,value)`
### `addOriginHttpHeader(key,value)`

Adds HTTP header items to the request origin event payload for both [custom](#setrequestorigincustomdomainnamepath) and [s3](#setrequestorigins3domainnameregionpath) targets:
Adds HTTP header items to the request origin event payload for both [custom](#setorigincustomdomainnamepath) and [s3](#setorigins3domainnameregionpath) targets:

```js
const harness = new edgy.EVENT_TYPE_CONSTRUCTOR();
harness
.setRequestOriginS3(
.setOriginS3(
'mybucket.s3.ap-southeast-2.amazonaws.com',
'ap-southeast-2',
'/s3/bucket/path')
.addRequestOriginHttpHeader('X-Custom-Header','apples')
.addRequestOriginHttpHeader('X-Custom-Header','oranges');
.addOriginHttpHeader('X-Custom-Header','apples')
.addOriginHttpHeader('X-Custom-Header','oranges');

/*
{
Expand Down
60 changes: 30 additions & 30 deletions lib.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ function buildEventBase(eventType,hasOrigin,hasResponse) {
return event;
}

function setEdgeEventRequestOriginCustom(event,domainName,path) {
function setEdgeEventOriginCustom(event,domainName,path) {
cfEventData(event).request.origin = {
custom: {
customHeaders: {},
Expand All @@ -227,28 +227,28 @@ function setEdgeEventRequestOriginCustom(event,domainName,path) {
};
}

function setEdgeEventRequestOriginKeepaliveTimeout(event,timeout) {
verifyEdgeEventRequestOriginModeCustom(event);
function setEdgeEventOriginKeepaliveTimeout(event,timeout) {
verifyEdgeEventOriginModeCustom(event);
cfEventData(event).request.origin.custom.keepaliveTimeout = intOrZero(timeout);
}

function setEdgeEventRequestOriginPort(event,port) {
verifyEdgeEventRequestOriginModeCustom(event);
function setEdgeEventOriginPort(event,port) {
verifyEdgeEventOriginModeCustom(event);
cfEventData(event).request.origin.custom.port = intOrZero(port);
}

function setEdgeEventRequestOriginHttps(event,isHttps) {
verifyEdgeEventRequestOriginModeCustom(event);
function setEdgeEventOriginHttps(event,isHttps) {
verifyEdgeEventOriginModeCustom(event);
cfEventData(event).request.origin.custom.protocol = (!!isHttps) ? 'https' : 'http';
}

function setEdgeEventRequestOriginReadTimeout(event,timeout) {
verifyEdgeEventRequestOriginModeCustom(event);
function setEdgeEventOriginReadTimeout(event,timeout) {
verifyEdgeEventOriginModeCustom(event);
cfEventData(event).request.origin.custom.readTimeout = intOrZero(timeout);
}

function setEdgeEventRequestOriginSslProtocolList(event,protocolList) {
verifyEdgeEventRequestOriginModeCustom(event);
function setEdgeEventOriginSslProtocolList(event,protocolList) {
verifyEdgeEventOriginModeCustom(event);

if (!Array.isArray(protocolList)) {
throw new Error('protocol list must be an array');
Expand All @@ -262,7 +262,7 @@ function setEdgeEventRequestOriginSslProtocolList(event,protocolList) {
cfEventData(event).request.origin.custom.sslProtocols = resultList;
}

function setEdgeEventRequestOriginS3(event,domainName,region,path) {
function setEdgeEventOriginS3(event,domainName,region,path) {
cfEventData(event).request.origin = {
s3: {
authMethod: 'none',
Expand All @@ -274,13 +274,13 @@ function setEdgeEventRequestOriginS3(event,domainName,region,path) {
};
}

function setEdgeEventRequestOriginOAI(event,isOAI) {
verifyEdgeEventRequestOriginModeS3(event);
function setEdgeEventOriginOAI(event,isOAI) {
verifyEdgeEventOriginModeS3(event);
cfEventData(event).request.origin.s3.authMethod = (!!isOAI) ? 'origin-access-identity' : 'none';
}

// addEdgeEventRequestOriginHttpHeader() is the only origin method shared by custom/S3 modes
function addEdgeEventRequestOriginHttpHeader(event,key,value) {
// addEdgeEventOriginHttpHeader() is the only origin method shared by custom/S3 modes
function addEdgeEventOriginHttpHeader(event,key,value) {
const origin = cfEventData(event).request.origin;
if (origin.hasOwnProperty('custom')) {
addEdgeEventHttpHeaderKeyValue(origin.custom.customHeaders,key,value);
Expand All @@ -292,20 +292,20 @@ function addEdgeEventRequestOriginHttpHeader(event,key,value) {
return;
}

throw new Error('an origin mode must be set via [setRequestOriginCustom()/setRequestOriginS3()]');
throw new Error('an origin mode must be set via [setOriginCustom()/setOriginS3()]');
}

function verifyEdgeEventRequestOriginModeCustom(event) {
function verifyEdgeEventOriginModeCustom(event) {
const origin = cfEventData(event).request.origin;
if ((origin === undefined) || !origin.hasOwnProperty('custom')) {
throw new Error('method only valid in custom origin [setRequestOriginCustom()] mode');
throw new Error('method only valid in custom origin [setOriginCustom()] mode');
}
}

function verifyEdgeEventRequestOriginModeS3(event) {
function verifyEdgeEventOriginModeS3(event) {
const origin = cfEventData(event).request.origin;
if ((origin === undefined) || !origin.hasOwnProperty('s3')) {
throw new Error('method only valid in S3 origin [setRequestOriginS3()] mode');
throw new Error('method only valid in S3 origin [setOriginS3()] mode');
}
}

Expand Down Expand Up @@ -626,15 +626,15 @@ module.exports = {
EdgeEventResponseBase,

// functions for mutating `event.Records[0].cf.request.origin.[custom|s3]`
setEdgeEventRequestOriginCustom,
setEdgeEventRequestOriginKeepaliveTimeout,
setEdgeEventRequestOriginPort,
setEdgeEventRequestOriginHttps,
setEdgeEventRequestOriginReadTimeout,
setEdgeEventRequestOriginSslProtocolList,
setEdgeEventRequestOriginS3,
setEdgeEventRequestOriginOAI,
addEdgeEventRequestOriginHttpHeader,
setEdgeEventOriginCustom,
setEdgeEventOriginKeepaliveTimeout,
setEdgeEventOriginPort,
setEdgeEventOriginHttps,
setEdgeEventOriginReadTimeout,
setEdgeEventOriginSslProtocolList,
setEdgeEventOriginS3,
setEdgeEventOriginOAI,
addEdgeEventOriginHttpHeader,

// functions for verifying returned Lambda@Edge function payloads
payloadVerifyRequest,
Expand Down
Loading

0 comments on commit d37bd52

Please sign in to comment.