-
Notifications
You must be signed in to change notification settings - Fork 8.3k
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.
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
[Security Solution] Resolver retrieve entity id of documents without field mapped #76562
Changes from 8 commits
3c3cba4
e4c5153
96392fa
b8af2f2
1e37369
dcf5369
e0a62b3
e97352c
97e14dd
e529bee
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,92 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
|
||
import { | ||
ResolverRelatedEvents, | ||
ResolverTree, | ||
ResolverEntityIndex, | ||
} from '../../../../common/endpoint/types'; | ||
import { mockEndpointEvent } from '../../mocks/endpoint_event'; | ||
import { mockTreeWithNoAncestorsAnd2Children } from '../../mocks/resolver_tree'; | ||
import { DataAccessLayer } from '../../types'; | ||
|
||
interface Metadata { | ||
/** | ||
* The `_id` of the document being analyzed. | ||
*/ | ||
databaseDocumentID: string; | ||
/** | ||
* A record of entityIDs to be used in tests assertions. | ||
*/ | ||
entityIDs: { | ||
/** | ||
* The entityID of the node related to the document being analyzed. | ||
*/ | ||
origin: 'origin'; | ||
/** | ||
* The entityID of the first child of the origin. | ||
*/ | ||
firstChild: 'firstChild'; | ||
/** | ||
* The entityID of the second child of the origin. | ||
*/ | ||
secondChild: 'secondChild'; | ||
}; | ||
} | ||
|
||
/** | ||
* A simple mock dataAccessLayer possible that returns a tree with 0 ancestors and 2 direct children. 1 related event is returned. The parameter to `entities` is ignored. | ||
*/ | ||
export function handleNoIndices(): { dataAccessLayer: DataAccessLayer; metadata: Metadata } { | ||
const metadata: Metadata = { | ||
databaseDocumentID: '_id', | ||
entityIDs: { origin: 'origin', firstChild: 'firstChild', secondChild: 'secondChild' }, | ||
}; | ||
return { | ||
metadata, | ||
dataAccessLayer: { | ||
/** | ||
* Fetch related events for an entity ID | ||
*/ | ||
relatedEvents(entityID: string): Promise<ResolverRelatedEvents> { | ||
return Promise.resolve({ | ||
entityID, | ||
events: [ | ||
mockEndpointEvent({ | ||
entityID, | ||
name: 'event', | ||
timestamp: 0, | ||
}), | ||
], | ||
nextEvent: null, | ||
}); | ||
}, | ||
|
||
/** | ||
* Fetch a ResolverTree for a entityID | ||
*/ | ||
resolverTree(): Promise<ResolverTree> { | ||
return Promise.resolve( | ||
mockTreeWithNoAncestorsAnd2Children({ | ||
originID: metadata.entityIDs.origin, | ||
firstChildID: metadata.entityIDs.firstChild, | ||
secondChildID: metadata.entityIDs.secondChild, | ||
}) | ||
); | ||
}, | ||
|
||
/** | ||
* Get entities matching a document. | ||
*/ | ||
entities({ indices }): Promise<ResolverEntityIndex> { | ||
if (indices.length === 1 && indices[0] === 'awesome_index') { | ||
return Promise.resolve([{ entity_id: metadata.entityIDs.origin }]); | ||
} | ||
return Promise.resolve([]); | ||
}, | ||
}, | ||
}; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,17 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
|
||
import { TreeFetcherParameters } from '../types'; | ||
|
||
/** | ||
* A factory for the most basic `TreeFetcherParameters`. Many tests need to provide this even when the values aren't relevant to the test. | ||
*/ | ||
export function mockTreeFetcherParameters(): TreeFetcherParameters { | ||
return { | ||
databaseDocumentID: '', | ||
indices: [], | ||
}; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
|
||
import { TreeFetcherParameters } from '../types'; | ||
|
||
import { equal } from './tree_fetcher_parameters'; | ||
describe('TreeFetcherParameters#equal:', () => { | ||
const cases: Array<[TreeFetcherParameters, TreeFetcherParameters, boolean]> = [ | ||
// different databaseDocumentID | ||
[{ databaseDocumentID: 'a', indices: [] }, { databaseDocumentID: 'b', indices: [] }, false], | ||
// different indices length | ||
[{ databaseDocumentID: 'a', indices: [''] }, { databaseDocumentID: 'a', indices: [] }, false], | ||
// same indices length, different databaseDocumentID | ||
[{ databaseDocumentID: 'a', indices: [''] }, { databaseDocumentID: 'b', indices: [''] }, false], | ||
// 1 item in `indices` | ||
[{ databaseDocumentID: 'b', indices: [''] }, { databaseDocumentID: 'b', indices: [''] }, true], | ||
// 2 item in `indices` | ||
[ | ||
{ databaseDocumentID: 'b', indices: ['1', '2'] }, | ||
{ databaseDocumentID: 'b', indices: ['1', '2'] }, | ||
true, | ||
], | ||
// 2 item in `indices`, but order inversed | ||
[ | ||
{ databaseDocumentID: 'b', indices: ['2', '1'] }, | ||
{ databaseDocumentID: 'b', indices: ['1', '2'] }, | ||
true, | ||
], | ||
]; | ||
describe.each(cases)('%p when compared to %p', (first, second, expected) => { | ||
it(`should ${expected ? '' : 'not'}be equal`, () => { | ||
expect(equal(first, second)).toBe(expected); | ||
}); | ||
}); | ||
}); |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,40 @@ | ||
/* | ||
* Copyright Elasticsearch B.V. and/or licensed to Elasticsearch B.V. under one | ||
* or more contributor license agreements. Licensed under the Elastic License; | ||
* you may not use this file except in compliance with the Elastic License. | ||
*/ | ||
|
||
import { TreeFetcherParameters } from '../types'; | ||
|
||
/** | ||
* Determine if two instances of `TreeFetcherParameters` are equivalent. Use this to determine if | ||
* a change to a `TreeFetcherParameters` warrants invaliding a request or response. | ||
*/ | ||
export function equal(param1: TreeFetcherParameters, param2?: TreeFetcherParameters): boolean { | ||
if (!param2) { | ||
return false; | ||
} | ||
if (param1 === param2) { | ||
return true; | ||
} | ||
if (param1.databaseDocumentID !== param2.databaseDocumentID) { | ||
return false; | ||
} | ||
return arrayEqual(param1.indices, param2.indices); | ||
} | ||
|
||
function arrayEqual(first: unknown[], second: unknown[]): boolean { | ||
if (first === second) { | ||
return true; | ||
} | ||
if (first.length !== second.length) { | ||
return false; | ||
} | ||
const firstSet = new Set(first); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. ℹ️ It could be a WeakSet! It's your big chance WeakSet get in there! 🤣 There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. haha I think to use a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You're right 😢 next time, WeakSet |
||
for (let index = 0; index < second.length; index++) { | ||
if (!firstSet.has(second[index])) { | ||
return false; | ||
} | ||
} | ||
return true; | ||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -115,7 +115,7 @@ interface AppReceivedNewExternalProperties { | |
/** | ||
* the `_id` of an ES document. This defines the origin of the Resolver graph. | ||
*/ | ||
databaseDocumentID?: string; | ||
databaseDocumentID: string; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is required by |
||
/** | ||
* An ID that uniquely identifies this Resolver instance from other concurrent Resolvers. | ||
*/ | ||
|
@@ -125,6 +125,11 @@ interface AppReceivedNewExternalProperties { | |
* The `search` part of the URL of this page. | ||
*/ | ||
locationSearch: string; | ||
|
||
/** | ||
* Indices that the backend will use to find the document. | ||
*/ | ||
indices: string[]; | ||
}; | ||
} | ||
|
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,6 +5,7 @@ | |
*/ | ||
|
||
import { ResolverRelatedEvents, ResolverTree } from '../../../../common/endpoint/types'; | ||
import { TreeFetcherParameters } from '../../types'; | ||
|
||
interface ServerReturnedResolverData { | ||
readonly type: 'serverReturnedResolverData'; | ||
|
@@ -14,9 +15,9 @@ interface ServerReturnedResolverData { | |
*/ | ||
result: ResolverTree; | ||
/** | ||
* The database document ID that was used to fetch the resolver tree | ||
* The database parameters that was used to fetch the resolver tree | ||
*/ | ||
databaseDocumentID: string; | ||
parameters: TreeFetcherParameters; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. instead of keeping track of just the |
||
}; | ||
} | ||
|
||
|
@@ -25,23 +26,23 @@ interface AppRequestedResolverData { | |
/** | ||
* entity ID used to make the request. | ||
*/ | ||
readonly payload: string; | ||
readonly payload: TreeFetcherParameters; | ||
} | ||
|
||
interface ServerFailedToReturnResolverData { | ||
readonly type: 'serverFailedToReturnResolverData'; | ||
/** | ||
* entity ID used to make the failed request | ||
*/ | ||
readonly payload: string; | ||
readonly payload: TreeFetcherParameters; | ||
} | ||
|
||
interface AppAbortedResolverDataRequest { | ||
readonly type: 'appAbortedResolverDataRequest'; | ||
/** | ||
* entity ID used to make the aborted request | ||
*/ | ||
readonly payload: string; | ||
readonly payload: TreeFetcherParameters; | ||
} | ||
|
||
/** | ||
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The indices to use are now passed in to Resolver via props from the Security Solution app.