PURISTA

Appearance

PURISTA API

PURISTA API / @purista/k8s-sdk

@purista/k8s-sdk ​

SDK and helper to run PURISTA services in Kubernetes.

Here is a full example, how the index file might look like, if you want to deploy a service to Kubernetes.

typescript
import { serve } from '@hono/node-server'
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'
import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base'
import { AmqpBridge } from '@purista/amqpbridge'
import {
  DefaultConfigStore,
  DefaultSecretStore,
  DefaultStateStore,
  getNewInstanceId,
  gracefulShutdown,
  initLogger,
  UnhandledError,
} from '@purista/core'
import { getHttpServer } from '@purista/k8s-sdk'

import { theServiceV1Service } from './service/theService/v1/index.js'

const main = async () => {
  // create a logger
  const logger = initLogger('debug')

  // add listeners to log really unexpected errors
  process.on('uncaughtException', (error, origin) => {
    const err = UnhandledError.fromError(error)
    logger.error({ err, origin }, `unhandled error: ${err.message}`)
  })

  process.on('unhandledRejection', (error, origin) => {
    const err = UnhandledError.fromError(error)
    logger.error({ err, origin }, `unhandled rejection: ${err.message}`)
  })

  // optional: set up opentelemetry if you like to use it
  const exporter = new OTLPTraceExporter({
    url: `http://localhost:14268/api/traces`,
  })
  const spanProcessor = new SimpleSpanProcessor(exporter)

  // optional: set up stores if they are needed for your service
  const secretStore = new DefaultSecretStore({ logger })
  const configStore = new DefaultConfigStore({ logger })
  const stateStore = new DefaultStateStore({ logger })

  // set up the eventbridge and start the event bridge
  const eventBridge = new AmqpBridge({
    spanProcessor,
    instanceId: process.env.HOSTNAME || getNewInstanceId(),
    url: process.env.AMQP_URL,
  })
  await eventBridge.start()

  // set up the service
  const theService = await theServiceV1Service.getInstance(eventBridge, {
    spanProcessor,
    configStore,
    secretStore,
    stateStore,
  })
  await theService.start()

  // create http server
  const app = getHttpServer({
    logger,
    // check event bridge health if /healthz endpoint is called
    healthFn: () => eventBridge.isHealthy(),
    // optional: expose the commands if they are defined to have url endpoint
    services: theService,
    // optional: expose service endpoints at [apiMountPath]/v[serviceVersion]/[path defined for command]
    // defaults to /api
    apiMountPath: '/api',
  })

  // start the http server
  // defaults to port 3000
  // optional: you can set the port in the optional parameter of this method
  const server = serve({
    fetch: app.fetch,
  })

  // register shut down methods
  gracefulShutdown(logger, [
    // begin with the event bridge to no longer accept incoming messages
    eventBridge,
    // optional: shut down the service
    theService,
    // optional: shut down the secret store
    secretStore,
    // optional: shut down the config store
    configStore,
    // optional: shut down the state store
    stateStore,
    {
      name: 'httpserver',
      destroy: async () =>
        new Promise((resolve, reject) => server.close((err) => (err ? reject(err) : resolve(undefined)))),
    },
  ])
}

main()

Visit purista.dev

Follow on Twitter @purista_js
Join the Discord Chat

PURISTA - Typescript framework for IoT, microservices, and serverless | Product Hunt

SDK and helper to run PURISTA services in Kubernetes.

Here is a full example, how the index file might look like, if you want to deploy a service to Kubernetes.

Example ​

typescript
import { serve } from '@hono/node-server'
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-http'
import { SimpleSpanProcessor } from '@opentelemetry/sdk-trace-base'
import { AmqpBridge } from '@purista/amqpbridge'
import {
 DefaultConfigStore,
 DefaultSecretStore,
 DefaultStateStore,
 getNewInstanceId,
 gracefulShutdown,
 initLogger,
 UnhandledError,
} from '@purista/core'
import { getHttpServer } from '@purista/k8s-sdk'

import { theServiceV1Service } from './service/theService/v1/theServiceV1Service.js'

const main = async () => {
 // create a logger
 const logger = initLogger('debug')

 // add listeners to log really unexpected errors
 process.on('uncaughtException', (error, origin) => {
   const err = UnhandledError.fromError(error)
   logger.error({ err, origin }, `unhandled error: ${err.message}`)
 })

 process.on('unhandledRejection', (error, origin) => {
   const err = UnhandledError.fromError(error)
   logger.error({ err, origin }, `unhandled rejection: ${err.message}`)
 })

 // optional: set up opentelemetry if you like to use it
 const exporter = new OTLPTraceExporter({
   url: `http://localhost:14268/api/traces`,
 })
 const spanProcessor = new SimpleSpanProcessor(exporter)

 // optional: set up stores if they are needed for your service
 const secretStore = new DefaultSecretStore({ logger })
 const configStore = new DefaultConfigStore({ logger })
 const stateStore = new DefaultStateStore({ logger })

 // set up the eventbridge and start the event bridge
 const eventBridge = new AmqpBridge({
   spanProcessor,
   instanceId: process.env.HOSTNAME || getNewInstanceId(),
   url: process.env.AMQP_URL,
 })
 await eventBridge.start()

 // set up the service
 const theService = await theServiceV1Service.getInstance(eventBridge, {
   spanProcessor,
   configStore,
   secretStore,
   stateStore,
 })
 await theService.start()

 // create http server
 const app = getHttpServer({
   logger,
   // check event bridge health if /healthz endpoint is called
   healthFn: () => eventBridge.isHealthy(),
   // optional: expose the commands if they are defined to have url endpoint
   services: theService,
   // optional: expose service endpoints at [apiMountPath]/v[serviceVersion]/[path defined for command]
   // defaults to /api
   apiMountPath: '/api',
 })

 // start the http server
 // defaults to port 3000
 // optional: you can set the port in the optional parameter of this method
 const server = serve({
   fetch: app.fetch,
 })

 // register shut down methods
 gracefulShutdown(logger, [
   // begin with the event bridge to no longer accept incoming messages
   eventBridge,
   // optional: shut down the service
   theService,
   // optional: shut down the secret store
   secretStore,
   // optional: shut down the config store
   configStore,
   // optional: shut down the state store
   stateStore,
   {
     name: 'httpserver',
     destroy: async () =>
       new Promise((resolve, reject) => server.close((err) => (err ? reject(err) : resolve(undefined)))),
   },
 ])
}

main()

Type Aliases ​

Variables ​

Functions ​