status-im
/
sourcecred
mirror of https://github.com/status-im/sourcecred.git
2
0
Fork 0
Code Issues Projects Releases Wiki Activity

github: fetch commit parent oids (#924) 

Summary:
To ease the transition from manual continuation resolution to the Mirror
API, we update the old system to fetch commit parent OIDs, as described
in #923.

Test Plan:
To check that the continuations are wired correctly, apply the following
patch to force continuations to be followed at every step:

```diff
diff --git a/src/plugins/github/graphql.js b/src/plugins/github/graphql.js
index 05761ca..a21a364 100644
--- a/src/plugins/github/graphql.js
+++ b/src/plugins/github/graphql.js
@@ -53,7 +53,7 @@ const PAGE_SIZE_COMMENTS = 20;
 const PAGE_SIZE_REVIEWS = 5;
 const PAGE_SIZE_REVIEW_COMMENTS = 10;
 const PAGE_SIZE_COMMIT_HISTORY = 100;
-const PAGE_SIZE_COMMIT_PARENTS = 5;
+const PAGE_SIZE_COMMIT_PARENTS = 0;
 const PAGE_SIZE_REACTIONS = 5;

 /**
@@ -358,6 +358,7 @@ function* continuationsFromCommit(
 ) {
   const b = build;
   if (result.parents && result.parents.pageInfo.hasNextPage) {
+    console.warn(result.parents.pageInfo);
     yield {
       enclosingNodeType: "COMMIT",
       enclosingNodeId: nodeId,
@@ -366,7 +367,7 @@ function* continuationsFromCommit(
           b.field(
             "parents",
             {
-              first: b.literal(PAGE_LIMIT),
+              first: b.literal(1),
               after: b.literal(result.parents.pageInfo.endCursor),
             },
             [b.fragmentSpread("commitParents")]
```

(It is important that the initial page limit be `0` and not (say) `1`,
because the `defaultBranchRef` is likely to have just one parent; by
using `0`, we test its continuations as long as it has at least one
parent.)

Then run `./src/plugins/github/fetchGithubRepoTest.sh` and note that the
test passes and the output is

```
{ hasNextPage: true, endCursor: null }
{ hasNextPage: true, endCursor: null }
{ hasNextPage: true, endCursor: null }
{ hasNextPage: true, endCursor: null }
{ hasNextPage: true, endCursor: null }
{ hasNextPage: true, endCursor: null }
{ hasNextPage: true, endCursor: null }
{ hasNextPage: true, endCursor: 'MQ==' }
{ hasNextPage: true, endCursor: 'MQ==' }
```

Note that the test output (as updated in this commit) includes commits
with a unique parent, a commit with no parents, and a commit with two
parents.

I also ran `node ./bin/sourcecred.js load` on sourcecred/sourcecred and
ipfs/js-ipfs. Each worked, and the resulting credit attributions loaded
fine.

wchargin-branch: github-commit-parent-oids
This commit is contained in:
William Chargin 2018-10-18 19:16:44 -07:00 committed by GitHub
parent 7c5923959e
commit ee4900616b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 172 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
src/plugins/github/__snapshots__/graphql.test.js.snap
View File

@ -355,6 +355,15 @@ fragment commitHistory on CommitHistoryConnection {
...commit
}
}
fragment commitParents on CommitConnection {
pageInfo {
hasNextPage
endCursor
}
nodes {
oid
}
}
fragment commit on Commit {
id
url
@ -366,6 +375,9 @@ fragment commit on Commit {
...whoami
}
}
parents(first: 5) {
...commitParents
}
}
fragment reactions on ReactionConnection {
pageInfo {

91
src/plugins/github/example/example-github.json
View File

@ -13,6 +13,17 @@
"id": "MDY6Q29tbWl0MTIzMjU1MDA2OjZiZDFiNGMwYjcxOWMyMmM2ODhhNzQ4NjNiZTA3YTY5OWI3YjliMzQ=",
"message": "A commit from someone with no GitHub account\n\nSummary:\nThis is a commit to master by a user with email at `example.com`, which\nshould not be linked to any GitHub account.\n\nGenerated with:\n\n git -c user.name='Mysterious Stranger' \\\n -c user.email='mysterious-stranger@example.com' \\\n commit -S\n\nActually committed and signed by William Chargin <wchargin@gmail.com>.\nVerify public key at either of:\n - <https://github.com/wchargin.gpg>\n - <https://wchargin.github.io/> (click link to \"My PGP key\")",
"oid": "6bd1b4c0b719c22c688a74863be07a699b7b9b34",
"parents": {
"nodes": [
{
"oid": "c430bd74455105f77215ece51945094ceeee6c86"
}
],
"pageInfo": {
"endCursor": "MQ==",
"hasNextPage": false
}
},
"url": "https://github.com/sourcecred/example-github/commit/6bd1b4c0b719c22c688a74863be07a699b7b9b34"
},
{
@ -28,6 +39,17 @@
"id": "MDY6Q29tbWl0MTIzMjU1MDA2OmM0MzBiZDc0NDU1MTA1Zjc3MjE1ZWNlNTE5NDUwOTRjZWVlZTZjODY=",
"message": "Hello from credbot!\n\nSummary:\nThis is a commit to master under the name and email of credbot, who has\nno other contributions to the repository. This is intended to test that\nwe can still pull the correct GitHub user off of the commit.\n\nGenerated with:\n\n git -c user.name='credbot' \\\n -c user.email='42819382+credbot@users.noreply.github.com' \\\n commit\n\nActually committed and signed by William Chargin <wchargin@gmail.com>.\nVerify public key at either of:\n - <https://github.com/wchargin.gpg>\n - <https://wchargin.github.io/> (click link to \"My PGP key\")",
"oid": "c430bd74455105f77215ece51945094ceeee6c86",
"parents": {
"nodes": [
{
"oid": "6d5b3aa31ebb68a06ceb46bbd6cf49b6ccd6f5e6"
}
],
"pageInfo": {
"endCursor": "MQ==",
"hasNextPage": false
}
},
"url": "https://github.com/sourcecred/example-github/commit/c430bd74455105f77215ece51945094ceeee6c86"
},
{
@ -43,6 +65,17 @@
"id": "MDY6Q29tbWl0MTIzMjU1MDA2OjZkNWIzYWEzMWViYjY4YTA2Y2ViNDZiYmQ2Y2Y0OWI2Y2NkNmY1ZTY=",
"message": "This pull request will be more contentious. I can feel it... (#5)\n\n* This pull request will be more contentious. I can feel it...\r\n\r\n* Address wchargin's unreasonable complaints",
"oid": "6d5b3aa31ebb68a06ceb46bbd6cf49b6ccd6f5e6",
"parents": {
"nodes": [
{
"oid": "0a223346b4e6dec0127b1e6aa892c4ee0424b66a"
}
],
"pageInfo": {
"endCursor": "MQ==",
"hasNextPage": false
}
},
"url": "https://github.com/sourcecred/example-github/commit/6d5b3aa31ebb68a06ceb46bbd6cf49b6ccd6f5e6"
},
{
@ -58,6 +91,20 @@
"id": "MDY6Q29tbWl0MTIzMjU1MDA2OjBhMjIzMzQ2YjRlNmRlYzAxMjdiMWU2YWE4OTJjNGVlMDQyNGI2NmE=",
"message": "Merge pull request #3 from sourcecred/add-readme\n\nAdd README, merge via PR.",
"oid": "0a223346b4e6dec0127b1e6aa892c4ee0424b66a",
"parents": {
"nodes": [
{
"oid": "ec91adb718a6045b492303f00d8e8beb957dc780"
},
{
"oid": "ecc889dc94cf6da17ae6eab5bb7b7155f577519d"
}
],
"pageInfo": {
"endCursor": "Mg==",
"hasNextPage": false
}
},
"url": "https://github.com/sourcecred/example-github/commit/0a223346b4e6dec0127b1e6aa892c4ee0424b66a"
},
{
@ -73,6 +120,17 @@
"id": "MDY6Q29tbWl0MTIzMjU1MDA2OmVjYzg4OWRjOTRjZjZkYTE3YWU2ZWFiNWJiN2I3MTU1ZjU3NzUxOWQ=",
"message": "Add README, merge via PR.",
"oid": "ecc889dc94cf6da17ae6eab5bb7b7155f577519d",
"parents": {
"nodes": [
{
"oid": "ec91adb718a6045b492303f00d8e8beb957dc780"
}
],
"pageInfo": {
"endCursor": "MQ==",
"hasNextPage": false
}
},
"url": "https://github.com/sourcecred/example-github/commit/ecc889dc94cf6da17ae6eab5bb7b7155f577519d"
},
{
@ -88,6 +146,14 @@
"id": "MDY6Q29tbWl0MTIzMjU1MDA2OmVjOTFhZGI3MThhNjA0NWI0OTIzMDNmMDBkOGU4YmViOTU3ZGM3ODA=",
"message": "Commit without pull request.",
"oid": "ec91adb718a6045b492303f00d8e8beb957dc780",
"parents": {
"nodes": [
],
"pageInfo": {
"endCursor": null,
"hasNextPage": false
}
},
"url": "https://github.com/sourcecred/example-github/commit/ec91adb718a6045b492303f00d8e8beb957dc780"
}
],
@ -881,6 +947,20 @@
"id": "MDY6Q29tbWl0MTIzMjU1MDA2OjBhMjIzMzQ2YjRlNmRlYzAxMjdiMWU2YWE4OTJjNGVlMDQyNGI2NmE=",
"message": "Merge pull request #3 from sourcecred/add-readme\n\nAdd README, merge via PR.",
"oid": "0a223346b4e6dec0127b1e6aa892c4ee0424b66a",
"parents": {
"nodes": [
{
"oid": "ec91adb718a6045b492303f00d8e8beb957dc780"
},
{
"oid": "ecc889dc94cf6da17ae6eab5bb7b7155f577519d"
}
],
"pageInfo": {
"endCursor": "Mg==",
"hasNextPage": false
}
},
"url": "https://github.com/sourcecred/example-github/commit/0a223346b4e6dec0127b1e6aa892c4ee0424b66a"
},
"number": 3,
@ -974,6 +1054,17 @@
"id": "MDY6Q29tbWl0MTIzMjU1MDA2OjZkNWIzYWEzMWViYjY4YTA2Y2ViNDZiYmQ2Y2Y0OWI2Y2NkNmY1ZTY=",
"message": "This pull request will be more contentious. I can feel it... (#5)\n\n* This pull request will be more contentious. I can feel it...\r\n\r\n* Address wchargin's unreasonable complaints",
"oid": "6d5b3aa31ebb68a06ceb46bbd6cf49b6ccd6f5e6",
"parents": {
"nodes": [
{
"oid": "0a223346b4e6dec0127b1e6aa892c4ee0424b66a"
}
],
"pageInfo": {
"endCursor": "MQ==",
"hasNextPage": false
}
},
"url": "https://github.com/sourcecred/example-github/commit/6d5b3aa31ebb68a06ceb46bbd6cf49b6ccd6f5e6"
},
"number": 5,

