add normalize script

weseek · mergify · Nov 18, 2024 · Oct 31, 2024 · Nov 1, 2024 · Nov 5, 2024
commit 43930d1e2e091768f937a3c038c359f3bbcd62a0
diff --git a/apps/app/src/features/openai/server/services/normalize-data/index.ts b/apps/app/src/features/openai/server/services/normalize-data/index.ts
@@ -0,0 +1 @@
+export * from './normalize-thread-relation-expired-at';
diff --git a/...tures/openai/server/services/normalize-data/normalize-thread-relation-expired-at/index.ts b/...tures/openai/server/services/normalize-data/normalize-thread-relation-expired-at/index.ts
@@ -0,0 +1 @@
+export * from './normalize-thread-relation-expired-at';
diff --git a/...e-data/normalize-thread-relation-expired-at/normalize-thread-relation-expired-at.integ.ts b/...e-data/normalize-thread-relation-expired-at/normalize-thread-relation-expired-at.integ.ts
@@ -0,0 +1,70 @@
+import { faker } from '@faker-js/faker';
+import { addDays, subDays } from 'date-fns';
+import { Types } from 'mongoose';
+
+import ThreadRelation from '../../../models/thread-relation';
+
+import { MAX_DAYS_UNTIL_EXPIRATION, normalizeExpiredAtForThreadRelations } from './normalize-thread-relation-expired-at';
+
+describe('normalizeExpiredAtForThreadRelations', () => {
+
+  it('should update expiredAt to 3 days from now for expired thread relations', async() => {
+    // arrange
+    const expiredDays = faker.number.int({ min: MAX_DAYS_UNTIL_EXPIRATION, max: 30 });
+    const expiredDate = addDays(new Date(), expiredDays);
+    const threadRelation = new ThreadRelation({
+      userId: new Types.ObjectId(),
+      threadId: 'test-thread',
+      expiredAt: expiredDate,
+    });
+    await threadRelation.save();
+
+    // act
+    await normalizeExpiredAtForThreadRelations();
+
+    // assert
+    const updatedThreadRelation = await ThreadRelation.findById(threadRelation._id);
+    expect(updatedThreadRelation).not.toBeNull();
+    assert(updatedThreadRelation?.expiredAt != null);
+    expect(updatedThreadRelation.expiredAt < addDays(new Date(), MAX_DAYS_UNTIL_EXPIRATION)).toBeTruthy();
+  });
+
+  it('should not update expiredAt for non-expired thread relations', async() => {
+    // arrange
+    const nonExpiredDays = faker.number.int({ min: 0, max: MAX_DAYS_UNTIL_EXPIRATION });
+    const nonExpiredDate = addDays(new Date(), nonExpiredDays);
+    const threadRelation = new ThreadRelation({
+      userId: new Types.ObjectId(),
+      threadId: 'test-thread-2',
+      expiredAt: nonExpiredDate,
+    });
+    await threadRelation.save();
+
+    // act
+    await normalizeExpiredAtForThreadRelations();
+
+    // assert
+    const updatedThreadRelation = await ThreadRelation.findById(threadRelation._id);
+    expect(updatedThreadRelation).not.toBeNull();
+    expect(updatedThreadRelation?.expiredAt).toEqual(nonExpiredDate);
+  });
+
+  it('should not update expiredAt is before today', async() => {
+    // arrange
+    const nonExpiredDate = subDays(new Date(), 1);
+    const threadRelation = new ThreadRelation({
+      userId: new Types.ObjectId(),
+      threadId: 'test-thread-3',
+      expiredAt: nonExpiredDate,
+    });
+    await threadRelation.save();
+
+    // act
+    await normalizeExpiredAtForThreadRelations();
+
+    // assert
+    const updatedThreadRelation = await ThreadRelation.findById(threadRelation._id);
+    expect(updatedThreadRelation).not.toBeNull();
+    expect(updatedThreadRelation?.expiredAt).toEqual(nonExpiredDate);
+  });
+});
diff --git a/...rmalize-data/normalize-thread-relation-expired-at/normalize-thread-relation-expired-at.ts b/...rmalize-data/normalize-thread-relation-expired-at/normalize-thread-relation-expired-at.ts
@@ -0,0 +1,14 @@
+import { addDays } from 'date-fns';
+
+import ThreadRelation from '../../../models/thread-relation';
+
+export const MAX_DAYS_UNTIL_EXPIRATION = 3;
+
+export const normalizeExpiredAtForThreadRelations = async(): Promise<void> => {
+  const maxDaysExpiredAt = addDays(new Date(), MAX_DAYS_UNTIL_EXPIRATION);
+
+  await ThreadRelation.updateMany(
+    { expiredAt: { $gt: maxDaysExpiredAt } },
+    { $set: { expiredAt: maxDaysExpiredAt } },
+  );
+};
diff --git a/apps/app/src/server/service/normalize-data/index.ts b/apps/app/src/server/service/normalize-data/index.ts
@@ -1,3 +1,4 @@
+import { normalizeExpiredAtForThreadRelations } from '~/features/openai/server/services/normalize-data';
 import loggerFactory from '~/utils/logger';
 
 import { convertRevisionPageIdToObjectId } from './convert-revision-page-id-to-objectid';
@@ -8,6 +9,7 @@ const logger = loggerFactory('growi:service:NormalizeData');
 export const normalizeData = async(): Promise<void> => {
   await renameDuplicateRootPages();
   await convertRevisionPageIdToObjectId();
+  await normalizeExpiredAtForThreadRelations();
 
   logger.info('normalizeData has been executed');
   return;

diff --git a/packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts b/packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts
  effects: Effects,
  ok: State
 ): (
  code: import('micromark-util-types').Code
 ) => void | import('micromark-util-types').State
 export type Effects = import('micromark-util-types').Effects
 export type State = import('micromark-util-types').State
