apostrophe 3.17.0 → 3.18.0

package/test/docs.js

@@ -1,6 +1,7 @@
 const t = require('../test-lib/test.js');
 const assert = require('assert');
 const _ = require('lodash');
+
 let apos;
 
 describe('Docs', function() {
@@ -30,6 +31,20 @@ describe('Docs', function() {
               }
             }
           }
+        },
+        '@apostrophecms/page': {
+          options: {
+            park: [],
+            types: [
+              {
+                name: 'test-page',
+                label: 'Test Page'
+              }
+            ]
+          }
+        },
+        'test-page': {
+          extend: '@apostrophecms/page-type'
         }
       }
     });
@@ -144,6 +159,68 @@ describe('Docs', function() {
     assert(person._friends[0].slug === 'larry');
   });
 
+  it('should support custom context menu (required only)', async function() {
+    const operation = {
+      context: 'update',
+      action: 'test',
+      label: 'Menu Label',
+      modal: 'SomeModalComponent'
+    };
+    assert.strictEqual(apos.doc.contextOperations.length, 0);
+
+    apos.doc.addContextOperation('test-people', operation);
+    assert.strictEqual(apos.doc.contextOperations.length, 1);
+    assert.deepStrictEqual(apos.doc.contextOperations[0], {
+      ...operation,
+      moduleName: 'test-people'
+    });
+  });
+
+  it('should support custom context menu (with optional)', async function() {
+    apos.doc.contextOperations = [];
+    const operation = {
+      context: 'update',
+      action: 'test',
+      label: 'Menu Label',
+      modal: 'SomeModalComponent',
+      manuallyPublished: true,
+      modifiers: [ 'danger' ]
+    };
+    assert.strictEqual(apos.doc.contextOperations.length, 0);
+
+    apos.doc.addContextOperation('test-people', operation);
+    assert.strictEqual(apos.doc.contextOperations.length, 1);
+    assert.deepStrictEqual(apos.doc.contextOperations[0], {
+      ...operation,
+      moduleName: 'test-people'
+    });
+  });
+
+  it('should override custom context menu', async function() {
+    apos.doc.contextOperations = [];
+    const operation1 = {
+      context: 'update',
+      action: 'test',
+      label: 'Op1',
+      modal: 'SomeModalComponent'
+    };
+    const operation2 = {
+      context: 'update',
+      action: 'test',
+      label: 'Op2',
+      modal: 'SomeModalComponent'
+    };
+    assert.strictEqual(apos.doc.contextOperations.length, 0);
+
+    apos.doc.addContextOperation('test-people', operation1);
+    apos.doc.addContextOperation('test-people', operation2);
+    assert.strictEqual(apos.doc.contextOperations.length, 1);
+    assert.deepStrictEqual(apos.doc.contextOperations[0], {
+      ...operation2,
+      moduleName: 'test-people'
+    });
+  });
+
   /// ///
   // UNIQUENESS
   /// ///
@@ -299,7 +376,7 @@ describe('Docs', function() {
     assert(doc.slug.match(/^one\d+$/));
   });
 
