GraphQL will return 0 nodes on a search query w/ PAT

[Kowlin]

Select Topic Area

Bug

Body

So it seems there was a recent change regarding searching with a PAT, where we have to split out into 2 requests to get both issues and PRs (Why?). However, I only found this behavior and it's accompanying note on the REST API's documentation page. Below follow the queries used to replicate this issue, and its responses.

Query:

query SearchIssues($query: String!) {
  search(type: ISSUE, query: $query, first: 15) {
    issueCount
    nodes {
      __typename
      ... on Issue {
        state
        number
        title
        url
      }
      ... on PullRequest {
        mergeable
        isDraft
        state
        number
        title
        url
      }
    }
  }
  rateLimit {
    cost
    remaining
    limit
    resetAt
  }
}

Variables:

{
  "query": "repo:cog-creators/red-discordbot is:open"
}

Response:

{
  "data": {
    "search": {
      "issueCount": 0,
      "nodes": []
    },
    "rateLimit": {
      "cost": 1,
      "remaining": 4995,
      "limit": 5000,
      "resetAt": "2025-01-13T05:43:43Z"
    }
  }
}

Adding in either is:issue, or is:pull-request to the query variable will give the expected search results, as seen below:

Fixed response:

{
  "data": {
    "search": {
      "issueCount": 196,
      "nodes": [
        ... Truncated
      ]
    },
    "rateLimit": {
      "cost": 1,
      "remaining": 4994,
      "limit": 5000,
      "resetAt": "2025-01-13T05:43:43Z"
    }
  }
}

So long story short. This isn't documented in the schema anywhere, nor does this give an error within the error field And its assumed that the user just seems to know about it. Leading to a confusing situation where the user doesn't know that this limitation is in place since it doesn't error out like the REST API does, where it'll give a HTTP 422.

[github-actions[bot]]

💬 Your Product Feedback Has Been Submitted 🎉

Thank you for taking the time to share your insights with us! Your feedback is invaluable as we build a better GitHub experience for all our users.

Here's what you can expect moving forward ⏩

• Your input will be carefully reviewed and cataloged by members of our product teams. 
  • Due to the high volume of submissions, we may not always be able to provide individual responses.
  • Rest assured, your feedback will help chart our course for product improvements.
• Other users may engage with your post, sharing their own perspectives or experiences. 
• GitHub staff may reach out for further clarification or insight. 
  • We may 'Answer' your discussion if there is a current solution, workaround, or roadmap/changelog post related to the feedback.

Where to look to see what's shipping 👀

• Read the Changelog for real-time updates on the latest GitHub features, enhancements, and calls for feedback.
• Explore our Product Roadmap, which details upcoming major releases and initiatives.

What you can do in the meantime 💻

• Upvote and comment on other user feedback Discussions that resonate with you.
• Add more information at any point! Useful details include: use cases, relevant labels, desired outcomes, and any accompanying screenshots.

As a member of the GitHub community, your participation is essential. While we can't promise that every suggestion will be implemented, we want to emphasize that your feedback is instrumental in guiding our decisions and priorities.

Thank you once again for your contribution to making GitHub even better! We're grateful for your ongoing support and collaboration in shaping the future of our platform. ⭐

[sloretz]

Ah! Thank you for posting this!

I've spent hours today trying to figure out why my search query wasn't working, and it's because of this bug.

To reproduce:

1. Create a Github App, install it, and get a User Access Token via device flow
2. Send this query to the graphql URL

{
    search(first: 1, query: "is:open", type: ISSUE) {
        issueCount
        nodes {
            ... on Issue {
                number
            }
        }
    }
}

3. The API returns 200, no indication of an error, just empty search results.
4. Add either is:issue or is:pr and the query works!

Especially confusing is I was trying to debug by sending queries through https://github.com/search , ex: https://github.com/search?q=is%3Aopen&type=issues , and those always worked!