GraphQL-Ruby 中处理多行字符串输入的解决方案

在 GraphQL-Ruby 项目中，开发者经常会遇到处理多行字符串输入的问题。本文将深入探讨这个常见问题的根源以及有效的解决方案。

问题背景

当在 GraphQL 查询中使用包含换行符的字符串值时，例如：

mutation {
  createRecord(data: {
     dynamicFields: { string_test: "avenue 1st
 2nd line"}
  })
 { id, dynamicFields }
}

直接解析这样的查询会导致 GraphQL::ParseError 错误，提示"Expected string or block string, but it was malformed"。这是因为 GraphQL 解析器对字符串中的换行符有严格的格式要求。

问题根源

GraphQL 规范要求字符串中的换行符必须被正确转义。原始字符串中的实际换行符（\n）需要转换为转义序列（\n），否则解析器会认为字符串格式不正确。

解决方案

GraphQL-Ruby 2.3.0 版本提供了 GraphQL::Language.escape_single_quoted_newlines 方法来处理这个问题。这个方法会自动将字符串中的换行符转义：

query = params[:query]
escaped_query = GraphQL::Language.escape_single_quoted_newlines(query)

实现细节

1. 转义过程：该方法会将字符串中的 \n 替换为 \\n，使其符合 GraphQL 解析器的要求。

2. 性能考虑：如果输入的字符串已经正确转义，方法会直接返回原字符串，避免不必要的处理。

3. 完整示例：

def execute
  query = params[:query]
  escaped_query = GraphQL::Language.escape_single_quoted_newlines(query)
  unless query.equal?(escaped_query)
    query = escaped_query
  end
  
  # 其他处理逻辑...
  result = MySchema.execute(query, variables: variables)
end

注意事项

1. 全面应用：确保在所有解析 GraphQL 查询的地方都应用这个转义方法，包括直接调用 GraphQL.parse 的地方。

2. 测试验证：添加包含多行字符串的测试用例，确保转义逻辑在各种场景下都能正常工作。

3. 性能监控：虽然转义操作通常很快，但在高流量应用中仍需监控其对性能的影响。

结论

通过正确使用 GraphQL::Language.escape_single_quoted_newlines 方法，开发者可以轻松解决 GraphQL-Ruby 中多行字符串输入的问题。这个解决方案既保持了代码的简洁性，又确保了查询的正确解析，是处理此类问题的推荐做法。