R chain: include schema summary (#3165)

Co-authored-by: Stefano Ricci <[email protected]>
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>

common/apiRoutes/index.js

@@ -1,3 +1,4 @@
 import * as rChain from './rChain'
+import * as survey from './survey'
 
-export { rChain }
+export { rChain, survey }

common/apiRoutes/survey.js

@@ -1 +1,3 @@
 export const getSurveyPath = (surveyId) => `/survey/${surveyId}`
+
+export const schemaSummary = ({ surveyId, cycle }) => `${getSurveyPath(surveyId)}/schema-summary/?cycle=${cycle}`

server/modules/analysis/service/rChain/rFile/system/rFileReadData.js

@@ -37,6 +37,13 @@ export default class RFileReadData extends RFileSystem {
     super(rChain, 'read-data')
   }
 
+  async initSchemaSummary() {
+    const { survey, cycle } = this.rChain
+
+    const schemaSummaryCSV = arenaGetCSV(ApiRoutes.survey.schemaSummary({ surveyId: Survey.getId(survey), cycle }))
+    await this.appendContent(setVar('arena.schemaSummary', schemaSummaryCSV))
+  }
+
   async initEntitiesData() {
     const { chainUuid, survey, cycle, entities } = this.rChain
 
@@ -119,6 +126,8 @@ export default class RFileReadData extends RFileSystem {
 
     const { listCategories, listTaxonomies } = this.rChain
 
+    await this.initSchemaSummary()
+
     await this.initEntitiesData()
 
     // Append categories and taxoniomies initialization

server/modules/survey/service/schemaSummary/schemaSummary.js

@@ -48,7 +48,7 @@ const getValidationsSummary = ({ nodeDef }) => {
     .join('\n')
 }
 
-export const exportSchemaSummary = async ({ surveyId, cycle, outputStream }) => {
+export const generateSchemaSummaryItems = async ({ surveyId, cycle }) => {
   const survey = await SurveyManager.fetchSurveyAndNodeDefsBySurveyId({ surveyId, draft: true, advanced: true })
   const nodeDefs = Survey.getNodeDefsArray(survey).filter(
     (nodeDef) =>
@@ -85,7 +85,7 @@ export const exportSchemaSummary = async ({ surveyId, cycle, outputStream }) =>
     return Taxonomy.getName(taxonomy) || ''
   }
 
-  const items = nodeDefs.map((nodeDef) => {
+  return nodeDefs.map((nodeDef) => {
     const { uuid, type } = nodeDef
 
     const languages = Survey.getLanguages(Survey.getSurveyInfo(survey))
@@ -123,6 +123,9 @@ export const exportSchemaSummary = async ({ surveyId, cycle, outputStream }) =>
       cycle: String(NodeDef.getCycles(nodeDef).map(RecordCycle.getLabel)), // this is to show the user the value that they see into the UI -> https://github.com/openforis/arena/issues/1677
     }
   })
+}
 
+export const exportSchemaSummary = async ({ surveyId, cycle, outputStream }) => {
+  const items = await generateSchemaSummaryItems({ surveyId, cycle })
   await CSVWriter.writeItemsToStream({ outputStream, items, options: { removeNewLines: false } })
 }