Pretty much a rewrite to support manifest v3 (only Chrome for now)

Author: mchristofides

README.md

@@ -1,16 +1,18 @@
 ### Intro
 pg_docs_bot is a browser extension for getting to the current Postgres docs by default.
-* [Firefox addon](https://addons.mozilla.org/en-US/firefox/addon/pg_docs_bot/)
 * [Chrome extension](https://chrome.google.com/webstore/detail/pgdocsbot/hkbfkapgdfedgidpfbhlogecohcnaeod?hl=en-GB)
-* It is also trivial to install manually, if you prefer
+* [Firefox addon](https://addons.mozilla.org/en-US/firefox/addon/pg_docs_bot/)
+* It is also possible to install extensions locally, if you prefer
 
 ### Benefits
-When you search for Postgres related things, an old version of the documentation is often indexed. Similarly, some answers on sites like Stack Overflow link to old versions of the documentation. pg_docs_bot helps you avoid the annoyance of having to click "Current" when you get there, the frustration of having read the whole page before realising it was an old version, or even worse, not realising that it was an out of date version at all.
+When you search for Postgres related things, an old version of the documentation is sometimes top of the list (although this was far more of a problem several years ago). Similarly, some links on sites like Stack Overflow are to old versions of the documentation.
+
+pg_docs_bot helps you avoid having to click "Current" when you get there, or the frustration of reading the information before realising it's out of date, or (even worse) not realising at all.
 
 ### Fixing the root cause
-Naturally, this extension doesn't help solve the root cause(s) of this issue.
+There have been many conversations on the PostgreSQL mailing lists about how to teach search engines which version to link to. In 2021 a [huge improvement](https://www.postgresql.org/message-id/flat/CABUevEyGwaZE8KJg%3D-K4f7moUo%3DUbV3AFbnmtTB-c31ojNn2Vg%40mail.gmail.com#611b31dcdc09aba835ef561ad15bed69) was made to the docs to let search engines know that the `current` version should be considered canonical, which has helped tremendously.
 
-There have been many conversations on the PostgreSQL mailing lists about how to teach search engines which version to link to. (June 2021 update: there is a [new thread](https://www.postgresql.org/message-id/flat/CABUevEyGwaZE8KJg%3D-K4f7moUo%3DUbV3AFbnmtTB-c31ojNn2Vg%40mail.gmail.com#611b31dcdc09aba835ef561ad15bed69) that seems promising). Please also continue to encourage people (eg on Stack Overflow or in blog posts) to link to the `current` version, which should gradually help.
+For the likes of Stack Overflow and blog posts, please do link to the `current` version whenever you aren't specifically referencing something version-specific.
 
 ### Features of pg_docs_bot
 * Redirects links to the `current` version
@@ -19,15 +21,9 @@ There have been many conversations on the PostgreSQL mailing lists about how to
 * Doesn't redirect when coming from another page in the docs, so you can still check old versions (the main problem with generic redirectors)
 
 ### Limitations
-* Only supports redirecting to `current` (request [support for other versions](https://github.com/mchristofides/pg_docs_bot/issues/1))
+* Only supports redirecting to `current` (here's [an alternative that does](https://github.com/dougharris/unified_docs_switcher))
 * Works for the English language docs
-* Works for version 7.0 links upwards
-* Chrome extension works on a limited list of search engines and Stack Exchange sites (to avoid needing <all_urls> permission)
-
-### Examples
-Here is an example of a [search for "postgresql create index"](https://duckduckgo.com/?q=postgresql+create+index). At the time of writing, the 9.1 version of the docs is the first search result (the "current" version is 12).
-
-### Requests, issues, PRs
-There are some feature ideas in the [issues](https://github.com/mchristofides/pg_docs_bot/issues). Bug reports and PRs super welcome.
+* Works for version v7.0 through v17 links
+* The Chrome extension only works on a limited set of search engines and Stack Exchange sites (to avoid needing the <all_urls> permission)
 
 ![alt text](https://github.com/mchristofides/pg_docs_bot/blob/trunk/slonik_in_glasses_128.png)

manifest.json

@@ -1,16 +1,17 @@
 {
   "name": "pg_docs_bot",
-  "version": "1.0.3",
+  "version": "2.0.0",
   "description": "Redirects PostgreSQL docs links to the current version (except when coming from the docs, or to deprecated features).",
   "homepage_url": "https://github.com/mchristofides/pg_docs_bot",
-  "manifest_version": 2,
+  "manifest_version": 3,
   "icons": {
     "48": "slonik_in_glasses_48.png",
     "128": "slonik_in_glasses_128.png"
   },
   "permissions": [
-    "webRequest",
-    "webRequestBlocking",
+    "declarativeNetRequest"
+  ],
+  "host_permissions": [
     "https://www.postgresql.org/docs/*",
     "https://*.google.com/*",
     "https://*.duckduckgo.com/*",
@@ -27,6 +28,6 @@
     }
   ],
   "background": {
-    "scripts": ["redirectdocs.js"]
+    "service_worker": "redirectdocs.js"
   }
-}
+}

manual-tests.md

@@ -1,8 +1,8 @@
 ### Manual tests
 
-* Search for, and click on, a link to an old version of the docs (should redirect to "current")
+* Search for "postgresql view 9.6", and click on a link to an old version of the docs (should redirect to "current")
 * Check the the pg_docs_bot reminder notice appears
 * Once there, try clicking on an old version (should NOT redirect back to "current")
 * Search for "postgresql docs" and click on a link to the root URL (should work)
 * Search for "postgresql docs faq" and click on a link to the FAQs (should work)
-* Search for "postgresql recovery config" and click on a link to the page (should go to the version clicked)
+* Search for "postgresql app-droplang" and click on a link to the page (should go to the version clicked)

pgdocsbotnotice.js

@@ -1,16 +1,32 @@
-var url = new URL(document.location);
-var redirectedURL = decodeURIComponent(url.searchParams.get('pg-docs-bot-redirected'));
-if (redirectedURL) {
-    var redirectedURL = new URL(redirectedURL);
-}
-var redirectedPath = redirectedURL.pathname;
-var redirectedVersion = redirectedPath.split('/');
-if (String(redirectedURL).startsWith('https://www.postgresql.org/docs/')) { 
-    var hover = document.createElement('Hover');
-    hover.innerHTML = `<div id="pgdocsbotHover" style="font-size: 14px;color: #0D0A0B;position: fixed;bottom: 30px;right: 30px;padding: 15px 30px 15px 15px;max-width: 350px;background: #BBCED9;border-radius: 5px;z-index: 100;box-shadow: 5px 5px 5px rgba(0,0,0,0.2)">Redirected by pg_docs_bot from: <a href="${redirectedURL}"><u>${redirectedVersion[2]}</u></a><button type="button" id="closeNotice" style="background: none;-webkit-appearance: none;border: none;position: absolute;right: 5px;top: 5px;line-height: 10px;color: #2c3e50;font-size: 18px;padding: 5px;cursor:pointer;">×</button></div>`;
-    document.body.appendChild(hover);
-    function closeButton () {
-        document.getElementById("pgdocsbotHover").remove()
+function showRedirectNotice() {
+  const url = new URL(document.location);
+  const redirectedURLParam = url.searchParams.get('pg-docs-bot-redirected');  
+  // Avoid errors when not redirecting
+  if (redirectedURLParam) {
+    try {
+      const redirectedURL = new URL(decodeURIComponent(redirectedURLParam));
+      const redirectedPath = redirectedURL.pathname;
+      const redirectedVersion = redirectedPath.split('/');
+      
+      if (String(redirectedURL).startsWith('https://www.postgresql.org/docs/')) { 
+        const hover = document.createElement('div');
+        hover.id = 'pgdocsbotHover';
+        hover.style = `font-size: 14px;color: #0D0A0B;position: fixed;bottom: 30px;right: 30px;padding: 15px 30px 15px 15px;max-width: 350px;background: #BBCED9;border-radius: 5px;z-index: 100;box-shadow: 5px 5px 5px rgba(0,0,0,0.2)`;
+        hover.innerHTML = `Redirected by pg_docs_bot from: <a href="${redirectedURL}"><u>${redirectedVersion[2]}</u></a><button type="button" id="closeNotice" style="background: none;-webkit-appearance: none;border: none;position: absolute;right: 5px;top: 5px;line-height: 10px;color: #2c3e50;font-size: 18px;padding: 5px;cursor:pointer;">×</button>`;
+        document.body.appendChild(hover);
+        document.getElementById("closeNotice").addEventListener("click", function() {
+          document.getElementById("pgdocsbotHover").remove();
+        });
       }
-    document.getElementById("closeNotice").addEventListener("click", closeButton); 
-};
+    } catch (e) {
+      // If there's an error, log it and don't show a notice
+      console.log('pg_docs_bot: Error processing redirected URL', e);
+    }
+  }
+}
+// Only run when the DOM is finished loading
+if (document.readyState === 'loading') {
+  document.addEventListener('DOMContentLoaded', showRedirectNotice);
+} else {
+  showRedirectNotice();
+}

redirectdocs.js

@@ -1,35 +1,78 @@
-chrome.webRequest.onBeforeRequest.addListener(function(details){
-    var pgdocsversion = 'docs\/current\/';
-    //Firefox uses details.originUrl, Chrome uses details.initiator
-    if (details.originUrl) {
-        var origin = details.originUrl;
-    }
-    else {
-        var origin = details.initiator;
-    }
-    if (origin.startsWith('https://www.postgresql.org')) {
-        //Do not redirect when coming from postgresql.org, to allow people to deliberately view older versions
-        return {cancel: false};
-    }
-    else if (/\/(archive-recovery-settings|recovery-target-settings|app-createlang|app-droplang|indexcost|inherit|manage|start-manage-db|failure|failure-disk-failed|programmer-client|developer|part-developer)\.html/.test(details.url)) {
-        //Avoid 404s by not redirecting deprecated pages
-        return {cancel: false};
-    }
-    else if (/\/release/.test(details.url)) {
-        //Avoid redirecting release pages that sometimes redirect from current back to their own version, and seem better to not redirect in any case
-        return {cancel: false};
+async function initExtension() {
+  // Create small individual rules to keep Chrome happy
+  const rules = [];
+  let ruleId = 1;
+  const versions = [
+    '7', '7.0', '7.1', '7.2', '7.3', '7.4', 
+    '8', '8.0', '8.1', '8.2', '8.3', '8.4', 
+    '9', '9.0', '9.1', '9.2', '9.3', '9.4', '9.5', '9.6',
+    '10', '11', '12', '13', '14', '15', '16', '17'
+  ];
+  const deprecatedPages = [
+    'archive-recovery-settings',
+    'recovery-target-settings',
+    'app-createlang',
+    'app-droplang',
+    'indexcost',
+    'inherit',
+    'manage',
+    'start-manage-db',
+    'failure',
+    'failure-disk-failed',
+    'programmer-client',
+    'developer',
+    'part-developer',
+    'release'
+  ];
+  for (const version of versions) {
+    rules.push({
+      id: ruleId++,
+      priority: 1, //Lower priority than non-redirects
+      action: {
+        type: "redirect",
+        redirect: {
+          regexSubstitution: "https://www.postgresql.org/docs/current/\\1?pg-docs-bot-redirected=https://www.postgresql.org/docs/" + version + "/\\1"
+        }
+      },
+      condition: {
+        regexFilter: `^https://www\\.postgresql\\.org/docs/${version}/([^/]+\\.html)`,
+        resourceTypes: ["main_frame"]
+      }
+    });
+  }
+  // Prevent redirects when already on postgresql.org
+  rules.push({
+    id: ruleId++,
+    priority: 3, // Higher priority than redirects and deprecated pages
+    action: {
+      type: "allow"
+    },
+    condition: {
+      urlFilter: "https://www.postgresql.org/docs/",
+      initiatorDomains: ["postgresql.org", "www.postgresql.org"],
+      resourceTypes: ["main_frame"]
     }
-    else { 
-        //Replace version numbers 7+ as notice now makes 404s less bad. Should probably also replace devel once people can set a default.
-        var redirectUrl = details.url.replace(/docs\/(current\/|7|7\.0|7\.1|7\.2|7\.3|7\.4|8|8\.0|8\.1|8\.2|8\.3|8\.4|9|9\.0|9\.1|9\.2|9\.3|9\.4|9\.5|9\.6|10|11|12|13)\//, pgdocsversion); 
-        if (redirectUrl === details.url) {
-            return {cancel: false};
-        } 
-        else { 
-            var url = new URL(redirectUrl);
-            url.searchParams.append('pg-docs-bot-redirected', details.url);
-            console.log(`pg_docs_bot: redirecting to ${pgdocsversion}`); 
-            return {redirectUrl: encodeURI(url)};
+  });
+  for (const version of versions) {
+    for (const page of deprecatedPages) {
+      rules.push({
+        id: ruleId++,
+        priority: 2, // Higher priority than redirects
+        action: {
+          type: "allow" // Don't redirect
+        },
+        condition: {
+          urlFilter: `https://www.postgresql.org/docs/${version}/${page}.html`,
+          resourceTypes: ["main_frame"]
         }
+      });
     }
-  }, {urls: ['https://www.postgresql.org/docs/*']},['blocking']);
+  }
+  // Register the rules
+  await chrome.declarativeNetRequest.updateDynamicRules({
+    removeRuleIds: Array.from({length: ruleId - 1}, (_, i) => i + 1),
+    addRules: rules
+  });
+  console.log('pg_docs_bot: Registered', rules.length, 'redirect rules');
+}
+initExtension();