ep_rss 11.0.26 → 11.0.27

package/AGENTS.md

@@ -17,13 +17,14 @@ ep_rss/
 ├── client.js
 ├── ep.json
 ├── index.js
+├── locales/
+│   └── en.json
 ├── package.json
 ├── static/
-│   ├── img/
-│   ├── tests/
+│   ├── css/exportColumn.css
+│   └── tests/
 ├── templates/
-│   ├── embedFrame.ejs
-│   ├── embedFrame.html
+│   └── exportColumn.ejs
 ```
 
 ## Helpers used
@@ -59,6 +60,6 @@ pnpm --filter ep_etherpad-lite run test-ui
 
 ## Quick reference: hooks declared in `ep.json`
 
-* Server: `eejsBlock_htmlHead`, `expressCreateServer`, `eejsBlock_embedPopup`
+* Server: `eejsBlock_htmlHead`, `expressCreateServer`, `eejsBlock_exportColumn`, `eejsBlock_styles`
 
 When adding a hook, register it in both `ep.json` *and* the matching `exports.<hook> = ...` in the JS file.

package/client.js

@@ -2,8 +2,14 @@
 
 const eejs = require('ep_etherpad-lite/node/eejs');
 
-exports.eejsBlock_embedPopup = (hookName, args, cb) => {
+exports.eejsBlock_exportColumn = (hookName, args, cb) => {
   const feedURL = `..${args.renderContext.req.url}/feed`;
-  args.content += eejs.require('ep_rss/templates/embedFrame.ejs', {feed: feedURL});
+  args.content += eejs.require('ep_rss/templates/exportColumn.ejs', {feed: feedURL});
+  return cb();
+};
+
+exports.eejsBlock_styles = (hookName, args, cb) => {
+  args.content +=
+      '<link rel="stylesheet" href="/static/plugins/ep_rss/static/css/exportColumn.css">';
   return cb();
 };

package/ep.json

@@ -5,7 +5,8 @@
       "hooks": {
         "eejsBlock_htmlHead": "ep_rss/index",
         "expressCreateServer" : "ep_rss/index:registerRoute",
-        "eejsBlock_embedPopup": "ep_rss/client:eejsBlock_embedPopup"
+        "eejsBlock_exportColumn": "ep_rss/client:eejsBlock_exportColumn",
+        "eejsBlock_styles": "ep_rss/client:eejsBlock_styles"
       }
     }
   ]

package/locales/en.json

@@ -0,0 +1,4 @@
+{
+  "ep_rss.exportrssa.title": "RSS feed of this pad",
+  "ep_rss.exportrss": "RSS"
+}

package/package.json

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

package/static/css/exportColumn.css

@@ -0,0 +1,24 @@
+/*
+ * SVG export-icon styling. The other export buttons render a Fontello
+ * glyph via the .exporttype:before / .buttonicon-* pseudo-element; we
+ * use an inline SVG instead so the icon survives without registering
+ * an extra font character. Sized at 22px to match the heuristic
+ * height of the buttonicon font row, kept orange so RSS readers still
+ * recognise it at a glance.
+ */
+#exportrssa .ep_rss_export_icon {
+  display: inline-flex;
+  align-items: center;
+  justify-content: center;
+  width: 22px;
+  height: 22px;
+  margin-right: 10px;
+  color: #f26522;
+  vertical-align: middle;
+}
+
+#exportrssa .ep_rss_export_icon svg {
+  width: 100%;
+  height: 100%;
+  fill: currentColor;
+}

package/static/tests/frontend-new/specs/export-link.spec.ts

@@ -0,0 +1,43 @@
+import {expect, test} from '@playwright/test';
+import {goToNewPad} from 'ep_etherpad-lite/tests/frontend-new/helper/padHelper';
+
+test.describe('ep_rss export-column link', () => {
+  test('renders the RSS link inside the Import/Export column', async ({page}) => {
+    await goToNewPad(page);
+    const link = page.locator('#exportColumn a#exportrssa');
+    await expect(link).toHaveCount(1);
+    await expect(link).toHaveAttribute('data-l10n-id', 'ep_rss.exportrssa.title');
+    await expect(link).toHaveAttribute('target', '_blank');
+    await expect(link).toHaveAttribute('rel', 'noopener');
+    const href = await link.getAttribute('href');
+    expect(href).toMatch(/\/feed$/);
+    await expect(link.locator('span#exportrss svg')).toHaveCount(1);
+  });
+
+  test('localized title attribute resolves via html10n', async ({page}) => {
+    await goToNewPad(page);
+    const link = page.locator('#exportrssa');
+    await expect.poll(
+      async () => link.getAttribute('title'),
+      {timeout: 5000},
+    ).toBe('RSS feed of this pad');
+  });
+
+  test('clicking the link reaches /p/<pad>/feed', async ({page, request}) => {
+    await goToNewPad(page);
+    const href = await page.locator('#exportrssa').getAttribute('href');
+    expect(href).toBeTruthy();
+    const resolved = new URL(href!, page.url()).toString();
+    const res = await request.get(resolved);
+    expect(res.status()).toBe(200);
+    expect(res.headers()['content-type']).toContain('application/rss+xml');
+  });
+
+  test('share/embed popup no longer carries an RSS block', async ({page}) => {
+    await goToNewPad(page);
+    // The legacy embedFrame.ejs put `<a class="rssfeed">` inside #embed.
+    // Verify nothing in #embed references the feed any more.
+    const stale = page.locator('#embed a.rssfeed, #embed a[href*="feed"]');
+    await expect(stale).toHaveCount(0);
+  });
+});

package/templates/exportColumn.ejs

@@ -0,0 +1,7 @@
+<a id="exportrssa" data-l10n-id="ep_rss.exportrssa.title" target="_blank" rel="noopener" class="exportlink" href="<%= feed %>">
+  <span class="exporttype ep_rss_export_icon" id="exportrss" data-l10n-id="ep_rss.exportrss" aria-hidden="true">
+    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" focusable="false" aria-hidden="true">
+      <path d="M5 4.5a1.5 1.5 0 0 1 1.5-1.5C14.4 3 21 9.6 21 17.5a1.5 1.5 0 0 1-3 0C18 11.3 12.7 6 6.5 6A1.5 1.5 0 0 1 5 4.5Zm0 6a1.5 1.5 0 0 1 1.5-1.5C11.7 9 16 13.3 16 18.5a1.5 1.5 0 0 1-3 0C13 14.9 10.1 12 6.5 12A1.5 1.5 0 0 1 5 10.5ZM6.5 16a2 2 0 1 1 0 4 2 2 0 0 1 0-4Z"/>
+    </svg>
+  </span>
+</a>

package/templates/embedFrame.ejs

@@ -1,8 +0,0 @@
-<br>
-<h2>Rss Feeds</h2>
-<p>
-<a class="rssfeed" href="<%= feed%>" title="Pad Feed">
-<img src="../static/plugins/ep_rss/static/img/rss.gif">
-</a>
-
-</p>

package/templates/embedFrame.html

@@ -1 +0,0 @@
-<a class="rssfeed" href="feed">RSS Feed</a>