Follow+Notes: Expose ability to retrieve grant followers via Finder API

[TylerHendrickson]

Subtask of [STORY]: Update 'Status' to 'Follow + Note' feature #2960

Blocked by

N/A

Blocks

• Follow+Notes: Implement Grant Activity card component in Grant Details view #3406

Definition of Done

A new API route exists that allows users retrieve followers (within the same tenant/organization) of a particular grant.

Implementation Details

• In packages/server/src/lib/grantsCollaboration/followers.js, update the exported interface with the following functions:
  • getFollowersForGrant(knex, grantId, organizationId, { beforeFollow, limit = 50 })
    • Performs a query for grant followers pertaining to the identified grant and organization
    • Results should be ordered by grant_followers.created_at in descending order (most recent first).
    • The knex argument represents a knex connection object, e.g. as implemented by the existing followGrant() function.
    • If a non-null/-undefined value is provided for the beforeFollow argument, the main query should be limited to results where grant_followers.id is less than that value.
    • This function should return an object that matches the following structure:

      {
        followers: [{
          id: grant_followers.id,
          createdAt: grant_followers.created_at,
          grant: { id: grant_followers.grant_id },
          user: {
            id: grant_followers.user_id,
            name: users.name,
            email: users.email,
            team: {
              id: users.agency_id,
              name: agencies.name,
            },
            organization: {
              id: users.tenant_id,
              name: tenants.name,
            },
          }
        }],
        pagination: {
          from: followers.length > 0 ? followers[followers.length - 1].id : beforeFollow,
        },
      }

      • Note that followersTotalCount is the result of the count query
• In packages/server/src/lib/grantsCollaboration/index.js, import/export the getFollowersForGrant() function exported from packages/server/src/lib/grantsCollaboration/followers.js
• In packages/server/src/routes/grants.js, define a new GET /:grantId/followers API route handler as follows:
  • Requires authentication.
  • Calls getFollowersForGrant() from packages/server/src/lib/grantsCollaboration with the grant ID and organization ID from the request.
    • The grantId call argument should be provided by the request path parameters.
    • The organizationId call argument should be the requesting user's tenant_id attribute (i.e. req.session.user.tenant_id).
  • If a ?paginateFrom query parameter value is provided in the request, that value should be provided as the beforeFollow argument in the call to getFollowersForGrant().
  • If a ?limit query parameter value is provided in the request, that value (as a parsed integer) should be provided as the limit argument in the call to getFollowersForGrant(). Additionally, this value must pass the following validation checks (or else respond with a 400 Bad Request status):
    • Can be successfully parsed as an integer
    • Parsed integer value must be greater than or equal to 1
    • Parsed integer value must not exceed 100
  • Following a successful call to getFollowersForGrant(), provides the function's return value as a JSON-serialized response.