chore: (CXSPA-11949) [BEFORE DF] Migration docs for breaking changes #21057
Conversation
closes: https://jira.tools.sap/browse/CXSPA-11949 create doc for manual changes
…oc-manual-doc-for-provided-breaking-changes
…ded-breaking-changes
…d-breaking-changes' into chore/doc-manual-doc-for-provided-breaking-changes
There was a problem hiding this comment.
Thank you, looks good! I left some comments.
Apart from that, let's consider adding the following, to explicitlyt inform about USER_CMS_ENDPOINTS removal
#### Removed Constants
- **`USER_CMS_ENDPOINTS`** (from `projects/core/src/model/cms.model.ts`):
- **Impact:** This feature toggle constant has been removed. The functionality is now always enabled.
- **Action Required:** Remove any references to this constant in your code. The CMS adapters now always use user-specific endpoints.
Also, was SMART_EDIT_DUMMY_COMPONENT_TYPE part of our public API?IF yes, then let's inform about it as well:
- **`SMART_EDIT_DUMMY_COMPONENT_TYPE`** (from `projects/core/src/cms/config/cms-config.ts`):
- **Impact:** This constant was unused since version 6.5. The `SmartEditLauncher` is now responsible for triggering the lazy loading of the `SMART_EDIT_FEATURE`.
- **Action Required:** Remove any references to this constant if you were using it.
| ### 6. `user-register.action.ts` | ||
| - **Comment Cleanup**: Removed a `@deprecated` TSDoc comment for the `RegisterUserSuccess` class. | ||
| - **Impact**: No functional breaking change, but indicates that the migration of this action to `@spartacus/user/profile/core` is considered complete/standard. |
There was a problem hiding this comment.
Since the purpose of this document is to present breaking changes affecting our customers. I don't think we need to include this information in it.
There was a problem hiding this comment.
thank you. removed
| #### New ESLint Rule: `feature-config-service-must-be-private` | ||
| - **Change**: A new ESLint rule has been introduced to enforce that `FeatureConfigService` is always injected as a `private` property. | ||
| - **Reason**: To prevent the exposure of internal feature configuration logic in the public/protected API of components and services. | ||
| - **Action Required**: Ensure that any manual injections of `FeatureConfigService` in your codebase use the `private` modifier. You can use `eslint --fix` to automatically resolve most violations. |
There was a problem hiding this comment.
Since the purpose of this document is to present breaking changes affecting our customers. I don't think we need to include this information in it.
There was a problem hiding this comment.
thanks for spotting this. removed 👍
| ### 5. `occ-cms-page.adapter.ts` | ||
| - **Feature Toggle Removal**: Removed all logic related to the `USER_CMS_ENDPOINTS` feature toggle. | ||
| - **Behavior Change**: Similar to the component adapter, it now always fetches the user ID to build CMS page request URLs. | ||
| - **API Cleanup**: Removed usage of `FeatureConfigService`. |
There was a problem hiding this comment.
query: I'm wondering if this is something that affects our customers. If FeatureConfigService was injected via inject function and had private access modifier, then I guess it wont affect customers in any way and could be removed.
This comment applies to all similar places.
There was a problem hiding this comment.
re-checked. all places. In this case it was protected.
Thank you Pawel. updated the file with this content as well. |
|
|
||
| ## Removed Constants | ||
| - **`USER_CMS_ENDPOINTS`** (from `projects/core/src/model/cms.model.ts`): | ||
| - **Impact:** This feature toggle constant has been removed. The functionality is now always enabled. |
There was a problem hiding this comment.
Hey Stan,
Only now I realized that using the name feature toggle for this DI injection token, could be confusing from the customers' perspective, because officially we use the name feature toggle for all toggles listed here:
What do you think about changing feature toggle to config? If you aggree, then it's needed to change it in all references to USER_CMS_ENDPOINTS in this doc.
There was a problem hiding this comment.
absolutely agree. Updated.
…ded-breaking-changes
pawelfras
deleted the
chore/doc-manual-doc-for-provided-breaking-changes
branch
closes: https://jira.tools.sap/browse/CXSPA-11949
create doc for manual changes