Merge pull request #586 from marle3003/develop

Develop

Author: marle3003

go.mod

@@ -12,7 +12,7 @@ require (
 	github.com/evanw/esbuild v0.25.5
 	github.com/fsnotify/fsnotify v1.9.0
 	github.com/go-co-op/gocron v1.37.0
-	github.com/go-git/go-git/v5 v5.16.1
+	github.com/go-git/go-git/v5 v5.16.2
 	github.com/google/uuid v1.6.0
 	github.com/jinzhu/inflection v1.0.0
 	github.com/pkg/errors v0.9.1

go.sum

@@ -54,8 +54,8 @@ github.com/go-git/go-billy/v5 v5.6.2 h1:6Q86EsPXMa7c3YZ3aLAQsMA0VlWmy43r6FHqa/UN
 github.com/go-git/go-billy/v5 v5.6.2/go.mod h1:rcFC2rAsp/erv7CMz9GczHcuD0D32fWzH+MJAU+jaUU=
 github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399 h1:eMje31YglSBqCdIqdhKBW8lokaMrL3uTkpGYlE2OOT4=
 github.com/go-git/go-git-fixtures/v4 v4.3.2-0.20231010084843-55a94097c399/go.mod h1:1OCfN199q1Jm3HZlxleg+Dw/mwps2Wbk9frAWm+4FII=
-github.com/go-git/go-git/v5 v5.16.1 h1:TuxMBWNL7R05tXsUGi0kh1vi4tq0WfXNLlIrAkXG1k8=
-github.com/go-git/go-git/v5 v5.16.1/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8=
+github.com/go-git/go-git/v5 v5.16.2 h1:fT6ZIOjE5iEnkzKyxTHK1W4HGAsPhqEqiSAssSO77hM=
+github.com/go-git/go-git/v5 v5.16.2/go.mod h1:4Ge4alE/5gPs30F2H1esi2gPd69R0C39lolkucHBOp8=
 github.com/go-sourcemap/sourcemap v2.1.3+incompatible h1:W1iEw64niKVGogNgBN3ePyLFfuisuzeidWPMPWmECqU=
 github.com/go-sourcemap/sourcemap v2.1.3+incompatible/go.mod h1:F8jJfvm2KbVjc5NqelyYJmf/v5J0dwNLS2mL4sNA1Jg=
 github.com/golang-jwt/jwt/v4 v4.5.2 h1:YtQM7lnr8iZ+j5q71MGKkNw9Mn7AjHM68uc9g5fXeUI=

js/mokapi/cron.go

@@ -8,13 +8,27 @@ import (
 	"reflect"
 )
 
-func (m *Module) Cron(expr string, do func(), args goja.Value) (int, error) {
+func (m *Module) Cron(expr string, do goja.Value, args goja.Value) (int, error) {
 	options, err := getJobOptions(m.vm, args)
 	if err != nil {
 		panic(m.vm.ToValue(err.Error()))
 	}
 
-	return m.host.Cron(expr, do, options)
+	f := func() {
+		_, err := m.loop.RunAsync(func(vm *goja.Runtime) (goja.Value, error) {
+			call, _ := goja.AssertFunction(do)
+			v, err := call(goja.Undefined())
+			if err != nil {
+				return nil, err
+			}
+			return v, nil
+		})
+		if err != nil {
+			panic(m.vm.ToValue(err.Error()))
+		}
+	}
+
+	return m.host.Cron(expr, f, options)
 }
 
 func getJobOptions(vm *goja.Runtime, opt goja.Value) (common.JobOptions, error) {

js/mokapi/cron_test.go

@@ -146,6 +146,37 @@ func TestModule_Cron(t *testing.T) {
 				r.EqualError(t, err, "unexpected type for skipImmediateFirstRun: String at mokapi/js/mokapi.(*Module).Cron-fm (native)")
 			},
 		},
+		{
+			name: "async handler",
+			test: func(t *testing.T, vm *goja.Runtime, host *enginetest.Host) {
+				var f func()
+				host.CronFunc = func(cron string, do func(), opt common.JobOptions) {
+					f = do
+				}
+
+				_, err := vm.RunString(`
+					const m = require('mokapi')
+					let result;
+					m.cron('', async () => {
+						result = await getMessage();
+					})
+
+					let getMessage = async () => {
+						return new Promise(async (resolve, reject) => {
+						  setTimeout(() => {
+							resolve('foo');
+						  }, 200);
+						});
+					}
+				`)
+				r.NoError(t, err)
+				f()
+				r.NoError(t, err)
+				v, err := vm.RunString("result")
+				r.NoError(t, err)
+				r.Equal(t, "foo", v.Export())
+			},
+		},
 	}
 
 	t.Parallel()

js/mokapi/every.go

@@ -4,11 +4,25 @@ import (
 	"github.com/dop251/goja"
 )
 
-func (m *Module) Every(every string, do func(), args goja.Value) (int, error) {
+func (m *Module) Every(every string, do goja.Value, args goja.Value) (int, error) {
 	options, err := getJobOptions(m.vm, args)
 	if err != nil {
 		panic(m.vm.ToValue(err.Error()))
 	}
 
-	return m.host.Every(every, do, options)
+	f := func() {
+		_, err := m.loop.RunAsync(func(vm *goja.Runtime) (goja.Value, error) {
+			call, _ := goja.AssertFunction(do)
+			v, err := call(goja.Undefined())
+			if err != nil {
+				return nil, err
+			}
+			return v, nil
+		})
+		if err != nil {
+			panic(m.vm.ToValue(err.Error()))
+		}
+	}
+
+	return m.host.Every(every, f, options)
 }

js/mokapi/every_test.go

@@ -146,6 +146,37 @@ func TestModule_Every(t *testing.T) {
 				r.EqualError(t, err, "unexpected type for skipImmediateFirstRun: String at mokapi/js/mokapi.(*Module).Every-fm (native)")
 			},
 		},
+		{
+			name: "async handler",
+			test: func(t *testing.T, vm *goja.Runtime, host *enginetest.Host) {
+				var f func()
+				host.EveryFunc = func(every string, do func(), opt common.JobOptions) {
+					f = do
+				}
+
+				_, err := vm.RunString(`
+					const m = require('mokapi')
+					let result;
+					m.every('1m', async () => {
+						result = await getMessage();
+					})
+
+					let getMessage = async () => {
+						return new Promise(async (resolve, reject) => {
+						  setTimeout(() => {
+							resolve('foo');
+						  }, 200);
+						});
+					}
+				`)
+				r.NoError(t, err)
+				f()
+				r.NoError(t, err)
+				v, err := vm.RunString("result")
+				r.NoError(t, err)
+				r.Equal(t, "foo", v.Export())
+			},
+		},
 	}
 
 	t.Parallel()

