Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Delete threat intel source config API #1066

Merged
merged 9 commits into from
Jun 13, 2024
Merged

Delete threat intel source config API #1066

merged 9 commits into from
Jun 13, 2024

Conversation

jowg-amazon
Copy link
Collaborator

Description

Architecture for delete threat intel source config API

Issues Resolved

[List any issues this PR will resolve]

Check List

  • New functionality includes testing.
    • All tests pass
  • New functionality has been documented.
    • New functionality has javadoc added
  • Commits are signed per the DCO using --signoff

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.
For more information on following Developer Certificate of Origin and signing off your commits, please check here.

@jowg-amazon
delete api
4c92ffd 
Signed-off-by: Joanne Wang <[email protected]>
@jowg-amazon
clean up
0f4fa85 
Signed-off-by: Joanne Wang <[email protected]>
@jowg-amazon
delete api integ test
f12483b 
Signed-off-by: Joanne Wang <[email protected]>
AWSHurneyt
AWSHurneyt reviewed Jun 11, 2024
View reviewed changes
...java/org/opensearch/securityanalytics/threatIntel/action/SADeleteTIFSourceConfigRequest.java Outdated

@Override
public ActionRequestValidationException validate() {
return null;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should there be a check here to assert that the id is not null or empty?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Added a check to ensure id exists

...org/opensearch/securityanalytics/threatIntel/service/SATIFSourceConfigManagementService.java
@@ -158,7 +159,8 @@ public void deleteTIFSourceConfig(
SATIFSourceConfig SaTifSourceConfig = convertToSATIFConfig(SaTifSourceConfigDto);
SaTifSourceConfigService.deleteTIFSourceConfig(SaTifSourceConfig, ActionListener.wrap(
deleteResponse -> {
log.debug("Successfully deleted threat intel source config");
log.debug("Successfully deleted threat intel source config [{}]", SaTifSourceConfig.getId());
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not blocking, but should we consider making this an info-level log?

...main/java/org/opensearch/securityanalytics/threatIntel/service/SATIFSourceConfigService.java
@@ -248,7 +246,7 @@ public void deleteTIFSourceConfig(
client.delete(request, ActionListener.wrap(
deleteResponse -> {
if (deleteResponse.status().equals(RestStatus.OK)) {
log.info("Deleted threat intel source config [{}] successfully", SaTifSourceConfig.getId());
log.debug("Deleted threat intel source config [{}] successfully", SaTifSourceConfig.getId());
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same question as above.

@jowg-amazon
added validation logic
c259baf 
Signed-off-by: Joanne Wang <[email protected]>
eirsep
eirsep reviewed Jun 12, 2024
View reviewed changes
...ava/org/opensearch/securityanalytics/threatIntel/action/SADeleteTIFSourceConfigResponse.java

public class SADeleteTIFSourceConfigResponse extends ActionResponse implements ToXContentObject {
private final String id;
private final RestStatus status;
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

what status implies deleted?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if the delete response is OK then the document is deleted successfully.

eirsep
eirsep reviewed Jun 12, 2024
View reviewed changes
src/main/java/org/opensearch/securityanalytics/threatIntel/common/Constants.java Outdated
@@ -10,4 +10,6 @@
public class Constants {
public static final String USER_AGENT_KEY = "User-Agent";
public static final String USER_AGENT_VALUE = String.format(Locale.ROOT, "OpenSearch/%s vanilla", Version.CURRENT.toString());
public static final String SOURCE_CONFIG_ID = "source_config_id";
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

MEGA-NIT: threat_intel_source_config_id?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed to threat_intel_source_config_id

eirsep
eirsep reviewed Jun 12, 2024
View reviewed changes
...rg/opensearch/securityanalytics/threatIntel/resthandler/RestDeleteTIFSourceConfigAction.java Outdated

@Override
protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
String SaTifSourceConfigId = request.param(SOURCE_CONFIG_ID, SATIFSourceConfigDto.NO_ID);
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lower case letter to begin variable name

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fixed

eirsep
eirsep reviewed Jun 12, 2024
View reviewed changes
...rg/opensearch/securityanalytics/threatIntel/resthandler/RestDeleteTIFSourceConfigAction.java Outdated
protected RestChannelConsumer prepareRequest(RestRequest request, NodeClient client) throws IOException {
String SaTifSourceConfigId = request.param(SOURCE_CONFIG_ID, SATIFSourceConfigDto.NO_ID);

if (SaTifSourceConfigId == null || SaTifSourceConfigId.isEmpty()) {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Stringutils.isBlank() instead

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

changed

eirsep
eirsep requested changes Jun 12, 2024
View reviewed changes
Copy link
Member

@eirsep eirsep left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

if there is only one config and it it's being deleted we need to ensure there are no jobs
Fail the delete request of the config saying plz delete all threat intel monitors before deleting the last config

@jowg-amazon
respond to comments
39ac4a9 
Signed-off-by: Joanne Wang <[email protected]>
@jowg-amazon
Copy link
Collaborator Author

if there is only one config and it it's being deleted we need to ensure there are no jobs Fail the delete request of the config saying plz delete all threat intel monitors before deleting the last config

Added a method checkAndEnsureThreatIntelMonitorsDeleted that checks if the source config to be deleted is the last one and if so, makes sure that all threat intel monitors have been deleted. Otherwise it throws an exception.

@jowg-amazon jowg-amazon merged commit 686d317 into opensearch-project:feature/threat_intel Jun 13, 2024
2 checks passed
AWSHurneyt pushed a commit to AWSHurneyt/security-analytics that referenced this pull request Jun 25, 2024
@jowg-amazon @AWSHurneyt
Delete threat intel source config API (opensearch-project#1066)
69b22e8 
* delete api

Signed-off-by: Joanne Wang <[email protected]>

* clean up

Signed-off-by: Joanne Wang <[email protected]>

* delete api integ test

Signed-off-by: Joanne Wang <[email protected]>

* added validation logic

Signed-off-by: Joanne Wang <[email protected]>

* respond to comments

Signed-off-by: Joanne Wang <[email protected]>

* fix merge conflicts

Signed-off-by: Joanne Wang <[email protected]>

* fix merge conflicts

Signed-off-by: Joanne Wang <[email protected]>

---------

Signed-off-by: Joanne Wang <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AWSHurneyt AWSHurneyt AWSHurneyt approved these changes

@eirsep eirsep eirsep approved these changes

@amsiglan amsiglan Awaiting requested review from amsiglan amsiglan is a code owner

@getsaurabh02 getsaurabh02 Awaiting requested review from getsaurabh02 getsaurabh02 is a code owner

@lezzago lezzago Awaiting requested review from lezzago lezzago is a code owner

@praveensameneni praveensameneni Awaiting requested review from praveensameneni praveensameneni is a code owner

@sbcd90 sbcd90 Awaiting requested review from sbcd90 sbcd90 is a code owner

@engechas engechas Awaiting requested review from engechas engechas is a code owner

@goyamegh goyamegh Awaiting requested review from goyamegh goyamegh is a code owner

@riysaxen-amzn riysaxen-amzn Awaiting requested review from riysaxen-amzn riysaxen-amzn is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@jowg-amazon @eirsep @AWSHurneyt