Mark graph object readonly #1122
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Updated the GraphObjectIteratee type to have a readonly entity parameter. When entities are being iterated in the graph store, they should never be modified. This change will indicate what integrations are breaking this pattern. - Add GraphObjectStore test that demonstrates entities are readonly during iteration. This can be ignored to avoid TS errors.
VDubber
commented
Sep 19, 2024
| @@ -4,7 +4,7 @@ export interface GraphObjectFilter { | |||
| _type: string; | |||
| } | |||
|
|
|||
| export type GraphObjectIteratee<T> = (obj: T) => void | Promise<void>; | |||
| export type GraphObjectIteratee<T> = (obj: Readonly<T>) => void | Promise<void>; | |||
There was a problem hiding this comment.
I'd consider this change a major version bump. Agreed?
There was a problem hiding this comment.
I've decided that since this is enforcing a pre-existing understanding/pattern, it should only be a minor version bump.
gastonyelmini
previously approved these changes
Sep 19, 2024
| @@ -506,6 +506,34 @@ describe('findEntity', () => { | |||
| }); | |||
|
|
|||
| describe('iterateEntities', () => { | |||
| test('iterated entities are mutable, but only if TS error is ignored.', async () => { | |||
RonaldEAM
previously approved these changes
Sep 19, 2024
VDubber
dismissed stale reviews from RonaldEAM and gastonyelmini
via
133dee8
…d within this monorepo. This should improve ability to use alpha packages in the future.
Gonzalo-Avalos-Ribas
previously approved these changes
Sep 19, 2024
|
New and removed dependencies detected. Learn more about Socket for GitHub ↗︎
🚮 Removed packages: npm/@jupiterone/[email protected], npm/@jupiterone/[email protected], npm/@jupiterone/[email protected], npm/@jupiterone/[email protected], npm/@jupiterone/[email protected], npm/@jupiterone/[email protected], npm/@jupiterone/[email protected] |
Gonzalo-Avalos-Ribas
approved these changes
Sep 19, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
When graph objects are iterated, mark them as Readonly.
Clean up unnecessary debugging logs.