switch from standardjs to prettier

dunglas · Oct 23, 2024 · 0803dc5 · 0803dc5
1 parent 78ed454
commit 0803dc5
Show file tree

Hide file tree

Showing 7 changed files with 446 additions and 361 deletions.
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -23,7 +23,7 @@ jobs:
         with:
           fetch-depth: 0
       - name: Lint Code Base
-        uses: super-linter/super-linter/slim@v7
+        uses: super-linter/super-linter/slim@v6
         env:
           DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
@@ -34,6 +34,6 @@ jobs:
           VALIDATE_GO_MODULES: false
           VALIDATE_PHP_PHPCS: false
           VALIDATE_KUBERNETES_KUBECONFORM: false
-          VALIDATE_JAVASCRIPT_PRETTIER: false
-          VALIDATE_TYPESCRIPT_PRETTIER: false
+          VALIDATE_JAVASCRIPT_STANDARD: false
+          VALIDATE_TYPESCRIPT_STANDARD: false
           VALIDATE_PYTHON_PYLINT: false
diff --git a/.prettierignore b/.prettierignore
@@ -1,7 +1,3 @@
-# We use standardjs for JavaScript and TypeScript files
-**/*.js
-**/*.ts
-
 # The spec is in the IETF flavor of Markdown
 spec/mercure.md
 

diff --git a/conformance-tests/mercure.spec.ts b/conformance-tests/mercure.spec.ts
@@ -1,124 +1,204 @@
-import { test, expect } from '@playwright/test';
+import { test, expect } from "@playwright/test";
 import { randomBytes } from "crypto";
 
 function randomString() {
-  return randomBytes(20).toString('hex');
+  return randomBytes(20).toString("hex");
 }
 
-test.beforeEach(async ({ page }) => await page.goto('/'));
+test.beforeEach(async ({ page }) => await page.goto("/"));
 
