Fix redirect. (#17)

* Fix redirect to GitHub.

* Write tests using jest.

Co-authored-by: Adi Roiban <[email protected]>

Author: ioanacristinamarinescu

.gitignore

@@ -2,3 +2,9 @@ _site/
 .sass-cache/
 .jekyll-cache/
 .jekyll-metadata
+venv/
+nodeenv/
+node-env/
+node_modules/
+# We don't want to commit all the pinned dependencies.
+package-lock.json

404.html

@@ -18,7 +18,7 @@ <h1 class="tw-m-0 tw-text-white">404</h1>
       <h1>Page not found on this site.</h1>
       <h2 id="js-redirection" class="tw-hidden tw-font-medium">
         Redirecting to moved
-        <a href="#" class="tw-text-highlight">page</a>.
+        <a id="js-redirection-link" href="#" class="tw-text-highlight">page</a>.
       </h2>
       <h2 class="tw-font-medium tw-m-0">
         Go to
@@ -27,14 +27,15 @@ <h2 class="tw-font-medium tw-m-0">
 
       <noscript>
         <h2 class="tw-font-medium">
-          Please enable JavaScript for this site to take advantage of automatic redirection.
+          You need to enable JavaScript for this site to take advantage of automatic redirection.
         </h2>
       </noscript>
     </div>
 
     <!-- Required vendor scripts (Do not remove) -->
-    <script type="text/javascript" src="/vendor/js/jquery-v3.5.1.min.js"></script>
-    <script type="module" src="/assets/js/redirect.js"></script>
+    <script type="text/javascript" src="/assets/js/node-shim.js"></script>
+    <script type="text/javascript" src="/assets/js/redirect_trac_tickets.js"></script>
+    <script type="text/javascript" src="/assets/js/redirect.js"></script>
   </body>
 
 </html>

README.md

@@ -12,14 +12,33 @@ You can run a local test server via `$ python3 test_server.py`.
 It is designed to replicate the same 404 behaviour as GitHub Pages.
 
 
-## Tools used
+## Tools
 
 This project is using [Tailwind v3](https://tailwindcss.com/docs/) in the
 *404.html* page.
 Use the `tw-` prefix with Tailwind CSS classes.
 
 Node/npm is required to update the */build/css/tailwind.css* file.
 
+You can get nodejs on your system via Python as:
+
+```
+virtualenv venv
+. venv/bin/activate
+pip install nodeenv
+nodeenv node-env
+. node-env/bin/activate
+```
+## JS devlopment
+
+`jest` is used for the test suite.
+
+```
+./node_modules/.bin/jest
+```
+
+## CSS development
+
 Use this command when developing for the CSS file to be updated automatically
 with your Tailwind classes:
 
@@ -28,6 +47,7 @@ npm run dev
 ```
 
 To minify the file run:
+
 ```
 npm run build
 ```

assets/js/node-shim.js

@@ -0,0 +1,10 @@
+//
+// Helpers to get the same code over nodejs and a webbrowser
+//
+// This is to have nodejs and browser code without webpack or other tools.
+//
+if (typeof exports === 'undefined') {
+    var require = function(node_path, browser_name) {
+        return this[browser_name]
+    }
+}

assets/js/redirect.js

@@ -4,63 +4,39 @@
 Show link to redirect to correct page and redirect.
 */
 
-// This is the Trac to GitHub issues mapping.
-// Stored in a separate file for convenience.
-import {migrated_tickets} from "./redirect_rules.mjs"
+(function(exports){
+
+// This is poor man's hack to have the same code available in browser and
+// nodejs without webpack or other tools.
+const redirect_trac_tickets = require(
+    './redirect_trac_tickets', 'redirect_trac_tickets')
+
 
 // Redirection rules.
 // This is a mapping from a regex to a redirection URL.
 const regex_redirects = [
-    ['/trac$', '/'],
-    ['/trac/$', '/'],
-    ['/trac/wiki$', '/'],
-    ['/trac/wiki/$', '/'],
-    ['/trac/wiki/WikiStart$', '/'],
-    ['/trac/timeline$', 'https://github.com/twisted/twisted/pulse'],
-    ['/trac/roadmap$', 'https://github.com/twisted//twisted/milestones'],
-    ['/trac/newticket$', 'https://github.com/twisted//twisted/issues/new'],
-    ['/trac/search$', 'https://github.com/twisted//twisted/issues'],
-    ['/trac/report.*', 'https://github.com/twisted/twisted/issues'],
-    ['/trac/wiki/(.+)', 'https://github.com/twisted/trac-wiki-archive/blob/trunk/$1.mediawiki'],
+    ['.*/trac$', '/'],
+    ['.*/trac/$', '/'],
+    ['.*/trac/wiki$', '/'],
+    ['.*/trac/wiki/$', '/'],
+    ['.*/trac/wiki/WikiStart$', '/'],
+    ['.*/trac/timeline$', 'https://github.com/twisted/twisted/pulse'],
+    ['.*/trac/roadmap$', 'https://github.com/twisted/twisted/milestones'],
+    ['.*/trac/newticket$', 'https://github.com/twisted/twisted/issues/new'],
+    ['.*/trac/search.*', 'https://github.com/twisted/twisted/issues'],
+    ['.*/trac/report.*', 'https://github.com/twisted/twisted/issues'],
+    ['.*/trac/wiki/(.+)', 'https://github.com/twisted/trac-wiki-archive/blob/trunk/$1.mediawiki'],
 ];
 
-var path = window.location.pathname
-var path_simple = stripTrailingSlash(path)
-
-if (path.match('/trac/ticket/.+')) {
-    var gh_issues_base_url = 'https://github.com/twisted/twisted/issues/'
-
-    var r = path_simple.split('/')
-    var trac_id = r[r.length - 1]
-
-    var new_id = getFirstMatch(migrated_tickets, parseInt(trac_id))
+function getRegexRedirectPath(regex_redirects, old_url) {
+    var matching_pair = regex_redirects.find(function(pair) {
+        var regex_path = new RegExp(pair[0])
+        return old_url.match(regex_path)
+    })
 
-    // #comment:2 -> #note_2
-    var new_anchor = ''
-    var anchor = window.location.href.match(/#comment:[0-9]+/gi)
-    if (anchor) {
-        new_anchor = '#note_' + anchor[0].match(/[0-9]+/)[0]
+    if(matching_pair) {
+        return old_url.replace(new RegExp(matching_pair[0]), matching_pair[1])
     }
-
-    var new_url = gh_issues_base_url + new_id + new_anchor
-    setLink(new_url)
-    window.location = new_url
-}
-
-
-goToRegexRedirectPath(regex_redirects, path_simple)
-
-
-function goToRegexRedirectPath(regex_redirects, path_simple) {
-    regex_redirects.forEach(function(pair) {
-        var regex_path = new RegExp(pair[0], 'gi')
-
-        if (path_simple.match(regex_path)) {
-            new_url = path_simple.replace(regex_path, pair[1])
-            setLink(new_url)
-            window.location = new_url
-        }
-    })
 }
 
 function getFirstMatch(rule_map, key) {
@@ -70,14 +46,41 @@ function getFirstMatch(rule_map, key) {
     return false
 }
 
-function stripTrailingSlash(str) {
-    if(str.substr(-1) === '/') {
-        return str.substr(0, str.length - 1);
+const twisted_url = 'https://github.com/twisted'
+
+exports.getMigratedURL = (old_url) => {
+    var ticket_regex_path = new RegExp('/trac/ticket/(.+)')
+    if (old_url.match(ticket_regex_path)) {
+
+        var new_url = twisted_url + '/twisted/issues/'
+        var trac_id = old_url.match(ticket_regex_path)[1]
+        var new_id = getFirstMatch(
+            redirect_trac_tickets.trac_to_github, parseInt(trac_id))
+
+        // #comment:2 -> #note_2
+        var new_anchor = ''
+        var anchor = old_url.match(/#comment:[0-9]+/gi)
+        if (anchor) {
+            new_anchor = '#note_' + anchor[0].match(/[0-9]+/)[0]
+        }
+
+        if (new_id) {
+            new_url = new_url + new_id + new_anchor
+            return new_url
+        }
     }
-    return str;
+    return getRegexRedirectPath(regex_redirects, old_url)
 }
 
-function setLink(url) {
-    $('#js-redirection a').attr('href', url)
-    $('#js-redirection').removeClass('tw-hidden')
+}(typeof exports === 'undefined' ? this.redirect = {} : exports))
+
+// Run the redirection when loaded from the browser.
+if (typeof exports === 'undefined') {
+
+    var new_url = redirect.getMigratedURL(window.location.href)
+    if (new_url) {
+        document.getElementById('js-redirection-link').setAttribute('href', new_url)
+        document.getElementById('js-redirection').classList.remove('tw-hidden')
+        window.location = new_url
+    }
 }

assets/js/redirect.test.js

@@ -0,0 +1,26 @@
+const redirect = require('./redirect');
+
+
+test('getMigratedURL', () => {
+    var domain = 'https://twisted.org'
+    var github_issues = 'https://github.com/twisted/twisted/issues/'
+
+    expect(redirect.getMigratedURL(domain+'/trac/ticket/1234')).toEqual(github_issues+'10828')
+    expect(redirect.getMigratedURL(domain+'/trac/ticket/3232')).toEqual(github_issues+'3232')
+    expect(redirect.getMigratedURL(domain+'/trac/ticket/10000#comment:2')).toEqual(github_issues+'10000#note_2')
+    expect(redirect.getMigratedURL(domain+'/trac')).toEqual('/')
+    expect(redirect.getMigratedURL(domain+'/trac/')).toEqual('/')
+    expect(redirect.getMigratedURL(domain+'/trac/wiki')).toEqual('/')
+    expect(redirect.getMigratedURL(domain+'/trac/wiki/')).toEqual('/')
+    expect(redirect.getMigratedURL(domain+'/trac/wiki/WikiStart')).toEqual('/')
+    expect(redirect.getMigratedURL(domain+'/trac/timeline')).toEqual('https://github.com/twisted/twisted/pulse')
+    expect(redirect.getMigratedURL(domain+'/trac/roadmap')).toEqual('https://github.com/twisted/twisted/milestones')
+    expect(redirect.getMigratedURL(domain+'/trac/newticket')).toEqual('https://github.com/twisted/twisted/issues/new')
+    expect(redirect.getMigratedURL(domain+'/trac/search')).toEqual('https://github.com/twisted/twisted/issues')
+    expect(redirect.getMigratedURL(domain+'/trac/search?q=query')).toEqual('https://github.com/twisted/twisted/issues')
+    expect(redirect.getMigratedURL(domain+'/trac/report')).toEqual('https://github.com/twisted/twisted/issues')
+    expect(redirect.getMigratedURL(domain+'/trac/report/1')).toEqual('https://github.com/twisted/twisted/issues')
+    expect(redirect.getMigratedURL(
+        domain+'/trac/wiki/TwistedDevelopment')).toEqual(
+        'https://github.com/twisted/trac-wiki-archive/blob/trunk/TwistedDevelopment.mediawiki')
+})

assets/js/redirect_rules.mjs renamed to assets/js/redirect_trac_tickets.js

@@ -1,11 +1,12 @@
-
 /*
-This files contains the mapping of Trac Ticket IDs as migrated
-to GitHub Issues ID for the tickets that don't have the same IDs.
+This file contains the mapping of Trac Ticket IDs as migrated
+to GitHub Issues ID.
 
-If an ID is not in this list, then both Trac and GitHub have same IDs.
+If an ID is not in this list, then it was not migrated.
 */
-export const migrated_tickets = new Map([
+(function(exports){
+
+exports.trac_to_github = new Map([
     [1741, 1741],
     [1742, 1742],
     [1743, 1743],
@@ -9827,3 +9828,5 @@ export const migrated_tickets = new Map([
     [246, 11559],
     [1647, 11560],
 ]);
+
+}(typeof exports === 'undefined' ? this.redirect_trac_tickets = {} : exports))

package.json

@@ -18,5 +18,8 @@
   "bugs": {
     "url": "https://github.com/twisted/twisted.github.io/issues"
   },
-  "homepage": "https://github.com/twisted/twisted.github.io#readme"
+  "homepage": "https://github.com/twisted/twisted.github.io#readme",
+  "devDependencies": {
+    "jest": "^28.1.2"
+  }
 }