@teleporthq/teleport-plugin-next-workflows 0.45.8 → 0.45.9

package/__tests__/newsletter-plugin.test.ts

@@ -723,6 +723,171 @@ describe('the newsletter routes', () => {
     expect(ok.body).toEqual({ ok: true, email: 'wait@site.test' })
     const bad = await route(app, 'confirm', { method: 'POST', body: { token: 'x.y' } })
     expect(bad.body).toEqual({ ok: false })
+    const queriesBefore = app.db.queries.length
+    const none = await route(app, 'confirm', { method: 'POST', body: {} })
+    expect(none.statusCode).toBe(200)
+    expect(none.body).toEqual({ ok: false })
+    expect(app.db.queries).toHaveLength(queriesBefore)
+    app.db.failWith = { message: 'connection refused', code: 'ECONNREFUSED' }
+    const down = await route(app, 'confirm', { method: 'POST', body: { token } })
+    expect(down.statusCode).toBe(503)
+    expect(down.body).toEqual({
+      error: 'We could not confirm the subscription. Please try again in a moment.',
+    })
+    const put = await route(app, 'confirm', { method: 'PUT', body: { token } })
+    expect(put.statusCode).toBe(405)
+  })
+
+  it("confirm: the emailed link to the site's confirm route shows a button; only its POST confirms", async () => {
+    const app = loadApp({
+      settings: {
+        pages: { confirm: '/api/newsletter/confirm', unsubscribe: '/api/newsletter/unsubscribe' },
+      },
+    })
+    await app.helper.subscribeNewsletterPerson({
+      db: app.db,
+      email: 'click@reader.test',
+      signUpPoint: 'block',
+      req: REQ,
+    })
+    expect(app.sent[0].html).toContain('https://studio.example/api/newsletter/confirm?t=')
+    const token = linkToken(app.sent[0].html)
+    // The person's click, and a mail client's link scanner opening the same
+    // link first, subscribe nobody.
+    for (let opened = 0; opened < 2; opened++) {
+      const page = await route(app, 'confirm', { method: 'GET', query: { t: token } })
+      expect(page.statusCode).toBe(200)
+      expect(page.headers['Content-Type']).toBe('text/html; charset=utf-8')
+      expect(page.headers['Cache-Control']).toBe('no-store')
+      expect(page.body).toContain('<h1>Confirm your subscription</h1>')
+      expect(page.body).toContain(
+        '<form method="post" action="/api/newsletter/confirm"><input type="hidden" name="t" value="' +
+          token +
+          '"><button type="submit">Confirm subscription</button></form>'
+      )
+    }
+    expect(app.db.rows[0].newsletter_status).toBe('pending')
+    expect(app.db.writes().map((query) => query.sql)).toEqual([NEWSLETTER_SQL.insertPending])
+    expect(app.sent).toHaveLength(1)
+
+    const pressButton = () =>
+      route(app, 'confirm', {
+        method: 'POST',
+        headers: { host: 'studio.example', 'content-type': 'application/x-www-form-urlencoded' },
+        body: { t: token },
+      })
+    const done = await pressButton()
+    expect(done.statusCode).toBe(200)
+    expect(done.headers['Content-Type']).toBe('text/html; charset=utf-8')
+    expect(done.body).toContain('<h1>You&#39;re subscribed</h1>')
+    expect(app.db.rows[0]).toMatchObject({
+      newsletter_status: 'subscribed',
+      marketing_consent: true,
+    })
+    expect(app.events.map((event) => event.type)).toEqual(['newsletter-subscribed'])
+    expect(app.sent).toHaveLength(2)
+    expect(app.sent[1].html).toContain('https://studio.example/api/newsletter/unsubscribe?t=')
+    // The same link used again: the same answer, nothing happens twice.
+    const again = await pressButton()
+    expect(again.body).toContain('<h1>You&#39;re subscribed</h1>')
+    expect(app.events).toHaveLength(1)
+    expect(app.sent).toHaveLength(2)
+  })
+
+  it('confirm: a bad, expired or wrong link answers a plain page and confirms nothing', async () => {
+    const app = loadApp()
+    app.db.rows.push({ id: 'u-p', email: 'wait@site.test', newsletter_status: 'pending' })
+    const eightDaysAgo = Math.floor(Date.now() / 1000) - 8 * 24 * 3600
+    const notALink =
+      'This confirmation link does not work. A link works for 7 days: sign up again to get a new one.'
+    const badLinks = [
+      '',
+      'x.y',
+      '"><script>alert(1)</script>',
+      app.helper.signNewsletterToken('wait@site.test', 'confirm', eightDaysAgo),
+      app.helper.signNewsletterToken('wait@site.test', 'unsubscribe'),
+      loadApp({ env: { NEXTAUTH_SECRET: 'another-site' } }).helper.signNewsletterToken(
+        'wait@site.test',
+        'confirm'
+      ),
+    ]
+    const expectNotALinkPage = (res: Row) => {
+      expect(res.statusCode).toBe(200)
+      expect(res.headers['Content-Type']).toBe('text/html; charset=utf-8')
+      expect(res.body).toContain('<h1>Link not valid</h1>')
+      expect(res.body).toContain(notALink)
+      expect(res.body).not.toContain('<form')
+      expect(res.body).not.toContain('<script>')
+    }
+    expectNotALinkPage(await route(app, 'confirm', { method: 'GET' }))
+    for (const t of badLinks) {
+      expectNotALinkPage(await route(app, 'confirm', { method: 'GET', query: { t } }))
+      expectNotALinkPage(
+        await route(app, 'confirm', {
+          method: 'POST',
+          headers: { host: 'studio.example', 'content-type': 'application/x-www-form-urlencoded' },
+          body: { t },
+        })
+      )
+    }
+    expect(app.db.writes()).toEqual([])
+    expect(app.db.rows[0].newsletter_status).toBe('pending')
+    expect(app.sent).toEqual([])
+
+    // The database down while the button is pressed: a plain page, not the error.
+    app.db.failWith = { message: 'connection refused', code: 'ECONNREFUSED' }
+    const down = await route(app, 'confirm', {
+      method: 'POST',
+      headers: { host: 'studio.example', 'content-type': 'application/x-www-form-urlencoded' },
+      body: { t: app.helper.signNewsletterToken('wait@site.test', 'confirm') },
+    })
+    expect(down.statusCode).toBe(503)
+    expect(down.body).toContain('<h1>Please try again</h1>')
+    expect(down.body).not.toContain('connection refused')
+    expect(down.body).not.toContain('ECONNREFUSED')
+  })
+
+  it('confirm: a project that still has its own confirm page keeps linking to it, and its step confirms', async () => {
+    const app = loadApp()
+    await app.helper.subscribeNewsletterPerson({
+      db: app.db,
+      email: 'page@reader.test',
+      signUpPoint: 'footer',
+      req: REQ,
+    })
+    expect(app.sent[0].html).toContain('https://studio.example/newsletter/confirm#t=')
+    expect(app.sent[0].html).not.toContain('/api/newsletter/confirm')
+    const realFetch = (global as any).fetch
+    ;(global as any).fetch = async (
+      url: string,
+      init: { method: string; headers: Row; body: string }
+    ) => {
+      expect(url).toBe('https://studio.example/api/newsletter/confirm')
+      const res = await route(app, 'confirm', {
+        method: init.method,
+        headers: { host: 'studio.example', 'content-type': init.headers['Content-Type'] },
+        body: JSON.parse(init.body),
+      })
+      return {
+        ok: res.statusCode < 400,
+        json: async () => {
+          expect(typeof res.body).toBe('object')
+          return res.body
+        },
+      }
+    }
+    try {
+      const confirmStep = loadHandler('newsletter-confirm')
+      expect(
+        await confirmStep(
+          { token: linkToken(app.sent[0].html) },
+          { __baseUrl: 'https://studio.example' }
+        )
+      ).toEqual({ ok: true, email: 'page@reader.test' })
+    } finally {
+      ;(global as any).fetch = realFetch
+    }
+    expect(app.db.rows[0].newsletter_status).toBe('subscribed')
   })
 })
 

