Merge pull request #503 from rubyowo/feat/yearsandmonths_next

feat: fix leap year rules, add year and month to the delay string
ZeppelinBot · Jan 4, 2025 · e196653 · e196653
2 parents 504ffd7 + 8110931
commit e196653
Show file tree

Hide file tree

Showing 50 changed files with 175 additions and 102 deletions.
diff --git a/backend/src/data/GuildCases.ts b/backend/src/data/GuildCases.ts
@@ -1,5 +1,4 @@
-import { In, InsertResult, Repository } from "typeorm";
-import { FindOptionsWhere } from "typeorm";
+import { FindOptionsWhere, In, InsertResult, Repository } from "typeorm";
 import { Queue } from "../Queue.js";
 import { chunkArray } from "../utils.js";
 import { BaseGuildRepository } from "./BaseGuildRepository.js";

diff --git a/backend/src/humanizeDuration.ts b/backend/src/humanizeDuration.ts
@@ -0,0 +1,34 @@
+import humanizeduration from "humanize-duration";
+
+export const delayStringMultipliers = {
+  y: 1000 * 60 * 60 * 24 * (365 + 1 / 4 - 1 / 100 + 1 / 400),
+  mo: (1000 * 60 * 60 * 24 * (365 + 1 / 4 - 1 / 100 + 1 / 400)) / 12,
+  w: 1000 * 60 * 60 * 24 * 7,
+  d: 1000 * 60 * 60 * 24,
+  h: 1000 * 60 * 60,
+  m: 1000 * 60,
+  s: 1000,
+  x: 1,
+};
+
+export const humanizeDurationShort = humanizeduration.humanizer({
+  language: "shortEn",
+  languages: {
+    shortEn: {
+      y: () => "y",
+      mo: () => "mo",
+      w: () => "w",
+      d: () => "d",
+      h: () => "h",
+      m: () => "m",
+      s: () => "s",
+      ms: () => "ms",
+    },
+  },
+  spacer: "",
+  unitMeasures: delayStringMultipliers,
+});
+
+export const humanizeDuration = humanizeduration.humanizer({
+  unitMeasures: delayStringMultipliers,
+});
diff --git a/backend/src/humanizeDurationShort.ts b/backend/src/humanizeDurationShort.ts
diff --git a/backend/src/index.ts b/backend/src/index.ts
@@ -44,7 +44,15 @@ import { availableGlobalPlugins, availableGuildPlugins } from "./plugins/availab
 import { setProfiler } from "./profiler.js";
 import { logRateLimit } from "./rateLimitStats.js";
 import { startUptimeCounter } from "./uptime.js";
-import { MINUTES, SECONDS, errorMessage, isDiscordAPIError, isDiscordHTTPError, sleep, successMessage } from "./utils.js";
+import {
+  MINUTES,
+  SECONDS,
+  errorMessage,
+  isDiscordAPIError,
+  isDiscordHTTPError,
+  sleep,
+  successMessage,
+} from "./utils.js";
 import { DecayingCounter } from "./utils/DecayingCounter.js";
 import { enableProfiling } from "./utils/easyProfiler.js";
 import { loadYamlSafely } from "./utils/loadYamlSafely.js";

diff --git a/backend/src/plugins/Automod/functions/applyCooldown.ts b/backend/src/plugins/Automod/functions/applyCooldown.ts
@@ -2,7 +2,12 @@ import { GuildPluginData } from "knub";
 import { convertDelayStringToMS } from "../../../utils.js";
 import { AutomodContext, AutomodPluginType, TRule } from "../types.js";
 
