Skip to content

1.0.0: Broadcasting support (GraphQL-Ruby 1.11+)

Compare
Choose a tag to compare
@github-actions github-actions released this 01 Apr 07:03
v1.0.0
02fc2ae

Added

Changed

  • Subscription data storage format changed to support broadcasting feature (see #15)

Removed

  • Drop support for GraphQL-Ruby before 1.11

  • Drop support for AnyCable before 1.0

  • Drop :action_cable_stream option from context: it is not used in reality.

    See rmosolgo/graphql-ruby#3076 for details

Upgrading notes

  1. Change method of plugging in of this gem from use GraphQL::Subscriptions::AnyCableSubscriptions to use GraphQL::AnyCable:

    use GraphQL::AnyCable

    If you need broadcasting, add broadcast: true option and ensure that Interpreter mode is enabled.

    use GraphQL::Execution::Interpreter
    use GraphQL::Analysis::AST
    use GraphQL::AnyCable, broadcast: true, default_broadcastable: true
  2. Enable handle_legacy_subscriptions setting for seamless upgrade from previous versions:

    GRAPHQL_ANYCABLE_HANDLE_LEGACY_SUBSCRIPTIONS=true

    Disable or remove this setting when you sure that all clients has re-subscribed (e.g. after subscription_expiration_seconds has passed after upgrade) as it imposes small performance penalty.