apostrophe 2.223.1 → 2.225.0-alpha

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## UNRELEASED
+
+### Adds
+
+* Accepts `APOS_BASE_URL` environment variable as an override of the global `baseUrl` option. Useful in devops.
+
+## 2.224.0 (2023-02-01)
+
+### Adds
+
+* If about to 404, redirect uppercase URLs automatically to their lowercase version - can be disabled with `redirectFailedUpperCaseUrls: false` in `apostrophe-pages/index.js` options.
+
 ## 2.223.1 (2022-12-21)
 
 ### Fixes

package/index.js

@@ -335,6 +335,8 @@ module.exports = function(options) {
       throw "Specify the `shortName` option and set it to the name of your project's repository or folder";
     }
     self.title = self.options.title;
+    // For devops purposes
+    self.options.baseUrl = process.env.APOS_BASE_URL || self.options.baseUrl;
     self.baseUrl = self.options.baseUrl;
     self.prefix = self.options.prefix || '';
   }

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

@@ -255,6 +255,8 @@ module.exports = {
 
   alias: 'pages',
 
+  redirectFailedUpperCaseUrls: true,
+
   types: [
     {
       // So that the minimum parked pages don't result in an error when home has no manager. -Tom
@@ -324,12 +326,14 @@ module.exports = {
         name: 'trash',
         label: 'Trash'
       }
-    ].concat(options.apos.docs.trashInSchema ? [
-      {
-        name: 'rescue',
-        label: 'Rescue'
-      }
-    ] : []).concat([
+    ].concat(options.apos.docs.trashInSchema
+      ? [
+        {
+          name: 'rescue',
+          label: 'Rescue'
+        }
+      ]
+      : []).concat([
       {
         name: 'publish',
         label: 'Publish'

package/lib/modules/apostrophe-pages/lib/api.js

@@ -429,7 +429,13 @@ module.exports = function(self, options) {
           .trash(null)
           .published(null)
           .areas(false)
-          .ancestors(_.assign({ depth: 1, trash: null, published: null, areas: false, permission: false }, options.filters || {}))
+          .ancestors(_.assign({
+            depth: 1,
+            trash: null,
+            published: null,
+            areas: false,
+            permission: false
+          }, options.filters || {}))
           .applyFilters(options.filters || {})
           .toObject(function(err, page) {
             if (err) {
@@ -460,7 +466,13 @@ module.exports = function(self, options) {
           .trash(null)
           .published(null)
           .areas(false)
-          .ancestors(_.assign({ depth: 1, trash: null, published: null, areas: false, permission: false }, options.filters || {}))
+          .ancestors(_.assign({
+            depth: 1,
+            trash: null,
+            published: null,
+            areas: false,
+            permission: false
+          }, options.filters || {}))
           .applyFilters(options.filters || {})
           .toObject(function(err, page) {
             if (err) {
@@ -516,7 +528,11 @@ module.exports = function(self, options) {
       function nudgeNewPeers(callback) {
         // Nudge down the pages that should now follow us
         // Always remember multi: true
-        self.apos.docs.db.update(mergeCriteria({ path: self.matchDescendants(parent), level: parent.level + 1, rank: { $gte: rank } }), { $inc: { rank: 1 } }, { multi: true }, function(err, count) {
+        self.apos.docs.db.update(mergeCriteria({
+          path: self.matchDescendants(parent),
+          level: parent.level + 1,
+          rank: { $gte: rank }
+        }), { $inc: { rank: 1 } }, { multi: true }, function(err, count) {
           return callback(err);
         });
       }
@@ -738,7 +754,12 @@ module.exports = function(self, options) {
       [
         function getPage(cb) {
         // check permissions and load page to trash/untrash
-          return self.find(req, { _id: _id }).permission('edit').trash(null).ancestors({ depth: 1, published: null, trash: null, areas: false }).toObject((err, _page) => {
+          return self.find(req, { _id: _id }).permission('edit').trash(null).ancestors({
+            depth: 1,
+            published: null,
+            trash: null,
+            areas: false
+          }).toObject((err, _page) => {
             page = _page;
             tree.push(page);
             parent = page._ancestors[0];
@@ -876,14 +897,17 @@ module.exports = function(self, options) {
     var parent;
     var changed = [];
 
-    return async.series([findTrash, findPage, movePage], function(err) {
+    return async.series([ findTrash, findPage, movePage ], function(err) {
       return callback(err, parent && parent.slug, changed);
     });
 
     function findTrash(callback) {
       // Always only one trash page at level 1, so we don't have
       // to hardcode the slug
-      return self.find(req, { trash: true, level: 1 })
+      return self.find(req, {
+        trash: true,
+        level: 1
+      })
         .permission(false)
         .published(null)
         .trash(null)
@@ -899,7 +923,12 @@ module.exports = function(self, options) {
 
     function findPage(callback) {
       // Also checks permissions
-      return self.find(req, { _id: _id }).permission('edit').ancestors({ depth: 1, published: null, trash: null, areas: false }).toObject(function(err, _page) {
+      return self.find(req, { _id: _id }).permission('edit').ancestors({
+        depth: 1,
+        published: null,
+        trash: null,
+        areas: false
+      }).toObject(function(err, _page) {
         if (err || (!_page)) {
           return callback('Page not found');
         }
@@ -943,7 +972,12 @@ module.exports = function(self, options) {
 
     function findPage(callback) {
       // Also checks permissions
-      return self.find(req, { _id: _id }).permission('publish').trash(true).ancestors({ depth: 1, published: null, trash: null, areas: false }).toObject(function(err, _page) {
+      return self.find(req, { _id: _id }).permission('publish').trash(true).ancestors({
+        depth: 1,
+        published: null,
+        trash: null,
+        areas: false
+      }).toObject(function(err, _page) {
         if (err || (!_page)) {
           return callback('Page not found');
         }
@@ -1134,6 +1168,12 @@ module.exports = function(self, options) {
       if (self.isFound(req)) {
         return callback(null);
       }
+
+      if (options.redirectFailedUpperCaseUrls && /[A-Z]/.test(req.path)) {
+        req.redirect = self.apos.urls.build(req.path.toLowerCase(), req.query);
+        return callback(null);
+      }
+
       req.data.suggestedSearch = self.apos.utils.slugify(req.url, { separator: ' ' });
       req.notFound = true;
       req.res.statusCode = 404;
@@ -1141,7 +1181,7 @@ module.exports = function(self, options) {
       // Give the browser a chance to do something interesting with a 404.
       // This is often a better idea than doing a heavy fallback search
       // server side, because those are triggered heavily by bots
-      req.browserCall("apos.emit('notfound', ?)", {
+      req.browserCall('apos.emit(\'notfound\', ?)', {
         suggestedSearch: req.data.suggestedSearch,
         url: req.url
       });
@@ -1421,7 +1461,10 @@ module.exports = function(self, options) {
 
   self.ensurePathIndex = function(callback) {
     var params = self.getPathIndexParams();
-    return self.apos.docs.db.ensureIndex(params, { unique: true, sparse: true }, callback);
+    return self.apos.docs.db.ensureIndex(params, {
+      unique: true,
+      sparse: true
+    }, callback);
   };
 
   self.getPathIndexParams = function() {
@@ -1502,8 +1545,14 @@ module.exports = function(self, options) {
     var matchParentPathPrefix = new RegExp('^' + self.apos.utils.regExpQuote(originalPath + '/'));
     var matchParentSlugPrefix = new RegExp('^' + self.apos.utils.regExpQuote(originalSlug + '/'));
     var done = false;
-    var cursor = self.apos.docs.db.findWithProjection(mergeCriteria({ path: matchParentPathPrefix }), { slug: 1, path: 1, level: 1 });
-    return async.whilst(function() { return !done; }, function(callback) {
+    var cursor = self.apos.docs.db.findWithProjection(mergeCriteria({ path: matchParentPathPrefix }), {
+      slug: 1,
+      path: 1,
+      level: 1
+    });
+    return async.whilst(function() {
+      return !done;
+    }, function(callback) {
       return cursor.nextObject(function(err, desc) {
         if (err) {
           return callback(err);
@@ -1996,10 +2045,10 @@ module.exports = function(self, options) {
   self.validateTypeChoices = function() {
     _.each(self.typeChoices, function(choice) {
       if (!choice.name) {
-        throw new Error("One of the page types specified for your 'types' option has no 'name' property.");
+        throw new Error('One of the page types specified for your \'types\' option has no \'name\' property.');
       }
       if (!choice.label) {
-        throw new Error("One of the page types specified for your 'types' option has no 'label' property.");
+        throw new Error('One of the page types specified for your \'types\' option has no \'label\' property.');
       }
     });
   };
@@ -2060,7 +2109,10 @@ module.exports = function(self, options) {
 
   self.removeSlugFromHomepageSchema = function(page, schema) {
     if (page.level === 0) {
-      schema = _.reject(schema, { type: 'slug', name: 'slug' });
+      schema = _.reject(schema, {
+        type: 'slug',
+        name: 'slug'
+      });
     }
     return schema;
   };

package/package.json

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

package/test/base-url-env-var.js

@@ -0,0 +1,45 @@
+const t = require('../test-lib/test.js');
+const assert = require('assert');
+let apos;
+let savedBaseUrl;
+
+describe('APOS_BASE_URL environment variable', function() {
+
+  this.timeout(t.timeout);
+
+  before(function(done) {
+    savedBaseUrl = process.env.APOS_BASE_URL;
+    process.env.APOS_BASE_URL = 'https://madethisup.com';
+    apos = require('../index.js')({
+      root: module,
+      shortName: 'test',
+      afterInit: function(callback) {
+        // In tests this will be the name of the test file,
+        // so override that in order to get apostrophe to
+        // listen normally and not try to run a task. -Tom
+        apos.argv._ = [];
+        return callback(null);
+      },
+      afterListen: function(err) {
+        assert(!err);
+        done();
+      }
+    });
+  });
+
+  after(function(done) {
+    if (savedBaseUrl) {
+      process.env.APOS_BASE_URL = savedBaseUrl;
+    } else {
+      delete process.env.APOS_BASE_URL;
+    }
+    return t.destroy(apos, done);
+  });
+
+  it('should respect APOS_BASE_URL', async function() {
+    const req = apos.tasks.getReq();
+    const home = await apos.docs.find(req, { slug: '/' }).toObject();
+    assert(home);
+    assert.strictEqual(home._url, 'https://madethisup.com/');
+  });
+});

package/test/pages.js

@@ -433,7 +433,6 @@ describe('Pages', function() {
       assert(body.match(/Home: \//));
       // Does the response prove that data.home._children was available?
       assert(body.match(/Tab: \/another-parent/));
-      // console.log(body);
       return done();
     });
   });
@@ -447,7 +446,6 @@ describe('Pages', function() {
       assert(body.match(/Home: \//));
       // Does the response prove that data.home._children was available?
       assert(body.match(/Tab: \/another-parent/));
-      // console.log(body);
       return done();
     });
   });
@@ -475,6 +473,29 @@ describe('Pages', function() {
     });
   });
 
+  it('should redirect to url with path in lower case by default', function(done) {
+    return request('http://localhost:7900/chiLD', function (err, response, body) {
+      assert(!err);
+      assert.equal(response.statusCode, 200);
+      assert(body.match(/Sing to me, Oh Muse./));
+      assert(body.match(/Home: \//));
+      assert(body.match(/Tab: \/another-parent/));
+      return done();
+    });
+  });
+
+  it('should not redirect to url with path in lower case if the option is disabled', function(done) {
+    apos.pages.options.redirectFailedUpperCaseUrls = false;
+
+    return request('http://localhost:7900/chiLD', function (err, response, body) {
+      assert(!err);
+      assert.equal(response.statusCode, 404);
+      apos.pages.options.redirectFailedUpperCaseUrls = true;
+      return done();
+    });
+
+  });
+
   it('should detect that the home page is an ancestor of any page except itself', function() {
     assert(
       apos.pages.isAncestorOf({
@@ -561,8 +582,8 @@ describe('Pages', function() {
       assert.equal(page.path, '/newish-page');
       done();
     });
-  });
 
+  });
 });
 
 describe('Pages with trashInSchema', function() {