js/mokapi/on_test.go

@@ -146,7 +146,6 @@ func TestModule_On(t *testing.T) {
 					const m = require('mokapi')
 					m.on('http', async (p) => {
 						p.msg = await getMessage();
-						return true;
 					})
 
 					let getMessage = async () => {

js/script_mokapi_test.go

@@ -178,26 +178,6 @@ func TestScript_Mokapi_Every(t *testing.T) {
 				r.NoError(t, err)
 			},
 		},
-		{
-			name: "run function",
-			test: func(t *testing.T, host *enginetest.Host) {
-				host.EveryFunc = func(every string, do func(), opt common.JobOptions) {
-					do()
-				}
-				s, err := jstest.New(jstest.WithSource(
-					`import { every } from 'mokapi'
-						 export default function() {
-							let counter = 1
-						  	every('1s', function() {counter++}, {tags: {foo: 'bar'}})
-							return counter
-						 }`),
-					js.WithHost(host))
-				r.NoError(t, err)
-				v, err := s.RunDefault()
-				r.NoError(t, err)
-				r.Equal(t, int64(2), v.ToInteger())
-			},
-		},
 	}
 
 	t.Parallel()
@@ -297,26 +277,6 @@ func TestScript_Mokapi_Cron(t *testing.T) {
 				r.NoError(t, err)
 			},
 		},
-		{
-			name: "run function",
-			test: func(t *testing.T, host *enginetest.Host) {
-				host.CronFunc = func(every string, do func(), opt common.JobOptions) {
-					do()
-				}
-				s, err := jstest.New(jstest.WithSource(
-					`import { cron } from 'mokapi'
-						 export default function() {
-							let counter = 1
-						  	cron('0/1 0 0 ? * * *', function() {counter++}, {tags: {foo: 'bar'}})
-							return counter
-						 }`),
-					js.WithHost(host))
-				r.NoError(t, err)
-				v, err := s.RunDefault()
-				r.NoError(t, err)
-				r.Equal(t, int64(2), v.ToInteger())
-			},
-		},
 	}
 
 	t.Parallel()

npm/types/faker.d.ts

@@ -36,7 +36,7 @@ export function findByName(name: string): Node;
 /**
  * The name of the root node in the faker tree.
  */
-export const Root_Name = "root";
+export const ROOT_NAME = "root";
 
 /**
  * Represents a node in the faker tree.
@@ -63,7 +63,54 @@ export interface Node {
     /**
      * The child nodes of this node.
      */
