apostrophe 2.221.0 → 2.221.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## 2.221.2 (2022-07-06)
+
+## Fixes
+
+* Previously, cache objects returned by `apos.caches.get` shared an incorrectly configured unique key index that prevented the same key from existing in two caches. This did not lead to any data integrity problems, because it was too strict rather than not strict enough. In this release the offending index is replaced with a correct one, which must be unique only on a combination of `name` (the cache name) and `key`, and unit test coverage is added to prevent a recurrence.
+
+## 2.221.1 (2022-06-22)
+
+## Fixes
+
+* Take into account query string in redirections.
+
 ## 2.221.0 (2022-06-07)
 
 ## Adds

package/lib/modules/apostrophe-caches/index.js

@@ -16,6 +16,7 @@ module.exports = {
 
   afterConstruct: function(self, callback) {
     self.addClearCacheTask();
+    self.removeBadIndexMigration();
     return self.getCollection(function(err) {
       if (err) {
         return callback(err);
@@ -213,7 +214,7 @@ module.exports = {
     self.ensureIndexes = function(callback) {
       return async.series({
         keyIndex: function(callback) {
-          return self.cacheCollection.ensureIndex({ key: 1, cache: 1 }, { unique: true }, callback);
+          return self.cacheCollection.ensureIndex({ key: 1, name: 1 }, { unique: true }, callback);
         },
         expireIndex: function(callback) {
           return self.cacheCollection.ensureIndex({ expires: 1 }, { expireAfterSeconds: 0 }, callback);
@@ -242,5 +243,26 @@ module.exports = {
         }
       );
     };
+
+    self.removeBadIndexMigration = function() {
+      // Cache module wakes before migrations module so we have to wait
+      // for apostrophe:modulesReady before registering the migration. Most modules
+      // can register one directly from afterConstruct
+      self.on('apostrophe:modulesReady', 'addRemoveBadIndexMigration', function() {
+        self.apos.migrations.add(self.__meta.name + '.removeBadIndex', async function() {
+          const indexes = await self.cacheCollection.indexes();
+          const culprit = indexes.find(index => index.key &&
+            (Object.keys(index.key).length === 2) &&
+            index.key.key &&
+            index.key.cache &&
+            index.unique
+          );
+          if (culprit) {
+            self.apos.utils.log('Removing incorrect cache index');
+            return self.cacheCollection.dropIndex(culprit.name);
+          }
+        });
+      });
+    };
   }
 };

package/lib/modules/apostrophe-soft-redirects/index.js

@@ -1,5 +1,6 @@
 var _ = require('@sailshq/lodash');
 var async = require('async');
+var qs = require('qs');
 
 // Implements "soft redirects." When a 404 is about to occur, Apostrophe will look
 // for a page or piece that has been associated with that URL in the past, and
@@ -48,21 +49,27 @@ module.exports = {
     };
 
     self.pageNotFound = function(req, callback) {
-      return self.apos.docs.find(req, { historicUrls: { $in: [ req.url ] } }).sort({ updatedAt: -1 }).toObject(function(err, doc) {
-        if (err) {
-          return callback(err);
-        }
-        if (!doc) {
-          return callback(null);
-        }
-        if (!doc._url) {
+      return self.apos.docs
+        .find(req, { historicUrls: req.path })
+        .sort({ updatedAt: -1 })
+        .toObject(function(err, doc) {
+          if (err) {
+            return callback(err);
+          }
+          if (!doc) {
+            return callback(null);
+          }
+          if (!doc._url) {
+            return callback(null);
+          }
+          if (self.local(doc._url) !== req.path) {
+            return req.res.redirect(
+              statusCode,
+              `${self.local(doc._url)}${qs.stringify(req.query, { addQueryPrefix: true })}`
+            );
+          }
           return callback(null);
-        }
-        if (self.local(doc._url) !== req.url) {
-          return req.res.redirect(statusCode, self.local(doc._url));
-        }
-        return callback(null);
-      });
+        });
     };
 
     self.pageBeforeSend = function(req, callback) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "2.221.0",
+  "version": "2.221.2",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {

package/test/caches.js

@@ -11,6 +11,8 @@ describe('Caches', function() {
 
   var apos;
   var cache;
+  let cache2;
+
   it('should exist on the apos object', function(done) {
     apos = require('../index.js')({
       root: module,
@@ -117,4 +119,31 @@ describe('Caches', function() {
         return true;
       });
   });
+  it('should give us a second, independent cache object', function() {
+    cache2 = apos.caches.get('testMonkeys2');
+  });
+  it('cache 1 should allow us to store capuchin', function() {
+    return cache.set('capuchin', { message: 'eek eek' });
+  });
+  it('cache 2 should allow us to store capuchin with another message', function() {
+    return cache2.set('capuchin', { message: 'ook ook' });
+  });
+  it('cache 1 should contain its unique message', async function() {
+    assert.strictEqual((await cache.get('capuchin')).message, 'eek eek');
+  });
+  it('cache 2 should contain its unique message', async function() {
+    assert.strictEqual((await cache2.get('capuchin')).message, 'ook ook');
+  });
+  it('unique index still prevents double insert of key within a namespace', async function() {
+    try {
+      await apos.caches.cacheCollection.insert({
+        key: 'capuchin',
+        name: 'testMonkeys'
+      });
+      // That's bad, unique index should have stopped us
+      assert(false);
+    } catch (e) {
+      // This is what we wanted to happen
+    }
+  });
 });

package/test/soft-redirects.js

@@ -81,7 +81,21 @@ describe('Soft Redirects', function() {
       // Is our status code good?
       assert.equal(response.statusCode, 302);
       // Are we going to be redirected to our page?
-      assert.equal(response.headers['location'], '/child-moved');
+      assert.equal(response.headers.location, '/child-moved');
+      return done();
+    });
+  });
+
+  it('should be able to serve the page at its old URL too, via redirect, with query params', function(done) {
+    return request({
+      url: 'http://localhost:7900/child?a-query-param=foo&bar[]=a&bar[]=b&another',
+      followRedirect: false
+    }, function(err, response, body) {
+      assert(!err);
+      // Is our status code good?
+      assert.equal(response.statusCode, 302);
+      // Are we going to be redirected to our page?
+      assert.equal(response.headers.location, '/child-moved?a-query-param=foo&bar%5B0%5D=a&bar%5B1%5D=b&another=');
       return done();
     });
   });
@@ -158,9 +172,8 @@ describe('Soft Redirects - with `statusCode` option', function() {
       // Is our status code good?
       assert.equal(response.statusCode, 301);
       // Are we going to be redirected to our page?
-      assert.equal(response.headers['location'], '/child-moved');
+      assert.equal(response.headers.location, '/child-moved');
       return done();
     });
   });
-
 });

package/.nyc_output/02d8fb44-f6bc-4ab4-8f47-22c7a42b887d.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/14b3f5f0-7e4e-461b-a7d9-4b735f510bd7.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/99acae99-becc-463d-ba35-9333f88d2694.json

@@ -1 +0,0 @@
-{}

package/.nyc_output/d071f9e0-3b11-44e6-9817-69f184dd064d.json

@@ -1 +0,0 @@
-{}