feat(hub-common): new sites are fully upgraded to the new catalog, old sites can opt into the upgrade #2013

sonofflynn89 · 2025-09-22T17:34:34Z

Description:
Part of https://devtopia.esri.com/dc/hub/issues/13504

Does the final cleanup needed to allow sites to be fully migrated to the new catalog spec, including:

Deleting the unneeded hub:feature:catalogs:edit:advancedpermission since it wasn't relevant any more
Remove gating on the hub:site:workspace:catalog:upgrade permission
Add the temporary data.useCatalogV2 field (needed because of template idiosyncrasies)
Stop setting the legacy catalog on new sites that are created in workspaces
Change site update logic to conditionally remove the legacy catalog if a site is marked for upgrade

Updated meaningful TSDoc to methods including Parameters and Returns, see Documentation Guide
used semantic commit messages
PR title follows semantic commit format (CRITICAL if the title is not in a semantic format, the release automation will not run!)
Updated peerDependencies as needed. CRITICAL our automated release system can not be counted on to update peerDependencies so we must do it manually in our PRs when needed. See the updating peerDependencies section of the release instructions for more details.
These changes have been verified by QA using a ?uiVersion that includes a PR-Preview of this branch and the v_req label has been applied to the issue.
OD-UI E2E tests pass against these changes using a ?uiVersion that includes a PR-Preview of this branch

*CRITICAL
If you are making a breaking change, make sure to add the BREAKING CHANGE comment in the merge commit message. If this is not done, semantic-release will not do the right thing.

If you find yourself in this position...

