Add docs notification if GitHub oAuth is not setup #969

vinokurig · 2021-01-22T11:23:30Z

What does this PR do?

If GitHub oauth is not set-up, show a notification with a link to a guide how to set-up GitHub identity provider in keycloak in Che docs page.
Fix authentication mechanism (if Che user token is expired, retrieve it again), little refactoring.

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

Run Che with quay.io/eclipse/che-server:nightly image. It contains the authentication fix
Create and open a workspace from dev-file:

apiVersion: 1.0.0
metadata:
  name: testnjz3q
components:
  - type: cheEditor
    reference: 'https://raw.githubusercontent.com/chepullreq4/pr-check-files/master/che-theia/pr-969/che_theia_meta.yaml'
  - id: github/vscode-pull-request-github/latest
    type: chePlugin
projects:
  - name: environment-variable
    source:
      location: 'https://github.com/vinokurig/environment-variable.git'
      type: git

Try to login the GitHub PR plugin:
See the notification:

PR Checklist

As the author of this Pull Request I made sure that:

Reviewers

Reviewers, please comment how you tested the PR when approving it.

Happy Path Channel

HAPPY_PATH_CHANNEL=stable

che-bot · 2021-01-22T12:00:28Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:969
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:969

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

sunix · 2021-01-22T18:11:16Z

I suggest something like that:

Could not start the Github Pull Request plugin. The setup for Github OAuth provider is not complete.

And only single button: Open the setup instructions page

vinokurig · 2021-01-26T13:44:43Z

@sunix

I suggest something like that:

Could not start the Github Pull Request plugin. The setup for Github OAuth provider is not complete.

It is not specific to the Github Pull Requests plugin so I would keep only: The setup for Github OAuth provider is not complete.

And only single button: Open the setup instructions page

Notification buttons are not very flexible in theia, so it will look like:

vinokurig · 2021-01-26T13:46:03Z

@benoitf @l0rd Could you please take a look?

azatsarynnyy · 2021-01-27T14:38:52Z

extensions/eclipse-che-theia-remote-api/src/browser/oauth-utils.ts

