@sap-cloud-sdk/resilience

@sap-cloud-sdk/resilience

This package contains implementations for the resilience middlewares like a timeout or circuit breaker middleware. This concept of middlewares is totally generic, and you can use it for non-resilience use cases.

Installation

$ npm install @sap-cloud-sdk/resilience

Usage

Add a timeout middleware to a request.

executeHttpRequest(destination, { middleware: [ timeout() ] }, httpRequestOptions);

For more detailed overview visit our resilience documentation.

Support

The recommended way to get in touch with us is to create an issue on GitHub. Select the issue category Bug, Feature, or Question depending on the nature of your request. We try to provide fixes, features and answers as soon as possible.

Contribute

If you would like to contribute to the SAP Cloud SDK, please make yourself familiar with our contributing guidelines and follow the given instructions.

Links

• Official support channel
• Github
• SAP Cloud SDK Documentation portal
  • SAP Cloud SDK Documentation portal - Overview
  • SAP Cloud SDK Documentation portal - Getting started guide
  • SAP Cloud SDK Documentation portal - API documentation
  • SAP Cloud SDK Documentation portal - Release notes
• Sample repository

License

The SAP Cloud SDK is released under the Apache License Version 2.0.

Changelog

3.0.0

API Docs: https://sap.github.io/cloud-sdk/api/3.0.0

Compatibility Notes

• [connectivity] The generic types of JwtKeyMapping is simplified so the second type argument JwtKeysT are always strings. (fde964e37)
• [connectivity] The Protocol enum was replaced with a string literal union type. Now, instead of passing Protocol.HTTPS pass 'https'. (fde964e37)
• [connectivity, http-client, openapi, odata-common, odata-v2, resilience] Remove the options timeout and enableCircuitBreaker from all BTP service interactions i.e. destination and token fetching. (fde964e37)
• [connectivity, http-client, mail-client, openapi, odata-common, odata-v2, odata-v4, eslint-config, generator, test-util, util, openapi-generator, generator-common, temporal-de-serializers, resilience] Switch the compilerOptions.module to Node16 instead of CommonJS for better interoperability with ES modules. See the TypeScript handbook for technical details if needed. (fde964e37)
• [connectivity] The enum IsolationStrategy was replaced with a string literal union type of the same name. Use 'tenant' and 'tenant-user' instead of IsolationStrategy.Tenant and IsolationStrategy.Tenant_User. (fde964e37)
• [connectivity, http-client, odata-common] ] The url property in Destination is now optional as destinations of type MAIL do not have a URL. (fde964e37)
• [http-client, openapi, odata-common] Remove timeout() method from the request builders and the timeout options from the executeHttpRequest() function. Visit the documentation portal to see how to add a timeout using middlewares. (fde964e37)
• [http-client] Removed overload of executeHttpRequest The overload, that accepted HttpRequestConfigWithOrigin as a parameter, is removed and replaced by the function executeHttpRequestWithOrigin. (fde964e37)
• [odata-common, generator, util] By default, generation of OData clients fails if a service path cannot be determined. Either provide servicePath value in the options-per-service.json or set skipValidation to true, in which case, / will be used. (fde964e37)
• [odata-common] The constructor of ODataRequestConfig was changed so that the third parameter cannot be a string anymore. Passing in a string which was then interpreted as the value for the Content-Type HTTP header was deprecated. The type of the parameter is now Record<string, any>, and if only want to set the Content-Type HTTP header you can do so by passing {'content-type': 'some-value'} to the constructor. (fde964e37)
• [odata-common] The constructor of the entity API is private to avoid accidental usage. Use the service object to get a API instance. (fde964e37)
• [odata-common, generator, openapi-generator] The serviceMapping option of the OData generator has been renamed to optionsPerService. The mapping file, service-mapping.json has also been renamed to options-per-service.json. By default, an options file will not be generated. (fde964e37)
• [odata-common] Setting custom fields in fromJson through the _customFields property has been removed. Add custom properties to your JSON object instead. (fde964e37)
• [generator] The options per service behavior is now the same as for the OpenApi generator. For details on how to migrate and what has change look at the migration guide. (fde964e37)
• [generator] The deprecated forceOverwrite option of the generator is removed. Use the overwrite option instead. [Compatibility Note] The deprecated generatePackageJson option of the generator is removed. Use the packageJson option instead. [Compatibility Note] The deprecated writeReadme option of the generator is removed. Use the readme option instead. [Compatibility Note] The deprecated processesJsGeneration option of the generator is removed. Use the transpilationProcesses option instead. [Compatibility Note] The internal options sdkAfterVersionScript, s4HanaCloud and packageVersion of the generator are removed. These were hidden options never meant for external usage and there is no replacement. [Compatibility Note] The deprecated generateNpmrc option of the generator is removed. Use the include option to add a .npmrc to the generated code if needed. (fde964e37)
• [generator] Add verbose generator option. By default, only error and warning logs will be displayed. If verbose is set to true, all logs will be displayed. (fde964e37)
• [generator] The generateJs option has been replaced with the transpile option. Transpilation is not enabled by default. (fde964e37)
• [generator] The command line argument inputDir of the OData generator is renamed to input. The new input options accepts now also file paths and glob patterns. (fde964e37)
• [generator] The OData generator won't automatically rename identifiers to avoid name conflicts. The generation process will fail if identifiers have conflicting names. Switch on the skipValidation flag if you want to generate despite name conflicts and are okay with changed identifier names to avoid conflicts. (fde964e37)
• [generator, openapi-generator, generator-common] Removed the option versionInPackageJson from the OData and OpenAPI generator. If the option packageJson is enabled now a package.json with a default version 1.0.0 is created. If necessary use the include option to add a package.json with a custom value. [Compatibility Note] Removed the option licenseInPackageJson from the OData and OpenAPI generator. If the option packageJson is enabled now a package.json with a default license UNLICENSED is created. If necessary use the include option to add a package.json with a custom value. (fde964e37)
• [generator, openapi-generator] Rename servicePath to basePath. (fde964e37)
• [generator] The option generateCSN is removed. There is no replacement. (fde964e37)
• [generator] The type for paths in the GeneratorOptions is changed from fs.PathLike to string. In case you passed a buffer object please resolve it to a string before passing it to the SAP Cloud SDK. (fde964e37)
• [generator, openapi-generator, generator-common] The two generators use the same CLI parsing code now, aligning the way paths are resolved. In case you experience problems with the new logic, enable the verbose flag to investigate the new paths. (fde964e37)
• [util] The function variadicArgumentToArray is replaced by the function transformVariadicArgumentToArray. (fde964e37)
• [util] The field logger on the interface LoggerOptions was not used and is removed from the interface. (fde964e37)
• [openapi-generator] The internal option packageVersion of the OpenAPI generator is removed. (fde964e37)
• [openapi-generator] tsConfig option has been renamed to tsconfig. (fde964e37)
• [generator-common] The generator does not create d.ts.map files per default anymore. If you need them include a custom tsconfig.json. [Compatibility Note] All SAP Cloud SDK packages ship without d.ts.map files from now on. Modern IDEs don't require those files for code navigation, thus they are removed to decrease download size of the SDK. (fde964e37)

