Codestin Search App

harshaanNihal · 2022-06-07T23:24:20Z

Notion card

https://www.notion.so/saeloun/API-development-for-delete-team-member-ba3b8f43bff5483a8c3bb456bc28a4cc

Summary

Add internal api for Team page with destroy Method
Add specs for Api team_controller#destroy method

Preview

Type of change

Please delete options that are not relevant.

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

How Has This Been Tested?

Checklist:

I have manually tested all workflows
I have performed a self-review of my own code
I have added automated tests for my code

github-actions · 2022-06-07T23:28:43Z

Current Code Coverage Percent of this PR:

87.78 %

Files having coverage below 100%

Impacted Files	Coverage
/app/controllers/users/invitations_controller.rb	86.36 %
/app/policies/payments/provider_policy.rb	85.71 %
/app/services/invoice_payment/checkout.rb	44.0 %
/app/services/invoice_payment/pdf_generation.rb	70.97 %
/app/services/report/filters.rb	87.1 %
/app/controllers/internal_api/v1/profile_controller.rb	96.88 %
/app/controllers/internal_api/v1/payment_settings_controller.rb	93.33 %
/app/controllers/internal_api/v1/payments/providers_controller.rb	94.74 %
/lib/benchmarking/benchmarker.rb	0.0 %

akhilgkrishnan

@harshaanNihal Added some comments

app/controllers/internal_api/v1/team_controller.rb

akhilgkrishnan · 2022-06-08T09:11:11Z

app/controllers/internal_api/v1/team_controller.rb

+class InternalApi::V1::TeamController < InternalApi::V1::ApplicationController
+  def destroy
+    authorize current_user, policy_class: TeamPolicy
+    user.discard!


what is the response when a team member does not discard?

in case user.discard! is not successful it will raise an Exception, which will get rescued here

akhilgkrishnan · 2022-06-08T09:12:53Z

app/controllers/internal_api/v1/team_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class InternalApi::V1::TeamController < InternalApi::V1::ApplicationController


Suggested change

class InternalApi::V1::TeamController < InternalApi::V1::ApplicationController

class InternalApi::V1::TeamsController < InternalApi::V1::ApplicationController

Can we use a plural name

akhilgkrishnan · 2022-06-08T09:13:54Z

spec/requests/internal_api/v1/teams/destroy_spec.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true


Add a test for negative condition, when user is not discarded properly

Added a Model spec for negative condition and mocking the failure negative condition in controller specs

rohitjoshixyz

I have a few concerns with this PR and hence stopped reviewing further. We are not checking if the user being deleted is part of other companies or not.
Discarding the user directly would discard the company_users associated with other companies making the user unable to login into other workspaces
This scenario is not tested in the specs as well.

What is the exact requirement of this API? We can probably split this API into two.

User destroy API which will completely remove the access to Miru (For all the workspaces)
Company User destroy API which will destroy one particular company_user (For a particular workspace)

Also when we say team member it is not immediately clear if we are talking about the company_user or the larger user record cc @supriya3105 @harshaanNihal @akhilgkrishnan

rohitjoshixyz · 2022-06-08T09:08:05Z

app/controllers/internal_api/v1/team_controller.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class InternalApi::V1::TeamController < InternalApi::V1::ApplicationController


NIt: TeamController -> TeamsController

app/controllers/internal_api/v1/team_controller.rb

rohitjoshixyz · 2022-06-08T09:15:38Z

spec/requests/internal_api/v1/teams/destroy_spec.rb

+
+RSpec.describe "InternalApi::V1::Team#destroy", type: :request do
+  let(:company) { create(:company) }
+  let(:user) { create(:user, current_workspace_id: company.id) }


You can rename this user as admin or admin_user and in the "when user is unauthorised" call it employee or employee_user to be more specific

akhilgkrishnan · 2022-06-08T09:35:19Z

I have a few concerns with this PR and hence stopped reviewing further. We are not checking if the user being deleted is part of other companies or not. Discarding the user directly would discard the company_users associated with other companies making the user unable to login into other workspaces This scenario is not tested in the specs as well.

What is the exact requirement of this API? We can probably split this API into two.

User destroy API which will completely remove the access to Miru (For all the workspaces)

Company User destroy API which will destroy one particular company_user (For a particular workspace)

Also when we say team member it is not immediately clear if we are talking about the company_user or the larger user record cc @supriya3105 @harshaanNihal @akhilgkrishnan

