Quick: Remove Unused JavaScript #475
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wesleyboar
requested review from
rstijerina and
duckonomy
and removed request for
duckonomy
wesleyboar
changed the title
wesleyboar
commented
Apr 6, 2022
Comment on lines
-1
to
-51
| /* WARNING: This code is deprecated. It must be removed AFTER GH-195/FP-1015. */ | ||
|
|
||
| /** | ||
| * Load JSON from an endpoint, and perform success-dependent actions | ||
| * @param {string} path - The path to an API endpoint | ||
| * @param {function} onSuccess - Callback for data retrieval success | ||
| * @param {function} onError - Callback for data retrieval success | ||
| */ | ||
| function getData(path, onSuccess, onError) { | ||
| var xhr = new XMLHttpRequest(); | ||
| xhr.onreadystatechange = function () { | ||
| if (xhr.readyState === XMLHttpRequest.DONE) { | ||
| if (xhr.status === 200) { | ||
| if (typeof onSuccess === 'function') { | ||
| onSuccess(JSON.parse(xhr.responseText)); | ||
| } | ||
| } else { | ||
| // NOTE: The original code did not ever log an error, thus `undefined` | ||
| onError(xhr, undefined); | ||
| } | ||
| } | ||
| }; | ||
| xhr.open("GET", path, true); | ||
| xhr.send(); | ||
| } | ||
|
|
||
| (function () { | ||
| /* | ||
| * Show (and populate) correct Portal navigation menu | ||
| * - If user is authenticated: | ||
| * - Populate username (to show that user is logged in) | ||
| * - Show portal nav dropdown (it is pre-hidden via classname) | ||
| * - If user is NOT authenticated: | ||
| * - Show portal login link (it is pre-hidden via classname) | ||
| */ | ||
| getData('/api/users/auth/', | ||
| function populateData(data) { | ||
| console.info('portal user data', data); | ||
|
|
||
| document.getElementById('portal-username').textContent = data.username; | ||
| // FAQ: Show the auth'd menu | ||
| document.getElementById('auth-menu').classList.remove('d-none'); | ||
| }, | ||
| function outputRequest(xhr, isFatal) { | ||
| if (isFatal) console.error(xhr); | ||
|
|
||
| // FAQ: Show the un-auth'd menu | ||
| document.getElementById('unauth-menu').classList.remove('d-none'); | ||
| } | ||
| ); | ||
| })(); |
There was a problem hiding this comment.
Explanation: This whole file is unused. Instead of manipulating duplicated HTML, we now load the server-side–prepared HTML directly into place.
Comment on lines
-1
to
-3
| 'use strict'; | ||
|
|
||
| console.info('Core `site.js` has no logic.'); |
There was a problem hiding this comment.
Original Intent: Note to self that there is a site.js for site-wide JavaScript. But no site-wide JavaScript has since been needed.
rstijerina
approved these changes
Apr 7, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Remove cruft JavaScript files.
Related
none
Changes
site.jsand call to load it.nav_portal.js(long since deprecated and never loaded).Testing
site.jsis not loaded.Screenshots