open a PR to master with a trivial change - fix a linting problem or something.
when you merge that, make sure you add the BREAKING CHANGE message in the merge commit.
then run npm deprecate @esri/{package-name}@v{version-you-don't-want-out}

github-actions · 2025-09-26T13:33:02Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

github-actions · 2025-09-30T13:34:30Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

codecov · 2025-10-01T01:18:49Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (b350124) to head (6950d0b).
⚠️ Report is 59 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##            master     #2013    +/-   ##
==========================================
  Coverage   100.00%   100.00%            
==========================================
  Files         1071      1116    +45     
  Lines        19532     19812   +280     
  Branches      3617      3652    +35     
==========================================
+ Hits         19532     19812   +280

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

github-actions · 2025-10-06T13:34:07Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

…n, remove hub:feature:catalogs: affects: @esri/hub-common

affects: @esri/hub-common

…d data.catalog in certain circu affects: @esri/hub-common

packages/common/src/sites/HubSites.ts

packages/common/src/sites/_internal/getPropertyMap.ts

Copilot

Pull Request Overview

This PR implements final cleanup for migrating sites to the new catalog spec (v2), allowing full migration to the new catalog format while maintaining backwards compatibility for sites that haven't opted in yet.

Removes deprecated permission hub:feature:catalogs:edit:advanced and updates dependent permissions
Modifies site creation to use catalogV2 by default and removes legacy catalog initialization
Updates site update logic to conditionally handle catalog formats based on isCatalogV1Enabled flag

Reviewed Changes

Copilot reviewed 11 out of 11 changed files in this pull request and generated 2 comments.

Show a summary per file

File	Description
packages/common/test/sites/HubSites.test.ts	Updates test cases to verify catalog v1/v2 behavior and legacy catalog removal
packages/common/src/sites/defaults.ts	Changes default site model to initialize catalogV2 instead of legacy catalog
packages/common/src/sites/_internal/getPropertyMap.ts	Removes legacy catalog property mapping
packages/common/src/sites/_internal/SiteBusinessRules.ts	Updates catalog upgrade permission to use assertions instead of flag-based availability
packages/common/src/sites/HubSites.ts	Major refactor to handle catalog v1/v2 logic in create/update operations
packages/common/src/projects/_internal/ProjectBusinessRules.ts	Removes deprecated permission dependency
packages/common/src/permissions/_internal/constants.ts	Removes deprecated `hub:feature:catalogs:edit:advanced` permission
packages/common/src/permissions/HubPermissionPolicies.ts	Removes deprecated permission policy and updates appearance permission
packages/common/src/initiatives/_internal/InitiativeBusinessRules.ts	Removes deprecated permission dependency
packages/common/src/events/_internal/EventBusinessRules.ts	Removes deprecated permission dependency
packages/common/src/discussions/_internal/DiscussionBusinessRules.ts	Removes deprecated permission dependency

packages/common/src/sites/HubSites.ts

knbhagat

Great job Caleb, LGTM!

github-actions · 2025-10-14T13:34:45Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

changeset-bot · 2025-10-17T00:16:32Z

🦋 Changeset detected

Latest commit: ea601c2

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package

Name	Type
@esri/hub-common	Minor

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

github-actions · 2025-10-21T13:35:25Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

github-actions · 2025-10-27T13:35:09Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

…'t migrated to catalogV2

sonofflynn89 · 2025-10-30T22:42:13Z

@knbhagat would you mind re-reviewing the PR? I had to fix a bug that Diana caught in testing. You can check out the new commits here:

https://github.com/Esri/hub.js/pull/2013/files/aa341389135e99db8429bd145943a95c034a5f36..ea601c2ad7c3fc84fbf1350e4c7adc50fac3c68f

knbhagat

Looks Good!

abp6318

LGTM

abp6318 · 2025-10-31T14:32:47Z

packages/common/src/sites/HubSites.ts

+    modelToUpdate = convertCatalogToLegacyFormat(modelToUpdate, currentModel);
+  } else {
+    // ensure the old catalog is removed if the site is not using v1
+    delete modelToUpdate.data.catalog;


abp6318 · 2025-10-31T14:33:18Z

packages/common/src/sites/HubSites.ts

There are a bunch of new TODOs in this file. Do we need to document them anywhere before we forget?

github-actions · 2025-11-04T13:35:25Z

There hasn't been any activity on this pull request in the past 3 days, so it has been marked as stale and it will be closed automatically if no further activity occurs in the next 7 days. If you want this PR to never become stale, please apply the "Draft" label.

github-actions bot added the Stale Stale issue - update or it will be closed label Sep 26, 2025

sonofflynn89 removed the Stale Stale issue - update or it will be closed label Sep 26, 2025

github-actions bot added the Stale Stale issue - update or it will be closed label Sep 30, 2025

sonofflynn89 removed the Stale Stale issue - update or it will be closed label Sep 30, 2025

sonofflynn89 force-pushed the f/13504-allow-site-migration branch from 2ef92b8 to f5c4a61 Compare September 30, 2025 22:58

github-actions bot added the Stale Stale issue - update or it will be closed label Oct 6, 2025

sonofflynn89 removed the Stale Stale issue - update or it will be closed label Oct 6, 2025

sonofflynn89 added 4 commits October 8, 2025 16:00

feat(hub-common): ungate hub:site:workspace:catalog:upgrade permissio…

e9a0a8f

…n, remove hub:feature:catalogs: affects: @esri/hub-common

feat(hub-common): delete the v1 catalog for upgraded sites

a25fc3b

affects: @esri/hub-common

test(hub-common): add tests

88e53a6

affects: @esri/hub-common

fix(hub-common): remove unnecessary versionless migration that delete…

aa34138

…d data.catalog in certain circu affects: @esri/hub-common

sonofflynn89 force-pushed the f/13504-allow-site-migration branch from 6950d0b to aa34138 Compare October 8, 2025 22:00

sonofflynn89 commented Oct 9, 2025

View reviewed changes

packages/common/src/sites/HubSites.ts Show resolved Hide resolved

sonofflynn89 commented Oct 9, 2025

View reviewed changes

packages/common/src/sites/HubSites.ts Show resolved Hide resolved

sonofflynn89 commented Oct 9, 2025

View reviewed changes

packages/common/src/sites/_internal/getPropertyMap.ts Show resolved Hide resolved

sonofflynn89 changed the title ~~F/13504 allow site migration~~ feat(hub-common): new sites are fully upgraded to the new catalog, old sites can opt into the upgrade Oct 9, 2025

sonofflynn89 requested a review from Copilot October 9, 2025 21:50

sonofflynn89 assigned abp6318 and knbhagat Oct 9, 2025

Copilot AI reviewed Oct 9, 2025

View reviewed changes

packages/common/src/sites/HubSites.ts Show resolved Hide resolved

packages/common/src/sites/HubSites.ts Show resolved Hide resolved

sonofflynn89 requested review from abp6318 and knbhagat October 9, 2025 22:10

sonofflynn89 unassigned abp6318 and knbhagat Oct 9, 2025

knbhagat approved these changes Oct 10, 2025

View reviewed changes

github-actions bot added the Stale Stale issue - update or it will be closed label Oct 14, 2025

Merge branch 'master' into f/13504-allow-site-migration

b64ff67

github-actions bot removed the Stale Stale issue - update or it will be closed label Oct 17, 2025

Merge branch 'master' into f/13504-allow-site-migration

6d47adc

github-actions bot added the Stale Stale issue - update or it will be closed label Oct 21, 2025

sonofflynn89 removed the Stale Stale issue - update or it will be closed label Oct 21, 2025

github-actions bot added the Stale Stale issue - update or it will be closed label Oct 27, 2025

sonofflynn89 removed the Stale Stale issue - update or it will be closed label Oct 27, 2025

JoshCrozier force-pushed the master branch 2 times, most recently from 0e9fbe4 to 1afeabb Compare October 27, 2025 20:50

sonofflynn89 added 4 commits October 28, 2025 10:42

Merge branch 'master' into f/13504-allow-site-migration

4670785

test: convert jasmine to vitest

96ce59b

feat: add changeset

abb432b

fix: fix bug in HubSites' createSite() function where new sites weren…

ea601c2

…'t migrated to catalogV2

sonofflynn89 requested a review from knbhagat October 30, 2025 22:38

knbhagat approved these changes Oct 31, 2025

View reviewed changes

abp6318 approved these changes Oct 31, 2025

View reviewed changes

github-actions bot added the Stale Stale issue - update or it will be closed label Nov 4, 2025

sonofflynn89 removed the Stale Stale issue - update or it will be closed label Nov 4, 2025

feat(hub-common): new sites are fully upgraded to the new catalog, old sites can opt into the upgrade #2013

Are you sure you want to change the base?

feat(hub-common): new sites are fully upgraded to the new catalog, old sites can opt into the upgrade #2013

Uh oh!

Conversation

sonofflynn89 commented Sep 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

github-actions bot commented Sep 26, 2025

Uh oh!

github-actions bot commented Sep 30, 2025

Uh oh!

codecov bot commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

github-actions bot commented Oct 6, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Uh oh!

Uh oh!

knbhagat left a comment

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Oct 14, 2025

Uh oh!

changeset-bot bot commented Oct 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🦋 Changeset detected

Uh oh!

github-actions bot commented Oct 21, 2025

Uh oh!

github-actions bot commented Oct 27, 2025

Uh oh!

sonofflynn89 commented Oct 30, 2025

Uh oh!

knbhagat left a comment

Choose a reason for hiding this comment

Uh oh!

abp6318 left a comment

Choose a reason for hiding this comment

Uh oh!

abp6318 Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

abp6318 Oct 31, 2025

Choose a reason for hiding this comment

Uh oh!

github-actions bot commented Nov 4, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

sonofflynn89 commented Sep 22, 2025 •

edited

Loading

codecov bot commented Oct 1, 2025 •

edited

Loading

changeset-bot bot commented Oct 17, 2025 •

edited

Loading