@ideasonpurpose/build-tools-wordpress 2.6.6 → 2.8.0

package/test/devserver-proxy.test.js

@@ -1,23 +1,19 @@
 //@ts-check
 
-import { afterEach, beforeEach, describe, expect, test, vi } from "vitest";
-
-import fs from "fs";
-import dns from "dns";
+import { afterEach, beforeEach, expect, test, vi } from "vitest";
 
 import { EventEmitter } from "events";
 
 import { devserverProxy } from "../lib/devserver-proxy.js";
 import { findLocalPort } from "../lib/find-local-docker-port.js";
 
-const expected = "11.22.33.44";
-
 const expectedPort = 56789;
 const expectedHostName = "stella.dog";
 const expectedTarget = `http://${expectedHostName}:${expectedPort}`;
 
 vi.mock("../lib/find-local-docker-port.js");
 
+/** @type {Promise<{port:number,hostname:string}>} */
 let localPort;
 
 beforeEach(() => {
@@ -33,80 +29,6 @@ beforeEach(() => {
 afterEach(() => {
   vi.restoreAllMocks();
 });
-// beforeEach(() => {
-//   jest.spyOn(dns, "promises", "get").mockImplementation(() => {
-//     return { resolve: async () => [expected] };
-//   });
-
-//   console.log = jest.fn();
-// });
-
-// afterEach(() => {
-//   jest.clearAllMocks();
-//   jest.resetAllMocks();
-//   // mockResolve.mockResolvedValue(["11.22.33.44"]);
-// });
-
-// disabled because we're now mocking the library
-// test.skip("dns works normally", async () => {
-//   const actual = await dns.promises.resolve("apple.com");
-//   expect(actual[0]).toMatch(/^17\.253/);
-// });
-
-// test("mock dns.promises.resolve", async () => {
-//   const actual = await dns.promises.resolve("hello");
-//   expect(actual).toBe(expected);
-// });
-
-// test("resolve from file", async () => {
-//   const actual = await resolveFromFile("wordpress");
-//   expect(actual).toBe(expected);
-// });
-
-// test("Send legacy token where there's no wordpress service", async () => {
-//   jest.spyOn(dns, "promises", "get").mockImplementation(() => {
-//     // console.log("ONLY ONCE");
-//     return { resolve: () => new Promise((resolve, reject) => reject()) };
-//   });
-
-//   let proxy =
-//     "http://devserver-proxy-token--d939bef2a41c4aa154ddb8db903ce19fff338b61";
-
-//   const logSpy = jest.spyOn(console, "log");
-//   const actual = await devserverProxy({ proxy });
-
-//   expect(actual).toStrictEqual({});
-//   // expect(logSpy).toHaveBeenCalledWith(expect.stringContaining("ONCE"));
-//   expect(logSpy).toHaveBeenCalledWith(
-//     expect.any(String),
-//     expect.stringContaining("devserver-proxy-token"),
-//     expect.any(String)
-//   );
-// });
-
-// test("prefix http onto string", async () => {
-//   jest.spyOn(dns, "promises", "get").mockImplementation(() => {
-//     return {
-//       resolve: () => new Promise((resolve, reject) => resolve(["fake-url"])),
-//     };
-//   });
-
-//   let proxy = "placeholder string";
-//   const actual = await devserverProxy({ proxy });
-//   expect(actual).toHaveProperty("proxy.**.target", "http://fake-url");
-// });
-
-// test("fail to prefix http onto string", async () => {
-//   jest.spyOn(dns, "promises", "get").mockImplementation(() => {
-//     return {
-//       resolve: () => new Promise((resolve, reject) => reject()),
-//     };
-//   });
-
-//   let proxy = "placeholder string";
-//   const actual = await devserverProxy({ proxy });
-//   expect(actual).toStrictEqual({});
-// });
 
 test("Test proxy settings", async () => {
   let proxy = true;
@@ -134,6 +56,13 @@ test("proxy is a plain string", async () => {
   expect(findLocalPort).toHaveBeenCalledWith(proxy);
 });
 
+test("plain string proxy with no local port", async () => {
+  vi.mocked(findLocalPort).mockReturnValue(Promise.resolve(null));
+  const result = await devserverProxy({ proxy: "sandwich" });
+  expect(result.proxy).toHaveLength(1);
+  expect(result.proxy[0].target).toBeUndefined();
+});
+
 test("Proxy boolean true", async () => {
   vi.mocked(findLocalPort).mockReturnValue(localPort);
   const proxy = true;
@@ -141,6 +70,13 @@ test("Proxy boolean true", async () => {
   expect(actual).toHaveProperty("target", expectedTarget);
 });
 
+test("Proxy boolean true with no local port", async () => {
+  vi.mocked(findLocalPort).mockReturnValue(Promise.resolve(null));
+  const result = await devserverProxy({ proxy: true });
+  expect(result.proxy).toHaveLength(1);
+  expect(result.proxy[0].target).toBeUndefined();
+});
+
 test("Proxy boolean false", async () => {
   const proxy = false;
   expect(await devserverProxy({ proxy })).toStrictEqual({ proxy: [] });
@@ -216,7 +152,6 @@ test("onProxyRes Handler", async () => {
   );
 });
 
-
 test("onProxyRes Handler passthrough", async () => {
   const config = { proxy: "http://localhost:3000" };
   const result = await devserverProxy(config);
@@ -224,9 +159,9 @@ test("onProxyRes Handler passthrough", async () => {
 
   const mockProxyRes = new EventEmitter();
   mockProxyRes.statusCode = 200;
-  mockProxyRes.statusMessage = "OK";
   mockProxyRes.headers = {
     "content-type": "nope/nope",
+    "x-num": 42,
   };
   const mockReq = {
     headers: { host: "example.com" },
@@ -255,124 +190,19 @@ test("onProxyRes Handler passthrough", async () => {
   );
 });
 
+test("onProxyReqWs handler", async () => {
+  const result = await devserverProxy({ proxy: "http://example.com" });
+  const onProxyReqWs = result.proxy[0].onProxyReqWs;
+
+  const socket = new EventEmitter();
+  const errSpy = vi.spyOn(console, "error");
 
+  onProxyReqWs(null, null, socket, null, null);
+  socket.emit("error", { code: "EPIPE" });
+  expect(errSpy).not.toHaveBeenCalled();
 
-// test("test proxy's onProxyRes handler", async () => {
-//   let proxy = "https://example.com";
-//   const logSpy = jest.spyOn(console, "log");
-//   const actual = await devserverProxy({ proxy });
-
-//   const route = actual.proxy["**"];
-//   const mockProxyRes = fs.createReadStream(new URL(import.meta.url));
-
-//   mockProxyRes.headers = {
-//     headerKey: "value",
-//     host: "example.com",
-//     "content-type": "text/html; charset=utf-8",
-//   };
-//   mockProxyRes.statusCode = "statusCode";
-//   mockProxyRes.statusMessage = "statusMessage";
-
-//   const events = {};
-//   jest.spyOn(mockProxyRes, "on").mockImplementation((event, handler) => {
-//     events[event] = handler;
-//     return mockProxyRes;
-//   });
-
-//   const setHeader = jest.fn();
-//   const end = jest.fn();
-
-//   const res = { setHeader, end };
-//   const req = {
-//     headers: { host: "req.headers.host" },
-//     path: "path",
-//   };
-
-//   route.onProxyRes(mockProxyRes, req, res);
-//   events.data(Buffer.from("A string with 28 characters."));
-//   events.end();
-
-//   expect(res.statusCode).toBe(mockProxyRes.statusCode);
-//   expect(res.statusMessage).toBe(mockProxyRes.statusMessage);
-//   expect(req.headers.host).toBe("req.headers.host");
-//   expect(setHeader).toHaveBeenLastCalledWith("Content-Length", 28);
-// });
-
-// test("test proxy's onProxyRes handler onEnd passthrough", async () => {
-//   let proxy = "https://example.com";
-//   // const logSpy = jest.spyOn(console, "log");
-//   const actual = await devserverProxy({ proxy });
-
-//   const route = actual.proxy["**"];
-//   const mockProxyRes = fs.createReadStream(new URL(import.meta.url));
-
-//   console.log("hello");
-//   mockProxyRes.headers = {
-//     headerKey: "value",
-//     host: "example.com",
-//     "Content-Length": 123,
-//   };
-
-//   const events = {};
-//   jest.spyOn(mockProxyRes, "on").mockImplementation((event, handler) => {
-//     events[event] = handler;
-//     return mockProxyRes;
-//   });
-
-//   const setHeader = jest.fn();
-//   const end = jest.fn();
-
-//   const res = { setHeader, end };
-//   const req = {
-//     headers: { host: "req.headers.host" },
-//     path: "/wp-admin/fake.css",
-//   };
-
-//   route.onProxyRes(mockProxyRes, req, res);
-//   events.end();
-
-//   expect(end).toHaveBeenCalled();
-// });
-
-// test("proxy should rewrite http:// and http:\\/\\/", async () => {
-//   let proxy = "wordpress";
-
-//   const logSpy = jest.spyOn(console, "log");
-//   const actual = await devserverProxy({ proxy });
-//   const route = actual.proxy["**"];
-//   const mockProxyRes = fs.createReadStream(new URL(import.meta.url));
-
-//   mockProxyRes.headers = {
-//     headerKey: "value",
-//     host: "example.com",
-//     "content-type": "text/html; charset=utf-8",
-//   };
-
-//   const events = {};
-//   jest.spyOn(mockProxyRes, "on").mockImplementation((event, handler) => {
-//     events[event] = handler;
-//     return mockProxyRes;
-//   });
-
-//   const setHeader = jest.fn();
-//   const end = jest.fn();
-
-//   const res = { setHeader, end };
-//   const req = {
-//     headers: { host: "req.headers.host" },
-//     path: "path",
-//   };
-
-//   route.onProxyRes(mockProxyRes, req, res);
-//   events.data(Buffer.from("http://11.22.33.44\n"));
-//   events.data(Buffer.from("http:\\/\\/11.22.33.44\n"));
-//   events.end();
-
-//   expect(end.mock.calls[0][0].toString("utf8")).toMatch(
-//     /http:\/\/req.headers.host/
-//   );
-
-//   expect(end.mock.calls[0][0].toString("utf8")).toMatch(
-//     /http:\\\/\\\/req.headers.host/
-//   );
-// });
+  socket.emit("error", { code: "OTHER" });
+  expect(errSpy).toHaveBeenCalledWith("WebSocket proxy error:", {
+    code: "OTHER",
+  });
+});

package/test/fixtures/format-wp-block-pattern/nested-list.php

@@ -1,3 +1,9 @@
+<?php
+/**
+ * Title: Nested List Test
+ */
+?>
+
 <!-- wp:list -->
 <ul class="wp-block-list"><!-- wp:list-item -->
 <li>   UL Item 1  </li>

package/test/fixtures/format-wp-block-pattern/nested-list__formatted.php

@@ -1,3 +1,9 @@
+<?php
+/**
+ * Title: Nested List Test
+ */
+?>
+
 <!-- wp:list -->
 <ul class="wp-block-list">
 

package/test/fixtures/format-wp-block-pattern/paragraph-whitespace.php

@@ -0,0 +1,14 @@
+<?php
+/**
+ * Title: Paragraph Whitespace Test
+ */
+?>
+
+<!-- wp:paragraph -->
+  <p>
+    There are four button styles. Default, Primary, Secondary and Text. Each
+    style can include an icon which can be positioned on either side by changing
+    the button's text-alignment. Button colors can be customized by selecting
+    different Text and Background colors.
+  </p>
+<!-- /wp:paragraph -->

package/test/fixtures/format-wp-block-pattern/paragraph-whitespace__formatted.php

@@ -0,0 +1,9 @@
+<?php
+/**
+ * Title: Paragraph Whitespace Test
+ */
+?>
+
+<!-- wp:paragraph -->
+<p>There are four button styles. Default, Primary, Secondary and Text. Each style can include an icon which can be positioned on either side by changing the button's text-alignment. Button colors can be customized by selecting different Text and Background colors.</p>
+<!-- /wp:paragraph -->

package/test/format-wp-block-pattern.test.js

@@ -1,6 +1,13 @@
 //@ts-check
 
-import { describe, expect, test } from "vitest";
+import { describe, expect, test, vi } from "vitest";
+import prettier from "prettier";
+
+vi.mock("prettier", () => ({
+  default: {
+    format: vi.fn().mockResolvedValue("<formatted/>"),
+  },
+}));
 
 import { readFile } from "node:fs/promises";
 
@@ -9,6 +16,11 @@ import {
   formatAllWpComments,
   normalizeCommentTagSpacing,
   trimInsideListElements,
+  normalizeNewlines,
+  trimInsideHeadings,
+  formatWithPrettier,
+  formatWPBlockPattern,
+  main,
 } from "../bin/format-wp-block-pattern.js";
 
 describe("Format JSON in WP Block comments", () => {
@@ -106,15 +118,62 @@ describe("Normalize whitespace", () => {
       await readFile("./test/fixtures/format-wp-block-pattern/nested-list.php")
     ).toString();
 
-        const expected = (
-      await readFile("./test/fixtures/format-wp-block-pattern/nested-list__formatted.php")
+    const expected = (
+      await readFile(
+        "./test/fixtures/format-wp-block-pattern/nested-list__formatted.php",
+      )
     ).toString();
 
     const actual = trimInsideListElements(input);
-        expect(actual).toMatch(/<li>UL/);
+    expect(actual).toMatch(/<li>UL/);
+
+    expect(actual).toBe(expected);
+  });
+
+  test("Whitespace handling in paragraphs", async () => {
+    const input = (
+      await readFile(
+        "./test/fixtures/format-wp-block-pattern/paragraph-whitespace.php",
+      )
+    ).toString();
+
+    const expected = (
+      await readFile(
+        "./test/fixtures/format-wp-block-pattern/paragraph-whitespace__formatted.php",
+      )
+    ).toString();
+
+    const actual = normalizeCommentTagSpacing(input);
+    expect(actual).toBe(expected);
+  });
+
+  test("normalizeNewlines for coverage", async () => {
+    const input = "Line 1\nLine 2\n \n \n\n\n\nLine 3\nLine 4";
+    const expected = "Line 1\nLine 2\n\nLine 3\nLine 4\n";
+
+    const actual = normalizeNewlines(input);
+    expect(actual).toBe(expected);
+  });
 
+  test("trimInsideHeadings for coverage", async () => {
+    const input = "<h2>   Heading with extra spaces   </h2>";
+    const expected = "<h2>Heading with extra spaces</h2>";
+
+    const actual = trimInsideHeadings(input);
     expect(actual).toBe(expected);
   });
+
+  test("formatWithPrettier for coverage", async () => {
+    const input = "<div>foo</div>";
+    await formatWithPrettier(input);
+    expect(prettier.format).toHaveBeenCalled();
+  });
+
+  test("main requires filepath", async () => {
+    const spy = vi.spyOn(console, "error").mockImplementation(() => {});
+    await main();
+    expect(spy).toHaveBeenCalled();
+    spy.mockRestore();
+  });
 });
 
-// {"align":"full","className":"group-name"}