Class: Subscriptions::BaseSubscription

Inherits:

GraphQL::Schema::Subscription

• Object
• GraphQL::Schema::Subscription
• Subscriptions::BaseSubscription

Includes:

Gitlab::Graphql::VersionFilter::FutureFieldFallback

Defined in:

app/graphql/subscriptions/base_subscription.rb

Direct Known Subclasses

Ci::Jobs::JobProcessed, Ci::Jobs::StatusUpdated, Ci::PipelineCreationRequestsUpdated, Ci::PipelineSchedule::StatusUpdated, Ci::Pipelines::StatusUpdated, Ci::Pipelines::StatusesUpdated, IssuableUpdated, Notes::Base, User::MergeRequestUpdated, WorkItemUpdated

Constant Summary

UNAUTHORIZED_ERROR_MESSAGE =

'Unauthorized subscription'

Instance Method Summary

• #authorized? ⇒ Boolean
• #initialize(object:, context:, field:) ⇒ BaseSubscription constructor

  A new instance of BaseSubscription.

• #subscribe ⇒ Object

  We override graphql-ruby’s default ‘subscribe` since it returns :no_response instead, which leads to empty hashes rendered out to the caller which has caused problems in the client.

Constructor Details

#initialize(object:, context:, field:) ⇒ BaseSubscription

# File 'app/graphql/subscriptions/base_subscription.rb', line 12

def initialize(object:, context:, field:)
  super

  # Reset user so that we don't use a stale user for authorization
  current_user.reset if current_user
end

Instance Method Details

#authorized? ⇒ Boolean

Raises:

• (NotImplementedError)

# File 'app/graphql/subscriptions/base_subscription.rb', line 31

def authorized?(*)
  raise NotImplementedError
end

#subscribe ⇒ Object

We override graphql-ruby’s default ‘subscribe` since it returns :no_response instead, which leads to empty hashes rendered out to the caller which has caused problems in the client.

Eventually, we should move to an approach where the caller receives a response here upon subscribing, but we don’t need this currently because Vue components also perform an initial fetch query. See gitlab.com/gitlab-org/gitlab/-/issues/402614

# File 'app/graphql/subscriptions/base_subscription.rb', line 27

def subscribe(*)
  nil
end