feat:Cluster description note #3174

Ash-exp · 2023-03-22T12:39:23Z

Description

Develop GET and PUT methods of Cluster Description.
Cluster Description Fields :

ClusterName
ClusterCreatedOn (Time Stamp)
ClusterCreatedBy (user email id)
ClusterNote Fields :
- Description (Markup Text)
- CreatedBy (user email id)
- CreatedOn (Time Stamp)

Maintain audit history of cluster description note in database.

Fixes #2773
Tech Doc

How Has This Been Tested?

GET: /description?id={clusterId}

RBAC implementation for cluster get access.
return 404 for invalid clusterId.
Always Return clusterName, clusterCreatedOn, clusterCreatedBy if cluster exists.
Return NULL clusterNotes for none existing cluster notes.

PUT: /description/note

RBAC implementation for cluster update access.
return 404 for invalid clusterId
Return updated cluster notes on successful updation.
Audit gets created on CREATE and UPDATE methods implemented on cluster notes.

Checklist:

The title of the PR states what changed and the related issues number (used for the release note).
Does this PR requires documentation updates?
I've updated documentation as required by this PR.
I have performed a self-review of my own code.
I have commented my code, particularly in hard-to-understand areas.
I have tested it for all user roles.
I have added all the required unit/api test cases.

Does this PR introduce a user-facing change?

vikramdevtron · 2023-03-22T12:42:24Z

pkg/cluster/repository/ClusterNoteRepository.go

+	return impl.dbConnection.Update(model)
+}
+
+func (impl ClusterNoteRepositoryImpl) Delete(model *ClusterNote) error {


why do we delete, use soft delete

removed delete method 👍

vikramdevtron · 2023-03-22T12:42:43Z

pkg/cluster/repository/ClusterNoteRepository.go

+	return clusterNote, err
+}
+
+func (impl ClusterNoteRepositoryImpl) FindByClusterIds(id []int) ([]ClusterNote, error) {


use Ids in params

Updated 👍

vikramdevtron · 2023-03-22T12:43:41Z

pkg/cluster/repository/ClusterNoteHistoryRepository.go

+	return impl.dbConnection.Insert(model)
+}
+
+func (impl ClusterNoteHistoryRepositoryImpl) FindHistoryByNoteId(id []int) ([]ClusterNoteHistory, error) {


user pointer * array

Implemented 👍

vikramdevtron · 2023-03-22T12:44:02Z

pkg/cluster/ClusterNoteService.go

+	if err != nil {
+		return err
+	}
+	return impl.clusterNoteRepository.Delete(model)


avoid hard delete

removed delete method 👍

vikramdevtron · 2023-03-22T12:45:03Z

pkg/cluster/ClusterNoteService.go

+	}
+	clusterAudit.CreatedBy = userId
+	clusterAudit.UpdatedBy = userId
+	clusterAudit.CreatedOn = time.Now()


on update why created by and created on ?

created by and created on is required for saving the record to the audit history

createdBy and CreatedOn for audit logs will not change in update operation.
clusterAudit.CreatedBy = model.Id
clusterAudit.UpdatedBy = model.UpdatedBy

sonarqubecloud · 2023-03-23T12:31:53Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
5 Code Smells

No Coverage information
3.3% Duplication

iamayushm · 2023-04-27T11:34:58Z

pkg/cluster/ClusterNoteService.go

+	clusterAudit.UpdatedOn = time.Now()
+	err = impl.clusterNoteHistoryRepository.SaveHistory(clusterAudit)
+	if err != nil {
+		return nil, err


Don't return err, only log it if there is error in saving history

implemented 👍

iamayushm · 2023-04-27T11:47:28Z

pkg/cluster/ClusterNoteService.go

+	}
+	clusterAudit.CreatedBy = userId
+	clusterAudit.UpdatedBy = userId
+	clusterAudit.CreatedOn = time.Now()


createdBy and CreatedOn for audit logs will not change in update operation.
clusterAudit.CreatedBy = model.Id
clusterAudit.UpdatedBy = model.UpdatedBy

iamayushm · 2023-04-27T11:49:57Z

pkg/cluster/ClusterNoteService.go

