Updated email analytics jobs to change completed status to finished

[cmraible]

no issue

• Currently the email analytics jobs record their status in the jobs table when they are finished. They are currently using completed as their status, but this is not an accepted option in the DB schema — it should be finished.
• The status is set using raw knex queries, which bypasses the schema/model validation layer. It doesn't create any problems for the email analytics jobs themselves, but other areas of the codebase query the jobs table using the bookshelf models, and this can create an error since the table contains invalid data.

[coderabbitai]

Walkthrough

This pull request updates the status terminology in the email analytics service by replacing the string "completed" with "finished" in two key locations within the EmailAnalyticsService.js file. These modifications are applied during both the setting of job timestamps for scheduled data and the updating of job statuses after fetching data. Additionally, corresponding changes were made to the test suite (email-analytics-service.test.js) by adding an assertion to verify that the job status is correctly set to "finished." The changes solely affect the terminology used during status updates without altering the underlying logic, control flow, or public interfaces of the service.

Possibly related PRs

• Removed job queue handling within the email analytics job #22243: This PR involves modifications to event handling in member email analytics, which affects job processing logic similar to the changes in the current update.

Suggested reviewers

• mike182uk

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 01c83f1 and 1ae5708.

📒 Files selected for processing (2)

• ghost/email-analytics-service/lib/EmailAnalyticsService.js (2 hunks)
• ghost/email-analytics-service/test/email-analytics-service.test.js (1 hunks)

✅ Files skipped from review due to trivial changes (1)

• ghost/email-analytics-service/lib/EmailAnalyticsService.js

⏰ Context from checks skipped due to timeout of 90000ms (12)

• GitHub Check: Unit tests (Node 22.13.1)
• 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: Database tests (Node 22.13.1, mysql8)
• 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 (1)

ghost/email-analytics-service/test/email-analytics-service.test.js (1)

230-230: Test assertion added to verify job status change.

This new assertion correctly validates that the job status is set to 'finished' rather than 'completed', which aligns with the PR objective of ensuring the status values in the jobs table conform to the database schema's valid options.

✨ Finishing Touches

• 📝 Generate Docstrings

---

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?

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

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)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.