@gatling.io/http 3.11.7 → 3.12.0

package/src/method.ts

@@ -0,0 +1,65 @@
+/**
+ * The OPTIONS method represents a request for information about the communication options
+ * available on the request/response chain identified by the Request-URI. This method allows
+ * the client to determine the options and/or requirements associated with a resource, or the
+ * capabilities of a server, without implying a resource action or initiating a resource
+ * retrieval.
+ */
+export type OPTIONS = "OPTIONS";
+
+/**
+ * The GET method means retrieve whatever information (in the form of an entity) is identified
+ * by the Request-URI.  If the Request-URI refers to a data-producing process, it is the
+ * produced data which shall be returned as the entity in the response and not the source text
+ * of the process, unless that text happens to be the output of the process.
+ */
+export type GET = "GET";
+
+/**
+ * The HEAD method is identical to GET except that the server MUST NOT return a message-body
+ * in the response.
+ */
+export type HEAD = "HEAD";
+
+/**
+ * The POST method is used to request that the origin server accept the entity enclosed in the
+ * request as a new subordinate of the resource identified by the Request-URI in the
+ * Request-Line.
+ */
+export type POST = "POST";
+
+/**
+ * The PUT method requests that the enclosed entity be stored under the supplied Request-URI.
+ */
+export type PUT = "PUT";
+
+/**
+ * The PATCH method requests that a set of changes described in the
+ * request entity be applied to the resource identified by the Request-URI.
+ */
+export type PATCH = "PATCH";
+
+/**
+ * The DELETE method requests that the origin server delete the resource identified by the
+ * Request-URI.
+ */
+export type DELETE = "DELETE";
+
+/**
+ * The TRACE method is used to invoke a remote, application-layer loop-back of the request
+ * message.
+ */
+export type TRACE = "TRACE";
+
+/**
+ * This specification reserves the method name CONNECT for use with a proxy that can dynamically
+ * switch to being a tunnel
+ */
+export type CONNECT = "CONNECT";
+
+/**
+ * The request method of HTTP or its derived protocols, such as
+ * <a href="https://en.wikipedia.org/wiki/Real_Time_Streaming_Protocol">RTSP</a> and
+ * <a href="https://en.wikipedia.org/wiki/Internet_Content_Adaptation_Protocol">ICAP</a>.
+ */
+export type HttpMethod = OPTIONS | GET | HEAD | POST | PUT | PATCH | DELETE | TRACE | CONNECT;

package/src/polling.ts

@@ -0,0 +1,59 @@
+import { HttpDsl as JvmHttpDsl } from "@gatling.io/jvm-types";
+import JvmPolling = io.gatling.javaapi.http.Polling;
+import JvmPollingEvery = io.gatling.javaapi.http.Polling$Every;
+
+import { ActionBuilder, Duration, wrapActionBuilder, toJvmDuration } from "@gatling.io/core";
+
+import { HttpRequestActionBuilder } from "./request";
+
+/** The prefix to bootstrap polling specific DSL */
+export const poll = (): Polling => wrapPolling(JvmHttpDsl.poll());
+
+/**
+ * DSL for building HTTP polling configurations
+ *
+ * Immutable, so all methods return a new occurrence and leave the original unmodified.
+ */
+export interface Polling {
+  /**
+   * Define a custom poller name so multiple pollers for the same virtual users don't conflict
+   *
+   * @param pollerName - the name
+   * @returns the next DSL step
+   */
+  pollerName(pollerName: string): Polling;
+
+  /**
+   * Define the polling period
+   *
+   * @param period - the period
+   * @returns the next DSL step
+   */
+  every(period: Duration): PollingEvery;
+
+  /**
+   * Stop polling
+   *
+   * @returns an ActionBuilder
+   */
+  stop(): ActionBuilder;
+}
+
+const wrapPolling = (_underlying: JvmPolling): Polling => ({
+  pollerName: (pollerName) => wrapPolling(_underlying.pollerName(pollerName)),
+  every: (period) => wrapPollingEvery(_underlying.every(toJvmDuration(period))),
+  stop: () => wrapActionBuilder(_underlying.stop())
+});
+
+export interface PollingEvery {
+  /**
+   * Define the polling request
+   *
+   * @returns an ActionBuilder
+   */
+  exec(requestBuilder: HttpRequestActionBuilder): ActionBuilder;
+}
+
+const wrapPollingEvery = (_underlying: JvmPollingEvery): PollingEvery => ({
+  exec: (requestBuilder) => wrapActionBuilder(_underlying.exec(requestBuilder._underlying))
+});