feat(condo): DOMA-9613: Add recipients counter to cross-posting integrations #5026

toplenboren · 2024-07-28T21:05:27Z

Add recipients counter to cross-posting integrations

Context

Context: we want to add ability to check out number of recipients before you send cross-posted news item.

Solution

I've implemented custom query that allows our partners to give their users this data. This is not a final solution, as details and architecture may be changed, (thus it is Proof of work)

How it works

Our partner / Open source contributor / 3rd party wants to share news to his platform of choice using Condo as UI and Backend. They already have integration working (Info on newsSharing is outside of the scope of this PR)
Our partner wants to give their users number of subscribers (recipients) so that users knows how many people will get his message

To do this they implement POST method called customGetRecipientsCounters (or whatever they want to call it) and put a url link to service that expose this API to newsSharingConfig

Example url: https://my-news-sharing-api/getNewsInfo

We expect that this method accepts this data:

{
  organization: {
      tin: string,
      id: string,
      name: string,
  },
  
  scopes: [{
      property: string,
      unitName: string,
      unitType: string,
  }]

  properties: [{
      id: string,
      address: string,
      addressMeta: addressMeta (JSON),
  }]
}

Condo expects output in this format:

{
  receiversCount: number
}

Note:

This method is created to support only advanced usecases with custom UI and custom Scopes logic. Integrations that do not require custom UI + custom Scopes logic (such as Telegram / Viber) would not require this logic.

More simple solution will be introduced later this year

Bonus

Sometimes you do not want preview to be shown, for example when your app does not have any preview (maybe internal system?)

Sometimes you do not want to show preview for push messages. For example, if your app sends push messages ONLY for emergency news items

I've introduced a setting in newsSharingConfig that covers this usecase

Alllex202 · 2024-07-29T08:16:05Z

apps/condo/domains/news/access/GetNewsSharingRecipientsCountersService.js

+    if (user.isAdmin || user.isSupport) return true
+
+    const b2bContext = await getById('B2BAppContext', b2bAppContextId)
+    if (!b2bContext) return false


Should check status and deletedAt

apps/condo/domains/news/access/GetNewsSharingRecipientsCountersService.js

apps/condo/domains/news/components/NewsForm/NewsItemSharingForm.tsx

Alllex202 · 2024-07-29T16:07:11Z

This method is created to support only advanced usecases with custom UI and custom Scopes logic. Integrations that do not require custom UI + custom Scopes logic (such as Telegram / Viber) would not require this logic.

For messengers (telegram/viber), you can use number of group members as number of recipients

apps/condo/domains/miniapp/gql.js

apps/condo/domains/miniapp/schema/B2BAppNewsSharingConfig.js

pahaz · 2024-08-02T05:37:15Z

apps/condo/domains/miniapp/schema/B2BAppNewsSharingConfig.js

            type: 'File',
            isRequired: false,
            adapter: NEWS_SHARING_FILE_ADAPTER,
        },

