Eagle Eye 2.0

.github/workflows/lint-frontend.yml

@@ -13,8 +13,5 @@ jobs:
         uses: actions/checkout@v2
 
       - name: Lint code
-        uses: reviewdog/action-eslint@v1
-        with:
-          reporter: github-pr-review
-          fail_on_error: true
-          workdir: 'frontend/'
+        run: npm i && npm run lint
+        working-directory: frontend

backend/.env.dist.local

@@ -133,4 +133,8 @@ CROWD_QDRANT_PORT=6333
 
 # Enrichment settings
 CROWD_ENRICHMENT_URL=
-CROWD_ENRICHMENT_API_KEY=
+CROWD_ENRICHMENT_API_KEY=
+
+# EagleEye settings
+CROWD_EAGLE_EYE_URL=
+CROWD_EAGLE_EYE_API_KEY=

backend/config/custom-environment-variables.json

@@ -94,6 +94,7 @@
     "templateWeeklyAnalytics": "CROWD_SENDGRID_TEMPLATE_WEEKLY_ANALYTICS",
     "templateIntegrationDone": "CROWD_SENDGRID_TEMPLATE_INTEGRATION_DONE",
     "templateCsvExport": "CROWD_SENDGRID_TEMPLATE_CSV_EXPORT",
+    "templateEagleEyeDigest": "CROWD_SENDGRID_TEMPLATE_EAGLE_EYE_DIGEST",
     "weeklyAnalyticsUnsubscribeGroupId": "CROWD_SENDGRID_WEEKLY_ANALYTICS_UNSUBSCRIBE_GROUP_ID"
   },
   "plans": {
@@ -135,5 +136,9 @@
   "enrichment": {
     "url": "CROWD_ENRICHMENT_URL",
     "apiKey": "CROWD_ENRICHMENT_API_KEY"
+  },
+  "eagleEye": {
+    "url": "CROWD_EAGLE_EYE_URL",
+    "apiKey": "CROWD_EAGLE_EYE_API_KEY"
   }
 }

backend/config/default.json

@@ -34,5 +34,6 @@
     "maxRetrospectInSeconds": 3600
   },
   "github": {},
-  "enrichment": {}
+  "enrichment": {},
+  "eagleEye": {}
 }

backend/src/api/eagleEyeContent/eagleEyeActionCreate.ts

@@ -0,0 +1,11 @@
+import Permissions from '../../security/permissions'
+import EagleEyeActionService from '../../services/eagleEyeActionService'
+import PermissionChecker from '../../services/user/permissionChecker'
+
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeActionCreate)
+
+  const payload = await new EagleEyeActionService(req).create(req.body, req.params.contentId)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/eagleEyeContent/eagleEyeActionDestroy.ts

@@ -0,0 +1,11 @@
+import Permissions from '../../security/permissions'
+import EagleEyeActionService from '../../services/eagleEyeActionService'
+import PermissionChecker from '../../services/user/permissionChecker'
+
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeActionDestroy)
+
+  const payload = await new EagleEyeActionService(req).destroy(req.params.actionId)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/eagleEyeContent/eagleEyeContentList.ts → backend/src/api/eagleEyeContent/eagleEyeContentReply.ts

@@ -4,14 +4,18 @@ import EagleEyeContentService from '../../services/eagleEyeContentService'
 import PermissionChecker from '../../services/user/permissionChecker'
 
 export default async (req, res) => {
-  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeContentRead)
-  const payload = await new EagleEyeContentService(req).findAndCountAll(req.query)
+  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeActionCreate)
 
-  if (req.query.filter && Object.keys(req.query.filter).length > 0) {
-    const platforms = req.query.filter.platforms ? req.query.filter.platforms.split(',') : []
-    const nDays = req.query.filter.nDays
-    track('Eagle Eye Filter', { filter: req.query.filter, platforms, nDays }, { ...req })
-  }
+  const payload = await EagleEyeContentService.reply(req.query.title, req.query.description)
 
+  track(
+    'Eagle Eye reply generated',
+    {
+      title: req.query.title,
+      description: req.query.description,
+      reply: payload.reply,
+    },
+    { ...req },
+  )
   await req.responseHandler.success(req, res, payload)
 }

backend/src/api/eagleEyeContent/eagleEyeContentSearch.ts

