@zup-it/beagle-web-grpc v1.0.0

Beagle WEB gRPC

What is gRPC?

It is an open source framework to perform RPC (Remote call procedure) calls, through the HTTP2 protocol in a two-way streaming format, using Protobufs as interfaces between client and server.

Protobufs, or Protocol Buffers, are a structured data serialization mechanism created by Google, which aim to keep contracts always valid and consistent regarding the implementations that consume a gRPC service.

Proto files, in their content, are very similar to any interface we are used to on the daily basis, but with the .proto extension, where we define which objects and methods are likely to be used in the service's communication.

Learn more...

gRPC for Beagle Web

gRPC is a technology that makes use of the HTTP 2 protocol, however, this technology is not compatible with the current Web structure, so the structure created uses a Client and a CLI, where the CLI is responsible for handling gRPC connections through a Proxy, written with Go, and the Client is responsible for handling all requests made by Beagle to the Proxy.

Requirements

• Git - CLI: Used internally as a proxy dependency.
• Go - CLI: Language which the proxy is written.
• Dep - CLI: Go's dependency manager, where it checks that everything is installed and working as expected.
• Protoc - CLI: Used by protobufs and necessary for code generation through a .proto file.

Installation

To install the library, install it globally, for a better experience with the CLI, and then install it in your project using the following commands:

npm install -g @zup-it/beagle-web-grpc
npm install --save-dev @zup-it/beagle-web-grpc

or if you use yarn:

yarn global add @zup-it/beagle-web-grpc
yarn add --dev @zup-it/beagle-web-grpc

Getting Started

1. After installing the library, in the project and globally, create the configuration file in the project's root folder, using: beagle-web-grpc init and then configure the attributes according to your needs.

2. Then import the gRPC Client:

   • React: ./src/beagle/beagle-service.ts

     import { createBeagleUIService } from '@zup-it/beagle-react'
     import { usingBeagleGrpcClient } from '@zup-it/beagle-web-grpc'
     
     export default createBeagleUIService({
       baseUrl: 'grpc://',
       components: {},
       fetchData: usingBeagleGrpcClient({ proxyAddress: 'http://localhost:8081' })
     })

   • Angular: ./src/app/beagle.module.ts

     import { BeagleModule } from '@zup-it/beagle-angular'
     import { usingBeagleGrpcClient } from '@zup-it/beagle-web-grpc'
     
     @BeagleModule({
       baseUrl: 'grpc://',
       module: {
         path: './beagle-components.module',
         name: 'BeagleComponentsModule',
       },
       components: {},
       fetchData: usingBeagleGrpcClient({ proxyAddress: 'http://localhost:8081' })
     })
     export class Beagle {}

3. Start your proxy running the following command on the root of the project: beagle-web-grpc start-proxy or beagle-web-grpc spx or beagle-web-grpc start-proxy --mode your-mode.

4. Use the Beagle Web as usually.

Observations Make sure that your BFF Application is running.

CLI

As gRPC is not compatible with the current structure of the Web, to support the technology, it is necessary to use a Proxy to establish the communication between the REST application and the gRPC Backend application, so we created a CLI (command-line interface), beagle-web-grpc, to facilitate the use of the proxy and provide all the necessary settings.

Available commands for beagle-web-grpc

Configuration file ./beagle-grpc.config.json

After running beagle-web-grpc init the file ./beagle-grpc.config.json will be created where the command was executed, generating a file with this content:

{
  "configs": [
    {
      "mode": "development",
      "grpcBackendAddress": "localhost:50051",
      "tlsCertificatePath": "",
      "tlsKeyPath": "",
      "runProxyOnPort": 8081
    },
    {
      "mode": "production",
      "grpcBackendAddress": "https://my-grpc.backend.com/address",
      "tlsCertificatePath": "",
      "tlsKeyPath": "",
      "runProxyOnPort": 8081
    }
  ]
}

Attributes of the configuration file ./beagle-grpc.config.json

Client

The gRPC Client for Beagle Web is what redirects grpc requests to the proxy, the client is used through BeagleService in React and the Beagle module in Angular, using the fetchData property, which Beagle allows you to create custom HTTP requests, so the use goes like this:

import { usingBeagleGrpcClient } from '@zup-it/beagle-web-grpc'

// { ... } - your module or service code
{
  // { ... } - other attributes
  fetchData: usingBeagleGrpcClient({ proxyAddress: 'http://localhost:8081' })
}

The gRPC client has the following initialization options (BeagleGrpcClientOptions):