Upgrade to work with @dmptool/types v4.0.0

[briri]

Upgrade to v4.0.0 of @dmptool/types and v2.1.6 of @dmptool/utils

[jupiter007]

LGTM

[briri]

This deserves another look @jupiter007

I moved much of the logic to the Apollo server's new entirePlan resolvers to take advantage of the MySQL transactions.

The API is now simply converting incoming maDMP JSON into GraphQL queries.

[jupiter007]

Looks good overall. I just had a few comments.

I guess it makes sense to consolidate mutation and query data into one "entire plan".

One thing I noticed is that you can simplify plan.graphql to use fragments. If you do that, you can simplify the Plan.fromGraphQL method.

Also, do we need to update the README.md file?

[jupiter007]

I think you can use fragment here to simplify this. The PlanByDmpId and PlanByAlternateIdentifier return the exact same data. So you can extract all the fields into a fragment like below, and then future changes can happen in one place. Also, this would simplify the Plan.toGraphQL.

fragment PlanDetails on Plan {
  id
  dmpId
  title
  visibility
  status
  created
  createdById
  modified
  modifiedById
  registered
  project {
    id
    title
    abstractText
    startDate
    endDate
    isTestProject
    researchDomain {
      id
      uri
    }
    members {
      id
      isPrimaryContact
      affiliation { uri }
      givenName
      surName
      orcid
      email
      memberRoles { id uri }
    }
    fundings {
      id
      affiliation { uri }
      status
      funderProjectNumber
      funderOpportunityNumber
      grantId
    }
  }
  members {
    projectMember { id }
    memberRoles { id uri }
  }
  fundings {
    id
    projectFunding { id }
  }
  answers {
    id
    versionedSection { id }
    versionedQuestion { id }
    json
  }
  versionedTemplate {
    id
    name
    description
    version
    template { id }
    versionedSections {
      id
      name
      displayOrder
      versionedQuestions {
        id
        questionText
        json
      }
    }
  }
  alternateIdentifiers {
    id
    alternateIdentifier
  }
}

and then

query PlanByDmpId($dmpId: String!) {
  planByDMPId(dmpId: $dmpId) {
    ...PlanDetails
  }
}

query PlanByAlternateIdentifier($alternateIdentifier: String!) {
  planByAlternateIdentifier(alternateIdentifier: $alternateIdentifier) {
    ...PlanDetails
  }
}

[jupiter007]

Did you mean to leave this console.log here?

[jupiter007]

Do we need to throw the ERROR_CODE_INTERNAL_SERVER here:

if (!maDMP || !maDMP.dmp) {
  request.log.error({ dmpId }, "Unable to generate narrative for DMP");
  throw newFastifyError(ERROR_CODE_INTERNAL_SERVER, ERROR_MSG_INTERNAL_SERVER);
}

It looks like if we return undefined to createPlanWorkflow, which calls this, then it returns an ERROR_CODE_INVALID_DMP. Is that expected?

[jupiter007]

L25: minor - "format" should be "formats"

[jupiter007]

It might be helpful to add some comments on what the LanguageMapThreeToFive and LanguageMapFiveToThree are for.