fix: resolve implementation for multiple contributors #439

tenshiAMD · 2022-10-07T22:47:50Z

What:

resolve implementation for multiple contributors

Why:

multiple contributors does not work properly

How:

refactor and update implementation

Checklist:

Documentation
Ready to be merged
Added myself to contributors table.
Bot Usage

vercel · 2022-10-07T22:47:53Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Updated
app	✅ Ready (Inspect)	Visit Preview	Oct 10, 2022 at 7:24PM (UTC)

tenshiAMD · 2022-10-07T22:49:11Z

TODO:

Add snapshot/s for testing multiple contributors in single comment
Add some documentation for usage

codecov · 2022-10-07T22:50:41Z

Codecov Report

Base: 100.00% // Head: 100.00% // No change to project coverage 👍

Coverage data is based on head (840a60a) compared to base (fb2d7c7).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff            @@
##            master      #439   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           17        16    -1     
  Lines          485       451   -34     
  Branches        57        53    -4     
=========================================
- Hits           485       451   -34

Impacted Files	Coverage Δ
lib/parse-comment.js	`100.00% <100.00%> (ø)`
lib/process-issue-comment.js	`100.00% <100.00%> (ø)`

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

tenshiAMD · 2022-10-07T22:57:07Z

test/integration/issue_comment.test.js

+  test("Happy path, add correct new multiple contributors", async () => {
+    const mock = nock("https://api.github.com")
+      .get(
+        `/repos/all-contributors/all-contributors-bot/git/ref/heads%2Fall-contributors%2Fadd-gr2m`
+      )
+      .reply(404)
+
+      .get(
+        `/repos/all-contributors/all-contributors-bot/git/ref/heads%2Fall-contributors%2Fadd-tenshiamd`
+      )
+      .reply(404)
+
+      .get(
+        "/repos/all-contributors/all-contributors-bot/contents/.all-contributorsrc?ref=master"
+      )
+      .reply(200, reposGetContentsAllContributorsRCdata)
+
+      .get("/users/gr2m")
+      .reply(200, usersGetByUsernameGr2mData)
+
+      .get("/users/tenshiamd")
+      .reply(200, usersGetByUsernameTenshiamdData)
+
+      .get(
+        "/repos/all-contributors/all-contributors-bot/contents/README.md?ref=master"
+      )
+      .reply(200, reposGetContentsREADMEMDdata)
+
+      .get(
+        `/repos/all-contributors/all-contributors-bot/git/ref/heads%2Fmaster`
+      )
+      .reply(200, gitGetRefdata)
+
+      .post(`/repos/all-contributors/all-contributors-bot/git/refs`, (body) => {
+        expect(body).toMatchSnapshot("request body");
+        return true;
+      })
+      .reply(201, gitCreateRefdata)
+
+      .put(
+        `/repos/all-contributors/all-contributors-bot/contents/.all-contributorsrc`,
+        (body) => {
+          expect(body).toMatchSnapshot("request body");
+          return true;
+        }
+      )
+      .reply(200, reposUpdateFiledata)
+
+      .put(
+        `/repos/all-contributors/all-contributors-bot/contents/README.md`,
+        (body) => {
+          expect(body).toMatchSnapshot("request body");
+          return true;
+        }
+      )
+      .reply(200, reposUpdateFiledata)
+
+      .post(`/repos/all-contributors/all-contributors-bot/pulls`, (body) => {
+        expect(body).toMatchSnapshot("request body");
+        return true;
+      })
+      .reply(201, pullsCreatedata)
+
+      .post(
+        "/repos/all-contributors/all-contributors-bot/issues/1/comments",
+        (body) => {
+          expect(body).toMatchSnapshot("request body");
+          return true;
+        }
+      )
+      .reply(200);
+
+    await probot.receive({
+      name: "issue_comment",
+      id: "1",
+      payload: issueCommentCreatedMultipleContributorsPayload,
+    });
+
+    expect(mock.activeMocks()).toStrictEqual([]);
+    expect(output).toMatchSnapshot("logs");
+  });


@gr2m @Berkmann18 please check this one as I cannot find any solution for this one to make it somehow pass. I need your advice regarding this matter. Thank you.

I can probably look into it next week

I can probably look into it next week

@gr2m please do check thanks

When you see a "Nock: No match for request" error, a good way to debug it is to run the test with nock debugging enabled

DEBUG=nock* npx jest --testNamePattern "Happy path, add correct new multiple contributors" test/integration/issue_comment.test.js

It seems that the app attempts to send these requests twice:

GET /repos/all-contributors/all-contributors-bot/contents/.all-contributorsrc?ref=master

GET /repos/all-contributors/all-contributors-bot/contents/README.md?ref=master

GET /repos/all-contributors/all-contributors-bot/git/ref/heads%2Fmaster