package/dist/cjs/newsletter/helper-code.js

@@ -444,8 +444,8 @@ function canSendNewsletterEmail() {
 
 // A link to one of the site's pages carries the token in its fragment: a
 // fragment never reaches a server, a CDN log or a Referer (the page's first
-// head script keeps it). The site's own unsubscribe route reads it on the
-// server, so a link to it carries it in the query.
+// head script keeps it). The site's own confirm and unsubscribe routes read it
+// on the server, so a link to one of them carries it in the query.
 function pageLink(path, token) {
   return path + (path.indexOf('/api/') === 0 ? '?t=' : '#t=') + encodeURIComponent(token);
 }

package/dist/cjs/newsletter/routes-code.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"routes-code.d.ts","sourceRoot":"","sources":["../../../src/newsletter/routes-code.ts"],"names":[],"mappings":"AA0BA,6DAA6D;AAC7D,eAAO,MAAM,6BAA6B,KAAK,CAAA;AAoB/C,eAAO,MAAM,gCAAgC,QAAO,MAuCnD,CAAA;AAED,eAAO,MAAM,8BAA8B,QAAO,MAqBjD,CAAA;AAED,eAAO,MAAM,kCAAkC,QAAO,MA0ErD,CAAA"}
+{"version":3,"file":"routes-code.d.ts","sourceRoot":"","sources":["../../../src/newsletter/routes-code.ts"],"names":[],"mappings":"AA4BA,6DAA6D;AAC7D,eAAO,MAAM,6BAA6B,KAAK,CAAA;AAoB/C,eAAO,MAAM,gCAAgC,QAAO,MAuCnD,CAAA;AA8BD,eAAO,MAAM,8BAA8B,QAAO,MAmDjD,CAAA;AAED,eAAO,MAAM,kCAAkC,QAAO,MAkDrD,CAAA"}

