feat: add support for user requests (#1959)

* feat: add support for user requests

* add slack notifications for user requests

* Fixing JSDoc missing

Co-authored-by: trigramdev9 <jsdevel@trigram.co>

Author: e-schneid

.env.tpl

@@ -22,6 +22,9 @@ SENTRY_DSN=https://000000@0000000.ingest.sentry.io/00000
 SENTRY_TOKEN=secret
 SENTRY_UPLOAD=false
 
+## User request Slack notification webhook URL
+SLACK_USER_REQUEST_WEBHOOK_URL=
+
 ## API PostgREST
 DATABASE_URL=http://localhost:3000
 DATABASE_TOKEN=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpc3MiOiJzdXBhYmFzZSIsImlhdCI6MTYwMzk2ODgzNCwiZXhwIjoyNTUwNjUzNjM0LCJyb2xlIjoic2VydmljZV9yb2xlIn0.necIJaiP7X2T2QjGeV-FhpkizcNTX8HjDDBAxpgQTEI

packages/api/src/bindings.d.ts

@@ -75,6 +75,9 @@ export interface ServiceConfiguration {
 
   /** Mailchimp api key */
   MAILCHIMP_API_KEY: string
+
+  /** Slack webhook url */
+  SLACK_USER_REQUEST_WEBHOOK_URL: string
 }
 
 export interface Ucan {
@@ -226,6 +229,13 @@ export interface PinsResponse {
   delegates: string[]
 }
 
+export interface RequestFormItem {
+  label: string
+  value: string
+}
+
+export type RequestForm = Array<RequestFormItem>
+
 /**
  * The known structural completeness of a given DAG. "Unknown" structure means
  * it could be a partial or it could be a complete DAG i.e. we haven't walked

packages/api/src/config.js

@@ -99,6 +99,7 @@ export function serviceConfigFromVariables(vars) {
     S3_ACCESS_KEY_ID: vars.S3_ACCESS_KEY_ID,
     S3_SECRET_ACCESS_KEY: vars.S3_SECRET_ACCESS_KEY,
     S3_BUCKET_NAME: vars.S3_BUCKET_NAME,
+    SLACK_USER_REQUEST_WEBHOOK_URL: vars.SLACK_USER_REQUEST_WEBHOOK_URL,
     PRIVATE_KEY: vars.PRIVATE_KEY,
     // These are injected in esbuild
     // @ts-ignore
@@ -157,7 +158,12 @@ export function loadConfigVariables() {
     }
   }
 
-  const optional = ['CLUSTER_SERVICE', 'CLUSTER_API_URL', 'S3_ENDPOINT']
+  const optional = [
+    'CLUSTER_SERVICE',
+    'CLUSTER_API_URL',
+    'S3_ENDPOINT',
+    'SLACK_USER_REQUEST_WEBHOOK_URL',
+  ]
 
   for (const name of optional) {
     const val = globals[name]

packages/api/src/index.js

@@ -23,6 +23,7 @@ import { metaplexUpload } from './routes/metaplex-upload.js'
 import { blogSubscribe } from './routes/blog-subscribe.js'
 import { userDIDRegister } from './routes/user-did-register.js'
 import { userTags } from './routes/user-tags.js'
+import { userRequestsAdd, userRequestsGet } from './routes/user-requests.js'
 import { ucanToken } from './routes/ucan-token.js'
 import { did } from './routes/did.js'
 import { getServiceConfig } from './config.js'
@@ -164,6 +165,13 @@ r.add(
 )
 r.add('get', '/user/tags', withAuth(withMode(userTags, RO)), [postCors])
 
+r.add('post', '/user/request', withAuth(withMode(userRequestsAdd, RW)), [
+  postCors,
+])
+r.add('get', '/user/request', withAuth(withMode(userRequestsGet, RW)), [
+  postCors,
+])
+
 // Tokens
 r.add('get', '/internal/tokens', withAuth(withMode(tokensList, RO)), [postCors])
 r.add(

packages/api/src/routes/user-requests.js

@@ -0,0 +1,104 @@
+import { checkAuth } from '../utils/auth.js'
+import { JSONResponse } from '../utils/json-response.js'
+import { getPendingProposals, getTagValue, hasTag } from '../utils/utils.js'
+import { getServiceConfig } from '../config.js'
+import { DBClient } from '../utils/db-client.js'
+
+/** @type {import('../bindings').Handler} */
+export const userRequestsAdd = async (event, ctx) => {
+  const { user } = checkAuth(ctx)
+
+  const userId = user.id
+  const { tagName, requestedTagValue, userProposalForm } =
+    await event.request.json()
+  const res = await ctx.db.createUserRequest(
+    userId,
+    tagName,
+    requestedTagValue,
+    userProposalForm
+  )
+
+  try {
+    notifySlack(userId, tagName, requestedTagValue, userProposalForm, ctx.db)
+  } catch (e) {
+    console.error('Failed to notify Slack: ', e)
+  }
+
+  return new JSONResponse({ ok: true, value: res })
+}
+
+/** @type {import('../bindings').Handler} */
+export const userRequestsGet = async (event, ctx) => {
+  const { user } = checkAuth(ctx)
+
+  const userId = user.id
+  const res = await ctx.db.getUserRequests(userId)
+
+  return new JSONResponse({ ok: true, value: getPendingProposals(res) })
+}
+
+/**
+ *
+ * @param {number} userId
+ * @param {string} userProposalForm
+ * @param {string} tagName
+ * @param {string} requestedTagValue
+ * @param {DBClient} db
+ */
+const notifySlack = async (
+  userId,
+  tagName,
+  requestedTagValue,
+  userProposalForm,
+  db
+) => {
+  const webhookUrl = getServiceConfig().SLACK_USER_REQUEST_WEBHOOK_URL
+
+  if (!webhookUrl) {
+    return
+  }
+
+  /** @type {import('../bindings').RequestForm} */
+  let form
+  try {
+    form = JSON.parse(userProposalForm)
+  } catch (e) {
+    console.error('Failed to parse user request form: ', e)
+    return
+  }
+
+  const user = await db.getUserById(userId)
+
+  fetch(webhookUrl, {
+    method: 'POST',
+    headers: {
+      'Content-type': 'application/json',
+    },
+    body: JSON.stringify({
+      text: `
+>*Username*
+>${user.name}
+>
+>*Email*
+>${user.email}
+>
+>*User Id*
+>${userId}
+>
+>*Requested Tag Name*
+>${tagName}
+>
+>*Requested Tag Value*
+>${requestedTagValue}
+>${form
+        .map(
+          ({ label, value }) => `
+>*${label}*
+>${value}
+>`
+        )
+        .join('')}
+`,
+    }),
+  })
+}

packages/api/src/utils/db-client.js

@@ -75,6 +75,26 @@ export class DBClient {
     }
   }
 
+  /**
+   * Gets a user by user id
+   *
+   * @param {number} id
+   * @returns
+   */
+  async getUserById(id) {
+    const { data, error, status } = await this.client
+      .from('user')
+      .select('*')
+      .eq('id', id)
+      .single()
+
+    if (error) {
+      throw new DBError(error)
+    }
+
+    return data
+  }
+
   /**
    * Get user by magic.link or old github id
    *
@@ -130,6 +150,75 @@ export class DBClient {
     return data?.status === 'Blocked'
   }
 
+  /**
+   * Gets user tag change requests
+   *
+   * @param {number} userId
+   */
+  async getUserRequests(userId) {
+    const { data, error } = await this.client
+      .from('user_tag_proposal')
+      .select('*')
+      .match({ user_id: userId })
+      .is('deleted_at', null)
+
+    if (error) {
+      throw new DBError(error)
+    }
+
+    return data
+  }
+
+  /**
+   * Creates a user tag change request
+   *
+   * @param {number} userId
+   * @param {string} tagName
+   * @param {string} requestedTagValue
+   * @param {JSON} userProposalForm
+   * @returns
+   */
+  async createUserRequest(
+    userId,
+    tagName,
+    requestedTagValue,
+    userProposalForm
+  ) {
+    const { data: deleteData, status: deleteStatus } = await this.client
+      .from('user_tag_proposal')
+      .update({
+        deleted_at: new Date().toISOString(),
+      })
+      .match({ user_id: userId, tag: tagName })
+      .is('deleted_at', null)
+
+    if (
+      deleteStatus === 200 ||
+      ((deleteStatus === 406 || deleteStatus === 404) && !deleteData)
+    ) {
+      const { error: insertError, status: insertStatus } = await this.client
+        .from('user_tag_proposal')
+        .insert({
+          user_id: userId,
+          tag: tagName,
+          proposed_tag_value: requestedTagValue,
+          inserted_at: new Date().toISOString(),
+          user_proposal_form: userProposalForm,
+        })
+        .single()
+
+      if (insertError) {
+        throw new DBError(insertError)
+      }
+
+      if (insertStatus === 201) {
+        return true
+      }
+    }
+
+    return false
+  }
+
   /**
    * Create upload with content and pins
    *

packages/api/src/utils/utils.js

@@ -97,3 +97,20 @@ export function hasTag(user, tagName, value) {
     )
   )
 }
+
+/**
+ * @param {Array<object | any> | null} proposals
+ * @return {object}
+ */
+export function getPendingProposals(proposals) {
+  if (Array.isArray(proposals)) {
+    return proposals.reduce((acc, p) => {
+      if (p['tag']) {
+        acc[p['tag']] = !p['admin_decision_type']
+      }
+      return acc
+    }, {})
+  }
+
+  return {}
+}

packages/api/test/scripts/globals.js

@@ -11,6 +11,7 @@ globalThis.METAPLEX_AUTH_TOKEN = 'metaplex-test-token'
 globalThis.LOGTAIL_TOKEN = ''
 globalThis.PRIVATE_KEY = 'xmbtWjE9eYuAxae9G65lQSkw36HV6H+0LSFq2aKqVwY='
 globalThis.SENTRY_DSN = 'https://test@test.ingest.sentry.io/0000000'
+globalThis.SLACK_USER_REQUEST_WEBHOOK_URL = 'test'
 
 globalThis.CLUSTER_API_URL = 'http://localhost:9094'
 // will be used with we can active auth in cluster base64 of test:test

packages/website/components/types.d.ts

@@ -21,6 +21,12 @@ export interface Tag {
   selected?: boolean
 }
 
+interface RequestFormItem {
+  label: string
+  value: string
+}
+
+export type RequestForm = Array<RequestFormItem>
 export interface Tags {
   tags: Tag[] | string[]
   className?: string
@@ -57,8 +63,13 @@ export interface UserTag {
   HasPsaAccess?: boolean
 }
 
+export interface TagProposal {
+  HasPsaAccess?: boolean
+}
+
 export interface User extends MagicUser {
   tags: UserTag
+  pendingTagProposals: TagProposal
 }
 
 export interface LayoutChildrenProps {