Fix Special Characters in Schema

[andreachild]

PR to Allow Special Characters in Schema

This PR is to edit the graphQL schema to support any graph data that has special/invalid characters

How it Works + Changes

• get data using OpenCypher queries
  • add backticks to labels to escape special characters
• creates graphQL schema
  • replaces invalid characters with something else that works (ex. _cn_, _dot_, _hy_)
  • adds alias directives with the original label
• querying in AppSync which converts graphQL requests to OpenCypher queries
  • uses the labels in the alias directives to create query with original labels
  • add backticks when creating query to escape special characters

[andreachild]

I tried running a few of the queries from the sample security data and found some of them do not work because we need to escape properties in the RETURN clause.

For example this query:

query MyQuery {
  getNodeEc2_cn_internet_hy_gateways {
    arn
    scan_id
    owner_id
    attachment_dot_state
  }
}

Resolves to this open cypher query:

MATCH(getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway:`ec2:internet-gateway`) RETURN collect({arn:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.arn,scan_id:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.scan_id,owner_id:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.owner_id,attachment_dot_state:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.attachment.state})

Which fails because there is a property attachment.state which has a . character. Error message from axios says "Property access over ambiguous type is not supported in this release". It works if this is also surrounded by backticks:

MATCH(getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway:`ec2:internet-gateway`) RETURN collect({arn:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.arn,scan_id:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.scan_id,owner_id:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.owner_id,attachment_dot_state:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.`attachment.state`})

[sophiadt]

I tried running a few of the queries from the sample security data and found some of them do not work because we need to escape properties in the RETURN clause.

For example this query:

query MyQuery {
  getNodeEc2_cn_internet_hy_gateways {
    arn
    scan_id
    owner_id
    attachment_dot_state
  }
}

Resolves to this open cypher query:

MATCH(getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway:`ec2:internet-gateway`) RETURN collect({arn:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.arn,scan_id:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.scan_id,owner_id:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.owner_id,attachment_dot_state:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.attachment.state})

Which fails because there is a property attachment.state which has a . character. Error message from axios says "Property access over ambiguous type is not supported in this release". It works if this is also surrounded by backticks:

MATCH(getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway:`ec2:internet-gateway`) RETURN collect({arn:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.arn,scan_id:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.scan_id,owner_id:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.owner_id,attachment_dot_state:getNodeEc2_cn_internet_hy_gateways_Ec2_cn_internet_hy_gateway.`attachment.state`})

I added backticks to the OPTIONAL MATCH queries so it should properly add backticks to schemaTypeInfo.typeAlias which has the . character. I tested it out with the query you used above and also tested getting the relationships by querying ec2_cn_security_hy_groupResource_linkOut and ec2_cn_vpcResource_linkOut and it works for me now.

if (schemaTypeInfo.isRelationship) {        
        if (schemaTypeInfo.relationship.direction === 'IN') {
            matchStatements.push(`OPTIONAL MATCH (${lastNamePath})<-[${schemaTypeInfo.pathName}_${schemaTypeInfo.relationship.edgeType}:${schemaTypeInfo.relationship.edgeType}]-(${schemaTypeInfo.pathName}:\`${schemaTypeInfo.typeAlias}\`${queryArguments})`);
        } else {
            matchStatements.push(`OPTIONAL MATCH (${lastNamePath})-[${schemaTypeInfo.pathName}_${schemaTypeInfo.relationship.edgeType}:${schemaTypeInfo.relationship.edgeType}]->(${schemaTypeInfo.pathName}:\`${schemaTypeInfo.typeAlias}\`${queryArguments})`);
        }
    } 

[andreachild]

The tests are failing because the files that contain the expected results are missing the back ticks that were added

[kmcginnes]

Mostly minor nit stuff.

[andreachild]

Approving via this comment