Merge pull request #102 from ahwayakchih/prodversionmin

feat: use `manifest.minimum_chrome_version` as XML's `prodversionmin`
thom4parisot · Apr 1, 2019 · f98080d · f98080d
2 parents 3afd311 + c9c79a2
commit f98080d
Show file tree

Hide file tree

Showing 5 changed files with 45 additions and 5 deletions.
diff --git a/src/crx.js b/src/crx.js
@@ -258,19 +258,33 @@ class ChromeExtension {
   /**
    * Generates an updateXML file from the extension content.
    *
+   * If manifest does not include `minimum_chrome_version`, defaults to:
+   * - '29.0.0' for CRX2, which is earliest extensions API available
+   * - '64.0.3242' for CRX3, which is when Chrome etension packager switched to CRX3
+   *
    * BC BREAK `this.updateXML` is not stored anymore (since 1.0.0)
    *
+   * @see
+   *   [Chrome Extensions APIs]{@link https://developer.chrome.com/extensions/api_index}
+   * @see
+   *   [Chrome verions]{@link https://en.wikipedia.org/wiki/Google_Chrome_version_history}
+   * @see
+   *   [Chromium switches to CRX3]{@link https://chromium.googlesource.com/chromium/src.git/+/b8bc9f99ef4ad6223dfdcafd924051561c05ac75}
    * @returns {Buffer}
    */
   generateUpdateXML () {
     if (!this.codebase) {
       throw new Error("No URL provided for update.xml.");
     }
 
+    var browserVersion = this.manifest.minimum_chrome_version
+      || (this.version < 3 && "29.0.0") // Earliest version with extensions API
+      || "64.0.3242"; // Chrome started generating CRX3 packages
+
     return Buffer.from(`<?xml version='1.0' encoding='UTF-8'?>
 <gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>
   <app appid='${this.appId || this.generateAppId()}'>
-    <updatecheck codebase='${this.codebase}' version='${this.manifest.version}' />
+    <updatecheck codebase='${this.codebase}' version='${this.manifest.version}' prodversionmin='${browserVersion}' />
   </app>
 </gupdate>`);
   }

diff --git a/test/expectations/update.xml → test/expectations/updateCRX2.xml b/test/expectations/update.xml → test/expectations/updateCRX2.xml
@@ -1,6 +1,6 @@
 <?xml version='1.0' encoding='UTF-8'?>
 <gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>
   <app appid='eoilidhiokfphdhpmhoaengdkehanjif'>
-    <updatecheck codebase='http://localhost:8000/myFirstExtension.crx' version='1.0' />
+    <updatecheck codebase='http://localhost:8000/myFirstExtension.crx' version='1.0' prodversionmin='29.0.0' />
   </app>
 </gupdate>
diff --git a/test/expectations/updateCRX3.xml b/test/expectations/updateCRX3.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>
+  <app appid='eoilidhiokfphdhpmhoaengdkehanjif'>
+    <updatecheck codebase='http://localhost:8000/myFirstExtension.crx' version='1.0' prodversionmin='64.0.3242' />
+  </app>
+</gupdate>
diff --git a/test/expectations/updateProdVersionMin.xml b/test/expectations/updateProdVersionMin.xml
@@ -0,0 +1,6 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<gupdate xmlns='http://www.google.com/update2/response' protocol='2.0'>
+  <app appid='eoilidhiokfphdhpmhoaengdkehanjif'>
+    <updatecheck codebase='http://localhost:8000/myFirstExtension.crx' version='1.0' prodversionmin='99.99.99-crxtest' />
+  </app>
+</gupdate>
diff --git a/test/index.js b/test/index.js
@@ -7,7 +7,9 @@ var Zip = require("adm-zip");
 var ChromeExtension = require("../");
 var join = require("path").join;
 var privateKey = fs.readFileSync(join(__dirname, "key.pem"));
-var updateXml = fs.readFileSync(join(__dirname, "expectations", "update.xml"));
+var updateXml2 = fs.readFileSync(join(__dirname, "expectations", "updateCRX2.xml"));
+var updateXml3 = fs.readFileSync(join(__dirname, "expectations", "updateCRX3.xml"));
+var updateXmlCustom = fs.readFileSync(join(__dirname, "expectations", "updateProdVersionMin.xml"));
 
 function newCrx(opts){
   return new ChromeExtension(Object.assign({
@@ -109,18 +111,30 @@ TESTS.loadContents = function(t, opts){
 
 
 TESTS.generateUpdateXML = function(t, opts){
-  t.plan(2);
+  t.plan(3);
 
   t.throws(() => new ChromeExtension({}).generateUpdateXML(), 'No URL provided for update.xml');
 
   var crx = newCrx(opts);
+  var expected = crx.version === 2 ? updateXml2 : updateXml3; 
 
   crx.pack().then(function(){
     var xmlBuffer = crx.generateUpdateXML();
 
-    t.equals(xmlBuffer.toString(), updateXml.toString());
+    t.equals(xmlBuffer.toString(), expected.toString());
   })
   .catch(t.error.bind(t));
+
+  var crxCustom = newCrx(opts);
+  crxCustom.load().then(() => {
+    crxCustom.manifest.minimum_chrome_version = '99.99.99-crxtest';
+    crxCustom.pack().then(function(){
+      var xmlBuffer = crxCustom.generateUpdateXML();
+
+      t.equals(xmlBuffer.toString(), updateXmlCustom.toString());
+    })
+    .catch(t.error.bind(t));
+  });
 };
 
 TESTS.generatePublicKey = function(t, opts) {