Skip to content

Only retrieve tag_list if requested in GraphQL query

Pedro Pombeiro requested to merge pedropombeiro/334173-fix-tags-retrieval into master

What does this MR do?

This MR ensures that only GraphQL runners queries that request tagList actually cause the tag list to be loaded from database. Before this MR, RunnersFinder was unconditionally calling Ci::Runner.with_tags even if the caller wasn't interested in them.

This MR leverages LooksAhead.node_selection to check if the query is requesting tagList and passes that information to RunnersFinder through a new preload: {tag_name: true} hash entry.

query getRunners {
  runners {
    edges {
      node {
        id
        description
      }
    }
  }
}

The above query resulted in the following logs in master:

  Ci::Runner Load (0.3ms)  SELECT "ci_runners".* FROM "ci_runners" ORDER BY "ci_runners"."created_at" DESC, "ci_runners"."id" DESC LIMIT 100 /*application:web,correlation_id:01F8SEP7HP68ZDGY7VHB4J8H7J,endpoint_id:GraphqlController#execute,line:/lib/gitlab/graphql/pagination/keyset/connection.rb:108:in `nodes'*/
  ↳ lib/gitlab/graphql/pagination/keyset/connection.rb:108:in `nodes'
  ActsAsTaggableOn::Tagging Load (0.3ms)  SELECT "taggings".* FROM "taggings" WHERE "taggings"."taggable_type" = 'Ci::Runner' AND "taggings"."context" = 'tags' AND "taggings"."taggable_id" IN (24, 2) /*application:web,correlation_id:01F8SEP7HP68ZDGY7VHB4J8H7J,endpoint_id:GraphqlController#execute,line:/lib/gitlab/graphql/pagination/keyset/connection.rb:108:in `nodes'*/
  ↳ lib/gitlab/graphql/pagination/keyset/connection.rb:108:in `nodes'
  ActsAsTaggableOn::Tag Load (0.3ms)  SELECT "tags".* FROM "tags" WHERE "tags"."id" IN (3, 2, 1, 4) /*application:web,correlation_id:01F8SEP7HP68ZDGY7VHB4J8H7J,endpoint_id:GraphqlController#execute,line:/lib/gitlab/graphql/pagination/keyset/connection.rb:108:in `nodes'*/

With this MR, it results in a single query:

  Ci::Runner Load (0.3ms)  SELECT "ci_runners".* FROM "ci_runners" ORDER BY "ci_runners"."created_at" DESC, "ci_runners"."id" DESC LIMIT 100 /*application:web,correlation_id:01F8SEQ257E9YRJKBXBBZ3X8K6,endpoint_id:GraphqlController#execute,line:/lib/gitlab/graphql/pagination/keyset/connection.rb:108:in `nodes'*/

Screenshots (strongly suggested)

image

Does this MR meet the acceptance criteria?

Conformity

Availability and Testing

Security

Does this MR contain changes to processing or storing of credentials or tokens, authorization and authentication methods or other items described in the security review guidelines? If not, then delete this Security section.

  • Label as security and @ mention @gitlab-com/gl-security/appsec
  • The MR includes necessary changes to maintain consistency between UI, API, email, or other methods
  • Security reports checked/validated by a reviewer from the AppSec team

Closes #334173 (closed)

Merge request reports

Loading