From 9129f8866227e2af762cdee499bb0f17980d65db Mon Sep 17 00:00:00 2001 From: aaronm-2112 Date: Fri, 24 Nov 2023 16:03:40 -0800 Subject: [PATCH] refactor: submission upload local submission file --- scripts/guided-mode/guided-curate-dataset.js | 20 +- scripts/metadata-files/datasetDescription.js | 16 +- scripts/metadata-files/manifest.js | 58 +-- scripts/metadata-files/readme-changes.js | 32 +- scripts/metadata-files/subjects-samples.js | 36 +- scripts/metadata-files/submission.js | 34 +- scripts/organize-dataset/curate-functions.js | 6 +- scripts/others/analytics/analytics-utils.js | 3 + scripts/others/renderer.js | 66 +-- sections/prepare_metadata/create_changes.html | 2 +- sections/prepare_metadata/create_readme.html | 2 +- sections/prepare_metadata/create_samples.html | 2 +- .../prepare_metadata/create_subjects.html | 2 +- .../prepare_metadata/create_submission.html | 6 +- .../prepare_metadata/dataset_description.html | 2 +- .../src/scripts/disseminate/disseminate.js | 2 + .../guided-mode/guided-curate-dataset.js | 20 +- .../metadata-files/datasetDescription.js | 19 +- .../src/scripts/metadata-files/manifest.js | 60 +-- .../scripts/metadata-files/readme-changes.js | 35 +- .../metadata-files/subjects-samples.js | 38 +- .../src/scripts/metadata-files/submission.js | 153 +++---- .../organize-dataset/curate-functions.js | 8 +- src/renderer/src/scripts/others/renderer.js | 398 +++++++++--------- .../prepare_metadata/create_changes.html | 2 +- .../prepare_metadata/create_readme.html | 2 +- .../prepare_metadata/create_samples.html | 2 +- .../prepare_metadata/create_subjects.html | 2 +- .../prepare_metadata/create_submission.html | 6 +- .../prepare_metadata/dataset_description.html | 2 +- 30 files changed, 531 insertions(+), 505 deletions(-) diff --git a/scripts/guided-mode/guided-curate-dataset.js b/scripts/guided-mode/guided-curate-dataset.js index 67bd2565f..db57b9f4f 100644 --- a/scripts/guided-mode/guided-curate-dataset.js +++ b/scripts/guided-mode/guided-curate-dataset.js @@ -1711,7 +1711,7 @@ const savePageChanges = async (pageBeingLeftID) => { if (pageBeingLeftID === "guided-create-submission-metadata-tab") { const award = document.getElementById("guided-submission-sparc-award-manual").value; - const milestones = getTagsFromTagifyElement(guidedSubmissionTagsTagifyManual); + const milestones = window.getTagsFromTagifyElement(guidedSubmissionTagsTagifyManual); const completionDate = document.getElementById( "guided-submission-completion-date-manual" ).value; @@ -5372,7 +5372,7 @@ const window.openPage = async (targetPageID) => { sectionSubmissionMetadataInputs.classList.remove("hidden"); // Show the instructions for non-SPARC funded submissions - showElementsWithClass("guided-non-sparc-funding-consortium-instructions"); + window.showElementsWithClass("guided-non-sparc-funding-consortium-instructions"); } else { topLevelDDDInstructionsText.classList.remove("hidden"); @@ -5403,7 +5403,7 @@ const window.openPage = async (targetPageID) => { } // Hide the instructions for non-SPARC funded submissions - hideElementsWithClass("guided-non-sparc-funding-consortium-instructions"); + window.hideElementsWithClass("guided-non-sparc-funding-consortium-instructions"); } } @@ -11315,7 +11315,7 @@ $("#guided-button-no-source-data").on("click", () => { } }); -const getTagsFromTagifyElement = (tagifyElement) => { +const window.getTagsFromTagifyElement = (tagifyElement) => { return Array.from(tagifyElement.getTagElms()).map((tag) => { return tag.textContent; }); @@ -15181,7 +15181,7 @@ const saveSubPageChanges = async (openSubPageID) => { if (openSubPageID === "guided-submission-metadata-page") { const award = $("#guided-submission-sparc-award").val(); const date = $("#guided-submission-completion-date").val(); - const milestones = getTagsFromTagifyElement(guidedSubmissionTagsTagify); + const milestones = window.getTagsFromTagifyElement(guidedSubmissionTagsTagify); if (award === "") { errorArray.push({ @@ -15505,7 +15505,7 @@ const guidedSaveDescriptionDatasetInformation = () => { const subtitle = sodaJSONObj["digital-metadata"]["subtitle"]; let studyType = sodaJSONObj["dataset-type"] || ""; //get the keywords from the keywords textarea - const keywordArray = getTagsFromTagifyElement(guidedDatasetKeywordsTagify); + const keywordArray = window.getTagsFromTagifyElement(guidedDatasetKeywordsTagify); if (keywordArray.length < 3) { throw "Please enter at least 3 keywords"; } @@ -15533,9 +15533,9 @@ const guidedSaveDescriptionDatasetInformation = () => { }; const guidedSaveDescriptionStudyInformation = () => { - const studyOrganSystemTags = getTagsFromTagifyElement(guidedStudyOrganSystemsTagify); - const studyApproachTags = getTagsFromTagifyElement(guidedStudyApproachTagify); - const studyTechniqueTags = getTagsFromTagifyElement(guidedStudyTechniquesTagify); + const studyOrganSystemTags = window.getTagsFromTagifyElement(guidedStudyOrganSystemsTagify); + const studyApproachTags = window.getTagsFromTagifyElement(guidedStudyApproachTagify); + const studyTechniqueTags = window.getTagsFromTagifyElement(guidedStudyTechniquesTagify); const studyPurposeInput = document.getElementById("guided-ds-study-purpose"); const studyDataCollectionInput = document.getElementById("guided-ds-study-data-collection"); @@ -15598,7 +15598,7 @@ const guidedSaveDescriptionContributorInformation = () => { const acknowledgements = acknowledgementsInput.value.trim(); // Get tags from other funding tagify - const otherFunding = getTagsFromTagifyElement(guidedOtherFundingsourcesTagify); + const otherFunding = window.getTagsFromTagifyElement(guidedOtherFundingsourcesTagify); sodaJSONObj["dataset-metadata"]["description-metadata"]["contributor-information"] = { funding: otherFunding, diff --git a/scripts/metadata-files/datasetDescription.js b/scripts/metadata-files/datasetDescription.js index d7eaaed76..fde8e775d 100644 --- a/scripts/metadata-files/datasetDescription.js +++ b/scripts/metadata-files/datasetDescription.js @@ -1556,9 +1556,9 @@ const checkBFImportDD = async () => { loadDDFileToUI(res, "bf"); // log the import action success to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.DATASET_DESCRIPTION, + window.MetadataAnalyticsPrefix.DATASET_DESCRIPTION, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.PENNSIEVE @@ -1573,9 +1573,9 @@ const checkBFImportDD = async () => { text: error.response.data.message, }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.DATASET_DESCRIPTION, + window.MetadataAnalyticsPrefix.DATASET_DESCRIPTION, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.PENNSIEVE @@ -1596,9 +1596,9 @@ const loadDDfileDataframe = async (filePath) => { loadDDFileToUI(ddFileData, "local"); // log the import action success to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.DATASET_DESCRIPTION, + window.MetadataAnalyticsPrefix.DATASET_DESCRIPTION, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.LOCAL @@ -1615,9 +1615,9 @@ const loadDDfileDataframe = async (filePath) => { }); // log the import action failure to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.DATASET_DESCRIPTION, + window.MetadataAnalyticsPrefix.DATASET_DESCRIPTION, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL diff --git a/scripts/metadata-files/manifest.js b/scripts/metadata-files/manifest.js index d27bef683..a9b5629e4 100644 --- a/scripts/metadata-files/manifest.js +++ b/scripts/metadata-files/manifest.js @@ -931,17 +931,17 @@ const generateManifest = async (action, type, manifestEditBoolean, ev) => { icon: "warning", showConfirmButton: "OK", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.LOCAL ); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ACTION, "Generate - Check Storage Space", Destinations.LOCAL @@ -951,9 +951,9 @@ const generateManifest = async (action, type, manifestEditBoolean, ev) => { generateAfterEdits(); return; } - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ACTION, "Generate - Check Storage Space", Destinations.LOCAL @@ -990,9 +990,9 @@ const generateManifest = async (action, type, manifestEditBoolean, ev) => { }).then((result) => {}); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.LOCAL @@ -1018,9 +1018,9 @@ const generateManifest = async (action, type, manifestEditBoolean, ev) => { }, }).then((result) => {}); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.LOCAL @@ -1046,9 +1046,9 @@ const generateManifest = async (action, type, manifestEditBoolean, ev) => { }, }).then((result) => {}); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.LOCAL @@ -1209,9 +1209,9 @@ const initiate_generate_manifest_local = async (manifestEditBoolean, originalDat }); //////////// Tracking analytics ///////////// // log the manifest file creation to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.LOCAL @@ -1303,9 +1303,9 @@ const initiate_generate_manifest_bf = async () => { } // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.PENNSIEVE @@ -1344,9 +1344,9 @@ const initiate_generate_manifest_bf = async () => { : kombuchaEnums.Origin.LOCAL; // log the manifest file creation to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.PENNSIEVE @@ -1356,7 +1356,7 @@ const initiate_generate_manifest_bf = async () => { ipcRenderer.send( "track-event", "Success", - MetadataAnalyticsPrefix.MANIFEST + " - Generate - Number of Files ", + window.MetadataAnalyticsPrefix.MANIFEST + " - Generate - Number of Files ", "Number of Files", high_level_folder_num ); @@ -1645,9 +1645,9 @@ const extractBFDatasetForManifestFile = async (editBoolean, bfaccount, bfdataset $("#bf_dataset_create_manifest").text("None"); window.defaultBfDataset = "Select dataset"; // log the Generate action without the destination - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.PENNSIEVE @@ -1697,9 +1697,9 @@ const extractBFDatasetForManifestFile = async (editBoolean, bfaccount, bfdataset $("#Question-prepare-manifest-3").removeClass("prev"); $("#bf_dataset_create_manifest").text("None"); window.defaultBfDataset = "Select dataset"; - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.PENNSIEVE @@ -1739,9 +1739,9 @@ const extractBFDatasetForManifestFile = async (editBoolean, bfaccount, bfdataset $("#Question-prepare-manifest-3").removeClass("prev"); $("#bf_dataset_create_manifest").text("None"); window.defaultBfDataset = "Select dataset"; - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.PENNSIEVE @@ -1773,9 +1773,9 @@ const extractBFDatasetForManifestFile = async (editBoolean, bfaccount, bfdataset window.defaultBfDataset = "Select dataset"; // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.PENNSIEVE @@ -2214,9 +2214,9 @@ const createManifestLocally = async (type, editBoolean, originalDataset) => { //////////// Tracking analytics ///////////// // log the manifest file creation to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.MANIFEST, + window.MetadataAnalyticsPrefix.MANIFEST, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.LOCAL diff --git a/scripts/metadata-files/readme-changes.js b/scripts/metadata-files/readme-changes.js index e30f24c63..2c7b10f8f 100644 --- a/scripts/metadata-files/readme-changes.js +++ b/scripts/metadata-files/readme-changes.js @@ -233,9 +233,9 @@ $(document).ready(function () { if (filepath !== null) { document.getElementById("existing-changes-file-destination").placeholder = filepath[0]; - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.CHANGES, + window.MetadataAnalyticsPrefix.CHANGES, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.PENNSIEVE @@ -264,9 +264,9 @@ $(document).ready(function () { if (filepath !== null) { document.getElementById("existing-readme-file-destination").placeholder = filepath[0]; - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.README, + window.MetadataAnalyticsPrefix.README, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.LOCAL @@ -381,9 +381,9 @@ async function saveRCFile(type) { }, }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - type === "changes" ? MetadataAnalyticsPrefix.CHANGES : MetadataAnalyticsPrefix.README, + type === "changes" ? window.MetadataAnalyticsPrefix.CHANGES : window.MetadataAnalyticsPrefix.README, window.AnalyticsGranularity.ALL_LEVELS, "Generate", Destinations.LOCAL @@ -568,9 +568,9 @@ const getRC = async (type) => { }); let res = import_rc_file.data.text; - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - shortName === "changes" ? MetadataAnalyticsPrefix.CHANGES : MetadataAnalyticsPrefix.README, + shortName === "changes" ? window.MetadataAnalyticsPrefix.CHANGES : window.MetadataAnalyticsPrefix.README, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.PENNSIEVE @@ -608,9 +608,9 @@ const getRC = async (type) => { backdrop: "rgba(0,0,0, 0.4)", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - shortName === "changes" ? MetadataAnalyticsPrefix.CHANGES : MetadataAnalyticsPrefix.README, + shortName === "changes" ? window.MetadataAnalyticsPrefix.CHANGES : window.MetadataAnalyticsPrefix.README, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.PENNSIEVE @@ -633,9 +633,9 @@ function importExistingRCFile(type) { "error" ); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - type === "changes" ? MetadataAnalyticsPrefix.CHANGES : MetadataAnalyticsPrefix.README, + type === "changes" ? window.MetadataAnalyticsPrefix.CHANGES : window.MetadataAnalyticsPrefix.README, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -650,9 +650,9 @@ function importExistingRCFile(type) { icon: "error", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - type === "changes" ? MetadataAnalyticsPrefix.CHANGES : MetadataAnalyticsPrefix.README, + type === "changes" ? window.MetadataAnalyticsPrefix.CHANGES : window.MetadataAnalyticsPrefix.README, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -715,9 +715,9 @@ const loadExistingRCFile = (filepath, type) => { }, }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - type === "changes" ? MetadataAnalyticsPrefix.CHANGES : MetadataAnalyticsPrefix.README, + type === "changes" ? window.MetadataAnalyticsPrefix.CHANGES : window.MetadataAnalyticsPrefix.README, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.LOCAL diff --git a/scripts/metadata-files/subjects-samples.js b/scripts/metadata-files/subjects-samples.js index 9dadbc2d4..08f6ea532 100644 --- a/scripts/metadata-files/subjects-samples.js +++ b/scripts/metadata-files/subjects-samples.js @@ -2250,9 +2250,9 @@ $(document).ready(function () { if (filepath != null) { document.getElementById("existing-samples-file-destination").placeholder = filepath[0]; // log the successful import to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.LOCAL @@ -2433,9 +2433,9 @@ const importExistingSubjectsFile = () => { Swal.fire("No file chosen", "Please select a path to your subjects.xlsx file,", "error"); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBJECTS, + window.MetadataAnalyticsPrefix.SUBJECTS, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -2451,9 +2451,9 @@ const importExistingSubjectsFile = () => { }); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBJECTS, + window.MetadataAnalyticsPrefix.SUBJECTS, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -2482,9 +2482,9 @@ const importExistingSamplesFile = () => { Swal.fire("No file chosen", "Please select a path to your samples.xlsx file.", "error"); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -2500,9 +2500,9 @@ const importExistingSamplesFile = () => { }); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -2560,9 +2560,9 @@ const checkBFImportSubjects = async () => { let res = import_metadata_file.data.subject_file_rows; // log the success to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.SUBJECTS, + window.MetadataAnalyticsPrefix.SUBJECTS, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.PENNSIEVE @@ -2580,9 +2580,9 @@ const checkBFImportSubjects = async () => { }); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBJECTS, + window.MetadataAnalyticsPrefix.SUBJECTS, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.PENNSIEVE @@ -2626,9 +2626,9 @@ const checkBFImportSamples = async () => { let res = importMetadataResponse.data.sample_file_rows; // log the success to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.PENNSIEVE @@ -2646,9 +2646,9 @@ const checkBFImportSamples = async () => { }); // log the error to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.PENNSIEVE diff --git a/scripts/metadata-files/submission.js b/scripts/metadata-files/submission.js index 642ddd96a..479a30281 100644 --- a/scripts/metadata-files/submission.js +++ b/scripts/metadata-files/submission.js @@ -478,7 +478,7 @@ function window.validateSubmissionFileInputs() { } // If milestones were added, check for a completion date - const milestones = getTagsFromTagifyElement(window.milestoneTagify1); + const milestones = window.getTagsFromTagifyElement(window.milestoneTagify1); if (milestones.length > 0) { const selectedCompletionDate = $("#submission-completion-date").val(); if (selectedCompletionDate === "") { @@ -537,7 +537,7 @@ $("#ffm-select-sparc-funding-consortium").on("change", function (e) { label.classList.add("required"); }); - hideElementsWithClass("non-sparc-funding-consortium-instructions"); // Hide non-SPARC instructions + window.hideElementsWithClass("non-sparc-funding-consortium-instructions"); // Hide non-SPARC instructions } else { generateSubmissionButton.classList.remove("hidden"); // Show the button } @@ -748,7 +748,7 @@ localReadmeBtn.addEventListener( false ); -const generateSubmissionHelper = async (uploadBFBoolean) => { +const window.generateSubmissionHelper = async (uploadBFBoolean) => { let datasetName = $("#bf_dataset_load_submission").text().trim(); if (uploadBFBoolean) { // Run pre-flight checks before uploading the submission file to Pennsieve @@ -830,7 +830,7 @@ const generateSubmissionHelper = async (uploadBFBoolean) => { const fundingConsortiumFromDropdown = $("#ffm-select-sparc-funding-consortium").val(); const awardNumber = $("#submission-sparc-award").val(); - const milestones = getTagsFromTagifyElement(window.milestoneTagify1); + const milestones = window.getTagsFromTagifyElement(window.milestoneTagify1); const completionDate = $("#submission-completion-date").val(); const submissionMetadataArray = []; @@ -908,9 +908,9 @@ const generateSubmissionHelper = async (uploadBFBoolean) => { allowOutsideClick: true, }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.SUBMISSION, + window.MetadataAnalyticsPrefix.SUBMISSION, window.AnalyticsGranularity.ALL_LEVELS, "Generate", uploadBFBoolean ? Destinations.PENNSIEVE : Destinations.LOCAL @@ -1029,7 +1029,7 @@ const showExistingSubmissionFile = (type) => { } }; -const openFileBrowserDestination = (metadataType) => { +const window.openFileBrowserDestination = (metadataType) => { ipcRenderer.send(`open-destination-generate-${metadataType}-locally`); }; @@ -1038,9 +1038,9 @@ const importExistingSubmissionFile = (type) => { if (filePath === "Browse here") { Swal.fire("No file chosen", `Please select a path to your submission.xlsx file`, "error"); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBMISSION, + window.MetadataAnalyticsPrefix.SUBMISSION, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -1055,9 +1055,9 @@ const importExistingSubmissionFile = (type) => { icon: "error", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBMISSION, + window.MetadataAnalyticsPrefix.SUBMISSION, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -1102,9 +1102,9 @@ const loadExistingSubmissionFile = async (filepath) => { backdrop: "rgba(0,0,0, 0.4)", icon: "error", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBMISSION, + window.MetadataAnalyticsPrefix.SUBMISSION, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -1177,9 +1177,9 @@ const loadSubmissionFileToUI = (data, type) => { }, }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.SUBMISSION, + window.MetadataAnalyticsPrefix.SUBMISSION, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", type === "local" ? Destinations.LOCAL : Destinations.PENNSIEVE @@ -1234,9 +1234,9 @@ const checkBFImportSubmission = async () => { icon: "warning", html: error.response.data.message, }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBMISSION, + window.MetadataAnalyticsPrefix.SUBMISSION, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.PENNSIEVE diff --git a/scripts/organize-dataset/curate-functions.js b/scripts/organize-dataset/curate-functions.js index 8c016ff67..c2409b574 100644 --- a/scripts/organize-dataset/curate-functions.js +++ b/scripts/organize-dataset/curate-functions.js @@ -369,7 +369,7 @@ const progressFileParse = (ev) => { "" + error + ""; // log the error to analytics at varying levels of granularity - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", PrepareDatasetsAnalyticsPrefix.CURATE, window.AnalyticsGranularity.ALL_LEVELS, @@ -615,7 +615,7 @@ const loadProgressFile = (ev) => { "Previous work loaded successfully! Continue below."; // log the success at the action and action with destination granularity levels - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", PrepareDatasetsAnalyticsPrefix.CURATE, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, @@ -689,7 +689,7 @@ const verify_missing_files = (mode) => { "Previous work loaded successfully! Continue below."; // log the success at the action and action with destination granularith levels - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", PrepareDatasetsAnalyticsPrefix.CURATE, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, diff --git a/scripts/others/analytics/analytics-utils.js b/scripts/others/analytics/analytics-utils.js index 86ac8a440..30800947a 100644 --- a/scripts/others/analytics/analytics-utils.js +++ b/scripts/others/analytics/analytics-utils.js @@ -1,3 +1,6 @@ +import { Destinations } from "./analytics" + + // determine if we are working with a Local, Saved, or Pennsieve dataset in the current Curation flow const determineDatasetLocation = () => { let location = ""; diff --git a/scripts/others/renderer.js b/scripts/others/renderer.js index 361024c42..057d0b26a 100644 --- a/scripts/others/renderer.js +++ b/scripts/others/renderer.js @@ -79,7 +79,7 @@ let datasetStructureJSONObj = { type: "", }; -let introStatus = { +let window.introStatus= { organizeStep3: true, submission: false, subjects: false, @@ -1777,14 +1777,14 @@ var window.milestoneTagify1 = new Tagify(milestoneInput1, { }, }); -const hideElementsWithClass = (className) => { +const window.hideElementsWithClass = (className) => { const elements = document.querySelectorAll(`.${className}`); elements.forEach((element) => { element.classList.add("hidden"); }); }; -const showElementsWithClass = (className) => { +const window.showElementsWithClass = (className) => { const elements = document.querySelectorAll(`.${className}`); elements.forEach((element) => { element.classList.remove("hidden"); @@ -1807,14 +1807,14 @@ window.milestoneTagify1.on("change", (e) => { // If there are milestone tags other than N/A, then show the completion date form component if (filteredMilestones.length > 0) { - showElementsWithClass("completion-date-form-component"); + window.showElementsWithClass("completion-date-form-component"); } else { // If there are no milestone tags other than N/A, then hide the completion date form component - hideElementsWithClass("completion-date-form-component"); + window.hideElementsWithClass("completion-date-form-component"); $("#submission-completion-date").val(""); } } else { - hideElementsWithClass("completion-date-form-component"); + window.hideElementsWithClass("completion-date-form-component"); $("#submission-completion-date").val(""); } }); @@ -2308,27 +2308,27 @@ async function loadSubjectsFileToDataframe(filePath) { backdrop: "rgba(0,0,0, 0.4)", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBJECTS, + window.MetadataAnalyticsPrefix.SUBJECTS, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL ); return; } - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.SUBJECTS, + window.MetadataAnalyticsPrefix.SUBJECTS, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.LOCAL ); loadDataFrametoUI("local"); } else { - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBJECTS, + window.MetadataAnalyticsPrefix.SUBJECTS, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -2351,9 +2351,9 @@ async function loadSubjectsFileToDataframe(filePath) { backdrop: "rgba(0,0,0, 0.4)", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SUBJECTS, + window.MetadataAnalyticsPrefix.SUBJECTS, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -2391,9 +2391,9 @@ async function loadSamplesFileToDataframe(filePath) { backdrop: "rgba(0,0,0, 0.4)", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -2401,9 +2401,9 @@ async function loadSamplesFileToDataframe(filePath) { return; } - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, "Existing", Destinations.LOCAL @@ -2411,9 +2411,9 @@ async function loadSamplesFileToDataframe(filePath) { loadDataFrametoUISamples("local"); } else { - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -2437,9 +2437,9 @@ async function loadSamplesFileToDataframe(filePath) { backdrop: "rgba(0,0,0, 0.4)", }); - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", - MetadataAnalyticsPrefix.SAMPLES, + window.MetadataAnalyticsPrefix.SAMPLES, window.AnalyticsGranularity.ALL_LEVELS, "Existing", Destinations.LOCAL @@ -6867,7 +6867,7 @@ ipcRenderer.on("selected-local-destination-datasetCurate", async (event, filepat $("#para-continue-location-dataset-getting-started").text("Please continue below."); $("#nextBtn").prop("disabled", false); // log the success to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Success", PrepareDatasetsAnalyticsPrefix.CURATE, window.AnalyticsGranularity.ACTION_AND_ACTION_WITH_DESTINATION, @@ -7056,7 +7056,7 @@ ipcRenderer.on("selected-local-destination-datasetCurate", async (event, filepat }); // log the failure to select an appropriate folder to analytics - logMetadataForAnalytics( + window.logMetadataForAnalytics( "Error", PrepareDatasetsAnalyticsPrefix.CURATE, window.AnalyticsGranularity.ALL_LEVELS, @@ -8550,7 +8550,7 @@ Analytics Logging Section // TEST comment for build spawn -function logMetadataForAnalytics( +function window.logMetadataForAnalytics( category, analyticsActionPrefix, granularity, @@ -8638,13 +8638,13 @@ const logMetadataSizeForAnalytics = async (uploadBFBoolean, metadataFileName, si ); let fileNameToPrefixMapping = { - dataset_description: MetadataAnalyticsPrefix.DATASET_DESCRIPTION, - submission: MetadataAnalyticsPrefix.SUBMISSION, - subjects: MetadataAnalyticsPrefix.SUBJECTS, - samples: MetadataAnalyticsPrefix.SAMPLES, - readme: MetadataAnalyticsPrefix.README, - changes: MetadataAnalyticsPrefix.CHANGES, - manifest: MetadataAnalyticsPrefix.MANIFEST, + dataset_description: window.MetadataAnalyticsPrefix.DATASET_DESCRIPTION, + submission: window.MetadataAnalyticsPrefix.SUBMISSION, + subjects: window.MetadataAnalyticsPrefix.SUBJECTS, + samples: window.MetadataAnalyticsPrefix.SAMPLES, + readme: window.MetadataAnalyticsPrefix.README, + changes: window.MetadataAnalyticsPrefix.CHANGES, + manifest: window.MetadataAnalyticsPrefix.MANIFEST, }; // remove the extension from the metadata file's name @@ -8688,7 +8688,7 @@ const getFileSizeInBytes = (path) => { }); }; -const MetadataAnalyticsPrefix = { +const window.MetadataAnalyticsPrefix = { DATASET_DESCRIPTION: "Prepare Metadata - dataset_description", MANIFEST: "Prepare Metadata - manifest", SUBJECTS: "Prepare Metadata - subjects", diff --git a/sections/prepare_metadata/create_changes.html b/sections/prepare_metadata/create_changes.html index a9daf72b4..4949c8e50 100644 --- a/sections/prepare_metadata/create_changes.html +++ b/sections/prepare_metadata/create_changes.html @@ -591,7 +591,7 @@

Generate directly on Pennsieve

Generate directly on Pennsieve Generate directly on Pennsieve Generate directly on Pennsieve Generate directly on Pennsieve Generate directly on Pennsieve >