Skip to content

🐛 Improved reliability of email analytics events #29895

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.

Sign up for GitHub

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

Open
EvanHahn wants to merge 1 commit into from
+12 −0
Open

🐛 Improved reliability of email analytics events #29895

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions ghost/core/core/server/services/email-analytics/lib/queries.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,7 @@ export class Queries {
id: new ObjectID().toHexString(),
name: jobName,
[updateField]: date.toISOString(), // force to iso string for sqlite
created_at: date.toISOString(), // force to iso string for sqlite

@cmraible cmraible Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thought: this is so subtle, I wonder if we could catch a missing required field like this at compile time somehow 🤔

@cmraible cmraible Aug 12, 2026

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't see this as blocking, but I think we could. Knex supports declaration merging via knex/types/tables and CompositeTableType, which lets us define separate row, insert, and update types. We could make created_at required for inserts but optional for updates, causing the original code here to fail type-checking. Ghost already uses this pattern for gift links and member custom fields.

Quick example pasted from Codex:

import type {Knex} from 'knex';

  interface JobRow {
      id: string;
      name: string;
      status: 'started' | 'finished' | 'failed' | 'queued';
      started_at: Date | string | null;
      finished_at: Date | string | null;
      created_at: Date | string;
      updated_at: Date | string | null;
      metadata: string | null;
      queue_entry: number | null;
  }

  type JobInsert =
      Pick<JobRow, 'id' | 'name' | 'created_at'>
      & Partial<Omit<JobRow, 'id' | 'name' | 'created_at'>>;

  declare module 'knex/types/tables' {
      interface Tables {
          jobs: Knex.CompositeTableType<
              JobRow,             // what SELECT returns
              JobInsert,          // what INSERT accepts
              Partial<JobRow>     // what UPDATE accepts
          >;
      }
  }

updated_at: date.toISOString(), // force to iso string for sqlite
status: status
});
Expand Down
11 changes: 11 additions & 0 deletions ghost/core/test/unit/server/services/email-analytics/queries.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,6 +269,17 @@ describe('Email analytics queries', function () {
assert.equal(job.status, 'finished');
});

it('creates missing job with created timestamp', async function () {
const date = new Date('2026-08-11T10:00:00.000Z');

await queries.setJobTimestamp('email-analytics-missing', 'started', date);

const job = await knex('jobs').where('name', 'email-analytics-missing').first();
assert.equal(new Date(job.created_at).toISOString(), date.toISOString());
assert.equal(new Date(job.started_at).toISOString(), date.toISOString());
assert.equal(new Date(job.updated_at).toISOString(), date.toISOString());
});

it('swallows database errors', async function () {
await knex.schema.dropTable('jobs');

Expand Down
Loading