feat: site sandbox configuration #941
Open
Conversation
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
added 3 commits
August 27, 2025 21:21
- Add sandboxAudits attribute to global configuration schema - Add helper methods for managing sandbox audit configurations - Enable sandbox sites to override regular audit handler settings
|
This PR will trigger a minor release when merged. |
Kanishkavijay39
changed the title
… sandboxAudits - Replace this.state.sandboxAudits with this.getSandboxAudits() and this.setSandboxAudits() - Fix updateSandboxAuditConfig, getSandboxAuditConfig, getEnabledSandboxAudits, and removeSandboxAuditConfig methods - Ensure sandbox audit configurations persist properly in database - Add comprehensive logging for debugging sandbox audit operations
Kanishkavijay39
force-pushed
the
feature/site-sandbox-configuration
branch
from
efff862 to
4f00e5e
Compare
added 3 commits
September 10, 2025 01:51
- Add comprehensive documentation for the sandbox audit configuration update method - Ensure clear understanding of method purpose and functionality
Kanishkavijay39
force-pushed
the
feature/site-sandbox-configuration
branch
from
437e0f8 to
0b776e1
Compare
added 9 commits
September 11, 2025 13:24
…oi schema validation.
- Update updateSandboxAuditConfig to properly handle null values for removal - Simplify schema validation to only require 'enabled' (boolean) and 'expire' (string/number) - Allow additional properties for future extensibility - Update tests to match new simplified schema and removal behavior This ensures sandbox audit configurations can be properly removed by passing null values.
- Add sandbox audit methods to Configuration model - Support updateSandboxAuditConfig, getSandboxAudits, etc. - Fix regex pattern for audit type validation - Simplify validation logic (remove null/undefined bypass) - Remove auto-enable logic for sandbox sites - Add comprehensive test coverage
- Rollback package-lock.json version updates - Rollback unrelated test changes in audit/site models - Rollback url-helpers.js export addition - Remove unrelated test files (adobe-fetch.test.js, test-rum.js) - Keep PR focused only on sandbox audit configuration
- Remove fix-entity.schema.test.js (99 lines, unrelated) - Remove trial-user.schema.test.js (73 lines, unrelated) - Keep feature branch focused only on sandbox configuration
…uration - Update configuration schema to use cooldownHours instead of expire - Update tests to reflect the new cooldownHours field - Improve clarity: cooldownHours better describes the rate limiting behavior - All tests passing with 100% coverage
- Restore original 768+ line API documentation file - No functional changes to sandbox configuration feature - Keep spacecat-shared focused on our sandbox changes only
Kanishkavijay39
changed the title
Kanishkavijay39
requested review from
solaris007,
iuliaangelescu and
iuliag
and removed request for
iuliaangelescu
solaris007
approved these changes
Sep 17, 2025
iuliag
changed the title
iuliag
reviewed
Sep 17, 2025
|
|
||
| // Get all enabled sandbox audit types | ||
| getEnabledSandboxAudits() { | ||
| return Object.keys(this.getSandboxAudits() || {}); |
There was a problem hiding this comment.
Shouldn't the list be filtered by enabled true, according to the schema https://github.com/adobe/spacecat-shared/pull/941/files#diff-ec6a8162056224108b6fc55e86bf6d58298ed01c9cd75a0bb024369f6356b49bR52 ?
Same for isAuditEnabledForSandbox below.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Add Sandbox Audit Configuration API
Problem
Need centralized control over sandbox audit execution:
Solution
Adds global sandbox audit configuration with full API support:
sandboxAuditsattribute in Configuration model for centralized control/configurations/sandboxAPI endpoint for runtime updatesChanges
spacecat-shared (Configuration Model):
getSandboxAudits(),setSandboxAudits(),getSandboxAuditConfig(auditType)updateSandboxAuditConfig(auditType, config)for updatesisAuditEnabledForSandbox(auditType),hasSandboxAudits()helpersgetEnabledSandboxAudits()for listing enabled audit typesAPI Usage
PATCH /configurations/sandbox { "sandboxConfigs": { "meta-tags": { "cooldownHours": "3", "enabled": true }, "alt-text": { "cooldownHours": "6", "enabled": false } } }