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

Mark graph object readonly #1122

Merged
merged 6 commits into from
Sep 19, 2024
+127 −89
Merged

Mark graph object readonly #1122

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
b46acb4
- removed unnecessary logging
VDubber Sep 19, 2024
147a271
Clean up lint errors
VDubber Sep 19, 2024
133dee8
Update comment.
VDubber Sep 19, 2024
54143cf
Update package locks to point to non-carret versions of packages foun…
VDubber Sep 19, 2024
91f237a
update CHANGELOG.md for 13.6.0
VDubber Sep 19, 2024
1347ff9
v13.6.0
VDubber Sep 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,20 @@ and this project adheres to

# Unreleased

# 13.6.0 - 2024-09-19

- Minor breaking change to JobState methods iterateEntities and
iterateRelationships function signatures. The graph object passed to the
iteratee is now Readonly. The intention is to prevent modification of the
object during iteration. This is not a breaking change since the long-standing
understanding is that these objects should never be modified once added to the
jobState.

```diff
- export type GraphObjectIteratee<T> = (obj: T) => void | Promise<void>;
+ export type GraphObjectIteratee<T> = (obj: Readonly<T>) => void | Promise<void>;
```

# 13.5.2 - 2024-09-17

- Temporary logging that should be removed after investigation.
Expand Down
2 changes: 1 addition & 1 deletion lerna.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,5 +4,5 @@
"packages/integration-sdk-*",
"packages/cli"
],
"version": "13.5.2"
"version": "13.6.0"
}
62 changes: 31 additions & 31 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions packages/cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jupiterone/cli",
"version": "13.5.2",
"version": "13.6.0",
"description": "The JupiterOne cli",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand All @@ -24,8 +24,8 @@
"test": "jest"
},
"dependencies": {
"@jupiterone/integration-sdk-core": "^13.5.2",
"@jupiterone/integration-sdk-runtime": "^13.5.2",
"@jupiterone/integration-sdk-core": "^13.6.0",
"@jupiterone/integration-sdk-runtime": "^13.6.0",
"@lifeomic/attempt": "^3.0.3",
"commander": "^5.0.0",
"globby": "^11.0.1",
Expand Down
6 changes: 3 additions & 3 deletions packages/integration-sdk-benchmark/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jupiterone/integration-sdk-benchmark",
"version": "13.5.2",
"version": "13.6.0",
"private": true,
"description": "SDK benchmarking scripts",
"main": "./src/index.js",
Expand All @@ -15,8 +15,8 @@
"benchmark": "for file in ./src/benchmarks/*; do npm run prebenchmark && node $file; done"
},
"dependencies": {
"@jupiterone/integration-sdk-core": "^13.5.2",
"@jupiterone/integration-sdk-runtime": "^13.5.2",
"@jupiterone/integration-sdk-core": "^13.6.0",
"@jupiterone/integration-sdk-runtime": "^13.6.0",
"benchmark": "^2.1.4"
}
}
8 changes: 4 additions & 4 deletions packages/integration-sdk-cli/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jupiterone/integration-sdk-cli",
"version": "13.5.2",
"version": "13.6.0",
"description": "The SDK for developing JupiterOne integrations",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand All @@ -26,8 +26,8 @@
},
"dependencies": {
"@jupiterone/data-model": "^0.61.11",
"@jupiterone/integration-sdk-core": "^13.5.2",
"@jupiterone/integration-sdk-runtime": "^13.5.2",
"@jupiterone/integration-sdk-core": "^13.6.0",
"@jupiterone/integration-sdk-runtime": "^13.6.0",
"chalk": "^4",
"commander": "^9.4.0",
"ejs": "^3.1.9",
Expand All @@ -45,7 +45,7 @@
"url-exists": "^1.0.3"
},
"devDependencies": {
"@jupiterone/integration-sdk-private-test-utils": "^13.5.2",
"@jupiterone/integration-sdk-private-test-utils": "^13.6.0",
"@pollyjs/adapter-node-http": "^6.0.5",
"@pollyjs/core": "^6.0.5",
"@pollyjs/persister-fs": "^6.0.5",
Expand Down
4 changes: 2 additions & 2 deletions packages/integration-sdk-core/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jupiterone/integration-sdk-core",
"version": "13.5.2",
"version": "13.6.0",
"description": "The SDK for developing JupiterOne integrations",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand All @@ -24,7 +24,7 @@
},
"dependencies": {
"@jupiterone/data-model": "^0.61.11",
"@jupiterone/integration-sdk-entity-validator": "^13.5.2",
"@jupiterone/integration-sdk-entity-validator": "^13.6.0",
"@sinclair/typebox": "^0.32.30",
"lodash": "^4.17.21"
},
Expand Down
12 changes: 11 additions & 1 deletion packages/integration-sdk-core/src/types/jobState.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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>;
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'd consider this change a major version bump. Agreed?

