Pre-fill values, require an explicit compatibility status and add the contact reminder (section 23.1)
This commit is contained in:
1 parent
cfa138fb90
commit
dd25b81aeb
1 file changed
+60
-17
+60
-17
@@ -6,8 +6,11 @@ const keyCheck = document.querySelector("#key-check");
|
|||||||
const softwareSection = document.querySelector("#software-section");
|
const softwareSection = document.querySelector("#software-section");
|
||||||
const softwareGrid = document.querySelector("#software-section .field-grid");
|
const softwareGrid = document.querySelector("#software-section .field-grid");
|
||||||
const walletSoftwareSelect = document.querySelector("#wallet-software");
|
const walletSoftwareSelect = document.querySelector("#wallet-software");
|
||||||
|
const softwareCompatibilitySelect = document.querySelector("#software-compatibility");
|
||||||
const softwareVersionInput = document.querySelector("#software-version");
|
const softwareVersionInput = document.querySelector("#software-version");
|
||||||
const softwareHelp = document.querySelector("#software-help");
|
const softwareHelp = document.querySelector("#software-help");
|
||||||
|
const contactSelect = document.querySelector("#contact-info-verified");
|
||||||
|
const contactReminder = document.querySelector("#contact-reminder");
|
||||||
const toolChecks = document.querySelector("#tool-checks");
|
const toolChecks = document.querySelector("#tool-checks");
|
||||||
const securityChecks = document.querySelector("#security-checks");
|
const securityChecks = document.querySelector("#security-checks");
|
||||||
const nextCheckPreview = document.querySelector("#next-check-preview");
|
const nextCheckPreview = document.querySelector("#next-check-preview");
|
||||||
@@ -26,6 +29,8 @@ const SECURITY_STATUSES = ["SECURE", "PATCHED", "VULNERABLE", "COMPROMISED"];
|
|||||||
const UNRESOLVED_STATUSES = ["VULNERABLE", "COMPROMISED"];
|
const UNRESOLVED_STATUSES = ["VULNERABLE", "COMPROMISED"];
|
||||||
const DEFAULT_SECURITY_STATUS = "SECURE";
|
const DEFAULT_SECURITY_STATUS = "SECURE";
|
||||||
const UNAVAILABLE_MESSAGE = "The remaining checks for this key cannot be recorded.";
|
const UNAVAILABLE_MESSAGE = "The remaining checks for this key cannot be recorded.";
|
||||||
|
// The contact result that reminds the user to update their own records (section 23.1).
|
||||||
|
const CONTACT_NEEDS_UPDATE = "Needs external update";
|
||||||
const generalStatuses = [
|
const generalStatuses = [
|
||||||
["NOT_ASSESSED", "Not assessed"],
|
["NOT_ASSESSED", "Not assessed"],
|
||||||
["OK", "OK"],
|
["OK", "OK"],
|
||||||
@@ -47,6 +52,8 @@ const booleanOptions = [["", "Not assessed"], ["1", "Yes"], ["0", "No"]];
|
|||||||
let keyProfiles = [];
|
let keyProfiles = [];
|
||||||
let previousValues = { keys: [], security: {} };
|
let previousValues = { keys: [], security: {} };
|
||||||
let carriedSecurity = [];
|
let carriedSecurity = [];
|
||||||
|
// True while the compatibility control carries the value derived for a cloud key.
|
||||||
|
let compatibilityDerived = false;
|
||||||
|
|
||||||
function emptyState(text) {
|
function emptyState(text) {
|
||||||
const message = document.createElement("p");
|
const message = document.createElement("p");
|
||||||
@@ -83,15 +90,15 @@ function makeSelect(options, name, placeholder = "") {
|
|||||||
return select;
|
return select;
|
||||||
}
|
}
|
||||||
|
|
||||||
function makeTextInput(name, maxLength = 200, placeholder = "") {
|
function makeTextInput(name, maxLength = 200, value = "") {
|
||||||
const input = document.createElement("input");
|
const input = document.createElement("input");
|
||||||
input.type = "text";
|
input.type = "text";
|
||||||
input.name = name;
|
input.name = name;
|
||||||
input.maxLength = maxLength;
|
input.maxLength = maxLength;
|
||||||
input.autocomplete = "off";
|
input.autocomplete = "off";
|
||||||
if (placeholder) {
|
// A previous value is a real input value, not a placeholder, so a field the
|
||||||
input.placeholder = placeholder;
|
// user does not touch is saved as it stands (section 23.1).
|
||||||
}
|
input.value = value;
|
||||||
return input;
|
return input;
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -133,6 +140,11 @@ function previousSecurity(provider) {
|
|||||||
return (previousValues.security || {})[provider] || null;
|
return (previousValues.security || {})[provider] || null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function previousText(previous, field) {
|
||||||
|
// An empty field is the right answer when no relevant value was saved.
|
||||||
|
return (previous && previous[field]) || "";
|
||||||
|
}
|
||||||
|
|
||||||
function keyProductFor(key) {
|
function keyProductFor(key) {
|
||||||
return KEY_PRODUCTS[key.key_number];
|
return KEY_PRODUCTS[key.key_number];
|
||||||
}
|
}
|
||||||
@@ -195,7 +207,7 @@ function renderKeyCheck() {
|
|||||||
details.append(makeField(
|
details.append(makeField(
|
||||||
"Firmware version",
|
"Firmware version",
|
||||||
"firmware_version",
|
"firmware_version",
|
||||||
makeTextInput("firmware_version", 100, previous ? previous.firmware_version : ""),
|
makeTextInput("firmware_version", 100, previousText(previous, "firmware_version")),
|
||||||
));
|
));
|
||||||
details.append(makeField(
|
details.append(makeField(
|
||||||
"Seed backup intact and matching the device",
|
"Seed backup intact and matching the device",
|
||||||
@@ -208,7 +220,7 @@ function renderKeyCheck() {
|
|||||||
details.append(makeField(
|
details.append(makeField(
|
||||||
"Address path",
|
"Address path",
|
||||||
"address_path",
|
"address_path",
|
||||||
makeTextInput("address_path", 200, previous ? previous.address_path : ""),
|
makeTextInput("address_path", 200, previousText(previous, "address_path")),
|
||||||
));
|
));
|
||||||
card.append(details);
|
card.append(details);
|
||||||
card.append(makeField("Key notes", "key_comments", makeTextarea("key_comments")));
|
card.append(makeField("Key notes", "key_comments", makeTextarea("key_comments")));
|
||||||
@@ -239,17 +251,18 @@ function syncRequiredFields() {
|
|||||||
|
|
||||||
function syncAddressPathField() {
|
function syncAddressPathField() {
|
||||||
// The path is only recorded when it was verified as OK, so an unverified or
|
// The path is only recorded when it was verified as OK, so an unverified or
|
||||||
// failed result never stores a path (section 21).
|
// failed result never stores a path (section 21). The control is disabled
|
||||||
|
// while it is hidden instead of cleared, so a pre-filled path is kept for the
|
||||||
|
// user and still cannot be submitted with an unverified result.
|
||||||
const field = form.querySelector('[name="address_path"]')?.closest(".field");
|
const field = form.querySelector('[name="address_path"]')?.closest(".field");
|
||||||
const verified = form.querySelector('[name="address_path_verified"]');
|
const verified = form.querySelector('[name="address_path_verified"]');
|
||||||
if (!field || verified === null) {
|
if (!field || verified === null) {
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
const input = form.querySelector('[name="address_path"]');
|
||||||
const show = Boolean(selectedKey()) && verified.value === "OK";
|
const show = Boolean(selectedKey()) && verified.value === "OK";
|
||||||
field.hidden = !show;
|
field.hidden = !show;
|
||||||
if (!show) {
|
input.disabled = !show;
|
||||||
form.querySelector('[name="address_path"]').value = "";
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function syncUnavailableState() {
|
function syncUnavailableState() {
|
||||||
@@ -260,6 +273,9 @@ function syncUnavailableState() {
|
|||||||
toolChecksSection.hidden = unavailable;
|
toolChecksSection.hidden = unavailable;
|
||||||
securityChecksSection.hidden = unavailable;
|
securityChecksSection.hidden = unavailable;
|
||||||
walletSoftwareSelect.required = !unavailable;
|
walletSoftwareSelect.required = !unavailable;
|
||||||
|
// A hidden required control blocks the submission, so the compatibility
|
||||||
|
// result is not required for a key that was not available either.
|
||||||
|
softwareCompatibilitySelect.required = !unavailable;
|
||||||
}
|
}
|
||||||
|
|
||||||
function lockSoftwareFields() {
|
function lockSoftwareFields() {
|
||||||
@@ -270,22 +286,41 @@ function lockSoftwareFields() {
|
|||||||
softwareGrid.hidden = isCloud;
|
softwareGrid.hidden = isCloud;
|
||||||
if (isCloud) {
|
if (isCloud) {
|
||||||
walletSoftwareSelect.value = "Nunchuk";
|
walletSoftwareSelect.value = "Nunchuk";
|
||||||
|
// Compatibility is derived from availability for the cloud key, so the
|
||||||
|
// hidden control carries the derived value instead of asking for one
|
||||||
|
// (section 20).
|
||||||
|
softwareCompatibilitySelect.value = "OK";
|
||||||
|
compatibilityDerived = true;
|
||||||
softwareHelp.textContent = "Compatibility is derived from availability for the cloud key: available gives OK, not available gives not assessed.";
|
softwareHelp.textContent = "Compatibility is derived from availability for the cloud key: available gives OK, not available gives not assessed.";
|
||||||
} else {
|
} else {
|
||||||
|
if (compatibilityDerived) {
|
||||||
|
// The derived value is not an answer for another key, so it is cleared.
|
||||||
|
softwareCompatibilitySelect.value = "";
|
||||||
|
compatibilityDerived = false;
|
||||||
|
}
|
||||||
softwareHelp.textContent = "Record the version of the software you selected for this key.";
|
softwareHelp.textContent = "Record the version of the software you selected for this key.";
|
||||||
}
|
}
|
||||||
updateSoftwareVersionPlaceholder();
|
updateSoftwareVersionValue();
|
||||||
}
|
}
|
||||||
|
|
||||||
function updateSoftwareVersionPlaceholder() {
|
function updateSoftwareVersionValue() {
|
||||||
const key = selectedKey();
|
const key = selectedKey();
|
||||||
const previous = key ? previousForKey(key.id) : null;
|
const previous = key ? previousForKey(key.id) : null;
|
||||||
|
// The saved version belongs to the saved software choice, so it is only
|
||||||
|
// reused for the same key and the same software (section 23.1). The cloud key
|
||||||
|
// has no version field of its own.
|
||||||
const reusable = Boolean(key)
|
const reusable = Boolean(key)
|
||||||
&& key.key_number !== CLOUD_KEY_NUMBER
|
&& key.key_number !== CLOUD_KEY_NUMBER
|
||||||
&& previous
|
&& previous
|
||||||
&& previous.wallet_software === walletSoftwareSelect.value
|
&& previous.wallet_software === walletSoftwareSelect.value
|
||||||
&& previous.software_version;
|
&& previous.software_version;
|
||||||
softwareVersionInput.placeholder = reusable ? previous.software_version : "";
|
softwareVersionInput.value = reusable ? previous.software_version : "";
|
||||||
|
}
|
||||||
|
|
||||||
|
function syncContactReminder() {
|
||||||
|
// "Needs external update" records the status only and reminds the user to
|
||||||
|
// update the contact details in their own documentation (section 23.1).
|
||||||
|
contactReminder.hidden = contactSelect.value !== CONTACT_NEEDS_UPDATE;
|
||||||
}
|
}
|
||||||
|
|
||||||
function renderToolChecks() {
|
function renderToolChecks() {
|
||||||
@@ -449,7 +484,13 @@ function buildReview() {
|
|||||||
const value = data.get(select.name);
|
const value = data.get(select.name);
|
||||||
if (value === "" || value === "NOT_ASSESSED") {
|
if (value === "" || value === "NOT_ASSESSED") {
|
||||||
missing.push(label);
|
missing.push(label);
|
||||||
} else if (value === "PROBLEM" || value === "0" || value === "VULNERABLE" || value === "COMPROMISED") {
|
} else if (
|
||||||
|
value === "PROBLEM"
|
||||||
|
|| value === "0"
|
||||||
|
|| value === "VULNERABLE"
|
||||||
|
|| value === "COMPROMISED"
|
||||||
|
|| value === CONTACT_NEEDS_UPDATE
|
||||||
|
) {
|
||||||
const problem = `${label}: ${value}`;
|
const problem = `${label}: ${value}`;
|
||||||
problems.push(problem);
|
problems.push(problem);
|
||||||
}
|
}
|
||||||
@@ -567,9 +608,9 @@ function collectPayload() {
|
|||||||
wallet_software: unavailable ? null : data.get("wallet_software"),
|
wallet_software: unavailable ? null : data.get("wallet_software"),
|
||||||
software_version: unavailable ? "" : textValue(data, "software_version"),
|
software_version: unavailable ? "" : textValue(data, "software_version"),
|
||||||
software_compatibility_status: derived.software_compatibility_status
|
software_compatibility_status: derived.software_compatibility_status
|
||||||
|| (unavailable ? "NOT_ASSESSED" : data.get("software_compatibility_status")),
|
|| (unavailable ? "NOT_ASSESSED" : statusValue(data, "software_compatibility_status")),
|
||||||
software_comments: unavailable ? "" : textValue(data, "software_comments"),
|
software_comments: unavailable ? "" : textValue(data, "software_comments"),
|
||||||
contact_info_verified: flagValue(data, "contact_info_verified"),
|
contact_info_verified: statusValue(data, "contact_info_verified"),
|
||||||
comments: textValue(data, "comments"),
|
comments: textValue(data, "comments"),
|
||||||
key_check: collectKeyCheck(data, key, derived),
|
key_check: collectKeyCheck(data, key, derived),
|
||||||
tool_checks: unavailable ? [] : expectedProducts(key).map((product) => {
|
tool_checks: unavailable ? [] : expectedProducts(key).map((product) => {
|
||||||
@@ -647,16 +688,18 @@ async function loadFormData() {
|
|||||||
setCheckDate();
|
setCheckDate();
|
||||||
renderKeyCheck();
|
renderKeyCheck();
|
||||||
refreshKeySections();
|
refreshKeySections();
|
||||||
|
syncContactReminder();
|
||||||
saveButton.addEventListener("click", saveHealthCheck);
|
saveButton.addEventListener("click", saveHealthCheck);
|
||||||
keySelect.addEventListener("change", () => {
|
keySelect.addEventListener("change", () => {
|
||||||
renderKeyCheck();
|
renderKeyCheck();
|
||||||
refreshKeySections();
|
refreshKeySections();
|
||||||
});
|
});
|
||||||
walletSoftwareSelect.addEventListener("change", () => {
|
walletSoftwareSelect.addEventListener("change", () => {
|
||||||
updateSoftwareVersionPlaceholder();
|
updateSoftwareVersionValue();
|
||||||
renderToolChecks();
|
renderToolChecks();
|
||||||
renderSecurityChecks();
|
renderSecurityChecks();
|
||||||
});
|
});
|
||||||
|
contactSelect.addEventListener("change", syncContactReminder);
|
||||||
form.addEventListener("input", resetReview);
|
form.addEventListener("input", resetReview);
|
||||||
form.addEventListener("submit", (event) => {
|
form.addEventListener("submit", (event) => {
|
||||||
event.preventDefault();
|
event.preventDefault();
|
||||||
|
|||||||
Reference in new issue
Block a user