feat(calm-hub): refactored namespaces from simple string to full obect and added description #2084

grahampacker-ms · 2026-01-28T19:32:23Z

Description

Changed the namespace to a full object from a simple string. This will allow future extension without breaking change. This is a data model change so will break existing calm hubs. Given calm-hub is not ready for proper usage I don't think a migration guide is needed.

Type of Change

🐛 Bug fix (non-breaking change which fixes an issue)
✨ New feature (non-breaking change which adds functionality)
💥 Breaking change (fix or feature that would cause existing functionality to not work as expected)
📚 Documentation update
🎨 Code style/formatting changes
♻️ Refactoring (no functional changes)
⚡ Performance improvements
✅ Test additions or updates
🔧 Chore (maintenance, dependencies, CI, etc.)

Affected Components

Commit Message Format ✅

Testing

I have tested my changes locally
I have added/updated unit tests
All existing tests pass

Checklist

My commits follow the conventional commit format
I have updated documentation if necessary
I have added tests for my changes (if applicable)
My changes follow the project's coding standards

markscott-ms · 2026-01-28T20:31:53Z

@grahampacker-ms @willosborne could we have a wider discussion on the roadmap for CalmHub and how these individual changes align to how entitlements, immutable artifact repository, etc, are aligned?

…ct and added description # Conflicts: # package-lock.json

markscott-ms · 2026-02-03T19:04:03Z

@grahampacker-ms and I had a conversation. happy for this PR to proceed - in fact it is definitely necessary.

Copilot

Pull request overview

This PR refactors the namespace representation from a simple string to a full object with name and description fields. This is a breaking change that enables future extensibility without additional breaking changes. The refactoring affects both the calm-hub backend and calm-hub-ui frontend.

Changes:

Introduced a new NamespaceInfo class with name and description fields
Updated NamespaceRequest to include a description field alongside the name field
Modified all store implementations (Nitrite and MongoDB) to handle the new namespace structure
Updated database initialization scripts and integration tests to use the new format
Adapted the UI service to extract name values from the new namespace objects

Reviewed changes

Copilot reviewed 14 out of 14 changed files in this pull request and generated 7 comments.

Show a summary per file

File	Description
calm-hub/src/main/java/org/finos/calm/domain/namespaces/NamespaceInfo.java	New domain class representing namespace information with name and description
calm-hub/src/main/java/org/finos/calm/domain/NamespaceRequest.java	Updated to replace `namespace` field with `name` and added `description` field
calm-hub/src/main/java/org/finos/calm/store/NamespaceStore.java	Updated interface to return `NamespaceInfo` objects and accept separate name/description parameters
calm-hub/src/main/java/org/finos/calm/store/nitrite/NitriteNamespaceStore.java	Updated to store and retrieve namespace objects with name and description fields
calm-hub/src/main/java/org/finos/calm/store/mongo/MongoNamespaceStore.java	Updated to store and retrieve namespace objects with name and description fields
calm-hub/src/main/java/org/finos/calm/resources/NamespaceResource.java	Updated to handle the new namespace structure in API requests and responses
calm-hub/src/test/java/org/finos/calm/store/nitrite/TestNitriteNamespaceStoreShould.java	Updated tests to work with NamespaceInfo objects
calm-hub/src/test/java/org/finos/calm/store/mongo/TestMongoNamespaceStoreShould.java	Updated tests to work with NamespaceInfo objects
calm-hub/src/test/java/org/finos/calm/resources/TestNamespaceResourceShould.java	Updated tests for new API structure and removed redundant comments
calm-hub/src/integration-test/java/integration/PermittedScopesIntegration.java	Updated to verify both name and description fields in responses
calm-hub/src/integration-test/java/integration/MongoNamespaceIntegration.java	Updated to verify both name and description fields in responses
calm-hub/src/integration-test/java/integration/MongoSetup.java	Updated test data to include description field
calm-hub/mongo/init-mongo.js	Updated initialization script to use new namespace structure
calm-hub-ui/src/service/calm-service.tsx	Updated to extract name values from the new namespace object structure

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Copilot · 2026-02-03T19:07:09Z

calm-hub/src/main/java/org/finos/calm/domain/namespaces/NamespaceInfo.java

+public class NamespaceInfo {
+    @NotNull(message = "Name must not be null")
+    @NotBlank(message = "Name must not be blank")
+    private final String name;
+    private final String description;
+
+    public NamespaceInfo(String name, String description) {
+        this.name = name;
+        this.description = description;
+    }
+
+    public String getName() {
+        return name;
+    }
+
+    public String getDescription() {
+        return description;
+    }
+
+}


The NamespaceInfo class is missing equals() and hashCode() implementations. Since this class is used in collections and comparisons (as seen in test assertions), it should implement these methods to ensure proper equality checks. This is especially important for the domain model where objects may be compared or used in Sets/Maps.

Copilot · 2026-02-03T19:07:09Z

calm-hub/src/main/java/org/finos/calm/domain/NamespaceRequest.java

+    @NotNull(message = "Name must not be null")
+    @NotBlank(message = "Name must not be blank")
+    private String name;



The description field has no validation annotations. Unlike the name field which has @NotNull and @notblank, the description field allows null values. This inconsistency could lead to issues when storing descriptions. Consider adding validation constraints if descriptions are required, or explicitly document that null descriptions are acceptable.

Suggested change

@NotNull(message = "Description must not be null")

@NotBlank(message = "Description must not be blank")

Copilot · 2026-02-03T19:07:09Z

calm-hub-ui/src/service/calm-service.tsx

        const data = await res.json();
