Developing new API which is completely driven by address hierarchy and uses AddressNode psql table to get required nodes data
const fetchGeneralAddressCode = async (organisationId, extendedModels, params, options = {}) => {
const { searchType, queryString } = params;
if (!searchType) {
throw helper.wrongInputError('Location Key should be present');
}
const metaData = await addressHierarchy.getAddressMetadata(extendedModels, organisationId);
const hierarchy = metaData.hierarchy || [];
const nodeHierarchyMetaData = hierarchy.find(obj => helper.sanitizeStringCode(obj.location_key) === helper.sanitizeStringCode(searchType)) || {};
if(!nodeHierarchyMetaData){
throw helper.wrongInputError('Invalid Location Key');
}
let parentMetaDataArr = [];
let searchTypeNodeFound = false;
if (Array.isArray(hierarchy) && hierarchy.length > 0) {
for (let i = 0; i < hierarchy.length; i++) {
if (searchTypeNodeFound || helper.sanitizeStringCode(hierarchy[i].location_key) === helper.sanitizeStringCode(searchType)) {
searchTypeNodeFound = true;
parentMetaDataArr.push(hierarchy[i + 1]);
}
}
}
const queryParameters = [];
const whereParts = [];
let heirarchyId = nodeHierarchyMetaData.id;
let nodeCode = helper.sanitizeStringCode(queryString);
const toRet = {};
toRet.data = {};
whereParts.push(`addressNode.organisation_id = $${(queryParameters.length + 1)}`);
queryParameters.push(organisationId);
whereParts.push(`addressNode.hierarchy_id = $${(queryParameters.length + 1)}`);
queryParameters.push(heirarchyId);
whereParts.push(`addressNode.code = $${(queryParameters.length + 1)}`);
queryParameters.push(nodeCode);
const queryToExecute = `SELECT
addressNode.id as node_id,addressNode.code as node_code,addressNode.name as node_name,addressNode.hierarchy_id as hierarchy_id,
addressNode.parent_node_id as parent_node_id,parentAddressNode.code as parent_code,parentAddressNode.name as parent_name
FROM addressNode
JOIN addressNode AS parentAddressNode on addressNode.parent_node_id = parentAddressNode.id
WHERE ${whereParts.join(' AND ')}`;
const result = await helper.executeQueryAsync(extendedModels.AddressNode, queryToExecute, queryParameters, options);
if (result[0] && result[0].node_name) {
toRet.data[searchType] = result[0].node_name;
} else {
throw helper.wrongInputError('Data not found for this location key');
}
let nextNodesResult = result;
for (let i = 0; i < parentMetaDataArr.length; i++) {
try {
heirarchyId = parentMetaDataArr[i].id;
nodeCode = nextNodesResult[0].parent_code;
const locationKey = parentMetaDataArr[i].location_key;
queryParameters[1] = heirarchyId;
queryParameters[2] = nodeCode;
nextNodesResult = await helper.executeQueryAsync(extendedModels.AddressNode, queryToExecute, queryParameters, options);
if (nextNodesResult[0] && nextNodesResult[0].node_name) {
toRet.data[locationKey] = nextNodesResult[0].node_name;
}
} catch (err) {
***********************************
// to be decided what to do if any of middle hierarchy nodedata is missing
// is it possible in prod db to occur
***********************************
}
}
return toRet;
};
success response type will be like
{
"data": {
"pincode": "DAM",
"city": "Z1",
"state": "DAMMAM"
}
}
Point to consider for better efficiency of this api(lesser load on db):
on loading page on frontend side fetch all possible node values for each address field (in useEffect)
on selecting any of value from dropdown of any field this api will be called by passing
queryString=selectedValue of nodeandsearchType=type of selected fieldFrontend changes to be done in add consignment(crm) alongwith customer-portal and counter-booking(crm). (@saarthak to confirm all screens(frontend) where this change has to be done).
What to do if any of middle node in hierarchy data is not found commented in above code snippet in catch block because it will hinder fetching data of other higher level (is it possible to occur in prod DB)
Should disable all highe level nodes irrespective of the case that their value is fetched or not OR disable only those fields for which value is fetched. @saarthak
Frontend changes:
In case allowOverrideHierarchy is false , we will let user only enter values from dropdown only
else user can either select from dropdown or enter other values too
{!this.state.allowOverrideHierarchy && getFieldDecorator('sender_country', {
rules: [{ required: false, message: t('cannot_be_empty') }],
})(
<Select
showSearch
optionFilterProp="children"
onChange={(value) => this.saveAddressUsingAddressHierarchy(value, 'country', 'sender')}
placeholder={t("Country")}
disabled={this.state.senderDisableCountry}
onSearch={this.loadCountries}
allowClear
>
{this.state?.countriesList?.map(opt => <Option key={opt.id} value={opt.code}>{t(opt.name)} ({opt.code})</Option>)}
</Select>,
)}
{this.state.allowOverrideHierarchy && getFieldDecorator('sender_country', {
rules: [{ required: false, message: t('cannot_be_empty') }],
})(
<AutoComplete
options={this.state?.countriesList?.map(item => ({ label: `${item.name} (${item.code})`, value: item.code }))}
onSearch={this.loadCountries}
onSelect={(value) => this.saveAddressUsingAddressHierarchy(value, 'country', 'sender')}
onChange={(value) => this.handleAddressFields('country', value, !this.state.allowOverrideHierarchy, 'sender')}
disabled={this.state.senderDisableCountry}
allowClear
>
<Input
allowClear
placeholder={t("Country")}
/>
</AutoComplete>,
Add Comment