apostrophe 3.37.0 → 3.38.1

package/CHANGELOG.md

@@ -1,5 +1,41 @@
 # Changelog
 
+## 3.38.1 (2023-01-23)
+
+### Fixes
+
+* Version 3.38.0 introduced a regression that temporarily broke support for user-edited content in locales with names like `de-de` (note the lowercase country name). This was inadvertently introduced in an effort to improve support for locale fallback when generating static translations of the admin interface. Version 3.38.1 brings back the content that temporarily appeared to be missing for these locales (it was never removed from the database), and also achieves the original goal. **However, if you created content for such locales using `3.38.0` (released five days ago) and wish to keep that content,** rather than reverting to the content from before `3.38.0`, see below.
+
+### Adds
+
+* The new `i18n:rename-locale` task can be used to move all content from one locale name to another, using the `--old` and `--new` options. By default, any duplicate keys for content existing in both locales will stop the process. However you can specify which content to keep in the event of a duplicate key error using the `--keep=localename` option. Note that the value of `--new` should match the a locale name that is currently configured for the `@apostrophecms/i18n` module.
+
+Example:
+
+```
+# If you always had de-de configured as a locale, but created
+# a lot of content with Apostrophe 3.38.0 which incorrectly stored
+# it under de-DE, you can copy that content. In this case we opt
+# to keep de-de content in the event of any conflicts
+node app @apostrophecms/i18n:rename-locale --old=de-DE --new=de-de --keep=de-de
+```
+
+## 3.38.0 (2023-01-18)
+
+### Adds
+
+* Emit a `beforeSave` event from the `@apostrophecms:notification` module, with `req` and the `notification` as arguments, in order to give the possibility to override the notification.
+* Emit a `beforeInsert` event from the `@apostrophecms:attachment` module, with `req` and the `doc` as arguments, in order to give the possibility to override the attachment.
+* Emit a `beforeSaveSafe` event from the `@apostrophecms:user` module, with `req`, `safeUser` and `user` as arguments, in order to give the possibility to override properties of the `safeUser` object which contains password hashes and other information too sensitive to be stored in the aposDocs collection.
+* Automatically convert failed uppercase URLs to their lowercase version - can be disabled with `redirectFailedUpperCaseUrls: false` in `@apostrophecms/page/index.js` options. This only comes into play if a 404 is about to happen.
+* Automatically convert country codes in locales like `xx-yy` to `xx-YY` before passing them to `i18next`, which is strict about uppercase country codes.
+
+### Fixes
+
+* Documents kept as the `previous` version for undo purposes were not properly marked as such, breaking the public language switcher in some cases. This was fixed and a migration was added for existing data.
+* Uploading an image in an apostrophe area with `minSize` requirements will not trigger an unexpected error anymore. If the image is too small, a notification will be displayed with the minimum size requirements. The `Edit Image` modal will now display the minimum size requirements, if any, above the `Browse Images` field.
+* Some browsers saw the empty `POST` response for new notifications as invalid XML. It will now return an empty JSON object with the `Content-Type` set to `application/json`.
+
 ## 3.37.0 (2023-01-06)
 
 ### Adds
@@ -15,14 +51,14 @@
     e.g. `A permission.can() call was made with a type that has no manager: @apostrophecms/polymorphic-type`.
 * The module `webpack.extensions` configuration is not applied to the core Admin UI build anymore. This is the correct and intended behavior as explained in the [relevant documentation](https://v3.docs.apostrophecms.org/guide/webpack.html#extending-webpack-configuration).
 * The `previewImage` option now works properly for widget modules loaded from npm and those that subclass them. Specifically, the preview image may be provided in the `public/` subdirectory of the original module, the project-level configuration of it, or a subclass.
- 
+
 ## 3.36.0 (2022-12-22)
 
 ### Adds
 
-* `shortcut` option for piece modules, allowing easy re-mapping of the manager command shortcut per module. 
+* `shortcut` option for piece modules, allowing easy re-mapping of the manager command shortcut per module.
 
-### Fixes 
+### Fixes
 
 * Ensure there are no conflicting command shortcuts for the core modules.
 

package/modules/@apostrophecms/attachment/index.js

@@ -443,6 +443,9 @@ module.exports = {
           await Promise.promisify(self.uploadfs.copyIn)(file.path, '/attachments/' + info._id + '-' + info.name + '.' + info.extension);
         }
         info.createdAt = new Date();
+
+        await self.emit('beforeInsert', req, info);
+
         await self.db.insertOne(info);
         return info;
       },

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

