From c4251bbe4b409b0116a2a6ef99c53ab0ccb8b947 Mon Sep 17 00:00:00 2001 From: Mihail Stoykov Date: Fri, 9 Feb 2024 12:01:10 +0200 Subject: [PATCH] Stabilize k6/experimental/timers into k6/timers Closes #3297 --- cmd/tests/eventloop_test.go | 2 +- examples/experimental/ws.js | 2 +- examples/{experimental => }/timers.js | 2 +- go.mod | 1 - go.sum | 2 - js/jsmodules.go | 45 +++- .../modules/k6}/timers/timers.go | 0 js/modules/k6/timers/timers_test.go | 192 +++++++++++++++++ vendor/github.com/grafana/xk6-timers/LICENSE | 201 ------------------ vendor/modules.txt | 3 - 10 files changed, 230 insertions(+), 220 deletions(-) rename examples/{experimental => }/timers.js (93%) rename {vendor/github.com/grafana/xk6-timers => js/modules/k6}/timers/timers.go (100%) create mode 100644 js/modules/k6/timers/timers_test.go delete mode 100644 vendor/github.com/grafana/xk6-timers/LICENSE diff --git a/cmd/tests/eventloop_test.go b/cmd/tests/eventloop_test.go index 2ba7ddbbbbf..03acebb3e74 100644 --- a/cmd/tests/eventloop_test.go +++ b/cmd/tests/eventloop_test.go @@ -122,7 +122,7 @@ func eventLoopTest(t *testing.T, script []byte, testHandle func(logLines []strin ts := NewGlobalTestState(t) ts.CmdArgs = []string{"k6", "--quiet", "run", "-"} ts.Stdin = bytes.NewBuffer( - append([]byte("import { setTimeout } from 'k6/experimental/timers';\n"), script...), + append([]byte("import { setTimeout } from 'k6/timers';\n"), script...), ) cmd.ExecuteWithGlobalState(ts.GlobalState) diff --git a/examples/experimental/ws.js b/examples/experimental/ws.js index 185db5f44db..b3340e622a1 100644 --- a/examples/experimental/ws.js +++ b/examples/experimental/ws.js @@ -8,7 +8,7 @@ import { clearTimeout, setInterval, clearInterval, -} from "k6/experimental/timers"; +} from "k6/timers"; let chatRoomName = "publicRoom"; // choose your chat room name let sessionDuration = randomIntBetween(5000, 60000); // user session between 5s and 1m diff --git a/examples/experimental/timers.js b/examples/timers.js similarity index 93% rename from examples/experimental/timers.js rename to examples/timers.js index ac072b5ef29..db9d977d8a1 100644 --- a/examples/experimental/timers.js +++ b/examples/timers.js @@ -1,5 +1,5 @@ // based on https://developer.mozilla.org/en-US/docs/Web/API/setTimeout#reasons_for_delays_longer_than_specified -import { setTimeout } from "k6/experimental/timers"; +import { setTimeout } from "k6/timers"; let last = 0; let iterations = 10; diff --git a/go.mod b/go.mod index 0595b147c8f..1bf10922e1c 100644 --- a/go.mod +++ b/go.mod @@ -17,7 +17,6 @@ require ( github.com/grafana/xk6-dashboard v0.7.2 github.com/grafana/xk6-output-prometheus-remote v0.3.1 github.com/grafana/xk6-redis v0.2.0 - github.com/grafana/xk6-timers v0.2.3 github.com/grafana/xk6-webcrypto v0.1.1 github.com/grafana/xk6-websockets v0.2.1 github.com/grpc-ecosystem/go-grpc-middleware v1.4.0 diff --git a/go.sum b/go.sum index b99b6d5bb75..da9573e187d 100644 --- a/go.sum +++ b/go.sum @@ -101,8 +101,6 @@ github.com/grafana/xk6-output-prometheus-remote v0.3.1 h1:X23rQzlJD8dXWB31DkxR4u github.com/grafana/xk6-output-prometheus-remote v0.3.1/go.mod h1:0JLAm4ONsNUlNoxJXAwOCfA6GtDwTPs557OplAvE+3o= github.com/grafana/xk6-redis v0.2.0 h1:iXmAKVlAxafZ/h8ptuXTFhGu63IFsyDI8QjUgWm66BU= github.com/grafana/xk6-redis v0.2.0/go.mod h1:B3PA9PAPJa2/WUfNJCdQwZrbb6D4e6UHIk8dssQbj7w= -github.com/grafana/xk6-timers v0.2.3 h1:uShQZ6T+9fpCc9j8AAuBPRMKNneG/TRtkM1uuwhXH4g= -github.com/grafana/xk6-timers v0.2.3/go.mod h1:QbhJwMBHm9k8ukFm1AtnsoCbeRSngk+8iFaxnKZaKdo= github.com/grafana/xk6-webcrypto v0.1.1 h1:SSGjm3mea8V9AkbqHkzlle+6KOu87gLE2xf9kfM3jlg= github.com/grafana/xk6-webcrypto v0.1.1/go.mod h1:2pyN4Lmf5cK6EH9xnSn2B81k9vpCdBzcklWhZ/dH+18= github.com/grafana/xk6-websockets v0.2.1 h1:99tuI5g9UPTCpGbiEo/9E7VFKQIOvTLq231qoMVef5c= diff --git a/js/jsmodules.go b/js/jsmodules.go index 3e0b1e33b80..ea0da9a58c7 100644 --- a/js/jsmodules.go +++ b/js/jsmodules.go @@ -1,7 +1,10 @@ package js import ( + "sync" + "go.k6.io/k6/ext" + "go.k6.io/k6/js/modules" "go.k6.io/k6/js/modules/k6" "go.k6.io/k6/js/modules/k6/crypto" "go.k6.io/k6/js/modules/k6/crypto/x509" @@ -14,11 +17,11 @@ import ( "go.k6.io/k6/js/modules/k6/html" "go.k6.io/k6/js/modules/k6/http" "go.k6.io/k6/js/modules/k6/metrics" + "go.k6.io/k6/js/modules/k6/timers" "go.k6.io/k6/js/modules/k6/ws" "github.com/grafana/xk6-browser/browser" "github.com/grafana/xk6-redis/redis" - "github.com/grafana/xk6-timers/timers" "github.com/grafana/xk6-webcrypto/webcrypto" expws "github.com/grafana/xk6-websockets/websockets" ) @@ -30,20 +33,23 @@ func getInternalJSModules() map[string]interface{} { "k6/crypto/x509": x509.New(), "k6/data": data.New(), "k6/encoding": encoding.New(), + "k6/timers": timers.New(), "k6/execution": execution.New(), "k6/experimental/redis": redis.New(), "k6/experimental/webcrypto": webcrypto.New(), "k6/experimental/websockets": &expws.RootModule{}, "k6/experimental/grpc": grpc.NewExperimental(), - "k6/experimental/timers": timers.New(), - "k6/experimental/tracing": tracing.New(), - "k6/experimental/browser": browser.New(), - "k6/experimental/fs": fs.New(), - "k6/net/grpc": grpc.New(), - "k6/html": html.New(), - "k6/http": http.New(), - "k6/metrics": metrics.New(), - "k6/ws": ws.New(), + "k6/experimental/timers": newWarnExperimentalModule(timers.New(), + "k6/experimental/timers is now part of the k6 core, please change your imports to use k6/timers instead."+ + " The k6/experimental/timers will be removed in k6 v0.52.0"), + "k6/experimental/tracing": tracing.New(), + "k6/experimental/browser": browser.New(), + "k6/experimental/fs": fs.New(), + "k6/net/grpc": grpc.New(), + "k6/html": html.New(), + "k6/http": http.New(), + "k6/metrics": metrics.New(), + "k6/ws": ws.New(), } } @@ -58,3 +64,22 @@ func getJSModules() map[string]interface{} { return result } + +type warnExperimentalModule struct { + once *sync.Once + msg string + base modules.Module +} + +func newWarnExperimentalModule(base modules.Module, msg string) modules.Module { + return &warnExperimentalModule{ + msg: msg, + base: base, + once: &sync.Once{}, + } +} + +func (w *warnExperimentalModule) NewModuleInstance(vu modules.VU) modules.Instance { + w.once.Do(func() { vu.InitEnv().Logger.Warn(w.msg) }) + return w.base.NewModuleInstance(vu) +} diff --git a/vendor/github.com/grafana/xk6-timers/timers/timers.go b/js/modules/k6/timers/timers.go similarity index 100% rename from vendor/github.com/grafana/xk6-timers/timers/timers.go rename to js/modules/k6/timers/timers.go diff --git a/js/modules/k6/timers/timers_test.go b/js/modules/k6/timers/timers_test.go new file mode 100644 index 00000000000..681270bc0ac --- /dev/null +++ b/js/modules/k6/timers/timers_test.go @@ -0,0 +1,192 @@ +package timers + +import ( + "context" + "testing" + "time" + + "github.com/stretchr/testify/require" + "go.k6.io/k6/js/modulestest" +) + +func TestSetTimeout(t *testing.T) { + t.Parallel() + runtime := modulestest.NewRuntime(t) + err := runtime.SetupModuleSystem(map[string]any{"k6/x/timers": New()}, nil, nil) + require.NoError(t, err) + + rt := runtime.VU.Runtime() + var log []string + require.NoError(t, rt.Set("print", func(s string) { log = append(log, s) })) + + _, err = runtime.RunOnEventLoop(` + let timers = require("k6/x/timers"); + timers.setTimeout(()=> { + print("in setTimeout") + }) + print("outside setTimeout") + `) + require.NoError(t, err) + require.Equal(t, []string{"outside setTimeout", "in setTimeout"}, log) +} + +func TestSetInterval(t *testing.T) { + t.Parallel() + runtime := modulestest.NewRuntime(t) + err := runtime.SetupModuleSystem(map[string]any{"k6/x/timers": New()}, nil, nil) + require.NoError(t, err) + + rt := runtime.VU.Runtime() + var log []string + require.NoError(t, rt.Set("print", func(s string) { log = append(log, s) })) + require.NoError(t, rt.Set("sleep10", func() { time.Sleep(10 * time.Millisecond) })) + + _, err = runtime.RunOnEventLoop(` + let timers = require("k6/x/timers"); + var i = 0; + let s = timers.setInterval(()=> { + sleep10(); + if (i>1) { + print("in setInterval"); + timers.clearInterval(s); + } + i++; + }, 1); + print("outside setInterval") + `) + require.NoError(t, err) + require.Equal(t, len(log), 2) + require.Equal(t, "outside setInterval", log[0]) + for i, l := range log[1:] { + require.Equal(t, "in setInterval", l, i) + } +} + +func TestSetTimeoutOrder(t *testing.T) { + t.Parallel() + runtime := modulestest.NewRuntime(t) + err := runtime.SetupModuleSystem(map[string]any{"k6/x/timers": New()}, nil, nil) + require.NoError(t, err) + + rt := runtime.VU.Runtime() + var log []string + require.NoError(t, rt.Set("print", func(s string) { log = append(log, s) })) + + _, err = rt.RunString(`globalThis.setTimeout = require("k6/x/timers").setTimeout;`) + require.NoError(t, err) + + for i := 0; i < 100; i++ { + _, err = runtime.RunOnEventLoop(` + setTimeout((_) => print("one"), 1); + setTimeout((_) => print("two"), 1); + setTimeout((_) => print("three"), 1); + setTimeout((_) => print("last"), 10); + setTimeout((_) => print("four"), 1); + setTimeout((_) => print("five"), 1); + setTimeout((_) => print("six"), 1); + print("outside setTimeout"); + `) + require.NoError(t, err) + require.Equal(t, []string{"outside setTimeout", "one", "two", "three", "four", "five", "six", "last"}, log, i) + log = log[:0] + } +} + +func TestSetIntervalOrder(t *testing.T) { + t.Parallel() + runtime := modulestest.NewRuntime(t) + err := runtime.SetupModuleSystem(map[string]any{"k6/x/timers": New()}, nil, nil) + require.NoError(t, err) + + rt := runtime.VU.Runtime() + var log []string + require.NoError(t, rt.Set("print", func(s string) { log = append(log, s) })) + + _, err = rt.RunString(`globalThis.setInterval = require("k6/x/timers").setInterval;`) + require.NoError(t, err) + + _, err = rt.RunString(`globalThis.clearInterval = require("k6/x/timers").clearInterval;`) + require.NoError(t, err) + + for i := 0; i < 100; i++ { + _, err = runtime.RunOnEventLoop(` + var one = setInterval((_) => print("one"), 1); + var two = setInterval((_) => print("two"), 1); + var last = setInterval((_) => { + print("last") + clearInterval(one); + clearInterval(two); + clearInterval(three); + clearInterval(last); + }, 4); + var three = setInterval((_) => print("three"), 1); + print("outside"); + `) + require.NoError(t, err) + require.GreaterOrEqual(t, len(log), 5) + require.Equal(t, log[0], "outside") + for i := 1; i < len(log)-1; i += 3 { + switch len(log) - i { + case 2: + require.Equal(t, log[i:i+1], []string{"one"}) + case 3: + require.Equal(t, log[i:i+2], []string{"one", "two"}) + default: + require.Equal(t, log[i:i+3], []string{"one", "two", "three"}) + } + } + require.Equal(t, log[len(log)-1], "last") + log = log[:0] + } +} + +func TestSetTimeoutContextCancel(t *testing.T) { + t.Parallel() + runtime := modulestest.NewRuntime(t) + err := runtime.SetupModuleSystem(map[string]any{"k6/x/timers": New()}, nil, nil) + require.NoError(t, err) + + rt := runtime.VU.Runtime() + var log []string + interruptChannel := make(chan struct{}) + require.NoError(t, rt.Set("print", func(s string) { log = append(log, s) })) + require.NoError(t, rt.Set("interrupt", func() { + select { + case interruptChannel <- struct{}{}: + default: + } + })) + + _, err = rt.RunString(`globalThis.setTimeout = require("k6/x/timers").setTimeout;`) + require.NoError(t, err) + + for i := 0; i < 2000; i++ { + ctx, cancel := context.WithCancel(context.Background()) + runtime.CancelContext = cancel + runtime.VU.CtxField = ctx + runtime.VU.RuntimeField.ClearInterrupt() + const interruptMsg = "definitely an interrupt" + go func() { + <-interruptChannel + time.Sleep(time.Millisecond) + runtime.CancelContext() + runtime.VU.RuntimeField.Interrupt(interruptMsg) + }() + _, err = runtime.RunOnEventLoop(` + (async () => { + let poll = async (resolve, reject) => { + await (async () => 5); + setTimeout(poll, 1, resolve, reject); + interrupt(); + } + setTimeout(async () => { + await new Promise(poll) + }, 0) + })() + `) + if err != nil { + require.ErrorContains(t, err, interruptMsg) + } + require.Empty(t, log) + } +} diff --git a/vendor/github.com/grafana/xk6-timers/LICENSE b/vendor/github.com/grafana/xk6-timers/LICENSE deleted file mode 100644 index c186a9c9f79..00000000000 --- a/vendor/github.com/grafana/xk6-timers/LICENSE +++ /dev/null @@ -1,201 +0,0 @@ - Apache License - Version 2.0, January 2004 - http://www.apache.org/licenses/ - - TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION - - 1. Definitions. - - "License" shall mean the terms and conditions for use, reproduction, - and distribution as defined by Sections 1 through 9 of this document. - - "Licensor" shall mean the copyright owner or entity authorized by - the copyright owner that is granting the License. - - "Legal Entity" shall mean the union of the acting entity and all - other entities that control, are controlled by, or are under common - control with that entity. For the purposes of this definition, - "control" means (i) the power, direct or indirect, to cause the - direction or management of such entity, whether by contract or - otherwise, or (ii) ownership of fifty percent (50%) or more of the - outstanding shares, or (iii) beneficial ownership of such entity. - - "You" (or "Your") shall mean an individual or Legal Entity - exercising permissions granted by this License. - - "Source" form shall mean the preferred form for making modifications, - including but not limited to software source code, documentation - source, and configuration files. - - "Object" form shall mean any form resulting from mechanical - transformation or translation of a Source form, including but - not limited to compiled object code, generated documentation, - and conversions to other media types. - - "Work" shall mean the work of authorship, whether in Source or - Object form, made available under the License, as indicated by a - copyright notice that is included in or attached to the work - (an example is provided in the Appendix below). - - "Derivative Works" shall mean any work, whether in Source or Object - form, that is based on (or derived from) the Work and for which the - editorial revisions, annotations, elaborations, or other modifications - represent, as a whole, an original work of authorship. For the purposes - of this License, Derivative Works shall not include works that remain - separable from, or merely link (or bind by name) to the interfaces of, - the Work and Derivative Works thereof. - - "Contribution" shall mean any work of authorship, including - the original version of the Work and any modifications or additions - to that Work or Derivative Works thereof, that is intentionally - submitted to Licensor for inclusion in the Work by the copyright owner - or by an individual or Legal Entity authorized to submit on behalf of - the copyright owner. For the purposes of this definition, "submitted" - means any form of electronic, verbal, or written communication sent - to the Licensor or its representatives, including but not limited to - communication on electronic mailing lists, source code control systems, - and issue tracking systems that are managed by, or on behalf of, the - Licensor for the purpose of discussing and improving the Work, but - excluding communication that is conspicuously marked or otherwise - designated in writing by the copyright owner as "Not a Contribution." - - "Contributor" shall mean Licensor and any individual or Legal Entity - on behalf of whom a Contribution has been received by Licensor and - subsequently incorporated within the Work. - - 2. Grant of Copyright License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - copyright license to reproduce, prepare Derivative Works of, - publicly display, publicly perform, sublicense, and distribute the - Work and such Derivative Works in Source or Object form. - - 3. Grant of Patent License. Subject to the terms and conditions of - this License, each Contributor hereby grants to You a perpetual, - worldwide, non-exclusive, no-charge, royalty-free, irrevocable - (except as stated in this section) patent license to make, have made, - use, offer to sell, sell, import, and otherwise transfer the Work, - where such license applies only to those patent claims licensable - by such Contributor that are necessarily infringed by their - Contribution(s) alone or by combination of their Contribution(s) - with the Work to which such Contribution(s) was submitted. If You - institute patent litigation against any entity (including a - cross-claim or counterclaim in a lawsuit) alleging that the Work - or a Contribution incorporated within the Work constitutes direct - or contributory patent infringement, then any patent licenses - granted to You under this License for that Work shall terminate - as of the date such litigation is filed. - - 4. Redistribution. You may reproduce and distribute copies of the - Work or Derivative Works thereof in any medium, with or without - modifications, and in Source or Object form, provided that You - meet the following conditions: - - (a) You must give any other recipients of the Work or - Derivative Works a copy of this License; and - - (b) You must cause any modified files to carry prominent notices - stating that You changed the files; and - - (c) You must retain, in the Source form of any Derivative Works - that You distribute, all copyright, patent, trademark, and - attribution notices from the Source form of the Work, - excluding those notices that do not pertain to any part of - the Derivative Works; and - - (d) If the Work includes a "NOTICE" text file as part of its - distribution, then any Derivative Works that You distribute must - include a readable copy of the attribution notices contained - within such NOTICE file, excluding those notices that do not - pertain to any part of the Derivative Works, in at least one - of the following places: within a NOTICE text file distributed - as part of the Derivative Works; within the Source form or - documentation, if provided along with the Derivative Works; or, - within a display generated by the Derivative Works, if and - wherever such third-party notices normally appear. The contents - of the NOTICE file are for informational purposes only and - do not modify the License. You may add Your own attribution - notices within Derivative Works that You distribute, alongside - or as an addendum to the NOTICE text from the Work, provided - that such additional attribution notices cannot be construed - as modifying the License. - - You may add Your own copyright statement to Your modifications and - may provide additional or different license terms and conditions - for use, reproduction, or distribution of Your modifications, or - for any such Derivative Works as a whole, provided Your use, - reproduction, and distribution of the Work otherwise complies with - the conditions stated in this License. - - 5. Submission of Contributions. Unless You explicitly state otherwise, - any Contribution intentionally submitted for inclusion in the Work - by You to the Licensor shall be under the terms and conditions of - this License, without any additional terms or conditions. - Notwithstanding the above, nothing herein shall supersede or modify - the terms of any separate license agreement you may have executed - with Licensor regarding such Contributions. - - 6. Trademarks. This License does not grant permission to use the trade - names, trademarks, service marks, or product names of the Licensor, - except as required for reasonable and customary use in describing the - origin of the Work and reproducing the content of the NOTICE file. - - 7. Disclaimer of Warranty. Unless required by applicable law or - agreed to in writing, Licensor provides the Work (and each - Contributor provides its Contributions) on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or - implied, including, without limitation, any warranties or conditions - of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A - PARTICULAR PURPOSE. You are solely responsible for determining the - appropriateness of using or redistributing the Work and assume any - risks associated with Your exercise of permissions under this License. - - 8. Limitation of Liability. In no event and under no legal theory, - whether in tort (including negligence), contract, or otherwise, - unless required by applicable law (such as deliberate and grossly - negligent acts) or agreed to in writing, shall any Contributor be - liable to You for damages, including any direct, indirect, special, - incidental, or consequential damages of any character arising as a - result of this License or out of the use or inability to use the - Work (including but not limited to damages for loss of goodwill, - work stoppage, computer failure or malfunction, or any and all - other commercial damages or losses), even if such Contributor - has been advised of the possibility of such damages. - - 9. Accepting Warranty or Additional Liability. While redistributing - the Work or Derivative Works thereof, You may choose to offer, - and charge a fee for, acceptance of support, warranty, indemnity, - or other liability obligations and/or rights consistent with this - License. However, in accepting such obligations, You may act only - on Your own behalf and on Your sole responsibility, not on behalf - of any other Contributor, and only if You agree to indemnify, - defend, and hold each Contributor harmless for any liability - incurred by, or claims asserted against, such Contributor by reason - of your accepting any such warranty or additional liability. - - END OF TERMS AND CONDITIONS - - APPENDIX: How to apply the Apache License to your work. - - To apply the Apache License to your work, attach the following - boilerplate notice, with the fields enclosed by brackets "[]" - replaced with your own identifying information. (Don't include - the brackets!) The text should be enclosed in the appropriate - comment syntax for the file format. We also recommend that a - file or class name and description of purpose be included on the - same "printed page" as the copyright notice for easier - identification within third-party archives. - - Copyright 2021 Grafana Labs - - Licensed under the Apache License, Version 2.0 (the "License"); - you may not use this file except in compliance with the License. - You may obtain a copy of the License at - - http://www.apache.org/licenses/LICENSE-2.0 - - Unless required by applicable law or agreed to in writing, software - distributed under the License is distributed on an "AS IS" BASIS, - WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. - See the License for the specific language governing permissions and - limitations under the License. \ No newline at end of file diff --git a/vendor/modules.txt b/vendor/modules.txt index 8d3b8971217..551832760f4 100644 --- a/vendor/modules.txt +++ b/vendor/modules.txt @@ -173,9 +173,6 @@ github.com/grafana/xk6-output-prometheus-remote/pkg/stale # github.com/grafana/xk6-redis v0.2.0 ## explicit; go 1.19 github.com/grafana/xk6-redis/redis -# github.com/grafana/xk6-timers v0.2.3 -## explicit; go 1.20 -github.com/grafana/xk6-timers/timers # github.com/grafana/xk6-webcrypto v0.1.1 ## explicit; go 1.19 github.com/grafana/xk6-webcrypto/webcrypto