Load issues dynamically in the Issue Finder #543

dhruvkb · 2020-10-12T10:59:29Z

Fixes

Fixes #542 by @dhruvkb
Fixes #523 by @dhruvkb

Description

This PR uses the Octokit Search API which is not authenticated to find and display issues.

Technical details

This removes the need for the hourly pull and push in ccos-scripts and will also reduce the bot commits to the repo.

Checklist

My pull request has a descriptive title (not a vague title like Update index.md).
My pull request targets the default branch of the repository (main or master).
My commit messages follow best practices.
My code follows the established code style of the repository.
I added tests for the changes I made (if applicable).
I added or updated documentation (if applicable).
I tried running the project locally and verified that there are no
visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

dhruvkb

As a side-effect, this fixes the issue of wrong colours being applied to the skill labels.

dhruvkb · 2020-10-12T11:00:32Z

webpack/js/components.js

@@ -178,6 +178,20 @@ export const App = {
    const BASE_URL = 'https://raw.githubusercontent.com/creativecommons/ccos-scripts/master/normalize_repos'
    const FILE_URL = name => `${BASE_URL}/${name}.json`

+    const octokit = new Octokit();
+    octokit.search.issuesAndPullRequests({
+      q: 'org:creativecommons is:open is:issue label:"help wanted"',


Should we remove the issues awaiting triage?

I think we should add a separate filter for issues awaiting triage.

dhruvkb · 2020-10-12T11:01:05Z

webpack/js/components.js

+    const octokit = new Octokit();
+    octokit.search.issuesAndPullRequests({
+      q: 'org:creativecommons is:open is:issue label:"help wanted"',
+      per_page: 100


I've observed this number to be ~60 so we can skip pagination for now.

kgodey

@dhruvkb the code for this looks fine, but I'm concerned about making this dependent on JavaScript. One of the advantages of having a static site is that it doesn't depend on JavaScript, if we're just using JavaScript for filtering, it can gracefully degrade.

kgodey · 2020-10-16T16:32:34Z

webpack/js/components.js

@@ -178,6 +178,20 @@ export const App = {
    const BASE_URL = 'https://raw.githubusercontent.com/creativecommons/ccos-scripts/master/normalize_repos'
    const FILE_URL = name => `${BASE_URL}/${name}.json`

+    const octokit = new Octokit();
+    octokit.search.issuesAndPullRequests({
+      q: 'org:creativecommons is:open is:issue label:"help wanted"',


I think we should add a separate filter for issues awaiting triage.

dhruvkb · 2020-10-16T17:00:19Z

@kgodey the content changes so dynamically that we're seeing almost 24 bot commits a day. In cases like this, can we not justify the use of JavaScript?

kgodey · 2020-10-16T17:51:57Z

@dhruvkb I don't see what bot commits have to do with JavaScript or the architecture of the project. In any case, I merged creativecommons/ccos-scripts#94 which should reduce bot commits.

dhruvkb · 2020-10-16T18:00:19Z

@kgodey using JavaScript to fetch issues dynamically eliminates the need to keep a databag and sync it hourly. The data will always be fresh and up-to-date. Adding new filters (such as issues that need triage) is also easier because data is being fetched on demand from GitHub which would otherwise need another databag to be created and pushed hourly.

akmadian

The code here looks great to me, I think I agree with Dhruv on the use of JS. I think that the advantages posed by using JS far outweigh the disadvantages. The JS used seems to be pretty standard so in terms of being reliant on it, it seems pretty innocuous.

I do agree that I don't like being dependent on third party packages any more than is needed, but the functionality seems worth it to me.

zackkrida

I am pleased with the changes and approach taken here. Nice work @dhruvkb

dhruvkb · 2020-11-28T18:01:49Z

Now there's an option to find issues that have the label 🚦 status: awaiting triage.

While I agree 100% on @kgodey's points in favour of the static site, this JS based client-side approach proves how easy it is to extend the issue finder when adding new functionality.

dhruvkb added 4 commits October 12, 2020 16:23

Remove the use of the issues databag

ad9f8ad

Install Octokit

811f4c4

Fetch issues directly from GitHub using the unauthenticated Search API

065c3a0

Fix an issue in the skill label colors

b4bec16

dhruvkb requested review from a team as code owners October 12, 2020 10:59

dhruvkb requested review from akmadian, kgodey and zackkrida and removed request for a team October 12, 2020 10:59

dhruvkb commented Oct 12, 2020

View reviewed changes

dhruvkb mentioned this pull request Oct 12, 2020

Remove updatedAt field from issue data in push_data_to_ccos creativecommons/ccos-scripts#94

Merged

7 tasks

kgodey self-assigned this Oct 12, 2020

kgodey reviewed Oct 16, 2020

View reviewed changes

akmadian reviewed Oct 18, 2020

View reviewed changes

zackkrida approved these changes Nov 5, 2020

View reviewed changes

dhruvkb added 3 commits November 28, 2020 23:28

Add an option for triaging issues

2d8ca64

Dynamically load issues based on the aim filter

a6f46a9

Merge branch 'master' into issue_finder_dyn

0accf61

dhruvkb requested review from zackkrida, akmadian and kgodey November 28, 2020 17:59

akmadian approved these changes Nov 29, 2020

View reviewed changes

kgodey approved these changes Nov 29, 2020

View reviewed changes

Merge branch 'master' into issue_finder_dyn

d984e42

Merge branch 'master' into issue_finder_dyn

f8d3feb

kgodey merged commit 9fcd5df into master Nov 29, 2020

kgodey deleted the issue_finder_dyn branch November 29, 2020 22:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Load issues dynamically in the Issue Finder #543

Load issues dynamically in the Issue Finder #543

dhruvkb commented Oct 12, 2020

dhruvkb left a comment

dhruvkb Oct 12, 2020

kgodey Oct 16, 2020

dhruvkb Oct 12, 2020

kgodey left a comment

kgodey Oct 16, 2020

dhruvkb commented Oct 16, 2020

kgodey commented Oct 16, 2020

dhruvkb commented Oct 16, 2020

akmadian left a comment

zackkrida left a comment

dhruvkb commented Nov 28, 2020

Load issues dynamically in the Issue Finder #543

Load issues dynamically in the Issue Finder #543

Conversation

dhruvkb commented Oct 12, 2020

Fixes

Description

Technical details

Checklist

Developer Certificate of Origin

dhruvkb left a comment

Choose a reason for hiding this comment

dhruvkb Oct 12, 2020

Choose a reason for hiding this comment

kgodey Oct 16, 2020

Choose a reason for hiding this comment

dhruvkb Oct 12, 2020

Choose a reason for hiding this comment

kgodey left a comment

Choose a reason for hiding this comment

kgodey Oct 16, 2020

Choose a reason for hiding this comment

dhruvkb commented Oct 16, 2020

kgodey commented Oct 16, 2020

dhruvkb commented Oct 16, 2020

akmadian left a comment

Choose a reason for hiding this comment

zackkrida left a comment

Choose a reason for hiding this comment

dhruvkb commented Nov 28, 2020