-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(appsync): add L2 constructs for AWS AppSync Events (#32505)
### Issue # (if applicable) Closes #32004 ### Reason for this change This is in support of AWS AppSync Events. ### Description of changes - New constructs for `EventApi` and `ChannelNamespace` to support AWS AppSync Events. - Create common file for authorization config across `EventApi` and `GraphqlApi` constructs. - Create common file for common resources across `EventApi` and `GraphqlApi` constructs. ### Description of how you validated changes Added both unit and integration tests for AWS AppSync Event API changes. ### Contributors @mazyu36 @onlybakam @kwwendt ### Checklist - [X] My code adheres to the [CONTRIBUTING GUIDE](https://github.com/aws/aws-cdk/blob/main/CONTRIBUTING.md) and [DESIGN GUIDELINES](https://github.com/aws/aws-cdk/blob/main/docs/DESIGN_GUIDELINES.md) ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --------- Co-authored-by: onlybakam <onlybakam@gmail.com> Co-authored-by: GZ <hz351086153@gmail.com> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
- Loading branch information
1 parent
b3975c5
commit 9ae1d34
Showing
79 changed files
with
64,424 additions
and
257 deletions.
There are no files selected for viewing
3 changes: 3 additions & 0 deletions
3
...ramework-integ/test/aws-appsync/test/integ-assets/appsync-js-channel-namespace-handler.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,3 @@ | ||
export function onPublish(ctx) { | ||
return ctx.events.filter((event) => event.payload.odds > 0) | ||
} |
207 changes: 207 additions & 0 deletions
207
...ting/framework-integ/test/aws-appsync/test/integ-assets/eventapi-grant-assertion/index.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,207 @@ | ||
// Reference: https://github.com/onlybakam/appsync-events-client-tutorial/blob/main/app/signer-smithy.mjs | ||
|
||
import { HttpRequest } from '@smithy/protocol-http' | ||
import { SignatureV4 } from '@smithy/signature-v4' | ||
import { fromNodeProviderChain } from '@aws-sdk/credential-providers' | ||
import { Sha256 } from '@aws-crypto/sha256-js' | ||
|
||
// The default headers to to sign the request | ||
const DEFAULT_HEADERS = { | ||
accept: 'application/json, text/javascript', | ||
'content-encoding': 'amz-1.0', | ||
'content-type': 'application/json; charset=UTF-8', | ||
} | ||
|
||
const AWS_APPSYNC_EVENTS_SUBPROTOCOL = 'aws-appsync-event-ws'; | ||
const realtimeUrl = process.env.EVENT_API_REALTIME_URL; | ||
const httpUrl = process.env.EVENT_API_HTTP_URL; | ||
const region = process.env.AWS_REGION; | ||
|
||
/** | ||
* Returns a signed authorization object | ||
* | ||
* @param {string} httpDomain the AppSync Event API HTTP domain | ||
* @param {string} region the AWS region of your API | ||
* @param {string} [body] the body of the request | ||
* @returns {Object} | ||
*/ | ||
async function signWithAWSV4(httpDomain, region, body) { | ||
const signer = new SignatureV4({ | ||
credentials: fromNodeProviderChain(), | ||
service: 'appsync', | ||
region, | ||
sha256: Sha256, | ||
}) | ||
|
||
const url = new URL(`https://${httpDomain}/event`) | ||
const request = new HttpRequest({ | ||
method: 'POST', | ||
headers: { | ||
...DEFAULT_HEADERS, | ||
host: url.hostname, | ||
}, | ||
body: body ?? '{}', | ||
hostname: url.hostname, | ||
path: url.pathname, | ||
}) | ||
|
||
const signedHttpRequest = await signer.sign(request) | ||
|
||
return { | ||
host: signedHttpRequest.hostname, | ||
...signedHttpRequest.headers, | ||
} | ||
} | ||
|
||
/** | ||
* Returns a header value for the SubProtocol header | ||
* @param {string} httpDomain the AppSync Event API HTTP domain | ||
* @param {string} region the AWS region of your API | ||
* @returns string a header string | ||
*/ | ||
async function getAuthProtocolForIAM(httpDomain, region) { | ||
const signed = await signWithAWSV4(httpDomain, region) | ||
const based64UrlHeader = btoa(JSON.stringify(signed)) | ||
.replace(/\+/g, '-') // Convert '+' to '-' | ||
.replace(/\//g, '_') // Convert '/' to '_' | ||
.replace(/=+$/, '') // Remove padding `=` | ||
return `header-${based64UrlHeader}` | ||
} | ||
|
||
/** | ||
* Returns a Promise after a delay | ||
* | ||
* @param {int} ms milliseconds to delay | ||
* @returns {Promise} | ||
*/ | ||
function sleep(ms) { | ||
return new Promise(resolve => setTimeout(resolve, ms)); | ||
} | ||
|
||
/** | ||
* Initiates a subscription to a channel and returns the response | ||
* | ||
* @param {string} channel the channel to subscribe to | ||
* @param {boolean} triggerPub whether to also publish in the method | ||
* @returns {Object} | ||
*/ | ||
async function subscribe(channel, triggerPub=false) { | ||
const response = {}; | ||
const auth = await getAuthProtocolForIAM(httpUrl, region) | ||
const socket = await new Promise((resolve, reject) => { | ||
const socket = new WebSocket( | ||
`wss://${realtimeUrl}/event/realtime`, | ||
[AWS_APPSYNC_EVENTS_SUBPROTOCOL, auth], | ||
{ headers: { ...DEFAULT_HEADERS } }, | ||
) | ||
|
||
socket.onopen = () => { | ||
socket.send(JSON.stringify({ type: 'connection_init' })) | ||
console.log("Initialize connection"); | ||
resolve(socket) | ||
} | ||
|
||
socket.onclose = (evt) => reject(new Error(evt.reason)) | ||
socket.onmessage = (event) => { | ||
const payload = JSON.parse(event.data); | ||
console.log('=>', payload); | ||
if (payload.type === 'subscribe_success') { | ||
console.log('Connection established') | ||
response.statusCode = 200; | ||
response.msg = 'subscribe_success'; | ||
} else if (payload.type === 'data') { | ||
console.log('Data received'); | ||
response.pubStatusCode = 200; | ||
response.pubMsg = JSON.parse(payload.event).message; | ||
} else if (payload.type === "subscribe_error") { | ||
console.log(payload); | ||
if (payload.errors.some((error) => error.errorType === "UnauthorizedException")) { | ||
console.log("Error received"); | ||
response.statusCode = 401; | ||
response.msg = "UnauthorizedException"; | ||
} else if (payload.errors.some(error => error.errorType === 'AccessDeniedException')) { | ||
console.log('Error received'); | ||
response.statusCode = 403; | ||
response.msg = 'Forbidden'; | ||
} else { | ||
console.log("Error received"); | ||
response.statusCode = 400; | ||
response.msg = payload.errors[0].errorType; | ||
} | ||
} | ||
} | ||
socket.onerror = (event) => console.log(event) | ||
}); | ||
|
||
const subChannel = `/${channel}/*`; | ||
socket.send(JSON.stringify({ | ||
type: 'subscribe', | ||
id: crypto.randomUUID(), | ||
channel: subChannel, | ||
authorization: await signWithAWSV4(httpUrl, region, JSON.stringify({ channel: subChannel })), | ||
})); | ||
|
||
if (triggerPub) { | ||
await sleep(1000); | ||
await publish(channel); | ||
} | ||
await sleep(3000); | ||
return response; | ||
} | ||
|
||
/** | ||
* Publishes to a channel and returns the response | ||
* | ||
* @param {string} channel the channel to publish to | ||
* @returns {Object} | ||
*/ | ||
async function publish(channel) { | ||
const event = { | ||
"channel": `/${channel}/test`, | ||
"events": [ | ||
JSON.stringify({message:'Hello World!'}) | ||
] | ||
} | ||
|
||
const response = await fetch(`https://${httpUrl}/event`, { | ||
method: 'POST', | ||
headers: await signWithAWSV4(httpUrl, region, JSON.stringify(event)), | ||
body: JSON.stringify(event) | ||
}); | ||
|
||
if (!response.ok) { | ||
return { | ||
statusCode: response.status, | ||
msg: response.statusText | ||
} | ||
} | ||
const output = await response.json(); | ||
return { | ||
statusCode: 200, | ||
msg: output.successful.length == 1 ? 'publish_success' : 'publish_fail', | ||
} | ||
} | ||
|
||
/** | ||
* | ||
* @param {Object} event json object that contains the action and channel | ||
* @returns {Object} | ||
*/ | ||
exports.handler = async function(event) { | ||
const pubSubAction = event.action; | ||
const channel = event.channel; | ||
|
||
if (pubSubAction === 'publish') { | ||
const res = await publish(channel); | ||
console.log(res); | ||
return res; | ||
} else if (pubSubAction === 'subscribe') { | ||
const res = await subscribe(channel, false); | ||
console.log(res); | ||
return res; | ||
} else if (pubSubAction === 'pubSub') { | ||
const res = await subscribe(channel, true); | ||
console.log(res); | ||
return res; | ||
} | ||
}; |
45 changes: 45 additions & 0 deletions
45
...est/integ.appsync-channel-namespace.js.snapshot/EventApiChannelNamespaceStack.assets.json
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
Oops, something went wrong.