-        setNamespaces(data.values);
+        const values = Array.isArray(data?.values) ? data.values : [];
+        const namespaces = values.map((v: { name?: string }) => v?.name);


The mapping from namespace objects to names can produce undefined values in the array. If a namespace object is missing the name property, v?.name will be undefined, resulting in an array that might contain undefined values. Consider filtering out undefined values or handling this edge case more explicitly.

Suggested change

const namespaces = values.map((v: { name?: string }) => v?.name);

const namespaces = values

.map((v: { name?: string }) => v?.name)

.filter((name): name is string => typeof name === 'string');

Copilot · 2026-02-03T19:07:10Z

calm-hub/src/main/java/org/finos/calm/resources/NamespaceResource.java


-        String namespace = request.getNamespace().trim();
+        String name = request.getName().trim();
+        String description = request.getDescription();


The description parameter is not validated before being passed to the store. If the description is null, it will be stored as null in the database. While NamespaceRequest allows null descriptions, the NamespaceResource should handle this case explicitly, either by validating that description is not null or by providing a default value. Consider adding null handling here to ensure consistent behavior.

Suggested change

String description = request.getDescription();

String description = request.getDescription();

if (description != null) {

description = description.trim();

} else {

description = "";

}

Copilot · 2026-02-03T19:07:10Z

calm-hub/src/main/java/org/finos/calm/resources/NamespaceResource.java


-        String namespace = request.getNamespace().trim();
+        String name = request.getName().trim();
+        String description = request.getDescription();


The name field is trimmed before use, but the description field is not. If users submit descriptions with leading or trailing whitespace, this will be stored as-is. Consider trimming the description as well for consistency, or document why descriptions should preserve whitespace while names should not.

Suggested change

String description = request.getDescription();

String description = request.getDescription();

if (description != null) {

description = description.trim();

}

Copilot · 2026-02-03T19:07:10Z

calm-hub/src/test/java/org/finos/calm/store/nitrite/TestNitriteNamespaceStoreShould.java

+        assertThat(result.get(0).getName(), is("finos"));
+        assertThat(result.get(1).getName(), is("workshop"));


The test only verifies the name field of the returned NamespaceInfo objects but doesn't verify the description field. Since the test documents include descriptions ("d1" and "d2"), add assertions to verify these descriptions are correctly retrieved.

Copilot · 2026-02-03T19:07:10Z

calm-hub/src/test/java/org/finos/calm/store/mongo/TestMongoNamespaceStoreShould.java

+        assertThat(namespaces.get(0).getName(), is(expectedNamespaces.get(0).getName()));
+        assertThat(namespaces.get(1).getName(), is(expectedNamespaces.get(1).getName()));


The test only verifies the name field but not the description field. Add assertions to verify that the descriptions ("FINOS namespace" and "other namespace") are correctly retrieved from the documents.

grahampacker-ms requested review from a team, Thels, jpgough-ms and rocketstack-matt as code owners January 28, 2026 19:32

github-actions bot added calm-hub The Calm Hub Product config calm-hub-ui labels Jan 28, 2026

grahampacker-ms force-pushed the issue-1440-namespace-refactor branch 2 times, most recently from 70d5a49 to e3278ef Compare January 28, 2026 20:47

grahampacker-ms changed the title ~~feat(calm-hub): refactored namespaces from simple string to full obje…~~ feat(calm-hub): refactored namespaces from simple string to full obect and added description Jan 29, 2026

grahampacker-ms requested review from LeighFinegold, aidanm3341, lbulanti-ms, markscott-ms and willosborne as code owners February 3, 2026 11:29

github-actions bot added cli docs labels Feb 3, 2026

feat(calm-hub): refactored namespaces from simple string to full obje…

f366d11

…ct and added description # Conflicts: # package-lock.json

grahampacker-ms force-pushed the issue-1440-namespace-refactor branch from 17a4b90 to f366d11 Compare February 3, 2026 11:32

markscott-ms requested a review from Copilot February 3, 2026 19:02

Copilot started reviewing on behalf of markscott-ms February 3, 2026 19:03 View session

Copilot AI reviewed Feb 3, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(calm-hub): refactored namespaces from simple string to full obect and added description #2084

feat(calm-hub): refactored namespaces from simple string to full obect and added description #2084

grahampacker-ms commented Jan 28, 2026 •

edited

Loading

Uh oh!

markscott-ms commented Jan 28, 2026

Uh oh!

markscott-ms commented Feb 3, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Copilot AI Feb 3, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants



	@NotNull(message = "Description must not be null")
	@NotBlank(message = "Description must not be blank")

-        String description = request.getDescription();
+        String description = request.getDescription();
+        if (description != null) {
+            description = description.trim();
+        } else {
+            description = "";
+        }

		assertThat(result.get(0).getName(), is("finos"));
		assertThat(result.get(1).getName(), is("workshop"));

		assertThat(namespaces.get(0).getName(), is(expectedNamespaces.get(0).getName()));
		assertThat(namespaces.get(1).getName(), is(expectedNamespaces.get(1).getName()));

feat(calm-hub): refactored namespaces from simple string to full obect and added description #2084

Are you sure you want to change the base?

feat(calm-hub): refactored namespaces from simple string to full obect and added description #2084

Conversation

grahampacker-ms commented Jan 28, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Affected Components

Commit Message Format ✅

Testing

Checklist

Uh oh!

markscott-ms commented Jan 28, 2026

Uh oh!

markscott-ms commented Feb 3, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Feb 3, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

grahampacker-ms commented Jan 28, 2026 •

edited

Loading