diff --git a/packages/slack/src/interfaces/growi-interaction-processor.ts b/packages/slack/src/interfaces/growi-interaction-processor.ts
 import type { AuthorizeResult } from '@slack/oauth';

 import { InteractionPayloadAccessor } from '../utils/interaction-payload-accessor';


 export interface InteractionHandledResult<V> {
  shouldHandleInteraction(interactionPayloadAccessor: InteractionPayloadAccessor): boolean;

  processInteraction(
    authorizeResult: AuthorizeResult, interactionPayload: any, interactionPayloadAccessor: InteractionPayloadAccessor): Promise<InteractionHandledResult<V>>;

 }
diff --git a/packages/slack/src/interfaces/request-from-slack.ts b/packages/slack/src/interfaces/request-from-slack.ts
 import type { Request } from 'express';

 export interface IInteractionPayloadAccessor {
  firstAction(): any;
 }

 export type RequestFromSlack = Request & {
  // appended by GROWI or slackbot-proxy
  slackSigningSecret?:string,

  interactionPayload?: any,
  interactionPayloadAccessor?: any,
 };
diff --git a/packages/slack/src/middlewares/parse-slack-interaction-request.ts b/packages/slack/src/middlewares/parse-slack-interaction-request.ts
 import { InteractionPayloadAccessor } from '../utils/interaction-payload-accessor';


 export const parseSlackInteractionRequest = (req: RequestFromSlack, res: Response, next: NextFunction): Record<string, any> | void => {
  // There is no payload in the request from slack
  if (req.body.payload == null) {
    return next();
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1 @@
		export * from './normalize-thread-relation-expired-at';
	effects: Effects,
	ok: State
	): (
	code: import('micromark-util-types').Code
Check warning on line 9 in packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts GitHub Actions / ci-app-lint (20.x) `import()` type annotations are forbidden Check warning on line 9 in packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts GitHub Actions / ci-app-lint (20.x) `import()` type annotations are forbidden
	) => void \| import('micromark-util-types').State
Check warning on line 10 in packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts GitHub Actions / ci-app-lint (20.x) `import()` type annotations are forbidden Check warning on line 10 in packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts GitHub Actions / ci-app-lint (20.x) `import()` type annotations are forbidden
	export type Effects = import('micromark-util-types').Effects
Check warning on line 11 in packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts GitHub Actions / ci-app-lint (20.x) `import()` type annotations are forbidden Check warning on line 11 in packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts GitHub Actions / ci-app-lint (20.x) `import()` type annotations are forbidden
	export type State = import('micromark-util-types').State
Check warning on line 12 in packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts GitHub Actions / ci-app-lint (20.x) `import()` type annotations are forbidden Check warning on line 12 in packages/remark-growi-directive/src/micromark-factory-attributes-devider/index.d.ts GitHub Actions / ci-app-lint (20.x) `import()` type annotations are forbidden
	import type { AuthorizeResult } from '@slack/oauth';

	import { InteractionPayloadAccessor } from '../utils/interaction-payload-accessor';
Check warning on line 3 in packages/slack/src/interfaces/growi-interaction-processor.ts GitHub Actions / ci-app-lint (20.x) All imports in the declaration are only used as types. Use `import type` Check warning on line 3 in packages/slack/src/interfaces/growi-interaction-processor.ts GitHub Actions / ci-app-lint (20.x) All imports in the declaration are only used as types. Use `import type`


	export interface InteractionHandledResult<V> {
	shouldHandleInteraction(interactionPayloadAccessor: InteractionPayloadAccessor): boolean;

	processInteraction(
	authorizeResult: AuthorizeResult, interactionPayload: any, interactionPayloadAccessor: InteractionPayloadAccessor): Promise<InteractionHandledResult<V>>;
Check warning on line 16 in packages/slack/src/interfaces/growi-interaction-processor.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type` Check warning on line 16 in packages/slack/src/interfaces/growi-interaction-processor.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type`

	}
	import type { Request } from 'express';

	export interface IInteractionPayloadAccessor {
	firstAction(): any;
Check warning on line 4 in packages/slack/src/interfaces/request-from-slack.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type` Check warning on line 4 in packages/slack/src/interfaces/request-from-slack.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type`
	}

	export type RequestFromSlack = Request & {
	// appended by GROWI or slackbot-proxy
	slackSigningSecret?:string,

	interactionPayload?: any,
Check warning on line 14 in packages/slack/src/interfaces/request-from-slack.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type` Check warning on line 14 in packages/slack/src/interfaces/request-from-slack.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type`
	interactionPayloadAccessor?: any,
Check warning on line 15 in packages/slack/src/interfaces/request-from-slack.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type` Check warning on line 15 in packages/slack/src/interfaces/request-from-slack.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type`
	};
	import { InteractionPayloadAccessor } from '../utils/interaction-payload-accessor';


	export const parseSlackInteractionRequest = (req: RequestFromSlack, res: Response, next: NextFunction): Record<string, any> \| void => {
Check warning on line 7 in packages/slack/src/middlewares/parse-slack-interaction-request.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type` Check warning on line 7 in packages/slack/src/middlewares/parse-slack-interaction-request.ts GitHub Actions / ci-app-lint (20.x) `Unexpected any. Specify a different type`
	// There is no payload in the request from slack
	if (req.body.payload == null) {
	return next();