apostrophe 3.46.0 → 3.47.0

package/.github/workflows/main.yml

@@ -20,8 +20,8 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node-version: [14, 16, 18]
-        mongodb-version: [4.2, 5.0]
+        node-version: [16, 18]
+        mongodb-version: [4.4, 5.0, 6.0]
 
     # Steps represent a sequence of tasks that will be executed as part of the job
     steps:

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # Changelog
 
+## 3.47.0 (2023-05-05)
+
+### Changes
+
+* Since Node 14 and MongoDB 4.2 have reached their own end-of-support dates,
+we are **no longer supporting them for A3.** Note that our dependency on
+`jsdom` 22 is incompatible with Node 14. Node 16 and Node 18 are both
+still supported. However, because Node 16 reaches its
+end-of-life date quite soon (September), testing and upgrading directly
+to Node 18 is strongly recommended.
+* Updated `sluggo` to version 1.0.0.
+* Updated `jsdom` to version `22.0.0` to address an installation warning about the `word-wrap` module.
+
+### Fixes
+
+* Fix `extendQueries` to use super pattern for every function in builders and methods (and override properties that are not functions).
+
 ## 3.46.0 (2023-05-03)
 
 ### Fixes
@@ -58,7 +75,11 @@ shouldn't close the link dialog etc.
 
 ### Fixes
 
+* Fix various issues on conditional fields that were occurring when adding new widgets with default values or selecting a falsy value in a field that has a conditional field relying on it.  
+Populate new or existing doc instances with default values and add an empty `null` choice to select fields that do not have a default value (required or not) and to the ones configured with dynamic choices.
 * Rich text widgets save more reliably when many actions are taken quickly just before save.
+* Fix an issue in the `oembed` field where the value was kept in memory after cancelling the widget editor, which resulted in saving the value if the widget was nested and the parent widget was saved.  
+Also improve the `oembed` field UX by setting the input as `readonly` rather than `disabled` when fetching the video metadata, in order to avoid losing its focus when typing.
 
 ## 3.44.0 (2023-04-13)
 
@@ -78,11 +99,6 @@ those writing mocha tests of Apostrophe modules.
 ### Fixes
 * Fix child page slug when title is deleted
 
-### Fixes
-
-* Fix various issues on conditional fields that were occurring when adding new widgets with default values or selecting a falsy value in a field that has a conditional field relying on it.  
-Populate new or existing doc instances with default values and add an empty `null` choice to select fields that do not have a default value (required or not) and to the ones configured with dynamic choices.
-
 ## 3.43.0 (2023-03-29)
 
 ### Adds

package/modules/@apostrophecms/doc-type/index.js

@@ -1,6 +1,7 @@
 const { SemanticAttributes } = require('@opentelemetry/semantic-conventions');
 const _ = require('lodash');
 const util = require('util');
+const extendQueries = require('./lib/extendQueries');
 
 module.exports = {
   options: {
@@ -472,8 +473,9 @@ module.exports = {
             }
           }
           if (self.extendQueries[name]) {
-            wrap(query.builders, self.extendQueries[name].builders || {});
-            wrap(query.methods, self.extendQueries[name].methods || {});
+            const extendedQueries = self.extendQueries[name](self, query);
+            extendQueries(query.builders, extendedQueries.builders || {});
+            extendQueries(query.methods, extendedQueries.methods || {});
           }
         }
         Object.assign(query, query.methods);
@@ -2322,8 +2324,14 @@ module.exports = {
               query.and({ $or });
             }
           }
-        }
+        },
 
+        viewContext: {
+          def: null,
+          launder(viewContext) {
+            return [ 'manage', 'relationship' ].includes(viewContext) ? viewContext : null;
+          }
+        }
       },
 
       methods: {
@@ -3073,17 +3081,3 @@ module.exports = {
     };
   }
 };
-
-function wrap(context, extensions) {
-  for (const [ name, fn ] of extensions) {
-    if ((typeof fn) !== 'function') {
-      // Nested structure is allowed
-      context[name] = context[name] || {};
-      return wrap(context[name], fn);
-    }
-    const superMethod = context[name];
-    context[name] = function(...args) {
-      return fn(superMethod, ...args);
-    };
-  }
-}

package/modules/@apostrophecms/doc-type/lib/extendQueries.js

