apostrophe 3.6.0 → 3.9.0

package/modules/@apostrophecms/ui/ui/apos/lib/i18next.js

@@ -10,11 +10,20 @@ export default {
   install(Vue, options) {
     const i18n = options.i18n;
 
+    const fallbackLng = [ i18n.defaultLocale ];
+    // In case the default locale also has inadequate admin UI phrases
+    if (fallbackLng[0] !== 'en') {
+      fallbackLng.push('en');
+    }
+
     i18next.init({
       lng: i18n.locale,
-      fallbackLng: i18n.defaultLocale,
+      fallbackLng,
       resources: {},
-      debug: i18n.debug
+      debug: i18n.debug,
+      interpolation: {
+        escapeValue: false
+      }
     });
 
     for (const [ ns, phrases ] of Object.entries(i18n.i18n[i18n.locale])) {
@@ -25,6 +34,11 @@ export default {
         i18next.addResourceBundle(i18n.defaultLocale, ns, phrases, true, true);
       }
     }
+    if ((i18n.locale !== 'en') && (i18n.defaultLocale !== 'en')) {
+      for (const [ ns, phrases ] of Object.entries(i18n.i18n.en)) {
+        i18next.addResourceBundle('en', ns, phrases, true, true);
+      }
+    }
 
     // Like standard i18next $t, but also with support
     // for just one object argument with at least a `key`

package/modules/@apostrophecms/ui/ui/apos/mixins/AposPublishMixin.js

@@ -49,9 +49,10 @@ export default {
         if ((e.name === 'invalid') && e.body && e.body.data && e.body.data.unpublishedAncestors) {
           if (await apos.confirm({
             heading: 'apostrophe:unpublishedParent',
-            description: 'apostrophe:unpublishedParentDescription',
+            description: 'apostrophe:unpublishedParentDescription'
+          }, {
             interpolate: {
-              unpublishedParents: this.$t(e.body.data.unpublishedAncestors.map(page => page.title).join(this.$t('apostrophe:listJoiner')))
+              unpublishedParents: e.body.data.unpublishedAncestors.map(page => page.title).join(this.$t('apostrophe:listJoiner'))
             }
           })) {
             try {

package/modules/@apostrophecms/ui/ui/apos/scss/global/_tables.scss

@@ -5,7 +5,7 @@
 
 .apos-table__header {
   margin-bottom: $spacing-base;
-  padding: 12.5px 4.5px;
+  padding: 12.5px 15px;
   border-bottom: 1px solid var(--a-base-8);
   color: var(--a-base-3);
   text-align: left;
@@ -52,12 +52,13 @@ span.apos-table__header-label:hover {
   @include apos-transition(all, 0.05s);
 }
 .apos-table__cell {
-  padding: 5px;
+  padding: 5px 15px;
   border-bottom: 1px solid var(--a-base-10);
 }
 
 .apos-table__cell--context-menu  {
-  width: 40px;
+  padding-right: 0;
+  padding-left: 0;
 }
 
 .apos-table__cell-field--context-menu  {

package/modules/@apostrophecms/util/ui/src/util.js

@@ -257,6 +257,21 @@ export default () => {
     return path + '.' + file.extension;
   };
 
+  // Given an asset path such as `/modules/modulename/images/file.png`, this
+  // method will return a URL for it. This is used when frontend JavaScript
+  // code needs to access static assets shipped in the `public` subdirectory of
+  // individual modules. Currently `path` must begin with `/modules/` followed
+  // by a module name; other namespaces may exist later. The remainder of the
+  // path, such as `/images/file.png` in the above example, must currespond
+  // to a file that exists in the `public` subdirectory of the named module.
+  //
+  // Asset paths of this type are also automatically supported by CSS and
+  // SCSS files in the project when using `url()`.
+
+  apos.util.assetUrl = function(path) {
+    return apos.assetBaseUrl + path;
+  };
+
   // Returns true if the uri references the same site (same host and port) as the
   // current page. Cross-browser implementation, valid at least back to IE11.
   // Regarding port numbers, this will match as long as the URIs are consistent

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

@@ -156,7 +156,7 @@ module.exports = {
         self.schema = self.apos.schema.compose({
           addFields: self.apos.schema.fieldsToArray(`Module ${self.__meta.name}`, self.fields),
           arrangeFields: self.apos.schema.groupsToArray(self.fieldsGroups)
-        });
+        }, self);
         const forbiddenFields = [
           '_id',
           'type'

package/modules/@apostrophecms/widget-type/ui/apos/mixins/AposWidgetMixin.js

@@ -22,16 +22,11 @@ export default {
   },
   data() {
     return {
-      rendered: '...',
-      playerOpts: null
+      rendered: '...'
     };
   },
   mounted() {
     this.renderContent();
-    this.playerOpts = apos.util.widgetPlayers[this.type] || null;
-  },
-  updated () {
-    this.runPlayer();
   },
   computed: {
     moduleOptions() {
@@ -40,6 +35,7 @@ export default {
   },
   methods: {
     async renderContent() {
+      apos.bus.$emit('widget-rendering');
       const parameters = {
         _docId: this.docId,
         widget: this.value,
@@ -49,7 +45,6 @@ export default {
       try {
         if (this.rendering && (isEqual(this.rendering.parameters, parameters))) {
           this.rendered = this.rendering.html;
-          this.runPlayer();
         } else {
           this.rendered = '...';
           this.rendered = await apos.http.post(`${apos.area.action}/render-widget?aposEdit=1&aposMode=draft`, {
@@ -57,9 +52,9 @@ export default {
             body: parameters
           });
         }
-        // Wait for reactivity to populate v-html so the
-        // AposAreas manager can spot any new area divs.
-        // This will also run the player
+        // Wait for reactivity to render v-html so that markup is
+        // in the DOM before hinting that it might be time to prepare
+        // sub-area editors and run players
         setTimeout(function() {
           apos.bus.$emit('widget-rendered');
         }, 0);
@@ -68,15 +63,6 @@ export default {
         console.error('Unable to render widget. Possibly the schema has been changed and the existing widget does not pass validation.', e);
       }
     },
-    runPlayer() {
-      if (!this.playerOpts) {
-        return;
-      }
-      const el = this.$el.querySelector(this.playerOpts.selector);
-      if (el && this.playerOpts.player) {
-        this.playerOpts.player(el);
-      }
-    },
     clicked(e) {
       // If you do not want a particular click to swap to the edit view
       // for your widget, you should make sure it does not bubble

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "apostrophe",
-  "version": "3.6.0",
+  "version": "3.9.0",
   "description": "The Apostrophe Content Management System.",
   "main": "index.js",
   "scripts": {
-    "pretest": "npm run lint && npm audit",
+    "pretest": "npm run lint",
     "test": "nyc --reporter=html mocha -t 10000",
     "lint": "eslint . && node scripts/lint-i18n"
   },

package/test/job.js

@@ -0,0 +1,224 @@
+const t = require('../test-lib/test.js');
+const assert = require('assert');
+const Promise = require('bluebird');
+let apos;
+
+describe('Job module', function() {
+
+  this.timeout(t.timeout);
+
+  after(async function() {
+    return t.destroy(apos);
+  });
+
+  let jobModule;
+
+  it('should be a property of the apos object', async function() {
+    this.timeout(t.timeout);
+    this.slow(2000);
+
+    apos = await t.create({
+      root: module,
+      modules: {
+        article: {
+          extend: '@apostrophecms/piece-type'
+        }
+      }
+    });
+    jobModule = apos.modules['@apostrophecms/job'];
+    assert(apos.modules['@apostrophecms/job']);
+  });
+
+  it('has a related database collection', async function () {
+    assert(jobModule.db);
+  });
+
+  let jobOne;
+
+  it('should create a new job', async function () {
+    jobOne = await jobModule.start({});
+
+    assert(jobOne._id);
+
+    const found = await jobModule.db.findOne({ _id: jobOne._id });
+
+    assert(found);
+    assert(found.status === 'running');
+    assert(found.ended === false);
+  });
+
+  it('should end a job and mark it as successful', async function () {
+    const result = await jobModule.end(jobOne, 'success', { testing: 'testing' });
+
+    assert(result.result.nModified === 1);
+
+    const found = await jobModule.db.findOne({ _id: jobOne._id });
+
+    assert(found);
+    assert(found.status === 'completed');
+    assert(found.ended === true);
+  });
+  let jar;
+  it('should get admin jar', async () => {
+    await t.createAdmin(apos);
+
+    jar = await t.getUserJar(apos);
+
+    assert(jar);
+  });
+
+  it('should access a job via REST API GET request', async function () {
+    const job = await apos.http.get(`/api/v1/@apostrophecms/job/${jobOne._id}`, {
+      jar
+    });
+
+    assert(job._id === jobOne._id);
+  });
+
+  let articleIds;
+
+  it('can insert many test articles', async function () {
+    const req = apos.task.getReq();
+
+    const promises = [];
+
+    for (let i = 1; i <= 500; i++) {
+      promises.push(insert(req, apos.modules.article, 'article', {}, i));
+    }
+
+    const inserted = await Promise.all(promises);
+    articleIds = inserted.map(doc => doc._id);
+
+    assert(inserted.length === 500);
+    assert(!!inserted[0]._id);
+  });
+
+  let jobTwo;
+  it('can run a batch job', async function () {
+    const req = apos.task.getReq();
+
+    jobTwo = await jobModule.runBatch(
+      req,
+      articleIds,
+      async function(req, id) {
+        await apos.doc.db.updateOne({
+          _id: id
+        }, {
+          $set: {
+            checked: true
+          }
+        });
+      }
+    );
+
+    assert(!!jobTwo.jobId);
+  });
+
+  it('can follow the second job as it works', async function () {
+    const { completed } = await pollJob({
+      route: `${jobModule.action}/${jobTwo.jobId}`
+    }, {
+      jar
+    });
+
+    assert(completed === articleIds.length);
+    const index = Math.floor(Math.random() * (articleIds.length - 1));
+
+    const article = await apos.http.get(`/api/v1/article/${articleIds[index]}`, {
+      jar
+    });
+
+    assert(article.checked === true);
+  });
+
+  const logged = [];
+
+  let jobThree;
+
+  it('can run a generic job', async function () {
+    const req = apos.task.getReq();
+
+    jobThree = await jobModule.run(
+      req,
+      async function(req, reporters) {
+        let count = 1;
+        reporters.setTotal(articleIds.length);
+
+        for (const id of articleIds) {
+          await Promise.delay(3);
+          logged.push(id);
+          if (count % 2) {
+            reporters.success();
+          } else {
+            reporters.failure();
+          }
+          count++;
+        }
+      }
+    );
+
+    assert(!!jobThree.jobId);
+  });
+
+  it('can follow the third job as it works', async function () {
+    const route = `${jobModule.action}/${jobThree.jobId}`;
+    const { total } = await apos.http.get(route, { jar });
+    // Tests setTotal()
+    assert(total === articleIds.length);
+
+    const {
+      completed,
+      good,
+      bad
+    } = await pollJob({
+      route
+    }, {
+      jar
+    });
+
+    assert(completed === articleIds.length);
+    // Tests success()
+    assert(good === (articleIds.length / 2));
+    // Tests failure()
+    assert(bad === (articleIds.length / 2));
+  });
+});
+
+function padInteger (i, places) {
+  let s = i + '';
+  while (s.length < places) {
+    s = '0' + s;
+  }
+  return s;
+}
+
+async function insert (req, pieceModule, title, data, i) {
+  const docData = Object.assign(pieceModule.newInstance(), {
+    title: `${title} #${padInteger(i, 5)}`,
+    slug: `${title}-${padInteger(i, 5)}`,
+    ...data
+  });
+
+  return pieceModule.insert(req, docData);
+};
+
+async function pollJob(job, { jar }) {
+  const {
+    processed,
+    total,
+    good,
+    bad
+  } = await apos.http.get(job.route, { jar });
+
+  if (processed < total) {
+    Promise.delay(100);
+
+    return await pollJob(job, { jar });
+  } else {
+    return {
+      completed: processed,
+      good,
+      bad
+    };
+  }
+}

package/test/pieces.js

@@ -768,6 +768,23 @@ describe('Pieces', function() {
     relatedArticleId = response._articles[0]._id;
   });
 
+  it('can GET a single product using projections', async () => {
+    const response = await apos.http.get(`/api/v1/product/${relatedProductId}`, {
+      qs: {
+        project: {
+          _id: 1,
+          title: 1
+        }
+      }
+    });
+
+    const keys = Object.keys(response);
+
+    assert(response);
+    assert(keys.length === 2);
+    assert(keys.every((key) => [ '_id', 'title' ].includes(key)));
+  });
+
   it('can GET a single article with reverse relationships', async () => {
     const response = await apos.http.get(`/api/v1/article/${relatedArticleId}`);
     assert(response);
@@ -1246,4 +1263,21 @@ describe('Pieces', function() {
     assert(fs.readFileSync(path.join(__dirname, 'public', resume.attachment._url), 'utf8') === fs.readFileSync(path.join(__dirname, '/public/static-test.txt'), 'utf8'));
   });
 
+  it('should convert a piece keeping only the present fields', async () => {
+    const req = apos.task.getReq();
+
+    const inputPiece = {
+      title: 'new product name'
+    };
+
+    const existingPiece = {
+      color: 'red'
+    };
+
+    await apos.modules.product.convert(req, inputPiece, existingPiece, { presentFieldsOnly: true });
+
+    assert(Object.keys(existingPiece).length === 2);
+    assert(existingPiece.title === 'new product name');
+    assert(existingPiece.color === 'red');
+  });
 });

package/test-lib/util.js

@@ -57,8 +57,40 @@ async function create(options) {
   return require('../index.js')(config);
 }
 
+// Create an admin user. By default the username and password are both 'admin'
+async function createAdmin(apos, { username, password } = {}) {
+  const user = apos.user.newInstance();
+  const name = username || 'admin';
+
+  user.title = name;
+  user.username = name;
+  user.password = password || 'admin';
+  user.email = `${name}@admin.io`;
+  user.role = 'admin';
+
+  return await apos.user.insert(apos.task.getReq(), user);
+}
+
+async function getUserJar(apos, { username, password } = {}) {
+  const jar = apos.http.jar();
+
+  // Log in
+  await apos.http.post('/api/v1/@apostrophecms/login/login', {
+    body: {
+      username: username || 'admin',
+      password: password || 'admin',
+      session: true
+    },
+    jar
+  });
+
+  return jar;
+}
+
 module.exports = {
   destroy,
   create,
+  createAdmin,
+  getUserJar,
   timeout: (process.env.TEST_TIMEOUT && parseInt(process.env.TEST_TIMEOUT)) || 20000
 };

package/.circleci/config.yml

@@ -1,94 +0,0 @@
-version: 2
-jobs:
-  build-node14-mongo5:
-    docker:
-      - image: circleci/node:14-browsers
-      - image: mongo:5.0
-    steps:
-      - checkout
-      - run:
-          name: update-npm
-          command: 'sudo npm install -g npm@7'
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: install-npm-wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-          paths:
-            - ./node_modules
-      - run:
-          name: test
-          command: npm test
-  build-node14-mongo44:
-    docker:
-      - image: circleci/node:14-browsers
-      - image: mongo:4.4
-    steps:
-      - checkout
-      - run:
-          name: update-npm
-          command: 'sudo npm install -g npm@7'
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: install-npm-wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-          paths:
-            - ./node_modules
-      - run:
-          name: test
-          command: npm test
-  build-node14-mongo42:
-    docker:
-      - image: circleci/node:14-browsers
-      - image: mongo:4.2
-    steps:
-      - checkout
-      - run:
-          name: update-npm
-          command: 'sudo npm install -g npm@7'
-      - restore_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-      - run:
-          name: install-npm-wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ checksum "package.json" }}
-          paths:
-            - ./node_modules
-      - run:
-          name: test
-          command: npm test
-  build-node12:
-    docker:
-      - image: circleci/node:12-browsers
-      - image: mongo:3.6.11
-    steps:
-      - checkout
-      - run:
-          name: update-npm
-          command: "sudo npm install -g npm"
-      - restore_cache:
-          key: dependency-cache-{{ .Branch }}-{{ checksum "package-lock.json" }}
-      - run:
-          name: install-npm-wee
-          command: npm install
-      - save_cache:
-          key: dependency-cache-{{ .Branch }}-{{ checksum "package-lock.json" }}
-          paths:
-            - ./node_modules
-      - run:
-          name: test
-          command: npm test
-workflows:
-  version: 2
-  build:
-    jobs:
-      - build-node14-mongo5
-      - build-node14-mongo44
-      - build-node14-mongo42
-      - build-node12

package/.scratch.md

@@ -1,2 +0,0 @@
-- `/deep/ .apos-button` to `:deep(.apos-button)`
-- Remove v-popover, v-tooltip, VueClickOutsideElement