feat: Google OAuth for login & signup #6346

scmmishra · 2023-01-25T10:12:49Z

Description

This PR adds Google OAuth for all existing users; this will allow users to log in or signup via their Google account.

Type of change

New feature (non-breaking change which adds functionality)
This change requires a documentation update

Depends on: chatwoot/utils#18

How Has This Been Tested?

Tested locally, needs to be verified on staging

Checklist:

My code follows the style guidelines of this project
I have performed a self-review of my code
I have commented on my code, particularly in hard-to-understand areas
I have made corresponding changes to the documentation
My changes generate no new warnings
I have added tests that prove my fix is effective or that my feature works
New and existing unit tests pass locally with my changes
Any dependent changes have been merged and published in downstream modules

netlify · 2023-01-25T10:12:57Z

✅ Deploy Preview for chatwoot-storybook canceled.

Name	Link
🔨 Latest commit	`dc8e12c`
🔍 Latest deploy log	https://app.netlify.com/sites/chatwoot-storybook/deploys/63edbe9ad0a6b200075ee769

scmmishra · 2023-01-25T11:40:37Z

app/controllers/devise_overrides/omniauth_callbacks_controller.rb

+    if @resource.nil?
+      redirect_to "#{ENV.fetch('FRONTEND_URL', nil)}/app/login?error=oauth-no-user"
+      return
+    end


@sojan-official @pranavrajs need your thoughts on this approach, to reject a login

Can we show a toast when there is an error?

We raise a toast that says "User not found. You need to sign up first"

app/controllers/dashboard_controller.rb

app/javascript/shared/helpers/string.js

pranavrajs · 2023-01-25T16:26:15Z

config/routes.rb

@@ -1,11 +1,12 @@
 Rails.application.routes.draw do
  # AUTH STARTS
-  match 'auth/:provider/callback', to: 'home#callback', via: [:get, :post]
+  # match 'auth/:provider/callback', to: 'home#callback', via: [:get, :post]


Wanted to know if this route is actually used? I couldn't trace back the controller for it

Adding this back, yields this error, because the home_controller.rb does not exist and it overrides the routes created by devise token auth

@sojan-official @tejaswinichile let me know if you have an idea about this

@scmmishra I think this has been initially added as a provider for Facebook messenger or Twitter. But we introduced Twitty later, and this endpoint is not used for Facebook. And as you said, the home_controller is also not present in the system.

But to make sure, please deploy this branch on staging, and check if the Facebook and twitter integrations are working. Or let me know; my Facebook account is already configured on staging.

Or if you could test it on local with ngrok, that will also work.

Noted, I will test it locally with ngrok

@tejaswinichile is there any docs on setting up facebook and twitter locally?

scmmishra · 2023-01-31T09:24:59Z

@sojan-official I've changed the base branch to a feature branch; we can merge this as required. I will work on the signup in a separate branch, will merge it to feat/google-oauth-integration

scmmishra · 2023-02-14T08:32:42Z

@sojan-official the PR is good to go by Pranav, need your review on this. @fayazara it'd be great if you could review the frontend changes

sojan-official

Minor comment. Other wise looks good to me.

sojan-official · 2023-02-14T10:13:34Z

app/controllers/devise_overrides/omniauth_callbacks_controller.rb

+
+  def account_signup_allowed?
+    # set it to true by default, this is the behaviour across the app
+    ActiveModel::Type::Boolean.new.cast(ENV.fetch('ENABLE_ACCOUNT_SIGNUP', true))


let's use GlobalConfigService.load('ENABLE_ACCOUNT_SIGNUP', 'false') instead.
Chatwoot also allows configuration from UI for this flag. hence we will have to account for that.

@sojan-official made the changes, PTAL

fayazara

@scmmishra Frontend code looks good 🔥 .

Have left some comments for minor css changes and some input sanitazation.

app/javascript/dashboard/components/ui/Auth/GoogleOAuthButton.vue

app/javascript/dashboard/routes/auth/components/Signup/Form.vue

Co-authored-by: Fayaz Ahmed <15716057+fayazara@users.noreply.github.com>

scmmishra · 2023-02-16T05:03:07Z

@sojan-official thanks for taking care of the merge conflict. Let me know if this requires any more changes

github-actions · 2023-03-18T08:05:01Z

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs.

pr-triage bot added the PR: draft label Jan 25, 2023

scmmishra force-pushed the feat/google-auth branch from 2991a89 to 3c01845 Compare January 25, 2023 11:36

scmmishra commented Jan 25, 2023

View reviewed changes

scmmishra marked this pull request as ready for review January 25, 2023 11:43

pr-triage bot added PR: unreviewed and removed PR: draft labels Jan 25, 2023

