From f4f0b5110c2c87878b322db5d1cce848ef7baeb1 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Iv=C3=A1n=20Ovejero?= Date: Fri, 15 Nov 2024 10:28:21 +0100 Subject: [PATCH] refactor(core): Remove deprecated `TIME` constant (#11740) --- packages/cli/src/constants.ts | 21 ++++--------------- .../cli/src/scaling/multi-main-setup.ee.ts | 4 ++-- .../cli/src/services/cache/cache.service.ts | 4 ++-- .../workflows/workflow-history/constants.ts | 3 --- .../workflow-history-manager.ee.ts | 4 ++-- .../test/integration/pruning.service.test.ts | 4 ++-- 6 files changed, 12 insertions(+), 28 deletions(-) delete mode 100644 packages/cli/src/workflows/workflow-history/constants.ts diff --git a/packages/cli/src/constants.ts b/packages/cli/src/constants.ts index be26616fb6..df52a36b96 100644 --- a/packages/cli/src/constants.ts +++ b/packages/cli/src/constants.ts @@ -110,25 +110,12 @@ export const UM_FIX_INSTRUCTION = 'Please fix the database by running ./packages/cli/bin/n8n user-management:reset'; /** - * Units of time in milliseconds - * @deprecated Please use constants.Time instead. - */ -export const TIME = { - SECOND: 1000, - MINUTE: 60 * 1000, - HOUR: 60 * 60 * 1000, - DAY: 24 * 60 * 60 * 1000, -} as const; - -/** - * Convert time from any unit to any other unit - * - * Please amend conversions as necessary. - * Eventually this will superseed `TIME` above + * Convert time from any time unit to any other unit */ export const Time = { milliseconds: { toMinutes: 1 / (60 * 1000), + toSeconds: 1 / 1000, }, seconds: { toMilliseconds: 1000, @@ -150,9 +137,9 @@ export const MIN_PASSWORD_CHAR_LENGTH = 8; export const MAX_PASSWORD_CHAR_LENGTH = 64; -export const TEST_WEBHOOK_TIMEOUT = 2 * TIME.MINUTE; +export const TEST_WEBHOOK_TIMEOUT = 2 * Time.minutes.toMilliseconds; -export const TEST_WEBHOOK_TIMEOUT_BUFFER = 30 * TIME.SECOND; +export const TEST_WEBHOOK_TIMEOUT_BUFFER = 30 * Time.seconds.toMilliseconds; export const GENERIC_OAUTH2_CREDENTIALS_WITH_EDITABLE_SCOPE = [ 'oAuth2Api', diff --git a/packages/cli/src/scaling/multi-main-setup.ee.ts b/packages/cli/src/scaling/multi-main-setup.ee.ts index 8be7f4ae51..dab9f17cc6 100644 --- a/packages/cli/src/scaling/multi-main-setup.ee.ts +++ b/packages/cli/src/scaling/multi-main-setup.ee.ts @@ -3,7 +3,7 @@ import { InstanceSettings } from 'n8n-core'; import { Service } from 'typedi'; import config from '@/config'; -import { TIME } from '@/constants'; +import { Time } from '@/constants'; import { Logger } from '@/logging/logger.service'; import { Publisher } from '@/scaling/pubsub/publisher.service'; import { RedisClientService } from '@/services/redis-client.service'; @@ -54,7 +54,7 @@ export class MultiMainSetup extends TypedEmitter { this.leaderCheckInterval = setInterval(async () => { await this.checkLeader(); - }, this.globalConfig.multiMainSetup.interval * TIME.SECOND); + }, this.globalConfig.multiMainSetup.interval * Time.seconds.toMilliseconds); } async shutdown() { diff --git a/packages/cli/src/services/cache/cache.service.ts b/packages/cli/src/services/cache/cache.service.ts index aefe9310fc..f82bac3d02 100644 --- a/packages/cli/src/services/cache/cache.service.ts +++ b/packages/cli/src/services/cache/cache.service.ts @@ -4,7 +4,7 @@ import { ApplicationError, jsonStringify } from 'n8n-workflow'; import Container, { Service } from 'typedi'; import config from '@/config'; -import { TIME } from '@/constants'; +import { Time } from '@/constants'; import { MalformedRefreshValueError } from '@/errors/cache-errors/malformed-refresh-value.error'; import { UncacheableValueError } from '@/errors/cache-errors/uncacheable-value.error'; import type { @@ -160,7 +160,7 @@ export class CacheService extends TypedEmitter { }); } - await this.cache.store.expire(key, ttlMs / TIME.SECOND); + await this.cache.store.expire(key, ttlMs * Time.milliseconds.toSeconds); } // ---------------------------------- diff --git a/packages/cli/src/workflows/workflow-history/constants.ts b/packages/cli/src/workflows/workflow-history/constants.ts deleted file mode 100644 index dc4f7c7867..0000000000 --- a/packages/cli/src/workflows/workflow-history/constants.ts +++ /dev/null @@ -1,3 +0,0 @@ -import { TIME } from '@/constants'; - -export const WORKFLOW_HISTORY_PRUNE_INTERVAL = 1 * TIME.HOUR; diff --git a/packages/cli/src/workflows/workflow-history/workflow-history-manager.ee.ts b/packages/cli/src/workflows/workflow-history/workflow-history-manager.ee.ts index e710637441..f3a25bfb16 100644 --- a/packages/cli/src/workflows/workflow-history/workflow-history-manager.ee.ts +++ b/packages/cli/src/workflows/workflow-history/workflow-history-manager.ee.ts @@ -1,9 +1,9 @@ import { DateTime } from 'luxon'; import { Service } from 'typedi'; +import { Time } from '@/constants'; import { WorkflowHistoryRepository } from '@/databases/repositories/workflow-history.repository'; -import { WORKFLOW_HISTORY_PRUNE_INTERVAL } from './constants'; import { getWorkflowHistoryPruneTime, isWorkflowHistoryEnabled, @@ -20,7 +20,7 @@ export class WorkflowHistoryManager { clearInterval(this.pruneTimer); } - this.pruneTimer = setInterval(async () => await this.prune(), WORKFLOW_HISTORY_PRUNE_INTERVAL); + this.pruneTimer = setInterval(async () => await this.prune(), 1 * Time.hours.toMilliseconds); } shutdown() { diff --git a/packages/cli/test/integration/pruning.service.test.ts b/packages/cli/test/integration/pruning.service.test.ts index 4ea8455b94..b4300c77a5 100644 --- a/packages/cli/test/integration/pruning.service.test.ts +++ b/packages/cli/test/integration/pruning.service.test.ts @@ -4,7 +4,7 @@ import { BinaryDataService, InstanceSettings } from 'n8n-core'; import type { ExecutionStatus } from 'n8n-workflow'; import Container from 'typedi'; -import { TIME } from '@/constants'; +import { Time } from '@/constants'; import type { ExecutionEntity } from '@/databases/entities/execution-entity'; import type { WorkflowEntity } from '@/databases/entities/workflow-entity'; import { ExecutionRepository } from '@/databases/repositories/execution.repository'; @@ -25,7 +25,7 @@ describe('softDeleteOnPruningCycle()', () => { instanceSettings.markAsLeader(); const now = new Date(); - const yesterday = new Date(Date.now() - TIME.DAY); + const yesterday = new Date(Date.now() - 1 * Time.days.toMilliseconds); let workflow: WorkflowEntity; let pruningConfig: PruningConfig;