feat: add typescript compilation on build

Author: notdryft

.github/workflows/build.yml

@@ -35,17 +35,20 @@ jobs:
       - name: Build JVM code samples
         run: sbt "all headerCheckAll scalafmtSbtCheck" "test"
 
-      - name: Setup Hugo
-        uses: peaceiris/actions-hugo@v3
-        with:
-          hugo-version: '0.135.0'
-          extended: true
-
       - name: Setup Node
         uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: 'npm'
 
+      - name: Setup Hugo
+        uses: peaceiris/actions-hugo@v3
+        with:
+          hugo-version: '0.135.0'
+          extended: true
+
       - name: Generate site
         run: ./bin/entrypoint.sh generate
+
+      - name: Build TypeScript code samples
+        run: npm run test-ts-samples

config/_default/params.yaml

@@ -46,7 +46,7 @@ languages:
   default: java
   labels:
     - java: Java
-    - js: JavaScript
+    - ts: JavaScript
     - kt: Kotlin
     - scala: Scala
 

content/guides/debugging/code/ComputerDatabaseSampleJS.js renamed to content/guides/debugging/code/ComputerDatabaseSampleJS.ts

@@ -14,6 +14,9 @@
  * limitations under the License.
  */
 
+import { scenario } from "@gatling.io/core";
+
+scenario("scenario")
 //#print-session-value
 .exec((session) => {
   console.log(session.get("addComputer"));

content/guides/dynatrace/code/DynatraceSampleJS.js renamed to content/guides/dynatrace/code/DynatraceSampleJS.ts

@@ -1,3 +1,8 @@
+import { SetUpFunction, rampUsers, scenario } from "@gatling.io/core";
+
+const scn = scenario("scenario");
+const setUp = null as unknown as SetUpFunction;
+
 //#injection-from-options
 import { getParameter } from "@gatling.io/core";
 

content/guides/grouping-feeder/code/GroupingFeederJS.js renamed to content/guides/grouping-feeder/code/GroupingFeederJS.ts

@@ -32,8 +32,8 @@ npx gatling run users=500 ramp=3600
 
 You can resolve these options directly in your code with the `getParameter` function:
 
-{{< include-code "injection-from-options" js >}}
+{{< include-code "injection-from-options" ts >}}
 
 We also provide a `getEnvironmentVariable` function to read environment variables:
 
-{{< include-code "injection-from-env-vars" js >}}
+{{< include-code "injection-from-env-vars" ts >}}

content/guides/passing-parameters/code/PassingParametersSampleJs.js renamed to content/guides/passing-parameters/code/PassingParametersSampleJs.ts

@@ -14,6 +14,19 @@
  * limitations under the License.
  */
 
+import {
+  SetUpFunction,
+  atOnceUsers,
+  nothingFor,
+  pause,
+  rampUsers,
+  scenario,
+  simulation
+} from "@gatling.io/core";
+import { http } from "@gatling.io/http";
+
+const setUp = null as unknown as SetUpFunction;
+
 //#dsl-bad
 for (let i = 0; i < 5; i++) {
   http("Access Github").get("https://github.com");

content/guides/passing-parameters/index.md

@@ -14,6 +14,21 @@
  * limitations under the License.
  */
 
+import {
+  SetUpFunction,
+  atOnceUsers,
+  details,
+  forAll,
+  global,
+  scenario,
+  simulation,
+} from "@gatling.io/core";
+
+const scn = scenario("scenario");
+const injectionProfile = atOnceUsers(1);
+
+const setUp = null as unknown as SetUpFunction;
+
 //#setUp
 setUp(scn.injectOpen(injectionProfile))
   .assertions(

content/reference/glossary/code/ConceptsIntroductionSampleJS.js renamed to content/reference/glossary/code/ConceptsIntroductionSampleJS.ts

@@ -14,6 +14,25 @@
  * limitations under the License.
  */
 
+import {
+  ElFileBody,
+  RawFileBody,
+  bodyBytes,
+  bodyLength,
+  bodyString,
+  css,
+  form,
+  jmesPath,
+  jsonPath,
+  md5,
+  regex,
+  responseTimeInMillis,
+  sha1,
+  substring,
+  xpath
+} from "@gatling.io/core";
+import { http, status } from "@gatling.io/http";
+
 //#status-is-200
 http("Gatling").get("https://gatling.io")
   .check(status().is(200))
@@ -41,7 +60,7 @@ http("").get("")
 
 //#bodyBytes
 .check(
-  bodyBytes().is("{\"foo\": \"bar\"}".getBytes(StandardCharsets.UTF_8)),
+  bodyBytes().is([123,34,102,111,111,34,58,32,34,98,97,114,34,125]), // Bytes array
   bodyBytes().is(RawFileBody("expected.json"))
 )
 //#bodyBytes
@@ -351,14 +370,18 @@ NOT SUPPORTED
         const prefix = session.get("prefix");
         if (actual == null) {
           throw Error("Value is missing");
-        } else if (!actual.startsWith(prefix)) {
-          throw Error("Value " + actual + " should start with " + prefix);
+        } else {
+          // @ts-ignore
+          if (!actual.startsWith(prefix)) {
+            throw Error("Value " + actual + " should start with " + prefix);
+          }
         }
         return actual;
       })
 )
 //#validator
 
+http("").get("")
 //#name
 .check(
   jmesPath("foo").name("My custom error message")

content/reference/script/core/assertions/code/AssertionSampleJS.js renamed to content/reference/script/core/assertions/code/AssertionSampleJS.ts

@@ -14,6 +14,23 @@
  * limitations under the License.
  */
 
+import {
+  SetUpFunction,
+  atOnceUsers,
+  constantConcurrentUsers,
+  constantUsersPerSec,
+  incrementConcurrentUsers,
+  incrementUsersPerSec,
+  nothingFor,
+  rampConcurrentUsers,
+  rampUsers,
+  rampUsersPerSec,
+  scenario,
+  stressPeakUsers
+} from "@gatling.io/core";
+import { http } from "@gatling.io/http";
+
+const setUp = null as unknown as SetUpFunction;
 
 const httpProtocol = http;
 const scn = scenario("scenario");

content/reference/script/core/checks/code/CheckSampleJS.js renamed to content/reference/script/core/checks/code/CheckSampleJS.ts

@@ -14,6 +14,46 @@
  * limitations under the License.
  */
 
+import {
+  asLongAs,
+  asLongAsDuring,
+  crashLoadGenerator,
+  crashLoadGeneratorIf,
+  doIf,
+  doIfEquals,
+  doIfEqualsOrElse,
+  doIfOrElse,
+  doWhile,
+  doWhileDuring,
+  doSwitch,
+  doSwitchOrElse,
+  dummy,
+  during,
+  exitBlockOnFail,
+  exitHere,
+  exitHereIf,
+  exitHereIfFailed,
+  foreach,
+  forever,
+  group,
+  onCase,
+  pace,
+  pause,
+  percent,
+  exec,
+  randomSwitch,
+  randomSwitchOrElse,
+  rendezVous,
+  repeat,
+  roundRobinSwitch,
+  scenario,
+  stopLoadGenerator,
+  stopLoadGeneratorIf,
+  tryMax,
+  uniformRandomSwitch
+} from "@gatling.io/core";
+import { http } from "@gatling.io/http";
+
 //#bootstrapping
 const scn = scenario("Scenario");
 //#bootstrapping

content/reference/script/core/injection/code/InjectionSampleJS.js renamed to content/reference/script/core/injection/code/InjectionSampleJS.ts

@@ -14,6 +14,10 @@
  * limitations under the License.
  */
 
+import { Session, exec } from "@gatling.io/core";
+
+const session = null as unknown as Session;
+
 //#sessions-are-immutable
 // wrong usage: result from Session#set is discarded
 exec((session) => {
@@ -28,18 +32,20 @@ exec((session) => {
 });
 //#sessions-are-immutable
 
-//#set
-// set one single attribute
-const newSession1 = session.set("key", "whateverValue");
-// set multiple attributes
-const newSession2 = session.setAll({ "key": "value" });
-// remove one single attribute
-const newSession3 = session.remove("key");
-// remove multiple attributes
-const newSession4 = session.removeAll("key1", "key2");
-// remove all non Gatling internal attributes
-const newSession5 = session.reset();
-//#set
+const set = () => {
+  //#set
+  // set one single attribute
+  const newSession1 = session.set("key", "whateverValue");
+  // set multiple attributes
+  const newSession2 = session.setAll({ "key": "value" });
+  // remove one single attribute
+  const newSession3 = session.remove("key");
+  // remove multiple attributes
+  const newSession4 = session.removeAll("key1", "key2");
+  // remove all non Gatling internal attributes
+  const newSession5 = session.reset();
+  //#set
+};
 
 //#get
 // check if an attribute is stored in the session
@@ -58,13 +64,15 @@ const scenario = session.scenario();
 const groups = session.groups();
 //#properties
 
-//#state
-// return true if the virtual user has experienced a failure before this point
-const failed = session.isFailed();
-// reset the state to success
-// so that interrupt mechanisms such as exitHereIfFailed don't trigger
-const newSession1 = session.markAsSucceeded();
-// force the state to failure
-// so that interrupt mechanisms such as exitHereIfFailed do trigger
-const newSession2 = session.markAsFailed();
-//#state
+const state = () => {
+  //#state
+  // return true if the virtual user has experienced a failure before this point
+  const failed = session.isFailed();
+  // reset the state to success
+  // so that interrupt mechanisms such as exitHereIfFailed don't trigger
+  const newSession1 = session.markAsSucceeded();
+  // force the state to failure
+  // so that interrupt mechanisms such as exitHereIfFailed do trigger
+  const newSession2 = session.markAsFailed();
+  //#state
+};

content/reference/script/core/scenario/code/ScenarioSampleJS.js renamed to content/reference/script/core/scenario/code/ScenarioSampleJS.ts

@@ -14,6 +14,20 @@
  * limitations under the License.
  */
 
+import {
+  FeederBuilder,
+  arrayFeeder,
+  csv,
+  feed,
+  jsonFile,
+  jsonUrl,
+  separatedValues,
+  ssv,
+  tsv
+} from "@gatling.io/core";
+
+const feeder = null as unknown as FeederBuilder<string>;
+
 /*
 //#random-mail-generator
 The `feeder(Iterator)` method is currently not supported by Gatling JS.

content/reference/script/core/session/api/code/SessionSampleJS.js renamed to content/reference/script/core/session/api/code/SessionSampleJS.ts

@@ -14,9 +14,13 @@
  * limitations under the License.
  */
 
+import { exec } from "@gatling.io/core";
+import { http } from "@gatling.io/http";
+
 //#function-sample
 // inline usage with a lambda
 exec(http("name")
+  // @ts-ignore
   .get((session) => "/foo/" + session.get("param").toLocaleLowerCase()));
 
 // passing a reference to a function