-export function applyCooldown(pluginData: GuildPluginData<AutomodPluginType>, rule: TRule, ruleName: string, context: AutomodContext) {
+export function applyCooldown(
+  pluginData: GuildPluginData<AutomodPluginType>,
+  rule: TRule,
+  ruleName: string,
+  context: AutomodContext,
+) {
   const cooldownKey = `${ruleName}-${context.user?.id}`;
 
   const cooldownTime = convertDelayStringToMS(rule.cooldown, "s");

diff --git a/backend/src/plugins/Automod/functions/checkCooldown.ts b/backend/src/plugins/Automod/functions/checkCooldown.ts
@@ -1,7 +1,12 @@
 import { GuildPluginData } from "knub";
 import { AutomodContext, AutomodPluginType, TRule } from "../types.js";
 
-export function checkCooldown(pluginData: GuildPluginData<AutomodPluginType>, rule: TRule, ruleName: string, context: AutomodContext) {
+export function checkCooldown(
+  pluginData: GuildPluginData<AutomodPluginType>,
+  rule: TRule,
+  ruleName: string,
+  context: AutomodContext,
+) {
   const cooldownKey = `${ruleName}-${context.user?.id}`;
 
   return pluginData.state.cooldownManager.isOnCooldown(cooldownKey);

diff --git a/backend/src/plugins/Automod/functions/createMessageSpamTrigger.ts b/backend/src/plugins/Automod/functions/createMessageSpamTrigger.ts
@@ -1,6 +1,6 @@
 import z from "zod";
 import { SavedMessage } from "../../../data/entities/SavedMessage.js";
-import { humanizeDurationShort } from "../../../humanizeDurationShort.js";
+import { humanizeDurationShort } from "../../../humanizeDuration.js";
 import { getBaseUrl } from "../../../pluginUtils.js";
 import { convertDelayStringToMS, sorter, zDelayString } from "../../../utils.js";
 import { RecentActionType } from "../constants.js";

diff --git a/backend/src/plugins/Automod/triggers/matchAttachmentType.ts b/backend/src/plugins/Automod/triggers/matchAttachmentType.ts
@@ -13,19 +13,20 @@ const baseConfig = z.strictObject({
   filetype_blacklist: z.array(z.string().max(32)).max(255).default([]),
   filetype_whitelist: z.array(z.string().max(32)).max(255).default([]),
 });
-const configWithWhitelist = baseConfig.merge(z.strictObject({
-  whitelist_enabled: z.literal(true),
-  blacklist_enabled: z.literal(false).default(false),
-}));
-const configWithBlacklist = baseConfig.merge(z.strictObject({
-  blacklist_enabled: z.literal(true),
-  whitelist_enabled: z.literal(false).default(false),
-}));
+const configWithWhitelist = baseConfig.merge(
+  z.strictObject({
+    whitelist_enabled: z.literal(true),
+    blacklist_enabled: z.literal(false).default(false),
+  }),
+);
+const configWithBlacklist = baseConfig.merge(
+  z.strictObject({
+    blacklist_enabled: z.literal(true),
+    whitelist_enabled: z.literal(false).default(false),
+  }),
+);
 
-const configSchema = z.union([
-  configWithWhitelist,
-  configWithBlacklist,
-]);
+const configSchema = z.union([configWithWhitelist, configWithBlacklist]);
 
 export const MatchAttachmentTypeTrigger = automodTrigger<MatchResultType>()({
   configSchema,

diff --git a/backend/src/plugins/Automod/triggers/matchMimeType.ts b/backend/src/plugins/Automod/triggers/matchMimeType.ts
@@ -12,19 +12,20 @@ const baseConfig = z.strictObject({
   mime_type_blacklist: z.array(z.string().max(32)).max(255).default([]),
   mime_type_whitelist: z.array(z.string().max(32)).max(255).default([]),
 });
-const configWithWhitelist = baseConfig.merge(z.strictObject({
-  whitelist_enabled: z.literal(true),
-  blacklist_enabled: z.literal(false).default(false),
-}));
-const configWithBlacklist = baseConfig.merge(z.strictObject({
-  blacklist_enabled: z.literal(true),
-  whitelist_enabled: z.literal(false).default(false),
-}));
+const configWithWhitelist = baseConfig.merge(
+  z.strictObject({
+    whitelist_enabled: z.literal(true),
+    blacklist_enabled: z.literal(false).default(false),
+  }),
+);
+const configWithBlacklist = baseConfig.merge(
+  z.strictObject({
+    blacklist_enabled: z.literal(true),
+    whitelist_enabled: z.literal(false).default(false),
+  }),
+);
 
-const configSchema = z.union([
-  configWithWhitelist,
-  configWithBlacklist,
-]);
+const configSchema = z.union([configWithWhitelist, configWithBlacklist]);
 
 export const MatchMimeTypeTrigger = automodTrigger<MatchResultType>()({
   configSchema,

diff --git a/backend/src/plugins/Censor/util/applyFiltersToMsg.ts b/backend/src/plugins/Censor/util/applyFiltersToMsg.ts
@@ -4,7 +4,13 @@ import { GuildPluginData } from "knub";
 import { allowTimeout } from "../../../RegExpRunner.js";
 import { ZalgoRegex } from "../../../data/Zalgo.js";
 import { ISavedMessageEmbedData, SavedMessage } from "../../../data/entities/SavedMessage.js";
-import { getInviteCodesInString, getUrlsInString, isGuildInvite, resolveInvite, resolveMember } from "../../../utils.js";
+import {
+  getInviteCodesInString,
+  getUrlsInString,
+  isGuildInvite,
+  resolveInvite,
+  resolveMember,
+} from "../../../utils.js";
 import { CensorPluginType } from "../types.js";
 import { censorMessage } from "./censorMessage.js";
 

diff --git a/backend/src/plugins/ContextMenus/actions/ban.ts b/backend/src/plugins/ContextMenus/actions/ban.ts
@@ -7,8 +7,8 @@ import {
   TextInputBuilder,
   TextInputStyle,
 } from "discord.js";
-import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { logger } from "../../../logger.js";
 import { canActOn } from "../../../pluginUtils.js";
 import { convertDelayStringToMS, renderUserUsername } from "../../../utils.js";

diff --git a/backend/src/plugins/ContextMenus/actions/mute.ts b/backend/src/plugins/ContextMenus/actions/mute.ts
@@ -7,9 +7,9 @@ import {
   TextInputBuilder,
   TextInputStyle,
 } from "discord.js";
-import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
 import { ERRORS, RecoverablePluginError } from "../../../RecoverablePluginError.js";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { logger } from "../../../logger.js";
 import { canActOn } from "../../../pluginUtils.js";
 import { convertDelayStringToMS } from "../../../utils.js";

diff --git a/backend/src/plugins/Counters/CountersPlugin.ts b/backend/src/plugins/Counters/CountersPlugin.ts
@@ -3,7 +3,7 @@ import { PluginOptions, guildPlugin } from "knub";
 import { GuildCounters } from "../../data/GuildCounters.js";
 import { CounterTrigger, parseCounterConditionString } from "../../data/entities/CounterTrigger.js";
 import { makePublicFn } from "../../pluginUtils.js";
-import { MINUTES, convertDelayStringToMS, values } from "../../utils.js";
+import { MINUTES, convertDelayStringToMS } from "../../utils.js";
 import { CommonPlugin } from "../Common/CommonPlugin.js";
 import { AddCounterCmd } from "./commands/AddCounterCmd.js";
 import { CountersListCmd } from "./commands/CountersListCmd.js";

diff --git a/backend/src/plugins/Counters/commands/AddCounterCmd.ts b/backend/src/plugins/Counters/commands/AddCounterCmd.ts
@@ -125,9 +125,13 @@ export const AddCounterCmd = guildPluginMessageCommand<CountersPluginType>()({
         `Added ${amount} to **${args.counterName}** for <@!${user.id}> in <#${channel.id}>. The value is now ${newValue}.`,
       );
     } else if (channel) {
-      message.channel.send(`Added ${amount} to **${args.counterName}** in <#${channel.id}>. The value is now ${newValue}.`);
+      message.channel.send(
+        `Added ${amount} to **${args.counterName}** in <#${channel.id}>. The value is now ${newValue}.`,
+      );
     } else if (user) {
-      message.channel.send(`Added ${amount} to **${args.counterName}** for <@!${user.id}>. The value is now ${newValue}.`);
+      message.channel.send(
+        `Added ${amount} to **${args.counterName}** for <@!${user.id}>. The value is now ${newValue}.`,
+      );
     } else {
       message.channel.send(`Added ${amount} to **${args.counterName}**. The value is now ${newValue}.`);
     }

diff --git a/backend/src/plugins/LocateUser/commands/FollowCmd.ts b/backend/src/plugins/LocateUser/commands/FollowCmd.ts
@@ -1,7 +1,7 @@
-import humanizeDuration from "humanize-duration";
 import moment from "moment-timezone";
 import { commandTypeHelpers as ct } from "../../../commandTypes.js";
 import { registerExpiringVCAlert } from "../../../data/loops/expiringVCAlertsLoop.js";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { MINUTES, SECONDS } from "../../../utils.js";
 import { locateUserCmd } from "../types.js";
 

diff --git a/backend/src/plugins/Logs/LogsPlugin.ts b/backend/src/plugins/Logs/LogsPlugin.ts
@@ -30,7 +30,7 @@ import {
 import { LogsThreadCreateEvt, LogsThreadDeleteEvt, LogsThreadUpdateEvt } from "./events/LogsThreadModifyEvts.js";
 import { LogsGuildMemberUpdateEvt } from "./events/LogsUserUpdateEvts.js";
 import { LogsVoiceStateUpdateEvt } from "./events/LogsVoiceChannelEvts.js";
-import { FORMAT_NO_TIMESTAMP, LogsPluginType, zLogsConfig } from "./types.js";
+import { LogsPluginType, zLogsConfig } from "./types.js";
 import { getLogMessage } from "./util/getLogMessage.js";
 import { log } from "./util/log.js";
 import { onMessageDelete } from "./util/onMessageDelete.js";

diff --git a/backend/src/plugins/Logs/logFunctions/logMemberJoin.ts b/backend/src/plugins/Logs/logFunctions/logMemberJoin.ts
@@ -1,8 +1,8 @@
 import { GuildMember } from "discord.js";
-import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
 import moment from "moment-timezone";
 import { LogType } from "../../../data/LogType.js";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { createTypedTemplateSafeValueContainer } from "../../../templateFormatter.js";
 import { memberToTemplateSafeMember } from "../../../utils/templateSafeObjects.js";
 import { LogsPluginType } from "../types.js";

diff --git a/backend/src/plugins/Logs/logFunctions/logMessageDelete.ts b/backend/src/plugins/Logs/logFunctions/logMessageDelete.ts
@@ -12,7 +12,7 @@ import {
   userToTemplateSafeUser,
 } from "../../../utils/templateSafeObjects.js";
 import { TimeAndDatePlugin } from "../../TimeAndDate/TimeAndDatePlugin.js";
-import { FORMAT_NO_TIMESTAMP, LogsPluginType } from "../types.js";
+import { LogsPluginType } from "../types.js";
 import { log } from "../util/log.js";
 
 export interface LogMessageDeleteData {

diff --git a/backend/src/plugins/Logs/types.ts b/backend/src/plugins/Logs/types.ts
@@ -6,7 +6,7 @@ import { GuildCases } from "../../data/GuildCases.js";
 import { GuildLogs } from "../../data/GuildLogs.js";
 import { GuildSavedMessages } from "../../data/GuildSavedMessages.js";
 import { LogType } from "../../data/LogType.js";
-import { keys, zBoundedCharacters, zMessageContent, zRegex, zSnowflake } from "../../utils.js";
+import { zBoundedCharacters, zMessageContent, zRegex, zSnowflake } from "../../utils.js";
 import { MessageBuffer } from "../../utils/MessageBuffer.js";
 import {
   TemplateSafeCase,

diff --git a/backend/src/plugins/Logs/util/getLogMessage.ts b/backend/src/plugins/Logs/util/getLogMessage.ts
@@ -25,7 +25,7 @@ import {
   TemplateSafeUser,
 } from "../../../utils/templateSafeObjects.js";
 import { TimeAndDatePlugin } from "../../TimeAndDate/TimeAndDatePlugin.js";
-import { FORMAT_NO_TIMESTAMP, ILogTypeData, LogsPluginType, TLogChannel } from "../types.js";
+import { ILogTypeData, LogsPluginType, TLogChannel } from "../types.js";
 
 export async function getLogMessage<TLogType extends keyof ILogTypeData>(
   pluginData: GuildPluginData<LogsPluginType>,

diff --git a/backend/src/plugins/MessageSaver/MessageSaverPlugin.ts b/backend/src/plugins/MessageSaver/MessageSaverPlugin.ts
@@ -3,7 +3,12 @@ import { GuildSavedMessages } from "../../data/GuildSavedMessages.js";
 import { CommonPlugin } from "../Common/CommonPlugin.js";
 import { SaveMessagesToDBCmd } from "./commands/SaveMessagesToDB.js";
 import { SavePinsToDBCmd } from "./commands/SavePinsToDB.js";
-import { MessageCreateEvt, MessageDeleteBulkEvt, MessageDeleteEvt, MessageUpdateEvt } from "./events/SaveMessagesEvts.js";
+import {
+  MessageCreateEvt,
+  MessageDeleteBulkEvt,
+  MessageDeleteEvt,
+  MessageUpdateEvt,
+} from "./events/SaveMessagesEvts.js";
 import { MessageSaverPluginType, zMessageSaverConfig } from "./types.js";
 
 const defaultOptions: PluginOptions<MessageSaverPluginType> = {

diff --git a/backend/src/plugins/ModActions/commands/ban/actualBanCmd.ts b/backend/src/plugins/ModActions/commands/ban/actualBanCmd.ts
@@ -1,9 +1,9 @@
 import { Attachment, ChatInputCommandInteraction, GuildMember, Message, User } from "discord.js";
-import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
 import { getMemberLevel } from "knub/helpers";
 import { CaseTypes } from "../../../../data/CaseTypes.js";
 import { clearExpiringTempban, registerExpiringTempban } from "../../../../data/loops/expiringTempbansLoop.js";
+import { humanizeDuration } from "../../../../humanizeDuration.js";
 import { canActOn, getContextChannel } from "../../../../pluginUtils.js";
 import { UnknownUser, UserNotificationMethod, renderUsername, resolveMember } from "../../../../utils.js";
 import { banLock } from "../../../../utils/lockNameHelpers.js";

diff --git a/backend/src/plugins/ModActions/commands/cases/actualCasesCmd.ts b/backend/src/plugins/ModActions/commands/cases/actualCasesCmd.ts
@@ -1,7 +1,6 @@
 import { APIEmbed, ChatInputCommandInteraction, GuildMember, Message, User } from "discord.js";
 import { GuildPluginData } from "knub";
-import { In } from "typeorm";
-import { FindOptionsWhere } from "typeorm";
+import { FindOptionsWhere, In } from "typeorm";
 import { CaseTypes } from "../../../../data/CaseTypes.js";
 import { Case } from "../../../../data/entities/Case.js";
 import { sendContextResponse } from "../../../../pluginUtils.js";

diff --git a/backend/src/plugins/ModActions/commands/kick/actualKickCmd.ts b/backend/src/plugins/ModActions/commands/kick/actualKickCmd.ts
@@ -2,7 +2,14 @@ import { Attachment, ChatInputCommandInteraction, GuildMember, Message, User } f
 import { GuildPluginData } from "knub";
 import { LogType } from "../../../../data/LogType.js";
 import { canActOn } from "../../../../pluginUtils.js";
-import { DAYS, SECONDS, UnknownUser, UserNotificationMethod, renderUsername, resolveMember } from "../../../../utils.js";
+import {
+  DAYS,
+  SECONDS,
+  UnknownUser,
+  UserNotificationMethod,
+  renderUsername,
+  resolveMember,
+} from "../../../../utils.js";
 import { handleAttachmentLinkDetectionAndGetRestriction } from "../../functions/attachmentLinkReaction.js";
 import {
   formatReasonWithAttachments,

diff --git a/backend/src/plugins/ModActions/commands/massban/actualMassBanCmd.ts b/backend/src/plugins/ModActions/commands/massban/actualMassBanCmd.ts
@@ -2,7 +2,7 @@ import { Attachment, ChatInputCommandInteraction, GuildMember, Message, Snowflak
 import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../../data/CaseTypes.js";
 import { LogType } from "../../../../data/LogType.js";
-import { humanizeDurationShort } from "../../../../humanizeDurationShort.js";
+import { humanizeDurationShort } from "../../../../humanizeDuration.js";
 import { canActOn, getContextChannel, isContextInteraction, sendContextResponse } from "../../../../pluginUtils.js";
 import { DAYS, MINUTES, SECONDS, noop } from "../../../../utils.js";
 import { CasesPlugin } from "../../../Cases/CasesPlugin.js";

diff --git a/backend/src/plugins/ModActions/commands/mute/actualMuteCmd.ts b/backend/src/plugins/ModActions/commands/mute/actualMuteCmd.ts
@@ -1,7 +1,7 @@
 import { Attachment, ChatInputCommandInteraction, GuildMember, Message, User } from "discord.js";
-import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
 import { ERRORS, RecoverablePluginError } from "../../../../RecoverablePluginError.js";
+import { humanizeDuration } from "../../../../humanizeDuration.js";
 import { logger } from "../../../../logger.js";
 import {
   UnknownUser,

diff --git a/backend/src/plugins/ModActions/commands/unmute/actualUnmuteCmd.ts b/backend/src/plugins/ModActions/commands/unmute/actualUnmuteCmd.ts
@@ -1,6 +1,6 @@
 import { Attachment, ChatInputCommandInteraction, GuildMember, Message, User } from "discord.js";
-import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
+import { humanizeDuration } from "../../../../humanizeDuration.js";
 import { UnknownUser, asSingleLine, renderUsername } from "../../../../utils.js";
 import { MutesPlugin } from "../../../Mutes/MutesPlugin.js";
 import { handleAttachmentLinkDetectionAndGetRestriction } from "../../functions/attachmentLinkReaction.js";

diff --git a/backend/src/plugins/ModActions/functions/banUserId.ts b/backend/src/plugins/ModActions/functions/banUserId.ts
@@ -1,9 +1,9 @@
 import { DiscordAPIError, Snowflake } from "discord.js";
-import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
 import { CaseTypes } from "../../../data/CaseTypes.js";
 import { LogType } from "../../../data/LogType.js";
 import { registerExpiringTempban } from "../../../data/loops/expiringTempbansLoop.js";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { logger } from "../../../logger.js";
 import { TemplateParseError, TemplateSafeValueContainer, renderTemplate } from "../../../templateFormatter.js";
 import {

diff --git a/backend/src/plugins/ModActions/functions/clearTempban.ts b/backend/src/plugins/ModActions/functions/clearTempban.ts
@@ -1,10 +1,10 @@
 import { Snowflake } from "discord.js";
-import humanizeDuration from "humanize-duration";
 import { GuildPluginData } from "knub";
 import moment from "moment-timezone";
 import { CaseTypes } from "../../../data/CaseTypes.js";
 import { LogType } from "../../../data/LogType.js";
 import { Tempban } from "../../../data/entities/Tempban.js";
+import { humanizeDuration } from "../../../humanizeDuration.js";
 import { logger } from "../../../logger.js";
 import { resolveUser } from "../../../utils.js";
 import { CasesPlugin } from "../../Cases/CasesPlugin.js";