fix(core): Use consistent timezone-aware timestamps in postgres (#6948)

Fixes:
* ENG-51 / N8N-2490
* PAY-397
* #2178
* #2810
* #3855

Supersedes #2813

[DB
Tests](https://github.com/n8n-io/n8n/actions/runs/6000780146/job/16273596338)
This commit is contained in:
कारतोफ्फेलस्क्रिप्ट™ 2023-09-27 18:44:47 +02:00 committed by GitHub
parent ebce6fe1b0
commit 0132514f8b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 50 additions and 10 deletions

View file

@ -1,3 +1,4 @@
import type { ColumnOptions } from 'typeorm';
import {
BeforeInsert,
BeforeUpdate,
@ -5,7 +6,6 @@ import {
PrimaryColumn,
UpdateDateColumn,
} from 'typeorm';
import { IsDate, IsOptional } from 'class-validator';
import config from '@/config';
import { generateNanoId } from '../utils/generators';
@ -21,9 +21,10 @@ const timestampSyntax = {
export const jsonColumnType = dbType === 'sqlite' ? 'simple-json' : 'json';
export const datetimeColumnType = dbType === 'postgresdb' ? 'timestamptz' : 'datetime';
const tsColumnOptions = {
const tsColumnOptions: ColumnOptions = {
precision: 3,
default: () => timestampSyntax,
type: datetimeColumnType,
};
type Constructor<T> = new (...args: any[]) => T;
@ -46,16 +47,9 @@ function mixinStringId<T extends Constructor<{}>>(base: T) {
function mixinTimestamps<T extends Constructor<{}>>(base: T) {
class Derived extends base {
@CreateDateColumn(tsColumnOptions)
@IsOptional() // ignored by validation because set at DB level
@IsDate()
createdAt: Date;
@UpdateDateColumn({
...tsColumnOptions,
onUpdate: timestampSyntax,
})
@IsOptional() // ignored by validation because set at DB level
@IsDate()
@UpdateDateColumn(tsColumnOptions)
updatedAt: Date;
@BeforeUpdate()

View file

@ -0,0 +1,44 @@
import type { IrreversibleMigration, MigrationContext } from '@/databases/types';
const defaultTimestampColumns = ['createdAt', 'updatedAt'];
const tablesWithDefaultTimestamps = [
'auth_identity',
'credentials_entity',
'event_destinations',
'installed_packages',
'role',
'shared_credentials',
'shared_workflow',
'tag_entity',
'user',
'workflow_entity',
];
const additionalColumns = {
auth_provider_sync_history: ['endedAt', 'startedAt'],
execution_entity: ['startedAt', 'stoppedAt', 'waitTill'],
workflow_statistics: ['latestEvent'],
};
export class MigrateToTimestampTz1694091729095 implements IrreversibleMigration {
async up({ queryRunner, tablePrefix }: MigrationContext) {
const changeColumnType = async (tableName: string, columnName: string, setDefault: boolean) => {
const alterColumnQuery = `ALTER TABLE "${tablePrefix}${tableName}" ALTER COLUMN "${columnName}"`;
await queryRunner.query(`${alterColumnQuery} TYPE TIMESTAMP(3) WITH TIME ZONE`);
if (setDefault)
await queryRunner.query(`${alterColumnQuery} SET DEFAULT CURRENT_TIMESTAMP(3)`);
};
for (const tableName of tablesWithDefaultTimestamps) {
for (const columnName of defaultTimestampColumns) {
await changeColumnType(tableName, columnName, true);
}
}
for (const [tableName, columnNames] of Object.entries(additionalColumns)) {
for (const columnName of columnNames) {
await changeColumnType(tableName, columnName, false);
}
}
}
}

View file

@ -47,6 +47,7 @@ import { CreateWorkflowHistoryTable1692967111175 } from '../common/1692967111175
import { DisallowOrphanExecutions1693554410387 } from '../common/1693554410387-DisallowOrphanExecutions';
import { ExecutionSoftDelete1693491613982 } from '../common/1693491613982-ExecutionSoftDelete';
import { AddWorkflowMetadata1695128658538 } from '../common/1695128658538-AddWorkflowMetadata';
import { MigrateToTimestampTz1694091729095 } from './1694091729095-MigrateToTimestampTz';
export const postgresMigrations: Migration[] = [
InitialMigration1587669153312,
@ -97,4 +98,5 @@ export const postgresMigrations: Migration[] = [
DisallowOrphanExecutions1693554410387,
ExecutionSoftDelete1693491613982,
AddWorkflowMetadata1695128658538,
MigrateToTimestampTz1694091729095,
];