From e33e4afbf0e290029c9887f271ae2ad6a4a65269 Mon Sep 17 00:00:00 2001 From: DwayneCoussement Date: Tue, 2 Mar 2021 22:05:50 +0100 Subject: [PATCH] Add support for AppSync events. (#187) motivation: Support AWS AppSync events changes: add Codable models for AppSync events --- Sources/AWSLambdaEvents/AppSync.swift | 169 +++++++++++ Tests/AWSLambdaEventsTests/AppSyncTests.swift | 271 ++++++++++++++++++ 2 files changed, 440 insertions(+) create mode 100644 Sources/AWSLambdaEvents/AppSync.swift create mode 100644 Tests/AWSLambdaEventsTests/AppSyncTests.swift diff --git a/Sources/AWSLambdaEvents/AppSync.swift b/Sources/AWSLambdaEvents/AppSync.swift new file mode 100644 index 00000000..002ab68f --- /dev/null +++ b/Sources/AWSLambdaEvents/AppSync.swift @@ -0,0 +1,169 @@ +//===----------------------------------------------------------------------===// +// +// This source file is part of the SwiftAWSLambdaRuntime open source project +// +// Copyright (c) 2017-2020 Apple Inc. and the SwiftAWSLambdaRuntime project authors +// Licensed under Apache License v2.0 +// +// See LICENSE.txt for license information +// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors +// +// SPDX-License-Identifier: Apache-2.0 +// +//===----------------------------------------------------------------------===// + +// https://docs.aws.amazon.com/appsync/latest/devguide/resolver-context-reference.html +public enum AppSync { + public struct Event: Decodable { + public let arguments: [String: ArgumentValue] + + public enum ArgumentValue: Codable { + case string(String) + case dictionary([String: String]) + + public init(from decoder: Decoder) throws { + let container = try decoder.singleValueContainer() + if let strValue = try? container.decode(String.self) { + self = .string(strValue) + } else if let dictionaryValue = try? container.decode([String: String].self) { + self = .dictionary(dictionaryValue) + } else { + throw DecodingError.dataCorruptedError(in: container, debugDescription: """ + Unexpected AppSync argument. + Expected a String or a Dictionary. + """) + } + } + + public func encode(to encoder: Encoder) throws { + var container = encoder.singleValueContainer() + switch self { + case .dictionary(let array): + try container.encode(array) + case .string(let str): + try container.encode(str) + } + } + } + + public let request: Request + public struct Request: Decodable { + let headers: HTTPHeaders + } + + public let source: [String: String]? + public let stash: [String: String]? + + public let info: Info + public struct Info: Codable { + public var selectionSetList: [String] + public var selectionSetGraphQL: String + public var parentTypeName: String + public var fieldName: String + public var variables: [String: String] + } + + public let identity: Identity? + public enum Identity: Codable { + case iam(IAMIdentity) + case cognitoUserPools(CognitoUserPoolIdentity) + + public struct IAMIdentity: Codable { + public let accountId: String + public let cognitoIdentityPoolId: String + public let cognitoIdentityId: String + public let sourceIp: [String] + public let username: String? + public let userArn: String + public let cognitoIdentityAuthType: String + public let cognitoIdentityAuthProvider: String + } + + public struct CognitoUserPoolIdentity: Codable { + public let defaultAuthStrategy: String + public let issuer: String + public let sourceIp: [String] + public let sub: String + public let username: String? + + public struct Claims { + let sub: String + let emailVerified: Bool + let iss: String + let phoneNumberVerified: Bool + let cognitoUsername: String + let aud: String + let eventId: String + let tokenUse: String + let authTime: Int + let phoneNumber: String? + let exp: Int + let iat: Int + let email: String? + + enum CodingKeys: String, CodingKey { + case sub + case emailVerified = "email_verified" + case iss + case phoneNumberVerified = "phone_number_verified" + case cognitoUsername = "cognito:username" + case aud + case eventId = "event_id" + case tokenUse = "token_use" + case authTime = "auth_time" + case phoneNumber = "phone_number" + case exp + case iat + case email + } + } + } + + public init(from decoder: Decoder) throws { + let container = try decoder.singleValueContainer() + if let iamIdentity = try? container.decode(IAMIdentity.self) { + self = .iam(iamIdentity) + } else if let cognitoIdentity = try? container.decode(CognitoUserPoolIdentity.self) { + self = .cognitoUserPools(cognitoIdentity) + } else { + throw DecodingError.dataCorruptedError(in: container, debugDescription: """ + Unexpected Identity argument. + Expected a IAM Identity or a Cognito User Pool Identity. + """) + } + } + + public func encode(to encoder: Encoder) throws { + var container = encoder.singleValueContainer() + switch self { + case .iam(let iamIdentity): + try container.encode(iamIdentity) + case .cognitoUserPools(let cognitoUserPool): + try container.encode(cognitoUserPool) + } + } + } + } +} + +public extension AppSync { + enum Response: Encodable { + public func encode(to encoder: Encoder) throws { + var container = encoder.singleValueContainer() + switch self { + case .array(let array): + try container.encode(array) + case .object(let object): + try container.encode(object) + case .dictionary(let dictionary): + try container.encode(dictionary) + } + } + + case object(ResultType) + case array([ResultType]) + case dictionary([String: ResultType]) + } + + typealias JSONStringResponse = Response +} diff --git a/Tests/AWSLambdaEventsTests/AppSyncTests.swift b/Tests/AWSLambdaEventsTests/AppSyncTests.swift new file mode 100644 index 00000000..5aeda17d --- /dev/null +++ b/Tests/AWSLambdaEventsTests/AppSyncTests.swift @@ -0,0 +1,271 @@ +//===----------------------------------------------------------------------===// +// +// This source file is part of the SwiftAWSLambdaRuntime open source project +// +// Copyright (c) 2017-2020 Apple Inc. and the SwiftAWSLambdaRuntime project authors +// Licensed under Apache License v2.0 +// +// See LICENSE.txt for license information +// See CONTRIBUTORS.txt for the list of SwiftAWSLambdaRuntime project authors +// +// SPDX-License-Identifier: Apache-2.0 +// +//===----------------------------------------------------------------------===// + +@testable import AWSLambdaEvents +import XCTest + +class AppSyncTests: XCTestCase { + static let exampleEventBody = """ + { + "arguments": { + "id": "my identifier" + }, + "identity": { + "claims": { + "sub": "192879fc-a240-4bf1-ab5a-d6a00f3063f9", + "email_verified": true, + "iss": "https://cognito-idp.us-west-2.amazonaws.com/us-west-xxxxxxxxxxx", + "phone_number_verified": false, + "cognito:username": "jdoe", + "aud": "7471s60os7h0uu77i1tk27sp9n", + "event_id": "bc334ed8-a938-4474-b644-9547e304e606", + "token_use": "id", + "auth_time": 1599154213, + "phone_number": "+19999999999", + "exp": 1599157813, + "iat": 1599154213, + "email": "jdoe@email.com" + }, + "defaultAuthStrategy": "ALLOW", + "groups": null, + "issuer": "https://cognito-idp.us-west-2.amazonaws.com/us-west-xxxxxxxxxxx", + "sourceIp": [ + "1.1.1.1" + ], + "sub": "192879fc-a240-4bf1-ab5a-d6a00f3063f9", + "username": "jdoe" + }, + "source": null, + "request": { + "headers": { + "x-forwarded-for": "1.1.1.1, 2.2.2.2", + "cloudfront-viewer-country": "US", + "cloudfront-is-tablet-viewer": "false", + "via": "2.0 xxxxxxxxxxxxxxxx.cloudfront.net (CloudFront)", + "cloudfront-forwarded-proto": "https", + "origin": "https://us-west-1.console.aws.amazon.com", + "content-length": "217", + "accept-language": "en-US,en;q=0.9", + "host": "xxxxxxxxxxxxxxxx.appsync-api.us-west-1.amazonaws.com", + "x-forwarded-proto": "https", + "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/85.0.4183.83 Safari/537.36", + "accept": "*/*", + "cloudfront-is-mobile-viewer": "false", + "cloudfront-is-smarttv-viewer": "false", + "accept-encoding": "gzip, deflate, br", + "referer": "https://us-west-1.console.aws.amazon.com/appsync/home?region=us-west-1", + "content-type": "application/json", + "sec-fetch-mode": "cors", + "x-amz-cf-id": "3aykhqlUwQeANU-HGY7E_guV5EkNeMMtwyOgiA==", + "x-amzn-trace-id": "Root=1-5f512f51-fac632066c5e848ae714", + "authorization": "eyJraWQiOiJScWFCSlJqYVJlM0hrSnBTUFpIcVRXazNOW...", + "sec-fetch-dest": "empty", + "x-amz-user-agent": "AWS-Console-AppSync/", + "cloudfront-is-desktop-viewer": "true", + "sec-fetch-site": "cross-site", + "x-forwarded-port": "443" + } + }, + "prev": null, + "info": { + "selectionSetList": [ + "id", + "field1", + "field2" + ], + "selectionSetGraphQL": "{ id }", + "parentTypeName": "Mutation", + "fieldName": "createSomething", + "variables": {} + }, + "stash": {} + } + """ + + // MARK: Decoding + + func testRequestDecodingExampleEvent() { + let data = AppSyncTests.exampleEventBody.data(using: .utf8)! + var event: AppSync.Event? + XCTAssertNoThrow(event = try JSONDecoder().decode(AppSync.Event.self, from: data)) + + XCTAssertNotNil(event?.arguments) + XCTAssertEqual(event?.arguments["id"], .string("my identifier")) + XCTAssertEqual(event?.info.fieldName, "createSomething") + XCTAssertEqual(event?.info.parentTypeName, "Mutation") + XCTAssertEqual(event?.info.selectionSetList, ["id", "field1", "field2"]) + XCTAssertEqual(event?.request.headers["accept-language"], "en-US,en;q=0.9") + + switch event?.identity { + case .cognitoUserPools(let cognitoIdentity): + XCTAssertEqual(cognitoIdentity.defaultAuthStrategy, "ALLOW") + XCTAssertEqual(cognitoIdentity.issuer, "https://cognito-idp.us-west-2.amazonaws.com/us-west-xxxxxxxxxxx") + XCTAssertEqual(cognitoIdentity.sourceIp, ["1.1.1.1"]) + XCTAssertEqual(cognitoIdentity.username, "jdoe") + XCTAssertEqual(cognitoIdentity.sub, "192879fc-a240-4bf1-ab5a-d6a00f3063f9") + default: + XCTAssertTrue(false, "a cognito identity was expected, but didn't find one.") + } + } + + func testRequestDecodingEventWithSource() { + let eventBody = """ + { + "arguments": {}, + "identity": null, + "source": { + "name": "Hello", + "id": "1" + }, + "request": { + "headers": { + "x-forwarded-for": "1.1.1.1, 2.2.2.2", + "accept-encoding": "gzip, deflate, br", + "cloudfront-viewer-country": "CA", + "cloudfront-is-tablet-viewer": "false", + "referer": "https://us-west-2.console.aws.amazon.com/", + "via": "2.0 xxxxxx.cloudfront.net (CloudFront)", + "cloudfront-forwarded-proto": "https", + "origin": "https://us-west-2.console.aws.amazon.com", + "x-api-key": "xxxxxxxxxxxxxxxxxxxxx", + "content-type": "application/json", + "x-amzn-trace-id": "Root=1-5fcd9a24-364c62405b418bd53c7984ce", + "x-amz-cf-id": "3aykhqlUwQeANU-HGY7E_guV5EkNeMMtwyOgiA==", + "content-length": "173", + "x-amz-user-agent": "AWS-Console-AppSync/", + "x-forwarded-proto": "https", + "host": "xxxxxxxxxxxxxxxx.appsync-api.us-west-2.amazonaws.com", + "accept-language": "en-ca", + "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.1 Safari/605.1.15", + "cloudfront-is-desktop-viewer": "true", + "cloudfront-is-mobile-viewer": "false", + "accept": "*/*", + "x-forwarded-port": "443", + "cloudfront-is-smarttv-viewer": "false" + } + }, + "prev": null, + "info": { + "selectionSetList": [ + "address", + "id" + ], + "selectionSetGraphQL": "{ address id}", + "parentTypeName": "Customer", + "fieldName": "address", + "variables": {} + }, + "stash": {} + } + """ + + let data = eventBody.data(using: .utf8)! + var event: AppSync.Event? + XCTAssertNoThrow(event = try JSONDecoder().decode(AppSync.Event.self, from: data)) + XCTAssertEqual(event?.source?["name"], "Hello") + XCTAssertTrue(event?.stash?.isEmpty ?? false, "stash dictionary must be empty") + XCTAssertNil(event?.identity) + } + + func testRequestDecodingIamIdentity() { + let eventBody = """ + { + "arguments": {}, + "identity": { + "accountId" : "accountId1", + "cognitoIdentityPoolId" : "cognitoIdentityPool2", + "cognitoIdentityId" : "cognitoIdentity3", + "sourceIp" : ["1.1.1.1"], + "username" : null, + "userArn" : "arn123", + "cognitoIdentityAuthType" : "authenticated", + "cognitoIdentityAuthProvider" : "authprovider" + }, + "source": { + "name": "Hello", + "id": "1" + }, + "request": { + "headers": { + "x-forwarded-for": "1.1.1.1, 2.2.2.2", + "accept-encoding": "gzip, deflate, br", + "cloudfront-viewer-country": "CA", + "cloudfront-is-tablet-viewer": "false", + "referer": "https://us-west-2.console.aws.amazon.com/", + "via": "2.0 xxxxxx.cloudfront.net (CloudFront)", + "cloudfront-forwarded-proto": "https", + "origin": "https://us-west-2.console.aws.amazon.com", + "x-api-key": "xxxxxxxxxxxxxxxxxxxxx", + "content-type": "application/json", + "x-amzn-trace-id": "Root=1-5fcd9a24-364c62405b418bd53c7984ce", + "x-amz-cf-id": "3aykhqlUwQeANU-HGY7E_guV5EkNeMMtwyOgiA==", + "content-length": "173", + "x-amz-user-agent": "AWS-Console-AppSync/", + "x-forwarded-proto": "https", + "host": "xxxxxxxxxxxxxxxx.appsync-api.us-west-2.amazonaws.com", + "accept-language": "en-ca", + "user-agent": "Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_6) AppleWebKit/605.1.15 (KHTML, like Gecko) Version/14.0.1 Safari/605.1.15", + "cloudfront-is-desktop-viewer": "true", + "cloudfront-is-mobile-viewer": "false", + "accept": "*/*", + "x-forwarded-port": "443", + "cloudfront-is-smarttv-viewer": "false" + } + }, + "prev": null, + "info": { + "selectionSetList": [ + "address", + "id" + ], + "selectionSetGraphQL": "{ address id}", + "parentTypeName": "Customer", + "fieldName": "address", + "variables": {} + }, + "stash": {} + } + """ + + let data = eventBody.data(using: .utf8)! + var event: AppSync.Event? + XCTAssertNoThrow(event = try JSONDecoder().decode(AppSync.Event.self, from: data)) + switch event?.identity { + case .iam(let iamIdentity): + XCTAssertEqual(iamIdentity.accountId, "accountId1") + XCTAssertEqual(iamIdentity.cognitoIdentityPoolId, "cognitoIdentityPool2") + XCTAssertEqual(iamIdentity.cognitoIdentityId, "cognitoIdentity3") + XCTAssertEqual(iamIdentity.sourceIp, ["1.1.1.1"]) + XCTAssertNil(iamIdentity.username) + XCTAssertEqual(iamIdentity.userArn, "arn123") + XCTAssertEqual(iamIdentity.cognitoIdentityAuthType, "authenticated") + XCTAssertEqual(iamIdentity.cognitoIdentityAuthProvider, "authprovider") + default: + XCTAssertTrue(false, "an iam identity was expected, but didn't find one.") + } + } +} + +extension AppSync.Event.ArgumentValue: Equatable { + public static func == (lhs: Self, rhs: Self) -> Bool { + switch (lhs, rhs) { + case (.string(let lhsString), .string(let rhsString)): + return lhsString == rhsString + case (.dictionary(let lhsDictionary), .dictionary(let rhsDictionary)): + return lhsDictionary == rhsDictionary + default: + return false + } + } +}