+        pushNotificationSettings: {
+            schemaDoc: 'Push notification settings',


Suggested change

schemaDoc: 'Push notification settings',

schemaDoc: 'Push notification preferences for each B2BApp. The available options include: notifications are sent only for emergency alerts, all notifications are turned off, or all notifications are enabled',

apps/condo/domains/miniapp/schema/B2BAppNewsSharingConfig.js

apps/condo/domains/miniapp/schema/B2BAppNewsSharingConfig.test.js

apps/condo/domains/news/components/RecipientCounter.tsx

pahaz · 2024-08-02T05:51:27Z

apps/condo/domains/news/components/RecipientCounter.tsx

+
+    return (
+        <RecipientCounterContainer
+            title={<>{MailingMessage}<Typography.Text strong>{buildMessageFromNewsItemScopes(newsItemScopes, intl)}</Typography.Text></>}


it looks hacky. is it possible to move inise RecipientCounterContainer or create a special component?

I do not see this as hacky, I think codebase would be more complex if I put this stuff inside component

At least not before we implement Telegram :-)

nomerdvadcatpyat

You need to remove duplicated migration and update migration number

nomerdvadcatpyat · 2024-08-09T09:16:11Z

apps/condo/domains/news/components/NewsForm/NewsItemSharingForm.tsx

+import { NewsItemSharingCustomRecipientCounter } from '../RecipientCounter'
+import { NewsItemScopeNoInstanceType } from '../types'


use absolute imports

nomerdvadcatpyat · 2024-08-09T09:16:31Z

apps/condo/domains/news/components/RecipientCounter.tsx

-import { TNewsItemScopeNoInstance, TUnit } from './types'
+import { NewsItemScopeNoInstanceType, TUnit } from './types'
+
+import { Loader } from '../../common/components/Loader'


nomerdvadcatpyat · 2024-08-09T09:17:19Z

apps/condo/domains/news/components/RecipientCounter.tsx

+        {
+            onCompleted: (data) => {
+                console.log(data)
+                console.log(get(data, ['result', 'receiversCount']))


remove console.log

nomerdvadcatpyat · 2024-08-09T09:19:08Z

...tions/20240729010950-0413_b2bappnewssharingconfig_customgetrecipientscountersurl_and_more.js

@@ -0,0 +1,59 @@
+// auto generated by kmigrator
+// KMIGRATOR:0413_b2bappnewssharingconfig_customgetrecipientscountersurl_and_more:IyBHZW5lcmF0ZWQgYnkgRGphbmdvIDQuMi4xIG9uIDIwMjQtMDctMjggMjA6MTAKCmZyb20gZGphbmdvLmRiIGltcG9ydCBtaWdyYXRpb25zLCBtb2RlbHMKCgpjbGFzcyBNaWdyYXRpb24obWlncmF0aW9ucy5NaWdyYXRpb24pOgoKICAgIGRlcGVuZGVuY2llcyA9IFsKICAgICAgICAoJ19kamFuZ29fc2NoZW1hJywgJzA0MTJfbWFya2V0c2V0dGluZ2hpc3RvcnlyZWNvcmRfYW5kX21vcmUnKSwKICAgIF0KCiAgICBvcGVyYXRpb25zID0gWwogICAgICAgIG1pZ3JhdGlvbnMuQWRkRmllbGQoCiAgICAgICAgICAgIG1vZGVsX25hbWU9J2IyYmFwcG5ld3NzaGFyaW5nY29uZmlnJywKICAgICAgICAgICAgbmFtZT0nY3VzdG9tR2V0UmVjaXBpZW50c0NvdW50ZXJzVXJsJywKICAgICAgICAgICAgZmllbGQ9bW9kZWxzLlRleHRGaWVsZChibGFuaz1UcnVlLCBudWxsPVRydWUpLAogICAgICAgICksCiAgICAgICAgbWlncmF0aW9ucy5BZGRGaWVsZCgKICAgICAgICAgICAgbW9kZWxfbmFtZT0nYjJiYXBwbmV3c3NoYXJpbmdjb25maWcnLAogICAgICAgICAgICBuYW1lPSdwdXNoTm90aWZpY2F0aW9uU2V0dGluZ3MnLAogICAgICAgICAgICBmaWVsZD1tb2RlbHMuQ2hhckZpZWxkKGNob2ljZXM9WygnT05MWV9FTUVSR0VOQ1knLCAnT05MWV9FTUVSR0VOQ1knKSwgKCdFTkFCTEVEJywgJ0VOQUJMRUQnKSwgKCdESVNBQkxFRCcsICdESVNBQkxFRCcpXSwgZGVmYXVsdD0nRElTQUJMRUQnLCBtYXhfbGVuZ3RoPTUwKSwKICAgICAgICAgICAgcHJlc2VydmVfZGVmYXVsdD1GYWxzZSwKICAgICAgICApLAogICAgICAgIG1pZ3JhdGlvbnMuQWRkRmllbGQoCiAgICAgICAgICAgIG1vZGVsX25hbWU9J2IyYmFwcG5ld3NzaGFyaW5nY29uZmlnaGlzdG9yeXJlY29yZCcsCiAgICAgICAgICAgIG5hbWU9J2N1c3RvbUdldFJlY2lwaWVudHNDb3VudGVyc1VybCcsCiAgICAgICAgICAgIGZpZWxkPW1vZGVscy5UZXh0RmllbGQoYmxhbms9VHJ1ZSwgbnVsbD1UcnVlKSwKICAgICAgICApLAogICAgICAgIG1pZ3JhdGlvbnMuQWRkRmllbGQoCiAgICAgICAgICAgIG1vZGVsX25hbWU9J2IyYmFwcG5ld3NzaGFyaW5nY29uZmlnaGlzdG9yeXJlY29yZCcsCiAgICAgICAgICAgIG5hbWU9J3B1c2hOb3RpZmljYXRpb25TZXR0aW5ncycsCiAgICAgICAgICAgIGZpZWxkPW1vZGVscy5UZXh0RmllbGQoYmxhbms9VHJ1ZSwgbnVsbD1UcnVlKSwKICAgICAgICApLAogICAgICAgIG1pZ3JhdGlvbnMuQWx0ZXJGaWVsZCgKICAgICAgICAgICAgbW9kZWxfbmFtZT0nYjJiYXBwbmV3c3NoYXJpbmdjb25maWcnLAogICAgICAgICAgICBuYW1lPSdnZXRSZWNpcGllbnRzVXJsJywKICAgICAgICAgICAgZmllbGQ9bW9kZWxzLlRleHRGaWVsZChibGFuaz1UcnVlLCBudWxsPVRydWUpLAogICAgICAgICksCiAgICBdCg==


you need to rebase and regenerate migration to update it's number

nomerdvadcatpyat · 2024-08-09T09:20:36Z

...tions/20240729173935-0414_b2bappnewssharingconfig_customgetrecipientscountersurl_and_more.js

+// auto generated by kmigrator
+// KMIGRATOR:0414_b2bappnewssharingconfig_customgetrecipientscountersurl_and_more:IyBHZW5lcmF0ZWQgYnkgRGphbmdvIDQuMi4xIG9uIDIwMjQtMDctMjkgMTI6MzkKCmZyb20gZGphbmdvLmRiIGltcG9ydCBtaWdyYXRpb25zLCBtb2RlbHMKCgpjbGFzcyBNaWdyYXRpb24obWlncmF0aW9ucy5NaWdyYXRpb24pOgoKICAgIGRlcGVuZGVuY2llcyA9IFsKICAgICAgICAoJ19kamFuZ29fc2NoZW1hJywgJzA0MTNfdXNlcnJpZ2h0c3NldF9jYW5yZWFkbWVzc2FnZXNfYW5kX21vcmUnKSwKICAgIF0KCiAgICBvcGVyYXRpb25zID0gWwogICAgICAgIG1pZ3JhdGlvbnMuQWRkRmllbGQoCiAgICAgICAgICAgIG1vZGVsX25hbWU9J2IyYmFwcG5ld3NzaGFyaW5nY29uZmlnJywKICAgICAgICAgICAgbmFtZT0nY3VzdG9tR2V0UmVjaXBpZW50c0NvdW50ZXJzVXJsJywKICAgICAgICAgICAgZmllbGQ9bW9kZWxzLlRleHRGaWVsZChibGFuaz1UcnVlLCBudWxsPVRydWUpLAogICAgICAgICksCiAgICAgICAgbWlncmF0aW9ucy5BZGRGaWVsZCgKICAgICAgICAgICAgbW9kZWxfbmFtZT0nYjJiYXBwbmV3c3NoYXJpbmdjb25maWcnLAogICAgICAgICAgICBuYW1lPSdwdXNoTm90aWZpY2F0aW9uU2V0dGluZ3MnLAogICAgICAgICAgICBmaWVsZD1tb2RlbHMuQ2hhckZpZWxkKGNob2ljZXM9WygnT05MWV9FTUVSR0VOQ1knLCAnT05MWV9FTUVSR0VOQ1knKSwgKCdFTkFCTEVEJywgJ0VOQUJMRUQnKSwgKCdESVNBQkxFRCcsICdESVNBQkxFRCcpXSwgZGVmYXVsdD0nRElTQUJMRUQnLCBtYXhfbGVuZ3RoPTUwKSwKICAgICAgICAgICAgcHJlc2VydmVfZGVmYXVsdD1GYWxzZSwKICAgICAgICApLAogICAgICAgIG1pZ3JhdGlvbnMuQWRkRmllbGQoCiAgICAgICAgICAgIG1vZGVsX25hbWU9J2IyYmFwcG5ld3NzaGFyaW5nY29uZmlnaGlzdG9yeXJlY29yZCcsCiAgICAgICAgICAgIG5hbWU9J2N1c3RvbUdldFJlY2lwaWVudHNDb3VudGVyc1VybCcsCiAgICAgICAgICAgIGZpZWxkPW1vZGVscy5UZXh0RmllbGQoYmxhbms9VHJ1ZSwgbnVsbD1UcnVlKSwKICAgICAgICApLAogICAgICAgIG1pZ3JhdGlvbnMuQWRkRmllbGQoCiAgICAgICAgICAgIG1vZGVsX25hbWU9J2IyYmFwcG5ld3NzaGFyaW5nY29uZmlnaGlzdG9yeXJlY29yZCcsCiAgICAgICAgICAgIG5hbWU9J3B1c2hOb3RpZmljYXRpb25TZXR0aW5ncycsCiAgICAgICAgICAgIGZpZWxkPW1vZGVscy5UZXh0RmllbGQoYmxhbms9VHJ1ZSwgbnVsbD1UcnVlKSwKICAgICAgICApLAogICAgICAgIG1pZ3JhdGlvbnMuQWx0ZXJGaWVsZCgKICAgICAgICAgICAgbW9kZWxfbmFtZT0nYjJiYXBwbmV3c3NoYXJpbmdjb25maWcnLAogICAgICAgICAgICBuYW1lPSdnZXRSZWNpcGllbnRzVXJsJywKICAgICAgICAgICAgZmllbGQ9bW9kZWxzLlRleHRGaWVsZChibGFuaz1UcnVlLCBudWxsPVRydWUpLAogICAgICAgICksCiAgICBdCg==
+
+exports.up = async (knex) => {


Same migration as above. You need to remove it

apps/condo/domains/news/components/RecipientCounter.tsx

toplenboren · 2024-08-05T12:11:14Z

apps/condo/domains/news/components/RecipientCounter.tsx

+
+    return (
+        <RecipientCounterContainer
+            title={<>{MailingMessage}<Typography.Text strong>{buildMessageFromNewsItemScopes(newsItemScopes, intl)}</Typography.Text></>}


I do not see this as hacky, I think codebase would be more complex if I put this stuff inside component

toplenboren · 2024-08-05T12:11:38Z

apps/condo/domains/news/components/RecipientCounter.tsx

+
+    return (
+        <RecipientCounterContainer
+            title={<>{MailingMessage}<Typography.Text strong>{buildMessageFromNewsItemScopes(newsItemScopes, intl)}</Typography.Text></>}


At least not before we implement Telegram :-)

apps/condo/domains/miniapp/schema/B2BAppNewsSharingConfig.js

apps/condo/domains/miniapp/gql.js

apps/condo/domains/miniapp/schema/B2BAppNewsSharingConfig.js

… news items using custom query

sonarcloud · 2024-08-12T11:36:24Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

sonarcloud · 2024-08-12T12:29:59Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarCloud

toplenboren temporarily deployed to internal July 28, 2024 21:05 — with GitHub Actions Inactive

toplenboren temporarily deployed to internal July 28, 2024 21:43 — with GitHub Actions Inactive

toplenboren temporarily deployed to internal July 28, 2024 23:13 — with GitHub Actions Inactive

toplenboren temporarily deployed to internal July 29, 2024 07:57 — with GitHub Actions Inactive

Alllex202 reviewed Jul 29, 2024

View reviewed changes

apps/condo/domains/news/access/GetNewsSharingRecipientsCountersService.js Show resolved Hide resolved

Alllex202 reviewed Jul 29, 2024

View reviewed changes

apps/condo/domains/news/components/NewsForm/NewsItemSharingForm.tsx Outdated Show resolved Hide resolved

toplenboren temporarily deployed to internal July 29, 2024 11:04 — with GitHub Actions Inactive

toplenboren temporarily deployed to internal July 29, 2024 12:28 — with GitHub Actions Inactive

toplenboren force-pushed the toplenboren-support-news-sharing-counter-lite branch from e4e0045 to 18d7112 Compare July 29, 2024 12:45

toplenboren temporarily deployed to internal July 29, 2024 12:46 — with GitHub Actions Inactive

toplenboren temporarily deployed to internal July 30, 2024 13:05 — with GitHub Actions Inactive