@@ -0,0 +1,21 @@
+module.exports = extendQueries;
+
+function extendQueries(queries, extensions) {
+  for (const [ name, fn ] of Object.entries(extensions)) {
+    if (typeof fn === 'object' && !Array.isArray(fn) && fn !== null) {
+      // Nested structure is allowed
+      queries[name] = queries[name] || {};
+      return extendQueries(queries[name], fn);
+    }
+
+    if (typeof fn !== 'function' || typeof queries[name] !== 'function') {
+      queries[name] = fn;
+      continue;
+    }
+
+    const superMethod = queries[name];
+    queries[name] = function(...args) {
+      return fn(superMethod, ...args);
+    };
+  }
+};

package/modules/@apostrophecms/oembed-field/ui/apos/components/AposInputOembed.vue

@@ -8,10 +8,14 @@
       <div class="apos-input-wrapper">
         <input
           :class="classes"
-          v-model="next.url" type="url"
+          v-model="next.url"
+          type="url"
           :placeholder="$t(field.placeholder)"
-          :disabled="field.readOnly" :required="field.required"
-          :id="uid" :tabindex="tabindex"
+          :disabled="field.readOnly"
+          :readonly="tempReadOnly"
+          :required="field.required"
+          :id="uid"
+          :tabindex="tabindex"
         >
         <component
           v-if="icon"
