Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/peak-ai/ais-service-discovery-js
https://github.com/peak-ai/ais-service-discovery-js
Last synced: 7 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/peak-ai/ais-service-discovery-js
- Owner: peak-ai
- License: gpl-3.0
- Created: 2019-07-12T10:55:33.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-01-10T12:30:00.000Z (10 months ago)
- Last Synced: 2024-09-20T13:16:16.861Z (about 2 months ago)
- Language: JavaScript
- Size: 1.3 MB
- Stars: 36
- Watchers: 4
- Forks: 8
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Cloud Application Framework
## Description
This repository interfaces Service Discovery, in this instance CloudMap, in order to locate and communicate with different services. As opposed to storing ARN's in environment variables, this library will interface CloudMap to find a service by a user friendly naming convention, and will understand what 'type' of service you've requested, and use the correct code to communicate/call that service.
## Services supported
- Lambda (`request`|`call`).
- SNS (`publish`). // subscribe not supported by SNS.
- SQS (`queue`|`listen`),
- Automation//SSM task (`automate` | `script`).
- Step function (`state-machine`).
## Examples:
### Import
```javascript
const ServiceDiscovery = require('@peak-ai/ais-service-discovery');
```
### Call a function
```javascript
await ServiceDiscovery.request('namespace.service->handler', body);
```
### Publish an SNS event
```javascript
await ServiceDiscovery.publish('namspace.service-name->topic', event, {
...opts,
attributes: { // Matches params.MessageAttributes from aws-sdk
tenant: {
DataType: 'String',
StringValue: 'foo',
},
},
});
```
### Add message to queue
```javascript
await ServiceDiscovery.queue('namespace.service-name->queue-name', message, opts // optional);
```
### List to queue
```javascript
const messages = await ServiceDiscovery.listen('namespace.service-name->queue-name', opts // optional);
messages.on('message', (message) => {
});
```
### Register a service (Cloudformation)
```yaml
CloudMapService:
Type: AWS::ServiceDiscovery::Service
Properties:
Description: discover handlers for ais-service-segment-explorer
Name: segment-explorer
NamespaceId: ${cf:ais-${opt:stage}-service-discovery.NamespaceId}
CreateRefreshSegmentInstance:
Type: "AWS::ServiceDiscovery::Instance"
Properties:
InstanceAttributes:
arn: ${self:service}-${opt:stage}-refresh-segment
type: function
InstanceId: refresh-segment
ServiceId:
Ref: CloudMapService
```
## Upcoming Beta version
We're releasing an update which allows you to configure and write modular 'backends' for the core service discovery library.
In this new version we're also introducing Typescript.
For example (previous):
```typescript
const ServiceDiscovery = require('@peak-ai/ais-service-discovery-js');
ServiceDiscovery.request('latest.service->instance', request);
```
The above example only deals with AWS, and there's no way to reconfigure this behaviour.
This is fairly limiting, especially for testing locally. We came up with the idea of being able to 'mock' or 'stub' these requests locally, for a faster development process.
New example:
```typescript
import { WithMockedBackend, WithAWSBackend } from "@peak-ai/ais-service-discovery-js";
// Config to decide what to do locally
const config = {
"latest.service->instance": {
resolver: { mockedResponse: { message: 'Hello World' } },
},
};
// Responds with mocked responses
const local = WithMockedBackend(config);
const res = await local.request('latest.service->instance', request);
// Communicates via SQS
const prod = WithAWSBackend();
await prod.queue('latest.service->instance', request);
```
### Integration Tests
#### Prerequisites
1. AWS Account Access
2. Run the infrastructure CDK plan, found in ./examples/infrastructure (follow the instructions in the README there).
3. Ensure you have your AWS_PROFILE, and AWS_REGION env vars set correctly.
#### Run integration tests
```bash
$ yarn run test:integration
```