bug: Accommodated for special characters in edge labels to ensure correct Cypher translation (aws#127)

Queries would fail if an edge label contained a special character such as a colon, period, or space as it is invalid formatting for Cypher. Thus, back ticks were added to ensure that special characters could be included as label names without crashing from incorrect Cypher translations.

Added a unit test for the resolver to ensure backticks are added correctly in cypher translations from queries with special characters in edge labels. Also changed existing resolver unit tests to accommodate for this change.

Author: flora-jin

CHANGELOG.md

@@ -112,12 +112,12 @@ permissions and limitations under the License.
 * Fixed Apollo template to reference `graphql` `parse` instead of `graphql-tag`
   `gql` ([#116](https://github.com/aws/amazon-neptune-for-graphql/pull/116))
 * Fixed deployment of AWS resources if a pipeline name is not provided as an
-  input
-  option ([#117](https://github.com/aws/amazon-neptune-for-graphql/pull/117))
+  input option ([#117](https://github.com/aws/amazon-neptune-for-graphql/pull/117))
 * Fixed invalid schema generation when AWS AppSync scalar types are used in 
-  an input 
-  schema ([#118](https://github.com/aws/amazon-neptune-for-graphql/pull/118))
+  an input schema ([#118](https://github.com/aws/amazon-neptune-for-graphql/pull/118))
 * Fixed duplicated nodes and edges from nodes with 
   multi-labels ([#125](https://github.com/aws/amazon-neptune-for-graphql/pull/125))
 * Updated Apollo subgraph to allow use of Federation 2 features.
   ([#126](https://github.com/aws/amazon-neptune-for-graphql/pull/126))
+* Accommodated for special characters in edge labels to ensure proper Cypher
+  translation ([#127](https://github.com/aws/amazon-neptune-for-graphql/pull/127))

src/test/airports.customized.graphql

@@ -8,15 +8,15 @@ type Continent @alias(property: "continent") {
   type: String
   code: String
   desc: String
-  airportContainssOut(filter: AirportInput, options: Options): [Airport] @relationship(edgeType: "contains", direction: OUT)
+  airportContainssOut(filter: AirportInput, options: Options, sort: [AirportSort!]): [Airport] @relationship(edgeType: "contains", direction: OUT)
   contains: Contains
 }
 
 input ContinentInput {
-_id: ID @id
-type: StringScalarFilters
-code: StringScalarFilters
-desc: StringScalarFilters
+  _id: ID @id
+  type: StringScalarFilters
+  code: StringScalarFilters
+  desc: StringScalarFilters
 }
 
 input ContinentCreateInput {
@@ -54,24 +54,24 @@ type Country @alias(property: "country") {
   governmentSite: AWSURL
   emergencyLine: AWSPhone
   gatewayIp: AWSIPAddress
-  airportContainssOut(filter: AirportInput, options: Options): [Airport] @relationship(edgeType: "contains", direction: OUT)
+  airportContainssOut(filter: AirportInput, options: Options, sort: [AirportSort!]): [Airport] @relationship(edgeType: "contains", direction: OUT)
   contains: Contains
 }
 
 input CountryInput {
-_id: ID @id
-type: StringScalarFilters
-code: StringScalarFilters
-desc: StringScalarFilters
-foundingDate: AWSDate
-localOfficeTime: AWSTime
-updatedAt: AWSDateTime
-createdTimestamp: AWSTimestamp
-officialEmail: AWSEmail
-metadataJson: AWSJSON
-governmentSite: AWSURL
-emergencyLine: AWSPhone
-gatewayIp: AWSIPAddress
+  _id: ID @id
+  type: StringScalarFilters
+  code: StringScalarFilters
+  desc: StringScalarFilters
+  foundingDate: AWSDate
+  localOfficeTime: AWSTime
+  updatedAt: AWSDateTime
+  createdTimestamp: AWSTimestamp
+  officialEmail: AWSEmail
+  metadataJson: AWSJSON
+  governmentSite: AWSURL
+  emergencyLine: AWSPhone
+  gatewayIp: AWSIPAddress
 }
 
 input CountryCreateInput {
@@ -129,15 +129,17 @@ type Version @alias(property: "version") {
   author: String
   type: String
   code: String
+  dataSourcePulled_cn_fromOut(filter: DataSourceInput, options: Options): [DataSource] @relationship(edgeType: "pulled:From", direction: OUT)
+  pulled_cn_From: Pulled_cn_from
 }
 
 input VersionInput {
-_id: ID @id
-date: StringScalarFilters
-desc: StringScalarFilters
-author: StringScalarFilters
-type: StringScalarFilters
-code: StringScalarFilters
+  _id: ID @id
+  date: StringScalarFilters
+  desc: StringScalarFilters
+  author: StringScalarFilters
+  type: StringScalarFilters
+  code: StringScalarFilters
 }
 
 input VersionCreateInput {
@@ -191,19 +193,19 @@ type Airport @alias(property: "airport") {
 }
 
 input AirportInput {
-_id: ID @id
-type: StringScalarFilters
-city: StringScalarFilters
-icao: StringScalarFilters
-code: StringScalarFilters
-country: StringScalarFilters
-lat: Float
-longest: Int
-runways: Int
-desc: StringScalarFilters
-lon: Float
-region: StringScalarFilters
-elev: Int
+  _id: ID @id
+  type: StringScalarFilters
+  city: StringScalarFilters
+  icao: StringScalarFilters
+  code: StringScalarFilters
+  country: StringScalarFilters
+  lat: Float
+  longest: Int
+  runways: Int
+  desc: StringScalarFilters
+  lon: Float
+  region: StringScalarFilters
+  elev: Int
 }
 
 input AirportCreateInput {
@@ -254,61 +256,119 @@ input AirportSort {
   elev: SortingDirection
 }
 
-type Contains @alias(property:"contains") {
-_id: ID! @id
+type DataSource @alias(property: "dataSource") {
+  _id: ID! @id
+  name: String
+  type: String
+  url: String
+  description: String
+  lastUpdated: String
+  isActive: Boolean
+  versionPulled_cn_fromsIn(filter: VersionInput, options: Options, sort: [VersionSort!]): [Version] @relationship(edgeType: "pulled:From", direction: IN)
+  pulled_cn_From: Pulled_cn_from
+}
+
+input DataSourceInput {
+  _id: ID @id
+  name: StringScalarFilters
+  type: StringScalarFilters
+  url: StringScalarFilters
+  description: StringScalarFilters
+  lastUpdated: StringScalarFilters
+  isActive: Boolean
 }
 
-type Route @alias(property:"route") {
-_id: ID! @id
-dist: Int
+input DataSourceCreateInput {
+  _id: ID @id
+  name: String
+  type: String
+  url: String
+  description: String
+  lastUpdated: String
+  isActive: Boolean
+}
+
+input DataSourceUpdateInput {
+  _id: ID! @id
+  name: String
+  type: String
+  url: String
+  description: String
+  lastUpdated: String
+  isActive: Boolean
+}
+
+input DataSourceSort {
+  _id: SortingDirection
+  name: SortingDirection
+  type: SortingDirection
+  url: SortingDirection
+  description: SortingDirection
+  lastUpdated: SortingDirection
+  isActive: SortingDirection
+}
+
+type Contains @alias(property: "contains") {
+  _id: ID! @id
+}
+
+type Route @alias(property: "route") {
+  _id: ID! @id
+  dist: Int
 }
 
 input RouteInput {
-dist: Int
+  dist: Int
+}
+
+type Pulled_cn_from @alias(property: "pulled:From") {
+  _id: ID! @id
 }
 
 input Options {
-limit:Int
-offset:Int
+  limit: Int
+  offset: Int
 }
 
 input StringScalarFilters {
-eq: String
-contains: String
-endsWith: String
-startsWith: String
+  eq: String
+  contains: String
+  endsWith: String
+  startsWith: String
 }
 
 type Query {
-getAirportByCode(code: String): Airport
-getAirportConnection(fromCode: String!, toCode: String!): Airport @cypher(statement: "MATCH (:airport{code: '$fromCode'})-[:route]->(this:airport)-[:route]->(:airport{code:'$toCode'})")
-getContinentsWithGremlin: [Continent] @graphQuery(statement: "g.V().hasLabel('continent').elementMap().fold()")
-getCountriesCountGremlin: Int @graphQuery(statement: "g.V().hasLabel('country').count()")
-getContinent(filter: ContinentInput): Continent
-getContinents(filter: ContinentInput, options: Options, sort: [ContinentSort!]): [Continent]
-getCountry(filter: CountryInput): Country
-getCountrys(filter: CountryInput, options: Options, sort: [CountrySort!]): [Country]
-getVersion(filter: VersionInput): Version
-getVersions(filter: VersionInput, options: Options, sort: [VersionSort!]): [Version]
-getAirport(filter: AirportInput): Airport
-airportQuery_getAirport(filter: AirportInput): Airport
-getAirports(filter: AirportInput, options: Options, sort: [AirportSort!]): [Airport]
-getAirportWithGremlin(code: String): Airport @graphQuery(statement: "g.V().has('airport', 'code', '$code').elementMap()")
-getCountriesCount: Int @graphQuery(statement: "g.V().hasLabel('country').count()")
+  getAirportByCode(code: String): Airport
+  getAirportConnection(fromCode: String!, toCode: String!): Airport @cypher(statement: "MATCH (:airport{code: '$fromCode'})-[:route]->(this:airport)-[:route]->(:airport{code:'$toCode'})")
+  getContinentsWithGremlin: [Continent] @graphQuery(statement: "g.V().hasLabel('continent').elementMap().fold()")
+  getCountriesCountGremlin: Int @graphQuery(statement: "g.V().hasLabel('country').count()")
+  getContinent(filter: ContinentInput): Continent
+  getContinents(filter: ContinentInput, options: Options, sort: [ContinentSort!]): [Continent]
+  getCountry(filter: CountryInput): Country
+  getCountrys(filter: CountryInput, options: Options, sort: [CountrySort!]): [Country]
+  getVersion(filter: VersionInput): Version
+  getVersions(filter: VersionInput, options: Options, sort: [VersionSort!]): [Version]
+  getAirport(filter: AirportInput): Airport
+  airportQuery_getAirport(filter: AirportInput): Airport
+  getAirports(filter: AirportInput, options: Options, sort: [AirportSort!]): [Airport]
+  getAirportWithGremlin(code: String): Airport @graphQuery(statement: "g.V().has('airport', 'code', '$code').elementMap()")
+  getCountriesCount: Int @graphQuery(statement: "g.V().hasLabel('country').count()")
 }
 
 type Mutation {
-createAirport(input: AirportCreateInput!): Airport
-airportMutation_createAirport(input: AirportCreateInput!): Airport
-updateAirport(input: AirportUpdateInput!): Airport
-airportMutation_updateAirport(input: AirportUpdateInput!): Airport
-connectCountryToAirportThroughContains(from_id: ID!, to_id: ID!): Contains
-airportMutation_connectCountryToAirportThroughContains(from_id: ID!, to_id: ID!): Contains
-deleteContainsConnectionFromCountryToAirport(from_id: ID!, to_id: ID!): Boolean
-airportMutation_deleteContainsConnectionFromCountryToAirport(from_id: ID!, to_id: ID!): Boolean
-updateRouteConnectionFromAirportToAirport(from_id: ID!, to_id: ID!, edge: RouteInput!): Route
-airportMutation_updateRouteConnectionFromAirportToAirport(from_id: ID!, to_id: ID!, edge: RouteInput!): Route
-createAirportCustom(input: AirportCreateInput!): Airport @graphQuery(statement: "CREATE (this:airport {$input}) RETURN this")
+  createAirport(input: AirportCreateInput!): Airport
+  airportMutation_createAirport(input: AirportCreateInput!): Airport
+  updateAirport(input: AirportUpdateInput!): Airport
+  airportMutation_updateAirport(input: AirportUpdateInput!): Airport
+  connectCountryToAirportThroughContains(from_id: ID!, to_id: ID!): Contains
+  airportMutation_connectCountryToAirportThroughContains(from_id: ID!, to_id: ID!): Contains
+  deleteContainsConnectionFromCountryToAirport(from_id: ID!, to_id: ID!): Boolean
+  airportMutation_deleteContainsConnectionFromCountryToAirport(from_id: ID!, to_id: ID!): Boolean
+  updateRouteConnectionFromAirportToAirport(from_id: ID!, to_id: ID!, edge: RouteInput!): Route
+  airportMutation_updateRouteConnectionFromAirportToAirport(from_id: ID!, to_id: ID!, edge: RouteInput!): Route
+  connectVersionToDataSourceThroughPulled_cn_from(from_id: ID!, to_id: ID!): Pulled_cn_from
+  deletePulled_cn_fromConnectionFromVersionToDataSource(from_id: ID!, to_id: ID!): Boolean
+  createAirportCustom(input: AirportCreateInput!): Airport @graphQuery(statement: "CREATE (this:airport {$input}) RETURN this")
 }
 
 schema {