Yes I agree with you.

harshaanNihal · 2022-06-08T11:02:56Z

I have a few concerns with this PR and hence stopped reviewing further. We are not checking if the user being deleted is part of other companies or not. Discarding the user directly would discard the company_users associated with other companies making the user unable to login into other workspaces This scenario is not tested in the specs as well.

What is the exact requirement of this API? We can probably split this API into two.

User destroy API which will completely remove the access to Miru (For all the workspaces)
Company User destroy API which will destroy one particular company_user (For a particular workspace)
Also when we say team member it is not immediately clear if we are talking about the company_user or the larger user record cc @supriya3105 @harshaanNihal @akhilgkrishnan

Agree we should discard the conmpany_user instead of user in this scenario.
Initially I was trying to port prewritten team_controller to internal API which was discarding user directly hence I overlooked this scenario.

Moving the PR to Draft for now

harshaanNihal · 2022-06-09T05:46:46Z

I have kept the controller name singular team instead of teams.
The controller will mainly manage the company_users and it's not tied to a specific model i.e. Team.

Since each company will technically have only one team (company_users belong to that company). As Team controller is not associated with any particular model / resource, but rather handle a set of functionality. In this case, the pluralization doesn't make any sense to me.

Please let me know if you think otherwise and I will update the controller name to a plural form.
@rohitjoshixyz @akhilgkrishnan

rohitjoshixyz · 2022-06-09T05:53:48Z

Since each company will technically have only one team (company users belong to that company). As Team controller is not associated with any particular model / resource, but rather handle a set of functionality. In this case, the pluralization doesn't make any sense to me.

That makes sense, considering this and our previous discussion since this controller is only going to handle the company_user model's destroy action let's name it as company_users_controller. What do you think?

harshaanNihal · 2022-06-09T07:08:30Z

There is already a company_users_controller present. [for now it is been used for project Page ]
The Team_controller will be handling functionality specific to team page. [It is already implemented for ERB files]. We are porting it to APIs so that the team page can be ported into react components.

beside destroy method controller will have index update and probably edit.

Maybe once after the Team page is ported we can merge both team and company_user controller into single controller. if they share the functionality.

rohitjoshixyz

@harshaanNihal
Summarizing our discussion here.

The original rails controller's (app/controllers/team_controller) implementation itself is wrong.
Instead of discarding the User it should ideally discard only the current_workspace's CompanyUser record.
According to the latest changes I asked you to make here, this PR will do that correctly.

But as you said the intent of this PR is to port the functionality of the rails controller into an internal API to be used for React we are in a fix. 😓

I won't block this PR since this is an internal API but we need to address and add API for both:

Discarding the User record
Discarding the Company User record
And name the controllers accordingly on priority as a follow-up

Please check and update the language and grammar used in the spec description. It should be consistent.

Overall nice work with the specs. LGTM 👍

rohitjoshixyz · 2022-06-09T09:47:10Z

spec/requests/internal_api/v1/team/destroy_spec.rb

+      expect(json_response["errors"]).to eq(I18n.t("pundit.team_policy.destroy?"))
+    end
+
+    it "does not Discard the team member" do


Nit: Capitalizing "discard" is unnecessary

rohitjoshixyz · 2022-06-09T09:48:05Z

spec/requests/internal_api/v1/team/destroy_spec.rb

+    end
+  end
+
+  context "when user is not signed In" do


Captailizing "In" is unnecessary

rohitjoshixyz · 2022-06-09T09:48:44Z

spec/requests/internal_api/v1/team/destroy_spec.rb

+  context "when user is not signed In" do
+    let(:team_user) { create(:user, current_workspace_id: company.id) }
+
+    it "return unauthorized response with error" do


Nit return => returns

rohitjoshixyz · 2022-06-09T09:49:01Z

spec/requests/internal_api/v1/team/destroy_spec.rb

+      send_request :delete, internal_api_v1_team_path(team_user)
+    end
+
+    it "return forbidden response with error" do


rohitjoshixyz · 2022-06-09T09:49:24Z

spec/requests/internal_api/v1/team/destroy_spec.rb

+    end
+  end
+
+  context "when current user is employee" do


Suggested change

context "when current user is employee" do

context "when current user is an employee" do

- Add destroy method - add internal_api routes - add translations

