refactor(condo): DOMA-6931 refactored news sending #4501

Alllex202 · 2024-03-21T07:37:15Z

what's going on here?

changes in the `NewsItem` schema:

Before:

the field sendAt is set in when the news should be postponed

After:

the sendAt field is now always set in (сan be null if not ready to send yet when isPublished = false), and indicates the date when the news sending should begin

changes in tasks

Before:

the notifyResidentsAboutNewsItem task used setTimeout and because of this we could not track the sending process, since the worker completed the task before the news sending process was completed

After:

the notifyResidentsAboutNewsItem task has been refactored and now does not use setTimeout

changes in accesses

Before:

a dynamic filter was previously used to allow residents to read news

After:

the filter for residents to read news has been simplified

Other

Tests for sending news have been added
Fixed display of the date of sending news in CRM
Removed the button for editing if the news is already being sent out

toplenboren · 2024-03-21T14:50:16Z

apps/condo/domains/news/gql.js

@@ -12,7 +12,7 @@ const { ADDRESS_META_SUBFIELDS_TABLE_LIST } = require('@condo/domains/property/s

 const COMMON_FIELDS = 'id dv sender { dv fingerprint } v deletedAt newId createdBy { id name } updatedBy { id name } createdAt updatedAt'

-const NEWS_ITEM_FIELDS = `{ organization { id } number title body type validBefore sendAt sentAt isPublished publishedAt ${COMMON_FIELDS} compactScopes { count firstOnes { id unitType unitName property { address addressMeta { ${ADDRESS_META_SUBFIELDS_TABLE_LIST} } } } } }`
+const NEWS_ITEM_FIELDS = `{ organization { id } number title body type validBefore sendAt deliverAt sentAt isPublished publishedAt ${COMMON_FIELDS} compactScopes { count firstOnes { id unitType unitName property { address addressMeta { ${ADDRESS_META_SUBFIELDS_TABLE_LIST} } } } } }`


Its better to call it deliveredAt, since delivered is in past tense

No, it's future tense, not past tense.
This is equivalent to:

sendAt - for news to be sent in the future

publishedAt + time to cancel sending 15 seconds - for news to be sent now

I will add a description to this pr to make it clearer what is changing

Alright, got you

But this seems really counter intuitive.. Need docs or better naming

Unfortunately, the name sendTo is already taken :(

or better naming

Ok, I'll think about it

Just to be clear:

Why couldnt we set sendAt to publishedAt + time to cancel sending 15 seconds - for news to be sent now ?

Yeah, I wanted to do that, but...
Now the sendAt field is an indicator that the news was sent with a planned sending date in the future.
If it is full, then the news is planned; if it is empty, then the news is being sent right now.
I can’t yet say for sure whether we need this information now or whether this information may be useful in the future, but if we start always filling out the sendAt field, we will lose it.

However, we can add a separate flag for this. (If needed)

I think it's worth discussing this point. if it doesn't affect anything, then why not

toplenboren · 2024-03-21T14:52:09Z

apps/condo/domains/news/schema/NewsItem.js

            type: 'DateTimeUtc',
        },

+        deliverAt: {
+            // todo(DOMA-6931): update schemaDoc


6931 is solved by this PR, is it not? I think we should remove this PR

toplenboren · 2024-03-21T14:52:50Z

apps/condo/domains/news/schema/NewsItem.test.js

@@ -828,7 +828,8 @@ describe('NewsItems', () => {
            )
        })

-        test('must throw an error on trying to edit the news item which already been sent', async () => {
+        // todo(doma-6931): rewrite test


toplenboren · 2024-03-21T18:28:15Z

apps/condo/domains/news/schema/NewsItem.test.js

+                })
+            })
+
+            describe('should be auto-calculate', () => {


Suggested change

describe('should be auto-calculate', () => {

describe('should be auto-calculated', () => {

toplenboren · 2024-03-21T18:29:56Z

apps/condo/domains/news/schema/NewsItem.js

@@ -136,10 +136,40 @@ const NewsItem = new GQLListSchema('NewsItem', {
        },

        sendAt: {


what will happen with this value if user decides to click "No I do not want to send this newsItem"

Also, I think we should reuse 15 seconds from frontned part of our app. Otherwise we will change 15 to 30 in one place. and forget to change in other place

if user decides to click "No I do not want to send this newsItem"

This news item will be deleted (using deletedAt)

Also, I think we should reuse 15 seconds from frontned part of our app. Otherwise we will change 15 to 30 in one place. and forget to change in other place

Fixed

toplenboren · 2024-03-21T18:33:24Z

apps/condo/domains/news/tasks/notifyResidentsAboutNewsItem.js

+                type: defineMessageType(newsItem),
+                meta: {
+                    dv: 1,
+                    title: truncate(newsItem.title, { length: TITLE_MAX_LEN, separator: ' ', omission: '...' }),


It might be better to use deidcated … char here, since it might (im not sure) take less space in the resulting message

Need to check whether the target system support the encodings though

I think there is no need to change something that already works well :)

apps/condo/domains/news/schema/NewsItem.js

apps/condo/domains/news/tasks/notifyResidentsAboutNewsItem.js

nomerdvadcatpyat · 2024-03-27T12:43:00Z

apps/condo/pages/news/[id]/index.tsx

@@ -83,6 +85,8 @@ const NewsItemCard: React.FC = () => {
    const ConfirmDeleteMessage = intl.formatMessage({ id: 'news.ConfirmDeleteMessage' })
    const CancelMessage = intl.formatMessage({ id: 'news.CancelMessage' })

+    const { publicRuntimeConfig: { newsItemsSendingDelay } } = getConfig()


move this outside of component

…task

This reverts commit 1c31f56.

…eUntil" and "NewsItem.deliverAt" to "NewsItem.sendAt"

….postponeUntil" and "NewsItem.deliverAt" to "NewsItem.sendAt"" This reverts commit 536deef.

sonarcloud · 2024-03-28T09:16:14Z

Quality Gate passed

Issues
2 New issues
0 Accepted issues

Measures
0 Security Hotspots
No data about Coverage
0.0% Duplication on New Code

See analysis details on SonarCloud

Alllex202 added the 🔬 WIP Not intended to be merged right now, it is a work in progress label Mar 21, 2024

Alllex202 force-pushed the refactor/condo/DOMA-6931/refactor-news-sending branch from 09239d2 to 92ebb7f Compare March 21, 2024 15:09

toplenboren reviewed Mar 21, 2024

View reviewed changes

Alllex202 force-pushed the refactor/condo/DOMA-6931/refactor-news-sending branch from 92ebb7f to 871fcd0 Compare March 22, 2024 09:20

Alllex202 requested a review from AleX83Xpert March 22, 2024 12:44

AleX83Xpert reviewed Mar 22, 2024

View reviewed changes

apps/condo/domains/news/schema/NewsItem.js Outdated Show resolved Hide resolved

apps/condo/domains/news/tasks/notifyResidentsAboutNewsItem.js Show resolved Hide resolved

Alllex202 force-pushed the refactor/condo/DOMA-6931/refactor-news-sending branch from 9d87ebf to 536deef Compare March 26, 2024 16:46

Alllex202 marked this pull request as ready for review March 26, 2024 17:29

Alllex202 added ✋🙂 Review please Comments are resolved, take a look, please 🚨 Migrations We have a database migrations here! and removed 🔬 WIP Not intended to be merged right now, it is a work in progress labels Mar 26, 2024

Alllex202 requested review from AleX83Xpert, toplenboren and nomerdvadcatpyat March 26, 2024 17:29

Alllex202 added 🔬 WIP Not intended to be merged right now, it is a work in progress and removed ✋🙂 Review please Comments are resolved, take a look, please labels Mar 27, 2024

toplenboren approved these changes Mar 27, 2024

View reviewed changes

Alllex202 force-pushed the refactor/condo/DOMA-6931/refactor-news-sending branch from 536deef to 7e2f166 Compare March 27, 2024 12:15

Alllex202 added ✋🙂 Review please Comments are resolved, take a look, please and removed 🔬 WIP Not intended to be merged right now, it is a work in progress labels Mar 27, 2024

nomerdvadcatpyat approved these changes Mar 27, 2024

View reviewed changes

Alllex202 force-pushed the refactor/condo/DOMA-6931/refactor-news-sending branch from 5b62394 to 4604ee4 Compare March 27, 2024 16:57

Alllex202 added 8 commits March 28, 2024 14:09

fix(condo): DOMA-6931 updated accesses for "NewsItem.sentAt" field

f409a7f

feat(condo): DOMA-6931 added "deliverAt" field to "NewsItem" schema

d208306

refactor(condo): DOMA-6931 refactored "notifyResidentsAboutNewsItem" …

3693a59

…task

chore(condo): DOMA-6931 updated schemas

e7011f9

chore(condo): DOMA-6931 wrapped sendMessage to try/catch

fa07eae

feat(condo): DOMA-6931 added migrations

53ada77

feat(condo): DOMA-6931 updated display of the date of sending news

cc1c3e2

feat(condo): DOMA-6931 added migrations for existing news items

7857f4d

Alllex202 added 24 commits March 28, 2024 14:09

chore(condo): DOMA-6931 updated docs

6970092

test(condo): DOMA-6931 updated tests

ff32cfa

refactor(condo): DOMA-6931 refactored export of tasks

35ff75f

refactor(condo): DOMA-6931 refactored checking before sending news item

131bf65

chore(condo): DOMA-6931 added comments

aed9065

Revert "refactor(condo): DOMA-6931 refactored export of tasks"

fb4a999

This reverts commit 1c31f56.

chore(condo): DOMA-6931 updated comment

2030a86

fix(condo): DOMA-6931 fixed tasks

a5c6164

fix(condo): DOMA-6931 fixed tests

54d0e09

test(condo): DOMA-6931 fixed tests

759df07

feat(condo): DOMA-6931 updated NewsItem.deliverAt

ab9da5c

test(condo): DOMA-6931 fixed tests

a2f7989

feat(condo): DOMA-6931 updated migrations

7eeacd3

feat(condo): DOMA-6931 renamed "NewsItem.sendAt" to "NewsItem.postpon…

0f53d33

…eUntil" and "NewsItem.deliverAt" to "NewsItem.sendAt"

Revert "feat(condo): DOMA-6931 renamed "NewsItem.sendAt" to "NewsItem…

3d4a988

….postponeUntil" and "NewsItem.deliverAt" to "NewsItem.sendAt"" This reverts commit 536deef.

refactor(condo): DOMA-6931 updated "NewsItem.sendAt" field logic

381fa1a

feat(condo): DOMA-6931 updated migrations

0b4703a

feat(condo): DOMA-6931 updated schema types

4d7197e

fix(condo): DOMA-6931 news editing fixed

f1f7b19

test(condo): DOMA-6931 updated tests

4ca5d65

fix(condo): DOMA-6931 fixed schema types

1be44ad

chore(condo): DOMA-6931 added todo

3d43b11

refactor(condo): DOMA-6931 refactored after review

3e5cbe7

chore(condo): DOMA-6931 updated migrations

a80e3ef

Alllex202 force-pushed the refactor/condo/DOMA-6931/refactor-news-sending branch from 4604ee4 to a80e3ef Compare March 28, 2024 09:09

Alllex202 merged commit d352b18 into master Mar 29, 2024
24 checks passed

Alllex202 deleted the refactor/condo/DOMA-6931/refactor-news-sending branch March 29, 2024 11:23

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

refactor(condo): DOMA-6931 refactored news sending #4501

refactor(condo): DOMA-6931 refactored news sending #4501

Alllex202 commented Mar 21, 2024 •

edited

toplenboren Mar 21, 2024

Alllex202 Mar 21, 2024

Alllex202 Mar 21, 2024

toplenboren Mar 22, 2024

Alllex202 Mar 22, 2024

Alllex202 Mar 22, 2024 •

edited

toplenboren Mar 22, 2024

Alllex202 Mar 22, 2024

toplenboren Mar 21, 2024

toplenboren Mar 21, 2024

toplenboren Mar 21, 2024

toplenboren Mar 21, 2024

Alllex202 Mar 22, 2024

Alllex202 Mar 22, 2024

toplenboren Mar 21, 2024

Alllex202 Mar 22, 2024

nomerdvadcatpyat Mar 27, 2024

sonarcloud bot commented Mar 28, 2024

	describe('should be auto-calculate', () => {
	describe('should be auto-calculated', () => {

		@@ -136,10 +136,40 @@ const NewsItem = new GQLListSchema('NewsItem', {
		},

		sendAt: {

refactor(condo): DOMA-6931 refactored news sending #4501

refactor(condo): DOMA-6931 refactored news sending #4501

Conversation

Alllex202 commented Mar 21, 2024 • edited

what's going on here?

changes in the NewsItem schema:

changes in tasks

changes in accesses

Other

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Alllex202 Mar 22, 2024 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sonarcloud bot commented Mar 28, 2024

Quality Gate passed

Alllex202 commented Mar 21, 2024 •

edited

changes in the `NewsItem` schema:

Alllex202 Mar 22, 2024 •

edited