@@ -4,11 +4,9 @@ import EagleEyeContentService from '../../services/eagleEyeContentService'
 import PermissionChecker from '../../services/user/permissionChecker'
 
 export default async (req, res) => {
-  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeContentSearch)
-
-  const payload = await new EagleEyeContentService(req).search(req.body)
-
-  track('EagleEyeSearch', { ...req.body }, { ...req })
+  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeActionCreate)
 
+  const payload = await new EagleEyeContentService(req).search()
+  track('EagleEye backend search', { ...req.body }, { ...req })
   await req.responseHandler.success(req, res, payload)
 }

backend/src/api/eagleEyeContent/eagleEyeContentTrack.ts

@@ -0,0 +1,99 @@
+import Permissions from '../../security/permissions'
+import PermissionChecker from '../../services/user/permissionChecker'
+import track from '../../segment/track'
+import Error404 from '../../errors/Error404'
+
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeContentRead)
+
+  const event = req.body.event
+  const params = req.body.params
+
+  switch (event) {
+    case 'postClicked':
+      console.log('Eagle Eye post clicked', {
+        url: params.url,
+        platform: params.platform,
+      })
+      track(
+        'Eagle Eye post clicked',
+        {
+          url: params.url,
+          platform: params.platform,
+        },
+        { ...req },
+      )
+      break
+    case 'generatedReply':
+      console.log('Eagle Eye AI reply generated', {
+        title: params.title,
+        description: params.description,
+        platform: params.platform,
+        reply: params.reply,
+        url: params.url,
+      })
+      track(
+        'Eagle Eye AI reply generated',
+        {
+          title: params.title,
+          description: params.description,
+          platform: params.platform,
+          reply: params.reply,
+          url: params.url,
+        },
+        { ...req },
+      )
+      break
+    case 'generatedReplyFeedback':
+      console.log('Eagle Eye AI reply feedback', {
+        type: params.type,
+        title: params.title,
+        description: params.description,
+        platform: params.platform,
+        reply: params.reply,
+        url: params.url,
+      })
+      track(
+        'Eagle Eye AI reply feedback',
+        {
+          type: params.type,
+          title: params.title,
+          description: params.description,
+          platform: params.platform,
+          reply: params.reply,
+          url: params.url,
+        },
+        { ...req },
+      )
+      break
+    case 'generatedReplyCopied':
+      console.log('Eagle Eye AI reply copied', {
+        title: params.title,
+        description: params.description,
+        platform: params.platform,
+        url: params.url,
+        reply: params.reply,
+      })
+      track(
+        'Eagle Eye AI reply copied',
+        {
+          title: params.title,
+          description: params.description,
+          platform: params.platform,
+          url: params.url,
+          reply: params.reply,
+        },
+        { ...req },
+      )
+      break
+
+    default:
+      throw new Error404('en', 'erros.eagleEye.invlaidEvent')
+  }
+
+  const out = {
+    Success: true,
+  }
+
+  await req.responseHandler.success(req, res, out)
+}

backend/src/api/eagleEyeContent/eagleEyeContentUpdate.ts → backend/src/api/eagleEyeContent/eagleEyeContentUpsert.ts

@@ -3,9 +3,9 @@ import EagleEyeContentService from '../../services/eagleEyeContentService'
 import PermissionChecker from '../../services/user/permissionChecker'
 
 export default async (req, res) => {
-  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeContentEdit)
+  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeContentCreate)
 
-  const payload = await new EagleEyeContentService(req).update(req.params.id, req.body)
+  const payload = await new EagleEyeContentService(req).upsert(req.body)
 
   await req.responseHandler.success(req, res, payload)
 }

backend/src/api/eagleEyeContent/eagleEyeSettingsUpdate.ts

@@ -0,0 +1,11 @@
+import Permissions from '../../security/permissions'
+import EagleEyeSettingsService from '../../services/eagleEyeSettingsService'
+import PermissionChecker from '../../services/user/permissionChecker'
+
+export default async (req, res) => {
+  new PermissionChecker(req).validateHas(Permissions.values.eagleEyeActionCreate)
+
+  const payload = await new EagleEyeSettingsService(req).update(req.body)
+
+  await req.responseHandler.success(req, res, payload)
+}

backend/src/api/eagleEyeContent/index.ts

@@ -1,21 +1,59 @@
 import { safeWrap } from '../../middlewares/errorMiddleware'
