feat: add PLG preonboarding and delivery config backfill scripts#1976
Open
Kanishkavijay39 wants to merge 19 commits intomainfrom
Open
feat: add PLG preonboarding and delivery config backfill scripts#1976Kanishkavijay39 wants to merge 19 commits intomainfrom
Kanishkavijay39 wants to merge 19 commits intomainfrom
Conversation
- plg-preonboard.js: preonboards domains by creating org/site, enabling audits and summit-plg, creating ASO entitlement, and setting status to PRE_ONBOARDING so the customer's POST /plg/onboard fast-tracks to ONBOARDED. Resolves canonical URL before RUM lookup to handle www redirects. - plg-backfill-delivery-config.js: targeted script to backfill deliveryConfig (authorURL, programId, environmentId) for already-preonboarded sites where the initial RUM lookup failed. Uses overrideBaseURL hostname for the RUM query.
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
|
This PR will trigger a minor release when merged. |
Kanishkavijay39
changed the title
… admin bypass - preonboard script: enable all 11 ASO PLG handlers (auto-fix, auto-suggest) via single API call, add site entitlement enrollment, trigger audits via SQS, use demo org for site/entitlement while keeping customer imsOrgId in record, include waitlisted/skipped domains in CSV report - rollback script: disable all config handlers in one API call - profiles.json: add auto-fix/auto-suggest handlers to aso_plg profile - plg-onboarding controller: enable all config handlers in one save call, allow admin/API key callers to bypass tenant check in getStatus - tests: add AccessControlUtil mock and admin bypass test cases for getStatus
Checks preonboarded/onboarded sites for missing data and fills gaps without overwriting existing values. Backfills: overrideBaseURL, deliveryConfig (authorURL), code config, hlxConfig, locale, projectId.
Outputs a CSV report with the original site object before any changes, enabling rollback if needed. Matches the pattern from plg-preonboard.js.
…o plg-preonboarding-scripts
For existing sites, resolve field values but only write when absent. When present, validate against resolved values and report in CSV as absent_added, correct, or wrong:actual=X|expected=Y. New CSV columns: v_deliveryType, v_overrideBaseURL, v_authorURL, v_code, v_hlxConfig.
Add helper scripts for PLG preonboarding operations: - add-aso-entitlement, delete-plg-record, set-plg-preonboarding - plg-enable-handlers, plg-trigger-audits, plg-pageviews - update-plg-imsorgid, update-plg-orgid, update-site-org - site-opportunities-report
Documents all 14 scripts with usage, env vars, input formats, and troubleshooting. Covers the typical workflow from preonboarding through backfill and rollback.
…mmit Step 9 (trigger audit runs via SQS for alt-text, cwv, broken-backlinks, scrape-top-pages) was accidentally removed during the validation columns refactor. Restored as Step 8.
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.
plg-preonboard.js: preonboards domains by creating org/site, enabling audits and summit-plg, creating ASO entitlement, and setting status to PRE_ONBOARDING so the customer's POST /plg/onboard fast-tracks to ONBOARDED. Resolves canonical URL before RUM lookup to handle www redirects.
plg-backfill-delivery-config.js: targeted script to backfill deliveryConfig (authorURL, programId, environmentId) for already-preonboarded sites where the initial RUM lookup failed. Uses overrideBaseURL hostname for the RUM query.
Please ensure your pull request adheres to the following guidelines:
describe here the problem you're solving.
If the PR is changing the API specification:
yet. Ideally, return a 501 status code with a message explaining the feature is not implemented yet.
If the PR is changing the API implementation or an entity exposed through the API:
If the PR is introducing a new audit type:
Related Issues
Thanks for contributing!