Fix TechDocs download bug when backend/app hosts are the same.

Signed-off-by: Eric Peterson <ericpeterson@spotify.com>
2022-02-01 13:39:23 +01:00
parent a28838ac5c
commit 742434a6ba
4 changed files with 39 additions and 1 deletions
@@ -0,0 +1,5 @@
+---
+'@backstage/plugin-techdocs': patch
+---
+
+Fixed a bug where links to files within a TechDocs site that use the `download` attribute would result in a 404 in cases where the TechDocs backend and Backstage frontend application are on the same host.
@@ -88,6 +88,12 @@ Weather: :sunny: :umbrella: :cloud: :snowflake:

 Animals: :tiger: :horse: :turtle: :wolf: :frog:

+### Attributes
+
+[A Download Link](./images/backstage-logo-cncf.svg){: download }
+
+![A Scaled Image](./images/backstage-logo-cncf.svg){: style="width: 100px" }
+
 ### MDX truly sane lists

 - attributes
@@ -71,4 +71,31 @@ describe('addLinkClickListener', () => {

    expect(fn).toHaveBeenCalledTimes(0);
  });
+
+  it('does not call onClick when a link has a download attribute', async () => {
+    const fn = jest.fn();
+    const shadowDom = await createTestShadowDom(
+      `
+      <!DOCTYPE html>
+      <html>
+        <body>
+          <a download href="http://localhost:3000/file.pdf">Download</a>
+        </body>
+      </html>
+    `,
+      {
+        preTransformers: [],
+        postTransformers: [
+          addLinkClickListener({
+            baseUrl: 'http://localhost:3000',
+            onClick: fn,
+          }),
+        ],
+      },
+    );
+
+    shadowDom.querySelector('a')?.click();
+
+    expect(fn).toHaveBeenCalledTimes(0);
+  });
 });
@@ -32,7 +32,7 @@ export const addLinkClickListener = ({
        const href = target.getAttribute('href');

        if (!href) return;
-        if (href.startsWith(baseUrl)) {
+        if (href.startsWith(baseUrl) && !elem.hasAttribute('download')) {
          e.preventDefault();
          onClick(e, href);
        }