Started executing automations (in development)#28120
Open
EvanHahn wants to merge 16 commits into
Open
Conversation
Contributor
|
Too many files changed? Review this PR in Change Stack to see how the pieces fit before you dive in. No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Run ID: ⛔ Files ignored due to path filters (1)
📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (2)
WalkthroughThis PR implements an automation step polling and execution system: it defines step types and constants, extends the repository API for locking/transition operations, implements those operations in the fake-database repository (locking, finish+enqueue, retry, terminal), provides a poll runner that fetches/locks steps, executes wait and send_email steps with retries and terminal logic, refactors the member-welcome-emails service to send automation emails, wires automationsApi into the service, and adds unit and e2e tests covering these flows. Possibly related PRs
Suggested labels
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 warning)
✅ Passed checks (4 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
|
| Command | Status | Duration | Result |
|---|---|---|---|
nx run ghost:build:tsc |
❌ Failed | 5s | View ↗ |
nx run-many -t lint -p ghost |
❌ Failed | 11s | View ↗ |
nx run ghost:test:ci:integration |
✅ Succeeded | 1m 57s | View ↗ |
nx run ghost:test:ci:e2e |
✅ Succeeded | 7m 53s | View ↗ |
nx run ghost:test:ci:legacy |
✅ Succeeded | 3m 3s | View ↗ |
nx run-many -t test:unit -p ghost |
✅ Succeeded | 31s | View ↗ |
nx run-many --target=build --projects=@tryghost... |
✅ Succeeded | <1s | View ↗ |
☁️ Nx Cloud last updated this comment at 2026-05-25 21:05:13 UTC
EvanHahn
force-pushed
the
ny-1286-north-star
branch
3 times, most recently
from
f349d29 to
595810d
Compare
EvanHahn
added a commit
that referenced
this pull request
May 28, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 We can use `export foo` instead of `module.exports`. This change should have no user impact, but makes an upcoming change easier.
troyciesco
pushed a commit
that referenced
this pull request
Jun 3, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 **I recommend [reviewing this with whitespace changes disabled](https://github.com/TryGhost/Ghost/pull/28263/changes?w=1).** When a member signs up, we should trigger an automation run and possibly insert a new row. Nothing happens yet when these rows are inserted. That will be done in a future change. This is development-only; triggering is a no-op in production. I tested this by: - Adding automated tests. - Verified that the old member welcome email is still sent on member signup. - Creating this temporary endpoint and verifying that the results looked expected after member signup: ```js router.get('/automations/database-dump', (_req, res) => { const db = getTemporaryFakeAutomationsDatabase(); res.json({ automation_runs: db.prepare('SELECT * FROM automation_runs').all(), automation_run_steps: db.prepare('SELECT * FROM automation_run_steps').all() }); }); ```
EvanHahn
added a commit
that referenced
this pull request
Jun 3, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 This change should have no impact on functionality. We have [a lint rule that limits the length of `index.js` files][0]. In [an upcoming change][1], the automations service will cross that limit. This patch moves it into a separate file. Doing so also makes it a little easier to test. [0]: https://github.com/TryGhost/eslint-plugin-ghost/blob/22d154a8e3807e4e30219fb8449e7aa9b90a110b/lib/config/node.js#L32-L37 [1]: #28120
EvanHahn
added a commit
that referenced
this pull request
Jun 3, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 This change should have no impact on functionality. We have [a lint rule that limits the length of `index.js` files][0]. In [an upcoming change][1], the automations service will cross that limit. This patch moves it into a separate file. Doing so also makes it a little easier to test. [0]: https://github.com/TryGhost/eslint-plugin-ghost/blob/22d154a8e3807e4e30219fb8449e7aa9b90a110b/lib/config/node.js#L32-L37 [1]: #28120
EvanHahn
added a commit
that referenced
this pull request
Jun 3, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 This change should have no impact on functionality. We have [a lint rule that limits the length of `index.js` files][0]. In [an upcoming change][1], the automations service will cross that limit. This patch moves it into a separate file. Doing so also makes it a little easier to test. [0]: https://github.com/TryGhost/eslint-plugin-ghost/blob/22d154a8e3807e4e30219fb8449e7aa9b90a110b/lib/config/node.js#L32-L37 [1]: #28120
EvanHahn
added a commit
that referenced
this pull request
Jun 3, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 This change should have no impact on functionality. We have [a lint rule that limits the length of `index.js` files][0]. In [an upcoming change][1], the automations service will cross that limit. This patch moves it into a separate file. Doing so also makes it a little easier to test. [0]: https://github.com/TryGhost/eslint-plugin-ghost/blob/22d154a8e3807e4e30219fb8449e7aa9b90a110b/lib/config/node.js#L32-L37 [1]: #28120 (cherry picked from commit 2eb8a65)
EvanHahn
added a commit
that referenced
this pull request
Jun 3, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 To run an automation, we will: 1. Fetch (and lock) up to 100 steps. 2. If no steps are found, enqueue another poll for later, and stop. 3. Run all the steps. 4. Possibly enqueue another poll for later. This patch implements the first of those procedures. (If you want to see more fully how it will be used, see [this PR][0].) [0]: #28120
EvanHahn
changed the title
EvanHahn
added a commit
that referenced
this pull request
Jun 4, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 This is a test-only change that just makes things a little easier to read. I think it's useful on its own, but it'll also be useful for [an upcoming change](#28120).
EvanHahn
added a commit
that referenced
this pull request
Jun 4, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 To run an automation, we will: 1. Fetch (and lock) up to 100 steps. 2. If no steps are found, enqueue another poll for later, and stop. 3. Run all the steps. 4. Possibly enqueue another poll for later. This patch implements the first of those procedures. (If you want to see more fully how it will be used, see [this PR][0].) [0]: #28120
EvanHahn
added a commit
that referenced
this pull request
Jun 4, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 *I recommend reviewing this with whitespace changes disabled.* **What:** We want to trigger automations after members are inserted. **Why:** If we don't do this, automations could run before the member exists in the database.
EvanHahn
added a commit
that referenced
this pull request
Jun 4, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 *I recommend reviewing this with whitespace changes disabled.* **What:** We want to trigger automations after members are inserted. **Why:** If we don't do this, automations could run before the member exists in the database.
EvanHahn
added a commit
that referenced
this pull request
Jun 5, 2026
towards https://linear.app/ghost/issue/NY-1286 ref #28120 *I recommend reviewing this with whitespace changes disabled.* **What:** We want to trigger automations after members are inserted. **Why:** If we don't do this, automations could run before the member exists in the database. (cherry picked from commit e04da95)
EvanHahn
force-pushed
the
ny-1286-north-star
branch
from
cbc2db3 to
8b0cf45
Compare
towards https://linear.app/ghost/issue/NY-1286 ref #28120 *I recommend reviewing this with whitespace changes disabled.* **What:** We want to trigger automations after members are inserted. **Why:** If we don't do this, automations could run before the member exists in the database. (cherry picked from commit e04da95)
These functions are neither called nor implemented! But their skeletons are now here, along with some documentation about what they'll do.
Now that we have two places doing this, let's use the same code.
EvanHahn
force-pushed
the
ny-1286-north-star
branch
from
8b0cf45 to
b7f0a05
Compare
EvanHahn
force-pushed
the
ny-1286-north-star
branch
from
b7f0a05 to
d46b3ac
Compare
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.
closes https://linear.app/ghost/issue/NY-1286
ref #28239
ref #28263
ref #28343
ref #28375
ref #28376
Blocked by #28376.
I recommend reviewing this commit-by-commit.
This change starts executing automations (only in development and test).