Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
@antoineludeau
antoineludeau committed Sep 17, 2024
1 parent 084d773 commit 691bc09
Show file tree
Hide file tree
Showing 5 changed files with 88 additions and 58 deletions.
22 changes: 11 additions & 11 deletions src/bal-converter/helpers/validator.test.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -81,50 +81,50 @@ const balWithDifferentDistrictID = [

describe("balTopoToBanTopo", () => {
test("Should return true as bal 1.3 uses ban IDs", async () => {
expect(await validator(districtID, balJSON_1, '1.3')).toMatchSnapshot();
expect(await validator([districtID], balJSON_1, '1.3')).toMatchSnapshot();
});

test("Should return true as bal 1.4 uses ban IDs", async () => {
expect(await validator(districtID, balJSON_2, '1.4')).toMatchSnapshot();
expect(await validator([districtID], balJSON_2, '1.4')).toMatchSnapshot();
});

test("Should return false as bal does not use ban IDs", async () => {
expect(await validator(districtID, balJSONlegacy, '1.3')).toMatchSnapshot();
expect(await validator([districtID], balJSONlegacy, '1.3')).toMatchSnapshot();
});

test("Should throw an error as bal does not have a district ID on one of its line", async () => {
await expect(
validator(districtID, balJSONSimplifiedAndModified_1, '1.3')
validator([districtID], balJSONSimplifiedAndModified_1, '1.3')
).rejects.toThrowError(/Missing districtID/);
});

test("Should throw an error as bal does not have a common toponym ID on one of its line", async () => {
await expect(
validator(districtID, balJSONSimplifiedAndModified_2, '1.3')
validator([districtID], balJSONSimplifiedAndModified_2, '1.3')
).rejects.toThrowError(/Missing mainTopoID/);
});

test("Should throw an error as bal does not have an address ID on one of its line that has a number different from the topo number", async () => {
await expect(
validator(districtID, balJSONSimplifiedAndModified_3, '1.3')
validator([districtID], balJSONSimplifiedAndModified_3, '1.3')
).rejects.toThrowError(/Missing addressID/);
});

test("Should throw an error as some lines are using BanIDs and some are not", async () => {
await expect(
validator(districtID, balJSONSimplifiedAndModified_4, '1.3')
validator([districtID], balJSONSimplifiedAndModified_4, '1.3')
).rejects.toThrowError(/Some lines are using BanIDs and some are not/);
})

test("Should throw an error as multiple district IDs", async () => {
test("Should throw an error as one of district ID from BAL is not part of the authorized district ID", async () => {
await expect(
validator(districtID, balWithMultipleDistrictIDs, '1.4')
).rejects.toThrowError(/Multiple district IDs/);
validator([districtID], balWithMultipleDistrictIDs, '1.4')
).rejects.toThrowError(/Missing rights/);
})

test("Should throw an error as district ID from BAL different from district ID from district DB", async () => {
await expect(
validator(districtID, balWithDifferentDistrictID, '1.4')
validator([districtID], balWithDifferentDistrictID, '1.4')
).rejects.toThrowError(/Missing rights/);
})
});
16 changes: 8 additions & 8 deletions src/bal-converter/helpers/validator.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@ import { logger } from "../../utils/logger.js";
import { digestIDsFromBalAddr } from "./index.js";
import { numberForTopo as IS_TOPO_NB } from "../bal-converter.config.js";

const validator = async (districtID: string, bal: Bal, version: BalVersion) => {
const validator = async (districtIDsFromDB: string[], bal: Bal, version: BalVersion) => {
let balAdresseUseBanId = 0
let balAddressDoNotUseBanId = 0
const districtIDs = new Set();
const districtIDsExtracted: string[] = [];
for (const balAdresse of bal) {
// Check presence and format of BanIDs
const { districtID, mainTopoID, addressID } = digestIDsFromBalAddr(
Expand All @@ -28,19 +28,19 @@ const validator = async (districtID: string, bal: Bal, version: BalVersion) => {
throw new Error(`Missing addressID - bal address ${JSON.stringify(balAdresse)}`);
}
balAdresseUseBanId++
districtIDs.add(districtID);
if (!districtIDsExtracted.includes(districtID)) {
districtIDsExtracted.push(districtID);
}
} else {
balAddressDoNotUseBanId++
}
}

if (balAdresseUseBanId === bal.length){
// Check district IDs consistency
if (districtIDs.size > 1){
throw new Error(`Multiple district IDs - ${JSON.stringify([...districtIDs])}`);
}
if (!districtIDs.has(districtID)){
throw new Error(`Missing rights - District ID ${districtID} cannot be updated`);
if (!districtIDsExtracted.every(districtIDExtracted => districtIDsFromDB.includes(districtIDExtracted))) {
const unauthorizedDistrictIDs = districtIDsExtracted.filter(districtIDExtracted => !districtIDsFromDB.includes(districtIDExtracted));
throw new Error(`Missing rights - districtIDs ${unauthorizedDistrictIDs} are not part of the authorized districts to be updated`);
}
return true;
} else if (balAddressDoNotUseBanId === bal.length){
Expand Down
96 changes: 60 additions & 36 deletions src/compute-from-cog.ts
View file
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
// Get revision from dump-api (api de dépôt)
import { logger } from "./utils/logger.js";
import {
getRevisionFromDistrictCOG,
getRevisionFileText,
getRevisionData,
} from "./dump-api/index.js";
import { sendBalToBan } from "./bal-converter/index.js";
import {
Expand All @@ -17,6 +16,8 @@ import {
} from "./bal-converter/helpers/index.js";

import acceptedCogList from "./accepted-cog-list.json" assert { type: "json" };
import { BalAdresse } from "./types/bal-types.js";
import { BanDistrict } from "./types/ban-types.js";

export const computeFromCog = async (
cog: string,
Expand All @@ -35,31 +36,27 @@ export const computeFromCog = async (

logger.info(`District cog ${cog} is part of the whitelist.`);

const revision = await getRevisionFromDistrictCOG(cog);
const revisionFileText = await getRevisionFileText(revision._id);

// Get BAL text data from dump-api
const {revision, balTextData: balCsvData} = await getRevisionData(cog);
// Convert csv to json
const bal = csvBalToJsonBal(revisionFileText);
const bal = csvBalToJsonBal(balCsvData);

// Detect BAL version
const version = getBalVersion(bal);
logger.info(`District cog ${cog} is using BAL version ${version}`);

const districtResponseRaw = await getDistrictFromCOG(cog);
if (!districtResponseRaw.length) {
const districts: BanDistrict[] = await getDistrictFromCOG(cog);
if (!districts.length) {
throw new Error(`No district found with cog ${cog}`);
} else if (districtResponseRaw.length > 1) {
throw new Error(
`Multiple district found with cog ${cog}. Behavior not handled yet.`
);
}

const { id } = districtResponseRaw[0];
const districtIDsFromDB = districts.map((district) => district.id);

// Check if bal is using BanID
// If not, send process to ban-plateforme legacy API
// If the use of IDs is partial, throwing an error
const useBanId = await validator(id, bal, version);
const useBanId = await validator(districtIDsFromDB, bal, version);

if (!useBanId) {
logger.info(
Expand All @@ -68,32 +65,59 @@ export const computeFromCog = async (
return await sendBalToLegacyCompose(cog, forceLegacyCompose as string);
} else {
logger.info(`District cog ${cog} is using banID`);
// Update District meta with revision data from dump-api (id and date)
const districtUpdate = {
id,
meta: {
bal: {
idRevision: revision._id,
dateRevision: revision.publishedAt,
},

// Split BAL by district ID to handle multiple districts in a BAL
const splitBalPerDistictID = bal.reduce(
(acc: { [key: string]: BalAdresse[] }, balAdresse) => {
if (balAdresse.id_ban_commune) {
if (!acc[balAdresse.id_ban_commune]) {
acc[balAdresse.id_ban_commune] = [];
}
acc[balAdresse.id_ban_commune].push(balAdresse);
}
return acc;
},
};
await partialUpdateDistricts([districtUpdate]);
{}
);

const result = (await sendBalToBan(bal)) || {};
const results = []
for (let i = 0; i < Object.keys(splitBalPerDistictID).length; i++) {
const [id, bal] = Object.entries(splitBalPerDistictID)[i];
try {
// Update District meta with revision data from dump-api (id and date)
const districtUpdate = {
id,
meta: {
bal: {
idRevision: revision._id,
dateRevision: revision.publishedAt,
},
},
};
await partialUpdateDistricts([districtUpdate]);

if (!Object.keys(result).length) {
const response = `District id ${id} not updated in BAN BDD. No changes detected.`;
logger.info(response);
return response;
}
const result = (await sendBalToBan(bal)) || {};

logger.info(
`District id ${id} updated in BAN BDD. Response body : ${JSON.stringify(
result
)}`
);
if (!Object.keys(result).length) {
const response = `District id ${id} (cog: ${cog}) not updated in BAN BDD. No changes detected.`;
logger.info(response);
return response;
}

logger.info(
`District id ${id} (cog: ${cog}) updated in BAN BDD. Response body : ${JSON.stringify(
result
)}`
);

results.push(result);
} catch (error) {
const { message } = error as Error;
logger.error(message);
results.push(`Error for district ${id} (cog: ${cog}) : ${message}`);
}
};

return result;
return results;
}
};
10 changes: 8 additions & 2 deletions src/dump-api/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,13 @@ import HandleHTTPResponse from "../utils/http-request-handler.js";

const API_DEPOT_URL = process.env.API_DEPOT_URL || "";

export const getRevisionFromDistrictCOG = async (cog: string) => {
export const getRevisionData = async (cog: string) => {
const revision = await getRevisionFromDistrictCOG(cog);
const balTextData = await getRevisionFileText(revision._id);
return {revision, balTextData};
}

const getRevisionFromDistrictCOG = async (cog: string) => {
try {
const response = await fetch(
`${API_DEPOT_URL}/communes/${cog}/current-revision`
Expand All @@ -14,7 +20,7 @@ export const getRevisionFromDistrictCOG = async (cog: string) => {
}
};

export const getRevisionFileText = async (revisionId: string) => {
const getRevisionFileText = async (revisionId: string) => {
try {
const response = await fetch(
`${API_DEPOT_URL}/revisions/${revisionId}/files/bal/download`
Expand Down
2 changes: 1 addition & 1 deletion src/types/ban-types.d.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ export type Label = {
};

export type BanDistrict = {
districtID: BanDistrictID; // code INSEE de la commune
id: BanDistrictID; // code INSEE de la commune
labels: {
isoCode: LangISO639v3; // code ISO de la langue
value: string; // nom de la voie
Expand Down

0 comments on commit 691bc09

Please sign in to comment.