Add FA & length field to updateClimbs mutation (#243)

* feat: support FA & length update
* test: unit test length & fa updates
* docs: update climbs mutation

---------

Co-authored-by: viet nguyen <vietnguyen@noreply>

src/db/ClimbTypes.ts

@@ -37,6 +37,9 @@ export interface IClimbProps {
   /** First ascent, if known. Who was the first person to climb this route? */
   fa?: string
   yds?: string
+
+  /** Total length in metersif known.  We will support individual pitch lenth in the future. */
+  length?: number
   /**
    * Grades appear within as an I18n-safe format.
    * We achieve this via a larger data encapsulation, and perform interpretation and comparison
@@ -149,11 +152,11 @@ export interface ClimbChangeInputType {
   description?: string
   location?: string
   protection?: string
+  fa?: string
+  length?: number
 }
 
-// export type ClimbDBChangeType = ClimbChangeInputType
-
-type UpdatableClimbFieldsType = Pick<ClimbType, 'fa'|'name'|'type' | 'gradeContext' |'grades' | 'content'>
+type UpdatableClimbFieldsType = Pick<ClimbType, 'fa' | 'name' | 'type' | 'gradeContext' | 'grades' | 'content' | 'length'>
 /**
  * Minimum required fields when adding a new climb or boulder problem
  */

src/graphql/resolvers.ts

@@ -143,6 +143,8 @@ const resolvers = {
 
     yds: (node: ClimbGQLQueryType) => node.yds ?? null,
 
+    length: (node: ClimbGQLQueryType) => node.length ?? -1,
+
     grades: (node: ClimbGQLQueryType) => node.grades ?? null,
 
     metadata: (node: ClimbGQLQueryType) => ({

src/graphql/schema/Climb.gql

@@ -15,6 +15,10 @@ type Climb {
   name: String!
   "First ascent, if known. Who was the first person to climb this route?"
   fa: String
+
+  "Total length in meters if known (-1 otherwise)"
+  length: Int!
+
   "The grade(s) assigned to this climb. See GradeType documentation"
   grades: GradeType
 

src/graphql/schema/ClimbEdit.gql

@@ -1,8 +1,12 @@
 type Mutation {
+  """
+  Create or update one or more climbs.
+  """
   updateClimbs(input: UpdateClimbsInput): [ID]
-}
 
-type Mutation {
+  """
+  Delete one or more climbs
+  """
   deleteClimbs(input: DeleteManyClimbsInput): Int
 }
 
@@ -11,12 +15,21 @@ input DeleteManyClimbsInput {
   idList: [ID]
 }
 
+"""
+Create/update climbs input parameter.
+"""
 input UpdateClimbsInput {
+  "Parent area ID"
   parentId: ID!
+  "Array of change records"
   changes: [SingleClimbChangeInput]
 }
 
+"""
+Climb change record.  If the climb ID is omitted or does not exist in the database, a new climb will be created.
+"""
 input SingleClimbChangeInput {
+  "Climb UUID"
   id: ID
   name: String
   disciplines: DisciplineType
@@ -25,6 +38,10 @@ input SingleClimbChangeInput {
   description: String
   location: String
   protection: String
+  "Legacy FA data"
+  fa: String
+  "Length in meters"
+  length: Int
 }
 
 input DisciplineType {

src/model/MutableClimbDataSource.ts

@@ -115,7 +115,7 @@ export default class MutableClimbDataSource extends ClimbDataSource {
         ? createGradeObject(grade, typeSafeDisciplines, cragGradeScales)
         : null
 
-      const { description, location, protection, name } = userInput[i]
+      const { description, location, protection, name, fa, length } = userInput[i]
 
       // Make sure we don't update content = {}
       // See https://www.mongodb.com/community/forums/t/mongoservererror-invalid-set-caused-by-an-empty-object-is-not-a-valid-value/148344/2
@@ -131,6 +131,8 @@ export default class MutableClimbDataSource extends ClimbDataSource {
         ...newGradeObj != null && { grades: newGradeObj },
         ...typeSafeDisciplines != null && { type: typeSafeDisciplines },
         gradeContext: parent.gradeContext,
+        ...fa != null && { fa },
+        ...length != null && length > 0 && { length },
         content: Object.keys(content).length === 0 ? undefined : content,
         metadata: {
           areaRef: parent.metadata.area_id,

src/model/__tests__/MutableClimbDataSource.ts

@@ -256,4 +256,36 @@ describe('Climb CRUD', () => {
     expect(actual1?.createdBy?.toUUID().toString()).toEqual(testUser.toUUID().toString())
     expect(actual1?.updatedBy?.toUUID().toString()).toEqual(otherUser.toUUID().toString())
   })
+
+  it('can update climb length & fa', async () => {
+    const newDestination = await areas.addArea(testUser, 'Sport area Z100', null, 'fr')
+
+    if (newDestination == null) fail('Expect new area to be created')
+
+    const newIDs = await climbs.addOrUpdateClimbs(
+      testUser,
+      newDestination.metadata.area_id,
+      newClimbsToAdd
+    )
+
+    const change: ClimbChangeInputType = {
+      id: newIDs[0],
+      fa: 'First name Last name, 2023',
+      length: 20
+    }
+
+    await climbs.addOrUpdateClimbs(testUser,
+      newDestination.metadata.area_id,
+      [change])
+
+    const actual = await climbs.findOneClimbByMUUID(muid.from(newIDs[0]))
+
+    expect(actual?.fa).not.toBeNull()
+    expect(actual?.length).not.toBeNull()
+
+    expect(actual).toMatchObject({
+      fa: change.fa,
+      length: change.length
+    })
+  })
 })