+	clusterAudit.UpdatedOn = time.Now()
+	err = impl.clusterNoteHistoryRepository.SaveHistory(clusterAudit)
+	if err != nil {
+		return nil, err


As user main flow (saving cluster description) is not getting affected by audit logs, don't return error in this case, only log it

implemented 👍

iamayushm · 2023-04-27T11:54:45Z

pkg/cluster/ClusterNoteService.go

+	Description string    `json:"description" validate:"required"`
+	UpdatedBy   int       `json:"updated_by"`
+	UpdatedOn   time.Time `json:"updated_on"`
+}


is this needed?

yeah this is required for unmarshalling of ClusterNoteRepository

iamayushm · 2023-04-27T12:07:02Z

scripts/sql/133_alter_cluster_details.up.sql

+
+-- add foreign key
+ALTER TABLE "public"."cluster_note"
+    ADD FOREIGN KEY ("cluster_id") REFERENCES "public"."cluster" ("id");


add foreign key in table create query, alter query not required

implemented 👍

iamayushm · 2023-04-27T12:56:30Z

api/cluster/ClusterRestHandler.go

+	}
+	//RBAC enforcer Ends
+	bean, err := impl.clusterNoteService.FindByClusterId(i)
+	if err != nil {


use join instead of two queries

implemented 👍

sonarqubecloud · 2023-05-05T10:49:57Z

SonarCloud Quality Gate failed.

0 Bugs
0 Vulnerabilities
0 Security Hotspots
5 Code Smells

No Coverage information
4.2% Duplication

Ash-exp added 4 commits March 22, 2023 15:15

feat:Cluster description note added

4d2fb76

Merge branch 'main' into feature-cluster-description

234e1f7

fixed bugs and modifed

716fb9b

updated rback and removed unnecessary context

e6e1a0c

Ash-exp added the enhancement New feature or request label Mar 22, 2023

Ash-exp requested review from iamayushm and vikramdevtron March 22, 2023 12:39

Ash-exp self-assigned this Mar 22, 2023

vikramdevtron reviewed Mar 22, 2023

View reviewed changes

Ash-exp added 6 commits March 22, 2023 19:31

updated validations

8765936

added Integration test cases

299b4aa

incorporated the feedbacks

1b9516b

Merge branch 'main' into feature-cluster-description

800f24c

updated the migration script numbers

64e12cb

updated param name for id

5ce5601

Ash-exp added 7 commits April 24, 2023 17:00

migration scripts updated

9dda6e9

Merge branch 'main' into feature-cluster-description

7c56b3b

error handler update and rbac added

3122cbc

updated and sanity

d911fd0

fixed bug while saving

2bb0d72

updated the integration test case

5753ede

Merge branch 'main' into feature-cluster-description

1e4bc05

iamayushm reviewed Apr 27, 2023

View reviewed changes

updated and refactored

4065da9

Ash-exp added 4 commits May 1, 2023 01:49

updated intigration test

f04e982

Merge branch 'main' into feature-cluster-description

948ec9b

updated wire_gen

3de0ed7

updated integration test case

cc183f3

iamayushm previously approved these changes May 1, 2023

View reviewed changes

updated Rbac and audit save bug

2da511a

Ash-exp dismissed iamayushm’s stale review via 2da511a May 1, 2023 12:08

Ash-exp added 3 commits May 2, 2023 14:09

Merge branch 'main' into feature-cluster-description

c0c25ef

updated migration count

2cf4dde

Merge branch 'main' into feature-cluster-description

db5f280

iamayushm approved these changes May 5, 2023

View reviewed changes

Merge branch 'main' into feature-cluster-description

8ee8fc7

Ash-exp merged commit 854de20 into main May 5, 2023

Ash-exp deleted the feature-cluster-description branch May 5, 2023 10:50

feat:Cluster description note #3174

feat:Cluster description note #3174

Uh oh!

Conversation

Ash-exp commented Mar 22, 2023 • edited by prakarsh-dt Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

How Has This Been Tested?

Checklist:

Does this PR introduce a user-facing change?

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!

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!

sonarqubecloud bot commented Mar 23, 2023

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!

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!

sonarqubecloud bot commented May 5, 2023

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

Ash-exp commented Mar 22, 2023 •

edited by prakarsh-dt

Loading