-
-
Notifications
You must be signed in to change notification settings - Fork 10.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Removed experimental URL cache #21751
Conversation
fdbe914
to
50ba6e1
Compare
50ba6e1
to
6b2f4de
Compare
Warning Rate limit exceeded@daniellockyer has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 21 minutes and 18 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ⛔ Files ignored due to path filters (7)
📒 Files selected for processing (21)
WalkthroughThe changes remove caching functionality and simplify several core services. The Suggested labels
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
ghost/core/test/utils/url-service-utils.js (1)
20-21
: Consider awaiting the async init call.Since “urlService.init()” is an async function, you may want to return or await it to ensure proper test sequencing. This helps avoid race conditions if any tests depend on the initialization completing first.
Here’s an example adjustment:
- module.exports.init = () => { - urlService.init(); - }; + module.exports.init = async () => { + await urlService.init(); + };
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap
is excluded by!**/*.snap
📒 Files selected for processing (15)
ghost/core/core/boot.js
(3 hunks)ghost/core/core/server/services/url/LocalFileCache.js
(0 hunks)ghost/core/core/server/services/url/UrlService.js
(2 hunks)ghost/core/core/server/services/url/index.js
(1 hunks)ghost/core/core/shared/config/env/config.testing-browser.json
(1 hunks)ghost/core/core/shared/config/env/config.testing-mysql.json
(1 hunks)ghost/core/core/shared/config/env/config.testing.json
(1 hunks)ghost/core/core/shared/labs.js
(0 hunks)ghost/core/test/unit/server/services/url/LocalFileCache.test.js
(0 hunks)ghost/core/test/unit/shared/config/loader.test.js
(0 hunks)ghost/core/test/unit/shared/labs.test.js
(2 hunks)ghost/core/test/utils/e2e-utils.js
(1 hunks)ghost/core/test/utils/fixtures/urls/resources.json
(0 hunks)ghost/core/test/utils/fixtures/urls/urls.json
(0 hunks)ghost/core/test/utils/url-service-utils.js
(1 hunks)
💤 Files with no reviewable changes (6)
- ghost/core/test/unit/shared/config/loader.test.js
- ghost/core/core/shared/labs.js
- ghost/core/test/unit/server/services/url/LocalFileCache.test.js
- ghost/core/test/utils/fixtures/urls/resources.json
- ghost/core/core/server/services/url/LocalFileCache.js
- ghost/core/test/utils/fixtures/urls/urls.json
✅ Files skipped from review due to trivial changes (2)
- ghost/core/core/shared/config/env/config.testing.json
- ghost/core/core/shared/config/env/config.testing-mysql.json
⏰ Context from checks skipped due to timeout of 90000ms (4)
- GitHub Check: Ghost-CLI tests
- GitHub Check: Unit tests (Node 20.11.1)
- GitHub Check: Unit tests (Node 18.12.1)
- GitHub Check: Lint
🔇 Additional comments (10)
ghost/core/test/unit/shared/labs.test.js (2)
36-37
: LGTM! The test cases correctly handle the newNestPlayground
flag.The changes consistently replace the old
urlCache
flag withNestPlayground
across the test suite, aligning with the PR's objective of removing the URL cache feature.Also applies to: 42-43, 47-47
55-56
: LGTM! The test verifies that alpha flags are disabled when dev experiments are off.The test case correctly ensures that the
NestPlayground
flag is disabled when developer experiments are turned off, maintaining the expected behavior for alpha features.Also applies to: 65-65
ghost/core/core/server/services/url/UrlService.js (2)
299-310
: Asynchronous init logic streamlined.Removing the cache handling here and simplifying resource fetching is consistent with the goal of removing caching. The updated method body looks coherent, with initialization steps clearly laid out. No issues found.
17-17
: Constructor param removal appears consistent.Removing the
options
param from the constructor aligns with phasing out the URL cache. Please confirm that no other code path still relies on the old constructor signature.Run this script to search references of a previous constructor signature passing an argument:
✅ Verification successful
🏁 Script executed:
#!/bin/bash # Description: Look for code passing arguments into UrlService constructor rg "new UrlService\(\{"Length of output: 25
I'll run an additional verification script to ensure there are no invocations of the UrlService constructor with non-empty arguments and no lingering references to the old "options" parameter.
🏁 Script executed:
#!/bin/bash # Search for UrlService invocations that pass any parameter echo "Searching for new UrlService invocations with non-empty arguments:" rg "new UrlService\(\s*[^)]" echo "" echo "Searching for references to a constructor with an 'options' parameter:" rg "constructor\s*\(\s*options\s*\)"Length of output: 1047
Constructor Signature Change Verified
- No calls to the UrlService constructor passing parameters (e.g., object literals) were found in the codebase.
- References to constructors using an "options" parameter appear in unrelated classes; none target UrlService.
These findings confirm that removing the "options" parameter from the UrlService constructor does not impact any code paths.
ghost/core/core/server/services/url/index.js (1)
3-3
: Instantiation matches new constructor signature.Instantiating the service without parameters aligns with the removal of the cache logic. No conflicts found.
ghost/core/test/utils/e2e-utils.js (1)
136-136
: LGTM!The removal of the
urlCache
parameter fromurlServiceUtils.init()
aligns with the PR objective of removing the experimental URL cache feature.ghost/core/core/boot.js (3)
83-83
: LGTM!The removal of the
frontend
parameter from theinitCore
function signature is consistent with the PR objective of removing URL caching functionality.
564-564
: LGTM!The updated
initCore
call correctly reflects the removal of thefrontend
parameter.
120-120
: LGTM!The removal of the URL cache-related callback parameter aligns with the overall cleanup of the URL caching feature.
ghost/core/core/shared/config/env/config.testing-browser.json (1)
82-82
: LGTM!The removal of the
urlCache
path from the configuration file is consistent with the PR objective of removing the experimental URL cache feature.
1c78096
to
db205ce
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (5)
ghost/core/test/e2e-api/content/utils.js (1)
99-101
: Consider handling undefined parameters.While the change is correct, it would be more robust to maintain the default parameter to ensure
testUtils.startGhost
always receives an object.- async startGhost(overrides) { + async startGhost(overrides = {}) { return await testUtils.startGhost(overrides); }ghost/core/test/utils/e2e-framework.js (2)
202-204
: Consider cleaning up the now redundantfrontend
parameter.
These lines always setfrontend: true
, which seems to be the new baseline for these tests. Removing the optional parameter fromstartGhost
altogether (or documenting its new purpose) might reduce confusion in the future.
224-227
: Align documentation with enforced frontend boot.
These lines similarly hardcodefrontend: true
. Ensure that any references or docs implying conditional frontend booting are updated accordingly to avoid mismatched expectations.ghost/core/core/server/services/url/UrlService.js (2)
25-26
: Consider addressing the initialization order technical debt.The comment indicates that
Urls
andResources
initialization should be moved to theinit
method, but this change is blocked by test dependencies. Consider creating a follow-up task to refactor the tests and move the initialization to theinit
method for better separation of concerns.Would you like me to help create an issue to track this technical debt?
312-314
: Consider improving the shutdown method.The method is marked as
async
but contains no implementation. Consider either:
- Removing the
async
keyword if no asynchronous cleanup is needed- Adding cleanup for other resources (e.g., removing event listeners, closing connections)
Example improvement:
-async shutdown() { +shutdown() { + this.resources.releaseAll(); + this.queue.removeListener('started', this._onQueueStartedListener); + this.queue.removeListener('ended', this._onQueueEndedListener); }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (5)
ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/pages.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/content/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-webhooks/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
📒 Files selected for processing (19)
ghost/core/core/boot.js
(3 hunks)ghost/core/core/server/services/url/LocalFileCache.js
(0 hunks)ghost/core/core/server/services/url/UrlService.js
(2 hunks)ghost/core/core/server/services/url/index.js
(1 hunks)ghost/core/core/shared/config/env/config.testing-browser.json
(1 hunks)ghost/core/core/shared/config/env/config.testing-mysql.json
(1 hunks)ghost/core/core/shared/config/env/config.testing.json
(1 hunks)ghost/core/core/shared/labs.js
(0 hunks)ghost/core/test/e2e-api/admin/sso.test.js
(1 hunks)ghost/core/test/e2e-api/admin/utils.js
(1 hunks)ghost/core/test/e2e-api/content/utils.js
(1 hunks)ghost/core/test/unit/server/services/url/LocalFileCache.test.js
(0 hunks)ghost/core/test/unit/shared/config/loader.test.js
(0 hunks)ghost/core/test/unit/shared/labs.test.js
(2 hunks)ghost/core/test/utils/e2e-framework.js
(3 hunks)ghost/core/test/utils/e2e-utils.js
(1 hunks)ghost/core/test/utils/fixtures/urls/resources.json
(0 hunks)ghost/core/test/utils/fixtures/urls/urls.json
(0 hunks)ghost/core/test/utils/url-service-utils.js
(1 hunks)
💤 Files with no reviewable changes (6)
- ghost/core/test/unit/shared/config/loader.test.js
- ghost/core/core/shared/labs.js
- ghost/core/test/unit/server/services/url/LocalFileCache.test.js
- ghost/core/core/server/services/url/LocalFileCache.js
- ghost/core/test/utils/fixtures/urls/resources.json
- ghost/core/test/utils/fixtures/urls/urls.json
🚧 Files skipped from review as they are similar to previous changes (8)
- ghost/core/core/shared/config/env/config.testing-browser.json
- ghost/core/test/utils/url-service-utils.js
- ghost/core/core/shared/config/env/config.testing-mysql.json
- ghost/core/test/e2e-api/admin/utils.js
- ghost/core/core/shared/config/env/config.testing.json
- ghost/core/test/utils/e2e-utils.js
- ghost/core/test/unit/shared/labs.test.js
- ghost/core/core/boot.js
⏰ Context from checks skipped due to timeout of 90000ms (10)
- GitHub Check: Regression tests (Node 20.11.1, sqlite3)
- GitHub Check: Regression tests (Node 20.11.1, mysql8)
- GitHub Check: Database tests (Node 20.11.1, sqlite3)
- GitHub Check: Ghost-CLI tests
- GitHub Check: Database tests (Node 20.11.1, mysql8)
- GitHub Check: Database tests (Node 18.12.1, mysql8)
- GitHub Check: Unit tests (Node 20.11.1)
- GitHub Check: Unit tests (Node 18.12.1)
- GitHub Check: i18n
- GitHub Check: Lint
🔇 Additional comments (5)
ghost/core/test/e2e-api/content/utils.js (1)
99-101
: LGTM! Changes align with URL cache removal.The simplified implementation supports the PR's objective of removing the URL cache functionality by making the test setup more explicit.
ghost/core/test/utils/e2e-framework.js (1)
302-303
: Looks good.
Always enabling the frontend here is consistent with the other agents.ghost/core/core/server/services/url/index.js (1)
3-3
: Removal of cache parameter looks correct.
InstantiatingUrlService
without caching parameters aligns with removing the experimental URL cache.ghost/core/test/e2e-api/admin/sso.test.js (1)
12-13
: Model initialization improvement.
Callingmodels.init()
early ensures all tables and model relationships are fully set up before test execution. This change looks good.ghost/core/core/server/services/url/UrlService.js (1)
299-310
: LGTM! The initialization flow is now cleaner and more maintainable.The method has been simplified to focus on core initialization steps with a clear sequence of operations. The async/await usage properly handles asynchronous operations.
db205ce
to
92b2382
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
ghost/core/core/server/services/url/UrlService.js (1)
312-313
: Consider removing empty method.The
shutdown
method is now empty after removing cache writing logic. Consider removing this method if it's no longer needed.-async shutdown() { -}
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/pages.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/content/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-webhooks/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/integration/services/email-service/__snapshots__/cards.test.js.snap
is excluded by!**/*.snap
📒 Files selected for processing (21)
ghost/core/core/boot.js
(3 hunks)ghost/core/core/server/services/url/LocalFileCache.js
(0 hunks)ghost/core/core/server/services/url/UrlService.js
(2 hunks)ghost/core/core/server/services/url/index.js
(1 hunks)ghost/core/core/shared/config/env/config.testing-browser.json
(1 hunks)ghost/core/core/shared/config/env/config.testing-mysql.json
(1 hunks)ghost/core/core/shared/config/env/config.testing.json
(1 hunks)ghost/core/core/shared/labs.js
(0 hunks)ghost/core/test/e2e-api/admin/sso.test.js
(1 hunks)ghost/core/test/e2e-api/admin/utils.js
(1 hunks)ghost/core/test/e2e-api/content/utils.js
(1 hunks)ghost/core/test/regression/api/admin/utils.js
(1 hunks)ghost/core/test/regression/api/content/utils.js
(1 hunks)ghost/core/test/unit/server/services/url/LocalFileCache.test.js
(0 hunks)ghost/core/test/unit/shared/config/loader.test.js
(0 hunks)ghost/core/test/unit/shared/labs.test.js
(2 hunks)ghost/core/test/utils/e2e-framework.js
(4 hunks)ghost/core/test/utils/e2e-utils.js
(1 hunks)ghost/core/test/utils/fixtures/urls/resources.json
(0 hunks)ghost/core/test/utils/fixtures/urls/urls.json
(0 hunks)ghost/core/test/utils/url-service-utils.js
(1 hunks)
💤 Files with no reviewable changes (6)
- ghost/core/core/shared/labs.js
- ghost/core/core/server/services/url/LocalFileCache.js
- ghost/core/test/utils/fixtures/urls/urls.json
- ghost/core/test/unit/server/services/url/LocalFileCache.test.js
- ghost/core/test/utils/fixtures/urls/resources.json
- ghost/core/test/unit/shared/config/loader.test.js
🚧 Files skipped from review as they are similar to previous changes (11)
- ghost/core/core/shared/config/env/config.testing-mysql.json
- ghost/core/test/e2e-api/admin/utils.js
- ghost/core/core/shared/config/env/config.testing-browser.json
- ghost/core/test/e2e-api/admin/sso.test.js
- ghost/core/core/shared/config/env/config.testing.json
- ghost/core/test/utils/e2e-utils.js
- ghost/core/test/e2e-api/content/utils.js
- ghost/core/test/utils/url-service-utils.js
- ghost/core/core/boot.js
- ghost/core/test/unit/shared/labs.test.js
- ghost/core/core/server/services/url/index.js
🔇 Additional comments (15)
ghost/core/core/server/services/url/UrlService.js (5)
17-34
: LGTM! Constructor simplified by removing cache options.The constructor has been simplified by removing the
cache
option, which aligns with the PR objective of removing the experimental URL cache.
299-310
: LGTM! Initialization process simplified by removing cache-related logic.The initialization process has been streamlined by removing the
urlCache
parameter and its associated logic, which aligns with the PR objective of removing the experimental URL cache.
312-313
: LGTM! Shutdown process simplified by removing cache writing logic.The shutdown process has been streamlined by removing the cache writing logic, which aligns with the PR objective of removing the experimental URL cache.
17-17
: LGTM!The constructor has been simplified by removing the cache-related options parameter, which aligns with the PR objectives of removing URL cache functionality.
299-310
: LGTM!The
init
method has been simplified by:
- Removing the cache-related parameter
- Streamlining the initialization flow
- Directly starting the queue after fetching resources
These changes align with the PR objectives of removing URL cache functionality.
ghost/core/test/utils/e2e-framework.js (8)
81-81
: LGTM! Frontend booting enforced by default.The method now enforces frontend booting by default, which aligns with the PR objective of removing the experimental URL cache and simplifies the initialization process.
202-204
: LGTM! Frontend booting explicitly enabled for content API agent.The method now explicitly sets
frontend: true
, ensuring consistent behavior across all agent creation functions.
225-227
: LGTM! Frontend booting enabled for admin API agent.The method now sets
frontend: true
, ensuring consistent behavior across all agent creation functions.
302-302
: LGTM! Frontend booting enabled for Ghost API agent.The method now sets
frontend: true
, ensuring consistent behavior across all agent creation functions.
81-81
: LGTM!Setting
frontend: true
as the default instartGhost
ensures consistent behavior across all test agents.
202-204
: LGTM!Explicitly setting
frontend: true
ingetContentAPIAgent
aligns with the new default behavior.
225-227
: LGTM!Simplified
getAdminAPIAgent
by settingfrontend: true
aligns with the new default behavior.
302-302
: LGTM!Setting
frontend: true
ingetGhostAPIAgent
aligns with the new default behavior.ghost/core/test/regression/api/content/utils.js (1)
105-106
: LGTM!The simplification of the
startGhost
function by removing the default parameter and directly passing overrides aligns with the PR objectives of removing URL cache functionality.ghost/core/test/regression/api/admin/utils.js (1)
209-210
: LGTM!The simplification of the
startGhost
function by removing the default parameter and directly passing overrides aligns with the PR objectives of removing URL cache functionality.
75b523b
to
16adbb6
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
ghost/core/core/server/services/url/UrlService.js (2)
305-309
: Consider making queue configuration more flexible.The
requiredSubscriberCount
is hardcoded to 1, which might be too rigid. Consider making it configurable to handle changes in the number of subscribers.- this.queue.start({ - event: 'init', - tolerance: 100, - requiredSubscriberCount: 1 - }); + this.queue.start({ + event: 'init', + tolerance: 100, + requiredSubscriberCount: this.urlGenerators.length || 1 + });
312-313
: Consider removing the empty shutdown method.Since the cache writing logic has been removed, this empty method serves no purpose and could be safely removed.
- async shutdown() { - }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (6)
ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/pages.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/content/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/integration/services/email-service/__snapshots__/cards.test.js.snap
is excluded by!**/*.snap
ghost/core/test/regression/api/admin/__snapshots__/authentication.test.js.snap
is excluded by!**/*.snap
📒 Files selected for processing (21)
ghost/core/core/boot.js
(3 hunks)ghost/core/core/server/services/url/LocalFileCache.js
(0 hunks)ghost/core/core/server/services/url/UrlService.js
(2 hunks)ghost/core/core/server/services/url/index.js
(1 hunks)ghost/core/core/shared/config/env/config.testing-browser.json
(1 hunks)ghost/core/core/shared/config/env/config.testing-mysql.json
(1 hunks)ghost/core/core/shared/config/env/config.testing.json
(1 hunks)ghost/core/core/shared/labs.js
(0 hunks)ghost/core/test/e2e-api/admin/sso.test.js
(1 hunks)ghost/core/test/e2e-api/admin/utils.js
(1 hunks)ghost/core/test/e2e-api/content/utils.js
(1 hunks)ghost/core/test/regression/api/admin/utils.js
(1 hunks)ghost/core/test/regression/api/content/utils.js
(1 hunks)ghost/core/test/unit/server/services/url/LocalFileCache.test.js
(0 hunks)ghost/core/test/unit/shared/config/loader.test.js
(0 hunks)ghost/core/test/unit/shared/labs.test.js
(2 hunks)ghost/core/test/utils/e2e-framework.js
(6 hunks)ghost/core/test/utils/e2e-utils.js
(1 hunks)ghost/core/test/utils/fixtures/urls/resources.json
(0 hunks)ghost/core/test/utils/fixtures/urls/urls.json
(0 hunks)ghost/core/test/utils/url-service-utils.js
(1 hunks)
💤 Files with no reviewable changes (6)
- ghost/core/core/shared/labs.js
- ghost/core/test/unit/shared/config/loader.test.js
- ghost/core/test/utils/fixtures/urls/resources.json
- ghost/core/core/server/services/url/LocalFileCache.js
- ghost/core/test/unit/server/services/url/LocalFileCache.test.js
- ghost/core/test/utils/fixtures/urls/urls.json
🚧 Files skipped from review as they are similar to previous changes (14)
- ghost/core/core/shared/config/env/config.testing-mysql.json
- ghost/core/core/shared/config/env/config.testing-browser.json
- ghost/core/test/utils/e2e-utils.js
- ghost/core/test/regression/api/content/utils.js
- ghost/core/test/e2e-api/admin/utils.js
- ghost/core/core/shared/config/env/config.testing.json
- ghost/core/test/e2e-api/admin/sso.test.js
- ghost/core/test/utils/url-service-utils.js
- ghost/core/core/server/services/url/index.js
- ghost/core/core/boot.js
- ghost/core/test/e2e-api/content/utils.js
- ghost/core/test/regression/api/admin/utils.js
- ghost/core/test/utils/e2e-framework.js
- ghost/core/test/unit/shared/labs.test.js
🔇 Additional comments (2)
ghost/core/core/server/services/url/UrlService.js (2)
17-17
: LGTM! Constructor simplified by removing cache parameter.The change aligns with the PR objective of removing the experimental URL cache feature.
299-304
: LGTM! Initialization flow simplified.The removal of cache-related logic makes the initialization process more straightforward and maintainable.
16adbb6
to
09f7040
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
ghost/core/core/server/services/url/UrlService.js (1)
312-313
: Add JSDoc comment to empty shutdown method.While keeping the empty method is good for interface compatibility and future extensibility, it should be documented to explain its purpose.
+/** + * @description Placeholder method maintained for interface compatibility and future extensibility. + */ async shutdown() { }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/pages.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/content/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-webhooks/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/integration/services/email-service/__snapshots__/cards.test.js.snap
is excluded by!**/*.snap
ghost/core/test/regression/api/admin/__snapshots__/authentication.test.js.snap
is excluded by!**/*.snap
📒 Files selected for processing (21)
ghost/core/core/boot.js
(3 hunks)ghost/core/core/server/services/url/LocalFileCache.js
(0 hunks)ghost/core/core/server/services/url/UrlService.js
(2 hunks)ghost/core/core/server/services/url/index.js
(1 hunks)ghost/core/core/shared/config/env/config.testing-browser.json
(1 hunks)ghost/core/core/shared/config/env/config.testing-mysql.json
(1 hunks)ghost/core/core/shared/config/env/config.testing.json
(1 hunks)ghost/core/core/shared/labs.js
(0 hunks)ghost/core/test/e2e-api/admin/sso.test.js
(1 hunks)ghost/core/test/e2e-api/admin/utils.js
(1 hunks)ghost/core/test/e2e-api/content/utils.js
(1 hunks)ghost/core/test/regression/api/admin/utils.js
(1 hunks)ghost/core/test/regression/api/content/utils.js
(1 hunks)ghost/core/test/unit/server/services/url/LocalFileCache.test.js
(0 hunks)ghost/core/test/unit/shared/config/loader.test.js
(0 hunks)ghost/core/test/unit/shared/labs.test.js
(2 hunks)ghost/core/test/utils/e2e-framework.js
(6 hunks)ghost/core/test/utils/e2e-utils.js
(1 hunks)ghost/core/test/utils/fixtures/urls/resources.json
(0 hunks)ghost/core/test/utils/fixtures/urls/urls.json
(0 hunks)ghost/core/test/utils/url-service-utils.js
(1 hunks)
💤 Files with no reviewable changes (6)
- ghost/core/core/shared/labs.js
- ghost/core/core/server/services/url/LocalFileCache.js
- ghost/core/test/unit/server/services/url/LocalFileCache.test.js
- ghost/core/test/unit/shared/config/loader.test.js
- ghost/core/test/utils/fixtures/urls/urls.json
- ghost/core/test/utils/fixtures/urls/resources.json
🚧 Files skipped from review as they are similar to previous changes (14)
- ghost/core/core/shared/config/env/config.testing-browser.json
- ghost/core/test/regression/api/content/utils.js
- ghost/core/core/shared/config/env/config.testing-mysql.json
- ghost/core/core/boot.js
- ghost/core/core/shared/config/env/config.testing.json
- ghost/core/test/e2e-api/admin/utils.js
- ghost/core/core/server/services/url/index.js
- ghost/core/test/e2e-api/admin/sso.test.js
- ghost/core/test/unit/shared/labs.test.js
- ghost/core/test/utils/url-service-utils.js
- ghost/core/test/regression/api/admin/utils.js
- ghost/core/test/utils/e2e-utils.js
- ghost/core/test/utils/e2e-framework.js
- ghost/core/test/e2e-api/content/utils.js
⏰ Context from checks skipped due to timeout of 90000ms (10)
- GitHub Check: Unit tests (Node 20.11.1)
- GitHub Check: Unit tests (Node 18.12.1)
- GitHub Check: Regression tests (Node 20.11.1, sqlite3)
- GitHub Check: Regression tests (Node 20.11.1, mysql8)
- GitHub Check: Database tests (Node 20.11.1, sqlite3)
- GitHub Check: Lint
- GitHub Check: Database tests (Node 20.11.1, mysql8)
- GitHub Check: i18n
- GitHub Check: Ghost-CLI tests
- GitHub Check: Database tests (Node 18.12.1, mysql8)
🔇 Additional comments (2)
ghost/core/core/server/services/url/UrlService.js (2)
17-17
: LGTM! Constructor simplified by removing cache parameter.The constructor has been streamlined to focus on core initialization, aligning with the PR objective of removing URL cache functionality.
299-310
: LGTM! Initialization flow simplified by removing cache logic.The
init
method has been streamlined to follow a clear, direct initialization flow:
- Set callback
- Initialize listeners
- Fetch resources
- Start queue
The changes maintain essential functionality while reducing complexity.
09f7040
to
2cfa836
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (1)
ghost/core/core/server/services/url/UrlService.js (1)
312-313
: Consider adding a comment explaining the empty method.The shutdown method is now empty but retained for interface compatibility. Consider adding a comment to explain why this method exists.
async shutdown() { + // Method retained for interface compatibility }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/pages.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/content/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-webhooks/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/integration/services/email-service/__snapshots__/cards.test.js.snap
is excluded by!**/*.snap
ghost/core/test/regression/api/admin/__snapshots__/authentication.test.js.snap
is excluded by!**/*.snap
📒 Files selected for processing (21)
ghost/core/core/boot.js
(3 hunks)ghost/core/core/server/services/url/LocalFileCache.js
(0 hunks)ghost/core/core/server/services/url/UrlService.js
(2 hunks)ghost/core/core/server/services/url/index.js
(1 hunks)ghost/core/core/shared/config/env/config.testing-browser.json
(1 hunks)ghost/core/core/shared/config/env/config.testing-mysql.json
(1 hunks)ghost/core/core/shared/config/env/config.testing.json
(1 hunks)ghost/core/core/shared/labs.js
(0 hunks)ghost/core/test/e2e-api/admin/sso.test.js
(1 hunks)ghost/core/test/e2e-api/admin/utils.js
(1 hunks)ghost/core/test/e2e-api/content/utils.js
(1 hunks)ghost/core/test/regression/api/admin/utils.js
(1 hunks)ghost/core/test/regression/api/content/utils.js
(1 hunks)ghost/core/test/unit/server/services/url/LocalFileCache.test.js
(0 hunks)ghost/core/test/unit/shared/config/loader.test.js
(0 hunks)ghost/core/test/unit/shared/labs.test.js
(2 hunks)ghost/core/test/utils/e2e-framework.js
(6 hunks)ghost/core/test/utils/e2e-utils.js
(1 hunks)ghost/core/test/utils/fixtures/urls/resources.json
(0 hunks)ghost/core/test/utils/fixtures/urls/urls.json
(0 hunks)ghost/core/test/utils/url-service-utils.js
(1 hunks)
💤 Files with no reviewable changes (6)
- ghost/core/core/shared/labs.js
- ghost/core/test/unit/shared/config/loader.test.js
- ghost/core/test/utils/fixtures/urls/resources.json
- ghost/core/core/server/services/url/LocalFileCache.js
- ghost/core/test/utils/fixtures/urls/urls.json
- ghost/core/test/unit/server/services/url/LocalFileCache.test.js
🚧 Files skipped from review as they are similar to previous changes (13)
- ghost/core/core/shared/config/env/config.testing-mysql.json
- ghost/core/core/shared/config/env/config.testing-browser.json
- ghost/core/core/shared/config/env/config.testing.json
- ghost/core/test/regression/api/content/utils.js
- ghost/core/test/utils/url-service-utils.js
- ghost/core/test/e2e-api/admin/sso.test.js
- ghost/core/test/regression/api/admin/utils.js
- ghost/core/test/utils/e2e-utils.js
- ghost/core/core/boot.js
- ghost/core/test/e2e-api/content/utils.js
- ghost/core/test/unit/shared/labs.test.js
- ghost/core/core/server/services/url/index.js
- ghost/core/test/e2e-api/admin/utils.js
🔇 Additional comments (4)
ghost/core/core/server/services/url/UrlService.js (2)
17-34
: LGTM! Constructor simplified by removing cache options.The constructor has been simplified by removing cache-related options, which aligns with the PR objective of removing the experimental URL cache.
299-310
: LGTM! Initialization logic streamlined.The init method has been simplified by removing cache-related logic and directly initializing resources and queue. The changes make the code more maintainable.
ghost/core/test/utils/e2e-framework.js (2)
79-83
: LGTM! Frontend is now always enabled by default.The change to enable frontend by default simplifies the test setup and aligns with the removal of URL cache functionality.
222-313
: LGTM! API agent creation methods simplified.The API agent creation methods have been simplified by removing boot options, which is consistent with the new default frontend behavior.
2cfa836
to
8449cea
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 0
🧹 Nitpick comments (2)
ghost/core/core/server/services/url/UrlService.js (2)
299-310
: LGTM! Init method streamlined with clear initialization sequence.The initialization process is now more straightforward with a clear sequence of operations. Consider adding debug logs to help with troubleshooting.
Add debug logs to track initialization progress:
async init({onFinished} = {}) { + debug('Initializing URL service'); this.onFinished = onFinished; + debug('Initializing resource event listeners'); this.resources.initEventListeners(); + debug('Fetching resources'); await this.resources.fetchResources(); // CASE: all resources are fetched, start the queue + debug('Starting queue'); this.queue.start({ event: 'init', tolerance: 100, requiredSubscriberCount: 1 }); }
312-314
: Add JSDoc comment to explain the empty shutdown method.The empty shutdown method should be documented to explain its purpose and why it remains empty after removing cache-related cleanup.
Add JSDoc comment:
+/** + * @description Cleanup method called during service shutdown. + * @note This method is kept for interface consistency and future use. + */ async shutdown() { }
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/pages.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/content/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-webhooks/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/integration/services/email-service/__snapshots__/cards.test.js.snap
is excluded by!**/*.snap
ghost/core/test/regression/api/admin/__snapshots__/authentication.test.js.snap
is excluded by!**/*.snap
📒 Files selected for processing (21)
ghost/core/core/boot.js
(3 hunks)ghost/core/core/server/services/url/LocalFileCache.js
(0 hunks)ghost/core/core/server/services/url/UrlService.js
(2 hunks)ghost/core/core/server/services/url/index.js
(1 hunks)ghost/core/core/shared/config/env/config.testing-browser.json
(1 hunks)ghost/core/core/shared/config/env/config.testing-mysql.json
(1 hunks)ghost/core/core/shared/config/env/config.testing.json
(1 hunks)ghost/core/core/shared/labs.js
(0 hunks)ghost/core/test/e2e-api/admin/sso.test.js
(1 hunks)ghost/core/test/e2e-api/admin/utils.js
(1 hunks)ghost/core/test/e2e-api/content/utils.js
(1 hunks)ghost/core/test/regression/api/admin/utils.js
(1 hunks)ghost/core/test/regression/api/content/utils.js
(1 hunks)ghost/core/test/unit/server/services/url/LocalFileCache.test.js
(0 hunks)ghost/core/test/unit/shared/config/loader.test.js
(0 hunks)ghost/core/test/unit/shared/labs.test.js
(2 hunks)ghost/core/test/utils/e2e-framework.js
(6 hunks)ghost/core/test/utils/e2e-utils.js
(1 hunks)ghost/core/test/utils/fixtures/urls/resources.json
(0 hunks)ghost/core/test/utils/fixtures/urls/urls.json
(0 hunks)ghost/core/test/utils/url-service-utils.js
(1 hunks)
💤 Files with no reviewable changes (6)
- ghost/core/core/shared/labs.js
- ghost/core/test/unit/shared/config/loader.test.js
- ghost/core/test/utils/fixtures/urls/resources.json
- ghost/core/test/unit/server/services/url/LocalFileCache.test.js
- ghost/core/core/server/services/url/LocalFileCache.js
- ghost/core/test/utils/fixtures/urls/urls.json
🚧 Files skipped from review as they are similar to previous changes (14)
- ghost/core/core/shared/config/env/config.testing-mysql.json
- ghost/core/test/regression/api/content/utils.js
- ghost/core/test/utils/e2e-utils.js
- ghost/core/test/e2e-api/admin/sso.test.js
- ghost/core/core/shared/config/env/config.testing-browser.json
- ghost/core/test/e2e-api/admin/utils.js
- ghost/core/test/regression/api/admin/utils.js
- ghost/core/core/boot.js
- ghost/core/test/utils/url-service-utils.js
- ghost/core/test/e2e-api/content/utils.js
- ghost/core/test/unit/shared/labs.test.js
- ghost/core/test/utils/e2e-framework.js
- ghost/core/core/server/services/url/index.js
- ghost/core/core/shared/config/env/config.testing.json
⏰ Context from checks skipped due to timeout of 90000ms (9)
- GitHub Check: Ghost-CLI tests
- GitHub Check: Regression tests (Node 20.11.1, sqlite3)
- GitHub Check: Database tests (Node 20.11.1, sqlite3)
- GitHub Check: Unit tests (Node 20.11.1)
- GitHub Check: Database tests (Node 20.11.1, mysql8)
- GitHub Check: Unit tests (Node 18.12.1)
- GitHub Check: Database tests (Node 18.12.1, mysql8)
- GitHub Check: i18n
- GitHub Check: Lint
🔇 Additional comments (1)
ghost/core/core/server/services/url/UrlService.js (1)
17-34
: LGTM! Constructor simplified by removing cache initialization.The removal of cache-related initialization aligns with the PR objectives and reduces complexity.
8449cea
to
82a8bf1
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Actionable comments posted: 1
🧹 Nitpick comments (1)
ghost/core/core/server/services/url/UrlService.js (1)
312-313
: Consider documenting the empty method.Since the method is part of the public API but now empty after removing cache-related cleanup, consider either:
- Adding a comment explaining why it's empty
- Or removing it if it's no longer needed
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (7)
ghost/core/test/e2e-api/admin/__snapshots__/config.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/pages.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/admin/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-api/content/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/e2e-webhooks/__snapshots__/posts.test.js.snap
is excluded by!**/*.snap
ghost/core/test/integration/services/email-service/__snapshots__/cards.test.js.snap
is excluded by!**/*.snap
ghost/core/test/regression/api/admin/__snapshots__/authentication.test.js.snap
is excluded by!**/*.snap
📒 Files selected for processing (22)
ghost/core/core/boot.js
(3 hunks)ghost/core/core/server/services/url/LocalFileCache.js
(0 hunks)ghost/core/core/server/services/url/UrlService.js
(2 hunks)ghost/core/core/server/services/url/index.js
(1 hunks)ghost/core/core/shared/config/env/config.testing-browser.json
(1 hunks)ghost/core/core/shared/config/env/config.testing-mysql.json
(1 hunks)ghost/core/core/shared/config/env/config.testing.json
(1 hunks)ghost/core/core/shared/labs.js
(0 hunks)ghost/core/test/e2e-api/admin/sso.test.js
(1 hunks)ghost/core/test/e2e-api/admin/utils.js
(1 hunks)ghost/core/test/e2e-api/content/utils.js
(1 hunks)ghost/core/test/integration/services/email-service/cards.test.js
(1 hunks)ghost/core/test/regression/api/admin/utils.js
(1 hunks)ghost/core/test/regression/api/content/utils.js
(1 hunks)ghost/core/test/unit/server/services/url/LocalFileCache.test.js
(0 hunks)ghost/core/test/unit/shared/config/loader.test.js
(0 hunks)ghost/core/test/unit/shared/labs.test.js
(2 hunks)ghost/core/test/utils/e2e-framework.js
(6 hunks)ghost/core/test/utils/e2e-utils.js
(1 hunks)ghost/core/test/utils/fixtures/urls/resources.json
(0 hunks)ghost/core/test/utils/fixtures/urls/urls.json
(0 hunks)ghost/core/test/utils/url-service-utils.js
(1 hunks)
💤 Files with no reviewable changes (6)
- ghost/core/test/unit/shared/config/loader.test.js
- ghost/core/test/utils/fixtures/urls/resources.json
- ghost/core/core/shared/labs.js
- ghost/core/test/utils/fixtures/urls/urls.json
- ghost/core/core/server/services/url/LocalFileCache.js
- ghost/core/test/unit/server/services/url/LocalFileCache.test.js
🚧 Files skipped from review as they are similar to previous changes (13)
- ghost/core/core/shared/config/env/config.testing-browser.json
- ghost/core/test/utils/e2e-utils.js
- ghost/core/test/regression/api/content/utils.js
- ghost/core/test/e2e-api/admin/sso.test.js
- ghost/core/core/shared/config/env/config.testing-mysql.json
- ghost/core/core/shared/config/env/config.testing.json
- ghost/core/test/e2e-api/admin/utils.js
- ghost/core/test/regression/api/admin/utils.js
- ghost/core/test/utils/url-service-utils.js
- ghost/core/test/e2e-api/content/utils.js
- ghost/core/core/boot.js
- ghost/core/test/unit/shared/labs.test.js
- ghost/core/core/server/services/url/index.js
🧰 Additional context used
🪛 Biome (1.9.4)
ghost/core/test/integration/services/email-service/cards.test.js
[error] 68-68: Don't focus the test.
The 'only' method is often used for debugging or during implementation. It should be removed before deploying to production.
Consider removing 'only' to ensure all tests are executed.
Unsafe fix: Remove focus from test.
(lint/suspicious/noFocusedTests)
🪛 ESLint
ghost/core/test/integration/services/email-service/cards.test.js
[error] 68-68: Unexpected exclusive mocha test.
(ghost/mocha/no-exclusive-tests)
🔇 Additional comments (7)
ghost/core/core/server/services/url/UrlService.js (2)
17-17
: LGTM!The constructor signature has been simplified by removing the unused cache parameter, aligning with the PR objective to remove the experimental URL cache.
299-309
: LGTM!The initialization logic has been streamlined by:
- Removing the unused
urlCache
parameter- Simplifying the flow to directly initialize event listeners and fetch resources
This change improves code clarity while aligning with the PR objective to remove the experimental URL cache.
ghost/core/test/utils/e2e-framework.js (5)
81-81
: LGTM!Setting
frontend: true
as the default ensures consistent behavior by always booting the frontend, which simplifies the initialization process.
222-224
: LGTM!The function has been simplified by removing the unused options parameter and using the default startGhost configuration.
246-246
: LGTM!The function now uses the default startGhost configuration, which is consistent with the simplified initialization process.
268-268
: LGTM!The function now uses the default startGhost configuration, aligning with the simplified initialization process.
290-290
: LGTM!The function now uses the default startGhost configuration, maintaining consistency with the simplified initialization process.
@@ -65,7 +65,7 @@ function createLexicalJson(cards = []) { | |||
|
|||
let agent; | |||
|
|||
describe('Can send cards via email', function () { | |||
describe.only('Can send cards via email', function () { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Remove .only from the test suite.
Using .only
prevents other test suites from running. This is typically used for debugging but should not be committed.
Apply this diff to fix the issue:
-describe.only('Can send cards via email', function () {
+describe('Can send cards via email', function () {
📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
describe.only('Can send cards via email', function () { | |
describe('Can send cards via email', function () { |
🧰 Tools
🪛 Biome (1.9.4)
[error] 68-68: Don't focus the test.
The 'only' method is often used for debugging or during implementation. It should be removed before deploying to production.
Consider removing 'only' to ensure all tests are executed.
Unsafe fix: Remove focus from test.
(lint/suspicious/noFocusedTests)
🪛 ESLint
[error] 68-68: Unexpected exclusive mocha test.
(ghost/mocha/no-exclusive-tests)
16f25fb
to
2b688df
Compare
fix https://linear.app/ghost/issue/ENG-1803/remove-url-cache-code - this feature is experimental and was designed in order to speed up our URL service init by storing a cache of the object - however, it was never really finished and we've had a few bugs with it - to avoid further issues, this commit removes it - along the way, I've discovered that our tests REQUIRE the URL cache in order to pass, which I thought was weird. Turns out it's because they incorrectly set cache values into the URL service that are outdated, which meant our snapshots are wrong - this is why several of the snapshots have been updated, because URLs have changed - sadly this commit touches so many files, but this feature was really spread around the codebase - this technically removes test util API support for a split backend/frontend but that wasn't properly finished. I'd like to get that working, but first we need to unpick the mess we've got ourselves into
2b688df
to
523337c
Compare
fix https://linear.app/ghost/issue/ENG-1803/remove-url-cache-code