package/dist/cjs/newsletter/routes-code.js

@@ -11,12 +11,13 @@ exports.generateNewsletterUnsubscribeRoute = exports.generateNewsletterConfirmRo
  *   `footer`, `popup`, `form`), else `block`; errors are logged by code and
  *   message only (never a database row); every answer is `{ ok: true, pending }`, after at least
  *   `NEWSLETTER_MIN_RESPONSE_MS`, whatever happened to the address.
- * - `confirm` — POST `{ token }` → `{ ok, email? }`.
- * - `unsubscribe` — POST `{ token }` → `{ ok, email? }`; a GET with `?t=`
- *   (a click in a mail client) answers a small page whose button POSTs it, so a
- *   link scanner that opens every link unsubscribes nobody.
+ * - `confirm` and `unsubscribe` — POST `{ token }` → `{ ok, email? }`; a GET
+ *   with `?t=` (a click in a mail client) answers a small page whose button
+ *   POSTs it, so a link scanner that opens every link confirms and
+ *   unsubscribes nobody.
  */
 const security_runtime_code_1 = require("../security-runtime/security-runtime-code");
+const helper_code_1 = require("./helper-code");
 const newsletter_scope_1 = require("./newsletter-scope");
 /** From `pages/api/newsletter/` to the project root. */
 const RELATIVE_PREFIX = '../../..';
