-
Notifications
You must be signed in to change notification settings - Fork 2
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
feat: introduce audit for broken backlinks SITES-18417 #77
Conversation
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.
Some points to be addressed below:
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.
Audit results need to be stored using dataAccess.addAudit
. See https://github.com/adobe/spacecat-audit-worker/blob/main/src/lhs/handler.js#L265 for reference.
We should audit on a site-level... audits need to be stored and referenced to a site. see https://github.com/adobe/spacecat-audit-worker/blob/main/src/lhs/handler.js#L353 |
@solaris007 , this is storing the audit result in DynamoDB, no? Is it mandatory or just best practice?
The |
This PR will trigger a minor release when merged. |
I would consider it both mandatory and best-practice :) audits should be standardized (exceptions apply), in that we store them into our data layer for exposure to our various UIs (e.g. slack bot) and via the HTTP API, serving for analysis and visualization.
the URL represents a site, if the url corresponds to a baseURL (unique for sites) for a known site. all audits (exceptions apply) should check whether the audit target (the site) exists and furthermore if the audit config of the site disables audits in general or specifically for that audit type.
Please see the "data model" tab here: https://lucid.app/lucidchart/f5480d07-626d-42e8-8eb5-39b0e9a1c75f/edit?viewport_loc=-128%2C323%2C2452%2C1717%2C0_0&invitationId=inv_c77bd463-5df8-4973-b70b-a8028a6ee21a Some details also in the readme (outdated): https://github.com/adobe/spacecat-shared/tree/main/packages/spacecat-shared-data-access |
@solaris007 what of your review is blocking vs what can we do later? Before we aim for engineering excellence, I need to get the use case out in the wild to discuss how/if it makes sense. Thanks! |
@basecode the execution of the audit in the context of a site obtained from the data layer and storage of the audit result is not engineering excellence, but essential for downstream automation and consumption |
Weekly schedule (dev + prod) have been created with event payload |
…ker into SITES-18417
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #77 +/- ##
==========================================
Coverage 100.00% 100.00%
==========================================
Files 10 12 +2
Lines 1111 1306 +195
==========================================
+ Hits 1111 1306 +195 ☔ View full report in Codecov by Sentry. |
…ker into SITES-18417
Add broken-backlinks as supported audit type for SITES-18417. Relates to adobe/spacecat-audit-worker#77, adobe/spacecat-audit-post-processor#37, adobe/spacecat-audit-scheduler#27
# [1.16.0](v1.15.5...v1.16.0) (2024-01-22) ### Features * add broken-backlinks trigger (SITES-18417) ([#97](#97)) ([2524d2a](2524d2a)), closes [adobe/spacecat-audit-worker#77](adobe/spacecat-audit-worker#77) [adobe/spacecat-audit-post-processor#37](adobe/spacecat-audit-post-processor#37) [adobe/spacecat-audit-scheduler#27](adobe/spacecat-audit-scheduler#27)
Add broken-backlinks as supported audit type for SITES-18417. Relates to adobe/spacecat-audit-worker#77, adobe/spacecat-audit-post-processor#37, adobe/spacecat-api-service#97
# [1.3.0](v1.2.0...v1.3.0) (2024-01-22) ### Features * add broken-backlinks audit type (SITES-18417) ([#27](#27)) ([9fec401](9fec401)), closes [adobe/spacecat-audit-worker#77](adobe/spacecat-audit-worker#77) [adobe/spacecat-audit-post-processor#37](adobe/spacecat-audit-post-processor#37)
…7) (#37) Implement the post processor for broken-backlinks audit (SITES-18417). Relates to adobe/spacecat-audit-worker#77.
# [1.3.0](v1.2.3...v1.3.0) (2024-01-23) ### Features * introduce post processor for broken-backlinks audit (SITES-18417) ([#37](#37)) ([7f0f699](7f0f699)), closes [adobe/spacecat-audit-worker#77](adobe/spacecat-audit-worker#77)
# [1.7.0](v1.6.7...v1.7.0) (2024-01-23) ### Features * introduce audit for broken-backlinks (SITES-18417) ([#77](#77)) ([034e5e8](034e5e8)), closes [adobe/spacecat-audit-post-processor#37](adobe/spacecat-audit-post-processor#37)
🎉 This PR is included in version 1.7.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
PR Status
This PR implements the audit worker for SITES-18417.
Relates to adobe/spacecat-audit-post-processor#37