Draft: Add sponsorability feature by IngridGdesigns · Pull Request #135 · indeedeng/Mariner

IngridGdesigns · 2023-02-10T09:50:10Z

Work in progress

src/sponsorabilityFetcher.ts

…g Contributors[] type

…tions

kevindigo

Let's discuss in slack or in a video call.

kevindigo · 2023-03-16T16:51:05Z

src/sponsorabilityFinder.ts

+    public async fetchSponsorabilityInformation(
+        token: string,
+        repositoryIdentifiers: string[]
+    ): Promise<Map<string, ContributionCountOfUserIntoRepo[]>> {


I think I would expect the return value from this function to be an array, where each entry contains all of the data for one row of the spreadsheet.

kevindigo · 2023-03-16T16:51:54Z

src/sponsorabilityFinder.ts

+        repositoryIdentifiers: string[]
+    ): Promise<Map<string, ContributionCountOfUserIntoRepo[]>> {
+        //SponsorWithRepoIdAndContribution
+        const fetchAllContributors = new ContributorFetcher(this.config);


The name should be a noun, like contributorFetcher. Or, since later we learn that it's returning histories, maybe the class should be ContributorHistoryFetcher and this const should be contributorHistoryFetcher?

not wild about the names but will change it

kevindigo · 2023-03-16T16:54:41Z

src/sponsorabilityFinder.ts

+            await sponsorableContributorsFetcher.fetchSponsorableContributorsInformation(
+                token,
+                queryTemplate,
+                allContributorHistorys


Generally it would be better to only pass in the needed information. In this case, passing just a simple list of contributors (without history).

ok, passed it in to have the key of Contributor[],

kevindigo · 2023-03-16T16:55:30Z

src/sponsorabilityFinder.ts

+                allContributorHistorys
+            );
+
+        const sponsorableContributorWithContributonCounts =


I like this step

kevindigo · 2023-03-16T17:02:56Z

src/sponsorableContributorsFetcher.ts

+            });
+        }
+
+        return sponsorables;


Since we already have a map of contributors by repo from elsewhere, does this need to tie the sponsorables back to their repos? Could this just return an array of Sponsors? (Which I would rename Sponsorable, since these are the people potentially being sponsored, not the people doing the sponsoring.)

will work returning array, rename interface to Sponsorables

kevindigo · 2023-03-16T17:11:14Z

src/sponsorabilityFinder.ts

+            contributor: SponsorableWithContributionCount;
+        }[] = [];
+
+        for (const [key, sponsors] of sponsorableContributor) {


It would be clearer to rename key to repoId. And sponsors should be sponsorables.

kevindigo · 2023-03-16T17:12:51Z

src/sponsorabilityFinder.ts

+
+    public addContributionCount(
+        sponsorableContributor: Map<string, Sponsor[]>,
+        contributors: ContributionCountOfUserIntoRepo[]


This should probably be something like contributionCounts. I'm not sure that's right, but it's at least closer.

kevindigo · 2023-03-16T17:16:27Z

src/sponsorabilityFinder.ts

+
+    /*
+
+    for each repo count the number of contributions that were made,


More of this kind of comment might be helpful while the naming and logic is still being worked out. Then, by the end, hopefully the code will be clear enough that the comments will be redundant and can be deleted.

yes, planning to remove all comments once my logic and naming is fleshed out

kevindigo · 2023-03-16T17:20:27Z

src/sponsorableContributorsFetcher.ts

+        const allSponsorableUsersInfo = [];
+        const sponsorables = new Map<string, Sponsor[]>();
+
+        for (const [repoIdentifier, githubUsers] of contributors.entries()) {


To avoid dealing with "entries", I would typically have this outer loop iterate through just the "keys". Then the first line inside the loop would be const users = contributors.get(repoIdentifier);

kevindigo · 2023-03-16T17:22:38Z

src/sponsorableContributorsFetcher.ts

+                }
+            }
+
+            // need to refactor:


I suspect this would be simpler if you built the map inside the loop above, instead of building it there an array, and then converting it to a map here.

I was having issues trying to do that inside the loop, (was getting duplicates)

Co-authored-by: Kevin Smith <kevindigo@users.noreply.github.com>

…conversion function

IngridGdesigns added 5 commits February 2, 2023 11:34

updated deprecated code

4be1d02

installed octokit/rest

72a51e1

npm audit fix

c3694be

added octokit typew

21ebf5e

create SponsorabilityFetcher class

34d3afa

IngridGdesigns requested a review from kevindigo February 10, 2023 09:50

IngridGdesigns added 5 commits February 10, 2023 01:54

added findSponsorables to runExample.ts

1b86b61

added notes, and Contributor interface

cc638bf

read dependencies in file

beaf24c

removed schema comments

18127b3

renamed type, added extract function, read file

9e7a39c

kevindigo reviewed Feb 10, 2023

View reviewed changes

src/sponsorabilityFetcher.ts Outdated Show resolved Hide resolved

IngridGdesigns added 18 commits February 14, 2023 10:20

update names

a16ef51

updated interface

1ec03c8

added error handling in readJsonFile, fetching contributers, returnin…

21d4467

…g Contributors[] type

added start in script

2a23189

added npm start info

aac1262

remove comments, updated type

89c3b10

added space, pulled out fileDir

7cba834

rename function

fea2571

rename const

0f5f03d

rename function

32591fd

fixed package-lock issue

0d20952

rename function

978fc16

added new class for contributors, and to get all sponsorables,

0711f82

added query string mvp

c419212

WIP comment

759a12e

fixed query, added list to-do, fetchSponsorData for single contributor

fc28270

added test data, iterating through contributors to fetchSponsorData

ffaf51b

updated interfaces, added to fetchSponsorData

6b26eea

IngridGdesigns added 9 commits March 15, 2023 12:00

fixed duplication bug with brute force code

a7bc453

moved Promise.all comment to below active code

a0d108a

WIP: committing before cleaning , extracting functions, countContribu…

c9d748b

…tions

extracted function

ef9d0d1

refactored and extracted loops to other functions

99efda1

moved functions around

186d6b8

renamed consts, extracted loops related to language count

68d397f

deleted comments

874df87

added to-do

86a7b21

kevindigo reviewed Mar 16, 2023

View reviewed changes

IngridGdesigns and others added 20 commits March 16, 2023 11:56

rename class

d99e63e

rename interface

acbb92d

rename interface to Sponsorable

2f9cc7d

rename const to repoId, sponsorables

d875fdf

rename const

481bf21

avoiding using entries and adding error handling for login undefine case

cc89c5b

update function name and parameter name

68fcbc6

moved all types to single file

b9cccaa

Co-authored-by: Kevin Smith <kevindigo@users.noreply.github.com>

remove unused code

e8a7c47

moved Sponsorable to finder, added types, rename

354b043

update (due to rename), refactor, removed comments

f9cc361

implement renames, comment out code, removed contributionCounts from …

e69ebea

…conversion function

added impact score

b02b4e6

WIP: created map of contributions count by contributor

84a4d7b

edited name

31bacec

WIP: got counts of each contributor, needs refinement, its duplicating

b523bc5

erased unused code, to start fresh

f22cb46

more cleaning up

d8fdb4a

removed duplicate note

9206d75

add function

ca0f75a


		/*

		for each repo count the number of contributions that were made,

Comments

Conversation

IngridGdesigns commented Feb 10, 2023

Uh oh!

Uh oh!

kevindigo left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

IngridGdesigns Mar 16, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

IngridGdesigns Mar 16, 2023 •

edited

Loading