User Authentication Service

Getting Started

Click "Use this template" in Github, then "Create a new repository."

Kafka

Custom built consumer and producer classes can be imported from @codrjs/kafka.

Creating a producer

import { Producer } from "@codrjs/kafka";

// this should be imported from "@codrjs/models"
interface TestMessage {
  hello: "world";
}

const Topic = "test-topic";
const TestProducer = new Producer<TestMessage>(Topic);

export default TestProducer;

Creating a consumer

import type { KafkaMessage } from "kafkajs";
import { Consumer } from "@codrjs/kafka";

import dotenv from "dotenv";
dotenv.config();

// this should be imported from "@codrjs/models"
interface TestMessage {
  hello: "world";
}

const Topic = "test-topic";
const TopicGroup = process.env.KAFKA_CONSUMER_GROUP as string;

// @ts-ignore
const processor = function (payload: TestMessage, message: KafkaMessage) {
  // do stuff here
};

const TestConsumer = new Consumer<TestMessage>({
  processor,
  groupId: TopicGroup,
  topics: [Topic],
});

export default TestConsumer;

Heath Checks

The @codrjs/kafka module automatically adds the Kafka admin client and all producers and consumers to the health check.

The only health checks that need to be added manually are for the express server and mongoose instance.

import { ServiceHealth } from "@codrjs/health";

// for Express, add the following events to the appropriate handlers.
//   This is done for you in this template.
ServiceHealth.handleEvent("express", "connect");
ServiceHealth.handleEvent("express", "disconnect");

// for Mongoose, add the connection property to the health monitor
import mongoose from "mongoose";

const client = mongoose.connect(...);
ServiceHealth.addMongo(client.connection);

Mongo

If mongo is not needed, but remove the src/server/mongo/ folder and update the src/server/index.ts and src/serve.ts accordingly. Also remove the src/types/index.d.ts file.

Environment

Necessary variables needed to run:

Env var	Location	Required	Description
ENV	env	true	Deployment envionment - dev, qa, stage, prod
AWS_REGION	aws.region	false	AWS - deployment region
AWS_SES_API_VERSION	aws.ses.api.version	false	AWS SES - api version
AWS_SES_ACCESS_KEY	aws.ses.access.key	false	AWS SES - IAM access key id
AWS_SES_ACCESS_SECRET	aws.ses.access.secret	false	AWS SES - IAM access key secret
EMAIL_FROM	email.from	false	Email - from address
EMAIL_REPLY_TO	email.replyto	false	Email - reply to address(es)
EXPRESS_HOST	express.host	false	Express server - listener host
EXPRESS_PORT	express.port	false	Express server - listener port
MONGO_URI	mongo.uri	true	MongoDB - server URL, please include username and password to this string
KAFKA_BROKERS	kafka.brokers	true	Kafka server - comma seperated locations of the kafka brokers
KAFKA_CLIENT_ID	kafka.clientId	true	Kafka server - name of the kafka cluster
KAFKA_CONSUMER_GROUP	kafka.consumer.group	true	Kafka server - consumer group
JWT_ALGORITHM	jwt.algorithm	true	JWT - algorithm, default HS256
JWT_SECRET	jwt.secret	true	JWT - secret, key to decode jwt, must be the same across all services in an environment
JWT_ISSUER	jwt.issuer	true	JWT - issuer, default codrjs.com