Skip to content

Commit

Permalink
support separate submission and guidance content
Browse files Browse the repository at this point in the history
  • Loading branch information
jessicamcinchak committed Jan 24, 2024
1 parent 769eea9 commit bd7aff7
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 6 deletions.
27 changes: 23 additions & 4 deletions titleBoundary/helpers.js
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
/**
* Find each DrawBoundary node in a flow (live or published) and update its' content if not already matching default
*/
const updateDrawBoundaryNodeData = (flowData) => {
const updateDrawBoundaryNodeData = (flowData, slug) => {
let newFlowData = flowData;
Object.entries(flowData)
.filter(([_nodeId, nodeData]) => nodeData["type"] === 10)
.forEach(([drawBoundaryNodeId, _drawBoundaryNodeData]) => newFlowData[drawBoundaryNodeId]["data"] = defaultDrawBoundaryNodeData);
.forEach(([drawBoundaryNodeId, _drawBoundaryNodeData]) => {
if (slug.startsWith("apply-for")) {
newFlowData[drawBoundaryNodeId]["data"] = defaultSubmissionDrawBoundaryNodeData;
} else {
newFlowData[drawBoundaryNodeId]["data"] = defaultGuidanceDrawBoundaryNodeData;
}
});
return newFlowData;
}

Expand All @@ -17,6 +23,8 @@ const updatePropertyInformationNodeData = (flowData) => {
return newFlowData;
}

const delay = (ms) => new Promise(res => setTimeout(res, ms));

/**
* Default DrawBoundary & PropertyInformation content as of 23 Jan 2024
* This isn't an ideal way to store or edit HTML. A nicer way to generate and update the content of this file is to:
Expand All @@ -25,7 +33,7 @@ const updatePropertyInformationNodeData = (flowData) => {
* 3. Paste formatted content here
* 4. Run migration script to bulk update existing nodes across all applicable flows
*/
const defaultDrawBoundaryNodeData = {
const defaultSubmissionDrawBoundaryNodeData = {
title: "Check or amend the outline of your property and works",
description:
"<p>The red line shown below should include:</p><ul><li><p>the outline of your property boundary</p></li><li><p>any works outside the property boundary</p></li><li><p>areas that will be closed off or you&apos;ll need access to during the works</p></li></ul><p>If the red line already includes all these, tap continue. If it does not, tap <em>More information</em> for guidance on how to amend or redraw the outline.</p>",
Expand All @@ -42,10 +50,21 @@ const defaultDrawBoundaryNodeData = {
'<p>We have pre-populated the map with a red outline that includes the entire property, using information from Land Registry.</p><p>In some cases, this outline might not include all the works or the areas that will be closed off. This could be the case if you are proposing works to a public highway (such as a dropped kerb), doing works that involve multiple properties, or works to a building that is part of a larger estate.</p><p>In these cases, you should amend the red outline by dragging the edges, or erase it by clicking the 🗑-icon on the map and draw a new outline.</p><p></p><h1>How to draw and amend the outline</h1><ol><li><p>Move the cursor to the corner you want to start with and click or tap once.</p></li><li><p>Move the cursor to the next corner and click or tap.</p></li><li><p>Repeat until you have the shape you need.</p></li><li><p>Click or tap the last corner again to stop drawing.</p></li><li><p>To amend the outline, click or tap on a line and drag it into a new position.</p></li></ol><img src="https://api.editor.planx.uk/file/public/dni98ojg/Draw_Outline_2.gif">',
};

const defaultGuidanceDrawBoundaryNodeData = {
title: "Check or amend the outline of your property and works",
description: "<p>The red line shown below should include:</p><ul><li><p>the outline of your property boundary</p></li><li><p>any works outside the property boundary</p></li><li><p>areas that will be closed off or you&apos;ll need access to during the works</p></li></ul><p>If the red line already includes all these, tap continue. If it does not, tap <em>More information</em> for guidance on how to amend or redraw the outline.</p>",
dataFieldBoundary: "property.boundary.site",
dataFieldArea: "property.boundary.area",
hideFileUpload: true,
info: "<p>This outline identifies the location of the proposed changes on a map. It helps us tell you if there are any planning constraints that might affect your project. It is sometimes called a &apos;red line drawing&apos; or &apos;location plan&apos;.</p>",
policyRef: "<p><a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"https://www.legislation.gov.uk/uksi/2015/595/article/7\">The Town and Country Planning (Development Management Procedure) (England) Order 2015</a>,</p><p><a target=\"_blank\" rel=\"noopener noreferrer nofollow\" href=\"https://www.gov.uk/government/collections/planning-practice-guidance\">Planning Practice Guidance (PPG)</a></p>",
howMeasured: "<p>We have pre-populated the map with a red outline that includes the entire property, using information from Land Registry.</p><p>In some cases, this outline might not include all the works or the areas that will be closed off. This could be the case if you are proposing works to a public highway (such as a dropped kerb), doing works that involve multiple properties, or works to a building that is part of a larger estate.</p><p>In these cases, you should amend the red outline by dragging the edges, or erase it by clicking the :wastebasket:-icon on the map and draw a new outline.</p><p></p><h1>How to draw and amend the outline</h1><ol><li><p>Move the cursor to the corner you want to start with and click or tap once.</p></li><li><p>Move the cursor to the next corner and click or tap.</p></li><li><p>Repeat until you have the shape you need.</p></li><li><p>Click or tap the last corner again to stop drawing.</p></li><li><p>To amend the outline, click or tap on a line and drag it into a new position.</p></li></ol><img src=\"https://api.editor.planx.uk/file/public/dni98ojg/Draw_Outline_2.gif\">",
};

const defaultPropertyInformationNodeData = {
"title": "About the property",
"description": "<p>This is the information we currently have about the property, including its title boundary shown in blue from the Land Registry</p>",
"showPropertyTypeOverride": true
};

module.exports = { updateDrawBoundaryNodeData, updatePropertyInformationNodeData };
module.exports = { updateDrawBoundaryNodeData, updatePropertyInformationNodeData, delay };
7 changes: 5 additions & 2 deletions titleBoundary/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -52,11 +52,11 @@ ask.start();

// Find DrawBoundary & PropertyInformation nodes in live flow data, update them
// This does NOT require a corresponding operation because we are not creating the flow for the first time
liveFlowData = updateDrawBoundaryNodeData(flow.data);
liveFlowData = updateDrawBoundaryNodeData(flow.data, flow.slug);
liveFlowData = updatePropertyInformationNodeData(liveFlowData);

// Find DrawBoundary & PropertyInformation nodes in published flow data, update them directly too
publishedFlowData = updateDrawBoundaryNodeData(flow.publishedFlows?.[0]?.data);
publishedFlowData = updateDrawBoundaryNodeData(flow.publishedFlows?.[0]?.data, flow.slug);
publishedFlowData = updatePropertyInformationNodeData(publishedFlowData);

// Write update in a single mutation block for postgres transaction-like rollback behavior on error
Expand All @@ -79,6 +79,9 @@ ask.start();
} catch (error) {
console.log(chalk.red(error));
}

// wait 5 seconds before proceeding through next item in loop to avoid Hasura timeouts
await delay(5000);
});
} else {
console.log(chalk.red(`Cannot find any flows matching slug: ${formattedSlug}. Exiting migration script`));
Expand Down

0 comments on commit bd7aff7

Please sign in to comment.