# @janiscommerce/microservice-call > Allows communication between services. Latest version **5.1.1** (published 2024-01-15) · ISC license · 0 weekly downloads ## Install ```sh npm install @janiscommerce/microservice-call pnpm add @janiscommerce/microservice-call yarn add @janiscommerce/microservice-call bun add @janiscommerce/microservice-call ``` ## Health **Score 40/100 (D)** — status: abandoned. Positive: has types; no vulnerabilities; high maintenance score; high quality score. Warnings: low downloads; no esm support. Negative: abandoned. ## Facts | | | |---|---| | Version | 5.1.1 | | Published | 2024-01-15 | | First published | 2019-06-21 | | Weekly downloads | 0 | | License | ISC | | TypeScript types | bundled | | Module format | CommonJS | | Dependencies | 5 | | Unpacked size | 35.6 KB | | Known vulnerabilities | 0 (+23 in 1 direct dependencies) | | Install scripts | no | | GitHub stars | 2 | | Author | Janis | | Maintainers | janiscommerce | ## Links - npm: https://www.npmjs.com/package/@janiscommerce/microservice-call - Repository: https://github.com/janis-commerce/microservice-call - Homepage: https://github.com/janis-commerce/microservice-call#readme - Issues: https://github.com/janis-commerce/microservice-call/issues - npm.io page: https://npm.io/package/@janiscommerce/microservice-call ## Dependencies (5) - [qa](https://npm.io/package/qa.md) 0.0.1 - [qs](https://npm.io/package/qs.md) ^6.11.2 - [axios](https://npm.io/package/axios.md) ^0.24.0 - [@janiscommerce/lambda](https://npm.io/package/@janiscommerce/lambda.md) ^6.0.5 - [@janiscommerce/aws-secrets-manager](https://npm.io/package/@janiscommerce/aws-secrets-manager.md) ^1.1.0 ## Recent versions - 5.1.1 (latest) — 2024-01-15 - 5.1.0 — 2024-01-02 - 5.0.1 — 2023-09-21 - 5.0.0 — 2023-04-19 - 4.5.0 — 2022-12-23 - 5.0.0-beta.1 — 2022-12-22 - 5.0.0-beta.0 — 2022-12-22 - 4.4.0 — 2022-11-16 - 4.3.4 — 2021-11-22 - 4.3.3 — 2021-11-19 - 4.3.2 — 2021-09-20 - 4.3.1 — 2021-04-14 - 4.3.0 — 2021-03-26 - 4.2.0 — 2020-12-15 - 4.1.2 — 2020-06-19 - … 8 more at https://npm.io/package/@janiscommerce/microservice-call/versions ## README # Microservice Call ![Build Status](https://github.com/janis-commerce/microservice-call/workflows/Build%20Status/badge.svg) [![Coverage Status](https://coveralls.io/repos/github/janis-commerce/microservice-call/badge.svg?branch=master)](https://coveralls.io/github/janis-commerce/microservice-call?branch=master) [![npm version](https://badge.fury.io/js/%40janiscommerce%2Fmicroservice-call.svg)](https://www.npmjs.com/package/@janiscommerce/microservice-call) The `MicroService Call` module allows the communication between services. --- ## Installation ``` npm install @janiscommerce/microservice-call ``` ## Endpoints `MicroService Call` uses **Janis Discovery Service** to obtain Api Endpoints using `service`, `namespace` and `method`. ## Session If an [API Session](https://www.npmjs.com/package/@janiscommerce/api-session) is injected, it will inject `janis-client` and `x-janis-user` headers when possible. ## Authentication It will automatically inject the `janis-api-key` and `janis-api-secret` headers if `JANIS_SERVICE_NAME` and `JANIS_SERVICE_SECRET` environment variables are set. ### 🔑 Secrets In case the `JANIS_SERVICE_SECRET` variable is not found, the package will get the **secret** using the `JANIS_SERVICE_NAME` environment variable. If the **secret** is found it will be used in the `janis-api-secret` header. The Secrets are stored in [AWS Secrets Manager](https://aws.amazon.com/secrets-manager) and obtained with the package [@janiscommerce/aws-secrets-manager](https://www.npmjs.com/package/@janiscommerce/aws-secrets-manager) --- ## API ### No Safe Mode These methods **WILL THROW AN ERROR** when response `statusCode` is `400+`. * `call(service, namespace, method, requestData, requestHeaders, endpointParameters)` Make a request to an microservice. Returns a `Promise` of `MicroServiceCallResponse`. * `list(service, namespace, requestData, endpointParameters, pageSize)` _Since 4.0.0_ Make a `LIST` request to an microservice by entity. Returns a `Promise` of `MicroServiceCallResponse`, the `body` contains the full list of entity's objects (no need for pagination) ### Safe Mode _Since 4.0.0_ These methods **WILL NOT THROW AN ERROR** when response `statusCode` is `400+`. * `safeCall(service, namespace, method, requestData, requestHeaders, endpointParameters)` Make a request to an microservice. Returns a `Promise` of `MicroServiceCallResponse`. * `safeList(service, namespace, requestData, endpointParameters, pageSize)` Make a `LIST` request to an microservice by entity. Returns a `Promise` of `MicroServiceCallResponse`, the `body` contains the full list of entity's objects (no need for pagination) ### Extra _Since 4.0.0_ * `shouldRetry(response)` Indicates if should re-try the call. It is useful for Event-Listeners API to avoid unnecessary retries. Params: `response` `{MicroServiceCallResponse | MicroServiceCallError}` Returns a `Boolean`. > :warning: **After version 4.0.0, `get`, `post`, `put`, `path`, `delete` are *REMOVED*** :warning: _Since 5.1.0_ * `setUserId(userId)` Function for add user id in api-key header Params: `userId` `{String}` Returns a `MicroServiceCallInstance`. ## Parameters The Parameters used in the API functions. * `service` * type: `String` * The name of the microservice. * `namespace` * type: `String` * The namespace of the microservice. * `method` * type: `String` * The method of microservice. * `requestData` * type: `Object` * The data that will send. * `requestHeaders` * type: `Object` * The headers of the request as key-value. * `endpointParameters` * type: `Object` * A key-value mapping between endpoint path variables and their replace value. * `filters` * type: `Object` * filters and/or orders available in destination Entity's Service. * example: ```js { filters: { id: 'some-id', name:'some-name' }} ``` * `pageSize`. _Since 4.3.2_ * type: `Number` * The pageSize will be use to add the `x-janis-page-size` to the ApiList. The default value is `60`. ## Response Object Response of Microservice * `MicroServiceCallResponse`: type: `Object` * `statusCode`: * type: `Number` * The status code of the response. * `statusMessage`: * type: `String` * The status message of the response. * `headers`: * type: `Object` * The headers of the response. * `body`: * type: `Object`, `Array` or `String` (if it's "") * The body of the response ## Errors The errors are informed with a `MicroServiceCallError`. * `MicroServiceCallError`: * `code`: * type: `Number` * The status code of the error. * `message`: * type: `String` * The message of the error. * `name`: * type: `String` * The name of the Error * `statusCode`: * type: `Number` * The status code of the response. ### Codes The codes are the following: | Code | Description | |-----|-----------------------------| | 2 | Microservice Failed | | 3 | Request Library Errors | | 4 | Janis Secret is missing | --- ## Usage ### No Safe Mode
Making a regular call using the method call(). ```javascript const MicroServiceCall = require('@janiscommerce/microservice-call'); const ms = new MicroServiceCall(); // Make a GET request to ms "sac" with the namespace "claim-type" and method "get". try { const response = await ms.call('sac', 'claim-type', 'get', null, null, { foo: 'bar' }); /* Response example { headers: {}, // The headers of the response. statusCode: 200, statusMessage: 'Ok', body: { foo: 'bar', id: 'foo-id', other: 100 } } */ } catch(error){ /* Error Response Example: { name: 'MicroServiceCallError' message: 'Could not found claim', code: 2, statusCode: 404 } */ if(ms.shouldRetry(error)) // false throw new Error('Should Retry') // Do something } ```
Making a regular list call using the method list(). ```javascript const MicroServiceCall = require('@janiscommerce/microservice-call'); const ms = new MicroServiceCall(); // Make a LIST request to ms "catalog" with the namespace "brand" with status filter try { const filters = { status: 'active' }; const response = await ms.list('catalog', 'brand', { filters }); /* Response example { headers: {}, // The headers of the response. statusCode: 200, statusMessage: 'Ok', body: [ { id: 'brand-1', referenceId: 'reference-id-1', name: 'Brand One' }, { id: 'brand-2', referenceId: 'reference-id-2', name: 'Brand Two' }, // 1997 objects ... { id: 'brand-2000', referenceId: 'reference-id-2000', name: 'Brand Two Thousands' } ] } */ } catch(err){ /* Error Response Example: { name: 'MicroServiceCallError' message: 'Database Fails', code: 2, statusCode: 500 } */ if(ms.shouldRetry(error)) // true throw new Error('Service Call Fails. Should Retry') // Do something } ```
### Safe Mode
Making a "safe" call using the method safeCall(). ```javascript const MicroServiceCall = require('@janiscommerce/microservice-call'); const ms = new MicroServiceCall(); // Make a GET request to ms "pricing" with the namespace "base-price" and method "get". const response = await ms.safeCall('pricing', 'base-price', 'get', null, null, { foo: 'bar' }); /* Response example { headers: {}, // The headers of the response. statusCode: 504, statusMessage: null, body: { message: 'Timeout' } } */ if(ms.shouldRetry(response)) // true throw new Error('Should Retry') // Do something // Make a POST request to ms "wms" with the namespace "stock" and method "post". const response = await ms.safeCall('wms', 'stock', 'post', { name: 'stock-1', quantity: 1 }); /* Response example { headers: {}, // The headers of the response. statusCode: 200, statusMessage: 'Ok', body: { id: 'stock-id-1' } } */ if(ms.shouldRetry(response)) // false throw new Error('Should Retry') // Do something ```
Making a "safe" list call using the method safeList(). ```javascript const MicroServiceCall = require('@janiscommerce/microservice-call'); const ms = new MicroServiceCall(); // Make a LIST request to ms "commerce" with the namespace "seller" with status filter const filters = { status: 'active' }; const response = await ms.safeList('commerce', 'seller', { filters }); /* Response example { headers: {}, // The headers of the response. statusCode: 200, statusMessage: 'Ok', body: [ { id: 'seller-1', referenceId: 'reference-id-1', name: 'Seller One' }, { id: 'seller-2', referenceId: 'reference-id-2', name: 'Seller Two' }, // 1997 objects ... { id: 'seller-2000', referenceId: 'reference-id-2000', name: 'Seller Two Thousands' } ] } */ if(ms.shouldRetry(error)) // false throw new Error('Service Call Fails. Should Retry') // Do something ```
--- _Source: https://npm.io/package/@janiscommerce/microservice-call · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._