Introduce DefaultServiceOptions, that are applied to every service bind to the endpoint. (#572)

* Moved discovery and components to endpoint, these are relevant only there.
* Modified `EndpointBuilder`, now it's really used as a builder and has a final step `build()`. `GenericHandler` now uses the built `Endpoint`, instead of dealing with `EndpointBuilder`. This simplified the implementation of these new global options, and allowed to remove a bit of code as well.
* Unit tests and example of the new config options.
* Pruned some old unused code

Author: slinkydeveloper

DEVELOPMENT.md

@@ -40,7 +40,7 @@ E2E tests run automatically with
 ## Re-generating the discovery manifest
 
 ```shell
-npx --package=json-schema-to-typescript json2ts endpoint_manifest_schema.json packages/restate-sdk/src/types/discovery.ts
+npx --package=json-schema-to-typescript json2ts endpoint_manifest_schema.json packages/restate-sdk/src/endpoint/discovery.ts
 ```
 
 ## Releasing the package

packages/restate-sdk-examples/src/greeter_with_options.ts

@@ -49,4 +49,10 @@ const greeter = service({
 
 export type Greeter = typeof greeter;
 
-endpoint().bind(greeter).listen();
+endpoint()
+  .bind(greeter)
+  .defaultServiceOptions({
+    // You can configure default service options that will be applied to every service.
+    journalRetention: { days: 10 },
+  })
+  .listen();

packages/restate-sdk-testcontainers/src/public_api.ts

@@ -20,10 +20,16 @@ export type {
   Serde,
   RestateEndpoint,
   RestateEndpointBase,
+  DefaultServiceOptions,
   LoggerTransport,
   LogMetadata,
   LogSource,
   RestateLogLevel,
   LoggerContext,
   Request,
+  ServiceOptions,
+  ObjectOptions,
+  WorkflowOptions,
+  TerminalError,
+  RestateError,
 } from "@restatedev/restate-sdk";

packages/restate-sdk/src/common_api.ts

@@ -100,7 +100,12 @@ export type {
   WorkflowDefinition,
 } from "@restatedev/restate-sdk-core";
 
-export type { RestateEndpoint, RestateEndpointBase } from "./endpoint.js";
+export type {
+  RestateEndpoint,
+  RestateEndpointBase,
+  DefaultServiceOptions,
+} from "./endpoint.js";
+
 export {
   /**
    * @deprecated YOU MUST NOT USE THIS TYPE

packages/restate-sdk/src/endpoint.ts

@@ -16,6 +16,15 @@ import type {
   WorkflowDefinition,
 } from "@restatedev/restate-sdk-core";
 import type { LoggerTransport } from "./logging/logger_transport.js";
+import type {
+  ObjectOptions,
+  ServiceOptions,
+  WorkflowOptions,
+} from "./types/rpc.js";
+
+export type DefaultServiceOptions = ServiceOptions &
+  ObjectOptions &
+  WorkflowOptions;
 
 export interface RestateEndpointBase<E> {
   /**
@@ -41,6 +50,15 @@ export interface RestateEndpointBase<E> {
    */
   withIdentityV1(...keys: string[]): E;
 
+  /**
+   * Set default service options that will be used by all services bind to this endpoint.
+   *
+   * Options can be overridden on each service/handler.
+   *
+   * @param options
+   */
+  defaultServiceOptions(options: DefaultServiceOptions): E;
+
   /**
    * Replace the default console-based {@link LoggerTransport}
    * @param logger
@@ -68,8 +86,9 @@ export interface RestateEndpointBase<E> {
 /**
  * RestateEndpoint encapsulates all the Restate services served by this endpoint.
  *
- * A RestateEndpoint can either be served either as HTTP2 server, using the methods {@link listen} or {@link http2Handler},
- * or as Lambda, using the method {@link lambdaHandler}.
+ * A RestateEndpoint can either be served as HTTP2 server, using the methods {@link RestateEndpoint.listen} or {@link RestateEndpoint.http2Handler}.
+ *
+ * For Lambda, check {@link LambdaEndpoint}
  *
  * @example
  * A typical endpoint served as HTTP server would look like this:
@@ -81,16 +100,6 @@ export interface RestateEndpointBase<E> {
  *   .bind(myService)
  *   .listen(8000);
  * ```
- * @example
- * A typical endpoint served as AWS Lambda would look like this:
- * ```
- * import * as restate from "@restatedev/restate-sdk/lambda";
- *
- * export const handler = restate
- *   .endpoint()
- *   .bind(myService)
- *   .handler();
- * ```
  */
 export interface RestateEndpoint extends RestateEndpointBase<RestateEndpoint> {
   /**
@@ -110,15 +119,15 @@ export interface RestateEndpoint extends RestateEndpointBase<RestateEndpoint> {
    * httpServer.listen(port);
    * ```
    *
-   * If you need to manually control the server lifecycle, we suggest to manually instantiate the http2 server and use {@link http2Handler}.
+   * If you need to manually control the server lifecycle, we suggest to manually instantiate the http2 server and use {@link RestateEndpoint.http2Handler}.
    *
    * @param port The port to listen at. May be undefined (see above).
    * @returns a Promise that resolves with the bound port, or rejects with a failure otherwise.
    */
   listen(port?: number): Promise<number>;
 
   /**
-   * Returns an http2 server handler. See {@link listen} for more details.
+   * Returns an http2 server handler. See {@link RestateEndpoint.listen} for more details.
    */
   http2Handler(): (
     request: Http2ServerRequest,

packages/restate-sdk/src/types/components.ts renamed to packages/restate-sdk/src/endpoint/components.ts

@@ -19,8 +19,8 @@ import type {
   ObjectOptions,
   ServiceOptions,
   WorkflowOptions,
-} from "./rpc.js";
-import { HandlerKind } from "./rpc.js";
+} from "../types/rpc.js";
+import { HandlerKind } from "../types/rpc.js";
 import { millisOrDurationToMillis } from "@restatedev/restate-sdk-core";
 
 //