A working API to automate the creation of questions

[ombhardwajj]

What

A working API to automate the creation of questions for the all the tables of "subject types" and "Address" has been successfully built.

How does it work?

1. User sends a POST req at /api/metabase/create-questions
2. It calls "createQuestionsForSubjectTypes" method
3. This method first waits for the Database Sync to complete in metabase and then begins with the main task.
4. First it searches and stores all the names of the "subject types" in a List (since the tables would have the same name).
5. Then it executes the main POST req with payload to metabase which would create the questions/cards

[vinayvenu]

DatabaseRepository - Create proper objects for what you return, not JsonNode.

DatabaseService - Don't return Strings if there are specific known values. Move them into enum values

DatabaseService (createQuestionForTable) - Push towards making smaller objects that describe your data instead of directly using ObjectNodes.

DatabaseService - Eventually, we will plug this in when there are changes in programs, subject types etc. Which means there needs to be methods to make changes for specific subject types

StringUtils.java - There is an S.java that is meant for String utilities

getDatabaseDetails is being called multiple times. This is a network call, and can potentially get slow. Try to optimize

Not sure of the purpose of the db migrations

application.properties changes need to be reverted

Need to check how this works.
int tableId = getTableIdByName("Subject Type");
When running first time, the subject type tables will be of the form "schema"."subjectTypeName", so how do the subject type tables get created?

[himeshr]

Where is table type for "Encounter".?

[ombhardwajj]

We have "ProgramEncounter" isn't it? 🤔

[himeshr]

Define and invoke databaseService.createQuestionsForSubjectGeneralEncounterTypes()

[himeshr]

@ombhardwajj Pretty happy with the overall design and functionality of the Automated Question Creation service on Metabase.

Have specified list of code review comments from our code walkthrough session earlier:

• Rename createQuestionForIndividualTable to non Individual something, DatabaseRepository
• For Enums and other constants created to represent Metabase entityTypes, provide documentation links.
• Metbase client jar is available, for Java8 avni version and If easy, only then replace..
• Delete MetabaseJoin.java
• Use ConditionType.equal in MetabaseQueryBuilder => conditionArray
• Replace "base-type" with Enums in MetabaseQueryBuilder
• Create constants wherever demmed fit MetabaseQueryBuilder
• Link doc to MetabaseRequestBody
• See if TableDetails is needed in fetchingTableDetails calls from Metabase
• TableType.Encounter and its questions creation
• Move AddressQuestionCreationService logic to DatabaseService
• Replace getSubjectTypeNames usage of int literals with constants depictiing columnsNames
• Create common method called by createQuestionsForSubjectTypes() and createQuestionsForPrograms(), createQuestionsForProgramsEncounters() and createQuestionsForEncounters() with List entityNames
• createQuestionForTable( schema => !public is not used)

[himeshr]

@ombhardwajj another thought that occurred to me regarding this, in-case the Questions were previously created and we introduce a new SubjectType / EncounterType, etc.. if we retrigger the AutoQuestionCreationAPI "/create-questions", would it work as expected and create Question only for the new one and not try and recreate all of them.?
Ideally, Question creation should be an Idempotent operation.

[ombhardwajj]

Hey @himeshr I've addressed all the concerns including duplication of questions. Please review the code 🙇

[himeshr]

"createQuestionForTable( schema => !public is not used)" => This one is pending, but going ahead with merge as its a small inconsequential thing.