scmmishra requested review from pranavrajs and sojan-official January 25, 2023 11:43

pranavrajs reviewed Jan 25, 2023

View reviewed changes

app/controllers/dashboard_controller.rb Outdated Show resolved Hide resolved

pranavrajs reviewed Jan 25, 2023

View reviewed changes

app/javascript/shared/helpers/string.js Outdated Show resolved Hide resolved

pranavrajs reviewed Jan 25, 2023

View reviewed changes

scmmishra changed the base branch from develop to feat/google-oauth-integration January 31, 2023 09:21

scmmishra added 16 commits January 31, 2023 16:07

feat: add omniauth and other gems

d83361f

feat: add devise config for omniauth

a71bf28

feat: make user omniauthable

45b3e4f

feat: add omniauth callbacks controller

8bf0996

fix: route conflict

e2c17e8

chore: fix quotes in gemfile

c6de46f

refactor: formatting and code organization

1fa5a4f

feat: add google auth details to dashboard config

8858db9

refactor: update login markup

7100371

feat: add shake animation for wrong passwords

71fb770

refactor: use a safer boolean parsing logic

a410f44

feat: add login button

b4860f2

refactor: extend for DeviseTokenAuth

a3b2033

refactor: move omniauth callback

699e3a1

refactor: override redirect callbacks method

0908052

chore: format

dbb0b8b

Merge branch 'develop' into feat/google-auth

4b00595

pr-triage bot added PR: unreviewed and removed PR: partially-approved labels Feb 14, 2023

Fix spelling

e6bbdc9

scmmishra requested a review from fayazara February 14, 2023 08:32

sojan-official reviewed Feb 14, 2023

View reviewed changes

fayazara suggested changes Feb 15, 2023

View reviewed changes

pr-triage bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Feb 15, 2023

chore: Apply suggestions from code review

6a22074

Co-authored-by: Fayaz Ahmed <15716057+fayazara@users.noreply.github.com>

pr-triage bot added PR: unreviewed and removed PR: reviewed-changes-requested labels Feb 15, 2023

scmmishra added 2 commits February 15, 2023 16:09

refactor: use Global Config instead of env

d0eaad8

Merge branch 'develop' into feat/google-auth

f1bd167

scmmishra requested review from sojan-official and fayazara February 15, 2023 10:41

sojan-official added 3 commits February 16, 2023 10:26

Merge branch 'develop' into feat/google-auth

00a56a3

chore: rever to schema

efbcca9

Merge branch 'develop' into feat/google-auth

5ce1ae6

sojan-official added 3 commits February 16, 2023 10:46

chore: refactor logic

66d39a7

Merge branch 'develop' into feat/google-auth

fa952b3

chore: fix rubocop

dc8e12c

sojan-official merged commit 7be2ef3 into develop Feb 16, 2023

sojan-official deleted the feat/google-auth branch February 16, 2023 05:42

pr-triage bot added PR: merged and removed PR: unreviewed labels Feb 16, 2023

github-actions bot locked as resolved and limited conversation to collaborators Mar 18, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Google OAuth for login & signup #6346

feat: Google OAuth for login & signup #6346

scmmishra commented Jan 25, 2023 •

edited

Loading

netlify bot commented Jan 25, 2023 •

edited

Loading

scmmishra Jan 25, 2023

pranavrajs Jan 25, 2023

scmmishra Jan 29, 2023

pranavrajs Jan 25, 2023

scmmishra Jan 26, 2023

scmmishra Jan 29, 2023

tejaswinichile Jan 31, 2023 •

edited

Loading

scmmishra Jan 31, 2023

scmmishra Jan 31, 2023

scmmishra commented Jan 31, 2023

scmmishra commented Feb 14, 2023

sojan-official left a comment

sojan-official Feb 14, 2023

scmmishra Feb 15, 2023

fayazara left a comment

scmmishra commented Feb 16, 2023

github-actions bot commented Mar 18, 2023

feat: Google OAuth for login & signup #6346

feat: Google OAuth for login & signup #6346

Conversation

scmmishra commented Jan 25, 2023 • edited Loading

Description

Type of change

How Has This Been Tested?

Checklist:

netlify bot commented Jan 25, 2023 • edited Loading

✅ Deploy Preview for chatwoot-storybook canceled.

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

tejaswinichile Jan 31, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

scmmishra commented Jan 31, 2023

scmmishra commented Feb 14, 2023

sojan-official left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

fayazara left a comment

Choose a reason for hiding this comment

scmmishra commented Feb 16, 2023

github-actions bot commented Mar 18, 2023

scmmishra commented Jan 25, 2023 •

edited

Loading

netlify bot commented Jan 25, 2023 •

edited

Loading

tejaswinichile Jan 31, 2023 •

edited

Loading