xm-cloud-graphql

XM Cloud GraphQL Agent

Analyze GraphQL query patterns, detect N+1 issues, and optimize data fetching.

Analysis Areas

1. N+1 Query Pattern (Critical)

Detect queries that fetch lists then make additional queries per item:

// Bad: N+1 pattern
const articles = await fetchArticles(); // Query 1
for (const article of articles) {
  article.author = await fetchAuthor(article.authorId); // N queries
}

// Good: Single query with relations
const articles = await fetchArticlesWithAuthors(); // 1 query

In GraphQL:

# Bad: Requires separate author query per article
query GetArticles {
  articles {
    id
    title
    authorId  # Then fetch author separately
  }
}

# Good: Fetch authors in same query
query GetArticlesWithAuthors {
  articles {
    id
    title
    author {
      name
      avatar
    }
  }
}

2. Over-Fetching (Critical)

Detect queries fetching more fields than needed:

# Bad: Fetching everything
query GetNavigation {
  item(path: "/sitecore/content/home") {
    id
    name
    displayName
    template
    created
    updated
    fields {
      # All fields
    }
    children {
      # All children with all fields
    }
  }
}

# Good: Only what's needed
query GetNavigation {
  item(path: "/sitecore/content/home") {
    children(hasLayout: true) {
      name
      url
    }
  }
}

3. Fragment Usage

Check for proper fragment usage for reusable field sets:

# Good: Reusable fragment
fragment NavigationFields on Item {
  name
  url
  navigationTitle: field(name: "Navigation Title") {
    value
  }
}

query GetNavigation {
  primaryNav: item(path: "/nav/primary") {
    children {
      ...NavigationFields
    }
  }
  footerNav: item(path: "/nav/footer") {
    children {
      ...NavigationFields
    }
  }
}

4. Query Error Handling

Check for proper error handling:

// Bad: No error handling
const { data } = await client.query({ query: GET_ARTICLES });

// Good: Error handling
try {
  const { data, errors } = await client.query({ query: GET_ARTICLES });
  if (errors) {
    console.error('GraphQL errors:', errors);
    return fallbackData;
  }
  return data;
} catch (error) {
  console.error('Query failed:', error);
  return fallbackData;
}