Initialise ElasticSearch index and schema as part of migrations

[rikukissa]

Make sure ElasticSearch is fully initialised before the application starts. The reason for this is:

• Uninitialised index can cause false positive errors when a production environment is taken in to use
• Creating the index as part of creating the first record has caused raise condition bugs before
• It's a best practice to not manipulate database structures on runtime

{
	"ocrvs": {
		"mappings": {
			"properties": {
				"childDoB": {
					"type": "date"
				},
				"childFamilyName": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"childFirstNames": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"compositionType": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"createdAt": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"createdBy": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"dateOfDeclaration": {
					"type": "date"
				},
				"declarationJurisdictionIds": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"declarationLocationId": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"event": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"eventLocationId": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"fatherDoB": {
					"type": "date"
				},
				"fatherFamilyName": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"fatherFirstNames": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"gender": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"informantDoB": {
					"type": "date"
				},
				"informantFamilyName": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"informantFirstNames": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"informantType": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"modifiedAt": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"operationHistories": {
					"properties": {
						"operatedOn": {
							"type": "date"
						},
						"operationType": {
							"type": "text",
							"fields": {
								"keyword": {
									"type": "keyword",
									"ignore_above": 256
								}
							}
						},
						"operatorFamilyName": {
							"type": "text",
							"fields": {
								"keyword": {
									"type": "keyword",
									"ignore_above": 256
								}
							}
						},
						"operatorFamilyNameLocale": {
							"type": "text",
							"fields": {
								"keyword": {
									"type": "keyword",
									"ignore_above": 256
								}
							}
						},
						"operatorFirstNames": {
							"type": "text",
							"fields": {
								"keyword": {
									"type": "keyword",
									"ignore_above": 256
								}
							}
						},
						"operatorFirstNamesLocale": {
							"type": "text",
							"fields": {
								"keyword": {
									"type": "keyword",
									"ignore_above": 256
								}
							}
						},
						"operatorOfficeAlias": {
							"type": "text",
							"fields": {
								"keyword": {
									"type": "keyword",
									"ignore_above": 256
								}
							}
						},
						"operatorOfficeName": {
							"type": "text",
							"fields": {
								"keyword": {
									"type": "keyword",
									"ignore_above": 256
								}
							}
						},
						"operatorRole": {
							"type": "text",
							"fields": {
								"keyword": {
									"type": "keyword",
									"ignore_above": 256
								}
							}
						}
					}
				},
				"trackingId": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"type": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				},
				"updatedBy": {
					"type": "text",
					"fields": {
						"keyword": {
							"type": "keyword",
							"ignore_above": 256
						}
					}
				}
			}
		}
	}
}

Tech tasks:

• Log the full error here for easier production debugging
• Remove unmapped_type here when the mapping is available
• Look into create_elastic_index function in the infrastructure/elasticsearch/setup_helpers.sh file, and 20240527130750-reindex-elasticsearch.ts file. What is the synergy between these?

[euanmillar]

create_elastic_index function exists in the infrastructure/elasticsearch/setup_helpers.sh file if that helps.

[rikukissa]

That does help a bit but unless we define the schema and field types ourselves, Elasticsearch infers it for us. For most cases it does work but will hinder search performance. For instance an ID might be inferred to be a searchable text similar to names. This again might affect how search queries are executed so we're introducing unwanted unpredictability

[naftis]

We must handle this in core to sync up the search parameters and the mapping. Likely a good place is when reindexing