nock supports mock the same requests twice

.get( "/repos/all-contributors/all-contributors-bot/contents/.all-contributorsrc?ref=master" ) .twice() .reply(200, reposGetContentsAllContributorsRCdata)

however this looks like a bug?

@gr2m I already tried DEBUG=nock* and did have some other details but still not helpful 😞

however this looks like a bug?

Looks like it is. I also tried updating nock to the latest version just now but it still does not work.

I mean it looks like a bug with the code, not with nock. Why is the code sending these requests twice? Does it send them once per contributor?

Does it send them once per contributor?

@gr2m all tests passed now after adding .twice(). yes, currently it is one PR per contributor. Making one PR for many contributors is still on our TODO list for improvements.

@gr2m looks like all is good now. anything else we missed?

gr2m

🚀:shipit:

github-actions · 2022-10-11T00:29:31Z

🎉 This PR is included in version 1.18.2 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

tenshiAMD added 2 commits October 7, 2022 23:51

fix: resolve implementation for multiple contributors

fefe5d7

wip

4ec3103

tenshiAMD requested a review from a team as a code owner October 7, 2022 22:47

tenshiAMD changed the title ~~fix: resolve implementation for multiple contributors~~ WIP fix: resolve implementation for multiple contributors Oct 7, 2022

tenshiAMD self-assigned this Oct 7, 2022

chore: add snapshot for testing multiple contributors at single commit

5821e44

vercel bot deployed to Preview October 7, 2022 22:54 View deployment

tenshiAMD commented Oct 7, 2022

View reviewed changes

add .twice()

35a608e

vercel bot deployed to Preview October 10, 2022 18:47 View deployment

cleanups

840a60a

vercel bot deployed to Preview October 10, 2022 19:20 View deployment

tenshiAMD mentioned this pull request Oct 10, 2022

docs: add usage for multiple contributors at once all-contributors/all-contributors#652

Merged

3 tasks

gr2m changed the title ~~WIP fix: resolve implementation for multiple contributors~~ fix: resolve implementation for multiple contributors Oct 10, 2022

gr2m approved these changes Oct 10, 2022

View reviewed changes

tenshiAMD merged commit eb44cea into master Oct 11, 2022

tenshiAMD deleted the tenshiamd/fix-multiple-contributors branch October 11, 2022 00:28

github-actions bot added the released label Oct 11, 2022

gr2m mentioned this pull request May 9, 2023

fix: revert logging to the same schema as it used to be #466

Merged

3 tasks

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: resolve implementation for multiple contributors #439

fix: resolve implementation for multiple contributors #439

tenshiAMD commented Oct 7, 2022 •

edited

Loading

vercel bot commented Oct 7, 2022 •

edited

Loading

tenshiAMD commented Oct 7, 2022 •

edited

Loading

codecov bot commented Oct 7, 2022 •

edited

Loading

tenshiAMD Oct 7, 2022

gr2m Oct 7, 2022

tenshiAMD Oct 10, 2022

gr2m Oct 10, 2022

tenshiAMD Oct 10, 2022

gr2m Oct 10, 2022

tenshiAMD Oct 10, 2022 •

edited

Loading

tenshiAMD Oct 10, 2022

gr2m left a comment

github-actions bot commented Oct 11, 2022

fix: resolve implementation for multiple contributors #439

fix: resolve implementation for multiple contributors #439

Conversation

tenshiAMD commented Oct 7, 2022 • edited Loading

vercel bot commented Oct 7, 2022 • edited Loading

tenshiAMD commented Oct 7, 2022 • edited Loading

codecov bot commented Oct 7, 2022 • edited Loading

Codecov Report

tenshiAMD Oct 7, 2022

Choose a reason for hiding this comment

gr2m Oct 7, 2022

Choose a reason for hiding this comment

tenshiAMD Oct 10, 2022

Choose a reason for hiding this comment

gr2m Oct 10, 2022

Choose a reason for hiding this comment

tenshiAMD Oct 10, 2022

Choose a reason for hiding this comment

gr2m Oct 10, 2022

Choose a reason for hiding this comment

tenshiAMD Oct 10, 2022 • edited Loading

Choose a reason for hiding this comment

tenshiAMD Oct 10, 2022

Choose a reason for hiding this comment

gr2m left a comment

Choose a reason for hiding this comment

🚀:shipit:

github-actions bot commented Oct 11, 2022

tenshiAMD commented Oct 7, 2022 •

edited

Loading

vercel bot commented Oct 7, 2022 •

edited

Loading

tenshiAMD commented Oct 7, 2022 •

edited

Loading

codecov bot commented Oct 7, 2022 •

edited

Loading

tenshiAMD Oct 10, 2022 •

edited

Loading