- Update user with company_user in team_controller - use shordhand for team policy - add spec for multiple company condition - add descard specs.

- review changes

* Add team controller - Add destroy method - add internal_api routes - add translations * add specs for API team_controller#destroy method * code refactor * Add Discard to company_user - Update user with company_user in team_controller - use shordhand for team policy - add spec for multiple company condition - add descard specs. * fix specs language/grammer - review changes

pr-triage bot added the PR: draft label Jun 7, 2022

harshaanNihal force-pushed the team-member-delete-api branch from 03fdcea to e483ff3 Compare June 8, 2022 08:39

harshaanNihal marked this pull request as ready for review June 8, 2022 08:39

pr-triage bot added PR: unreviewed and removed PR: draft labels Jun 8, 2022

harshaanNihal requested a review from akhilgkrishnan June 8, 2022 08:40

akhilgkrishnan requested a review from rohitjoshixyz June 8, 2022 09:05

akhilgkrishnan reviewed Jun 8, 2022

View reviewed changes

rohitjoshixyz suggested changes Jun 8, 2022

View reviewed changes

pr-triage bot added PR: reviewed-changes-requested and removed PR: unreviewed labels Jun 8, 2022

harshaanNihal marked this pull request as draft June 8, 2022 11:03

pr-triage bot added PR: draft and removed PR: reviewed-changes-requested labels Jun 9, 2022

harshaanNihal force-pushed the team-member-delete-api branch from 1990aaa to 4749cce Compare June 9, 2022 05:27

harshaanNihal marked this pull request as ready for review June 9, 2022 05:46

pr-triage bot added PR: unreviewed and removed PR: draft labels Jun 9, 2022

harshaanNihal requested review from akhilgkrishnan and rohitjoshixyz June 9, 2022 05:47

rohitjoshixyz approved these changes Jun 9, 2022

View reviewed changes

pr-triage bot added PR: partially-approved and removed PR: unreviewed labels Jun 9, 2022

Add team controller

0eeb0c8

- Add destroy method - add internal_api routes - add translations

harshaanNihal added 4 commits June 9, 2022 15:58

add specs for API team_controller#destroy method

0a696f9

code refactor

6b762b2

Add Discard to company_user

1308490

- Update user with company_user in team_controller - use shordhand for team policy - add spec for multiple company condition - add descard specs.

fix specs language/grammer

2fb92d1

- review changes

harshaanNihal force-pushed the team-member-delete-api branch from 9e4dfb9 to 2fb92d1 Compare June 9, 2022 10:29

pr-triage bot added PR: unreviewed and removed PR: partially-approved labels Jun 9, 2022

akhilgkrishnan approved these changes Jun 10, 2022

View reviewed changes

pr-triage bot added PR: reviewed-approved and removed PR: unreviewed labels Jun 10, 2022

supriya3105 merged commit bb17c70 into develop Jun 10, 2022

supriya3105 deleted the team-member-delete-api branch June 10, 2022 08:26

pr-triage bot added PR: merged and removed PR: reviewed-approved labels Jun 10, 2022

		@@ -0,0 +1,18 @@
		# frozen_string_literal: true

		class InternalApi::V1::TeamController < InternalApi::V1::ApplicationController

	class InternalApi::V1::TeamController < InternalApi::V1::ApplicationController
	class InternalApi::V1::TeamsController < InternalApi::V1::ApplicationController

	context "when current user is employee" do
	context "when current user is an employee" do

Conversation

harshaanNihal commented Jun 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Notion card

Summary

Preview

Type of change

How Has This Been Tested?

Checklist:

Uh oh!

github-actions bot commented Jun 7, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Current Code Coverage Percent of this PR:

87.78 %

Files having coverage below 100%

Uh oh!

akhilgkrishnan left a comment

Choose a reason for hiding this comment

Uh oh!

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!

rohitjoshixyz left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

akhilgkrishnan commented Jun 8, 2022

Uh oh!

harshaanNihal commented Jun 8, 2022

Uh oh!

harshaanNihal commented Jun 9, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

rohitjoshixyz commented Jun 9, 2022

Uh oh!

harshaanNihal commented Jun 9, 2022

Uh oh!

rohitjoshixyz 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!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

harshaanNihal commented Jun 7, 2022 •

edited

Loading

github-actions bot commented Jun 7, 2022 •

edited

Loading

harshaanNihal commented Jun 9, 2022 •

edited

Loading