EagleEye contents with actions

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

@@ -135,5 +135,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/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/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,47 @@
 import { safeWrap } from '../../middlewares/errorMiddleware'
+import { featureFlagMiddleware } from '../../middlewares/featureFlagMiddleware'
+import { FeatureFlag } from '../../types/common'
 
 export default (app) => {
-  app.post(
-    `/tenant/:tenantId/eagleEyeContent`,
-    safeWrap(require('./eagleEyeContentSearch').default),
-  )
   app.post(
     `/tenant/:tenantId/eagleEyeContent/query`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
     safeWrap(require('./eagleEyeContentQuery').default),
   )
-  app.put(
-    `/tenant/:tenantId/eagleEyeContent/:id`,
-    safeWrap(require('./eagleEyeContentUpdate').default),
+
+  app.post(
+    `/tenant/:tenantId/eagleEyeContent`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeContentUpsert').default),
+  )
+
+  app.get(
+    `/tenant/:tenantId/eagleEyeContent/search`,
+    featureFlagMiddleware(FeatureFlag.EAGLE_EYE, 'entities.eagleEye.errors.planLimitExceeded'),
+    safeWrap(require('./eagleEyeContentSearch').default),
   )
-  app.get(`/tenant/:tenantId/eagleEyeContent`, safeWrap(require('./eagleEyeContentList').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/config/configTypes.ts

@@ -179,3 +179,8 @@ export interface EnrichmentConfiguration {
   url: string
   apiKey: string
 }
+
+export interface EagleEyeConfiguration {
+  url: string
+  apiKey: string
+}

backend/src/config/index.ts

@@ -24,6 +24,7 @@ import {
   PosthogConfiguration,
   PizzlyConfiguration,
   EnrichmentConfiguration,
+  EagleEyeConfiguration,
 } from './configTypes'
 
 // TODO-kube
@@ -233,3 +234,10 @@ export const ENRICHMENT_CONFIG: EnrichmentConfiguration = KUBE_MODE
       url: process.env.ENRICHMENT_URL,
       apiKey: process.env.ENRICHMENT_SECRET_KEY,
     }
+
+export const EAGLE_EYE_CONFIG: EagleEyeConfiguration = KUBE_MODE
+  ? config.get<EagleEyeConfiguration>('eagleEye')
+  : {
+      url: process.env.EAGLE_EYE_URL,
+      apiKey: process.env.EAGLE_EYE_SECRET_KEY,
+    }

backend/src/database/migrations/U1675259471__eagleEyeActions.sql

@@ -0,0 +1,59 @@
+DROP TABLE IF EXISTS "eagleEyeContents";
+
+DROP TYPE "eagleEyeContents_actions_type";
+
+create table "eagleEyeContents";
+(
+    id uuid not null primary key,
+    "sourceId" text not null,
+    "vectorId" text not null,
+    status varchar(255) default NULL::character varying,
+    title text not null,
+    username text not null,
+    url text not null,
+    text text,
+    timestamp timestamp with time zone not null,
+    platform text not null,
+    keywords text [],
+    "similarityScore" double precision,
+    "userAttributes" jsonb,
+    "postAttributes" jsonb,
+    "importHash" varchar(255),
+    "createdAt" timestamp with time zone not null,
+    "updatedAt" timestamp with time zone not null,
+    "deletedAt" timestamp with time zone,
+    "tenantId" uuid not null references tenants on update cascade,
+    "createdById" uuid references users on update cascade on delete
+    set null,
+        "updatedById" uuid references users on update cascade on delete
+    set null,
+        "exactKeywords" text []
+);
+
+alter table "eagleEyeContents" owner to postgres;
+
+create index discord on "eagleEyeContents" ("vectorId", status);
+
+create index members_email_tenant_id on "eagleEyeContents" (id)
+where ("deletedAt" IS NULL);
+
+create index members_joined_at_tenant_id on "eagleEyeContents" (id)
+where ("deletedAt" IS NULL);
+
+create index members_username on "eagleEyeContents" using gin (id);
+
+create index slack on "eagleEyeContents" (id);
+
+create index twitter on "eagleEyeContents" (id);
+
+create unique index eagle_eye_contents_import_hash_tenant_id on "eagleEyeContents" ("importHash", "tenantId")
+where ("deletedAt" IS NULL);
+
+create index eagle_eye_contents_platform_tenant_id_timestamp on "eagleEyeContents" (platform, "tenantId", timestamp)
+where ("deletedAt" IS NULL);
+
+create index eagle_eye_contents_status_tenant_id_timestamp on "eagleEyeContents" (status, "tenantId", timestamp)
+where ("deletedAt" IS NULL);
+
+create index eagle_eye_contents_tenant_id_timestamp on "eagleEyeContents" ("tenantId", timestamp)
+where ("deletedAt" IS NULL);

backend/src/database/migrations/U1675702339__eagleEyeSettings.sql

@@ -0,0 +1,2 @@
+ALTER TABLE public."users" 
+DROP COLUMN "eagleEyeSettings";

backend/src/database/migrations/V1675259471__eagleEyeActions.sql

@@ -0,0 +1,33 @@
+DROP TABLE IF EXISTS "eagleEyeContents";
+
+CREATE TABLE public."eagleEyeContents" (
+    "id" uuid NOT NULL,
+    "platform" text NOT NULL,
+    "url" text NOT NULL,
+    "post" jsonb NOT NULL,
+    "tenantId" uuid NOT NULL,
+    "postedAt" timestamptz NOT NULL,
+	"createdAt" timestamptz NOT NULL,
+	"updatedAt" timestamptz NOT NULL,
+	CONSTRAINT "eagleEyeContents_pkey" PRIMARY KEY ("id")
+);
+
+ALTER TABLE public."eagleEyeContents" ADD CONSTRAINT "eagleEyeContents_tenantId_fkey" FOREIGN KEY ("tenantId") REFERENCES public.tenants(id) ON DELETE NO ACTION ON UPDATE NO ACTION;
+
+CREATE TYPE public."eagleEyeActionTypes_type" AS ENUM ('thumbs-up', 'thumbs-down', 'bookmark');
+
+CREATE TABLE public."eagleEyeActions" (
+    "id" uuid NOT NULL,
+    "type" public."eagleEyeActionTypes_type" NOT NULL,
+    "timestamp" timestamptz NOT NULL,
+    "contentId" uuid NOT NULL,
+    "tenantId" uuid NOT NULL,
+    "actionById" uuid NOT NULL,
+	"createdAt" timestamptz NOT NULL,
+	"updatedAt" timestamptz NOT NULL,
+	CONSTRAINT "eagleEyeActions_pkey" PRIMARY KEY ("id")
+);
+
+ALTER TABLE public."eagleEyeActions" ADD CONSTRAINT "eagleEyeActions_tenantId_fkey" FOREIGN KEY ("tenantId") REFERENCES public.tenants(id) ON DELETE NO ACTION ON UPDATE NO ACTION;
+ALTER TABLE public."eagleEyeActions" ADD CONSTRAINT "eagleEyeActions_actionBy_fkey" FOREIGN KEY ("actionById") REFERENCES public.users(id) ON DELETE NO ACTION ON UPDATE NO ACTION;
+ALTER TABLE public."eagleEyeActions" ADD CONSTRAINT "eagleEyeActions_contentId_fkey" FOREIGN KEY ("contentId") REFERENCES public."eagleEyeContents"(id) ON DELETE CASCADE ON UPDATE NO ACTION;

backend/src/database/migrations/V1675702339__eagleEyeSettings.sql

@@ -0,0 +1,2 @@
+ALTER TABLE public."users"
+ADD COLUMN "eagleEyeSettings" JSONB DEFAULT '{"onboarded": false}';

backend/src/database/models/eagleEyeAction.ts

@@ -0,0 +1,48 @@
+import { DataTypes } from 'sequelize'
+
+const eagleEyeActionModel = {
+  id: {
+    type: DataTypes.UUID,
+    defaultValue: DataTypes.UUIDV4,
+    primaryKey: true,
+  },
+  type: {
+    type: DataTypes.TEXT,
+    validate: {
+      isIn: [['thumbs-up', 'thumbs-down', 'bookmark']],
+    },
+    defaultValue: null,
+  },
+  timestamp: {
+    type: DataTypes.DATE,
+    allowNull: false,
+  },
+}
+
+export default (sequelize) => {
+  const eagleEyeAction = sequelize.define('eagleEyeAction', eagleEyeActionModel, {
+    timestamps: true,
+    paranoid: false,
+  })
+
+  eagleEyeAction.associate = (models) => {
+    models.eagleEyeAction.belongsTo(models.tenant, {
+      as: 'tenant',
+      foreignKey: {
+        allowNull: false,
+      },
+    })
+
+    models.eagleEyeAction.belongsTo(models.user, {
+      as: 'actionBy',
+    })
+
+    models.eagleEyeAction.belongsTo(models.eagleEyeContent, {
+      as: 'content',
+    })
+  }
+
+  return eagleEyeAction
+}
+
+export { eagleEyeActionModel }