-test.describe('Publish update', () => {
+test.describe("Publish update", () => {
   const randomStrings: string[] = Array.from({ length: 6 }, randomString);
 
-  type Data = { name: string, updateTopics: string[], topicSelectors: string[], mustBeReceived: boolean, updateID?: string, private?: true };
+  type Data = {
+    name: string;
+    updateTopics: string[];
+    topicSelectors: string[];
+    mustBeReceived: boolean;
+    updateID?: string;
+    private?: true;
+  };
 
   const dataset: Data[] = [
-    { name: 'raw string', mustBeReceived: true, updateTopics: [randomStrings[0]], topicSelectors: [randomStrings[0]] },
-    { name: 'multiple topics', mustBeReceived: true, updateTopics: [randomString(), randomStrings[1]], topicSelectors: [randomStrings[1]] },
-    { name: 'multiple topic selectors', mustBeReceived: true, updateTopics: [randomStrings[2]], topicSelectors: ['foo', randomStrings[2]] },
-    { name: 'URI', mustBeReceived: true, updateTopics: [`https://example.net/foo/${randomStrings[3]}`], topicSelectors: [`https://example.net/foo/${randomStrings[3]}`] },
-    { name: 'URI template', mustBeReceived: true, updateTopics: [`https://example.net/foo/${randomStrings[4]}`], topicSelectors: ['https://example.net/foo/{random}'] },
-    { name: 'nonmatching raw string', mustBeReceived: false, updateTopics: [`will-not-match}`], topicSelectors: ['another-name'] },
-    { name: 'nonmatching URI', mustBeReceived: false, updateTopics: [`https://example.net/foo/will-not-match}`], topicSelectors: ['https://example.net/foo/another-name'] },
-    { name: 'nonmatching URI template', mustBeReceived: false, updateTopics: [`https://example.net/foo/will-not-match}`], topicSelectors: ['https://example.net/bar/{var}'] },
-    { name: 'private raw string', mustBeReceived: false, private: true, updateTopics: [randomStrings[0]], topicSelectors: [randomStrings[0]] },
-    { name: 'private URI', mustBeReceived: false, private: true, updateTopics: [`https://example.net/foo/${randomStrings[3]}`], topicSelectors: [`https://example.net/foo/${randomStrings[3]}`] },
-    { name: 'private URI template', mustBeReceived: false, private: true, updateTopics: [`https://example.net/foo/${randomStrings[4]}`], topicSelectors: ['https://example.net/foo/{random}'] },
+    {
+      name: "raw string",
+      mustBeReceived: true,
+      updateTopics: [randomStrings[0]],
+      topicSelectors: [randomStrings[0]],
+    },
+    {
+      name: "multiple topics",
+      mustBeReceived: true,
+      updateTopics: [randomString(), randomStrings[1]],
+      topicSelectors: [randomStrings[1]],
+    },
+    {
+      name: "multiple topic selectors",
+      mustBeReceived: true,
+      updateTopics: [randomStrings[2]],
+      topicSelectors: ["foo", randomStrings[2]],
+    },
+    {
+      name: "URI",
+      mustBeReceived: true,
+      updateTopics: [`https://example.net/foo/${randomStrings[3]}`],
+      topicSelectors: [`https://example.net/foo/${randomStrings[3]}`],
+    },
+    {
+      name: "URI template",
+      mustBeReceived: true,
+      updateTopics: [`https://example.net/foo/${randomStrings[4]}`],
+      topicSelectors: ["https://example.net/foo/{random}"],
+    },
+    {
+      name: "nonmatching raw string",
+      mustBeReceived: false,
+      updateTopics: [`will-not-match}`],
+      topicSelectors: ["another-name"],
+    },
+    {
+      name: "nonmatching URI",
+      mustBeReceived: false,
+      updateTopics: [`https://example.net/foo/will-not-match}`],
+      topicSelectors: ["https://example.net/foo/another-name"],
+    },
+    {
+      name: "nonmatching URI template",
+      mustBeReceived: false,
+      updateTopics: [`https://example.net/foo/will-not-match}`],
+      topicSelectors: ["https://example.net/bar/{var}"],
+    },
+    {
+      name: "private raw string",
+      mustBeReceived: false,
+      private: true,
+      updateTopics: [randomStrings[0]],
+      topicSelectors: [randomStrings[0]],
+    },
+    {
+      name: "private URI",
+      mustBeReceived: false,
+      private: true,
+      updateTopics: [`https://example.net/foo/${randomStrings[3]}`],
+      topicSelectors: [`https://example.net/foo/${randomStrings[3]}`],
+    },
+    {
+      name: "private URI template",
+      mustBeReceived: false,
+      private: true,
+      updateTopics: [`https://example.net/foo/${randomStrings[4]}`],
+      topicSelectors: ["https://example.net/foo/{random}"],
+    },
   ];
 
   for (const data of dataset) {
     test(data.name, async ({ page }) => {
-      page.on('console', msg => console.log(msg.text()));
+      page.on("console", (msg) => console.log(msg.text()));
 
       data.updateID = `id-${JSON.stringify(data.updateTopics)}`;
 
-      const { received, contentType, status, body } = await page.evaluate(async (data) => {
-        const receivedResult = Symbol('received');
-        const notReceivedResult = Symbol('not received');
-
-        let resolveReady: () => void;
-        const ready = new Promise((resolve) => {
-          resolveReady = () => resolve(true);
-        });
-
-        let resolveReceived: () => void;
-        const received = new Promise((resolve) => {
-          resolveReceived = () => resolve(receivedResult);
-        });
-
-        const timeout = new Promise((resolve) => setTimeout(resolve, 2000, notReceivedResult));
-
-        const url = new window.URL('/.well-known/mercure', window.origin);
-        data.topicSelectors.forEach(topicSelector => url.searchParams.append('topic', topicSelector));
-
-        const event = new window.URLSearchParams();
-        data.updateTopics.forEach(updateTopic => event.append('topic', updateTopic));
-        event.set('id', data.updateID);
-        event.set('data', `data for
-
-        ${data.name}`);
-        if (data.private) event.set('private', 'on');
-
-        console.log(`data: ${JSON.stringify(data)}`);
-
-        console.log(`creating EventSource: ${url}`);
-        const es = new EventSource(url);
-        console.log('EventSource created');
-
-        es.onopen = () => {
-          console.log('EventSource opened');
-          resolveReady();
-        }
-
-        let id: string;
-        es.onmessage = (e) => {
-          console.log(`EventSource event received: ${e.data}`);
-          if (
-            e.type === 'message' &&
-            e.lastEventId === event.get('id') &&
-            e.data === event.get('data')
-          ) {
-            es.close();
-            resolveReceived();
-          }
-        };
-
-        await ready; // Wait for the EventSource to be ready
-
-        console.log(`Creating POST request: ${event.toString()}`);
-        const resp = await fetch(`/.well-known/mercure`, {
-          method: 'POST',
-          headers: { 'Authorization': 'Bearer eyJhbGciOiJIUzI1NiJ9.eyJtZXJjdXJlIjp7InB1Ymxpc2giOlsiKiJdLCJzdWJzY3JpYmUiOlsiKiJdfX0.bVXdlWXwfw9ySx7-iV5OpUSHo34RkjUdVzDLBcc6l_g' },
-          body: event,
-        });
-
-        id = await resp.text();
-        console.log(`POST request done: ${JSON.stringify({ status: resp.status, id, event: event.toString() })}`);
-
-        switch (await Promise.race([received, timeout])) {
-          case receivedResult:
-            return {
-              received: true,
-              contentType: resp.headers.get('Content-Type'),
-              status: resp.status,
-              body: id,
-            };
-
-          case notReceivedResult:
-            return {
-              received: false,
+      const { received, contentType, status, body } = await page.evaluate(
+        async (data) => {
+          const receivedResult = Symbol("received");
+          const notReceivedResult = Symbol("not received");
+
+          let resolveReady: () => void;
+          const ready = new Promise((resolve) => {
+            resolveReady = () => resolve(true);
+          });
+
+          let resolveReceived: () => void;
+          const received = new Promise((resolve) => {
+            resolveReceived = () => resolve(receivedResult);
+          });
+
+          const timeout = new Promise((resolve) =>
+            setTimeout(resolve, 2000, notReceivedResult),
+          );
+
+          const url = new window.URL("/.well-known/mercure", window.origin);
+          data.topicSelectors.forEach((topicSelector) =>
+            url.searchParams.append("topic", topicSelector),
+          );
+
+          const event = new window.URLSearchParams();
+          data.updateTopics.forEach((updateTopic) =>
+            event.append("topic", updateTopic),
+          );
+          event.set("id", data.updateID);
+          event.set(
+            "data",
+            `data for
+
+        ${data.name}`,
+          );
+          if (data.private) event.set("private", "on");
+
+          console.log(`data: ${JSON.stringify(data)}`);
+
+          console.log(`creating EventSource: ${url}`);
+          const es = new EventSource(url);
+          console.log("EventSource created");
+
+          es.onopen = () => {
+            console.log("EventSource opened");
+            resolveReady();
+          };
+
+          let id: string;
+          es.onmessage = (e) => {
+            console.log(`EventSource event received: ${e.data}`);
+            if (
+              e.type === "message" &&
+              e.lastEventId === event.get("id") &&
+              e.data === event.get("data")
+            ) {
+              es.close();
+              resolveReceived();
             }
-        }
-
-      }, data);
+          };
+
+          await ready; // Wait for the EventSource to be ready
+
+          console.log(`Creating POST request: ${event.toString()}`);
+          const resp = await fetch(`/.well-known/mercure`, {
+            method: "POST",
+            headers: {
+              Authorization:
+                "Bearer eyJhbGciOiJIUzI1NiJ9.eyJtZXJjdXJlIjp7InB1Ymxpc2giOlsiKiJdLCJzdWJzY3JpYmUiOlsiKiJdfX0.bVXdlWXwfw9ySx7-iV5OpUSHo34RkjUdVzDLBcc6l_g",
+            },
+            body: event,
+          });
+
+          id = await resp.text();
+          console.log(
+            `POST request done: ${JSON.stringify({ status: resp.status, id, event: event.toString() })}`,
+          );
+
+          switch (await Promise.race([received, timeout])) {
+            case receivedResult:
+              return {
+                received: true,
+                contentType: resp.headers.get("Content-Type"),
+                status: resp.status,
+                body: id,
+              };
+
+            case notReceivedResult:
+              return {
+                received: false,
+              };
+          }
+        },
+        data,
+      );
 
       expect(received).toBe(data.mustBeReceived);
 
       if (data.mustBeReceived) {
         expect(contentType).toMatch(/^text\/plain(?:$|;.*)/);
         expect(status).toBe(200);
-        if (process.env.CUSTOM_ID)
-          expect(body).toBe(data.updateID);
+        if (process.env.CUSTOM_ID) expect(body).toBe(data.updateID);
       }
     });
   }