Chore/refactor types

processor/package.json

@@ -26,14 +26,14 @@
     "@commercetools/ts-client": "^3.0.4",
     "@fastify/autoload": "6.1.0",
     "@fastify/cors": "10.0.2",
+    "@fastify/env": "^5.0.2",
     "@fastify/formbody": "8.0.2",
     "@fastify/http-proxy": "11.0.1",
     "@fastify/request-context": "6.0.2",
     "@fastify/static": "8.1.1",
     "@fastify/type-provider-typebox": "5.1.0",
     "@sinclair/typebox": "0.34.27",
     "axios": "^1.7.9",
-    "dotenv": "16.4.7",
     "fastify": "5.2.1",
     "fastify-plugin": "5.0.1"
   },

processor/src/clients/ingrid/ingrid.client.ts

@@ -1,14 +1,15 @@
 import axios, { AxiosInstance } from 'axios';
 import {
   IngridBasePath,
-  IngridGetSessionResponse,
-  IngridUrls,
+  type IngridClientOptions,
   type IngridCompleteSessionRequestPayload,
   type IngridCompleteSessionResponse,
   type IngridCreateSessionRequestPayload,
   type IngridCreateSessionResponse,
+  IngridGetSessionResponse,
   type IngridUpdateSessionRequestPayload,
   type IngridUpdateSessionResponse,
+  IngridUrls,
 } from './types/ingrid.client.type';
 import { AbstractIngridClient } from './abstract-ingrid.client';
 import { CustomError } from '../../libs/fastify/errors';