69
src/plugins/github/graphql.js
View File

@ -53,6 +53,7 @@ const PAGE_SIZE_COMMENTS = 20;
const PAGE_SIZE_REVIEWS = 5;
const PAGE_SIZE_REVIEW_COMMENTS = 10;
const PAGE_SIZE_COMMIT_HISTORY = 100;
const PAGE_SIZE_COMMIT_PARENTS = 5;
const PAGE_SIZE_REACTIONS = 5;
/**
@ -89,6 +90,7 @@ const PAGE_SIZE_REACTIONS = 5;
export type Continuation = {|
+enclosingNodeType:
| "REPOSITORY"
| "COMMIT"
| "ISSUE"
| "PULL"
| "REVIEW"
@ -220,6 +222,7 @@ export function continuationsFromContinuation(
): Iterator<Continuation> {
const continuationsFromEnclosingType = {
REPOSITORY: continuationsFromRepository,
COMMIT: continuationsFromCommit,
ISSUE: continuationsFromIssue,
PULL: continuationsFromPR,
REVIEW: continuationsFromReview,
@ -325,6 +328,54 @@ function* continuationsFromRepository(
yield* continuationsFromPR(pull, pull.id, subpath);
}
}
if (result.defaultBranchRef) {
const topLevelCommit = result.defaultBranchRef.target;
{
const commit = topLevelCommit;
const subpath = [...path, "defaultBranchRef", "target"];
yield* continuationsFromCommit(commit, commit.id, subpath);
}
const pastCommits = topLevelCommit.history.nodes;
for (let i = 0; i < pastCommits.length; i++) {
const commit = pastCommits[i];
const subpath = [
...path,
"defaultBranchRef",
"target",
"history",
"nodes",
i,
];
yield* continuationsFromCommit(commit, commit.id, subpath);
}
}
}
function* continuationsFromCommit(
result: any,
nodeId: string,
path: $ReadOnlyArray<string | number>
) {
const b = build;
if (result.parents && result.parents.pageInfo.hasNextPage) {
yield {
enclosingNodeType: "COMMIT",
enclosingNodeId: nodeId,
selections: [
b.inlineFragment("Commit", [
b.field(
"parents",
{
first: b.literal(PAGE_LIMIT),
after: b.literal(result.parents.pageInfo.endCursor),
},
[b.fragmentSpread("commitParents")]
),
]),
],
destinationPath: path,
};
}
}
function* continuationsFromIssue(
@ -443,6 +494,11 @@ function* continuationsFromPR(
destinationPath: path,
};
}
if (result.mergeCommit) {
const commit = result.mergeCommit;
const subpath = [...path, "mergeCommit"];
yield* continuationsFromCommit(commit, commit.id, subpath);
}
if (result.reviews) {
for (let i = 0; i < result.reviews.nodes.length; i++) {
const issue = result.reviews.nodes[i];
@ -1007,6 +1063,7 @@ export type CommitJSON = {|
+user: NullableAuthorJSON,
|},
+message: string,
+parents: ConnectionJSON<{|+oid: string|}>,
|};
function commitFragment(): FragmentDefinition {
@ -1020,6 +1077,9 @@ function commitFragment(): FragmentDefinition {
b.field("date"),
b.field("user", {}, [b.fragmentSpread("whoami")]),
]),
b.field("parents", {first: b.literal(PAGE_SIZE_COMMIT_PARENTS)}, [
b.fragmentSpread("commitParents"),
]),
]);
}
@ -1031,6 +1091,14 @@ function commitHistoryFragment(): FragmentDefinition {
]);
}
function commitParentsFragment(): FragmentDefinition {
const b = build;
return b.fragment("commitParents", "CommitConnection", [
makePageInfo(),
b.field("nodes", {}, [b.field("oid")]),
]);
}
export const Reactions: {|
+THUMBS_UP: "THUMBS_UP",
+THUMBS_DOWN: "THUMBS_DOWN",
@ -1086,6 +1154,7 @@ export function createFragments(): FragmentDefinition[] {
reviewsFragment(),
reviewCommentsFragment(),
commitHistoryFragment(),
commitParentsFragment(),
commitFragment(),
reactionsFragment(),
];