Copy link
Contributor Author

@VDubber VDubber Sep 19, 2024 •
edited
Loading

Choose a reason for hiding this comment

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

I've decided that since this is enforcing a pre-existing understanding/pattern, it should only be a minor version bump.

export type GraphObjectIterateeOptions = {
concurrency?: number;
};
Expand Down Expand Up @@ -104,6 +104,11 @@ export interface JobState {
* have run and therefore entities collected by those other steps should not
* be expected to exist.
*
* The graph object parameter passed to the iteratee is marked as Readonly.
* Once created and added to the JobState, graph objects should be considered immutable.
* Modifying a graph object during iteration can result in undesirable behavior
* since objects are upload to JupiterOne at non-regular intervals.
*
* If concurrency is specified (defaults to 1), the iteratee will be executed
* concurrently for graph objects that are found in memory and for
* graph objects found in a given graph file. No specific ordering is guaranteed.
Expand Down Expand Up @@ -136,6 +141,11 @@ export interface JobState {
* may not have run and therefore relationships collected by those other steps
* should not be expected to exist.
*
* The graph object parameter passed to the iteratee is marked as Readonly.
* Once created and added to the JobState, graph objects should be considered immutable.
* Modifying a graph object during iteration can result in undesirable behavior
* since objects are upload to JupiterOne at non-regular intervals.
*
* If concurrency is specified (defaults to 1), the iteratee will be executed
* concurrently for graph objects that are found in memory and for
* graph objects found in a given graph file. No specific ordering is guaranteed.
Expand Down
6 changes: 3 additions & 3 deletions packages/integration-sdk-dev-tools/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jupiterone/integration-sdk-dev-tools",
"version": "13.5.2",
"version": "13.6.0",
"description": "A collection of developer tools that will assist with building integrations.",
"repository": "[email protected]:JupiterOne/sdk.git",
"author": "JupiterOne <[email protected]>",
Expand All @@ -15,8 +15,8 @@
"access": "public"
},
"dependencies": {
"@jupiterone/integration-sdk-cli": "^13.5.2",
"@jupiterone/integration-sdk-testing": "^13.5.2",
"@jupiterone/integration-sdk-cli": "^13.6.0",
"@jupiterone/integration-sdk-testing": "^13.6.0",
"@types/jest": "^29.5.3",
"@types/node": "^18",
"@typescript-eslint/eslint-plugin": "^6.2.1",
Expand Down
2 changes: 1 addition & 1 deletion packages/integration-sdk-entities/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jupiterone/integration-sdk-entities",
"version": "13.5.2",
"version": "13.6.0",
"description": "Generated types for the JupiterOne data-model",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand Down
2 changes: 1 addition & 1 deletion packages/integration-sdk-entity-validator/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jupiterone/integration-sdk-entity-validator",
"version": "13.5.2",
"version": "13.6.0",
"description": "Validator for JupiterOne integration entities",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand Down
8 changes: 4 additions & 4 deletions packages/integration-sdk-http-client/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@jupiterone/integration-sdk-http-client",
"version": "13.5.2",
"version": "13.6.0",
"description": "The HTTP client for use in JupiterOne integrations",
"main": "dist/src/index.js",
"types": "dist/src/index.d.ts",
Expand All @@ -24,15 +24,15 @@
},
"dependencies": {
"@jupiterone/hierarchical-token-bucket": "^0.3.1",
"@jupiterone/integration-sdk-core": "^13.5.2",
"@jupiterone/integration-sdk-core": "^13.6.0",
"@lifeomic/attempt": "^3.0.3",
"form-data": "^4.0.0",
"lodash": "^4.17.21",
"node-fetch": "^2.7.0"
},
"devDependencies": {
"@jupiterone/integration-sdk-dev-tools": "^13.5.2",
"@jupiterone/integration-sdk-private-test-utils": "^13.5.2",
"@jupiterone/integration-sdk-dev-tools": "^13.6.0",
"@jupiterone/integration-sdk-private-test-utils": "^13.6.0",
"@types/node-fetch": "^2.6.11"
},
"bugs": {
Expand Down
Loading