New Functionalities

• [connectivity] Support OAuth2RefreshToken authentication type (fde964e37)
• [connectivity] Add a retry option in the DestinationFetchOption. Enable this options if the token exchange done by the destination service is unstable. (fde964e37)
• [connectivity, resilience] Add ResilienceOptions and resilience() function. The function returns an array of middlewares based on the provided options. (fde964e37)
• [http-client, resilience] The request configuration used in the final request is now part of the middleware context. User can implement middlewares to change request properties like headers using this reference in the middleware context. The request configuration contains the url, headers and all other properties of the HTTP request. (fde964e37)
• [http-client, openapi, odata-common] Introduce the middleware on the request builders and http-client. Visit the documentation portal to see how to use middlewares. (fde964e37)
• [generator, generator-common] Introduced options transpile and tsconfig to configure transpilation for generated OData clients. (fde964e37)

Improvements

• [connectivity] Replace Protocol enum with a string literal union type. (fde964e37)
• [connectivity] Replace IsolationStrategy enum with union type. (fde964e37)
• [generator] Align naming rules for operations and properties in OData clients by removing _ prefix (fde964e37)

Fixed Issues

• [connectivity] Fix the combination of providing the iss together with OnPremise basic destinations. (fde964e37)
• [odata-v2] Allow to update OData v2 entities to null. Fixes 3204. (fde964e37)
• [generator] Allow OData service to contain an entity name 'Service'. (fde964e37)
• [generator] Now links to the correct generator binary. (fde964e37)

Known Issues

Compatibility Notes

New Functionality

Improvements

Fixed Issues