Git-point: GraphQL

[alejandronanez]

We should start moving gradually towards GraphQL, it will save us a TON of requests. AFAIK GraphQL doesn't have available the same exact endpoints as Github V3 Rest API so we should have a mix between both.

[andrewda]

While it's fresh on my mind, here's how we'd fetch an issue (query score: 3, i.e. is 3/5000 of our hourly limit):

{
  repository(owner: "gitpoint", name: "git-point") {
    issue(number: 2) {
      title
      body
      participants(first: 100) {
        edges {
          node {
            avatarUrl
            login
          }
        }
      }
      author {
        avatarUrl
        login
      }
      labels(first: 5) {
        edges {
          node {
            name
            color
          }
        }
      }
      comments(first: 100) {
        edges {
          node {
            body
            author {
              avatarUrl
              login
            }
          }
        }
      }
    }
  }
}

[andrewda]

And fetch a repository (query score: 5):

{
  repository(owner: "gitpoint", name: "git-point") {
    description
    primaryLanguage {
      name
      color
    }
    owner {
      avatarUrl
      login
    }
    releases {
      totalCount
    }
    stargazers {
      totalCount
    }
    forks {
      totalCount
    }
    # Contributors:
    mentionableUsers(first: 100) {
      edges {
        node {
          avatarUrl
          login
        }
      }
    }
    openIssues: issues(first: 3, states: OPEN) {
      totalCount
      edges {
        node {
          title
        }
      }
    }
    closedIssues: issues(first: 3, states: CLOSED) {
      totalCount
      edges {
        node {
          title
        }
      }
    }
    openPullRequests: pullRequests(first: 3, states: OPEN) {
      totalCount
      edges {
        node {
          title
        }
      }
    }
    closedPullRequests: pullRequests(first: 3, states: [CLOSED, MERGED]) {
      totalCount
      edges {
        node {
          title
        }
      }
    }
  }
}

[andrewda]

Fetching a user (query score: 1):

{
  user(login: "andrewda") {
    name
    bio
    email
    location
    company
    websiteUrl
    viewerIsFollowing
    followers {
      totalCount
    }
    following {
      totalCount
    }
    repositories {
      totalCount
    }
    organizations(first: 100) {
      edges {
        node {
          avatarUrl
          login
        }
      }
    }
  }
}

[reyhansofian]

you can also use viewer nodes for current logged in user

{
  viewer {
    name
    bio
    email
    location
    company
    websiteUrl
    viewerIsFollowing
    followers {
      totalCount
    }
    following {
      totalCount
    }
    repositories {
      totalCount
    }
    organizations(first: 100) {
      edges {
        node {
          avatarUrl
          login
        }
      }
    }
  }
}

[andrewda]

Just waiting for GitHub to get back to me now on why the Organization queries are lacking some fundamental information (description, website and email at least). Then I can continue work on this.

[reyhansofian]

Also, there's no user events on Graphql nodes. I've asked Github regarding this issue, still no answer

[andrewda]

:clap: https://platform.github.community/t/accessing-description-of-an-organization/2713/5

[machour]

Here's how to get the README.md file for a repo. If it doesn't exist, readme will be null:

{
  repository(owner: "gitpoint", name: "git-point") {
    readme: object(expression: "master:README.md") {
      ... on Blob {
        text
      }
    }
  }
}

[cheshire137]

I'd like to work on this!

[housseindjirdeh]

Absolutely @cheshire137! Thank you :)

@lex111 started integrating endpoints with organization requests at #347. Please feel free to put up PRs for certain portions incrementally if you prefer.

CC @andrewda (in case you've looked into adding any GraphQL endpoints) and @machour (who's working on normalizing our data store at the moment)