npm - ep_rss - Versions diffs - 11.0.24 → 11.0.26 - Mend

ep_rss 11.0.24 → 11.0.26

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md +51 -6
package/index.js +10 -27
package/package.json +1 -1
package/static/tests/frontend-new/specs/feed.spec.ts +54 -0

package/README.md CHANGED Viewed

@@ -1,18 +1,51 @@
-# RSS Feeds of Pad Changes for Etherpad
+# RSS feeds for Etherpad pads
-![Publish Status](https://github.com/ether/ep_rss/workflows/Node.js%20Package/badge.svg) [![Backend Tests Status](https://github.com/ether/ep_rss/actions/workflows/test-and-release.yml/badge.svg)](https://github.com/ether/ep_rss/actions/workflows/test-and-release.yml)
+[![npm](https://img.shields.io/npm/v/ep_rss.svg)](https://www.npmjs.com/package/ep_rss)
+[![Backend Tests](https://github.com/ether/ep_rss/actions/workflows/backend-tests.yml/badge.svg?branch=main)](https://github.com/ether/ep_rss/actions/workflows/backend-tests.yml)
+[![Frontend Tests](https://github.com/ether/ep_rss/actions/workflows/frontend-tests.yml/badge.svg?branch=main)](https://github.com/ether/ep_rss/actions/workflows/frontend-tests.yml)
-Exposes an RSS feed for each pad at `/p/{padId}/feed`.
+Adds an RSS 2.0 feed for every pad so readers can subscribe to changes
+in any feed reader.
 ## Install
-```
+From your Etherpad root, install the plugin via the Etherpad plugin
+manager:
+```sh
 pnpm run plugins i ep_rss
 ```
+Or install from the admin UI: **Admin → Manage Plugins**, search for
+`ep_rss`, click *Install*. Restart Etherpad after installing.
+> ⚠️ Don't run `npm i` / `pnpm add` against this plugin from inside
+> the Etherpad source tree — Etherpad tracks installed plugins
+> through its own plugin manager, and hand-editing `package.json`
+> can leave the server unable to start.
+## Endpoints
+Once installed, each pad exposes:
+| Path | Behavior |
+|---|---|
+| `/p/<pad>/feed` | 200 with `Content-Type: application/rss+xml` and the current pad text as a single `<item>` |
+| `/p/<pad>/rss` | 302 → `/p/<pad>/feed` |
+| `/p/<pad>/feed.rss` | 302 → `/p/<pad>/feed` |
+| `/p/<pad>/atom.xml` | 302 → `/p/<pad>/feed` |
+The pad page itself also advertises the feed in `<head>` so feed
+readers auto-discover it:
+```html
+<link rel="alternate" type="application/rss+xml" title="Pad RSS Feed" href="feed" />
+```
 ## Settings
-Optional stale time (milliseconds before a new RSS item is generated) can be set in `settings.json`:
+Optional. Add to `settings.json` to control how long a generated feed
+is cached in memory before being regenerated:
 ```json
 "rss": {
@@ -20,7 +53,19 @@ Optional stale time (milliseconds before a new RSS item is generated) can be set
 }
 ```
-Defaults to 5 minutes if not configured.
+`staleTime` is in milliseconds. Defaults to 5 minutes
+(`300000`) when unset.
+## Development
+```sh
+pnpm install
+pnpm run lint
+```
+Backend and frontend tests live under `static/tests/` and run inside
+an Etherpad checkout — the CI workflows install this plugin into a
+fresh Etherpad and exercise it end-to-end.
 ## License

package/index.js CHANGED Viewed

@@ -1,6 +1,6 @@
 'use strict';
-const API = require('ep_etherpad-lite/node/db/API.js');
+const API = require('ep_etherpad-lite/node/db/API');
 const padManager = require('ep_etherpad-lite/node/db/PadManager');
 const settings = require('ep_etherpad-lite/node/utils/Settings');
@@ -20,33 +20,16 @@ exports.eejsBlock_htmlHead = (hookName, args, cb) => {
 };
 exports.registerRoute = (hookName, args, cb) => {
-  args.app.get('/p/*/rss', (req, res) => {
-    /* Sanity is in the crack of time*/
-    const path = req.url.split('/');
-    const padId = path[2];
-    res.redirect(`/p/${padId}/feed`);
-  });
-  args.app.get('/p/*/feed.rss', (req, res) => {
-    /* Sanity is in the crack of time*/
-    const path = req.url.split('/');
-    const padId = path[2];
-    res.redirect(`/p/${padId}/feed`);
-  });
-  args.app.get('/p/*/atom.xml', (req, res) => {
-    /* Sanity is in the crack of time*/
-    const path = req.url.split('/');
-    const padId = path[2];
-    res.redirect(`/p/${padId}/feed`);
-  });
-  args.app.get('/p/*/feed', async (req, res) => {
-    /* Sanity is in the cracks of lime*/
+  const redirectToFeed = (req, res) => {
+    res.redirect(`/p/${encodeURIComponent(req.params.padId)}/feed`);
+  };
+  args.app.get('/p/:padId/rss', redirectToFeed);
+  args.app.get('/p/:padId/feed.rss', redirectToFeed);
+  args.app.get('/p/:padId/atom.xml', redirectToFeed);
+  args.app.get('/p/:padId/feed', async (req, res) => {
     const fullURL = `${req.protocol}://${req.get('host')}${req.url}`;
-    const path = req.url.split('/');
-    const padId = path[2];
+    const padId = req.params.padId;
     const padURL = `${req.protocol}://${req.get('host')}/p/${padId}`;
     const dateString = new Date();
     let isPublished = false; // is this item already published?

package/package.json CHANGED Viewed

@@ -1,7 +1,7 @@
 {
   "name": "ep_rss",
   "description": "Get an RSS feed of pad updates",
-  "version": "11.0.24",
+  "version": "11.0.26",
   "author": {
     "name": "John McLear",
     "email": "john@mclear.co.uk",

package/static/tests/frontend-new/specs/feed.spec.ts ADDED Viewed

@@ -0,0 +1,54 @@
+import {expect, test} from '@playwright/test';
+import {goToNewPad, writeToPad} from 'ep_etherpad-lite/tests/frontend-new/helper/padHelper';
+const BASE_URL = 'http://localhost:9001';
+const padIdFromUrl = (url: string) => url.split('/p/')[1].split('?')[0];
+test.describe('ep_rss feed', () => {
+  test('declares the RSS alternate link in the pad page head', async ({page}) => {
+    await goToNewPad(page);
+    const link = page.locator('head link[rel="alternate"][type="application/rss+xml"]');
+    await expect(link).toHaveAttribute('href', 'feed');
+  });
+  test('serves an RSS document at /p/<pad>/feed containing the pad text', async ({page, request}) => {
+    await goToNewPad(page);
+    const padId = padIdFromUrl(page.url());
+    const marker = `ep-rss-marker-${Date.now()}`;
+    await writeToPad(page, marker);
+    // Give the socket time to flush the change to the pad store before the
+    // route reads it back via API.getLastEdited / padManager.getPad.
+    await page.waitForTimeout(1200);
+    const res = await request.get(`${BASE_URL}/p/${padId}/feed`);
+    expect(res.status()).toBe(200);
+    expect(res.headers()['content-type']).toContain('application/rss+xml');
+    const body = await res.text();
+    expect(body).toMatch(/^<rss /);
+    expect(body).toContain(`<title>${padId}</title>`);
+    expect(body).toContain(marker);
+    expect(body.trim().endsWith('</rss>')).toBe(true);
+  });
+  test('escapes HTML special characters in the description', async ({page, request}) => {
+    await goToNewPad(page);
+    const padId = padIdFromUrl(page.url());
+    await writeToPad(page, 'tags <b>&</b>');
+    await page.waitForTimeout(1200);
+    const body = await (await request.get(`${BASE_URL}/p/${padId}/feed`)).text();
+    expect(body).toContain('&lt;b&gt;&amp;&lt;/b&gt;');
+    expect(body).not.toContain('<b>&</b>');
+  });
+  for (const alias of ['rss', 'feed.rss', 'atom.xml']) {
+    test(`/p/<pad>/${alias} redirects to /p/<pad>/feed`, async ({page, request}) => {
+      await goToNewPad(page);
+      const padId = padIdFromUrl(page.url());
+      const res = await request.get(`${BASE_URL}/p/${padId}/${alias}`, {maxRedirects: 0});
+      expect(res.status()).toBe(302);
+      expect(res.headers()['location']).toBe(`/p/${padId}/feed`);
+    });
+  }
+});