Backport PR #16584: Fix the identifier to download licenses in JSON format (#16592)

meeseeksmachine · joaopalmeiro · web-flow · commit be34cd308f0a · 2024-07-16T11:21:56.000+01:00
Co-authored-by: João Palmeiro &lt;joaommpalmeiro@gmail.com&gt;
diff --git a/galata/test/jupyterlab/help.test.ts b/galata/test/jupyterlab/help.test.ts
@@ -4,6 +4,23 @@
  */
 
 import { expect, test } from '@jupyterlab/galata';
+import { readFile } from 'fs/promises';
+
+import { isBlank, isValidJSON } from './utils';
+
+const licenseFormats = [
+  {
+    name: 'Markdown',
+    extension: 'md',
+    validation: (value: string) => !isBlank(value)
+  },
+  {
+    name: 'CSV',
+    extension: 'csv',
+    validation: (value: string) => !isBlank(value)
+  },
+  { name: 'JSON', extension: 'json', validation: isValidJSON }
+];
 
 test('Switch back and forth to reference page', async ({ page }) => {
   // The goal is to test switching back and forth with a tab containing an iframe
@@ -30,3 +47,29 @@ test('Switch back and forth to reference page', async ({ page }) => {
     page.locator('.jp-MarkdownCell .jp-InputArea-editor')
   ).toHaveText(cellContent);
 });
+
+test.describe('Licenses', () => {
+  licenseFormats.forEach(licenseFormat => {
+    test(`Exporting licenses as ${licenseFormat.name} must download a ${licenseFormat.name} file`, async ({
+      page
+    }) => {
+      await page.menu.clickMenuItem('Help>Licenses');
+
+      const downloadPromise = page.waitForEvent('download');
+      await page
+        .getByRole('button', {
+          name: `Download All Licenses as ${licenseFormat.name}`
+        })
+        .click();
+      const download = await downloadPromise;
+
+      const fileName = download.suggestedFilename();
+      const fileContent = await readFile(await download.path(), {
+        encoding: 'utf8'
+      });
+
+      expect(fileName).toBe(`jupyterlab-licenses.${licenseFormat.extension}`);
+      expect(licenseFormat.validation(fileContent)).toBeTruthy();
+    });
+  });
+});
diff --git a/galata/test/jupyterlab/utils.ts b/galata/test/jupyterlab/utils.ts
@@ -73,3 +73,22 @@ export async function dragCellTo(
   await page.waitForCondition(options.stopCondition);
   await page.mouse.up();
 }
+
+/**
+ * Check if a given string value is valid JSON.
+ */
+export function isValidJSON(value: string): boolean {
+  try {
+    JSON.parse(value);
+    return true;
+  } catch (e) {
+    return false;
+  }
+}
+
+/**
+ * Check if a given string value is empty (excluding spaces).
+ */
+export function isBlank(value: string): boolean {
+  return value.trim().length === 0;
+}
diff --git a/packages/help-extension/src/licenses.tsx b/packages/help-extension/src/licenses.tsx
@@ -183,7 +183,7 @@ export namespace Licenses {
       icon: spreadsheetIcon
     },
     json: {
-      id: 'csv',
+      id: 'json',
       title: 'JSON',
       icon: jsonIcon
     }

Original file line number	Diff line number	Diff line change
`@@ -183,7 +183,7 @@ export namespace Licenses {`
`183`	`183`	`icon: spreadsheetIcon`
`184`	`184`	`},`
`185`	`185`	`json: {`
`186`		`- id: 'csv',`
	`186`	`+ id: 'json',`
`187`	`187`	`title: 'JSON',`
`188`	`188`	`icon: jsonIcon`
`189`	`189`	`}`