Merge pull request #854 from marle3003/develop

Develop

Author: marle3003

.github/workflows/release.yml

@@ -138,6 +138,7 @@ jobs:
           node-version: 23
           registry-url: 'https://registry.npmjs.org'
       - run: npm install
+        working-directory: ./webui
       - name: Install taskfile
         run: sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
       - name: Publish

.gitignore

@@ -17,6 +17,8 @@
 data/*
 dist/
 bin/*
+obj/
+Debug/
 
 node_modules
 

acceptance/petstore_test.go

@@ -293,12 +293,16 @@ func (suite *PetStoreSuite) TestEvents() {
 		try.AssertBody(func(t *testing.T, body string) {
 			var data map[string]any
 			err := json.Unmarshal([]byte(body), &data)
-			require.NoError(t, err)
+			assert.NoError(t, err)
 			results := data["results"].([]any)
-			evt := results[0].(map[string]any)
-			require.Equal(t, "Event", evt["type"])
-			require.Equal(t, "GET http://127.0.0.1:18080/user/bob", evt["title"])
-			require.Equal(t, "Swagger Petstore", evt["domain"])
+			assert.NotNil(t, results, "search result should contain results")
+			assert.Greater(t, len(results), 0)
+			evt, ok := results[0].(map[string]any)
+			assert.True(t, ok, "event should be a map[string]any")
+			assert.NotNil(t, evt)
+			assert.Equal(t, "Event", evt["type"])
+			assert.Equal(t, "GET http://127.0.0.1:18080/user/bob", evt["title"])
+			assert.Equal(t, "Swagger Petstore", evt["domain"])
 		}),
 	)
 }

api/handler_search_test.go

@@ -1,6 +1,7 @@
 package api
 
 import (
+	"context"
 	"encoding/json"
 	"mokapi/config/dynamic"
 	"mokapi/config/dynamic/asyncApi/asyncapitest"
@@ -10,6 +11,7 @@ import (
 	"mokapi/providers/openapi/openapitest"
 	"mokapi/runtime"
 	"mokapi/runtime/search"
+	"mokapi/safe"
 	"mokapi/try"
 	"net/http"
 	"testing"
@@ -43,7 +45,8 @@ func TestHandler_SearchQuery(t *testing.T) {
 			},
 			app: func() *runtime.App {
 				app := runtime.New(&static.Config{Api: static.Api{Search: static.Search{
-					Enabled: true,
+					Enabled:  true,
+					InMemory: true,
 				}}})
 
 				cfg := openapitest.NewConfig("3.0", openapitest.WithInfo("foo", "", ""))
@@ -62,7 +65,8 @@ func TestHandler_SearchQuery(t *testing.T) {
 			},
 			app: func() *runtime.App {
 				app := runtime.New(&static.Config{Api: static.Api{Search: static.Search{
-					Enabled: true,
+					Enabled:  true,
+					InMemory: true,
 				}}})
 
 				cfg := openapitest.NewConfig("3.0", openapitest.WithInfo("foo", "", ""))
@@ -81,7 +85,8 @@ func TestHandler_SearchQuery(t *testing.T) {
 			},
 			app: func() *runtime.App {
 				app := runtime.New(&static.Config{Api: static.Api{Search: static.Search{
-					Enabled: true,
+					Enabled:  true,
+					InMemory: true,
 				}}})
 
 				cfg := openapitest.NewConfig("3.0", openapitest.WithInfo("foo", "", ""))
@@ -102,7 +107,8 @@ func TestHandler_SearchQuery(t *testing.T) {
 			},
 			app: func() *runtime.App {
 				app := runtime.New(&static.Config{Api: static.Api{Search: static.Search{
-					Enabled: true,
+					Enabled:  true,
+					InMemory: true,
 				}}})
 
 				cfg := openapitest.NewConfig("3.0", openapitest.WithInfo("foo", "", ""))
@@ -131,7 +137,8 @@ func TestHandler_SearchQuery(t *testing.T) {
 			},
 			app: func() *runtime.App {
 				app := runtime.New(&static.Config{Api: static.Api{Search: static.Search{
-					Enabled: true,
+					Enabled:  true,
+					InMemory: true,
 				}}})
 
 				h := openapitest.NewConfig("3.0", openapitest.WithInfo("foo", "", ""))
@@ -160,7 +167,8 @@ func TestHandler_SearchQuery(t *testing.T) {
 			},
 			app: func() *runtime.App {
 				app := runtime.New(&static.Config{Api: static.Api{Search: static.Search{
-					Enabled: true,
+					Enabled:  true,
+					InMemory: true,
 				}}})
 
 				h := openapitest.NewConfig("3.0", openapitest.WithInfo("foo", "", ""))
@@ -180,7 +188,12 @@ func TestHandler_SearchQuery(t *testing.T) {
 		t.Run(tc.name, func(t *testing.T) {
 			t.Parallel()
 
-			h := New(tc.app(), static.Api{})
+			app := tc.app()
+			pool := safe.NewPool(context.Background())
+			app.Start(pool)
+			defer pool.Stop()
+
+			h := New(app, static.Api{})
 
 			try.Handler(t,
 				http.MethodGet,

api/handler_test.go

@@ -196,7 +196,7 @@ func TestHandler_NoDashboard(t *testing.T) {
 }
 
 func TestHandler_SearchEnabled(t *testing.T) {
-	h := api.New(runtime.New(&static.Config{}), static.Api{Dashboard: true, Search: static.Search{Enabled: true}})
+	h := api.New(runtime.New(&static.Config{}), static.Api{Dashboard: true, Search: static.Search{Enabled: true, InMemory: true}})
 	try.Handler(t,
 		http.MethodGet,
 		"http://foo.api/api/info",

cmd/mokapi/main_test.go

@@ -82,6 +82,8 @@ api:
     dashboard: true
     search:
         enabled: true
+        indexPath: ""
+        inMemory: false
 rootCaCert: ""
 rootCaKey: ""
 configs: []

config/static/static_config.go

@@ -66,7 +66,9 @@ type Api struct {
 }
 
 type Search struct {
-	Enabled bool
+	Enabled   bool
+	IndexPath string `yaml:"indexPath" json:"indexPath" flag:"index-path"`
+	InMemory  bool   `yaml:"inMemory" json:"inMemory" flag:"in-memory"`
 }
 
 type FileProvider struct {

docs/config.json

@@ -588,9 +588,9 @@
         },
         "items": [
           {
-            "label": "Ensuring API Contract Compliance with Mokapi",
+            "label": "Guard Your API Contracts: Catch Breaking Changes Before Production",
             "source": "resources/blogs/ensuring-api-contract-compliance-with-mokapi.md",
-            "path": "/resources/blogs/ensuring-api-contract-compliance-with-mokapi",
+            "path": "/resources/blogs/guard-your-api-contracts",
             "hideNavigation": true
           },
           {

docs/javascript-api/mokapi/eventhandler/eventargs.md

@@ -8,12 +8,34 @@ description: EventArgs is an object used to configure event handlers registered
 [`on`](/docs/javascript-api/mokapi/on.md) function when registering an event handler.
 It allows controlling how and when an event handler is executed.
 
-| Name     | Type    | Description                                                                                            |
-|----------|---------|--------------------------------------------------------------------------------------------------------|
-| tags     | object  | Adds or overrides existing tags that are used in dashboard                                             |
-| priority | integer | Defines the execution priority of the event handler. Handlers with a higher value are executed first.  |
-
-If no priority is specified, the default priority is `0`.
+<div class="table-responsive-sm">
+<table>
+  <thead>
+    <tr>
+      <th scope="col" class="col-2">Name</th>
+      <th scope="col" class="col-2">Type</th>
+      <th scope="col" class="col">Description</th>
+    </tr>
+  </thead>
+  <tbody>
+    <tr>
+      <td>tags</td>
+      <td><code>object</code></td>
+      <td>Adds or overrides existing tags that are used in dashboard.</td>
+    </tr>
+    <tr>
+      <td>track</td>
+      <td><code>boolean | <br />(params) => boolean</code></td>
+      <td>Controls whether this event handler is tracked in the dashboard.</td>
+    </tr>
+    <tr>
+      <td>priority</td>
+      <td><code>integer</code></td>
+      <td>Defines the execution priority of the event handler. Handlers with a higher value are executed first. If no priority is specified, the default priority is <code>0</code>.</td>
+    </tr>
+  </tbody>
+</table>
+</div>
 
 ## Example: Adding custom tags
 
@@ -29,6 +51,62 @@ export default function() {
 }
 ```
 
+## Example: Controlling whether an event handler is tracked in the dashboard
+
+The track field controls whether executions of an event handler appear in the dashboard.
+
+It supports two modes:
+- true / false — always track or never track 
+- a function — decide dynamically per request
+
+### Static tracking
+
+```javascript
+on('http', handler, { track: true })
+```
+
+### Dynamic tracking (function)
+
+```javascript
+on('http', handler, {
+    track: (request, response) => request.key !== '/health'
+})
+```
+
+### Full example: Delay simulation with tracking
+
+```javascript
+import { on, sleep } from 'mokapi'
+
+export default () => {
+    let delay = undefined
+    
+    on('http', (request, response) => {
+        if (request.key === '/simulations/delay') {
+            switch (request.method) {
+                case 'PUT': 
+                    delay = request.query.duration;
+                    break;
+                case 'DELETE':
+                    delay = undefined;
+                    break;
+            }
+        }
+    }, { track: true })
+    on('http', (request, response) => {
+        if (!delay) {
+            sleep(delay);
+        }
+    }, { track: () => delay !== undefined } )
+}
+```
+
+#### Explanation
+- The first handler exposes a control endpoint to configure the delay. 
+  - track: true ensures all configuration changes are visible in the dashboard. 
+- The second handler applies the delay to incoming requests. 
+  - Tracking is enabled only while a delay is active, keeping the dashboard clean when no simulation is running.
+
 ## Example: Controlling execution order with priority
 
 When multiple handlers are registered for the same event, the priority