@@ -37,6 +37,7 @@ module.exports = {
     await self.createIndexes();
     self.addLegacyMigrations();
     self.addCacheFieldMigration();
+    self.addSetPreviousDocsAposModeMigration();
   },
   restApiRoutes(self) {
     return {
@@ -1288,6 +1289,20 @@ module.exports = {
       addCacheFieldMigration() {
         self.apos.migration.add('add-cache-invalidated-at-field', self.setCacheField);
       },
+
+      async addSetPreviousDocsAposModeMigration () {
+        self.apos.migration.add('set-previous-docs-apos-mode', async () => {
+          await self.apos.doc.db.updateMany({
+            _id: { $regex: ':previous$' },
+            aposMode: { $ne: 'previous' }
+          }, {
+            $set: {
+              aposMode: 'previous'
+            }
+          });
+        });
+      },
+
       ...require('./lib/legacy-migrations')(self)
     };
   }

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

@@ -847,6 +847,7 @@ module.exports = {
           if (previousPublished) {
             previousPublished._id = previousPublished._id.replace(':published', ':previous');
             previousPublished.aposLocale = previousPublished.aposLocale.replace(':published', ':previous');
+            previousPublished.aposMode = 'previous';
             Object.assign(previousPublished, await self.getDeduplicationSet(req, previousPublished));
             await self.apos.doc.db.replaceOne({
               _id: previousPublished._id

package/modules/@apostrophecms/i18n/index.js

@@ -561,6 +561,16 @@ module.exports = {
         for (const [ name, options ] of Object.entries(self.namespaces)) {
           if (options.browser) {
             i18n[name] = self.i18next.getResourceBundle(locale, name);
+            if (!i18n[name]) {
+              // Attempt fallback to language only. This is not
+              // the full fallback support of i18next because that
+              // is difficult to tap into when calling getResourceBundle,
+              // but it should work for most situations
+              const [ lang, country ] = locale.split('-');
+              if (country) {
+                i18n[name] = self.i18next.getResourceBundle(lang, name);
+              }
+            }
           }
         }
         return i18n;
@@ -644,6 +654,83 @@ module.exports = {
           );
       }
     };
+  },
+  tasks(self) {
+    return {
+      'rename-locale': {
+        usage: 'Usage: node app @apostrophecms/i18n:rename-locale --old=de-DE --new=de-de --keep=de-de',
+        async task(argv) {
+          const oldLocale = self.apos.launder.string(argv.old);
+          const newLocale = self.apos.launder.string(argv.new);
+          const keep = self.apos.launder.string(argv.keep);
+          let renamed = 0;
+          let kept = 0;
+          if (!oldLocale) {
+            throw new Error('You must specify --old');
+          }
+          if (!newLocale) {
+            throw new Error('You must specify --new');
+          }
+          if (oldLocale === newLocale) {
+            throw new Error('The old and new locales must be different');
+          }
+          if (keep && (!(keep === oldLocale) && !(keep === newLocale))) {
+            throw new Error('--keep must match --old or --new');
+          }
+          await self.apos.migration.eachDoc({ aposLocale: new RegExp(`^${self.apos.util.regExpQuote(oldLocale)}:`) }, async doc => {
+            const newDoc = {
+              ...doc,
+              aposLocale: doc.aposLocale.replace(oldLocale, newLocale),
+              _id: doc._id.replace(`:${oldLocale}`, `:${newLocale}`)
+            };
+            try {
+              // Remove old first to cut down on duplicate key conflicts due to
+              // custom properties
+              await self.apos.doc.db.removeOne({ _id: doc._id });
+              await self.apos.doc.db.insertOne(newDoc);
+              renamed++;
+            } catch (e) {
+              // First reinsert old doc to prevent content loss on new doc insert failure
+              await self.apos.doc.db.insertOne(doc);
+              if (!self.apos.doc.isUniqueError(e)) {
+                throw e;
+              }
+              const existing = await self.apos.doc.db.findOne({ _id: newDoc._id });
+              if (!existing) {
+                // We don't know the cause of this error
+                throw e;
+              }
+              if (keep === newLocale) {
+                // New content already exists in new locale, delete old locale
+                // and keep new
+                await self.apos.doc.db.removeOne({ _id: doc._id });
+                kept++;
+              } else if (keep === oldLocale) {
+                // We want to keep the old locale's content. Once again we
+                // need to remove the old doc first to cut down on conflicts
+                try {
+                  await self.apos.doc.db.removeOne({ _id: doc._id });
+                  await self.apos.doc.db.deleteOne({ _id: newDoc._id });
+                  await self.apos.doc.db.insertOne(newDoc);
+                } catch (e) {
+                  // Reinsert old doc to prevent content loss on new doc insert failure
+                  await self.apos.doc.db.insertOne(doc);
+                  throw e;
+                }
+                kept++;
+              } else {
+                console.error('A conflict occurred. Use --keep to specify a locale to keep and retry');
+                throw e;
+              }
+            }
+          });
+          console.log(`Renamed ${renamed} documents from ${oldLocale} to ${newLocale}`);
+          if (keep) {
+            console.log(`Due to conflicts, kept ${kept} documents from ${keep}`);
+          }
+        }
+      }
+    };
   }
 };
 

package/modules/@apostrophecms/image/ui/apos/components/AposMediaManager.vue

@@ -318,6 +318,21 @@ export default {
       this.uploading = false;
       await this.getMedia();
 
+      if (Array.isArray(imgIds) && imgIds.length && this.items.length === 0) {
+        const [ widgetOptions = {} ] = apos.area.widgetOptions;
+        const [ width, height ] = widgetOptions.minSize || [];
+        await apos.notify('apostrophe:minSize', {
+          type: 'danger',
+          icon: 'alert-circle-icon',
+          dismiss: true,
+          interpolate: {
+            width,
+            height
+          }
+        });
+        this.updateEditing(null);
+        return;
+      }
       if (Array.isArray(imgIds) && imgIds.length) {
         this.checked = this.checked.concat(imgIds);
 

package/modules/@apostrophecms/modal/ui/apos/mixins/AposDocsManagerMixin.js

@@ -219,7 +219,8 @@ export default {
       // database.
       this.checked.forEach(id => {
         if (this.checkedDocs.findIndex(doc => doc._id === id) === -1) {
-          this.checkedDocs.push(this.items.find(item => item._id === id));
+          const found = this.items.find(item => item._id === id);
+          found && this.checkedDocs.push(found);
         }
       });
 

package/modules/@apostrophecms/notification/index.js

@@ -92,6 +92,7 @@ module.exports = {
     async post(req) {
       const type = self.apos.launder.select(req.body.type, [
         'danger',
+        'error',
         'warning',
         'success',
         'info'
@@ -143,9 +144,14 @@ module.exports = {
     put(req, _id) {
       throw self.apos.error('unimplemented');
     },
-    patch(req, _id) {
+    async patch(req, _id) {
       const dismissed = self.apos.launder.boolean(req.body.dismissed);
       if (dismissed) {
+        await self.emit('beforeSave', req, {
+          _id,
+          dismissed
+        });
+
         return self.db.updateOne({ _id }, {
           $set: {
             dismissed
@@ -283,6 +289,8 @@ module.exports = {
 
         Object.assign(notification, copiedOptions);
 
+        await self.emit('beforeSave', req, notification);
+
         // We await here rather than returning because we expressly do not
         // want to leak mongodb metadata to the browser
         await self.db.updateOne(
@@ -302,6 +310,8 @@ module.exports = {
             noteId: notification._id
           };
         }
+
+        return {};
       },
 
       // The dismiss method accepts the following arguments:
@@ -317,6 +327,11 @@ module.exports = {
         await pause(delay);
 
         try {
+          await self.emit('beforeSave', req, {
+            _id: noteId,
+            dismissed: true
+          });
+
           await self.db.updateOne(
             {
               _id: noteId

package/modules/@apostrophecms/page/index.js

@@ -33,7 +33,8 @@ module.exports = {
         orphan: true,
         title: 'Archive'
       }
-    ]
+    ],
+    redirectFailedUpperCaseUrls: true
   },
   batchOperations: {
     add: {
@@ -1565,6 +1566,7 @@ database.`);
         if (self.isFound(req)) {
           return;
         }
+
         if (req.user && (req.mode === 'published')) {
           // Try again in draft mode
           try {
@@ -1613,6 +1615,12 @@ database.`);
             // Nonfatal, we were just probing
           }
         }
+
+        // If uppercase letters in URL, try with lowercase
+        if (self.options.redirectFailedUpperCaseUrls && /[A-Z]/.test(req.path)) {
+          req.redirect = self.apos.url.build(req.path.toLowerCase(), req.query);
+        }
+
         // Give all modules a chance to save the day
         await self.emit('notFound', req);
         // Are we happy now?

package/modules/@apostrophecms/schema/ui/apos/components/AposInputRelationship.vue

@@ -6,6 +6,17 @@
     :modifiers="modifiers"
   >
     <template #additional>
+      <div
+        v-if="minSize[0] || minSize[1]"
+        class="apos-field__min-size"
+      >
+        {{
+          $t('apostrophe:minSize', {
+            width: minSize[0] || '???',
+            height: minSize[1] || '???'
+          })
+        }}
+      </div>
       <AposMinMaxCount
         :field="field"
         :value="next"
@@ -122,6 +133,11 @@ export default {
         modifiers.push('block');
       }
       return modifiers;
+    },
+    minSize() {
+      const [ widgetOptions = {} ] = apos.area.widgetOptions;
+
+      return widgetOptions.minSize || [];
     }
   },
   watch: {
@@ -287,4 +303,12 @@ export default {
       padding: 0;
     }
   }
+
+  .apos-field__min-size {
+    @include type-help;
+    display: flex;
+    flex-grow: 1;
+    margin-bottom: $spacing-base;
+    font-weight: var(--a-weight-bold);
+  }
 </style>

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

@@ -17,7 +17,7 @@ export default {
     }
 
     i18next.init({
-      lng: i18n.locale,
+      lng: canonicalize(i18n.locale),
       fallbackLng,
       resources: {},
       debug: i18n.debug,
@@ -45,11 +45,11 @@ export default {
     });
 
     for (const [ ns, phrases ] of Object.entries(i18n.i18n[i18n.locale])) {
-      i18next.addResourceBundle(i18n.locale, ns, phrases, true, true);
+      i18next.addResourceBundle(canonicalize(i18n.locale), ns, phrases, true, true);
     }
     if (i18n.locale !== i18n.defaultLocale) {
       for (const [ ns, phrases ] of Object.entries(i18n.i18n[i18n.defaultLocale])) {
-        i18next.addResourceBundle(i18n.defaultLocale, ns, phrases, true, true);
+        i18next.addResourceBundle(canonicalize(i18n.defaultLocale), ns, phrases, true, true);
       }
     }
     if ((i18n.locale !== 'en') && (i18n.defaultLocale !== 'en')) {
@@ -107,5 +107,15 @@ export default {
         return result;
       }
     };
+
+    function canonicalize(locale) {
+      const [ language, territory ] = locale.split('-');
+      if (territory) {
+        return `${language}-${territory.toUpperCase()}`;
+      }
+      return locale;
+    }
+
   }
+
 };

package/modules/@apostrophecms/user/index.js

@@ -292,6 +292,9 @@ module.exports = {
 
         await self.hashPassword(doc, safeUser);
         await self.hashSecrets(doc, safeUser);
+
+        await self.emit('beforeSaveSafe', req, safeUser, doc);
+
         if (action === 'insert') {
           await self.safe.insertOne(safeUser);
         } else {

package/package.json

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

package/test/draft-published.js

@@ -209,11 +209,12 @@ describe('Draft / Published', function() {
     }), testDraftProduct);
   });
 
-  it('"previous published" should be deduplicated at this point', async function() {
+  it('"previous published" should be deduplicated at this point, and previous have the right props', async function() {
     const previous = await apos.doc.db.findOne({
       _id: testDraftProduct._id.replace(':draft', ':previous')
     });
     assert(previous);
+    assert(previous.aposMode === 'previous');
     assert.strictEqual(previous.slug, `deduplicate-${previous.aposDocId}-test-product`);
   });
 
@@ -539,6 +540,7 @@ describe('Draft / Published', function() {
     }), {
       aposDocId: sibling.aposDocId
     }).children(true).toObject();
+
     assert(siblingPublished && siblingPublished._children && siblingPublished._children[0] && siblingPublished._children[0]._id === grandchild._id.replace(':draft', ':published'));
   });
 
@@ -556,17 +558,20 @@ describe('Draft / Published', function() {
       const draftItem = {
         ...baseItem,
         _id: 'some-page:en:draft',
-        aposLocale: 'en:draft'
+        aposLocale: 'en:draft',
+        aposMode: 'draft'
       };
       const publishedItem = {
         ...baseItem,
         _id: 'some-page:en:published',
-        aposLocale: 'en:published'
+        aposLocale: 'en:published',
+        aposMode: 'published'
       };
       const previousItem = {
         ...baseItem,
         _id: 'some-page:en:previous',
-        aposLocale: 'en:previous'
+        aposLocale: 'en:previous',
+        aposMode: 'previous'
       };
 
       let draft;

package/test/modules/test-page/views/page.html

@@ -10,4 +10,6 @@
   {% for tab in data.home._children %}
     <a href="{{ tab._url }}">Tab: {{ tab.slug }}</a>
   {% endfor %}
+
+  URL: {{ data.page._url }}
 {% endblock %}

package/test/pages.js

@@ -215,6 +215,24 @@ describe('Pages', function() {
     assert(page.path === `${homeId.replace(':en:published', '')}/parent/child`);
   });
 
+  it('should convert an uppercase URL to its lowercase version', async function() {
+    const response = await apos.http.get('/PArent/cHild', {
+      fullResponse: true
+    });
+    assert(response.body.match(/URL: \/parent\/child/));
+  });
+
+  it('should NOT convert an uppercase URL if redirectFailedUpperCaseUrls is false', async function() {
+    apos.page.options.redirectFailedUpperCaseUrls = false;
+    try {
+      await apos.http.get('/PArent/cHild', {
+        fullResponse: true
+      });
+    } catch (error) {
+      assert(error.status === 404);
+    }
+  });
+
   it('should be able to include the ancestors of a page', async function() {
     const cursor = apos.page.find(apos.task.getAnonReq(), { slug: '/parent/child' });
 
@@ -1151,8 +1169,6 @@ describe('Pages', function() {
 
       it('should grant public access to a draft after having enabled draft sharing', async function() {
         const publicUrl = generatePublicUrl(shareResponse);
-        console.log('publicUrl', publicUrl);
-
         const response = await apos.http.get(shareResponse._url, { fullResponse: true });
         const publicResponse = await apos.http.get(publicUrl, { fullResponse: true });