#353 | Pull request reminder widget (github / bitbucket) #403

mGasiorek998 · 2021-06-25T08:36:35Z

#353 Pull request reminder widget (github / bitbucket)

Description

Added new widget which will show pull requests of a given repository.

Motivation and Context

User will be able to track all of the open pull request from a repository

Screenshots

Types of changes

Bug fix (non-breaking change which fixes an issue)
New feature (non-breaking change which adds functionality)
Breaking change (fix or feature that would cause existing functionality to not work as expected)

Checklist:

My code follows the code style of this project.
My change requires a change to the documentation.
Automated functional tests have been added or modified to cover my changes (if applicable)
I have updated the documentation accordingly.

I hereby agree to the terms of the Cogboard Contributor License Agreement.

…uests from given repo path

YellowFlash525 · 2021-06-26T10:18:15Z

cogboard-webapp/src/components/widgets/types/PullRequestReminderWidget/index.js

+          </PullRequestLink>
+        ))
+      ) : (
+        <StyledNoItemsInfo>


I think this part will never be rendered because of condition in line 14

Github API returns empty array when there is no pull requests in a given repository, so the widget will display "No Pull Requests", but if path to repository is invalid or API limit is reached it will return nothing, so widget will display "API rate limit exceeded!"

YellowFlash525 · 2021-06-26T10:19:53Z

cogboard-webapp/src/components/widgets/types/PullRequestReminderWidget/styled.js

+import styled from '@emotion/styled/macro';
+import { COLORS } from '../../../../constants/';
+
+export const PullRequestContainer = styled('div')`


Suggested change

export const PullRequestContainer = styled('div')`

export const PullRequestContainer = styled.div`

Fixed in commit 53f7cc8

YellowFlash525 · 2021-06-26T10:20:06Z

cogboard-webapp/src/components/widgets/types/PullRequestReminderWidget/styled.js

+  }
+`;
+
+export const PullRequestLink = styled('a')`


Suggested change

export const PullRequestLink = styled('a')`

export const PullRequestLink = styled.a`

Fixed in commit 53f7cc8

szymon-owczarzak · 2021-06-28T09:10:20Z

cogboard-app/src/main/kotlin/com/cognifide/cogboard/widget/type/PullRequestReminderWidget.kt

+                val apiUrl = url.replace("github.com/", "api.github.com")
+                httpGet(url = "$apiUrl/repos$path/pulls")
+            } else {
+                httpGet(url = "https://api.bitbucket.org/2.0/repositories$path/pullrequests")


I would like to be able to setup some repos from here:
https://bitbucket.cognifide.com/dashboard

Fixed in f03e91e

szymon-owczarzak · 2021-06-28T09:13:29Z

cogboard-app/src/main/kotlin/com/cognifide/cogboard/widget/type/PullRequestReminderWidget.kt

+    override fun updateState() {
+        if (url.isNotBlank() && path.isNotBlank()) {
+            if (url.contains("github")) {
+                val apiUrl = url.replace("github.com/", "api.github.com")


This will not work for commertial repos i think you should be replacing :// with ://api.

my project repo as an example: https://github.company.com/

Fixed in commit f03e91e

szymon-owczarzak · 2021-06-28T09:20:19Z

cogboard-webapp/src/components/widgets/types/PullRequestReminderWidget/index.js

+          <PullRequestLink key={id} href={url} target="_blank">
+            <PullRequestContainer>
+              {`${index + 1}. ${formatPullRequestTitle(title)}`}
+            </PullRequestContainer>
+          </PullRequestLink>


Please reuse the existing look & feel from other widgets - look at Random picker, Link List, ToDo list

Fixed in commit fe5980b

szymon-owczarzak

Please have a look @ my comments.
Add mocks, and example content for two widgets.
Test solution with our companys bitbucket.

… fixed github api url replace.

… are loading

…dating

szymon-owczarzak · 2021-07-13T10:39:34Z

cogboard-app/src/main/resources/initData/endpoints.json

+    {
+      "id": "endpoint5",
+      "label": "Bitbucket Cognifide",
+      "publicUrl": "https://bitbucket.cognifide.com/",
+      "url": "https://bitbucket.cognifide.com/",
+      "credentials": ""


Remove this and instead add support to our Api Mocks - and mimic a response there. Please make sure you are not providing any sensitiva data.

szymon-owczarzak · 2021-07-13T11:17:01Z

cogboard-webapp/src/components/widgets/index.js

+  },
+  PullRequestReminderWidget: {
+    component: PullRequestReminderWidget,
+    dialogFields: ['EndpointField', 'SchedulePeriod', 'Path'],


Let's expand dialog with new fields:
1 Project (Group) 2 Repository in place of Path
3 API Type dropdown with values: Bitbucket 1.0, Bitbucket 2.0, GitHub- we will expand if needed - GitHub as a default one

Use SonarQube Version field as an example

szymon-owczarzak · 2021-07-13T11:18:36Z

cogboard-app/src/main/kotlin/com/cognifide/cogboard/CogboardConstants.kt

@@ -73,6 +73,8 @@ class CogboardConstants {
            const val JQL_QUERY = "jqlQuery"
            const val BUCKET_QUERIES = "bucketQueries"
            const val BUCKET_NAME = "bucketName"
+            const val PULL_REQUESTS = "pullRequests"
+            const val REPOSITORY_HUB = "repositoryHub"


after the introduction of apiType dropdown this will not be required.

szymon-owczarzak · 2021-07-13T11:20:06Z

cogboard-app/src/main/kotlin/com/cognifide/cogboard/widget/type/PullRequestReminderWidget.kt

+    override fun handleResponse(responseBody: JsonObject) {
+        var pullRequests = responseBody
+
+        if (url.contains("github")) {


use switch-case on apiType instead

szymon-owczarzak · 2021-07-13T11:20:33Z

cogboard-app/src/main/kotlin/com/cognifide/cogboard/widget/type/PullRequestReminderWidget.kt

+            pullRequests =
+                    pullRequests
+                            .put(Props.PULL_REQUESTS, responseBody.remove("array"))
+                            .put(Props.REPOSITORY_HUB, "github")


no need to send this property

szymon-owczarzak · 2021-07-13T11:23:55Z

cogboard-app/src/main/kotlin/com/cognifide/cogboard/widget/type/PullRequestReminderWidget.kt

+        if (url.contains("github")) {
+            var (_, owner, repo) = path.split("/")
+            var apiUrl = url.replace("://", "://api.").replace("com/", "com")
+            httpGet("$apiUrl/repos/$owner/$repo/pulls")
+        } else if (url.contains("bitbucket") && path.contains("dashboard")) {
+            httpGet("$url/rest/api/1.0/dashboard/pull-requests")
+            return
+        } else {
+            var (_, project, repo) = path.split("/")
+            httpGet(url = "$url/rest/api/1.0/projects/$project/repos/$repo/pull-requests")
+        }


move this logic to a seprate class so we can just:

httpGet(UrlUtil.getApiUrl(apiType, url, project, repository))

You can do this as an extension method on string class also.
httpGet(url.getApiUrl(apiType, project, repository))
https://kotlinlang.org/docs/extensions.html#extension-functions
write Unit tests for supported examples

szymon-owczarzak

Look at my comments and the screenshot below.
Let's make this widget more generic and future prooof

michal-gasiorek-wttech added 5 commits June 23, 2021 13:40

Added new Pull Request Reminder Widget

3ec904f

Added PullRequest Input for repository url and its basic functionality

13f9028

Added Github API Call to get Pull Requests, Widget displayes Pull Req…

aa3ec40

…uests from given repo path

Remove unnecessary test objects

78867d8

Added Bitbucket API to the widget

53ffcf5

mGasiorek998 requested a review from szymon-owczarzak June 25, 2021 09:19

mGasiorek998 self-assigned this Jun 25, 2021

mGasiorek998 linked an issue Jun 25, 2021 that may be closed by this pull request

Pull request reminder widget (github / bitbucket) #353

Open

4 tasks

YellowFlash525 reviewed Jun 26, 2021

View reviewed changes

Improved styles of the widget

53f7cc8

kamil-wojcik-wttech previously approved these changes Jun 28, 2021

View reviewed changes

YellowFlash525 previously approved these changes Jun 28, 2021

View reviewed changes

szymon-owczarzak reviewed Jun 28, 2021

View reviewed changes

szymon-owczarzak suggested changes Jun 28, 2021

View reviewed changes

Changed styles to fit better with other widgets

fe5980b

mGasiorek998 dismissed stale reviews from YellowFlash525 and kamil-wojcik-wttech via fe5980b June 28, 2021 10:56

michal-gasiorek-wttech added 4 commits June 29, 2021 16:05

Added proper bitbucket API

1d44b5a

Added mocks to init config, added endpoints for github and bitbucket,…

f03e91e

… fixed github api url replace.

Fixed bug with fetching API, added loading spinner when pull requests…

791ba63

… are loading

Improved loading spinner: loading spinner will show when widget is up…

572ddb4

…dating

szymon-owczarzak added the enhancement New feature or request label Jun 30, 2021

szymon-owczarzak reviewed Jul 13, 2021

View reviewed changes

szymon-owczarzak suggested changes Jul 13, 2021

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

#353 | Pull request reminder widget (github / bitbucket) #403

#353 | Pull request reminder widget (github / bitbucket) #403

mGasiorek998 commented Jun 25, 2021 •

edited

Loading

YellowFlash525 Jun 26, 2021 •

edited

Loading

mGasiorek998 Jun 28, 2021 •

edited

Loading

YellowFlash525 Jun 26, 2021

mGasiorek998 Jun 28, 2021

YellowFlash525 Jun 26, 2021

mGasiorek998 Jun 28, 2021

szymon-owczarzak Jun 28, 2021

mGasiorek998 Jun 30, 2021

szymon-owczarzak Jun 28, 2021

szymon-owczarzak Jun 28, 2021

mGasiorek998 Jun 30, 2021

szymon-owczarzak Jun 28, 2021

mGasiorek998 Jun 28, 2021

szymon-owczarzak left a comment

szymon-owczarzak Jul 13, 2021

szymon-owczarzak Jul 13, 2021 •

edited

Loading

szymon-owczarzak Jul 13, 2021

szymon-owczarzak Jul 13, 2021 •

edited

Loading

szymon-owczarzak Jul 13, 2021

szymon-owczarzak Jul 13, 2021

szymon-owczarzak Jul 13, 2021 •

edited

Loading

szymon-owczarzak left a comment

	export const PullRequestContainer = styled('div')`
	export const PullRequestContainer = styled.div`

	export const PullRequestLink = styled('a')`
	export const PullRequestLink = styled.a`

#353 | Pull request reminder widget (github / bitbucket) #403

Are you sure you want to change the base?

#353 | Pull request reminder widget (github / bitbucket) #403

Conversation

mGasiorek998 commented Jun 25, 2021 • edited Loading

#353 Pull request reminder widget (github / bitbucket)

Description

Motivation and Context

Screenshots

Types of changes

Checklist:

YellowFlash525 Jun 26, 2021 • edited Loading

Choose a reason for hiding this comment

mGasiorek998 Jun 28, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szymon-owczarzak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szymon-owczarzak Jul 13, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szymon-owczarzak Jul 13, 2021 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szymon-owczarzak Jul 13, 2021 • edited Loading

Choose a reason for hiding this comment

szymon-owczarzak left a comment

Choose a reason for hiding this comment

mGasiorek998 commented Jun 25, 2021 •

edited

Loading

YellowFlash525 Jun 26, 2021 •

edited

Loading

mGasiorek998 Jun 28, 2021 •

edited

Loading

szymon-owczarzak Jul 13, 2021 •

edited

Loading

szymon-owczarzak Jul 13, 2021 •

edited

Loading

szymon-owczarzak Jul 13, 2021 •

edited

Loading