-    children: Node[];
+    children: Array<Node | AddNode>;
+
+    /**
+     * Generates a fake value based on the given request.
+     *
+     * @param r r - The request describing the value to generate.
+     * @returns A generated fake value.
+     *
+     * @example
+     * export default function() {
+     *   const frequencyItems = ['never', 'daily', 'weekly', 'monthly', 'yearly']
+     *   const node = findByName(ROOT_NAME)
+     *   node.children.unshift({
+     *     name: 'Frequency',
+     *     attributes: [ 'frequency' ]
+     *     fake: (r) => {
+     *       return frequencyItems[Math.floor(Math.random()*frequencyItems.length)]
+     *     }
+     *   })
+     *   console.log(fake({ properties: { frequency } }))
+     *   // Expected output: an object with a frequency attribute containing a random value of frequency
+     * }
+     */
+    fake: (r: Request) => any;
+}
+
+export interface AddNode {
+    /**
+     * The unique name of the node.
+     */
+    name: string;
+
+    /**
+     * Attributes associated with this node.
+     * These will be used for matching path or schema properties.
+     */
+    attributes?: string[];
+
+    /**
+     * A weight that determines how likely this node is to be selected,
+     * if multiple nodes match.
+     */
+    weight?: number;
+
+    /**
+     * The child nodes of this node.
+     */
+    children?: Array<Node | AddNode>;
 
     /**
      * Generates a fake value based on the given request.

npm/types/index.d.ts

@@ -108,10 +108,6 @@ export interface EventHandler {
     smtp: SmtpEventHandler;
 }
 
-export type ChangeResult = boolean | undefined;
-
-export type EventHandlerResult = ChangeResult | Promise<ChangeResult>;
-
 /**
  * HttpEventHandler is a function that is executed when an HTTP event is triggered.
  * https://mokapi.io/docs/javascript-api/mokapi/eventhandler/httpeventhandler
@@ -126,7 +122,7 @@ export type EventHandlerResult = ChangeResult | Promise<ChangeResult>;
  *   })
  * }
  */
-export type HttpEventHandler = (request: HttpRequest, response: HttpResponse) => EventHandlerResult;
+export type HttpEventHandler = (request: HttpRequest, response: HttpResponse) => void;
 
 /**
  * HttpRequest is an object used by HttpEventHandler that contains request-specific
@@ -208,7 +204,7 @@ export interface Url {
  *   })
  * }
  */
-export type KafkaEventHandler = (message: KafkaEventMessage) => EventHandlerResult;
+export type KafkaEventHandler = (message: KafkaEventMessage) => void;
 
 /**
  * KafkaEventMessage is an object used by KafkaEventHandler that contains Kafka-specific message data.
@@ -247,7 +243,7 @@ export interface KafkaEventMessage {
  *   })
  * }
  */
-export type LdapEventHandler = (request: LdapSearchRequest, response: LdapSearchResponse) => EventHandlerResult;
+export type LdapEventHandler = (request: LdapSearchRequest, response: LdapSearchResponse) => void;
 
 /**
  * LdapSearchRequest is an object used by LdapEventHandler that contains request-specific data.
@@ -347,7 +343,7 @@ export enum LdapResultStatus {
     SizeLimitExceeded = 4,
 }
 
-export type SmtpEventHandler = (record: SmtpEventMessage) => EventHandlerResult;
+export type SmtpEventHandler = (record: SmtpEventMessage) => void;
 
 export interface SmtpEventMessage {
     server: string;
@@ -460,4 +456,57 @@ export interface JSONObject {
     [key: string]: JSONValue;
 }
 
-export const RFC3339 = "RFC3339";
+/**
+ * Specifies the date-time format defined in [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339).
+ * This constant can be used when defining or validating datetime strings.
+ *
+ * @example
+ * const date = new Date().toISOString()
+ * if (isValidDate(date, RFC3339)) {
+ *   // do something
+ * }
+ */
+export const RFC3339 = "RFC3339";
+
+/**
+ * Applies a patch object to a target object. Only properties that are explicitly defined in the patch
+ * are applied. This includes nested objects. Properties marked with `Delete` will be removed.
+ *
+ * This function is especially useful when working with generated mock data in Mokapi that you want to override
+ * or refine with specific values.
+ *
+ * https://mokapi.io/docs/javascript-api/mokapi/patch
+ *
+ * @param target The original object or value to be patched.
+ * @param patch The patch object or value. Only defined values are applied; undefined values are ignored. Use `Delete` to remove fields.
+ * @returns A new object or value with the patch applied.
+ *
+ * @example
+ * const result = patch({ name: "foo", age: 42 }, { name: "bar" })
+ * // result: { name: "bar", age: 42 }
+ *
+ * @example
+ * const result = patch({ name: "foo", meta: { version: 1 } }, { meta: { version: 2 } })
+ * // result: { name: "foo", meta: { version: 2 } }
+ *
+ * @example
+ * const result = patch({ name: "foo", age: 42 }, { age: Delete })
+ * // result: { name: "foo" }
+ */
+export function patch(target: any, patch: any): any;
+
+/**
+ * Special marker used with the `patch` function to indicate a property should be removed.
+ *
+ * When used as a value inside a patch object, the corresponding property will be deleted
+ * from the result.
+ *
+ * This is useful when refining or overriding mock data in a script while keeping validation logic intact.
+ *
+ * https://mokapi.io/docs/javascript-api/mokapi/patch#delete
+ *
+ * @example
+ * const result = patch({ name: "foo", age: 42 }, { age: Delete })
+ * // result: { name: "foo" }
+ */
+export const Delete: unique symbol;