feat(otlp): add protobuf compression (#18)

Signed-off-by: GALLLASMILAN <gallas.milan@gmail.com>

.github/workflows/main.yml

@@ -13,7 +13,7 @@ concurrency:
 jobs:
   main:
     timeout-minutes: 20
-    name: Lint & Build & Test
+    name: Lint & Format & CommitLint & Build
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4

.prettierignore

@@ -0,0 +1,7 @@
+node_modules/
+.vscode/
+.next/
+.yarn/
+pnpm-lock.yaml
+CHANGELOG.md
+schema.d.ts

package.json

@@ -30,7 +30,7 @@
     "@commitlint/cli": "^19.5.0",
     "@commitlint/config-conventional": "^19.5.0",
     "@commitlint/types": "^19.5.0",
-    "@fastify/type-provider-json-schema-to-ts": "^3.0.0",
+    "@fastify/type-provider-json-schema-to-ts": "^4.0.1",
     "@opentelemetry/exporter-trace-otlp-proto": "^0.55.0",
     "@opentelemetry/instrumentation": "^0.55.0",
     "@opentelemetry/sdk-node": "^0.55.0",
@@ -60,10 +60,11 @@
     "vitest": "^2.1.3"
   },
   "dependencies": {
-    "@fastify/auth": "^4.6.1",
-    "@fastify/request-context": "^5.1.0",
-    "@fastify/swagger": "^8.14.0",
-    "@fastify/swagger-ui": "^3.0.0",
+    "@fastify/auth": "^5.0.1",
+    "@fastify/compress": "^8.0.1",
+    "@fastify/request-context": "^6.0.1",
+    "@fastify/swagger": "^9.0.4",
+    "@fastify/swagger-ui": "^5.2.0",
     "@godaddy/terminus": "^4.12.1",
     "@grpc/grpc-js": "^1.12.2",
     "@grpc/proto-loader": "^0.7.13",
@@ -75,8 +76,8 @@
     "bullmq": "^5.8.2",
     "dotenv": "^16.4.5",
     "dotenv-safe": "^9.1.0",
-    "fastify": "^4.27.0",
-    "fastify-plugin": "^4.5.1",
+    "fastify": "^5.1.0",
+    "fastify-plugin": "^5.0.1",
     "http-status-codes": "^2.3.0",
     "ioredis": "^5.4.1",
     "json-schema-to-ts": "^3.1.0",

src/app.ts

@@ -19,6 +19,7 @@ import './utils/load-config.js';
 import Fastify from 'fastify';
 import { RequestContext } from '@mikro-orm/core';
 import { JsonSchemaToTsProvider } from '@fastify/type-provider-json-schema-to-ts';
+import compressPlugin from '@fastify/compress';
 
 import { initTerminus } from './utils/terminus.js';
 import { authPlugin } from './utils/auth.js';
@@ -66,6 +67,9 @@ export async function bootstrap({ port }: BootstrapOptions) {
     timeout: 25000 // 25s
   });
 
+  // compress gzip (followed by https://opentelemetry.io/docs/specs/otlp/#protocol-details)
+  app.register(compressPlugin, { encodings: ['gzip'], customTypes: /x-protobuf$/ });
+
   // error
   app.register(errorPlugin);
 

src/trace/trace.test.ts

@@ -39,7 +39,7 @@ describe('trace module', () => {
     expect(res.status).toBe(200);
   });
 
-  it.skip('should return the `bad request` response when the invalid result is sent', async () => {
+  it('should return the `bad request` response when the invalid result is sent', async () => {
     const { status, statusText } = await sendCustomProtobuf({
       invalidSpanKey: 4200,
       secondInvalidSpanKey: 3000

src/utils/logger.ts

@@ -22,10 +22,10 @@ import { FastifyReply, FastifyRequest } from 'fastify';
 import { Logger, LoggerOptions, pino } from 'pino';
 import { requestContext } from '@fastify/request-context';
 
-export function createLogger(
+export function createLoggerConfig(
   options?: Omit<LoggerOptions, 'name' | 'level' | 'timestamp'>
-): Logger {
-  return pino({
+): LoggerOptions {
+  return {
     ...options,
     name: 'bee-observe',
     level: process.env.LOG_LEVEL || 'info',
@@ -37,10 +37,10 @@ export function createLogger(
       },
       ...options?.formatters
     }
-  });
+  };
 }
 
-export const fastifyLogger = createLogger({
+export const fastifyLogger = createLoggerConfig({
   serializers: {
     req(request: FastifyRequest) {
       return {
@@ -72,7 +72,7 @@ export const LogLabels = {
   CORRELATION_ID: 'correlationId'
 } as const;
 
-const log = createLogger();
+const log = pino(createLoggerConfig());
 
 export const getLogger = () => {
   const request = requestContext.get('request');