refactor: create a common gql type for update metadata

src/db/AreaTypes.ts

@@ -6,6 +6,7 @@ import { ClimbType } from './ClimbTypes.js'
 import { ChangeRecordMetadataType } from './ChangeLogType.js'
 import { GradeContexts } from '../GradeUtils.js'
 import { ExperimentalAuthorType } from './UserTypes.js'
+import { AuthorMetadata } from '../types.js'
 
 /**
  * Areas are a grouping mechanism in the OpenBeta data model that allow
@@ -32,7 +33,7 @@ export type AreaType = IAreaProps & {
  * See AreaType for the reified version of this object, and always use it
  * if you are working with data that exists inside the database.
 */
-export interface IAreaProps {
+export interface IAreaProps extends AuthorMetadata {
   _id: mongoose.Types.ObjectId
   /**
    * ShortCodes are short, globally uniqe codes that identify significant climbing areas
@@ -99,10 +100,6 @@ export interface IAreaProps {
   _change?: ChangeRecordMetadataType
   /** Used to delete an area.  See https://www.mongodb.com/docs/manual/core/index-ttl/ */
   _deleting?: Date
-  createdAt?: Date
-  updatedAt?: Date
-  updatedBy?: MUUID
-  createdBy?: MUUID
 }
 
 export interface IAreaMetadata {

src/db/utils/index.ts

@@ -0,0 +1,8 @@
+import { AuthorMetadata } from '../../types'
+
+export const getAuthorMetadataFromBaseNode = ({ updatedAt, updatedBy, createdAt, createdBy }: AuthorMetadata): AuthorMetadata => ({
+  updatedAt,
+  updatedBy,
+  createdAt,
+  createdBy
+})

src/db/utils/jobs/MigrateTagsToMediaCollection.ts

@@ -1,11 +1,5 @@
-import sharp from 'sharp'
-import { glob } from 'glob'
-import { validate as uuidValidate } from 'uuid'
-import muuid from 'uuid-mongodb'
-
 import { connectDB, getMediaModel, gracefulExit } from '../../index.js'
 import { logger } from '../../../logger.js'
-import { MediaObjectType } from '../../MediaMetaType.js'
 import { getMediaObjectModel } from '../../MediaObjectSchema.js'
 import { MediaType } from '../../MediaTypes.js'
 
@@ -19,7 +13,7 @@ const onConnected = async (): Promise<void> => {
 
   let count = 0
 
-  const rs = await oldTagModel.aggregate([
+  await oldTagModel.aggregate([
     {
       $group: {
         _id: '$mediaUrl',

src/graphql/history/HistoryFieldResolvers.ts

@@ -1,13 +1,15 @@
 import { ChangeLogType, BaseChangeRecordType, SupportedCollectionTypes, DocumentKind } from '../../db/ChangeLogType.js'
-import { exhaustiveCheck } from '../../utils/helpers.js'
+import { AuthorMetadata } from '../../types.js'
+import { exhaustiveCheck, getUserNickFromMediaDir } from '../../utils/helpers.js'
 
 /**
- * Customize to resolve individual fields
+ * History schama field resolvers
  */
 const resolvers = {
   History: {
     id: (node: ChangeLogType) => node._id.toString(),
-    editedBy: (node: ChangeLogType) => node.editedBy.toUUID().toString()
+    editedBy: (node: ChangeLogType) => node.editedBy.toUUID().toString(),
+    editedByUser: async (node: ChangeLogType) => (await getUserNickFromMediaDir(node.editedBy.toUUID().toString()))
   },
 
   Change: {
@@ -36,6 +38,13 @@ const resolvers = {
           return exhaustiveCheck(node.kind)
       }
     }
+  },
+
+  AuthorMetadata: {
+    createdBy: (node: AuthorMetadata) => node?.createdBy?.toUUID().toString(),
+    updatedBy: (node: AuthorMetadata) => node?.updatedBy?.toUUID().toString(),
+    createdByUser: async (node: AuthorMetadata) => await getUserNickFromMediaDir(node?.createdBy?.toUUID().toString() ?? ''),
+    updatedByUser: async (node: AuthorMetadata) => (await getUserNickFromMediaDir(node?.updatedBy?.toUUID().toString() ?? ''))
   }
 }
 

src/graphql/resolvers.ts

@@ -1,6 +1,9 @@
 import { makeExecutableSchema } from '@graphql-tools/schema'
 import { DataSources } from 'apollo-server-core/dist/graphqlOptions'
 import muid from 'uuid-mongodb'
+import fs from 'fs'
+import { gql } from 'apollo-server'
+import { DocumentNode } from 'graphql'
 
 import { CommonResolvers, CommonTypeDef } from './common/index.js'
 import { HistoryQueries, HistoryFieldResolvers } from '../graphql/history/index.js'
@@ -17,11 +20,8 @@ import { ClimbMutations } from './climb/index.js'
 import { OrganizationMutations, OrganizationQueries } from './organization/index.js'
 import TickMutations from './tick/TickMutations.js'
 import TickQueries from './tick/TickQueries.js'
-import fs from 'fs'
-
-import { gql } from 'apollo-server'
-import { DocumentNode } from 'graphql'
 import MediaDataSource from '../model/MediaDataSource.js'
+import { getAuthorMetadataFromBaseNode } from '../db/utils/index.js'
 
 /**
  * It takes a file name as an argument, reads the file, and returns a GraphQL DocumentNode.
@@ -178,8 +178,7 @@ const resolvers = {
         }
       : node.content,
 
-    createdBy: (node: ClimbGQLQueryType) => node?.createdBy?.toUUID().toString(),
-    updatedBy: (node: ClimbGQLQueryType) => node?.updatedBy?.toUUID().toString()
+    authorMetadata: getAuthorMetadataFromBaseNode
   },
 
   Area: {
@@ -237,9 +236,7 @@ const resolvers = {
       const { media }: { media: MediaDataSource } = dataSources
       return await media.findMediaByAreaId(node.metadata.area_id, node.ancestors)
     },
-
-    createdBy: (node: AreaType) => node?.createdBy?.toUUID().toString(),
-    updatedBy: (node: AreaType) => node?.updatedBy?.toUUID().toString()
+    authorMetadata: getAuthorMetadataFromBaseNode
   },
 
   CountByDisciplineType: {

src/graphql/schema/Area.gql

@@ -66,10 +66,8 @@ type Area {
   totalClimbs: Int!
   "Media associated with this area, or its child climbs"
   media: [MediaWithTags]
-  createdAt: Date
-  createdBy: ID
-  updatedAt: Date
-  updatedBy: ID
+  "Metadata about creation & update of this area"
+  authorMetadata: AuthorMetadata!
 }
 
 type AreaMetadata {

src/graphql/schema/Climb.gql

@@ -59,10 +59,8 @@ type Climb {
   "The parent area object"
   parent: Area!
 
-  createdAt: Date
-  updatedAt: Date
-  updatedBy: ID
-  createdBy: ID
+  "Metadata about creation & update of this climb"
+  authorMetadata: AuthorMetadata!
 }
 
 type ClimbMetadata {

src/graphql/schema/History.gql

@@ -28,7 +28,8 @@ union Document = Area | Climb | Organization
 
 type History {
   id: ID!
-  editedBy: String!
+  editedBy: ID!
+  editedByUser: String
   operation: String!
   createdAt: Date!
   changes: [Change]
@@ -39,3 +40,13 @@ type Query {
   getAreaHistory(filter: AreaHistoryFilter): [History]
   getOrganizationHistory(filter: OrganizationHistoryFilter): [History]
 }
+
+"""Author metadata"""
+type AuthorMetadata {
+  createdAt: Date!
+  createdBy: ID!
+  createdByUser: String
+  updatedAt: Date!
+  updatedBy: ID!
+  updatedByUser: String
+}

src/model/MediaDataSource.ts

@@ -1,13 +1,15 @@
 import { MongoDataSource } from 'apollo-datasource-mongodb'
 import muid, { MUUID } from 'uuid-mongodb'
 
-import { getMediaModel, getMediaObjectModel } from '../db/index.js'
+import { getMediaObjectModel } from '../db/index.js'
 import { MediaType, MediaByUsers, TagsLeaderboardType, MediaWithTags, AllTimeTagStats } from '../db/MediaTypes.js'
 
 export default class MediaDataSourcmnee extends MongoDataSource<MediaType> {
-  tagModel = getMediaModel()
   mediaObjectModel = getMediaObjectModel()
 
+  /**
+   * A reusable list of fields for '$group' aggregation
+   */
   mediaObjectGroupByFields = {
     mediaUrl: '$mediaUrl',
     userUuid: '$userUuid',
@@ -289,7 +291,7 @@ export default class MediaDataSourcmnee extends MongoDataSource<MediaType> {
       {
         $unset: ['_id']
       }
-    ])
+    ], { readPreference: 'secondaryPreferred' })
 
     if (rs?.length !== 1) throw new Error('Unexpected leaderboard query error')
 

src/types.ts

@@ -102,3 +102,10 @@ export interface Context {
 export interface ContextWithAuth extends Context {
   user: AuthUserType
 }
+
+export interface AuthorMetadata {
+  updatedAt?: Date
+  updatedBy?: MUUID
+  createdAt?: Date
+  createdBy?: MUUID
+}