feat: Add "space-variants" feature by spex66 · Pull Request #110 · cognitedata/inso-bootstrap-cli

spex66 · 2025-03-31T19:23:13Z

new version 3.5.0
update to latest cdf-sdk v7
- small changes how to create Group / Capabilties and spaces.apply
adding new feature to node level to define list of space-variants
- space-variants: ["i", "m"]
suffix added to the very end (after -spc) like for rawdb-variants
refactoring needed to not only use node_name: str as parameter but node: NamespaceNode
difference to rawdb-variants is, that it is not globally but locally configured
might mitigate the pain until "nested space access-control" is available

technical-debt / design-flaw

space-variants are good to create multiple spaces easily, but they fail if access-control is required on a granular level.

-spc-m typically representing data-models
-spc-i typically data-instances

with the approach, it is not possible to separate read/write access between the two spaces.

That's a technical debt, which needs to be resolved with switching to cdf-tk approach, or once we can switch to "nested spaces access-control"

for now the approach provides convenience (speed&simplicity) for increasing demand for spaces to get work done

- new version 3.5.0 - update to latest cdf-sdk v7 - adding new feature to node level to define list of space-variants - suffix at the very end (after `-spc`) - refactoring needed to not only use `node_name: str` as parameter but `node: NamespaceNode` - difference to rawdb-variants is, that it is not globally but locally configured - might mitigate the pain until "nested space access-control" is available

- cleanup `Optional[]` where there is a default-value - cleanup test print from pytest case

> .. it uses a deprecated version of `actions/cache: v3.3.2`. Please update your workflow to use v3/v4 of actions/cache to avoid interruptions

src/bootstrap/app_config.py

configs/config-deploy-example-v3.yml

psalaberria002 · 2025-04-01T12:35:47Z

src/bootstrap/app_cache.py

+        # item = convert_time_attributes_to_datetime(self.dump())
+        # return json.dumps(item, default=utils._auxiliary.json_dump_default, indent=4)


do you need to keep these?

psalaberria002 · 2025-04-01T12:36:33Z

src/bootstrap/app_config.py

+    with_raw_capability: bool = True
+    with_datamodel_capability: bool = True
+    with_undocumented_capabilities: bool = False
+    group_prefix: str = "cdf"
+    aggregated_level_name: str = "allprojects"
+    dataset_suffix: str = "dataset"
+    space_suffix: str = "space"
+    rawdb_suffix: str = "rawdb"
+    rawdb_additional_variants: list[str] = ["state"]


This is a breaking change. Is it a safe change? Will clients using your library break?

it is fully backward compatible, but from 3.5.0 onward supports a new (additional) config

semantic versioning from 3.4.1 to 3.5.0 is indicating that, and release-notes will too

From what I understand, something that was optional before is now mandatory. I see that as breaking. Did I misunderstand how it works?

ah you meant removal of Optional[..], that was only done where the default value was not None anyway.

A corner case could be that a yaml-config was configured with null which had before passed a pydantic value-validation

as this was never documented (and makes no sense) it is theoretical

as all have default values it is still optional when parsed by pydantic, just not support None anymore

psalaberria002

I managed to review the PR since it isn't that large, but going forward I don't think we should approve such PRs. See https://cognitedata.slack.com/archives/C0425G1JP2A/p1743509263432649

Once the comments I left in this PR are resolved ping me again for a final risk review.

psalaberria002

🦄

spex66

answered or resolved

spex66 · 2025-04-01T12:48:43Z

src/bootstrap/app_config.py

+    with_raw_capability: bool = True
+    with_datamodel_capability: bool = True
+    with_undocumented_capabilities: bool = False
+    group_prefix: str = "cdf"
+    aggregated_level_name: str = "allprojects"
+    dataset_suffix: str = "dataset"
+    space_suffix: str = "space"
+    rawdb_suffix: str = "rawdb"
+    rawdb_additional_variants: list[str] = ["state"]


ah you meant removal of Optional[..], that was only done where the default value was not None anyway.

A corner case could be that a yaml-config was configured with null which had before passed a pydantic value-validation

as this was never documented (and makes no sense) it is theoretical

spex66 · 2025-04-01T12:50:56Z

src/bootstrap/app_config.py

+    with_raw_capability: bool = True
+    with_datamodel_capability: bool = True
+    with_undocumented_capabilities: bool = False
+    group_prefix: str = "cdf"
+    aggregated_level_name: str = "allprojects"
+    dataset_suffix: str = "dataset"
+    space_suffix: str = "space"
+    rawdb_suffix: str = "rawdb"
+    rawdb_additional_variants: list[str] = ["state"]


as all have default values it is still optional when parsed by pydantic, just not support None anymore

spex66 · 2025-04-01T12:59:58Z

src/bootstrap/app_cache.py

+        # item = convert_time_attributes_to_datetime(self.dump())
+        # return json.dumps(item, default=utils._auxiliary.json_dump_default, indent=4)


spex66 requested a review from a team as a code owner March 31, 2025 19:23

fix:

4b5db93

- cleanup `Optional[]` where there is a default-value - cleanup test print from pytest case

spex66 requested a review from a team April 1, 2025 08:45

fix(gh-action): fixing a deprecation

5361ef9

> .. it uses a deprecated version of `actions/cache: v3.3.2`. Please update your workflow to use v3/v4 of actions/cache to avoid interruptions

psalaberria002 added the risk-review-ongoing Risk review is in progress label Apr 1, 2025

psalaberria002 self-assigned this Apr 1, 2025

ankku reviewed Apr 1, 2025

View reviewed changes

src/bootstrap/app_config.py Show resolved Hide resolved

spex66 changed the title ~~feat(space-variants)~~ Add "space-variants" feature Apr 1, 2025

spex66 changed the title ~~Add "space-variants" feature~~ feat: Add "space-variants" feature Apr 1, 2025

psalaberria002 reviewed Apr 1, 2025

View reviewed changes

configs/config-deploy-example-v3.yml Show resolved Hide resolved

psalaberria002 reviewed Apr 1, 2025

View reviewed changes

fix: resolving comments

9f81778

psalaberria002 approved these changes Apr 1, 2025

View reviewed changes

spex66 commented Apr 1, 2025

View reviewed changes

spex66 merged commit 50fde95 into main Apr 1, 2025
3 checks passed

spex66 deleted the feat/space-variants branch April 1, 2025 13:34

		# item = convert_time_attributes_to_datetime(self.dump())
		# return json.dumps(item, default=utils._auxiliary.json_dump_default, indent=4)

Conversation

spex66 commented Mar 31, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

technical-debt / design-flaw

Uh oh!

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

psalaberria002 left a comment

Choose a reason for hiding this comment

Uh oh!

psalaberria002 left a comment

Choose a reason for hiding this comment

Uh oh!

spex66 left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

spex66 commented Mar 31, 2025 •

edited

Loading