@@ -79,32 +80,7 @@ ${methodGuard(['POST'])}
 };
 `;
 exports.generateNewsletterSubscribeRoute = generateNewsletterSubscribeRoute;
-const generateNewsletterConfirmRoute = () => `${ROUTE_PREAMBLE}
-
-module.exports = async function handler(req, res) {
-${methodGuard(['POST'])}
-  if (!(await __security.rateLimitRequest(req, res, { scope: 'newsletter-confirm', limit: ${exports.NEWSLETTER_LINK_VISITOR_LIMIT}, windowSeconds: 3600 }))) {
-    return;
-  }
-  var body = readBody(req);
-  var token = typeof body.token === 'string' ? body.token : '';
-  if (!token) {
-    return res.status(200).json({ ok: false });
-  }
-  try {
-    var result = await __newsletter.withNewsletterDb(function (db) {
-      return __newsletter.confirmNewsletter({ db: db, token: token, req: req });
-    });
-    return res.status(200).json(result.ok ? { ok: true, email: result.email } : { ok: false });
-  } catch (err) {
-    return __security.sendClientError(res, 503, 'We could not confirm the subscription. Please try again in a moment.', __newsletter.safeError(err));
-  }
-};
-`;
-exports.generateNewsletterConfirmRoute = generateNewsletterConfirmRoute;
-const generateNewsletterUnsubscribeRoute = () => `${ROUTE_PREAMBLE}
-
-function escapeHtml(value) {
+const LINK_PAGE_CODE = `function escapeHtml(value) {
   return String(value == null ? '' : value)
     .replace(/&/g, '&')
     .replace(/</g, '&lt;')
@@ -128,7 +104,64 @@ function sendPage(res, status, title, message, form) {
     'button{font:inherit;padding:10px 18px;border:0;border-radius:6px;background:#111;color:#fff;cursor:pointer}</style>' +
     '</head><body><h1>' + escapeHtml(title) + '</h1><p>' + escapeHtml(message) + '</p>' + (form || '') + '</body></html>'
   );
-}
+}`;
+const CONFIRM_LINK_DAYS = helper_code_1.newsletterTokenSpec.confirmMaxAgeSeconds / 86400;
+const generateNewsletterConfirmRoute = () => `${ROUTE_PREAMBLE}
+
+${LINK_PAGE_CODE}
+
+var NOT_A_LINK = 'This confirmation link does not work. A link works for ${CONFIRM_LINK_DAYS} days: sign up again to get a new one.';
+
+module.exports = async function handler(req, res) {
+${methodGuard(['GET', 'POST'])}
+  if (!(await __security.rateLimitRequest(req, res, { scope: 'newsletter-confirm', limit: ${exports.NEWSLETTER_LINK_VISITOR_LIMIT}, windowSeconds: 3600 }))) {
+    return;
+  }
+  if (req.method === 'GET') {
+    // Opening the link changes nothing (a mail client's link scanner opens it
+    // too, and double opt-in means the person's own action): the button does.
+    var linkToken = req.query && typeof req.query.t === 'string' ? req.query.t : '';
+    if (!__newsletter.verifyNewsletterToken(linkToken, 'confirm')) {
+      return sendPage(res, 200, 'Link not valid', NOT_A_LINK, '');
+    }
+    return sendPage(
+      res,
+      200,
+      'Confirm your subscription',
+      'Receive the newsletter at this address?',
+      '<form method="post" action="${newsletter_scope_1.NEWSLETTER_CONFIRM_URL}"><input type="hidden" name="t" value="' +
+        escapeHtml(linkToken) + '"><button type="submit">Confirm subscription</button></form>'
+    );
+  }
+  var body = readBody(req);
+  var fromForm = String((req.headers && req.headers['content-type']) || '').indexOf('application/x-www-form-urlencoded') !== -1;
+  var token = typeof body.token === 'string' ? body.token : typeof body.t === 'string' ? body.t : '';
+  var result = { ok: false };
+  try {
+    if (token) {
+      result = await __newsletter.withNewsletterDb(function (db) {
+        return __newsletter.confirmNewsletter({ db: db, token: token, req: req });
+      });
+    }
+  } catch (err) {
+    if (fromForm) {
+      console.error('[newsletter] confirm failed:', __newsletter.safeError(err));
+      return sendPage(res, 503, 'Please try again', 'We could not confirm your subscription just now. Please try again in a moment.', '');
+    }
+    return __security.sendClientError(res, 503, 'We could not confirm the subscription. Please try again in a moment.', __newsletter.safeError(err));
+  }
+  if (fromForm) {
+    return result.ok
+      ? sendPage(res, 200, "You're subscribed", 'Thank you for confirming. You will receive the newsletter at this address.', '')
+      : sendPage(res, 200, 'Link not valid', NOT_A_LINK, '');
+  }
+  return res.status(200).json(result.ok ? { ok: true, email: result.email } : { ok: false });
+};
+`;
+exports.generateNewsletterConfirmRoute = generateNewsletterConfirmRoute;
+const generateNewsletterUnsubscribeRoute = () => `${ROUTE_PREAMBLE}
+
+${LINK_PAGE_CODE}
 
 var NOT_A_LINK = 'This unsubscribe link does not work. Use the link in a newer email from us.';
 

package/dist/cjs/newsletter/routes-code.js.map

@@ -1 +1 @@
-{"version":3,"file":"routes-code.js","sourceRoot":"","sources":["../../../src/newsletter/routes-code.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,qFAAoF;AACpF,yDAK2B;AAE3B,wDAAwD;AACxD,MAAM,eAAe,GAAG,UAAU,CAAA;AAElC,6DAA6D;AAChD,QAAA,6BAA6B,GAAG,EAAE,CAAA;AAE/C,MAAM,cAAc,GAAG,6BAA6B,IAAA,gDAAwB,EAAC,eAAe,CAAC;8BAC/D,IAAA,4CAAyB,EAAC,eAAe,CAAC;;;;;;;;EAQtE,CAAA;AAEF,MAAM,WAAW,GAAG,CAAC,OAAiB,EAAU,EAAE,CAAC,SAAS,OAAO;KAChE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAmB,MAAM,GAAG,CAAC;KAC7C,IAAI,CAAC,MAAM,CAAC;8BACe,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;;IAE5C,CAAA;AAEG,MAAM,gCAAgC,GAAG,GAAW,EAAE,CAAC,GAAG,cAAc;;;EAG7E,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;OAChB,2CAAwB;mDACoB,2CAAwB;8EACG,2CAAwB,aAAa,2CAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiC1I,CAAA;AAvCY,QAAA,gCAAgC,oCAuC5C;AAEM,MAAM,8BAA8B,GAAG,GAAW,EAAE,CAAC,GAAG,cAAc;;;EAG3E,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;4FACqE,qCAA6B;;;;;;;;;;;;;;;;;CAiBxH,CAAA;AArBY,QAAA,8BAA8B,kCAqB1C;AAEM,MAAM,kCAAkC,GAAG,GAAW,EAAE,CAAC,GAAG,cAAc;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EA+B/E,WAAW,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gGACkE,qCAA6B;;;;;;;;;;;;;;qCAcxF,6CAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4B9D,CAAA;AA1EY,QAAA,kCAAkC,sCA0E9C"}
+{"version":3,"file":"routes-code.js","sourceRoot":"","sources":["../../../src/newsletter/routes-code.ts"],"names":[],"mappings":";;;AAAA;;;;;;;;;;;;;;GAcG;AACH,qFAAoF;AACpF,+CAAmD;AACnD,yDAM2B;AAE3B,wDAAwD;AACxD,MAAM,eAAe,GAAG,UAAU,CAAA;AAElC,6DAA6D;AAChD,QAAA,6BAA6B,GAAG,EAAE,CAAA;AAE/C,MAAM,cAAc,GAAG,6BAA6B,IAAA,gDAAwB,EAAC,eAAe,CAAC;8BAC/D,IAAA,4CAAyB,EAAC,eAAe,CAAC;;;;;;;;EAQtE,CAAA;AAEF,MAAM,WAAW,GAAG,CAAC,OAAiB,EAAU,EAAE,CAAC,SAAS,OAAO;KAChE,GAAG,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,mBAAmB,MAAM,GAAG,CAAC;KAC7C,IAAI,CAAC,MAAM,CAAC;8BACe,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC;;IAE5C,CAAA;AAEG,MAAM,gCAAgC,GAAG,GAAW,EAAE,CAAC,GAAG,cAAc;;;EAG7E,WAAW,CAAC,CAAC,MAAM,CAAC,CAAC;OAChB,2CAAwB;mDACoB,2CAAwB;8EACG,2CAAwB,aAAa,2CAAwB;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;CAiC1I,CAAA;AAvCY,QAAA,gCAAgC,oCAuC5C;AAED,MAAM,cAAc,GAAG;;;;;;;;;;;;;;;;;;;;;;;;EAwBrB,CAAA;AAEF,MAAM,iBAAiB,GAAG,iCAAmB,CAAC,oBAAoB,GAAG,KAAK,CAAA;AAEnE,MAAM,8BAA8B,GAAG,GAAW,EAAE,CAAC,GAAG,cAAc;;EAE3E,cAAc;;2EAE2D,iBAAiB;;;EAG1F,WAAW,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;4FAC8D,qCAA6B;;;;;;;;;;;;;;;qCAepF,yCAAsB;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4B1D,CAAA;AAnDY,QAAA,8BAA8B,kCAmD1C;AAEM,MAAM,kCAAkC,GAAG,GAAW,EAAE,CAAC,GAAG,cAAc;;EAE/E,cAAc;;;;;EAKd,WAAW,CAAC,CAAC,KAAK,EAAE,MAAM,CAAC,CAAC;gGACkE,qCAA6B;;;;;;;;;;;;;;qCAcxF,6CAA0B;;;;;;;;;;;;;;;;;;;;;;;;;;;;CA4B9D,CAAA;AAlDY,QAAA,kCAAkC,sCAkD9C"}