@@ -43,10 +47,14 @@ export default {
   data () {
     return {
       next: (this.value && this.value.data)
-        ? this.value.data : {},
+        ? { ...this.value.data } : {},
       oembedResult: {},
       dynamicRatio: '',
-      oembedError: null
+      oembedError: null,
+
+      // This variable will set the input as readonly,
+      // not disabled, in order to avoid losing focus.
+      tempReadOnly: false
     };
   },
   computed: {
@@ -104,7 +112,7 @@ export default {
       this.validateAndEmit();
     },
     async loadOembed () {
-      this.field.readOnly = true;
+      this.tempReadOnly = true;
       this.oembedResult = {};
       this.oembedError = null;
       this.dynamicRatio = '';
@@ -132,7 +140,7 @@ export default {
         this.next.title = '';
         this.next.thumbnail = '';
       } finally {
-        this.field.readOnly = false;
+        this.tempReadOnly = false;
       }
     }
   }

package/modules/@apostrophecms/piece-type/ui/apos/components/AposDocsManager.vue

@@ -146,7 +146,9 @@ export default {
       totalPages: 1,
       currentPage: 1,
       filterValues: {},
-      queryExtras: {},
+      queryExtras: {
+        viewContext: this.relationshipField ? 'relationship' : 'manage'
+      },
       holdQueries: false,
       filterChoices: {},
       allPiecesSelection: {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "apostrophe",
-  "version": "3.46.0",
+  "version": "3.47.0",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {
@@ -17,7 +17,7 @@
     "url": "git@github.com:apostrophecms/apostrophe.git"
   },
   "engines": {
-    "node": ">=12.0.0"
+    "node": ">=16.0.0"
   },
   "keywords": [
     "apostrophe",
@@ -80,7 +80,7 @@
     "i18next-http-middleware": "^3.1.5",
     "import-fresh": "^3.3.0",
     "is-wsl": "^2.2.0",
-    "jsdom": "^17.0.0",
+    "jsdom": "^22.0.0",
     "klona": "^2.0.4",
     "launder": "^1.4.0",
     "lodash": "^4.17.20",
@@ -109,7 +109,7 @@
     "sass": "^1.52.3",
     "sass-loader": "^10.1.1",
     "server-destroy": "^1.0.1",
-    "sluggo": "^0.3.0",
+    "sluggo": "^1.0.0",
     "tinycolor2": "^1.4.2",
     "tough-cookie": "^4.0.0",
     "underscore.string": "^3.3.4",

package/test/queryBuilders.js

@@ -0,0 +1,225 @@
+const t = require('../test-lib/test.js');
+const assert = require('assert');
+
+describe('Query Builders', function() {
+  this.timeout(t.timeout);
+
+  let apos;
+  after(function() {
+    return t.destroy(apos);
+  });
+
+  before(async function () {
+    apos = await t.create({
+      root: module,
+      modules: {
+        young: {
+          options: {
+            alias: 'young'
+          },
+          extend: '@apostrophecms/piece-type',
+          fields: {
+            add: {
+              age: {
+                label: 'Age',
+                type: 'integer',
+                required: true
+              }
+            }
+          },
+          queries(self, query) {
+            return {
+              builders: {
+                age: {
+                  launder(str) {
+                    return [ 'children', 'adult' ].includes(str) ? str : null;
+                  },
+                  finalize() {
+                    const age = query.get('age');
+
+                    if ([ 'children', 'adults' ].includes(age)) {
+                      const ageCriteria = age === 'children' ? { $lte: 18 } : { $gt: 18 };
+                      query.and({ age: ageCriteria });
+                    }
+                  }
+                }
+              },
+              methods: {
+                async sortByAge() {
+                  await query.finalize();
+
+                  const pipeline = [
+                    { $match: query.get('criteria') },
+                    { $sort: { age: 1 } }
+                  ];
+
+                  const results = await self.apos.doc.db.aggregate(pipeline).toArray();
+
+                  return results;
+                }
+              }
+            };
+          }
+        },
+        person: {
+          extend: 'young',
+          options: {
+            alias: 'person'
+          },
+          extendQueries(self, query) {
+            return {
+              builders: {
+                age: {
+                  def: 'adult',
+                  launder(_super, val) {
+                    const laundered = _super();
+
+                    if (laundered !== null) {
+                      return laundered;
+                    }
+
+                    return val === 'senior' ? val : null;
+                  },
+                  async finalize(_super) {
+                    await _super();
+
+                    const age = query.get('age');
+
+                    if (age === 'seniors') {
+                      query.and({ age: { $gt: 60 } });
+                    }
+                  }
+                }
+              },
+              methods: {
+                async sortByAge(_super) {
+                  assert(typeof _super === 'function');
+
+                  await query.finalize();
+
+                  const pipeline = [
+                    { $match: query.get('criteria') },
+                    { $sort: { age: -1 } }
+                  ];
+
+                  const results = await self.apos.doc.db.aggregate(pipeline).toArray();
+
+                  return results;
+                }
+              }
+            };
+          }
+        }
+      }
+    });
+  });
+
+  it('should insert person pieces and verify age query builder is working', async function() {
+    const req = apos.task.getReq();
+    const persons = getPersons(apos.young);
+    const { insertedCount } = await apos.doc.db.insertMany(persons);
+
+    assert(insertedCount === 6);
+
+    const children = await apos.young.find(req).age('children').toArray();
+    const adults = await apos.young.find(req).age('adults').toArray();
+
+    assert(children.length === 2);
+    children.forEach((child) => {
+      assert(child.age <= 18);
+    });
+
+    assert(adults.length === 4);
+    adults.forEach((adult) => {
+      assert(adult.age > 18);
+    });
+  });
+
+  it('should insert seniors and verify the query builders have been properly extended', async function() {
+    const req = apos.task.getReq();
+    const persons = getPersons(apos.person, true);
+    const { insertedCount } = await apos.doc.db.insertMany(persons);
+
+    assert(insertedCount === 8);
+
+    const children = await apos.person.find(req).age('children').toArray();
+    const adults = await apos.person.find(req).age('adults').toArray();
+    const seniors = await apos.person.find(req).age('seniors').toArray();
+
+    assert(children.length === 2);
+    children.forEach((child) => {
+      assert(child.age <= 18);
+    });
+
+    assert(adults.length === 6);
+    adults.forEach((adult) => {
+      assert(adult.age > 18);
+    });
+
+    assert(seniors.length === 2);
+    seniors.forEach((senior) => {
+      assert(senior.age > 60);
+    });
+  });
+
+  it('should verify that query methods work and can be extende', async function() {
+    const req = apos.task.getReq();
+    const youngSorted = await apos.young.find(req).age('adults').sortByAge();
+    assert(youngSorted[0].age === 25);
+    assert(youngSorted[1].age === 32);
+    assert(youngSorted[2].age === 50);
+    assert(youngSorted[3].age === 58);
+
+    const personsSorted = await apos.person.find(req).age('adults').sortByAge();
+    assert(personsSorted[0].age === 80);
+    assert(personsSorted[1].age === 72);
+    assert(personsSorted[2].age === 58);
+    assert(personsSorted[3].age === 50);
+    assert(personsSorted[4].age === 32);
+  });
+});
+
+function getPersons(instance, withSeniors = false) {
+  const moduleName = instance.__meta.name;
+  return [
+    {
+      title: 'Jean',
+      age: 32
+    },
+    {
+      title: 'Julie',
+      age: 25
+    },
+    {
+      title: 'Victor',
+      age: 14
+    },
+    {
+      title: 'Marc',
+      age: 58
+    },
+    {
+      title: 'Hector',
+      age: 7
+    },
+    {
+      title: 'Marie',
+      age: 50
+    },
+    ...withSeniors ? [
+      {
+        title: 'Jules',
+        age: 72
+      },
+      {
+        title: 'Renée',
+        age: 80
+      }
+    ] : []
+  ].map((p, i) => ({
+    _id: `${moduleName}${i}`,
+    ...instance.newInstance(),
+    slug: `${moduleName}-${p.title.toLowerCase()}`,
+    ...p
+  }));
+}