[AN-149] Rename 'namespace' to 'collection' & update feature preview section #5212

salonishah11 · 2025-01-07T18:58:59Z

Jira Ticket: https://broadworkbench.atlassian.net/browse/AN-149

Summary of changes:

What

renames namespace to collection: I have updated only the component names and user-facing instances to collection
updates the feature preview section to align with what is in Roadmap

Why

better terminology

Testing strategy

manual testing
updated unit tests

Visual Aids

Feature Preview change

Namespace -> Collection renaming

salonishah11 · 2025-01-07T19:01:42Z

src/libs/feature-previews-config.ts

+    title: 'Terra Workflow Repository Improvements',
+    description:
+      "Enabling this feature will gives users access to the new Terra Workflow Repository UI. This replaces the Broad Methods Repository UI (and doesn't affect any workflows previously created).",
+    feedbackUrl: `mailto:[email protected]?subject=${encodeURIComponent(
+      'Feedback on Terra Workflow Repository Improvements'


For reviewers: This was requested by Beth and I did it as part of this PR itself. Please let me know if there is any wording improvements that can be done, especially for the description.

aednichols

LGTM 👍

aednichols · 2025-01-07T19:15:11Z

src/libs/feature-previews-config.ts

-      'Feedback on deprecating Firecloud UI'
+    title: 'Terra Workflow Repository Improvements',
+    description:
+      "Enabling this feature will gives users access to the new Terra Workflow Repository UI. This replaces the Broad Methods Repository UI (and doesn't affect any workflows previously created).",


I attempted to emphasize what had been missing in Terra (create & edit) and try to explain that these are two UIs viewing the same backend data.

Suggested change

"Enabling this feature will gives users access to the new Terra Workflow Repository UI. This replaces the Broad Methods Repository UI (and doesn't affect any workflows previously created).",

"Create and edit workflows with the built-in Terra Workflow Repository UI. Changes made in Terra are reflected in the external Broad Methods Repository, and vice-versa.",

What do you think about this? This also conveys that Broad Methods Repository is being replaced. 🤔

Enabling this feature will allow creating and editing workflows with the built-in Terra Workflow Repository UI. This replaces the external Broad Methods Repository. But changes made in Terra are reflected in the external Broad Methods Repository, and vice-versa.

Seems good to me!

aednichols · 2025-01-07T19:22:14Z

src/pages/workflows/workflow-details/WorkflowWrapper.ts

@@ -291,7 +291,7 @@ export const WorkflowsContainer = (props: WorkflowContainerProps) => {
      }),
    permissionsModalOpen &&
      h(PermissionsModal, {
-        versionOrNamespace: 'Version',
+        versionOrCollection: 'Version',


Incredibly glad we avoided working on snapshot => version and namespace => collection at the exact same time.

LizBaldo · 2025-01-08T18:39:06Z

src/workflows/modals/CreateWorkflowModal.tsx

@@ -77,15 +77,15 @@ const createWorkflowModalConstraints = {
  },
 };

-interface NamespaceNameSectionProps {
+interface CollectionAndNameSectionProps {


Would it make sense to also modify namespace to collection inside the interface as well? Also what does name refers to here, the collection name or the workflow name?

I had intentionally decided to rename only user facing and component names to collection because we had made a decision in previous renaming efforts to only change high level component names and user-facing places to new terminology. It also wouldn't be trivial to update all the instances of namespace to collection everywhere in code. And even if we do change the variable names we would still need to refer these as namespace (and snapshot) whenever we are using the Ajax calls so that it can be consistent with backend terminology.

Having said that, I do understand that there might be some confusion when someone else comes and looks at the code. So I am open to the discussion on renaming what else what be good for developer readability.

Gotcha, in that case maybe a little comment in the code explaining that a namespace is the collection, and name is the workflow name?

Yes I can do that. I will also update the component name to be CollectionAndWfNameSection so it is more clear.

LizBaldo · 2025-01-08T18:39:56Z

src/workflows/modals/PermissionsModal.test.tsx

@@ -118,7 +118,7 @@ describe('PermissionsModal', () => {
    });

    // ASSERT
-    expect(screen.getByText('Edit permissions for namespace my-namespace'));
+    expect(screen.getByText('Edit permissions for collection my-namespace'));


maybe change my-namespace to my-collection?

my-namespace is what is being passed on L111. I didn't rename instances of namespace to collection here since this is a test file.

LizBaldo · 2025-01-08T18:40:44Z

src/workflows/modals/PermissionsModal.tsx

@@ -166,7 +166,7 @@ const CurrentUsers = (props: CurrentUsersProps) => {
 };

 export const PermissionsModal = (props: WorkflowPermissionsModalProps) => {
-  const { versionOrNamespace, namespace, setPermissionsModalOpen, refresh, permissionsProvider } = props;
+  const { versionOrCollection, namespace, setPermissionsModalOpen, refresh, permissionsProvider } = props;


how hard would it be to also change namespace to collection here?

I don't this would be hard, but if we do decide to change variable names in this file it would be good to change it in other files as well to stay consistent, and that would not be trivial.

LizBaldo · 2025-01-08T18:41:35Z

src/workflows/modals/PermissionsModal.tsx

@@ -238,11 +238,11 @@ export const PermissionsModal = (props: WorkflowPermissionsModalProps) => {
  });

  const modalTitle =
-    versionOrNamespace === 'Version' ? 'Edit version permissions' : `Edit permissions for namespace ${namespace}`;
+    versionOrCollection === 'Version' ? 'Edit version permissions' : `Edit permissions for collection ${namespace}`;


I understand the goal is to change only what is user facing, but I am afraid that the next dev in this code base might be confused by what a namespace is if it is not consistent

sonarqubecloud · 2025-01-09T15:58:45Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
100.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

salonishah11 added 4 commits January 7, 2025 10:57

namespace -> collection

99683ba

fix tests

069a58d

update feature preview

2bedd00

small nit

fb78de1

salonishah11 commented Jan 7, 2025

View reviewed changes

broadbot temporarily deployed to pr-9 January 7, 2025 19:09 Inactive

aednichols approved these changes Jan 7, 2025

View reviewed changes

salonishah11 added 2 commits January 7, 2025 16:25

PR feedback

3a6cd53

Merge branch 'dev' into sps_rename_namespace

fd7ee7f

broadbot temporarily deployed to pr-9 January 7, 2025 21:38 Inactive

salonishah11 requested a review from LizBaldo January 8, 2025 16:06

LizBaldo reviewed Jan 8, 2025

View reviewed changes

LizBaldo approved these changes Jan 8, 2025

View reviewed changes

comment about renaming

069f3cc

broadbot deployed to pr-9 January 9, 2025 15:58 View deployment

salonishah11 added this pull request to the merge queue Jan 9, 2025

Merged via the queue into dev with commit ef90e77 Jan 9, 2025
11 checks passed

salonishah11 deleted the sps_rename_namespace branch January 9, 2025 16:44

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[AN-149] Rename 'namespace' to 'collection' & update feature preview section #5212

[AN-149] Rename 'namespace' to 'collection' & update feature preview section #5212

salonishah11 commented Jan 7, 2025 •

edited

Loading

salonishah11 Jan 7, 2025

aednichols left a comment

aednichols Jan 7, 2025

salonishah11 Jan 7, 2025

aednichols Jan 7, 2025

aednichols Jan 7, 2025

LizBaldo Jan 8, 2025

salonishah11 Jan 8, 2025

LizBaldo Jan 8, 2025

salonishah11 Jan 9, 2025

LizBaldo Jan 8, 2025

salonishah11 Jan 8, 2025

LizBaldo Jan 8, 2025

salonishah11 Jan 8, 2025

LizBaldo Jan 8, 2025

sonarqubecloud bot commented Jan 9, 2025

	"Enabling this feature will gives users access to the new Terra Workflow Repository UI. This replaces the Broad Methods Repository UI (and doesn't affect any workflows previously created).",
	"Create and edit workflows with the built-in Terra Workflow Repository UI. Changes made in Terra are reflected in the external Broad Methods Repository, and vice-versa.",

[AN-149] Rename 'namespace' to 'collection' & update feature preview section #5212

[AN-149] Rename 'namespace' to 'collection' & update feature preview section #5212

Conversation

salonishah11 commented Jan 7, 2025 • edited Loading

Jira Ticket: https://broadworkbench.atlassian.net/browse/AN-149

Summary of changes:

What

Why

Testing strategy

Visual Aids

Choose a reason for hiding this comment

aednichols left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarqubecloud bot commented Jan 9, 2025

Quality Gate passed

salonishah11 commented Jan 7, 2025 •

edited

Loading