-  it('should add the aposDocId to the related documents\' relatedReverseIds field', async () => {
+  it('should add the aposDocId to the related documents\' relatedReverseIds field and update their `cacheInvalidatedAt` field', async function() {
     const object = {
       aposDocId: 'paul',
       aposLocale: 'en:published',
@@ -314,7 +391,7 @@ describe('Docs', function() {
       _friends: [ { _id: 'carl:en:published' }, { _id: 'larry:en:published' } ]
     };
 
-    await apos.doc.insert(apos.task.getReq(), object);
+    const response = await apos.doc.insert(apos.task.getReq(), object);
 
     const carlDoc = await apos.doc.db.findOne({
       slug: 'carl',
@@ -328,9 +405,11 @@ describe('Docs', function() {
 
     assert(carlDoc.relatedReverseIds.length === 1);
     assert(carlDoc.relatedReverseIds[0] === 'paul');
+    assert(carlDoc.cacheInvalidatedAt.getTime() === response.updatedAt.getTime());
 
     assert(larryDoc.relatedReverseIds.length === 1);
     assert(larryDoc.relatedReverseIds[0] === 'paul');
+    assert(larryDoc.cacheInvalidatedAt.getTime() === response.updatedAt.getTime());
   });
 
   it('should not allow you to call the insert method if you are not an admin', async function() {
@@ -419,7 +498,7 @@ describe('Docs', function() {
     assert(counts.Lori === 2);
   });
 
-  it('should remove the aposDocId from the related documents\' relatedReverseIds field', async () => {
+  it('should remove the aposDocId from the related documents\' relatedReverseIds field and update their `cacheInvalidatedAt` field', async function() {
     const paulDoc = await apos.doc.db.findOne({
       slug: 'paul',
       aposLocale: 'en:published'
@@ -432,7 +511,7 @@ describe('Docs', function() {
       _friends: [ { _id: 'larry:en:published' } ]
     };
 
-    await apos.doc.update(apos.task.getReq(), object);
+    const response = await apos.doc.update(apos.task.getReq(), object);
 
     const carlDoc = await apos.doc.db.findOne({
       slug: 'carl',
@@ -445,9 +524,79 @@ describe('Docs', function() {
     });
 
     assert(carlDoc.relatedReverseIds.length === 0);
+    assert(carlDoc.cacheInvalidatedAt.getTime() === response.updatedAt.getTime());
 
     assert(larryDoc.relatedReverseIds.length === 1);
     assert(larryDoc.relatedReverseIds[0] === 'paul');
+    assert(larryDoc.cacheInvalidatedAt.getTime() === response.updatedAt.getTime());
+  });
+
+  it('should update the related reverse documents\' `cacheInvalidatedAt` field', async function() {
+    const object = {
+      aposDocId: 'john',
+      aposLocale: 'en:published',
+      slug: 'john',
+      visibility: 'public',
+      type: 'test-people',
+      firstName: 'John',
+      lastName: 'McClane',
+      age: 40,
+      alive: true,
+      friendsIds: [ 'carl' ],
+      _friends: [ { _id: 'carl:en:published' } ]
+    };
+
+    await apos.doc.insert(apos.task.getReq(), object);
+
+    const carlDoc = await apos.doc.db.findOne({
+      slug: 'carl',
+      aposLocale: 'en:published'
+    });
+
+    // update carl, now john (related reverse friend) should have its `cacheInvalidatedAt` field updated as well
+    const response = await apos.doc.update(apos.task.getReq(), {
+      ...carlDoc,
+      alive: false
+    });
+
+    const johnDoc = await apos.doc.db.findOne({
+      slug: 'john',
+      aposLocale: 'en:published'
+    });
+
+    assert(johnDoc.cacheInvalidatedAt.getTime() === response.updatedAt.getTime());
+  });
+
+  it('should update the pieces parent page\'s `cacheInvalidatedAt` field', async function() {
+    const page = {
+      slug: '/parent/new-page',
+      visibility: 'public',
+      type: 'test-page',
+      title: 'New Page'
+    };
+
+    const object = {
+      aposDocId: 'bruce',
+      aposLocale: 'en:published',
+      slug: 'bruce',
+      visibility: 'public',
+      type: 'test-people',
+      firstName: 'Bruce',
+      lastName: 'Lee',
+      age: 30,
+      alive: false,
+      _parentSlug: '/parent/new-page'
+    };
+
+    await apos.doc.insert(apos.task.getReq(), page);
+    const response = await apos.doc.insert(apos.task.getReq(), object);
+
+    const pageDoc = await apos.doc.db.findOne({
+      slug: '/parent/new-page',
+      aposLocale: 'en:published'
+    });
+
+    assert(pageDoc.cacheInvalidatedAt.getTime() === response.updatedAt.getTime());
   });
 
   it('should not allow you to call the update method if you are not an admin', async function() {
@@ -687,4 +836,95 @@ describe('Docs', function() {
     await apos.doc.createTextIndex();
   });
 
+  /// ///
+  // MIGRATIONS
+  /// ///
+
+  it('should add via a migration the `cacheInvalidatedAt` field to any doc and set it to equal the doc\'s `updatedAt` field', async function() {
+    const objects = [
+      {
+        slug: 'test-for-cacheInvalidatedAt-field-migration1',
+        visibility: 'public',
+        type: 'test-people',
+        firstName: 'Kurt',
+        lastName: 'Cobain',
+        age: 27,
+        alive: false,
+        updatedAt: '2022-03-28T12:57:03.685Z'
+      },
+      {
+        slug: 'test-for-cacheInvalidatedAt-field-migration2',
+        visibility: 'public',
+        type: 'test-people',
+        firstName: 'Jim',
+        lastName: 'Morrison',
+        age: 27,
+        alive: false,
+        updatedAt: '2020-08-29T12:57:03.685Z'
+      }
+    ];
+
+    await apos.doc.db.insertMany(objects);
+    await apos.doc.setCacheField();
+
+    const docs = await apos.doc.db.find({ slug: /test-for-cacheInvalidatedAt-field-migration/ }).toArray();
+    docs.forEach((doc, index) => {
+      const timestamps = {
+        doc: new Date(doc.cacheInvalidatedAt).toString(),
+        expected: new Date(objects[index].updatedAt).toString()
+
+      };
+      assert(timestamps.doc === timestamps.expected);
+    });
+  });
+
+  it('should not add via a migration the `cacheInvalidatedAt` field to docs that already have it', async function() {
+    const object = {
+      slug: 'test-for-cacheInvalidatedAt-field-migration3',
+      visibility: 'public',
+      type: 'test-people',
+      firstName: 'Janis',
+      lastName: 'Joplin',
+      age: 27,
+      alive: false,
+      updatedAt: '2018-08-29T12:57:03.685Z',
+      cacheInvalidatedAt: '2019-08-29T12:57:03.685Z'
+    };
+
+    await apos.doc.db.insert(object);
+    await apos.doc.setCacheField();
+
+    const doc = await apos.doc.db.findOne({ slug: 'test-for-cacheInvalidatedAt-field-migration3' });
+    const timestamps = {
+      doc: new Date(doc.cacheInvalidatedAt).toString(),
+      expected: new Date(object.cacheInvalidatedAt).toString()
+    };
+
+    assert(timestamps.doc === timestamps.expected);
+  });
+
+  /// ///
+  // CACHING
+  /// ///
+
+  it('should add a `cacheInvalidatedAt` field and set it to equal `updatedAt` field when saving a doc', async function() {
+    const object = {
+      slug: 'test-for-cacheInvalidatedAt-field',
+      visibility: 'public',
+      type: 'test-people',
+      firstName: 'Michael',
+      lastName: 'Jackson',
+      age: 64,
+      alive: true
+    };
+
+    const response = await apos.doc.insert(apos.task.getReq(), object);
+    const draft = await apos.doc.db.findOne({
+      _id: `${response.aposDocId}:en:draft`
+    });
+
+    assert(response.cacheInvalidatedAt.getTime() === response.updatedAt.getTime());
+    assert(draft.cacheInvalidatedAt.getTime() === draft.updatedAt.getTime());
+  });
+
 });

package/test/draft-published.js

@@ -15,7 +15,7 @@ describe('Draft / Published', function() {
   // EXISTENCE
   /// ///
 
-  it('should initialize with a schema', async () => {
+  it('should initialize with a schema', async function() {
     apos = await t.create({
       root: module,
 
@@ -122,7 +122,7 @@ describe('Draft / Published', function() {
 
   let testDraftProduct;
 
-  it('should be able to create and insert a draft product', async () => {
+  it('should be able to create and insert a draft product', async function() {
     const product = apos.product.newInstance();
     product.title = 'Test Product';
     testDraftProduct = await apos.product.insert(apos.task.getReq({
@@ -131,19 +131,19 @@ describe('Draft / Published', function() {
     assert(testDraftProduct.modified);
   });
 
-  it('published should not exist yet', async () => {
+  it('published should not exist yet', async function() {
     assert(!await apos.doc.db.findOne({
       _id: testDraftProduct._id.replace(':draft', ':published')
     }));
   });
 
-  it('should be able to publish the product', async () => {
+  it('should be able to publish the product', async function() {
     await apos.product.publish(apos.task.getReq({
       mode: 'draft'
     }), testDraftProduct);
   });
 
-  it('published product should exist and be the same', async () => {
+  it('published product should exist and be the same', async function() {
     const product = await apos.product.find(apos.task.getReq({
       mode: 'published'
     }), {
@@ -155,7 +155,7 @@ describe('Draft / Published', function() {
     assert(product.title === testDraftProduct.title);
   });
 
-  it('original product should no longer be modified', async () => {
+  it('original product should no longer be modified', async function() {
     testDraftProduct = await apos.product.find(apos.task.getReq({
       mode: 'draft'
     }), {
@@ -165,14 +165,14 @@ describe('Draft / Published', function() {
     assert(!testDraftProduct.modified);
   });
 
-  it('original product still shows as unmodified if we update it with no changes', async () => {
+  it('original product still shows as unmodified if we update it with no changes', async function() {
     testDraftProduct = await apos.product.update(apos.task.getReq({
       mode: 'draft'
     }), testDraftProduct);
     assert(!testDraftProduct.modified);
   });
 
-  it('original product shows as modified if we make a change to it', async () => {
+  it('original product shows as modified if we make a change to it', async function() {
     testDraftProduct.title = 'Another Title';
     testDraftProduct = await apos.product.update(apos.task.getReq({
       mode: 'draft'
@@ -180,7 +180,7 @@ describe('Draft / Published', function() {
     assert(testDraftProduct.modified);
   });
 
-  it('can revert the draft to published', async () => {
+  it('can revert the draft to published', async function() {
     testDraftProduct = await apos.product.revertDraftToPublished(apos.task.getReq({
       mode: 'draft'
     }), testDraftProduct);
@@ -189,13 +189,13 @@ describe('Draft / Published', function() {
     assert(testDraftProduct.title === 'Test Product');
   });
 
-  it('cannot revert the draft again', async () => {
+  it('cannot revert the draft again', async function() {
     assert(!await apos.product.revertDraftToPublished(apos.task.getReq({
       mode: 'draft'
     }), testDraftProduct));
   });
 
-  it('original product shows as modified if we make another change to it', async () => {
+  it('original product shows as modified if we make another change to it', async function() {
     testDraftProduct.title = 'Title 3';
     testDraftProduct = await apos.product.update(apos.task.getReq({
       mode: 'draft'
@@ -203,13 +203,13 @@ describe('Draft / Published', function() {
     assert(testDraftProduct.modified);
   });
 
-  it('should be able to publish the product', async () => {
+  it('should be able to publish the product again', async function() {
     await apos.product.publish(apos.task.getReq({
       mode: 'draft'
     }), testDraftProduct);
   });
 
-  it('"previous published" should be deduplicated at this point', async () => {
+  it('"previous published" should be deduplicated at this point', async function() {
     const previous = await apos.doc.db.findOne({
       _id: testDraftProduct._id.replace(':draft', ':previous')
     });
@@ -217,7 +217,7 @@ describe('Draft / Published', function() {
     assert.strictEqual(previous.slug, `deduplicate-${previous.aposDocId}-test-product`);
   });
 
-  it('original product shows as modified if we make a third change to it', async () => {
+  it('original product shows as modified if we make a third change to it', async function() {
     testDraftProduct.title = 'Title 4';
     testDraftProduct = await apos.product.update(apos.task.getReq({
       mode: 'draft'
@@ -225,7 +225,7 @@ describe('Draft / Published', function() {
     assert(testDraftProduct.modified);
   });
 
-  it('can revert the draft to Title 3', async () => {
+  it('can revert the draft to Title 3', async function() {
     testDraftProduct = await apos.product.revertDraftToPublished(apos.task.getReq({
       mode: 'draft'
     }), testDraftProduct);
@@ -234,7 +234,7 @@ describe('Draft / Published', function() {
     assert(testDraftProduct.title === 'Title 3');
   });
 
-  it('can revert the published version to Test Product (previous publication)', async () => {
+  it('can revert the published version to Test Product (previous publication)', async function() {
     const req = apos.task.getReq({
       mode: 'published'
     });
@@ -257,7 +257,7 @@ describe('Draft / Published', function() {
     assert(testDraftProduct.modified);
   });
 
-  it('cannot revert published to previous again', async () => {
+  it('cannot revert published to previous again', async function() {
     const req = apos.task.getReq({
       mode: 'published'
     });
@@ -276,7 +276,7 @@ describe('Draft / Published', function() {
 
   let parent;
 
-  it('should be able to create and insert a draft page', async () => {
+  it('should be able to create and insert a draft page', async function() {
     parent = {
       type: 'test-page',
       title: 'Parent',
@@ -294,19 +294,19 @@ describe('Draft / Published', function() {
     assert(parent.modified);
   });
 
-  it('published should not exist yet', async () => {
+  it('published should not exist yet again', async function() {
     assert(!await apos.doc.db.findOne({
       _id: parent._id.replace(':draft', ':published')
     }));
   });
 
-  it('should be able to publish the page', async () => {
+  it('should be able to publish the page', async function() {
     await apos.page.publish(apos.task.getReq({
       mode: 'draft'
     }), parent);
   });
 
-  it('published page should exist and be the same', async () => {
+  it('published page should exist and be the same', async function() {
     const publishedParent = await apos.page.find(apos.task.getReq({
       mode: 'published'
     }), {
@@ -318,7 +318,7 @@ describe('Draft / Published', function() {
     assert(publishedParent.title === parent.title);
   });
 
-  it('original page should no longer be modified', async () => {
+  it('original page should no longer be modified', async function() {
     parent = await apos.page.find(apos.task.getReq({
       mode: 'draft'
     }), {
@@ -328,14 +328,14 @@ describe('Draft / Published', function() {
     assert(!parent.modified);
   });
 
-  it('original page still shows as unmodified if we update it with no changes', async () => {
+  it('original page still shows as unmodified if we update it with no changes', async function() {
     parent = await apos.page.update(apos.task.getReq({
       mode: 'draft'
     }), parent);
     assert(!parent.modified);
   });
 
-  it('original page shows as modified if we make a change to it', async () => {
+  it('original page shows as modified if we make a change to it', async function() {
     parent.title = 'Parent Title 2';
     parent = await apos.page.update(apos.task.getReq({
       mode: 'draft'
@@ -343,7 +343,7 @@ describe('Draft / Published', function() {
     assert(parent.modified);
   });
 
-  it('can revert the page draft to published', async () => {
+  it('can revert the page draft to published', async function() {
     parent = await apos.page.revertDraftToPublished(apos.task.getReq({
       mode: 'draft'
     }), parent);
@@ -352,7 +352,7 @@ describe('Draft / Published', function() {
     assert(parent.title === 'Parent');
   });
 
-  it('cannot revert the draft again', async () => {
+  it('cannot revert the draft again (2)', async function() {
     assert(!await apos.page.revertDraftToPublished(apos.task.getReq({
       mode: 'draft'
     }), parent));
@@ -361,7 +361,7 @@ describe('Draft / Published', function() {
   // TODO convert more tests, add tests involving the page tree more,
   // write another test file with REST tests, implement the RESTfulness
 
-  it('original page shows as modified if we make another change to it', async () => {
+  it('original page shows as modified if we make another change to it', async function() {
     parent.title = 'Parent Title 3';
     parent = await apos.page.update(apos.task.getReq({
       mode: 'draft'
@@ -369,13 +369,13 @@ describe('Draft / Published', function() {
     assert(parent.modified);
   });
 
-  it('should be able to publish the page', async () => {
+  it('should be able to publish the page again', async function() {
     await apos.page.publish(apos.task.getReq({
       mode: 'draft'
     }), parent);
   });
 
-  it('original page shows as modified if we make a third change to it', async () => {
+  it('original page shows as modified if we make a third change to it', async function() {
     parent.title = 'Parent Title 4';
     parent = await apos.page.update(apos.task.getReq({
       mode: 'draft'
@@ -383,7 +383,7 @@ describe('Draft / Published', function() {
     assert(parent.modified);
   });
 
-  it('can revert the draft to parent Title 3', async () => {
+  it('can revert the draft to parent Title 3', async function() {
     parent = await apos.page.revertDraftToPublished(apos.task.getReq({
       mode: 'draft'
     }), parent);
@@ -392,7 +392,7 @@ describe('Draft / Published', function() {
     assert(parent.title === 'Parent Title 3');
   });
 
-  it('can revert the published version to previous', async () => {
+  it('can revert the published version to previous', async function() {
     const req = apos.task.getReq({
       mode: 'published'
     });
@@ -415,7 +415,7 @@ describe('Draft / Published', function() {
     assert(parent.modified);
   });
 
-  it('cannot revert published to previous again', async () => {
+  it('cannot revert published to previous again (2)', async function() {
     const req = apos.task.getReq({
       mode: 'published'
     });
@@ -434,7 +434,7 @@ describe('Draft / Published', function() {
 
   let sibling;
 
-  it('should be able to create and insert a sibling draft page', async () => {
+  it('should be able to create and insert a sibling draft page', async function() {
     sibling = {
       type: 'test-page',
       title: 'Sibling',
@@ -446,7 +446,7 @@ describe('Draft / Published', function() {
     assert(sibling.modified);
   });
 
-  it('should be able to publish the sibling page', async () => {
+  it('should be able to publish the sibling page', async function() {
     await apos.page.publish(apos.task.getReq({
       mode: 'draft'
     }), sibling);
@@ -454,7 +454,7 @@ describe('Draft / Published', function() {
 
   let grandchild;
 
-  it('should be able to create and insert a grandchild page', async () => {
+  it('should be able to create and insert a grandchild page', async function() {
     grandchild = {
       type: 'test-page',
       title: 'Grandchild',
@@ -469,7 +469,7 @@ describe('Draft / Published', function() {
     assert.strictEqual(grandchild.slug, '/parent/grandchild');
   });
 
-  it('published grandchild should not exist yet', async () => {
+  it('published grandchild should not exist yet', async function() {
     assert(!await apos.page.find(apos.task.getReq({
       mode: 'published'
     }), {
@@ -477,7 +477,7 @@ describe('Draft / Published', function() {
     }).toObject());
   });
 
-  it('should be able to publish the grandchild page', async () => {
+  it('should be able to publish the grandchild page', async function() {
     await apos.page.publish(apos.task.getReq({
       mode: 'draft'
     }), grandchild);
@@ -492,7 +492,7 @@ describe('Draft / Published', function() {
     assert.strictEqual(published.slug, '/parent/grandchild');
   });
 
-  it('should be able to move the grandchild page beneath the sibling page', async () => {
+  it('should be able to move the grandchild page beneath the sibling page', async function() {
     grandchild = await apos.page.find(apos.task.getReq({
       mode: 'draft'
     }), {
@@ -518,7 +518,7 @@ describe('Draft / Published', function() {
     assert(!grandchild.modified);
   });
 
-  it('published grandchild page should now also be beneath the sibling page', async () => {
+  it('published grandchild page should now also be beneath the sibling page', async function() {
     sibling = await apos.page.find(apos.task.getReq({
       mode: 'published'
     }), {
@@ -527,13 +527,13 @@ describe('Draft / Published', function() {
     assert(sibling && sibling._children && sibling._children[0] && sibling._children[0].aposDocId === grandchild.aposDocId);
   });
 
-  it('should be able to publish the grandchild page again to re-execute the move in the published locale', async () => {
+  it('should be able to publish the grandchild page again to re-execute the move in the published locale', async function() {
     await apos.page.publish(apos.task.getReq({
       mode: 'draft'
     }), grandchild);
   });
 
-  it('published grandchild page should now be beneath sibling page', async () => {
+  it('published grandchild page should now be beneath sibling page', async function() {
     const siblingPublished = await apos.page.find(apos.task.getReq({
       mode: 'published'
     }), {

package/test/express.js

@@ -105,7 +105,7 @@ describe('Express', function() {
     assert(apos.app !== apos.baseApp);
   });
 
-  it('should successfully make a GET request to establish CSRF', async function() {
+  it('should successfully make a GET request to establish CSRF (prefix)', async function() {
     jar = apos.http.jar();
     const body = await apos.http.get('/prefix/tests/welcome', {
       jar

package/test/http.js

@@ -32,7 +32,7 @@ describe('Http', function() {
     jar = apos.http.jar();
   });
 
-  it('should be able to make an http request', async () => {
+  it('should be able to make an http request', async function() {
     const result = await apos.http.get('/', {
       jar
     });
@@ -40,7 +40,7 @@ describe('Http', function() {
     assert(result.match(/logged out/));
   });
 
-  it('should be able to make an http POST request with csrf header via default csrf convenience of http.post', async () => {
+  it('should be able to make an http POST request with csrf header via default csrf convenience of http.post', async function() {
     const response = await apos.http.post('/csrf-test', {
       jar,
       body: {}