@@ -34,7 +35,7 @@ import { CustomError } from '../../libs/fastify/errors';
 export class IngridApiClient implements AbstractIngridClient {
   private client: AxiosInstance;
 
-  constructor(opts: { apiSecret: string; environment: keyof typeof IngridBasePath }) {
+  constructor(opts: IngridClientOptions) {
     this.client = createClient(opts);
   }
 

processor/src/clients/ingrid/types/ingrid.client.type.ts

@@ -21,6 +21,11 @@ export enum IngridUrls {
   DELIVERY_CHECKOUT = '/v1/delivery_checkout',
 }
 
+export interface IngridClientOptions {
+  apiSecret: string;
+  environment: IngridEnvironment;
+}
+
 /**
  * Response type for getting an Ingrid session
  * @see {@link https://developer.ingrid.com/delivery_checkout/reference/#GetSessionResponse}

processor/src/libs/logger/index.ts

@@ -1,6 +1,5 @@
 import { createApplicationLogger } from '@commercetools-backend/loggers';
 import { getRequestContext } from '../fastify/context/context';
-import { getConfig } from '../../config';
 import setIn from 'lodash/set';
 import { format } from 'logform';
 import cloneDeep from 'lodash/cloneDeep';
@@ -30,7 +29,7 @@ const defaultFieldsFormatter = (defaults: DefaultFields) => {
 export const appLogger = createApplicationLogger({
   formatters: [
     defaultFieldsFormatter({
-      projectKey: getConfig().projectKey,
+      projectKey: process.env.CTP_PROJECT_KEY,
       version: process.env.npm_package_version,
       name: process.env.npm_package_name,
       correlationId: () => getRequestContext().correlationId,

processor/src/main.ts

@@ -1,6 +1,3 @@
-import * as dotenv from 'dotenv';
-dotenv.config();
-
 import { setupFastify } from './server/server';
 
 (async () => {

processor/src/server/Env.ts

@@ -0,0 +1,78 @@
+import { FastifyInstance } from 'fastify';
+import fastifyEnv from '@fastify/env';
+import { Static, Type } from '@sinclair/typebox';
+
+const schema = {
+  type: 'object',
+  required: [
+    'CTP_PROJECT_KEY',
+    'CTP_CLIENT_ID',
+    'CTP_CLIENT_SECRET',
+    'CTP_AUTH_URL',
+    'CTP_API_URL',
+    'CTP_SESSION_URL',
+    'LOGGER_LEVEL',
+    'INGRID_API_KEY',
+    'INGRID_ENVIRONMENT',
+    'npm_package_version',
+    'npm_package_name',
+    'keyOfIngridSessionCustomType',
+  ],
+  properties: {
+    CTP_PROJECT_KEY: { type: 'string' },
+    CTP_CLIENT_ID: { type: 'string' },
+    CTP_CLIENT_SECRET: { type: 'string' },
+    CTP_AUTH_URL: { type: 'string' },
+    CTP_API_URL: { type: 'string' },
+    CTP_SESSION_URL: { type: 'string' },
+    LOGGER_LEVEL: { type: 'string', default: 'info' },
+    INGRID_API_KEY: { type: 'string' },
+    INGRID_ENVIRONMENT: { type: 'string', enum: ['STAGING', 'PRODUCTION'] },
+    npm_package_version: { type: 'string' },
+    npm_package_name: { type: 'string' },
+    keyOfIngridSessionCustomType: { type: 'string' },
+  },
+};
+
+// eslint-disable-next-line @typescript-eslint/no-unused-vars
+const typeboxSchema = Type.Object({
+  CTP_PROJECT_KEY: Type.String(),
+  CTP_CLIENT_ID: Type.String(),
+  CTP_CLIENT_SECRET: Type.String(),
+  CTP_AUTH_URL: Type.String(),
+  CTP_API_URL: Type.String(),
+  CTP_SESSION_URL: Type.String(),
+  LOGGER_LEVEL: Type.String(),
+  INGRID_API_KEY: Type.String(),
+  INGRID_ENVIRONMENT: Type.Enum({
+    STAGING: 'STAGING',
+    PRODUCTION: 'PRODUCTION',
+  }),
+  npm_package_version: Type.String(),
+  npm_package_name: Type.String(),
+  keyOfIngridSessionCustomType: Type.String(),
+});
+
+export type Env = Static<typeof typeboxSchema>;
+
+const options = {
+  confKey: 'environmentVariables',
+  schema: schema,
+  dotenv: true,
+};
+
+/**
+ * Configures environment variables for the Fastify server using @fastify/env plugin.
+ * This function registers environment variables according to the defined schema and
+ * makes them available through server.config.
+ */
+export async function configureEnvironmentVariables(server: FastifyInstance): Promise<Env> {
+  await server.register(fastifyEnv, options);
+  return server.environmentVariables as Env;
+}
+
+declare module 'fastify' {
+  interface FastifyInstance {
+    environmentVariables: Env;
+  }
+}

processor/src/server/plugins/ingrid-shipping.plugin.ts

@@ -2,20 +2,20 @@ import { FastifyInstance } from 'fastify';
 import { shippingRoutes } from '../../routes/ingrid-shipping.route';
 import { IngridShippingService } from '../../services/ingrid-shipping.service';
 import { IngridApiClient } from '../../clients/ingrid/ingrid.client';
-import { getConfig } from '../../config';
 import { CommercetoolsApiClient } from '../../clients/commercetools/api.client';
 import { appLogger } from '../../libs/logger';
 import { RequestContextData, updateRequestContext, getRequestContext } from '../../libs/fastify/context';
 import { SessionHeaderAuthInitializer } from '../../libs/auth';
+import { IngridClientOptions } from '../../clients/ingrid/types/ingrid.client.type';
 
 export default async function (server: FastifyInstance) {
   const opts = {
-    clientId: getConfig().clientId,
-    clientSecret: getConfig().clientSecret,
-    authUrl: getConfig().authUrl,
-    apiUrl: getConfig().apiUrl,
-    projectKey: getConfig().projectKey,
-    sessionUrl: getConfig().sessionUrl,
+    clientId: server.environmentVariables.CTP_CLIENT_ID,
+    clientSecret: server.environmentVariables.CTP_CLIENT_SECRET,
+    authUrl: server.environmentVariables.CTP_AUTH_URL,
+    apiUrl: server.environmentVariables.CTP_API_URL,
+    projectKey: server.environmentVariables.CTP_PROJECT_KEY,
+    sessionUrl: server.environmentVariables.CTP_SESSION_URL,
     logger: appLogger,
     getContextFn: (): RequestContextData => {
       const { correlationId, requestId, authentication } = getRequestContext();
@@ -36,9 +36,9 @@ export default async function (server: FastifyInstance) {
     },
   };
 
-  const ingridOpts = {
-    apiSecret: getConfig().ingridApiKey,
-    environment: getConfig().ingridEnvironment as 'STAGING' | 'PRODUCTION',
+  const ingridOpts: IngridClientOptions = {
+    apiSecret: server.environmentVariables.INGRID_API_KEY,
+    environment: server.environmentVariables.INGRID_ENVIRONMENT,
   };
 
   const commercetoolsApiClient: CommercetoolsApiClient = new CommercetoolsApiClient(opts);

processor/src/server/server.ts

@@ -4,9 +4,9 @@ import fastifyFormBody from '@fastify/formbody';
 import Fastify from 'fastify';
 import { randomUUID } from 'node:crypto';
 import { join } from 'path';
-import { getConfig } from '../config';
 import { requestContextPlugin } from '../libs/fastify/context';
 import { errorHandler } from '../libs/fastify/error-handler';
+import { configureEnvironmentVariables } from './Env';
 
 /**
  * Setup Fastify server instance
@@ -16,13 +16,15 @@ export const setupFastify = async () => {
   // Create fastify server instance
   const server = Fastify({
     logger: {
-      level: getConfig().loggerLevel,
+      level: process.env.LOGGER_LEVEL || 'info',
     },
     genReqId: () => randomUUID().toString(),
     requestIdLogLabel: 'requestId',
     requestIdHeader: 'x-request-id',
   });
 
+  await configureEnvironmentVariables(server);
+
   // Setup error handler
   server.setErrorHandler(errorHandler);
 

processor/src/services/ingrid-shipping.service.ts

@@ -10,7 +10,6 @@ import {
 } from './helpers';
 import { Cart } from '@commercetools/platform-sdk';
 import { InitSessionResponse, UpdateSessionResponse } from './types/ingrid-shipping.type';
-import { getConfig } from '../config';
 
 export class IngridShippingService extends AbstractShippingService {
   constructor(commercetoolsClient: CommercetoolsApiClient, ingridClient: IngridApiClient) {
@@ -26,7 +25,7 @@ export class IngridShippingService extends AbstractShippingService {
    * @returns {Promise<InitSessionResponse>} Returns the commercetools cart id, ingrid session id and ingrid checkout session html snippet
    */
   public async init(): Promise<InitSessionResponse> {
-    const ingridSessionCustomTypeKey = getConfig().keyOfIngridSessionCustomType;
+    const ingridSessionCustomTypeKey = process.env.INGRID_SESSION_CUSTOM_TYPE_KEY || 'ingrid-session';
     const customType = await this.commercetoolsClient.getCustomType(ingridSessionCustomTypeKey);
 
     if (!customType) {