fix(condo): DOMA-6453 The publishedAt field was added (#3493)

* fix(condo): DOMA-6453 The `publishedAt` field was added

Also throw an error on trying to publish news item without any scopes

* fix(condo): DOMA-6453 Fix roles permissions according to requirements

Author: AleX83Xpert

apps/condo/domains/news/constants/errors.js

@@ -5,6 +5,7 @@ const EDIT_DENIED_ALREADY_SENT = 'EDIT_DENIED_ALREADY_SENT'
 const EDIT_DENIED_PUBLISHED = 'EDIT_DENIED_PUBLISHED'
 const PROFANITY_DETECTED_MOT_ERF_KER = 'PROFANITY_DETECTED_MOT_ERF_KER'
 const WRONG_SEND_DATE = 'WRONG_SEND_DATE'
+const NO_NEWS_ITEM_SCOPES = 'NO_NEWS_ITEM_SCOPES'
 
 module.exports = {
     EMPTY_VALID_BEFORE_DATE,
@@ -14,4 +15,5 @@ module.exports = {
     EDIT_DENIED_PUBLISHED,
     PROFANITY_DETECTED_MOT_ERF_KER,
     WRONG_SEND_DATE,
+    NO_NEWS_ITEM_SCOPES,
 }

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 ${COMMON_FIELDS} }`
+const NEWS_ITEM_FIELDS = `{ organization { id } number title body type validBefore sendAt sentAt isPublished publishedAt ${COMMON_FIELDS} }`
 const NewsItem = generateGqlQueries('NewsItem', NEWS_ITEM_FIELDS)
 
 const NEWS_ITEM_SCOPE_FIELDS = `{ type newsItem { id organization { id } number isPublished } property { id address addressMeta { ${ADDRESS_META_SUBFIELDS_TABLE_LIST} } } unitType unitName ${COMMON_FIELDS} }`

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

@@ -22,9 +22,11 @@ const {
     EDIT_DENIED_PUBLISHED,
     PROFANITY_DETECTED_MOT_ERF_KER,
     WRONG_SEND_DATE,
+    NO_NEWS_ITEM_SCOPES,
 } = require('@condo/domains/news/constants/errors')
 const { NEWS_TYPES, NEWS_TYPE_EMERGENCY, NEWS_TYPE_COMMON } = require('@condo/domains/news/constants/newsTypes')
 const { notifyResidentsAboutNewsItem } = require('@condo/domains/news/tasks')
+const { NewsItemScope } = require('@condo/domains/news/utils/serverSchema')
 
 const badWords = new BadWordsNext()
 badWords.add(badWordsRu)
@@ -72,6 +74,12 @@ const ERRORS = {
         message: 'Wrong send date',
         messageForUser: 'api.newsItem.WRONG_SEND_DATE',
     },
+    NO_NEWS_ITEM_SCOPES: {
+        code: BAD_USER_INPUT,
+        type: NO_NEWS_ITEM_SCOPES,
+        message: 'The news item without scopes publishing is forbidden',
+        messageForUser: 'api.newsItem.NO_NEWS_ITEM_SCOPES',
+    },
 }
 
 const readOnlyFieldsWhenPublished = ['organization', 'title', 'body', 'type', 'sendAt']
@@ -138,7 +146,7 @@ const NewsItem = new GQLListSchema('NewsItem', {
         },
 
         sentAt: {
-            schemaDoc: 'The date when newsItem was sent to residents',
+            schemaDoc: 'The date when newsItem was sent to residents. This is an internal field used to detect was the message has already been sent or not.',
             type: 'DateTimeUtc',
         },
 
@@ -148,6 +156,21 @@ const NewsItem = new GQLListSchema('NewsItem', {
             defaultValue: false,
         },
 
+        publishedAt: {
+            schemaDoc: 'The date when the news item was published. It is an auto-Calculated field.',
+            type: 'DateTimeUtc',
+            hooks: {
+                resolveInput: ({ resolvedData, fieldPath }) => (
+                    resolvedData['isPublished'] ? dayjs().toISOString() : resolvedData[fieldPath]
+                ),
+            },
+            access: {
+                read: true,
+                create: false,
+                update: false,
+            },
+        },
+
     },
     hooks: {
         resolveInput: async (args) => {
@@ -166,11 +189,18 @@ const NewsItem = new GQLListSchema('NewsItem', {
 
             const sendAt = get(resolvedData, 'sendAt')
             const sentAt = get(existingItem, 'sentAt')
-            const validBefore = get(resolvedData, 'validBefore')
             const resultSendAt = get(resultItemData, 'sendAt')
             const resultValidBefore = get(resultItemData, 'validBefore')
             const isPublished = get(existingItem, 'isPublished')
             const type = get(resultItemData, 'type')
+            const resolvedIsPublished = get(resolvedData, 'isPublished')
+
+            if (resolvedIsPublished) {
+                const scopesCount = existingItem ? await NewsItemScope.count(context, { newsItem: { id: existingItem.id } }) : 0
+                if (scopesCount === 0) {
+                    throw new GQLError(ERRORS.NO_NEWS_ITEM_SCOPES, context)
+                }
+            }
 
             if (operation === 'update') {
                 if (sentAt) {

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

@@ -18,6 +18,7 @@ const {
     expectToThrowAuthenticationErrorToObjects,
     expectToThrowAccessDeniedErrorToObj,
     expectToThrowAccessDeniedToFieldError,
+    catchErrorFrom,
 } = require('@open-condo/keystone/test.utils')
 
 const { SENDING_DELAY_SEC } = require('@condo/domains/news/constants/common')
@@ -153,6 +154,16 @@ describe('NewsItems', () => {
                 expect(obj13.number).toEqual(3)
                 expect(obj21.number).toEqual(1)
             })
+
+            test('The publishedAt field must be not empty after publishing', async () => {
+                const [newsItem] = await createTestNewsItem(adminClient, dummyO10n)
+                await createTestNewsItemScope(adminClient, newsItem)
+
+                const [newsItemPublished] = await publishTestNewsItem(adminClient, newsItem.id)
+
+                expect(newsItem.publishedAt).toBeNull()
+                expect(newsItemPublished.publishedAt).not.toBeNull()
+            })
         })
 
         describe('update', () => {
@@ -238,6 +249,7 @@ describe('NewsItems', () => {
 
             test('user can successfully un-publish news item', async () => {
                 const [objCreated] = await createTestNewsItem(adminClient, dummyO10n)
+                await createTestNewsItemScope(adminClient, objCreated)
                 await publishTestNewsItem(adminClient, objCreated.id)
                 const [objUnpublished] = await updateTestNewsItem(adminClient, objCreated.id, { isPublished: false })
 
@@ -811,7 +823,9 @@ describe('NewsItems', () => {
         })
 
         test('must throw an error on trying to edit the published news item', async () => {
-            const [sentNewsItem] = await createTestNewsItem(adminClient, dummyO10n, { isPublished: true })
+            const [sentNewsItem] = await createTestNewsItem(adminClient, dummyO10n)
+            await createTestNewsItemScope(adminClient, sentNewsItem)
+            await publishTestNewsItem(adminClient, sentNewsItem.id)
             await expectToThrowGQLError(
                 async () => await updateTestNewsItem(adminClient, sentNewsItem.id, { title: faker.lorem.words(3) }),
                 {
@@ -867,6 +881,26 @@ describe('NewsItems', () => {
                 },
             )
         })
+
+        test('must throw an error on trying to publish news item without scopes', async () => {
+            const errorFieldsToCheck = {
+                code: 'BAD_USER_INPUT',
+                type: 'NO_NEWS_ITEM_SCOPES',
+                message: 'The news item without scopes publishing is forbidden',
+                messageForUser: 'api.newsItem.NO_NEWS_ITEM_SCOPES',
+            }
+
+            await expectToThrowGQLError(
+                async () => await createTestNewsItem(adminClient, dummyO10n, { isPublished: true }),
+                errorFieldsToCheck,
+            )
+
+            const [newsItem] = await createTestNewsItem(adminClient, dummyO10n)
+            await expectToThrowGQLError(
+                async () => await publishTestNewsItem(adminClient, newsItem.id),
+                errorFieldsToCheck,
+            )
+        })
     })
 
     describe('Delayed news items', () => {
@@ -1013,5 +1047,28 @@ describe('NewsItems', () => {
             }, { delay: (SENDING_DELAY_SEC + 3) * 1000 })
         })
     })
+
+    describe('access', () => {
+        test('error on trying to edit publishedAt field', async () => {
+            const [newsItem] = await createTestNewsItem(adminClient, dummyO10n)
+            await createTestNewsItemScope(adminClient, newsItem)
+            await catchErrorFrom(
+                async () => await updateTestNewsItem(adminClient, newsItem.id, { publishedAt: dayjs().toISOString() }),
+                (caught) => {
+                    expect(caught).toMatchObject({
+                        name: 'TestClientResponseError',
+                        message: expect.stringContaining('Test client caught GraphQL response with not empty errors body!'),
+                        errors: expect.arrayContaining([
+                            expect.objectContaining({
+                                name: 'UserInputError',
+                                message: expect.stringContaining('Field "publishedAt" is not defined by type "NewsItemUpdateInput"'),
+                                extensions: expect.objectContaining({ code: 'BAD_USER_INPUT' }),
+                            }),
+                        ]),
+                    })
+                },
+            )
+        })
+    })
 })
 

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

@@ -27,6 +27,8 @@ const {
     createTestNewsItemScope,
     updateTestNewsItemScope,
     createTestNewsItem,
+    publishTestNewsItem,
+    updateTestNewsItem,
 } = require('@condo/domains/news/utils/testSchema')
 const {
     createTestOrganizationEmployeeRole,
@@ -284,7 +286,9 @@ describe('NewsItemScope', () => {
         })
 
         test('must throw an error on trying to create/edit scope for published news item', async () => {
-            const [newsItem] = await createTestNewsItem(adminClient, dummyO10n, { isPublished: true })
+            const [newsItem] = await createTestNewsItem(adminClient, dummyO10n)
+            await createTestNewsItemScope(adminClient, newsItem)
+            await publishTestNewsItem(adminClient, newsItem.id)
 
             await expectToThrowGQLError(
                 async () => await createTestNewsItemScope(adminClient, newsItem, { property: { connect: { id: dummyProperty.id } } }),
@@ -298,10 +302,12 @@ describe('NewsItemScope', () => {
         })
 
         test('must throw an error on trying to create/edit scope for sent news item', async () => {
-            const [newsItem] = await createTestNewsItem(adminClient, dummyO10n, {
-                isPublished: true,
-                sentAt: dayjs().toISOString(),
-            })
+            const [newsItem] = await createTestNewsItem(adminClient, dummyO10n)
+            await createTestNewsItemScope(adminClient, newsItem)
+            await publishTestNewsItem(adminClient, newsItem.id)
+
+            // Emulate sending
+            await updateTestNewsItem(adminClient, newsItem.id, { sentAt: dayjs().toISOString() })
 
             await expectToThrowGQLError(
                 async () => await createTestNewsItemScope(adminClient, newsItem, { property: { connect: { id: dummyProperty.id } } }),

apps/condo/domains/organization/constants/common.js

@@ -83,8 +83,6 @@ const DEFAULT_ROLES = {
         'canManageBankTransactions': false,
         'canManageBankAccountReports': false,
         'ticketVisibilityType': PROPERTY_TICKET_VISIBILITY,
-        'canManageNewsItems': true,
-        'canManageNewsItemTemplates': true,
     },
     'Manager': {
         'name': 'employee.role.Manager.name',

apps/condo/lang/en/en.json

@@ -1716,6 +1716,7 @@
   "api.newsItem.VALIDITY_DATE_LESS_THAN_SEND_DATE": "The validity date is less than send date",
   "api.newsItem.PROFANITY_DETECTED_MOT_ERF_KER": "Profanity detected",
   "api.newsItem.WRONG_SEND_DATE": "Wrong send date",
+  "api.newsItem.NO_NEWS_ITEM_SCOPES": "Scope-less news item publishing is forbidden",
   "api.ticket.QUALITY_CONTROL_ADDITIONAL_OPTION_DOES_NOT_MATCH_QUALITY_CONTROL_VALUE": "Additional quality control parameters must match the specified scoring",
   "api.ticket.QUALITY_CONTROL_VALUE_MUST_BE_SPECIFIED": "When specifying a comment or additional evaluation parameters, you must specify the evaluation itself",
   "api.billing.sendNewReceiptMessagesToResidentScopes.INVALID_PERIOD_PROVIDED": "Please provide proper period not before start of previous and not later than start of current month, valid format is YYYY-MM-DD",

apps/condo/lang/ru/ru.json

@@ -1716,6 +1716,7 @@
   "api.newsItem.VALIDITY_DATE_LESS_THAN_SEND_DATE": "Дата актуальности меньше чем дата отправки",
   "api.newsItem.PROFANITY_DETECTED_MOT_ERF_KER": "Обнаружена ненормативная лексика",
   "api.newsItem.WRONG_SEND_DATE": "Неверная дата отправки",
+  "api.newsItem.NO_NEWS_ITEM_SCOPES": "Нельзя публиковать новость без получателей",
   "api.ticket.QUALITY_CONTROL_ADDITIONAL_OPTION_DOES_NOT_MATCH_QUALITY_CONTROL_VALUE": "Дополнительные параметры контроля качества должны соответсоввать указанной оценке",
   "api.ticket.QUALITY_CONTROL_VALUE_MUST_BE_SPECIFIED": "При указании комментария или дополнительных параметров оценки нужно указать саму оценку",
   "api.billing.sendNewReceiptMessagesToResidentScopes.INVALID_PERIOD_PROVIDED": "Необходимо передать период не ранее начала прошлого месяца и не позднее начала текущего месяца, валидный формат - YYYY-MM-DD",

apps/condo/migrations/20230622093945-0287_newsitem_publishedat_and_more.js

@@ -0,0 +1,51 @@
+// auto generated by kmigrator
+// KMIGRATOR:0287_newsitem_publishedat_and_more:IyBHZW5lcmF0ZWQgYnkgRGphbmdvIDQuMC4xIG9uIDIwMjMtMDYtMjIgMDQ6MzkKCmZyb20gZGphbmdvLmRiIGltcG9ydCBtaWdyYXRpb25zLCBtb2RlbHMKCgpjbGFzcyBNaWdyYXRpb24obWlncmF0aW9ucy5NaWdyYXRpb24pOgoKICAgIGRlcGVuZGVuY2llcyA9IFsKICAgICAgICAoJ19kamFuZ29fc2NoZW1hJywgJzAyODZfbmV3c2l0ZW1zY29wZV90eXBlX25ld3NpdGVtc2NvcGVoaXN0b3J5cmVjb3JkX3R5cGUnKSwKICAgIF0KCiAgICBvcGVyYXRpb25zID0gWwogICAgICAgIG1pZ3JhdGlvbnMuQWRkRmllbGQoCiAgICAgICAgICAgIG1vZGVsX25hbWU9J25ld3NpdGVtJywKICAgICAgICAgICAgbmFtZT0ncHVibGlzaGVkQXQnLAogICAgICAgICAgICBmaWVsZD1tb2RlbHMuRGF0ZVRpbWVGaWVsZChibGFuaz1UcnVlLCBudWxsPVRydWUpLAogICAgICAgICksCiAgICAgICAgbWlncmF0aW9ucy5BZGRGaWVsZCgKICAgICAgICAgICAgbW9kZWxfbmFtZT0nbmV3c2l0ZW1oaXN0b3J5cmVjb3JkJywKICAgICAgICAgICAgbmFtZT0ncHVibGlzaGVkQXQnLAogICAgICAgICAgICBmaWVsZD1tb2RlbHMuRGF0ZVRpbWVGaWVsZChibGFuaz1UcnVlLCBudWxsPVRydWUpLAogICAgICAgICksCiAgICBdCg==
+
+exports.up = async (knex) => {
+    await knex.raw(`
+    BEGIN;
+--
+-- Add field publishedAt to newsitem
+--
+ALTER TABLE "NewsItem" ADD COLUMN "publishedAt" timestamp with time zone NULL;
+
+
+
+----- MANUAL
+update "NewsItem" set "publishedAt"="NewsItem"."updatedAt" where "isPublished"=true and "publishedAt" is null;
+
+UPDATE "OrganizationEmployeeRole"
+SET "canManageOrganizationNews" = false
+WHERE "name" in ('employee.role.Dispatcher.name');
+
+UPDATE "OrganizationEmployeeRole"
+SET "canManageNewsItemTemplates" = false
+WHERE "name" in ('employee.role.Dispatcher.name');
+-----
+
+
+
+--
+-- Add field publishedAt to newsitemhistoryrecord
+--
+ALTER TABLE "NewsItemHistoryRecord" ADD COLUMN "publishedAt" timestamp with time zone NULL;
+COMMIT;
+
+    `)
+}
+
+exports.down = async (knex) => {
+    await knex.raw(`
+    BEGIN;
+--
+-- Add field publishedAt to newsitemhistoryrecord
+--
+ALTER TABLE "NewsItemHistoryRecord" DROP COLUMN "publishedAt" CASCADE;
+--
+-- Add field publishedAt to newsitem
+--
+ALTER TABLE "NewsItem" DROP COLUMN "publishedAt" CASCADE;
+COMMIT;
+
+    `)
+}