From a0e183075fef8016fe0fe58baab89befe17312d9 Mon Sep 17 00:00:00 2001 From: Pavel Gnedov Date: Sat, 24 Jun 2023 17:55:20 +0700 Subject: [PATCH 1/4] =?UTF-8?q?=D0=A0=D0=B0=D0=B7=D1=80=D0=B0=D0=B1=D0=BE?= =?UTF-8?q?=D1=82=D0=BA=D0=B0=20=D0=BF=D0=B0=D1=80=D1=81=D0=B5=D1=80=D0=B0?= =?UTF-8?q?=20=D1=81=D0=BE=D0=B1=D1=8B=D1=82=D0=B8=D0=B9=20=D0=B4=D0=BB?= =?UTF-8?q?=D1=8F=20=D0=BA=D0=B0=D0=BB=D0=B5=D0=BD=D0=B4=D0=B0=D1=80=D1=8F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- configs/interview-projects.jsonc | 6 +++ configs/interview-projects.jsonc.dist | 4 ++ src/issue-enhancers/interview-enhancer.ts | 59 +++++++++++++++++++++++ 3 files changed, 69 insertions(+) create mode 100644 configs/interview-projects.jsonc create mode 100644 configs/interview-projects.jsonc.dist create mode 100644 src/issue-enhancers/interview-enhancer.ts diff --git a/configs/interview-projects.jsonc b/configs/interview-projects.jsonc new file mode 100644 index 0000000..2b2925b --- /dev/null +++ b/configs/interview-projects.jsonc @@ -0,0 +1,6 @@ +{ + "interviewProjects": [ + "Программисты, инженеры HW" + ], + "customFieldDateFormat": "yyyy-MM-dd HH:mm" +} \ No newline at end of file diff --git a/configs/interview-projects.jsonc.dist b/configs/interview-projects.jsonc.dist new file mode 100644 index 0000000..9f49eb9 --- /dev/null +++ b/configs/interview-projects.jsonc.dist @@ -0,0 +1,4 @@ +{ + "interviewProjects": [], + "customFieldDateFormat": "yyyy-MM-dd HH:mm" +} \ No newline at end of file diff --git a/src/issue-enhancers/interview-enhancer.ts b/src/issue-enhancers/interview-enhancer.ts new file mode 100644 index 0000000..06e11c1 --- /dev/null +++ b/src/issue-enhancers/interview-enhancer.ts @@ -0,0 +1,59 @@ +import { IssueEnhancerInterface } from '@app/event-emitter/issue-enhancers/issue-enhancer-interface'; +import { RedmineTypes } from '@app/event-emitter/models/redmine-types'; +import { Injectable } from '@nestjs/common'; +import * as Luxon from 'luxon'; + +export type SubjectParserParam = { + regexp: string; + format: string; + type: string; +}; + +export type DescriptionParserParam = {}; + +@Injectable() +export class InterviewEnhancer implements IssueEnhancerInterface { + name = 'interview'; + + constructor( + public interviewProjects: string[] = [], + public customFieldDateFormat: string = 'yyyy-MM-dd HH:mm', + public subjectParserParams: SubjectParserParam[] + ) {} + + async enhance( + issue: RedmineTypes.Issue, + ): Promise> { + const res: RedmineTypes.ExtendedIssue = { ...issue }; + + if (this.interviewProjects.indexOf(res.project.name) < 0) { + return res; + } + + const subject = res.subject; + const nextEventDateField = res.custom_fields.find((cf) => { + return cf.name === 'Дата следующего обновления'; + }); + + if () + + const nextEventDate = Luxon.DateTime.fromFormat(nextEventDateField.value, this.customFieldDateFormat); + + return res; + } + + private getNextEventDate(issue: RedmineTypes.ExtendedIssue): Luxon.DateTime|null { + const nextEventDateField = issue.custom_fields.find((cf) => { + return cf.name === 'Дата следующего обновления'; + }); + if (!nextEventDateField) return null; + const nextEventDate = Luxon.DateTime.fromFormat(nextEventDateField.value, this.customFieldDateFormat); + if (!nextEventDate.isValid) return null; + return nextEventDate; + } + + private getDateFromSubject(issue: RedmineTypes.ExtendedIssue): Luxon.DateTime|null { + const subject = issue.subject; + return null; + } +} From 61371282b1a0e99a477bcc303d0afcaef8c52cf6 Mon Sep 17 00:00:00 2001 From: Pavel Gnedov Date: Wed, 23 Aug 2023 02:02:52 +0700 Subject: [PATCH 2/4] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=20=D0=BF=D0=B0=D1=80=D1=81=D0=B5=D1=80=20=D0=BA=D0=B0?= =?UTF-8?q?=D0=BB=D0=B5=D0=BD=D0=B4=D0=B0=D1=80=D0=BD=D1=8B=D1=85=20=D1=81?= =?UTF-8?q?=D0=BE=D0=B1=D1=8B=D1=82=D0=B8=D0=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .gitignore | 1 + configs/calendar-enhancer.jsonc.dist | 17 ++ configs/interview-projects.jsonc | 6 - configs/interview-projects.jsonc.dist | 4 - .../event-emitter/src/event-emitter.module.ts | 19 ++ .../src/issue-enhancers/calendar-enhancer.ts | 164 ++++++++++++++++++ .../src/models/calendar-event.ts | 8 + .../src/utils/string-with-dates-parser.ts | 138 +++++++++++++++ package-lock.json | 24 +++ package.json | 2 + src/app.module.ts | 5 + src/configs/app.ts | 3 + src/configs/calendar-enhancer.config.ts | 23 +++ src/issue-enhancers/interview-enhancer.ts | 59 ------- src/models/app-config.model.ts | 2 +- 15 files changed, 405 insertions(+), 70 deletions(-) create mode 100644 configs/calendar-enhancer.jsonc.dist delete mode 100644 configs/interview-projects.jsonc delete mode 100644 configs/interview-projects.jsonc.dist create mode 100644 libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts create mode 100644 libs/event-emitter/src/models/calendar-event.ts create mode 100644 libs/event-emitter/src/utils/string-with-dates-parser.ts create mode 100644 src/configs/calendar-enhancer.config.ts delete mode 100644 src/issue-enhancers/interview-enhancer.ts diff --git a/.gitignore b/.gitignore index 43607ab..d0f42bc 100644 --- a/.gitignore +++ b/.gitignore @@ -43,3 +43,4 @@ configs/eccm-config.jsonc configs/current-user-rules.jsonc configs/simple-kanban-board-config.jsonc configs/kanban-boards/ +configs/calendar-enhancer.jsonc diff --git a/configs/calendar-enhancer.jsonc.dist b/configs/calendar-enhancer.jsonc.dist new file mode 100644 index 0000000..72f9c8c --- /dev/null +++ b/configs/calendar-enhancer.jsonc.dist @@ -0,0 +1,17 @@ +{ + "useForProjects": [ + "*" // '*' - все, или перечислить отдельные проекты + ], + "customFields": [ + { + "dateFormat": "yyyy-MM-dd HH:mm", + "customFieldName": "Custom field name", + "alias": "" + } + ], + "descriptionCalendarParams": { + "title": "Calendar:", + "lineRegexp": "(?<=\\*\\ ).+" + }, + "calendarEventsKey": "calendar" +} diff --git a/configs/interview-projects.jsonc b/configs/interview-projects.jsonc deleted file mode 100644 index 2b2925b..0000000 --- a/configs/interview-projects.jsonc +++ /dev/null @@ -1,6 +0,0 @@ -{ - "interviewProjects": [ - "Программисты, инженеры HW" - ], - "customFieldDateFormat": "yyyy-MM-dd HH:mm" -} \ No newline at end of file diff --git a/configs/interview-projects.jsonc.dist b/configs/interview-projects.jsonc.dist deleted file mode 100644 index 9f49eb9..0000000 --- a/configs/interview-projects.jsonc.dist +++ /dev/null @@ -1,4 +0,0 @@ -{ - "interviewProjects": [], - "customFieldDateFormat": "yyyy-MM-dd HH:mm" -} \ No newline at end of file diff --git a/libs/event-emitter/src/event-emitter.module.ts b/libs/event-emitter/src/event-emitter.module.ts index 679e6a3..d24ab6a 100644 --- a/libs/event-emitter/src/event-emitter.module.ts +++ b/libs/event-emitter/src/event-emitter.module.ts @@ -28,6 +28,7 @@ import { ListIssuesByUsersLikeJiraWidgetService } from './project-dashboard/widg import { TimePassedHighlightEnhancer } from './issue-enhancers/time-passed-highlight-enhancer'; import { ListIssuesByFieldsWidgetService } from './project-dashboard/widgets/list-issues-by-fields.widget.service'; import { IssuesUpdaterService } from './issues-updater/issues-updater.service'; +import { CalendarEnhancer } from './issue-enhancers/calendar-enhancer'; @Module({}) export class EventEmitterModule implements OnModuleInit { @@ -68,6 +69,20 @@ export class EventEmitterModule implements OnModuleInit { }, inject: [ConfigService], }, + { + provide: 'CALENDAR_ENHANCER', + useFactory: (configService: ConfigService) => { + const calendarEnhancerConfig = + configService.get>('calendarEnhancer'); + return new CalendarEnhancer( + calendarEnhancerConfig.useForProjects, + calendarEnhancerConfig.customFields, + calendarEnhancerConfig.descriptionCalendarParams, + calendarEnhancerConfig.calendarEventsKey, + ); + }, + inject: [ConfigService], + }, ], exports: [ EventEmitterService, @@ -95,6 +110,10 @@ export class EventEmitterModule implements OnModuleInit { provide: 'ISSUES_UPDATER_SERVICE', useExisting: 'ISSUES_UPDATER_SERVICE', }, + { + provide: 'CALENDAR_ENHANCER', + useExisting: 'CALENDAR_ENHANCER', + }, ], controllers: [MainController, UsersController, IssuesController], }; diff --git a/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts b/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts new file mode 100644 index 0000000..5bc8c55 --- /dev/null +++ b/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts @@ -0,0 +1,164 @@ +import { IssueEnhancerInterface } from '@app/event-emitter/issue-enhancers/issue-enhancer-interface'; +import { RedmineTypes } from '@app/event-emitter/models/redmine-types'; +import { Injectable } from '@nestjs/common'; +import * as Luxon from 'luxon'; +import { CalendarEvent } from '../models/calendar-event'; +import * as DatesParser from '../utils/string-with-dates-parser'; + +export type DescriptionParserParams = { + title: string; + lineRegexp: string; +}; + +export type CustomFieldParserParams = { + dateFormat: string; + customFieldName: string; + /** Время в минутах */ + interval?: number; + fullDay?: boolean; + alias?: string; +}; + +export const UNKNOWN_CALENDAR_EVENT = 'Unknown calendar event'; + +@Injectable() +export class CalendarEnhancer implements IssueEnhancerInterface { + name = 'calendar'; + + constructor( + public useForProjects: string[], + public customFields: CustomFieldParserParams[], + public descriptionCalendarParams: DescriptionParserParams, + public calendarEventsKey: string, + ) {} + + async enhance( + issue: RedmineTypes.ExtendedIssue, + ): Promise { + const res: RedmineTypes.ExtendedIssue = { ...issue }; + + if (!this.checkProject(issue)) return res; + + issue[this.calendarEventsKey] = this.getCalendarEvents(issue); + + return res; + } + + private checkProject(issue: RedmineTypes.ExtendedIssue): boolean { + if (this.useForProjects.indexOf('*') >= 0) { + return true; + } + if ( + this.useForProjects.length > 0 && + this.useForProjects.indexOf(issue.project.name) >= 0 + ) { + return true; + } + return false; + } + + private getCalendarEvents( + issue: RedmineTypes.ExtendedIssue, + ): CalendarEvent[] { + return [ + ...this.getCalendarEventsFromCustomFields(issue), + ...this.getCalendarEventsFromSubject(issue), + ...this.getCalendarEventsFromDescription(issue), + ]; + } + + private getCalendarEventsFromCustomFields( + issue: RedmineTypes.ExtendedIssue, + ): CalendarEvent[] { + const res: CalendarEvent[] = []; + for (let i = 0; i < this.customFields.length; i++) { + const cfParam = this.customFields[i]; + const event = this.getCalendarEventFromCustomField(issue, cfParam); + if (event) res.push(event); + } + return res; + } + + private getCalendarEventFromCustomField( + issue: RedmineTypes.ExtendedIssue, + params: CustomFieldParserParams, + ): CalendarEvent | null { + if (typeof params.interval !== 'number' && params.fullDay !== true) + return null; + + const cf = issue.custom_fields.find((issueCf) => { + return issueCf.name === params.customFieldName; + }); + if (!cf) return null; + + const from = Luxon.DateTime.fromFormat(cf.value, params.dateFormat); + if (!from.isValid) return null; + + let to: Luxon.DateTime; + if (typeof params.interval === 'number') { + const interval = Luxon.Duration.fromObject({ minutes: params.interval }); + to = from.plus(interval); + } else if (params.fullDay) { + from.set({ hour: 0, minute: 0, second: 0, millisecond: 0 }); + to = from.plus(Luxon.Duration.fromObject({ day: 1 })); + } else { + return null; + } + if (!to.isValid) return null; + + return { + from: from.toISO(), + fromTimestamp: from.toSeconds(), + to: to.toISO(), + toTimestamp: to.toSeconds(), + fullDay: Boolean(params.fullDay), + description: params.alias || cf.name || UNKNOWN_CALENDAR_EVENT, + }; + } + + private getCalendarEventsFromSubject( + issue: RedmineTypes.ExtendedIssue, + ): CalendarEvent[] { + const matches = issue.subject.matchAll(/(?<=\()[^()]*(?=\))/g); + const items = [...matches].map((i) => i[0]).filter((i) => !!i); + + return items + .map((item) => DatesParser.parseToCalendarEvent(item)) + .filter((i) => !!i); + } + + private getCalendarEventsFromDescription( + issue: RedmineTypes.ExtendedIssue, + ): CalendarEvent[] { + const text = issue.description; + + const lines = text.split('\n').map((line) => line.trim()); + + const calendarStartIndex = lines.indexOf('Календарь:'); + if (calendarStartIndex < 0) return []; + + let index = calendarStartIndex + 1; + let line = this.extractFromList(lines[index]); + if (!line) { + index++; + line = this.extractFromList(lines[index]); + } + if (!line) return []; + + const res: string[] = []; + + do { + res.push(line); + index++; + line = this.extractFromList(lines[index]); + } while (line); + + return res.map((line) => DatesParser.parseToCalendarEvent(line)); + } + + private extractFromList(line: string): string | null { + const regexp = new RegExp(this.descriptionCalendarParams.lineRegexp); + const match = line.match(regexp); + return match && match[0] ? match[0] : null; + } +} diff --git a/libs/event-emitter/src/models/calendar-event.ts b/libs/event-emitter/src/models/calendar-event.ts new file mode 100644 index 0000000..3b5e180 --- /dev/null +++ b/libs/event-emitter/src/models/calendar-event.ts @@ -0,0 +1,8 @@ +export type CalendarEvent = { + from: string; + fromTimestamp: number; + to: string; + toTimestamp: number; + fullDay: boolean; + description: string; +}; diff --git a/libs/event-emitter/src/utils/string-with-dates-parser.ts b/libs/event-emitter/src/utils/string-with-dates-parser.ts new file mode 100644 index 0000000..cbfe4c8 --- /dev/null +++ b/libs/event-emitter/src/utils/string-with-dates-parser.ts @@ -0,0 +1,138 @@ +import Moo from 'moo'; +import { CalendarEvent } from '../models/calendar-event'; +import Luxon from 'luxon'; + +export const DEFAULT_PARAMS: Moo.Rules = { + WS: /[ \t]+/, + delimiter: /(?: - |: )/, + delimiter2: /(?:^\* |^- |(?!\d)T(?!>\d))/, + date: /(?:(?:\d{2}\.\d{2}\.(?:\d{2}|\d{4}))|(?:\d{4}-\d{2}-\d{2}))/, + time: /(?:\d{2}\b:\d{2}:\d{2}|\d{2}:\d{2})/, + word: /[\wА-Яа-я]+/, + other: { match: /./, lineBreaks: true }, + NL: { match: /\n/, lineBreaks: true }, +}; + +export const DEFAULT_DATE_FORMATS = ['dd.MM.yy', 'dd.MM.yyyy', 'yyyy-MM-dd']; + +export const DEFAULT_TIME_FORMATS = ['HH:mm', 'HH:mm:ss']; + +export const DEFAULT_EVENT_DURATION = 60 * 60 * 1000; // 1 hour in millis + +export function parse(str: string, params?: Moo.Rules): Moo.Token[] { + if (!params) params = DEFAULT_PARAMS; + try { + const lexer = Moo.compile(params); + lexer.reset(str); + const res: Moo.Token[] = []; + let token = lexer.next(); + while (token) { + res.push(token); + token = lexer.next(); + } + return res; + } catch (ex) { + return []; + } +} + +export type ParserOpts = { + rules?: Moo.Rules; + dateFormats?: string[]; + timeFormats?: string[]; +}; + +export function parseDate( + str: string, + formats?: string[], +): Luxon.DateTime | null { + if (!formats) formats = DEFAULT_DATE_FORMATS; + let res: Luxon.DateTime; + for (let i = 0; i < formats.length; i++) { + const format = formats[i]; + res = Luxon.DateTime.fromFormat(str, format); + if (res.isValid) return res; + } + return null; +} + +export function parseTime( + str: string, + formats?: string[], +): Luxon.Duration | null { + if (!formats) formats = DEFAULT_TIME_FORMATS; + let res: Luxon.DateTime; + for (let i = 0; i < formats.length; i++) { + const format = formats[i]; + res = Luxon.DateTime.fromFormat(str, format); + if (res.isValid) { + const startOfDay = res.set({ + hour: 0, + minute: 0, + second: 0, + millisecond: 0, + }); + return res.diff(startOfDay).shiftToAll(); + } + } + return null; +} + +export function parseToCalendarEvent( + str: string, + opts?: ParserOpts, +): CalendarEvent | null { + const tokens = parse(str, opts?.rules); + + const words = tokens.filter((i) => i.type === 'word'); + + const dates = tokens.filter((i) => i.type === 'date'); + if (dates.length < 0) return null; + const date1 = parseDate(dates[0]?.value, opts?.dateFormats); + const date2 = parseDate(dates[1]?.value, opts?.dateFormats); + + const times = tokens.filter((i) => i.type === 'time'); + const time1 = parseTime(times[0]?.value, opts?.timeFormats); + const time2 = parseTime(times[1]?.value, opts?.timeFormats); + + let from: Luxon.DateTime; + let to: Luxon.DateTime; + let fullDay: boolean; + + if (date1 && time1) { + from = date1.set({ + hour: time1.hours, + minute: time1.minutes, + second: time1.seconds, + }); + fullDay = false; + } else if (date1) { + from = date1; + fullDay = true; + } else { + return null; + } + + if (date2 && time2) { + to = date2.set({ + hour: time2.hours, + minute: time2.minutes, + second: time2.seconds, + }); + } else if (date2) { + to = date2.plus({ day: 1 }); + } else if (fullDay) { + to = from.plus({ day: 1 }); + } else { + to = from.plus(Luxon.Duration.fromMillis(DEFAULT_EVENT_DURATION)); + } + + return { + from: from.toISO(), + fromTimestamp: from.toMillis(), + to: to.toISO(), + toTimestamp: to.toMillis(), + description: words.join(' '), + fullDay: fullDay, + }; +} diff --git a/package-lock.json b/package-lock.json index 1c17d5d..4e33da7 100644 --- a/package-lock.json +++ b/package-lock.json @@ -24,6 +24,7 @@ "imap-simple": "^5.1.0", "jsonc-parser": "^3.2.0", "luxon": "^3.1.0", + "moo": "^0.5.2", "nano": "^10.0.0", "node-telegram-bot-api": "^0.59.0", "reflect-metadata": "^0.1.13", @@ -41,6 +42,7 @@ "@types/express": "^4.17.13", "@types/jest": "27.4.0", "@types/luxon": "^3.1.0", + "@types/moo": "^0.5.6", "@types/node": "^16.0.0", "@types/node-telegram-bot-api": "^0.57.1", "@types/supertest": "^2.0.11", @@ -2141,6 +2143,12 @@ "integrity": "sha512-Y4XFY5VJAuw0FgAqPNd6NNoV44jbq9Bz2L7Rh/J6jLTiHBSBJa9fxqQIvkIld4GsoDOcCbvzOUAbLPsSKKg+uA==", "dev": true }, + "node_modules/@types/moo": { + "version": "0.5.6", + "resolved": "https://registry.npmjs.org/@types/moo/-/moo-0.5.6.tgz", + "integrity": "sha512-Q60hZhulhl2Ox4LjbJvhH+HzsKrwzLPjEB8dZw0fK1MH2HyOLe6LDou68yTfsWasxGv7DPZe5VNM5vgpzOa2nw==", + "dev": true + }, "node_modules/@types/node": { "version": "16.11.49", "resolved": "https://registry.npmjs.org/@types/node/-/node-16.11.49.tgz", @@ -7452,6 +7460,11 @@ "mkdirp": "bin/cmd.js" } }, + "node_modules/moo": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/moo/-/moo-0.5.2.tgz", + "integrity": "sha512-iSAJLHYKnX41mKcJKjqvnAN9sf0LMDTXDEvFv+ffuRR9a1MIuXLjMNL6EsnDHSkKLTWNqQQ5uo61P4EbU4NU+Q==" + }, "node_modules/ms": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", @@ -12014,6 +12027,12 @@ "integrity": "sha512-Y4XFY5VJAuw0FgAqPNd6NNoV44jbq9Bz2L7Rh/J6jLTiHBSBJa9fxqQIvkIld4GsoDOcCbvzOUAbLPsSKKg+uA==", "dev": true }, + "@types/moo": { + "version": "0.5.6", + "resolved": "https://registry.npmjs.org/@types/moo/-/moo-0.5.6.tgz", + "integrity": "sha512-Q60hZhulhl2Ox4LjbJvhH+HzsKrwzLPjEB8dZw0fK1MH2HyOLe6LDou68yTfsWasxGv7DPZe5VNM5vgpzOa2nw==", + "dev": true + }, "@types/node": { "version": "16.11.49", "resolved": "https://registry.npmjs.org/@types/node/-/node-16.11.49.tgz", @@ -16024,6 +16043,11 @@ "minimist": "^1.2.6" } }, + "moo": { + "version": "0.5.2", + "resolved": "https://registry.npmjs.org/moo/-/moo-0.5.2.tgz", + "integrity": "sha512-iSAJLHYKnX41mKcJKjqvnAN9sf0LMDTXDEvFv+ffuRR9a1MIuXLjMNL6EsnDHSkKLTWNqQQ5uo61P4EbU4NU+Q==" + }, "ms": { "version": "2.1.2", "resolved": "https://registry.npmjs.org/ms/-/ms-2.1.2.tgz", diff --git a/package.json b/package.json index a871bf2..ad4a2a9 100644 --- a/package.json +++ b/package.json @@ -36,6 +36,7 @@ "imap-simple": "^5.1.0", "jsonc-parser": "^3.2.0", "luxon": "^3.1.0", + "moo": "^0.5.2", "nano": "^10.0.0", "node-telegram-bot-api": "^0.59.0", "reflect-metadata": "^0.1.13", @@ -53,6 +54,7 @@ "@types/express": "^4.17.13", "@types/jest": "27.4.0", "@types/luxon": "^3.1.0", + "@types/moo": "^0.5.6", "@types/node": "^16.0.0", "@types/node-telegram-bot-api": "^0.57.1", "@types/supertest": "^2.0.11", diff --git a/src/app.module.ts b/src/app.module.ts index 686bb56..2afa718 100644 --- a/src/app.module.ts +++ b/src/app.module.ts @@ -50,6 +50,7 @@ import { join } from 'path'; import { SimpleIssuesListController } from './dashboards/simple-issues-list.controller'; import { TagsManagerController } from './tags-manager/tags-manager.controller'; import { CreateTagManagerServiceProvider } from './tags-manager/tags-manager.service'; +import { CalendarEnhancer } from '@app/event-emitter/issue-enhancers/calendar-enhancer'; @Module({ imports: [ @@ -132,6 +133,9 @@ export class AppModule implements OnModuleInit { @Inject('CATEGORY_MERGE_TO_TAGS_ENHANCER') private categoryMergeToTagsEnhancer: CategoryMergeToTagsEnhancer, + + @Inject('CALENDAR_ENHANCER') + private calendarEnhancer: CalendarEnhancer, ) {} onModuleInit() { @@ -148,6 +152,7 @@ export class AppModule implements OnModuleInit { this.currentUserEnhancer, this.issueUrlEnhancer, this.categoryMergeToTagsEnhancer, + this.calendarEnhancer, ]); this.personalNotificationsService.$messages.subscribe((resp) => { diff --git a/src/configs/app.ts b/src/configs/app.ts index 89c3e6c..92146ba 100644 --- a/src/configs/app.ts +++ b/src/configs/app.ts @@ -8,6 +8,7 @@ import RedmineStatusChangesConfigLoader from './status-changes.config'; import RedmineEccmConfig from './eccm.config'; import RedmineCurrentUserRulesConfig from './current-user-rules.config'; import SimpleKanbanBoardConfig from './simple-kanban-board.config'; +import CalendarEnhancer from './calendar-enhancer.config'; const redmineIssueEventEmitterConfig = RedmineIssueEventEmitterConfigLoader(); const redmineStatusesConfig = RedmineStatusesConfigLoader(); @@ -15,6 +16,7 @@ const redmineStatusChanges = RedmineStatusChangesConfigLoader(); const redmineEccm = RedmineEccmConfig(); const redmineCurrentUserRules = RedmineCurrentUserRulesConfig(); const simpleKanbanBoard = SimpleKanbanBoardConfig(); +const calendarEnhancer = CalendarEnhancer(); let appConfig: AppConfig; @@ -39,6 +41,7 @@ export default (): AppConfig => { redmineEccm: redmineEccm, redmineCurrentUserRules: redmineCurrentUserRules, simpleKanbanBoard: simpleKanbanBoard, + calendarEnhancer: calendarEnhancer, }; return appConfig; diff --git a/src/configs/calendar-enhancer.config.ts b/src/configs/calendar-enhancer.config.ts new file mode 100644 index 0000000..1b19e6f --- /dev/null +++ b/src/configs/calendar-enhancer.config.ts @@ -0,0 +1,23 @@ +import { readFileSync } from 'fs'; +import { join } from 'path'; +import { parse } from 'jsonc-parser'; + +let config: Record; + +export default (): Record => { + if (config) { + return config; + } + + const userDefinedConfigPath = + process.env['ELTEX_REDMINE_HELPER_CALENDAR_ENHANCER_CONFIG_PATH']; + const defaultConfigPath = join('configs', 'calendar-enhancer.jsonc'); + + const configPath = userDefinedConfigPath || defaultConfigPath; + + const rawData = readFileSync(configPath, { encoding: 'utf-8' }); + + config = parse(rawData); + + return config; +}; diff --git a/src/issue-enhancers/interview-enhancer.ts b/src/issue-enhancers/interview-enhancer.ts deleted file mode 100644 index 06e11c1..0000000 --- a/src/issue-enhancers/interview-enhancer.ts +++ /dev/null @@ -1,59 +0,0 @@ -import { IssueEnhancerInterface } from '@app/event-emitter/issue-enhancers/issue-enhancer-interface'; -import { RedmineTypes } from '@app/event-emitter/models/redmine-types'; -import { Injectable } from '@nestjs/common'; -import * as Luxon from 'luxon'; - -export type SubjectParserParam = { - regexp: string; - format: string; - type: string; -}; - -export type DescriptionParserParam = {}; - -@Injectable() -export class InterviewEnhancer implements IssueEnhancerInterface { - name = 'interview'; - - constructor( - public interviewProjects: string[] = [], - public customFieldDateFormat: string = 'yyyy-MM-dd HH:mm', - public subjectParserParams: SubjectParserParam[] - ) {} - - async enhance( - issue: RedmineTypes.Issue, - ): Promise> { - const res: RedmineTypes.ExtendedIssue = { ...issue }; - - if (this.interviewProjects.indexOf(res.project.name) < 0) { - return res; - } - - const subject = res.subject; - const nextEventDateField = res.custom_fields.find((cf) => { - return cf.name === 'Дата следующего обновления'; - }); - - if () - - const nextEventDate = Luxon.DateTime.fromFormat(nextEventDateField.value, this.customFieldDateFormat); - - return res; - } - - private getNextEventDate(issue: RedmineTypes.ExtendedIssue): Luxon.DateTime|null { - const nextEventDateField = issue.custom_fields.find((cf) => { - return cf.name === 'Дата следующего обновления'; - }); - if (!nextEventDateField) return null; - const nextEventDate = Luxon.DateTime.fromFormat(nextEventDateField.value, this.customFieldDateFormat); - if (!nextEventDate.isValid) return null; - return nextEventDate; - } - - private getDateFromSubject(issue: RedmineTypes.ExtendedIssue): Luxon.DateTime|null { - const subject = issue.subject; - return null; - } -} diff --git a/src/models/app-config.model.ts b/src/models/app-config.model.ts index 38f3873..a60af45 100644 --- a/src/models/app-config.model.ts +++ b/src/models/app-config.model.ts @@ -26,4 +26,4 @@ export type AppConfig = { updateItemsLimit: number; tagsCustomFieldName: string; }; -}; +} & Record; From 4d693156d3671c7090bed8b112f11b2a12215e46 Mon Sep 17 00:00:00 2001 From: Gnedov Pavel Date: Wed, 23 Aug 2023 04:02:29 +0700 Subject: [PATCH 3/4] =?UTF-8?q?=D0=94=D0=BE=D0=B1=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D0=B0=20=D0=BE=D0=B1=D1=80=D0=B0=D0=B1=D0=BE=D1=82=D0=BA?= =?UTF-8?q?=D0=B0=20=D0=BE=D1=88=D0=B8=D0=B1=D0=BE=D0=BA=20=D0=B2=20=D0=BF?= =?UTF-8?q?=D0=B0=D1=80=D1=81=D0=B5=D1=80=20=D0=BA=D0=B0=D0=BB=D0=B5=D0=BD?= =?UTF-8?q?=D0=B4=D0=B0=D1=80=D0=BD=D1=8B=D1=85=20=D1=81=D0=BE=D0=B1=D1=8B?= =?UTF-8?q?=D1=82=D0=B8=D0=B9?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/issue-enhancers/calendar-enhancer.ts | 25 ++++++++++++++----- .../src/utils/string-with-dates-parser.ts | 21 +++++++++++++--- 2 files changed, 36 insertions(+), 10 deletions(-) diff --git a/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts b/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts index 5bc8c55..bbda56b 100644 --- a/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts +++ b/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts @@ -1,6 +1,6 @@ import { IssueEnhancerInterface } from '@app/event-emitter/issue-enhancers/issue-enhancer-interface'; import { RedmineTypes } from '@app/event-emitter/models/redmine-types'; -import { Injectable } from '@nestjs/common'; +import { Injectable, Logger } from '@nestjs/common'; import * as Luxon from 'luxon'; import { CalendarEvent } from '../models/calendar-event'; import * as DatesParser from '../utils/string-with-dates-parser'; @@ -23,6 +23,8 @@ export const UNKNOWN_CALENDAR_EVENT = 'Unknown calendar event'; @Injectable() export class CalendarEnhancer implements IssueEnhancerInterface { + private logger = new Logger(CalendarEnhancer.name); + name = 'calendar'; constructor( @@ -30,16 +32,27 @@ export class CalendarEnhancer implements IssueEnhancerInterface { public customFields: CustomFieldParserParams[], public descriptionCalendarParams: DescriptionParserParams, public calendarEventsKey: string, - ) {} + ) { + const initParams = {useForProjects, customFields, descriptionCalendarParams, calendarEventsKey}; + this.logger.debug(`Calendar enhancer init with ${JSON.stringify(initParams)}`); + } async enhance( issue: RedmineTypes.ExtendedIssue, ): Promise { const res: RedmineTypes.ExtendedIssue = { ...issue }; - if (!this.checkProject(issue)) return res; + if (!this.checkProject(res)) { + return res; + } - issue[this.calendarEventsKey] = this.getCalendarEvents(issue); + try { + res[this.calendarEventsKey] = this.getCalendarEvents(res); + } catch (ex) { + this.logger.error(`Error at parsing calendar events, message - ${ex}`); + return res; + } + this.logger.debug(`Calendar events for #${issue.id}: issue.${this.calendarEventsKey} = ${JSON.stringify(res[this.calendarEventsKey])}`); return res; } @@ -108,9 +121,9 @@ export class CalendarEnhancer implements IssueEnhancerInterface { return { from: from.toISO(), - fromTimestamp: from.toSeconds(), + fromTimestamp: from.toMillis(), to: to.toISO(), - toTimestamp: to.toSeconds(), + toTimestamp: to.toMillis(), fullDay: Boolean(params.fullDay), description: params.alias || cf.name || UNKNOWN_CALENDAR_EVENT, }; diff --git a/libs/event-emitter/src/utils/string-with-dates-parser.ts b/libs/event-emitter/src/utils/string-with-dates-parser.ts index cbfe4c8..55b4b46 100644 --- a/libs/event-emitter/src/utils/string-with-dates-parser.ts +++ b/libs/event-emitter/src/utils/string-with-dates-parser.ts @@ -1,6 +1,7 @@ -import Moo from 'moo'; +import * as Moo from 'moo'; import { CalendarEvent } from '../models/calendar-event'; -import Luxon from 'luxon'; +import * as Luxon from 'luxon'; +import { Logger } from '@nestjs/common'; export const DEFAULT_PARAMS: Moo.Rules = { WS: /[ \t]+/, @@ -13,12 +14,14 @@ export const DEFAULT_PARAMS: Moo.Rules = { NL: { match: /\n/, lineBreaks: true }, }; -export const DEFAULT_DATE_FORMATS = ['dd.MM.yy', 'dd.MM.yyyy', 'yyyy-MM-dd']; +export const DEFAULT_DATE_FORMATS = ['yyyy-MM-dd', 'dd.MM.yyyy', 'dd.MM.yy']; -export const DEFAULT_TIME_FORMATS = ['HH:mm', 'HH:mm:ss']; +export const DEFAULT_TIME_FORMATS = ['HH:mm:ss', 'HH:mm']; export const DEFAULT_EVENT_DURATION = 60 * 60 * 1000; // 1 hour in millis +const logger = new Logger('string-with-dates-parser'); + export function parse(str: string, params?: Moo.Rules): Moo.Token[] { if (!params) params = DEFAULT_PARAMS; try { @@ -32,6 +35,7 @@ export function parse(str: string, params?: Moo.Rules): Moo.Token[] { } return res; } catch (ex) { + logger.error(`Error at parse str=${str} with params=${params}, error message - ${ex}`); return []; } } @@ -42,10 +46,17 @@ export type ParserOpts = { timeFormats?: string[]; }; +export const DEFAULT_PARSER_OPTS: ParserOpts = { + rules: DEFAULT_PARAMS, + dateFormats: DEFAULT_DATE_FORMATS, + timeFormats: DEFAULT_TIME_FORMATS, +}; + export function parseDate( str: string, formats?: string[], ): Luxon.DateTime | null { + if (!str) return null; if (!formats) formats = DEFAULT_DATE_FORMATS; let res: Luxon.DateTime; for (let i = 0; i < formats.length; i++) { @@ -60,6 +71,7 @@ export function parseTime( str: string, formats?: string[], ): Luxon.Duration | null { + if (!str) return null; if (!formats) formats = DEFAULT_TIME_FORMATS; let res: Luxon.DateTime; for (let i = 0; i < formats.length; i++) { @@ -82,6 +94,7 @@ export function parseToCalendarEvent( str: string, opts?: ParserOpts, ): CalendarEvent | null { + if (!opts) opts = DEFAULT_PARSER_OPTS; const tokens = parse(str, opts?.rules); const words = tokens.filter((i) => i.type === 'word'); From 4107ae84f31c8215c046a798275760dfd85e34cb Mon Sep 17 00:00:00 2001 From: Gnedov Pavel Date: Thu, 24 Aug 2023 18:40:16 +0700 Subject: [PATCH 4/4] =?UTF-8?q?=D0=92=D1=8B=D0=B3=D1=80=D1=83=D0=B7=D0=BA?= =?UTF-8?q?=D0=B0=20=D0=BA=D0=B0=D0=BB=D0=B5=D0=BD=D0=B4=D0=B0=D1=80=D0=BD?= =?UTF-8?q?=D1=8B=D1=85=20=D1=81=D0=BE=D0=B1=D1=8B=D1=82=D0=B8=D0=B9=20?= =?UTF-8?q?=D0=B2=20=D1=84=D0=BE=D1=80=D0=BC=D0=B0=D1=82=D0=B5=20icalendar?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../src/calendar/calendar.controller.ts | 58 +++++++++ .../src/calendar/calendar.service.ts | 113 ++++++++++++++++++ .../event-emitter/src/event-emitter.module.ts | 16 ++- .../src/issue-enhancers/calendar-enhancer.ts | 5 +- .../src/utils/string-with-dates-parser.ts | 10 +- 5 files changed, 197 insertions(+), 5 deletions(-) create mode 100644 libs/event-emitter/src/calendar/calendar.controller.ts create mode 100644 libs/event-emitter/src/calendar/calendar.service.ts diff --git a/libs/event-emitter/src/calendar/calendar.controller.ts b/libs/event-emitter/src/calendar/calendar.controller.ts new file mode 100644 index 0000000..a62d6c0 --- /dev/null +++ b/libs/event-emitter/src/calendar/calendar.controller.ts @@ -0,0 +1,58 @@ +import { Controller, Get, Inject, Logger, Param, Query } from "@nestjs/common"; +import { CalendarService } from "./calendar.service"; +import nano from 'nano'; +import { UNLIMITED } from "../consts/consts"; + +@Controller('calendar') +export class CalendarController { + private logger = new Logger(CalendarController.name); + + constructor( + @Inject('CALENDAR_SERVICE') + private calendarService: CalendarService + ) {} + + @Get() + async get(@Param('filter') filter: any): Promise { + return await this.calendarService.getICalData(filter); + } + + @Get('/simple') + async simple( + @Query('project') project?: string, + @Query('category') category?: string + ): Promise { + const andSection: any[] = [ + { + "closed_on": { + "$exists": false + } + } + ]; + if (project) { + andSection.push({ + "project.name": { + "$in": [ + project + ] + } + }); + } + if (category) { + andSection.push({ + "category.name": { + "$in": [ + category + ] + } + }); + } + const query: nano.MangoQuery = { + selector: { + "$and": andSection + }, + limit: UNLIMITED + }; + return await this.calendarService.getICalData(query); + } +} \ No newline at end of file diff --git a/libs/event-emitter/src/calendar/calendar.service.ts b/libs/event-emitter/src/calendar/calendar.service.ts new file mode 100644 index 0000000..7f0833c --- /dev/null +++ b/libs/event-emitter/src/calendar/calendar.service.ts @@ -0,0 +1,113 @@ +import { Injectable, Logger } from "@nestjs/common"; +import { CalendarEvent } from "../models/calendar-event"; +import { RedmineTypes } from "../models/redmine-types"; +import * as Luxon from 'luxon'; +import { IssuesService } from "../issues/issues.service"; +import { randomUUID } from 'crypto'; + +/* +BEGIN:VCALENDAR +PRODID:-//Example Corp.//CalDAV Client//EN +VERSION:2.0 +BEGIN:VEVENT +UID:1@example.com +SUMMARY:One-off Meeting +DTSTAMP:20041210T183904Z +DTSTART:20041207T120000Z +DTEND:20041207T130000Z +END:VEVENT +BEGIN:VEVENT +UID:2@example.com +SUMMARY:Weekly Meeting +DTSTAMP:20041210T183838Z +DTSTART:20041206T120000Z +DTEND:20041206T130000Z +RRULE:FREQ=WEEKLY +END:VEVENT +BEGIN:VEVENT +UID:2@example.com +SUMMARY:Weekly Meeting +RECURRENCE-ID:20041213T120000Z +DTSTAMP:20041210T183838Z +DTSTART:20041213T130000Z +DTEND:20041213T140000Z +END:VEVENT +END:VCALENDAR +*/ + +export type IssueAndEvent = { + issue: RedmineTypes.ExtendedIssue; + event: CalendarEvent; +}; + +@Injectable() +export class CalendarService { + private interval = 30 * 24 * 60 * 60 * 1000; // 30 days + + constructor(public calendarEventsKey: string, private issuesService: IssuesService) {} + + async getICalData(filter: any): Promise { + const issues = await this.issuesService.find(filter); + const actualEvents = this.getActualEvents(issues); + const formattedEvents = actualEvents.map((event) => { + return this.generateICalendarEvent(event.issue, event.event); + }).filter((event) => { + return !!event; + }); + const res = this.generateICalendar(formattedEvents); + return res; + } + + private getActualEvents(issues: RedmineTypes.ExtendedIssue[]): IssueAndEvent[] { + const res: IssueAndEvent[] = []; + for (let i = 0; i < issues.length; i++) { + const issue = issues[i]; + if (!issue[this.calendarEventsKey] || issue[this.calendarEventsKey].length <= 0) { + continue; + } + const events = issue[this.calendarEventsKey]; + for (let j = 0; j < events.length; j++) { + const event = events[j]; + if (this.actualEvent(event)) res.push({event: event, issue: issue}); + } + } + return res; + } + + private actualEvent(event: CalendarEvent): boolean { + const now = Luxon.DateTime.now().toMillis(); + const from = now - this.interval; + const to = now + this.interval; + return Boolean( + (from <= event.fromTimestamp && event.fromTimestamp <= to) || + (from <= event.toTimestamp && event.toTimestamp <= to) + ); + } + + private generateICalendarEvent(issue: RedmineTypes.Issue, data: CalendarEvent): string | null { + if (!data) return null; + return `BEGIN:VEVENT +UID:${randomUUID()}@example.com +DTSTAMP:${this.formatTimestamp(data.fromTimestamp, data.fullDay)} +ORGANIZER;CN=John Doe:MAILTO:john.doe@example.com +DTSTART:${this.formatTimestamp(data.fromTimestamp, data.fullDay)} +DTEND:${this.formatTimestamp(data.toTimestamp, data.fullDay)} +SUMMARY:#${issue.id} - ${data.description} - ${issue.subject} +END:VEVENT`; + } + + private formatTimestamp(timestamp: number, fullDay?: boolean): string { + let format: string = fullDay ? "yyyyMMdd" : "yyyyMMdd'T'HHmmss'Z'"; + let datetime = Luxon.DateTime.fromMillis(timestamp); + if (!fullDay) datetime = datetime.setZone('utc'); + return datetime.toFormat(format); + } + + private generateICalendar(events: string[]): string { + return `BEGIN:VCALENDAR +VERSION:2.0 +PRODID:-//Example Corp.//CalDAV Client//EN +${events.join("\n")} +END:VCALENDAR`; + } +} \ No newline at end of file diff --git a/libs/event-emitter/src/event-emitter.module.ts b/libs/event-emitter/src/event-emitter.module.ts index d24ab6a..7383ec6 100644 --- a/libs/event-emitter/src/event-emitter.module.ts +++ b/libs/event-emitter/src/event-emitter.module.ts @@ -29,6 +29,8 @@ import { TimePassedHighlightEnhancer } from './issue-enhancers/time-passed-highl import { ListIssuesByFieldsWidgetService } from './project-dashboard/widgets/list-issues-by-fields.widget.service'; import { IssuesUpdaterService } from './issues-updater/issues-updater.service'; import { CalendarEnhancer } from './issue-enhancers/calendar-enhancer'; +import { CalendarService } from './calendar/calendar.service'; +import { CalendarController } from './calendar/calendar.controller'; @Module({}) export class EventEmitterModule implements OnModuleInit { @@ -83,6 +85,14 @@ export class EventEmitterModule implements OnModuleInit { }, inject: [ConfigService], }, + { + provide: 'CALENDAR_SERVICE', + useFactory: (calendarEnhancer: CalendarEnhancer, issuesService: IssuesService): CalendarService => { + const calendarEventsKey = calendarEnhancer.calendarEventsKey; + return new CalendarService(calendarEventsKey, issuesService); + }, + inject: ['CALENDAR_ENHANCER', IssuesService] + }, ], exports: [ EventEmitterService, @@ -114,8 +124,12 @@ export class EventEmitterModule implements OnModuleInit { provide: 'CALENDAR_ENHANCER', useExisting: 'CALENDAR_ENHANCER', }, + { + provide: 'CALENDAR_SERVICE', + useExisting: 'CALENDAR_SERVICE', + }, ], - controllers: [MainController, UsersController, IssuesController], + controllers: [MainController, UsersController, IssuesController, CalendarController], }; } diff --git a/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts b/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts index bbda56b..92dfc8c 100644 --- a/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts +++ b/libs/event-emitter/src/issue-enhancers/calendar-enhancer.ts @@ -49,7 +49,7 @@ export class CalendarEnhancer implements IssueEnhancerInterface { try { res[this.calendarEventsKey] = this.getCalendarEvents(res); } catch (ex) { - this.logger.error(`Error at parsing calendar events, message - ${ex}`); + this.logger.error(`Error at parsing calendar events, message - ${ex}: ${(ex as Error)?.stack}`); return res; } this.logger.debug(`Calendar events for #${issue.id}: issue.${this.calendarEventsKey} = ${JSON.stringify(res[this.calendarEventsKey])}`); @@ -147,7 +147,7 @@ export class CalendarEnhancer implements IssueEnhancerInterface { const lines = text.split('\n').map((line) => line.trim()); - const calendarStartIndex = lines.indexOf('Календарь:'); + const calendarStartIndex = lines.indexOf(this.descriptionCalendarParams.title); if (calendarStartIndex < 0) return []; let index = calendarStartIndex + 1; @@ -170,6 +170,7 @@ export class CalendarEnhancer implements IssueEnhancerInterface { } private extractFromList(line: string): string | null { + if (!line || line.length <= 0) return null; const regexp = new RegExp(this.descriptionCalendarParams.lineRegexp); const match = line.match(regexp); return match && match[0] ? match[0] : null; diff --git a/libs/event-emitter/src/utils/string-with-dates-parser.ts b/libs/event-emitter/src/utils/string-with-dates-parser.ts index 55b4b46..b1c39ec 100644 --- a/libs/event-emitter/src/utils/string-with-dates-parser.ts +++ b/libs/event-emitter/src/utils/string-with-dates-parser.ts @@ -7,8 +7,8 @@ export const DEFAULT_PARAMS: Moo.Rules = { WS: /[ \t]+/, delimiter: /(?: - |: )/, delimiter2: /(?:^\* |^- |(?!\d)T(?!>\d))/, - date: /(?:(?:\d{2}\.\d{2}\.(?:\d{2}|\d{4}))|(?:\d{4}-\d{2}-\d{2}))/, - time: /(?:\d{2}\b:\d{2}:\d{2}|\d{2}:\d{2})/, + date: /\b(?:(?:\d{2}\.\d{2}\.(?:\d{2}|\d{4}))|(?:\d{4}-\d{2}-\d{2}))\b/, + time: /\b(?:\d{2}\b:\d{2}:\d{2}|\d{2}:\d{2})\b/, word: /[\wА-Яа-я]+/, other: { match: /./, lineBreaks: true }, NL: { match: /\n/, lineBreaks: true }, @@ -136,6 +136,12 @@ export function parseToCalendarEvent( to = date2.plus({ day: 1 }); } else if (fullDay) { to = from.plus({ day: 1 }); + } else if (time2) { + to = date1.set({ + hour: time2.hours, + minute: time2.minutes, + second: time2.seconds + }); } else { to = from.plus(Luxon.Duration.fromMillis(DEFAULT_EVENT_DURATION)); }