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

x-pack/filebeat/input/entityanalytics/provider/okta: avoid work on unwanted datasets #36770

Merged
merged 1 commit into from
Oct 9, 2023
Merged

x-pack/filebeat/input/entityanalytics/provider/okta: avoid work on unwanted datasets #36770

merged 1 commit into from
Oct 9, 2023

Conversation

efd6
Copy link
Contributor

@efd6 efd6 commented Oct 5, 2023

Proposed commit message

During full sync the provider may have state from a previous dataset. So in the case that the user has changed dataset from users to devices or vice versa the provider may publish already existing state in the entity graph. This change adds conditional checks to ensure that unwanted dataset records are not published.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

Author's Checklist

  • [ ]

How to test this PR locally

Related issues

Use cases

Screenshots

Logs

@efd6 efd6 added enhancement Filebeat Filebeat Team:Security-External Integrations backport-skip Skip notification from the automated backport with mergify 8.12-candidate labels Oct 5, 2023
@efd6 efd6 self-assigned this Oct 5, 2023
@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Oct 5, 2023
@efd6 efd6 force-pushed the okta_avoid_unwanted_work branch from e1fd228 to 124ad75 Compare October 5, 2023 19:59
@elasticmachine
Copy link
Collaborator

elasticmachine commented Oct 5, 2023 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2023-10-07T01:47:05.952+0000

  • Duration: 73 min 53 sec

Test stats 🧪

Test Results
Failed 0
Passed 3209
Skipped 174
Total 3383

💚 Flaky test report

Tests succeeded.

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate the packages and run the E2E tests.

  • /beats-tester : Run the installation tests with beats-tester.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@efd6 efd6 marked this pull request as ready for review October 5, 2023 21:20
@efd6 efd6 requested a review from a team as a code owner October 5, 2023 21:20
@elasticmachine
Copy link
Collaborator

Pinging @elastic/security-external-integrations (Team:Security-External Integrations)

@mergify
Copy link
Contributor

mergify bot commented Oct 6, 2023

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b okta_avoid_unwanted_work upstream/okta_avoid_unwanted_work
git merge upstream/main
git push upstream okta_avoid_unwanted_work

@efd6 efd6 force-pushed the okta_avoid_unwanted_work branch from 124ad75 to 14745f6 Compare October 6, 2023 23:29
@mergify
Copy link
Contributor

mergify bot commented Oct 7, 2023

This pull request is now in conflicts. Could you fix it? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b okta_avoid_unwanted_work upstream/okta_avoid_unwanted_work
git merge upstream/main
git push upstream okta_avoid_unwanted_work

@efd6
x-pack/filebeat/input/entityanalytics/provider/okta: avoid work on un…
4bc0ac2 
…wanted datasets

During full sync the provider may have state from a previous dataset. So
in the case that the user has changed dataset from users to devices or
vice versa the provider may publish already existing state in the entity
graph. This change adds conditional checks to ensure that unwanted
dataset records are not published.
@efd6 efd6 force-pushed the okta_avoid_unwanted_work branch from 14745f6 to 4bc0ac2 Compare October 7, 2023 01:46
bhapas
bhapas reviewed Oct 9, 2023
View reviewed changes
x-pack/filebeat/input/entityanalytics/provider/okta/okta.go
tracker := kvstore.NewTxTracker(ctx)

start := time.Now()
p.publishMarker(start, start, inputCtx.ID, true, client, tracker)
for _, u := range state.users {
p.publishUser(u, state, inputCtx.ID, client, tracker)
if wantUsers {
Copy link
Contributor

Choose a reason for hiding this comment

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

Looks like this entire function runFullSync is untested.. Is it possible to mock kvstore and add some unit tests?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I don't see an easy way to do that.

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah. May be an improvement task for later

@efd6 efd6 merged commit 1b3786e into elastic:main Oct 9, 2023
5 of 8 checks passed
Scholar-Li pushed a commit to Scholar-Li/beats that referenced this pull request Feb 5, 2024
@efd6 @Scholar-Li
x-pack/filebeat/input/entityanalytics/provider/okta: avoid work on un…
7abd57d 
…wanted datasets (elastic#36770)

During full sync the provider may have state from a previous dataset. So
in the case that the user has changed dataset from users to devices or
vice versa the provider may publish already existing state in the entity
graph. This change adds conditional checks to ensure that unwanted
dataset records are not published.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@bhapas bhapas bhapas approved these changes

Assignees

@efd6 efd6

Labels
8.12-candidate backport-skip Skip notification from the automated backport with mergify enhancement Filebeat Filebeat
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@efd6 @elasticmachine @bhapas