+import { featureFlagMiddleware } from '../../middlewares/featureFlagMiddleware'
+import { FeatureFlag } from '../../types/common'
 
 export default (app) => {
+  app.post(
+    `/tenant/:tenantId/eagleEyeContent/query`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeContentQuery').default),
+  )
+
   app.post(
     `/tenant/:tenantId/eagleEyeContent`,
-    safeWrap(require('./eagleEyeContentSearch').default),
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeContentUpsert').default),
   )
+
   app.post(
-    `/tenant/:tenantId/eagleEyeContent/query`,
-    safeWrap(require('./eagleEyeContentQuery').default),
+    `/tenant/:tenantId/eagleEyeContent/track`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeContentTrack').default),
   )
-  app.put(
-    `/tenant/:tenantId/eagleEyeContent/:id`,
-    safeWrap(require('./eagleEyeContentUpdate').default),
+
+  app.get(
+    `/tenant/:tenantId/eagleEyeContent/reply`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeContentReply').default),
   )
-  app.get(`/tenant/:tenantId/eagleEyeContent`, safeWrap(require('./eagleEyeContentList').default))
+
+  app.get(
+    `/tenant/:tenantId/eagleEyeContent/search`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeContentSearch').default),
+  )
+
   app.get(
     `/tenant/:tenantId/eagleEyeContent/:id`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
     safeWrap(require('./eagleEyeContentFind').default),
   )
+
+  app.post(
+    `/tenant/:tenantId/eagleEyeContent/:contentId/action`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeActionCreate').default),
+  )
+
+  app.put(
+    `/tenant/:tenantId/eagleEyeContent/settings`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeSettingsUpdate').default),
+  )
+
+  app.delete(
+    `/tenant/:tenantId/eagleEyeContent/:contentId/action/:actionId`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeActionDestroy').default),
+  )
 }

backend/src/bin/jobs/eagleEyeEmailDigestTicks.ts

@@ -0,0 +1,55 @@
+import { Op } from 'sequelize'
+import moment from 'moment'
+import SequelizeRepository from '../../database/repositories/sequelizeRepository'
+import { CrowdJob } from '../../types/jobTypes'
+import { sendNodeWorkerMessage } from '../../serverless/utils/nodeWorkerSQS'
+import { NodeWorkerMessageType } from '../../serverless/types/workerTypes'
+import { NodeWorkerMessageBase } from '../../types/mq/nodeWorkerMessageBase'
+
+const job: CrowdJob = {
+  name: 'Eagle Eye Email Digest Ticker',
+  // every half hour
+  cronTime: '*/30 * * * *',
+  onTrigger: async () => {
+    const options = await SequelizeRepository.getDefaultIRepositoryOptions()
+    const users = (
+      await options.database.user.findAll({
+        where: {
+          [Op.and]: [
+            {
+              'eagleEyeSettings.emailDigestActive': {
+                [Op.ne]: null,
+              },
+            },
+            {
+              'eagleEyeSettings.emailDigestActive': {
+                [Op.eq]: true,
+              },
+            },
+          ],
+        },
+        include: [
+          {
+            model: options.database.tenantUser,
+            as: 'tenants',
+          },
+        ],
+      })
+    ).filter(
+      (u) =>
+        u.eagleEyeSettings &&
+        u.eagleEyeSettings.emailDigestActive &&
+        moment() > moment(u.eagleEyeSettings.emailDigest.nextEmailAt),
+    )
+
+    for (const user of users) {
+      await sendNodeWorkerMessage(user.id, {
+        type: NodeWorkerMessageType.NODE_MICROSERVICE,
+        user: user.id,
+        service: 'eagle-eye-email-digest',
+      } as NodeWorkerMessageBase)
+    }
+  },
+}
+
+export default job

backend/src/bin/jobs/index.ts

@@ -5,6 +5,7 @@ import memberScoreCoordinator from './memberScoreCoordinator'
 import checkSqsQueues from './checkSqsQueues'
 import refreshMaterializedViews from './refreshMaterializedViews'
 import downgradeExpiredPlans from './downgradeExpiredPlans'
+import eagleEyeEmailDigestTicks from './eagleEyeEmailDigestTicks'
 
 const jobs: CrowdJob[] = [
   weeklyAnalyticsEmailsCoordinator,
@@ -13,6 +14,7 @@ const jobs: CrowdJob[] = [
   checkSqsQueues,
   refreshMaterializedViews,
   downgradeExpiredPlans,
+  eagleEyeEmailDigestTicks,
 ]
 
 export default jobs