+      if (this.machineToken && this.machineToken.length > 0) {
+        const timer = setTimeout(() => {
+          this.messageService.warn(
+            'Authentication is taking too long, the oauth pop-up may be blocked by your browser, ' +


oauth -> OAuth

azatsarynnyy · 2021-01-27T14:39:11Z

extensions/eclipse-che-theia-remote-api/src/browser/oauth-utils.ts

+        const timer = setTimeout(() => {
+          this.messageService.warn(
+            'Authentication is taking too long, the oauth pop-up may be blocked by your browser, ' +
+              'if so, allow popup windows for the current url and restart the workspace'


popup -> pop-up

azatsarynnyy · 2021-01-27T14:59:36Z

plugins/github-auth-plugin/src/github-auth-plugin.ts

+        ) {
+          theia.commands.executeCommand(
+            'theia.open',
+            'https://www.eclipse.org/che/docs/che-7/administration-guide/configuring-authorization/#configuring-github-oauth_che'


Is it the correct link for the downstream as well?

I think the eclipse docs page is relevant for downstream as well.

azatsarynnyy

hm.. for some reasons, I see a bit different PULL REQUEST view

vinokurig · 2021-01-27T16:13:58Z

@azatsarynnyy Looks like there is no git project in your workspace. It's my mistake, I haven't included it to the example devfile, now it is updated :).

azatsarynnyy

The flow works as described. Thanks!

che-bot · 2021-01-27T18:04:30Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:969
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:969

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

…-18237

che-bot · 2021-01-28T14:51:44Z

❌ E2E Happy path tests failed ❗

See Details

name	link
che-theia	docker.io/maxura/che-theia:969
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:969

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

vinokurig · 2021-01-29T06:19:20Z

[crw-ci-test]

azatsarynnyy · 2021-01-29T06:52:35Z

fyi: HappyPath running depends on the fix eclipse-che/che#18918

dmytro-ndp · 2021-01-29T07:52:21Z

[crw-ci-test]

che-bot · 2021-01-29T08:12:03Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:969
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:969

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

sunix · 2021-01-29T08:20:52Z

@sunix

I suggest something like that:
Could not start the Github Pull Request plugin. The setup for Github OAuth provider is not complete.

It is not specific to the Github Pull Requests plugin so I would keep only: The setup for Github OAuth provider is not complete.

And only single button: Open the setup instructions page

Notification buttons are not very flexible in theia, so it will look like:

@vinokurig
in the message you have to tell

the problem (it could not go through the auth with github)
the cause (in our case the setup is not complete)
the solution (in our case the button to open the setup instruction)

OK so something like

Che could not authenticate to your Github account. The setup for Github OAuth provider is not complete.

For the button, avoid ...
So this should be enough: Setup instructions

vinokurig · 2021-01-29T08:30:39Z

@sunix
I like your message, applied it, thanks

che-bot · 2021-01-29T09:22:42Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:969
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:969

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

che-bot · 2021-01-29T10:36:02Z

✅ E2E Happy path tests succeed 🎉

See Details

name	link
che-theia	docker.io/maxura/che-theia:969
che-theia-endpoint-runtime-binary	docker.io/maxura/che-theia-endpoint-runtime-binary:969

Tested with Eclipse Che Single User on K8S (minikube v1.1.1)

Use comment "[crw-ci-test]" to rerun happy path E2E test.
Use comment "[crw-ci-test --rebuild]" to re-build the images and rerun happy path E2E test.

Add docs notification if GitHub oAuth is not setup

0fbd1e3

vinokurig requested review from azatsarynnyy, benoitf, ericwill, RomanNikitenko, sunix, svor, tsmaeder, vitaliy-guliy and vzhukovs as code owners January 22, 2021 11:23

Merge branch 'master' of github.com:eclipse/che-theia into che-18237

a939584

azatsarynnyy reviewed Jan 27, 2021

View reviewed changes

azatsarynnyy approved these changes Jan 27, 2021

View reviewed changes

vinokurig force-pushed the che-18237 branch from 969e634 to cb75be5 Compare January 28, 2021 14:15

fixup! Merge branch 'master' of github.com:eclipse/che-theia into che…

cb75be5

…-18237

vinokurig force-pushed the che-18237 branch from c5db5a0 to 8d688cc Compare January 29, 2021 09:57

fixup! Add docs notification if GitHub oAuth is not setup

8d688cc

vinokurig mentioned this pull request Feb 3, 2021

SSH plugin failed to upload ssh key to GitHub eclipse-che/che#18952

Closed

2 tasks

vinokurig merged commit 194c05c into master Feb 3, 2021

vinokurig deleted the che-18237 branch February 3, 2021 11:59

che-bot added this to the 7.26 milestone Feb 3, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add docs notification if GitHub oAuth is not setup #969

Add docs notification if GitHub oAuth is not setup #969

vinokurig commented Jan 22, 2021 •

edited

Loading

che-bot commented Jan 22, 2021

sunix commented Jan 22, 2021

vinokurig commented Jan 26, 2021

vinokurig commented Jan 26, 2021

azatsarynnyy Jan 27, 2021

vinokurig Jan 27, 2021

azatsarynnyy Jan 27, 2021

vinokurig Jan 27, 2021

azatsarynnyy Jan 27, 2021

vinokurig Jan 27, 2021

azatsarynnyy left a comment

vinokurig commented Jan 27, 2021

azatsarynnyy left a comment

che-bot commented Jan 27, 2021

che-bot commented Jan 28, 2021

vinokurig commented Jan 29, 2021

azatsarynnyy commented Jan 29, 2021

dmytro-ndp commented Jan 29, 2021

che-bot commented Jan 29, 2021

sunix commented Jan 29, 2021 •

edited

Loading

vinokurig commented Jan 29, 2021

che-bot commented Jan 29, 2021

che-bot commented Jan 29, 2021

Add docs notification if GitHub oAuth is not setup #969

Add docs notification if GitHub oAuth is not setup #969

Conversation

vinokurig commented Jan 22, 2021 • edited Loading

What does this PR do?

Screenshot/screencast of this PR

What issues does this PR fix or reference?

How to test this PR?

PR Checklist

Reviewers

Happy Path Channel

che-bot commented Jan 22, 2021

sunix commented Jan 22, 2021

vinokurig commented Jan 26, 2021

vinokurig commented Jan 26, 2021

azatsarynnyy Jan 27, 2021

Choose a reason for hiding this comment

vinokurig Jan 27, 2021

Choose a reason for hiding this comment

azatsarynnyy Jan 27, 2021

Choose a reason for hiding this comment

vinokurig Jan 27, 2021

Choose a reason for hiding this comment

azatsarynnyy Jan 27, 2021

Choose a reason for hiding this comment

vinokurig Jan 27, 2021

Choose a reason for hiding this comment

azatsarynnyy left a comment

Choose a reason for hiding this comment

vinokurig commented Jan 27, 2021

azatsarynnyy left a comment

Choose a reason for hiding this comment

che-bot commented Jan 27, 2021

che-bot commented Jan 28, 2021

vinokurig commented Jan 29, 2021

azatsarynnyy commented Jan 29, 2021

dmytro-ndp commented Jan 29, 2021

che-bot commented Jan 29, 2021

sunix commented Jan 29, 2021 • edited Loading

vinokurig commented Jan 29, 2021

che-bot commented Jan 29, 2021

che-bot commented Jan 29, 2021

vinokurig commented Jan 22, 2021 •

edited

Loading

sunix commented Jan 29, 2021 •

edited

Loading