Skip to content

Commit

Permalink
chore: add IDOX_NEXUS_CLIENT for test environment to Planx staging (#…
Browse files Browse the repository at this point in the history 
…3482)
  • Loading branch information
@jessicamcinchak
jessicamcinchak authored Aug 16, 2024
1 parent 80dd409 commit b0fbc4a
Show file tree
Hide file tree
Showing 10 changed files with 259 additions and 176 deletions.
2 changes: 2 additions & 0 deletions .env.example
View file
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,8 @@ UNIFORM_CLIENT_WYCOMBE=👻

## Forthcoming Idox Nexus integration
IDOX_NEXUS_CLIENT=👻
IDOX_NEXUS_TOKEN_URL=👻
IDOX_NEXUS_SUBMISSION_URL=👻

## End-to-end test team (borrows Lambeth's details)
GOV_UK_PAY_SECRET_E2E=👻
5 changes: 4 additions & 1 deletion api.planx.uk/.env.test.example
View file
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,7 @@ UNIFORM_SUBMISSION_URL=👻

SLACK_WEBHOOK_URL=👻

ORDNANCE_SURVEY_API_KEY=👻
ORDNANCE_SURVEY_API_KEY=👻

IDOX_NEXUS_TOKEN_URL=👻
IDOX_NEXUS_SUBMISSION_URL=👻
12 changes: 9 additions & 3 deletions api.planx.uk/modules/admin/session/zip.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ import { buildSubmissionExportZip } from "../../send/utils/exportZip.js";
* @swagger
* /admin/session/{sessionId}/zip:
* get:
* summary: Generates and downloads a zip file for Send to Email, or Uniform when XML is included
* description: Generates and downloads a zip file for Send to Email, or Uniform when XML is included
* summary: Generates and downloads a zip file for integrations
* description: Generates and downloads a zip file for integrations
* tags:
* - admin
* parameters:
Expand All @@ -21,6 +21,11 @@ import { buildSubmissionExportZip } from "../../send/utils/exportZip.js";
* type: boolean
* required: false
* description: If the Digital Planning JSON file should be included in the zip (only generated for supported application types)
* - in: query
* name: onlyDigitalPlanningJSON
* type: boolean
* required: false
* description: If the Digital Planning JSON file should be the ONLY file included in the zip (only generated for supported application types)
* security:
* - bearerAuth: []
*/
Expand All @@ -32,9 +37,10 @@ export async function generateZip(
try {
const zip = await buildSubmissionExportZip({
sessionId: req.params.sessionId,
includeOneAppXML: req.query.includeOneAppXML === "true",
includeOneAppXML: req.query.includeOneAppXML === "false",
includeDigitalPlanningJSON:
req.query.includeDigitalPlanningJSON === "false",
onlyDigitalPlanningJSON: req.query.onlyDigitalPlanningJSON === "false",
});
res.download(zip.filename, () => {
zip.remove();
Expand Down
2 changes: 1 addition & 1 deletion api.planx.uk/modules/send/createSendEvents/controller.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ const createSendEvents: CreateSendEventsController = async (
if (idox) {
const idoxEvent = await createScheduledEvent({
webhook: `{{HASURA_PLANX_API_URL}}/idox/${idox.localAuthority}`,
schedule_at: new Date(now.getTime() + 60 * 1000),
schedule_at: new Date(now.getTime()), // now() is good for testing, but should be staggered if dual processing in future
payload: idox.body,
comment: `idox_nexus_submission_${sessionId}`,
});
Expand Down
137 changes: 75 additions & 62 deletions api.planx.uk/modules/send/idox/nexus.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,25 +9,25 @@ import { $api } from "../../../client/index.js";
import { markSessionAsSubmitted } from "../../saveAndReturn/service/utils.js";
import { buildSubmissionExportZip } from "../utils/exportZip.js";

interface UniformClient {
interface IdoxNexusClient {
clientId: string;
clientSecret: string;
}

interface UniformSubmissionResponse {
submissionStatus?: string;
canDownload?: boolean;
submissionId?: string;
}

interface RawUniformAuthResponse {
interface RawIdoxNexusAuthResponse {
access_token: string;
}

interface UniformAuthResponse {
interface IdoxNexusAuthResponse {
token: string;
organisation: string;
organisationId: string;
organisations: Record<string, string>;
authorities: string[];
}

interface UniformSubmissionResponse {
submissionStatus?: string;
canDownload?: boolean;
submissionId?: string;
}

interface UniformApplication {
Expand All @@ -39,7 +39,7 @@ interface UniformApplication {
created_at: string;
}

interface SendToUniformPayload {
interface SendToIdoxNexusPayload {
sessionId: string;
}

Expand All @@ -49,16 +49,16 @@ export async function sendToIdoxNexus(
next: NextFunction,
) {
/**
* Submits application data to Uniform
* Submits application data to Idox's Submission API (aka Nexus)
*
* first, create a zip folder containing an XML (Idox's schema), CSV (our format), and any user-uploaded files
* first, create a zip folder containing the ODP Schema JSON
* then, make requests to Uniform's "Submission API" to authenticate, create a submission, and attach the zip to the submission
* finally, insert a record into uniform_applications for future auditing
*/
req.setTimeout(120 * 1000); // Temporary bump to address submission timeouts

// `/uniform/:localAuthority` is only called via Hasura's scheduled event webhook now, so body is wrapped in a "payload" key
const payload: SendToUniformPayload = req.body.payload;
// `/idox/:localAuthority` is only called via Hasura's scheduled event webhook now, so body is wrapped in a "payload" key
const payload: SendToIdoxNexusPayload = req.body.payload;
if (!payload?.sessionId) {
return next({
status: 400,
Expand All @@ -68,39 +68,46 @@ export async function sendToIdoxNexus(

// localAuthority is only parsed for audit record, not client-specific
const localAuthority = req.params.localAuthority;
const uniformClient = getUniformClient();
const idoxNexusClient = getIdoxNexusClient();

// confirm that this session has not already been successfully submitted before proceeding
const submittedApp = await checkUniformAuditTable(payload?.sessionId);
const isAlreadySubmitted =
const _isAlreadySubmitted =
submittedApp?.submissionStatus === "PENDING" && submittedApp?.canDownload;
if (isAlreadySubmitted) {
return res.status(200).send({
sessionId: payload?.sessionId,
idoxSubmissionId: submittedApp?.submissionId,
message: `Skipping send, already successfully submitted`,
});
}
// if (isAlreadySubmitted) {
// return res.status(200).send({
// sessionId: payload?.sessionId,
// idoxSubmissionId: submittedApp?.submissionId,
// message: `Skipping send, already successfully submitted`,
// });
// }

try {
// Request 1/4 - Authenticate
const { token, organisation, organisationId } =
await authenticate(uniformClient);
const { token, organisations } = await authenticate(idoxNexusClient);

// 2/4 - Create a submission
const idoxSubmissionId = await createSubmission(
token,
organisation,
organisationId,
payload.sessionId,
);
// TEMP - Mock organisations do NOT correspond to council envs, so randomly alternate submissions among ones we have access to for initial testing
// Switch to `team_integrations`-based approach later
const orgIds = Object.keys(organisations);
const randomOrgId = orgIds[Math.floor(Math.random() * orgIds.length)];
const randomOrg = organisations[randomOrgId];

// 3/4 - Create & attach the zip
// Create a zip containing only the ODP Schema JSON
// Do this BEFORE creating a submission in order to throw any validation errors early
const zip = await buildSubmissionExportZip({
sessionId: payload.sessionId,
onlyDigitalPlanningJSON: true,
});

// 2/4 - Create a submission
const idoxSubmissionId = await createSubmission(
token,
randomOrg,
randomOrgId,
payload.sessionId,
);

// 3/4 - Attach the zip
const attachmentAdded = await attachArchive(
token,
idoxSubmissionId,
Expand All @@ -112,7 +119,6 @@ export async function sendToIdoxNexus(

// 4/4 - Get submission details and create audit record
const submissionDetails = await retrieveSubmission(token, idoxSubmissionId);

const applicationAuditRecord = await createUniformApplicationAuditRecord({
idoxSubmissionId,
submissionDetails,
Expand All @@ -124,7 +130,7 @@ export async function sendToIdoxNexus(
markSessionAsSubmitted(payload?.sessionId);

return res.status(200).send({
message: `Successfully created an Idox Nexus submission`,
message: `Successfully created an Idox Nexus submission (${randomOrgId} - ${randomOrg})`,
zipAttached: attachmentAdded,
application: applicationAuditRecord,
});
Expand Down Expand Up @@ -172,14 +178,14 @@ async function checkUniformAuditTable(
async function authenticate({
clientId,
clientSecret,
}: UniformClient): Promise<UniformAuthResponse> {
}: IdoxNexusClient): Promise<IdoxNexusAuthResponse> {
const authString = Buffer.from(`${clientId}:${clientSecret}`).toString(
"base64",
);

const authConfig: AxiosRequestConfig = {
method: "POST",
url: process.env.UNIFORM_TOKEN_URL!,
url: process.env.IDOX_NEXUS_TOKEN_URL!,
headers: {
Authorization: `Basic ${authString}`,
"Content-type": "application/x-www-form-urlencoded",
Expand All @@ -191,30 +197,32 @@ async function authenticate({
}),
};

const response = await axios.request<RawUniformAuthResponse>(authConfig);
const response = await axios.request<RawIdoxNexusAuthResponse>(authConfig);

if (!response.data.access_token) {
throw Error("Failed to authenticate to Uniform - no access token returned");
throw Error(
"Failed to authenticate to Idox Nexus - no access token returned",
);
}

// Decode access_token to get "organisation-name" & "organisation-id"
// Decode access_token to get "organisations" & "authorities"
const decodedAccessToken = jwt.decode(response.data.access_token) as any;
const organisation = decodedAccessToken?.["organisation-name"];
const organisationId = decodedAccessToken?.["organisation-id"];
const organisations = decodedAccessToken?.["organisations"];
const authorities = decodedAccessToken?.["authorities"];

if (!organisation || !organisationId) {
if (!organisations || !authorities) {
throw Error(
"Failed to authenticate to Uniform - failed to decode organisation details from access_token",
"Failed to authenticate to Idox Nexus - failed to decode organisations or authorities from access_token",
);
}

const uniformAuthResponse: UniformAuthResponse = {
const idoxNexusAuthResponse: IdoxNexusAuthResponse = {
token: response.data.access_token,
organisation: organisation,
organisationId: organisationId,
organisations: organisations,
authorities: authorities,
};

return uniformAuthResponse;
return idoxNexusAuthResponse;
}

/**
Expand All @@ -227,13 +235,19 @@ async function createSubmission(
organisationId: string,
sessionId = "TEST",
): Promise<string> {
const createSubmissionEndpoint = `${process.env
.UNIFORM_SUBMISSION_URL!}/secure/submission`;
const createSubmissionEndpoint = `${process.env.IDOX_NEXUS_SUBMISSION_URL!}/secure/submission`;

const isStaging = ["mock-server", "staging"].some((hostname) =>
const isStaging = ["mock-server", "staging", "dev"].some((hostname) =>
createSubmissionEndpoint.includes(hostname),
);

// Get the application type prefix (eg "ldc", "pp", "pa") to send as the "entity"
const session = await $api.session.find(sessionId);
const rawApplicationType = session?.data.passport.data?.[
"application.type"
] as string[];
const applicationTypePrefix = rawApplicationType?.[0]?.split(".")?.[0];

const createSubmissionConfig: AxiosRequestConfig = {
url: createSubmissionEndpoint,
method: "POST",
Expand All @@ -242,15 +256,15 @@ async function createSubmission(
"Content-type": "application/json",
},
data: JSON.stringify({
entity: "dc",
module: "dc",
entity: applicationTypePrefix,
module: "dcplanx",
organisation: organisation,
organisationId: organisationId,
submissionReference: sessionId,
description: isStaging
? "Staging submission from PlanX"
: "Production submission from PlanX",
submissionProcessorType: "API",
submissionProcessorType: "PLANX_QUEUE",
}),
};

Expand Down Expand Up @@ -283,8 +297,7 @@ async function attachArchive(
return false;
}

const attachArchiveEndpoint = `${process.env
.UNIFORM_SUBMISSION_URL!}/secure/submission/${submissionId}/archive`;
const attachArchiveEndpoint = `${process.env.IDOX_NEXUS_SUBMISSION_URL!}/secure/submission/${submissionId}/archive`;

const formData = new FormData();
formData.append("file", fs.createReadStream(zipPath));
Expand All @@ -306,7 +319,7 @@ async function attachArchive(
const isSuccess = response.status === 204;

// Temp additional logging to debug failures
console.log("*** Uniform attachArchive response ***");
console.log("*** Idox Nexus attachArchive response ***");
console.log({ status: response.status });
console.log(JSON.stringify(response.data, null, 2));
console.log("******");
Expand All @@ -323,7 +336,7 @@ async function retrieveSubmission(
submissionId: string,
): Promise<UniformSubmissionResponse> {
const getSubmissionEndpoint = `${process.env
.UNIFORM_SUBMISSION_URL!}/secure/submission/${submissionId}`;
.IDOX_NEXUS_SUBMISSION_URL!}/secure/submission/${submissionId}`;

const getSubmissionConfig: AxiosRequestConfig = {
url: getSubmissionEndpoint,
Expand All @@ -340,7 +353,7 @@ async function retrieveSubmission(
/**
* Get id and secret of Idox Nexus client
*/
const getUniformClient = (): UniformClient => {
const getIdoxNexusClient = (): IdoxNexusClient => {
const client = process.env["IDOX_NEXUS_CLIENT"];

if (!client) throw Error(`Unable to find Idox Nexus client`);
Expand All @@ -356,7 +369,7 @@ const createUniformApplicationAuditRecord = async ({
submissionDetails,
}: {
idoxSubmissionId: string;
payload: SendToUniformPayload;
payload: SendToIdoxNexusPayload;
localAuthority: string;
submissionDetails: UniformSubmissionResponse;
}): Promise<UniformApplication> => {
Expand Down
Loading

0 comments on commit b0fbc4a

Please sign in to comment.