feat(tests): add weather service and API mocking with Playwright

Apply automatic changes

chore: bump biome 1.9.4

Author: jellydn

.gitignore

@@ -69,3 +69,5 @@ dist
 # Envrc file
 .envrc
 generated/sdk
+playwright-report
+test-results

.pre-commit-config.yaml

@@ -6,7 +6,7 @@ repos:
         # Those are not supported by biomejs yet, refer https://biomejs.dev/internals/language-support/
         types_or: [html, css, markdown]
   - repo: https://github.com/biomejs/pre-commit
-    rev: "v0.1.0" # Use the sha / tag you want to point at
+    rev: "v0.6.1" # Use the sha / tag you want to point at
     hooks:
       - id: biome-check
-        additional_dependencies: ["@biomejs/biome@1.6.3"]
+        additional_dependencies: ["@biomejs/biome@1.9.4"]

README.md

@@ -18,7 +18,7 @@
 
 ## Prerequisites
 
-- node >= 18.17.x
+-   node >= 18.17.x
 
 ## Init new project
 
@@ -28,14 +28,14 @@ npx degit jellydn/moleculer-typescript-template [PROJECT-NAME]
 
 ## Features
 
-- ⚡️ Progressive microservices framework for Node.js.
-  [Moleculer](https://moleculer.services/) with [Typescript](https://www.typescriptlang.org/) template
-- 📦 [hygen](http://www.hygen.io/) - The scalable code generator that saves you time.
-- 🦾 [pino](https://getpino.io) - super fast, all natural json logger
-- 🔥 [swagger-jsdoc](https://github.com/Surnet/swagger-jsdoc/blob/v6/docs/README.md) - Generates swagger/openapi specification based on jsDoc comments and YAML files.
-- ✨ [moleculer-zod-validator](https://github.com/TheAppleFreak/moleculer-zod-validator) - A validator for the Moleculer microservice framework to allow the use of [Zod](https://zod.dev/).
-- 🔏 [asteasolutions/zod-to-openapi](https://github.com/asteasolutions/zod-to-openapi#defining-schemas) - A library that generates OpenAPI (Swagger) docs from Zod schemas.
-- 🪄 [hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) - Turn your OpenAPI specification into a beautiful TypeScript client.
+-   ⚡️ Progressive microservices framework for Node.js.
+    [Moleculer](https://moleculer.services/) with [Typescript](https://www.typescriptlang.org/) template
+-   📦 [hygen](http://www.hygen.io/) - The scalable code generator that saves you time.
+-   🦾 [pino](https://getpino.io) - super fast, all natural json logger
+-   🔥 [swagger-jsdoc](https://github.com/Surnet/swagger-jsdoc/blob/v6/docs/README.md) - Generates swagger/openapi specification based on jsDoc comments and YAML files.
+-   ✨ [moleculer-zod-validator](https://github.com/TheAppleFreak/moleculer-zod-validator) - A validator for the Moleculer microservice framework to allow the use of [Zod](https://zod.dev/).
+-   🔏 [asteasolutions/zod-to-openapi](https://github.com/asteasolutions/zod-to-openapi#defining-schemas) - A library that generates OpenAPI (Swagger) docs from Zod schemas.
+-   🪄 [hey-api/openapi-ts](https://github.com/hey-api/openapi-ts) - Turn your OpenAPI specification into a beautiful TypeScript client.
 
 ## Install
 
@@ -63,10 +63,10 @@ pnpm cli --ns api
 
 In the terminal, try the following commands:
 
-- `nodes` - List all connected nodes.
-- `actions` - List all registered service actions.
-- `call greeter.hello` - Call the `greeter.hello` action.
-- `call greeter.welcome --username dunghd` - Call the `greeter.welcome` action with the `username` parameter.
+-   `nodes` - List all connected nodes.
+-   `actions` - List all registered service actions.
+-   `call greeter.hello` - Call the `greeter.hello` action.
+-   `call greeter.welcome --username dunghd` - Call the `greeter.welcome` action with the `username` parameter.
 
 ![https://gyazo.com/3aca1c4e1992ad1c10da8060d7e21a6c.gif](https://gyazo.com/3aca1c4e1992ad1c10da8060d7e21a6c.gif)
 
@@ -122,24 +122,24 @@ This template comes with two GitHub Actions that handle automatically deploying
 
 Prior to your first deployment, you'll need to do a few things:
 
-- [Install Fly](https://fly.io/docs/getting-started/installing-flyctl/)
+-   [Install Fly](https://fly.io/docs/getting-started/installing-flyctl/)
 
-- Sign up and log in to Fly
+-   Sign up and log in to Fly
 
     ```sh
     fly auth signup
     ```
 
-- Create two apps on Fly, one for staging and one for production:
+-   Create two apps on Fly, one for staging and one for production:
 
     ```sh
     fly create moleculer-typescript
     fly create moleculer-typescript-staging
     ```
 
-- Create a new [GitHub Repository](https://repo.new)
+-   Create a new [GitHub Repository](https://repo.new)
 
-- Add a `FLY_API_TOKEN` to your GitHub repo. To do this, go to your user settings on Fly and create a new [token](https://web.fly.io/user/personal_access_tokens/new), then add it to [your repo secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) with the name `FLY_API_TOKEN`.
+-   Add a `FLY_API_TOKEN` to your GitHub repo. To do this, go to your user settings on Fly and create a new [token](https://web.fly.io/user/personal_access_tokens/new), then add it to [your repo secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) with the name `FLY_API_TOKEN`.
 
 Now that every is set up you can commit and push your changes to your repo. Every commit to your `main` branch will trigger a deployment to your production environment, and every commit to your `dev` branch will trigger a deployment to your staging environment.
 
@@ -149,18 +149,18 @@ We use GitHub Actions for continuous integration and deployment. Anything that g
 
 ## Useful links
 
-- Moleculer website: https://moleculer.services/
-- Moleculer Documentation: https://moleculer.services/docs/0.14/
+-   Moleculer website: https://moleculer.services/
+-   Moleculer Documentation: https://moleculer.services/docs/0.14/
 
 ## NPM scripts
 
-- `pnpm dev`: Start development mode (load all services locally with hot-reload & watch)
-- `pnpm start`: Start production mode (set `SERVICES` env variable to load certain services)
-- `pnpm cli`: Start a CLI and connect to production. Don't forget to set production namespace with `--ns` argument in script
-- `pnpm ci`: Run continuous test mode with watching
-- `pnpm test`: Run tests & generate coverage report
-- `pnpm dc:up`: Start the stack with Docker Compose
-- `pnpm dc:down`: Stop the stack with Docker Compose
+-   `pnpm dev`: Start development mode (load all services locally with hot-reload & watch)
+-   `pnpm start`: Start production mode (set `SERVICES` env variable to load certain services)
+-   `pnpm cli`: Start a CLI and connect to production. Don't forget to set production namespace with `--ns` argument in script
+-   `pnpm ci`: Run continuous test mode with watching
+-   `pnpm test`: Run tests & generate coverage report
+-   `pnpm dc:up`: Start the stack with Docker Compose
+-   `pnpm dc:down`: Stop the stack with Docker Compose
 
 ## Pre-commit hooks
 
@@ -180,9 +180,9 @@ pre-commit run --all-files
 
 👤 **Dung Huynh**
 
-- Website: https://productsway.com/
-- Twitter: [@jellydn](https://twitter.com/jellydn)
-- Github: [@jellydn](https://github.com/jellydn)
+-   Website: https://productsway.com/
+-   Twitter: [@jellydn](https://twitter.com/jellydn)
+-   Github: [@jellydn](https://github.com/jellydn)
 
 ## Show your support
 

biome.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://biomejs.dev/schemas/1.8.0/schema.json",
+  "$schema": "https://biomejs.dev/schemas/1.9.4/schema.json",
   "organizeImports": {
     "enabled": true
   },

moleculer.config.ts

@@ -39,21 +39,23 @@ const config: BrokerOptions = {
 
     // Enable/disable logging or use custom logger. More info: https://moleculer.services/docs/0.14/logging.html
     // Available logger types: "Console", "File", "Pino", "Winston", "Bunyan", "debug", "Log4js", "Datadog"
-    logger: {
-        // Note: Change to Console if you want to see the logger output
-        type: "Pino",
-        options: {
-            pino: {
-                // More info: http://getpino.io/#/docs/api?id=options-object
-                options: {
-                    timestamp: stdTimeFunctions.isoTime,
+    logger: [
+        {
+            // Note: Change to Console if you want to see the logger output
+            type: "Pino",
+            options: {
+                pino: {
+                    // More info: http://getpino.io/#/docs/api?id=options-object
+                    options: {
+                        timestamp: stdTimeFunctions.isoTime,
+                    },
                 },
             },
         },
-    },
-    // Default log level for built-in console logger. It can be overwritten in logger options above.
-    // Available values: trace, debug, info, warn, error, fatal
-    logLevel: "info",
+        {
+            type: "Console",
+        },
+    ],
 
     // Define transporter.
     // More info: https://moleculer.services/docs/0.14/networking.html

package.json

@@ -13,9 +13,9 @@
     "start": "npx tsx ./server.ts",
     "cli": "NODE_OPTIONS='--import tsx' moleculer-connect --env --config moleculer.config.ts --transporter NATS",
     "ci": "biome ci .",
-    "test:ci": "vitest --watch",
-    "test": "vitest --run",
-    "test:coverage": "vitest --coverage",
+    "test:ci": "vitest --watch --exclude 'tests/**'",
+    "test": "vitest --run --exclude 'tests/**'",
+    "test:coverage": "vitest --coverage --exclude 'tests/**'",
     "test:ui": "vitest --ui",
     "build": "tsup --env.NODE_ENV production",
     "format": "biome format . --write",
@@ -30,7 +30,10 @@
     "generate:action": "hygen action new --name",
     "generate:swagger": "npx tsx cli.ts",
     "generate:sdk": "openapi-ts",
-    "typecheck": "npm run generate:sdk && tsc -b"
+    "typecheck": "npm run generate:sdk && tsc -b",
+    "test:e2e": "playwright test",
+    "test:e2e:ui": "playwright test --ui",
+    "test:e2e:debug": "DEBUG=pw:* playwright test --debug"
   },
   "dependencies": {
     "@asteasolutions/zod-to-openapi": "7.3.0",
@@ -51,6 +54,7 @@
     "@biomejs/biome": "1.9.4",
     "@flydotio/dockerfile": "0.6.1",
     "@hey-api/openapi-ts": "0.61.2",
+    "@playwright/test": "^1.49.1",
     "@types/express": "5.0.0",
     "@types/jest": "29.5.14",
     "@types/lodash": "4.17.14",
@@ -67,6 +71,7 @@
     "moleculer-connect": "0.2.2",
     "moleculer-io": "2.2.0",
     "moleculer-repl": "0.7.4",
+    "msw": "2.1.0",
     "npm-run-all2": "7.0.2",
     "pino-pretty": "13.0.0",
     "sort-package-json": "2.12.0",

playwright.config.ts

@@ -0,0 +1,35 @@
+import { defineConfig, devices } from "@playwright/test";
+
+export default defineConfig({
+    testDir: "./tests",
+    fullyParallel: true,
+    forbidOnly: !!process.env.CI,
+    retries: process.env.CI ? 2 : 0,
+    workers: process.env.CI ? 1 : undefined,
+    reporter: "html",
+    use: {
+        baseURL: "http://localhost:4567",
+        trace: "on-first-retry",
+    },
+
+    projects: [
+        {
+            name: "chromium",
+            use: { ...devices["Desktop Chrome"] },
+        },
+        {
+            name: "firefox",
+            use: { ...devices["Desktop Firefox"] },
+        },
+        {
+            name: "webkit",
+            use: { ...devices["Desktop Safari"] },
+        },
+    ],
+
+    webServer: {
+        command: "npm run dev",
+        url: "http://localhost:4567",
+        reuseExistingServer: !process.env.CI,
+    },
+});