Code cleanup#3927
Draft
jmendeza wants to merge 1 commit into
Draft
Conversation
WalkthroughThis PR removes deprecated v1 service APIs, AWS media transcoding support, and WebDAV functionality; simplifies v1 service method contracts; migrates remaining v1 implementations to use v2 ContentService; and updates Spring bean wiring accordingly. ChangesV1 API Deprecation and Cleanup
🎯 4 (Complex) | ⏱️ ~60 minutes Possibly Related PRs
Suggested Reviewers
🚥 Pre-merge checks | ✅ 3 | ❌ 2❌ Failed checks (1 warning, 1 inconclusive)
✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
src/main/java/org/craftercms/studio/api/v1/constant/DmConstants.java (1)
23-59:⚠️ Potential issue | 🟠 Major | ⚡ Quick winKeep deprecated aliases or explicitly treat this as a breaking API change.
org.craftercms.studio.api.v1.constantis still an exported v1 surface. Removing public fields fromDmConstantsturns existing imports into compile failures and can also triggerNoSuchFieldErrorfor already-compiled extensions. If these constants are being retired, please keep deprecated aliases for a release or add explicit migration/release-note coverage for the break.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@src/main/java/org/craftercms/studio/api/v1/constant/DmConstants.java` around lines 23 - 59, The PR removed or renamed public constants from DmConstants which breaks the v1 API; restore any removed fields (e.g., INDEX_FILE, SLASH_INDEX_FILE, SLASH_SITE_WEBSITE, XML_PATTERN, KEY_CONTENT_TYPE, KEY_PATH, KEY_SITE, KEY_USER, KEY_SOURCE_PATH, KEY_CONTENT_LOADER, ROOT_PATTERN_PAGES, ROOT_PATTERN_COMPONENTS, ROOT_PATTERN_ASSETS, ROOT_PATTERN_DOCUMENTS, CONTENT_LIFECYCLE_OPERATION, JSON_KEY_ORDER_DEFAULT, KEY_APPLICATION_CONTEXT) as deprecated aliases that forward to the new names, annotate them with `@Deprecated` and a Javadoc pointing to the replacement constant, or alternatively document this as a breaking change by keeping them removed only if you add explicit migration notes and bump the public API version; update DmConstants accordingly.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Inline comments:
In
`@src/main/java/org/craftercms/studio/api/v1/asset/processing/AssetProcessingConfigReader.java`:
- Around line 23-25: Update the AssetProcessingConfigReader interface Javadoc to
remove any mention of accepting an Apache Commons Configuration object and
instead document the single exposed method readConfig(InputStream): describe
that callers supply an InputStream, what format(s) are expected, and that the
implementation maps that input to ProcessorPipelineConfiguration and
ProcessorConfiguration objects; reference the interface name
AssetProcessingConfigReader and the method readConfig(InputStream) in the
updated description so the Javadoc matches the current API surface.
---
Outside diff comments:
In `@src/main/java/org/craftercms/studio/api/v1/constant/DmConstants.java`:
- Around line 23-59: The PR removed or renamed public constants from DmConstants
which breaks the v1 API; restore any removed fields (e.g., INDEX_FILE,
SLASH_INDEX_FILE, SLASH_SITE_WEBSITE, XML_PATTERN, KEY_CONTENT_TYPE, KEY_PATH,
KEY_SITE, KEY_USER, KEY_SOURCE_PATH, KEY_CONTENT_LOADER, ROOT_PATTERN_PAGES,
ROOT_PATTERN_COMPONENTS, ROOT_PATTERN_ASSETS, ROOT_PATTERN_DOCUMENTS,
CONTENT_LIFECYCLE_OPERATION, JSON_KEY_ORDER_DEFAULT, KEY_APPLICATION_CONTEXT) as
deprecated aliases that forward to the new names, annotate them with `@Deprecated`
and a Javadoc pointing to the replacement constant, or alternatively document
this as a breaking change by keeping them removed only if you add explicit
migration notes and bump the public API version; update DmConstants accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: d8dbea3b-c443-40c4-a4fd-353515640a5f
📒 Files selected for processing (42)
src/main/java/org/craftercms/studio/api/v1/asset/processing/AssetProcessingConfigReader.javasrc/main/java/org/craftercms/studio/api/v1/aws/elastictranscoder/ElasticTranscoder.javasrc/main/java/org/craftercms/studio/api/v1/aws/elastictranscoder/TranscoderJob.javasrc/main/java/org/craftercms/studio/api/v1/aws/elastictranscoder/TranscoderOutput.javasrc/main/java/org/craftercms/studio/api/v1/aws/elastictranscoder/TranscoderProfile.javasrc/main/java/org/craftercms/studio/api/v1/aws/mediaconvert/MediaConvertJob.javasrc/main/java/org/craftercms/studio/api/v1/aws/s3/S3Output.javasrc/main/java/org/craftercms/studio/api/v1/constant/DmConstants.javasrc/main/java/org/craftercms/studio/api/v1/constant/DmXmlConstants.javasrc/main/java/org/craftercms/studio/api/v1/constant/StudioConstants.javasrc/main/java/org/craftercms/studio/api/v1/exception/ContentNotAllowedException.javasrc/main/java/org/craftercms/studio/api/v1/exception/ContentProcessException.javasrc/main/java/org/craftercms/studio/api/v1/exception/SiteCreationException.javasrc/main/java/org/craftercms/studio/api/v1/exception/repository/RemoteRepositoryNotBareException.javasrc/main/java/org/craftercms/studio/api/v1/service/content/ContentService.javasrc/main/java/org/craftercms/studio/api/v1/service/security/SecurityService.javasrc/main/java/org/craftercms/studio/api/v1/service/webdav/WebDavService.javasrc/main/java/org/craftercms/studio/api/v1/to/SiteConfigTO.javasrc/main/java/org/craftercms/studio/impl/v1/asset/processing/AssetProcessingConfigReaderImpl.javasrc/main/java/org/craftercms/studio/impl/v1/aws/elastictranscoder/TranscoderProfileMapper.javasrc/main/java/org/craftercms/studio/impl/v1/service/configuration/ServicesConfigImpl.javasrc/main/java/org/craftercms/studio/impl/v1/service/content/ContentServiceImpl.javasrc/main/java/org/craftercms/studio/impl/v1/service/security/SecurityServiceImpl.javasrc/main/java/org/craftercms/studio/impl/v1/service/webdav/WebDavServiceImpl.javasrc/main/java/org/craftercms/studio/impl/v1/util/config/profiles/SiteAwareConfigProfileLoader.javasrc/main/java/org/craftercms/studio/impl/v2/service/scripting/internal/ScriptingServiceInternalImpl.javasrc/main/java/org/craftercms/studio/impl/v2/upgrade/operations/db/MigrateWorkflowUpgradeOperation.javasrc/main/java/org/craftercms/studio/model/Entity.javasrc/main/java/org/craftercms/studio/model/Site.javasrc/main/resources/crafter/studio/studio-services-context.xmlsrc/main/resources/crafter/studio/studio-upgrade-context.xmlsrc/main/webapp/default-site/scripts/api/ContentServices.groovysrc/main/webapp/default-site/scripts/api/impl/content/SpringContentServices.groovysrc/main/webapp/default-site/scripts/api/impl/user/SpringUserServices.groovysrc/main/webapp/default-site/scripts/libs/HTMLCompareTools.groovysrc/main/webapp/default-site/scripts/pages/analytics-dashboard.groovysrc/main/webapp/default-site/scripts/pages/browse.groovysrc/main/webapp/default-site/scripts/pages/browseS3.groovysrc/main/webapp/default-site/scripts/pages/browseWebDAV.groovysrc/main/webapp/default-site/scripts/pages/diff.groovysrc/main/webapp/default-site/scripts/pages/overlay-css.groovysrc/main/webapp/default-site/scripts/pages/overlayhook.groovy
💤 Files with no reviewable changes (32)
- src/main/java/org/craftercms/studio/api/v1/exception/ContentProcessException.java
- src/main/java/org/craftercms/studio/api/v1/aws/elastictranscoder/TranscoderOutput.java
- src/main/java/org/craftercms/studio/api/v1/exception/ContentNotAllowedException.java
- src/main/java/org/craftercms/studio/api/v1/aws/elastictranscoder/ElasticTranscoder.java
- src/main/webapp/default-site/scripts/pages/analytics-dashboard.groovy
- src/main/java/org/craftercms/studio/api/v1/aws/elastictranscoder/TranscoderJob.java
- src/main/java/org/craftercms/studio/model/Entity.java
- src/main/java/org/craftercms/studio/api/v1/aws/s3/S3Output.java
- src/main/webapp/default-site/scripts/api/ContentServices.groovy
- src/main/webapp/default-site/scripts/pages/overlay-css.groovy
- src/main/java/org/craftercms/studio/api/v1/aws/mediaconvert/MediaConvertJob.java
- src/main/webapp/default-site/scripts/pages/browseWebDAV.groovy
- src/main/webapp/default-site/scripts/api/impl/user/SpringUserServices.groovy
- src/main/java/org/craftercms/studio/impl/v1/service/configuration/ServicesConfigImpl.java
- src/main/java/org/craftercms/studio/api/v1/to/SiteConfigTO.java
- src/main/java/org/craftercms/studio/api/v1/aws/elastictranscoder/TranscoderProfile.java
- src/main/java/org/craftercms/studio/api/v1/exception/SiteCreationException.java
- src/main/webapp/default-site/scripts/pages/browse.groovy
- src/main/java/org/craftercms/studio/impl/v1/aws/elastictranscoder/TranscoderProfileMapper.java
- src/main/webapp/default-site/scripts/pages/diff.groovy
- src/main/java/org/craftercms/studio/impl/v1/service/webdav/WebDavServiceImpl.java
- src/main/resources/crafter/studio/studio-upgrade-context.xml
- src/main/java/org/craftercms/studio/impl/v2/upgrade/operations/db/MigrateWorkflowUpgradeOperation.java
- src/main/java/org/craftercms/studio/api/v1/service/content/ContentService.java
- src/main/webapp/default-site/scripts/pages/overlayhook.groovy
- src/main/java/org/craftercms/studio/api/v1/constant/StudioConstants.java
- src/main/webapp/default-site/scripts/libs/HTMLCompareTools.groovy
- src/main/java/org/craftercms/studio/api/v1/service/security/SecurityService.java
- src/main/webapp/default-site/scripts/pages/browseS3.groovy
- src/main/java/org/craftercms/studio/api/v1/service/webdav/WebDavService.java
- src/main/webapp/default-site/scripts/api/impl/content/SpringContentServices.groovy
- src/main/java/org/craftercms/studio/api/v1/exception/repository/RemoteRepositoryNotBareException.java
Comment on lines
23
to
25
| /** | ||
| * Reads the configuration from an input stream or a Apache Commons Configuration object and maps it to actual asset processing | ||
| * configuration objects like {@link ProcessorPipelineConfiguration} and {@link ProcessorConfiguration}. |
There was a problem hiding this comment.
Update the interface Javadoc to match the remaining API.
It still says callers can provide an Apache Commons Configuration object, but this interface now only exposes readConfig(InputStream).
🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
In
`@src/main/java/org/craftercms/studio/api/v1/asset/processing/AssetProcessingConfigReader.java`
around lines 23 - 25, Update the AssetProcessingConfigReader interface Javadoc
to remove any mention of accepting an Apache Commons Configuration object and
instead document the single exposed method readConfig(InputStream): describe
that callers supply an InputStream, what format(s) are expected, and that the
implementation maps that input to ProcessorPipelineConfiguration and
ProcessorConfiguration objects; reference the interface name
AssetProcessingConfigReader and the method readConfig(InputStream) in the
updated description so the Javadoc matches the current API surface.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Code cleanup
craftercms/craftercms#6061
Summary by CodeRabbit
Release Notes
Deprecations & Removals
Infrastructure Updates