Merge pull request #6 from mtrezza/add-user-locale-to-placeholder-callback

- Add user locale to placeholder callback

Author: mtrezza

CHANGELOG.md

@@ -3,10 +3,13 @@
 # main
 [Full Changelog](https://github.com/mtrezza/parse-server-api-mail-adapter/compare/1.0.1...master)
 
+### 🧬 Improvements
+- Added locale to placeholder callback. [#6](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/6). Thanks to [mtrezza](https://github.com/mtrezza).
+
 # 1.0.1
 [Full Changelog](https://github.com/mtrezza/parse-server-api-mail-adapter/compare/1.0.0...1.0.1)
 ### 🐛 Fixes
-- Removed unused config parameter from docs. [#1](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/1). Thanks to [mtrezza](https://github.com/mtrezza)
+- Removed unused config parameter from docs. [#1](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/1). Thanks to [mtrezza](https://github.com/mtrezza).
 
 ### 🧬 Improvements
 - ⚠️ Added locale to API callback. This is a breaking change because the `apiCallback` now returns an object `{payload, locale}` instead of only the `payload`. [#2](https://github.com/mtrezza/parse-server-api-mail-adapter/pull/2). Thanks to [mtrezza](https://github.com/mtrezza)

README.md

@@ -98,10 +98,11 @@ const server = new ParseServer({
                     },
                     // A callback that makes the Parse User accessible and allows
                     // to return user-customized placeholders that will override
-                    // the default template placeholders.
-                    placeholderCallback: async (user) => {
+                    // the default template placeholders. It also makes the user
+                    // locale accessible, if it was returned by the `localeCallback`.
+                    placeholderCallback: async ({ user, locale }) => {
                         return {
-                            phone: user.get('phone')
+                            phone: user.get('phone');
                         };
                     },
                     // A callback that makes the Parse User accessible and allows

spec/ApiMailAdapter.spec.js

@@ -38,9 +38,12 @@ const config = {
             subjectPath: path.join(__dirname, 'templates/custom_email_subject.txt'),
             textPath: path.join(__dirname, 'templates/custom_email.txt'),
             htmlPath: path.join(__dirname, 'templates/custom_email.html'),
+            placeholders: {
+                appName: "TemplatePlaceholder"
+            },
             placeholderCallback: () => new Promise((resolve) => {
                 resolve({
-                    appName: 'ExampleApp'
+                    appName: 'CallbackPlaceholder'
                 });
             })
         },
@@ -49,7 +52,21 @@ const config = {
             textPath: path.join(__dirname, 'templates/custom_email.txt'),
             htmlPath: path.join(__dirname, 'templates/custom_email.html'),
             localeCallback: async () => { return 'de-AT'; }
-        }
+        },
+        customEmailWithPlaceholderCallbackAndLocaleCallback: {
+            subjectPath: path.join(__dirname, 'templates/custom_email_subject.txt'),
+            textPath: path.join(__dirname, 'templates/custom_email.txt'),
+            htmlPath: path.join(__dirname, 'templates/custom_email.html'),
+            placeholders: {
+                appName: "TemplatePlaceholder"
+            },
+            placeholderCallback: () => new Promise((resolve) => {
+                resolve({
+                    appName: 'CallbackPlaceholder'
+                });
+            }),
+            localeCallback: async () => { return 'de-AT'; }
+        },
     }
 };
 const examplePayload = {
@@ -400,7 +417,7 @@ describe('ApiMailAdapter', () => {
         });
     });
 
-    describe('validate placeholders', function () {
+    describe('placeholders', function () {
 
         it('returns valid placeholders', async () => {
             const adapter = new ApiMailAdapter(config);
@@ -413,6 +430,56 @@ describe('ApiMailAdapter', () => {
             const placeholders = 'invalid';
             expect(adapter._validatePlaceholders(placeholders)).toEqual({});
         });
+
+        it('fills in the template placeholder without placeholder callback', async () => {
+            const adapter = new ApiMailAdapter(config);
+            const apiCallback = spyOn(adapter, 'apiCallback').and.callThrough();
+            const email = {
+                templateName: 'customEmailWithPlaceholderCallback',
+                recipient: '[email protected]',
+                direct: true
+            }
+            const template = config.templates[email.templateName];
+            const templatePlaceholder = template.placeholders.appName;
+            const callbackPlaceholder = (await config.templates[email.templateName].placeholderCallback()).appName;
+            spyOn(template, 'placeholderCallback').and.callFake(() => {});
+            
+            await adapter._sendMail(email);
+            expect(apiCallback.calls.all()[0].args[0].payload.text).toContain(templatePlaceholder);
+            expect(apiCallback.calls.all()[0].args[0].payload.text).not.toContain(callbackPlaceholder);
+        });
+
+        it('overrides the template placeholder with the callback placeholder', async () => {
+            const adapter = new ApiMailAdapter(config);
+            const apiCallback = spyOn(adapter, 'apiCallback').and.callThrough();
+            const email = {
+                templateName: 'customEmailWithPlaceholderCallback',
+                recipient: '[email protected]',
+                direct: true
+            }
+            const template = config.templates[email.templateName];
+            const templatePlaceholder = template.placeholders.appName;
+            const callbackPlaceholder = (await template.placeholderCallback()).appName;
+
+            await adapter._sendMail(email);
+            expect(apiCallback.calls.all()[0].args[0].payload.text).toContain(callbackPlaceholder);
+            expect(apiCallback.calls.all()[0].args[0].payload.text).not.toContain(templatePlaceholder);
+        });
+
+        it('makes user locale accessible in placeholder callback', async () => {
+            const adapter = new ApiMailAdapter(config);
+            const apiCallback = spyOn(adapter, 'apiCallback').and.callThrough();
+            const email = {
+                templateName: 'customEmailWithPlaceholderCallbackAndLocaleCallback',
+                recipient: '[email protected]',
+                direct: true
+            }
+            const template = config.templates[email.templateName];
+            const locale = await template.localeCallback();
+            
+            await adapter._sendMail(email);
+            expect(apiCallback.calls.all()[0].args[0].locale).toBe(locale);
+        });
     });
 
     describe('localization', () => {

src/ApiMailAdapter.js

@@ -218,15 +218,6 @@ class ApiMailAdapter extends MailAdapter {
     const { placeholderCallback, localeCallback } = template;
     let locale;
 
-    // If placeholder callback is set
-    if (placeholderCallback) {
-
-      // Add placeholders from callback
-      let callbackPlaceholders = await placeholderCallback(user);
-      callbackPlaceholders = this._validatePlaceholders(callbackPlaceholders);
-      Object.assign(placeholders, callbackPlaceholders);
-    }
-
     // If locale callback is set
     if (localeCallback) {
 
@@ -235,6 +226,15 @@ class ApiMailAdapter extends MailAdapter {
       locale = this._validateUserLocale(locale);
     }
 
+    // If placeholder callback is set
+    if (placeholderCallback) {
+
+      // Add placeholders from callback
+      let callbackPlaceholders = await placeholderCallback({ user, locale });
+      callbackPlaceholders = this._validatePlaceholders(callbackPlaceholders);
+      Object.assign(placeholders, callbackPlaceholders);
+    }
+
     // Get subject content
     const subject = message.subject || await this._loadFile(template.subjectPath, locale);