Merged in feat/sw-2859-set-up-shared-trpc-package (pull request #2319)
feat(SW-2859): Create trpc package * Add isEdge, safeTry and dataCache to new common package * Add eslint and move prettier config * Clean up tests * Create trpc package and move initialization * Move errors and a few procedures * Move telemetry to common package * Move tokenManager to common package * Add Sentry to procedures * Clean up procedures * Fix self-referencing imports * Add exports to packages and lint rule to prevent relative imports * Add env to trpc package * Add eslint to trpc package * Apply lint rules * Use direct imports from trpc package * Add lint-staged config to trpc * Move lang enum to common * Restructure trpc package folder structure * Fix lang imports Approved-by: Linus Flood
This commit is contained in:
8
packages/common/constants/language.ts
Normal file
8
packages/common/constants/language.ts
Normal file
@@ -0,0 +1,8 @@
|
||||
export enum Lang {
|
||||
da = "da",
|
||||
de = "de",
|
||||
en = "en",
|
||||
fi = "fi",
|
||||
no = "no",
|
||||
sv = "sv",
|
||||
}
|
||||
6
packages/common/env/server.ts
vendored
6
packages/common/env/server.ts
vendored
@@ -17,6 +17,9 @@ export const env = createEnv({
|
||||
? z.string()
|
||||
: z.string().optional().default("dev"),
|
||||
GIT_SHA: z.string().optional(),
|
||||
CURITY_ISSUER_USER: z.string(),
|
||||
CURITY_CLIENT_ID_SERVICE: z.string().default("scandichotels-web-backend"),
|
||||
CURITY_CLIENT_SECRET_SERVICE: z.string(),
|
||||
},
|
||||
emptyStringAsUndefined: true,
|
||||
runtimeEnv: {
|
||||
@@ -25,5 +28,8 @@ export const env = createEnv({
|
||||
REDIS_API_KEY: process.env.REDIS_API_KEY,
|
||||
BRANCH: process.env.BRANCH,
|
||||
GIT_SHA: process.env.GIT_SHA,
|
||||
CURITY_CLIENT_SECRET_SERVICE: process.env.CURITY_CLIENT_SECRET_SERVICE,
|
||||
CURITY_ISSUER_USER: process.env.CURITY_ISSUER_USER,
|
||||
CURITY_CLIENT_ID_SERVICE: process.env.CURITY_CLIENT_ID_SERVICE,
|
||||
},
|
||||
})
|
||||
|
||||
@@ -10,10 +10,22 @@
|
||||
"check-types": "tsc --noEmit",
|
||||
"lint": "eslint . --max-warnings 0 && tsc --noEmit"
|
||||
},
|
||||
"exports": {
|
||||
"./global.d.ts": "./global.d.ts",
|
||||
"./dataCache": "./dataCache/index.ts",
|
||||
"./telemetry": "./telemetry/index.ts",
|
||||
"./tokenManager": "./tokenManager/index.ts",
|
||||
"./utils/isEdge": "./utils/isEdge.ts",
|
||||
"./utils/safeTry": "./utils/safeTry.ts",
|
||||
"./constants/language": "./constants/language.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
"@opentelemetry/api": "^1.9.0",
|
||||
"@sentry/nextjs": "^8.41.0",
|
||||
"@t3-oss/env-nextjs": "^0.13.4",
|
||||
"deepmerge": "^4.3.1",
|
||||
"flat": "^6.0.1",
|
||||
"lodash-es": "^4.17.21",
|
||||
"zod": "^3.24.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
@@ -21,6 +33,7 @@
|
||||
"@eslint/eslintrc": "^3.3.1",
|
||||
"@eslint/js": "^9.26.0",
|
||||
"@scandic-hotels/typescript-config": "workspace:*",
|
||||
"@types/lodash-es": "^4",
|
||||
"@typescript-eslint/eslint-plugin": "^8.32.0",
|
||||
"@typescript-eslint/parser": "^8.32.0",
|
||||
"dotenv": "^16.5.0",
|
||||
|
||||
135
packages/common/telemetry/index.test.ts
Normal file
135
packages/common/telemetry/index.test.ts
Normal file
@@ -0,0 +1,135 @@
|
||||
import { describe, expect, test } from "vitest"
|
||||
|
||||
import { sanitize } from "."
|
||||
|
||||
describe("sanitize", () => {
|
||||
test("should handle valid primitive attributes", () => {
|
||||
const input = {
|
||||
key1: "value1",
|
||||
key2: 10,
|
||||
key3: true,
|
||||
}
|
||||
const expected = {
|
||||
key1: "value1",
|
||||
key2: 10,
|
||||
key3: true,
|
||||
}
|
||||
expect(sanitize(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
test("should handle valid array attributes", () => {
|
||||
const input = {
|
||||
key1: ["value1", "value2"],
|
||||
key2: [1, 2, 3],
|
||||
key3: [true, false, true],
|
||||
key4: [null, undefined, "a", 1, true],
|
||||
}
|
||||
const expected = {
|
||||
"key1.0": "value1",
|
||||
"key1.1": "value2",
|
||||
"key2.0": 1,
|
||||
"key2.1": 2,
|
||||
"key2.2": 3,
|
||||
"key3.0": true,
|
||||
"key3.1": false,
|
||||
"key3.2": true,
|
||||
"key4.0": null,
|
||||
"key4.1": undefined,
|
||||
"key4.2": "a",
|
||||
"key4.3": 1,
|
||||
"key4.4": true,
|
||||
}
|
||||
expect(sanitize(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
test("should stringify non-valid attributes", () => {
|
||||
const input = {
|
||||
key1: new Date("2024-08-08T12:00:00Z"),
|
||||
key2: { nested: "object" },
|
||||
}
|
||||
const expected = {
|
||||
key1: '"2024-08-08T12:00:00.000Z"',
|
||||
"key2.nested": "object",
|
||||
}
|
||||
expect(sanitize(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
test("should handle nested valid attributes", () => {
|
||||
const input = {
|
||||
key1: "Example",
|
||||
key2: 10,
|
||||
nested: {
|
||||
nestedKey1: "Value",
|
||||
nestedKey2: {
|
||||
nestedKey2Key1: true,
|
||||
},
|
||||
},
|
||||
}
|
||||
const expected = {
|
||||
key1: "Example",
|
||||
key2: 10,
|
||||
"nested.nestedKey1": "Value",
|
||||
"nested.nestedKey2.nestedKey2Key1": true,
|
||||
}
|
||||
expect(sanitize(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
test("should handle a mix of valid and non-valid nested attributes", () => {
|
||||
const input = {
|
||||
key1: "Example",
|
||||
key2: 10,
|
||||
nested: {
|
||||
nestedKey1: "Value",
|
||||
nestedKey2: {
|
||||
nestedKey2Key1: true,
|
||||
nestedKey2Key2: new Date("2024-08-08T12:00:00Z"),
|
||||
},
|
||||
nestedKey3: {
|
||||
reallyNested: "hello",
|
||||
},
|
||||
},
|
||||
nonPrimitive: new Date("2024-08-08T13:00:00Z"),
|
||||
}
|
||||
const expected = {
|
||||
key1: "Example",
|
||||
key2: 10,
|
||||
"nested.nestedKey1": "Value",
|
||||
"nested.nestedKey2.nestedKey2Key1": true,
|
||||
"nested.nestedKey2.nestedKey2Key2": '"2024-08-08T12:00:00.000Z"',
|
||||
"nested.nestedKey3.reallyNested": "hello",
|
||||
nonPrimitive: '"2024-08-08T13:00:00.000Z"',
|
||||
}
|
||||
expect(sanitize(input)).toEqual(expected)
|
||||
})
|
||||
|
||||
test("should throw an error when a function is passed", () => {
|
||||
const input = {
|
||||
key1: () => {},
|
||||
}
|
||||
expect(() => sanitize(input)).toThrowError("Cannot sanitize function")
|
||||
})
|
||||
|
||||
test("should throw an error when input not an object", () => {
|
||||
// @ts-expect-error: array not allowed. We do this here to make sure the
|
||||
// function not only relies on TS but actively blocks arrays as input.
|
||||
expect(() => sanitize(null)).toThrowError()
|
||||
|
||||
// @ts-expect-error: array not allowed. We do this here to make sure the
|
||||
// function not only relies on TS but actively blocks arrays as input.
|
||||
expect(() => sanitize(undefined)).toThrowError()
|
||||
|
||||
// @ts-expect-error: array not allowed. We do this here to make sure the
|
||||
// function not only relies on TS but actively blocks arrays as input.
|
||||
expect(() => sanitize("")).toThrowError()
|
||||
|
||||
// @ts-expect-error: array not allowed. We do this here to make sure the
|
||||
// function not only relies on TS but actively blocks arrays as input.
|
||||
expect(() => sanitize([1, 2, 3])).toThrowError()
|
||||
})
|
||||
|
||||
test("should handle empty input", () => {
|
||||
const input = {}
|
||||
const expected = {}
|
||||
expect(sanitize(input)).toEqual(expected)
|
||||
})
|
||||
})
|
||||
309
packages/common/telemetry/index.ts
Normal file
309
packages/common/telemetry/index.ts
Normal file
@@ -0,0 +1,309 @@
|
||||
// Central place for telemetry
|
||||
// TODO: Replace all of this with proper tracers and events
|
||||
|
||||
import {
|
||||
type Attributes,
|
||||
type AttributeValue,
|
||||
metrics,
|
||||
} from "@opentelemetry/api"
|
||||
import deepmerge from "deepmerge"
|
||||
import { flatten } from "flat"
|
||||
import {
|
||||
every,
|
||||
isArray,
|
||||
isBoolean,
|
||||
isFunction,
|
||||
isNull,
|
||||
isNumber,
|
||||
isObject,
|
||||
isPlainObject,
|
||||
isString,
|
||||
isUndefined,
|
||||
keys,
|
||||
mapValues,
|
||||
} from "lodash-es"
|
||||
|
||||
import type { ZodError } from "zod"
|
||||
|
||||
type AttributesInput = Record<string, unknown>
|
||||
|
||||
function isAttributesInput(value: unknown): value is AttributesInput {
|
||||
return (
|
||||
isObject(value) &&
|
||||
!isArray(value) &&
|
||||
!isNull(value) &&
|
||||
keys(value).length > 0 &&
|
||||
every(keys(value), isString)
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Checks if a given value is a valid OpenTelemetry `AttributeValue`.
|
||||
* An `AttributeValue` can be a `string`, `number`, `boolean`, or a homogenous
|
||||
* array containing only `null`, `undefined`, `string`, `number`, or `boolean`.
|
||||
*
|
||||
* @param value The value to check.
|
||||
* @returns `true` if the value is a valid `AttributeValue`, `false` otherwise.
|
||||
*/
|
||||
export function isValidAttributeValue(value: unknown): value is AttributeValue {
|
||||
if (isString(value) || isNumber(value) || isBoolean(value)) {
|
||||
return true
|
||||
}
|
||||
if (isArray(value)) {
|
||||
return every(
|
||||
value,
|
||||
(item) =>
|
||||
isNull(item) ||
|
||||
isUndefined(item) ||
|
||||
isString(item) ||
|
||||
isNumber(item) ||
|
||||
isBoolean(item)
|
||||
)
|
||||
}
|
||||
return false
|
||||
}
|
||||
|
||||
/**
|
||||
* Sanitizes an input object, ensuring its values are valid OpenTelemetry
|
||||
* `AttributeValue` or `JSON.stringify()` representations as a fallback.
|
||||
* It recursively processes nested objects and flattens the final object to one
|
||||
* level deep with dot delimited keys for nested values.
|
||||
*
|
||||
* @param data The input object to sanitize.
|
||||
* @returns The resulting object.
|
||||
*
|
||||
* @example
|
||||
* ```typescript
|
||||
* import { sanitize } from '@/server/telemetry';
|
||||
*
|
||||
* const input = {
|
||||
* key1: "Example",
|
||||
* key2: 10,
|
||||
* nested: {
|
||||
* nestedKey1: "Value",
|
||||
* nestedKey2: {
|
||||
* nestedKey2Key1: true,
|
||||
* },
|
||||
* },
|
||||
* };
|
||||
*
|
||||
* const sanitized = sanitize(input);
|
||||
* console.log(sanitized);
|
||||
* // {
|
||||
* // key1: "Example",
|
||||
* // key2: 10,
|
||||
* // "nested.nestedKey1": "Value",
|
||||
* // "nested.nestedKey2.nestedKey2Key1": true,
|
||||
* // }
|
||||
* ```
|
||||
*/
|
||||
export function sanitize(data: AttributesInput): Attributes {
|
||||
if (!isPlainObject(data)) {
|
||||
throw new Error(`Input must be an object, got ${JSON.stringify(data)}`)
|
||||
}
|
||||
|
||||
return flatten(
|
||||
mapValues(data, (value) => {
|
||||
if (isFunction(value)) {
|
||||
throw new Error("Cannot sanitize function")
|
||||
} else if (isValidAttributeValue(value)) {
|
||||
return value
|
||||
} else if (isAttributesInput(value)) {
|
||||
return sanitize(value)
|
||||
}
|
||||
|
||||
return JSON.stringify(value)
|
||||
})
|
||||
)
|
||||
}
|
||||
|
||||
/**
|
||||
* Creates an object that holds three OpenTelemetry counter instruments. One
|
||||
* that represents the counter itself, one for the success and one for any fail.
|
||||
* The object contains an `init method that acts as a factory to create the a
|
||||
* final object that holds methods to record different types of events one the
|
||||
* appropriate counter.
|
||||
*
|
||||
* @param meterName The name of the OpenTelemetry meter to create.
|
||||
* @param counterName The name of the counter instrument to create.
|
||||
* @returns An object with an `init` method that returns an object
|
||||
* with methods for recording counter events.
|
||||
*
|
||||
* @example
|
||||
*
|
||||
* See the codebase for reference usage.
|
||||
*/
|
||||
export function createCounter(meterName: string, counterName: string) {
|
||||
const meter = metrics.getMeter(meterName)
|
||||
|
||||
const fullName = `${meterName}.${counterName}`
|
||||
|
||||
const counter = meter.createCounter(fullName)
|
||||
const success = meter.createCounter(`${fullName}-success`)
|
||||
const fail = meter.createCounter(`${fullName}-fail`)
|
||||
|
||||
return {
|
||||
/**
|
||||
* Initializes the counter event handlers with a set of base attributes.
|
||||
* These attributes will be included in all recorded events.
|
||||
*
|
||||
* @param baseAttrs - The base attributes to associate with the counter. Defaults to an empty object.
|
||||
* @returns An object with methods to record specific counter events.
|
||||
*/
|
||||
init(baseAttrs: AttributesInput = {}) {
|
||||
return {
|
||||
/**
|
||||
* Records an event for the main counter.
|
||||
*
|
||||
* @param attrs - Additional attributes specific to this 'start' event. Defaults to an empty object.
|
||||
*/
|
||||
start(attrs: AttributesInput = {}) {
|
||||
const mergedAttrs = deepmerge.all<AttributesInput>([baseAttrs, attrs])
|
||||
const finalAttrs = sanitize(mergedAttrs)
|
||||
|
||||
counter.add(1, finalAttrs)
|
||||
console.info(`[${fullName}] start:`, finalAttrs)
|
||||
},
|
||||
|
||||
/**
|
||||
* Records an event for the success counter.
|
||||
*
|
||||
* @param attrs - Additional attributes specific to this 'success' event. Defaults to an empty object.
|
||||
*/
|
||||
success(attrs: AttributesInput = {}) {
|
||||
const mergedAttrs = deepmerge.all<AttributesInput>([baseAttrs, attrs])
|
||||
const finalAttrs = sanitize(mergedAttrs)
|
||||
|
||||
success.add(1, finalAttrs)
|
||||
console.info(`[${fullName}] success:`, finalAttrs)
|
||||
},
|
||||
|
||||
/**
|
||||
* Records an event of type `data_error` for the fail counter.
|
||||
* Used when some dependent data could not be resolved during the
|
||||
* operation. Note that "no data" also exists and might be more
|
||||
* appropriate in certain situations.
|
||||
*
|
||||
* @param errorMsg - A message describing the data error.
|
||||
* @param attrs - Additional attributes specific to this 'dataError' event. Defaults to an empty object.
|
||||
*/
|
||||
dataError(errorMsg: string, attrs: AttributesInput = {}) {
|
||||
const mergedAttrs = deepmerge.all<AttributesInput>([
|
||||
baseAttrs,
|
||||
attrs,
|
||||
{
|
||||
error_type: "data_error",
|
||||
error: errorMsg,
|
||||
},
|
||||
])
|
||||
const finalAttrs = sanitize(mergedAttrs)
|
||||
|
||||
fail.add(1, finalAttrs)
|
||||
console.error(`[${fullName}] dataError:`, finalAttrs)
|
||||
},
|
||||
|
||||
/**
|
||||
* Records an event of type `not_found` for the fail counter.
|
||||
* Used when some dependent data could not be found during the operation.
|
||||
* Note that when there is an error resolving the data, the
|
||||
* `dataError` method might be more appropriate.
|
||||
*
|
||||
* @param attrs - Additional attributes specific to this 'noDataError' event. Defaults to an empty object.
|
||||
*/
|
||||
noDataError(attrs: AttributesInput = {}) {
|
||||
const mergedAttrs = deepmerge.all<AttributesInput>([
|
||||
baseAttrs,
|
||||
attrs,
|
||||
{
|
||||
error_type: "not_found",
|
||||
},
|
||||
])
|
||||
const finalAttrs = sanitize(mergedAttrs)
|
||||
|
||||
fail.add(1, finalAttrs)
|
||||
console.error(`[${fullName}] noDataError:`, finalAttrs)
|
||||
},
|
||||
|
||||
/**
|
||||
* Records an event of type `validation_error` for the fail counter.
|
||||
* Used when a Zod schema fails validation.
|
||||
*
|
||||
* @param zodError - The {@link ZodError} object representing the validation error.
|
||||
*/
|
||||
validationError(zodError: ZodError) {
|
||||
const mergedAttrs = deepmerge.all<AttributesInput>([
|
||||
baseAttrs,
|
||||
{
|
||||
error_type: "validation_error",
|
||||
error: zodError.format(),
|
||||
},
|
||||
])
|
||||
const finalAttrs = sanitize(mergedAttrs)
|
||||
|
||||
fail.add(1, finalAttrs)
|
||||
console.error(`[${fullName}] validationError:`, finalAttrs)
|
||||
},
|
||||
|
||||
/**
|
||||
* Records an event of type `http_error` for the fail counter.
|
||||
* Used when a `fetch(...)` call fails. **Note**: This method must be
|
||||
* `await`ed as it is asynchronous!
|
||||
* The given {@link Response} must be unprocessed and will be cloned
|
||||
* to avoid interfering with its consumption outside this function.
|
||||
*
|
||||
* @param response - The HTTP {@link Response} object.
|
||||
*/
|
||||
async httpError(response: Response) {
|
||||
const res = response.clone()
|
||||
const text = await res.text()
|
||||
|
||||
const mergedAttrs = deepmerge.all<AttributesInput>([
|
||||
baseAttrs,
|
||||
{
|
||||
error_type: "http_error",
|
||||
error: {
|
||||
status: res.status,
|
||||
statusText: res.statusText,
|
||||
text,
|
||||
},
|
||||
},
|
||||
])
|
||||
const finalAttrs = sanitize(mergedAttrs)
|
||||
|
||||
fail.add(1, finalAttrs)
|
||||
console.error(`[${fullName}] httpError:`, finalAttrs)
|
||||
},
|
||||
|
||||
/**
|
||||
* Records an event of type `error` for the fail counter.
|
||||
* Used when an error is thrown or an exception is caught, or as a
|
||||
* general-purpose way to record an 'error' on the fail counter.
|
||||
*
|
||||
* @param err - An optional error object or message associated with the
|
||||
* failure. Usually an instance of {@link Error} or a string.
|
||||
*/
|
||||
fail(err?: unknown) {
|
||||
let msg = "unknown"
|
||||
|
||||
if (err && err instanceof Error) {
|
||||
msg = err.message
|
||||
} else if (typeof err === "string") {
|
||||
msg = err
|
||||
}
|
||||
|
||||
const mergedAttrs = deepmerge.all<AttributesInput>([
|
||||
baseAttrs,
|
||||
{
|
||||
error_type: "error",
|
||||
error: msg,
|
||||
},
|
||||
])
|
||||
const finalAttrs = sanitize(mergedAttrs)
|
||||
|
||||
fail.add(1, finalAttrs)
|
||||
console.error(`[${fullName}] fail:`, finalAttrs)
|
||||
},
|
||||
}
|
||||
},
|
||||
}
|
||||
}
|
||||
2
packages/common/tokenManager/index.ts
Normal file
2
packages/common/tokenManager/index.ts
Normal file
@@ -0,0 +1,2 @@
|
||||
import { getServiceToken } from "./tokenManager"
|
||||
export { getServiceToken }
|
||||
123
packages/common/tokenManager/tokenManager.ts
Normal file
123
packages/common/tokenManager/tokenManager.ts
Normal file
@@ -0,0 +1,123 @@
|
||||
import { trace, type Tracer } from "@opentelemetry/api"
|
||||
|
||||
import { getCacheClient } from "../dataCache"
|
||||
import { env } from "../env/server"
|
||||
import { createCounter } from "../telemetry"
|
||||
|
||||
interface ServiceTokenResponse {
|
||||
access_token: string
|
||||
scope?: string
|
||||
token_type: string
|
||||
expires_in: number
|
||||
}
|
||||
|
||||
export async function getServiceToken() {
|
||||
const tracer = trace.getTracer("getServiceToken")
|
||||
|
||||
return await tracer.startActiveSpan("getServiceToken", async () => {
|
||||
const scopes = ["profile", "hotel", "booking", "package", "availability"]
|
||||
|
||||
const cacheKey = getServiceTokenCacheKey(scopes)
|
||||
const cacheClient = await getCacheClient()
|
||||
const token = await getOrSetServiceTokenFromCache(cacheKey, scopes, tracer)
|
||||
|
||||
if (token.expiresAt < Date.now()) {
|
||||
await cacheClient.deleteKey(cacheKey)
|
||||
|
||||
const newToken = await getOrSetServiceTokenFromCache(
|
||||
cacheKey,
|
||||
scopes,
|
||||
tracer
|
||||
)
|
||||
return newToken.jwt
|
||||
}
|
||||
|
||||
return token.jwt
|
||||
})
|
||||
}
|
||||
|
||||
async function getOrSetServiceTokenFromCache(
|
||||
cacheKey: string,
|
||||
scopes: string[],
|
||||
tracer: Tracer
|
||||
) {
|
||||
const cacheClient = await getCacheClient()
|
||||
const token = await cacheClient.cacheOrGet(
|
||||
cacheKey,
|
||||
async () => {
|
||||
return await tracer.startActiveSpan("fetch new token", async () => {
|
||||
const newToken = await getJwt(scopes)
|
||||
return newToken
|
||||
})
|
||||
},
|
||||
"1h"
|
||||
)
|
||||
return token
|
||||
}
|
||||
|
||||
async function getJwt(scopes: string[]) {
|
||||
const getJwtCounter = createCounter("tokenManager", "getJwt")
|
||||
const metricsGetJwt = getJwtCounter.init({
|
||||
scopes,
|
||||
})
|
||||
|
||||
metricsGetJwt.start()
|
||||
|
||||
const jwt = await fetchServiceToken(scopes)
|
||||
|
||||
const expiresAt = Date.now() + jwt.expires_in * 1000
|
||||
|
||||
metricsGetJwt.success()
|
||||
|
||||
return { expiresAt, jwt }
|
||||
}
|
||||
|
||||
async function fetchServiceToken(scopes: string[]) {
|
||||
const fetchServiceTokenCounter = createCounter(
|
||||
"tokenManager",
|
||||
"fetchServiceToken"
|
||||
)
|
||||
const metricsFetchServiceToken = fetchServiceTokenCounter.init({
|
||||
scopes,
|
||||
})
|
||||
|
||||
metricsFetchServiceToken.start()
|
||||
|
||||
const response = await fetch(`${env.CURITY_ISSUER_USER}/oauth/v2/token`, {
|
||||
method: "POST",
|
||||
headers: {
|
||||
"Content-Type": "application/x-www-form-urlencoded",
|
||||
Accept: "application/json",
|
||||
},
|
||||
body: new URLSearchParams({
|
||||
grant_type: "client_credentials",
|
||||
client_id: env.CURITY_CLIENT_ID_SERVICE,
|
||||
client_secret: env.CURITY_CLIENT_SECRET_SERVICE,
|
||||
scope: scopes.join(" "),
|
||||
}),
|
||||
signal: AbortSignal.timeout(15_000),
|
||||
})
|
||||
|
||||
if (!response.ok) {
|
||||
await metricsFetchServiceToken.httpError(response)
|
||||
|
||||
const text = await response.text()
|
||||
throw new Error(
|
||||
`[fetchServiceToken] Failed to obtain service token: ${JSON.stringify({
|
||||
status: response.status,
|
||||
statusText: response.statusText,
|
||||
text,
|
||||
})}`
|
||||
)
|
||||
}
|
||||
|
||||
const result = response.json() as Promise<ServiceTokenResponse>
|
||||
|
||||
metricsFetchServiceToken.success()
|
||||
|
||||
return result
|
||||
}
|
||||
|
||||
function getServiceTokenCacheKey(scopes: string[]): string {
|
||||
return `serviceToken:${scopes.join(",")}`
|
||||
}
|
||||
18
packages/trpc/env/server.ts
vendored
Normal file
18
packages/trpc/env/server.ts
vendored
Normal file
@@ -0,0 +1,18 @@
|
||||
import { createEnv } from "@t3-oss/env-nextjs"
|
||||
import { z } from "zod"
|
||||
|
||||
export const env = createEnv({
|
||||
/**
|
||||
* Due to t3-env only checking typeof window === "undefined"
|
||||
* and Netlify running Deno, window is never "undefined"
|
||||
* https://github.com/t3-oss/t3-env/issues/154
|
||||
*/
|
||||
isServer: typeof window === "undefined" || "Deno" in window,
|
||||
server: {
|
||||
NODE_ENV: z.enum(["development", "test", "production"]),
|
||||
},
|
||||
emptyStringAsUndefined: true,
|
||||
runtimeEnv: {
|
||||
NODE_ENV: process.env.NODE_ENV,
|
||||
},
|
||||
})
|
||||
89
packages/trpc/eslint.config.mjs
Normal file
89
packages/trpc/eslint.config.mjs
Normal file
@@ -0,0 +1,89 @@
|
||||
import { FlatCompat } from "@eslint/eslintrc"
|
||||
import js from "@eslint/js"
|
||||
import typescriptEslint from "@typescript-eslint/eslint-plugin"
|
||||
import tsParser from "@typescript-eslint/parser"
|
||||
import { defineConfig } from "eslint/config"
|
||||
import simpleImportSort from "eslint-plugin-simple-import-sort"
|
||||
import importPlugin from "eslint-plugin-import"
|
||||
|
||||
const compat = new FlatCompat({
|
||||
recommendedConfig: js.configs.recommended,
|
||||
allConfig: js.configs.all,
|
||||
})
|
||||
|
||||
export default defineConfig([
|
||||
{
|
||||
files: ["**/*.ts", "**/*.tsx"],
|
||||
extends: compat.extends("plugin:import/typescript"),
|
||||
plugins: {
|
||||
"simple-import-sort": simpleImportSort,
|
||||
"@typescript-eslint": typescriptEslint,
|
||||
import: importPlugin,
|
||||
},
|
||||
|
||||
linterOptions: {
|
||||
reportUnusedDisableDirectives: true,
|
||||
},
|
||||
|
||||
languageOptions: {
|
||||
parser: tsParser,
|
||||
},
|
||||
|
||||
rules: {
|
||||
"no-unused-vars": "off",
|
||||
"import/no-relative-packages": "error",
|
||||
"simple-import-sort/imports": [
|
||||
"error",
|
||||
{
|
||||
groups: [
|
||||
["^\\u0000"],
|
||||
["^node:"],
|
||||
["^@?\\w"],
|
||||
["^@scandic-hotels/(?!.*\u0000$).*$"],
|
||||
[
|
||||
"^@/constants/?(?!.*\u0000$).*$",
|
||||
"^@/env/?(?!.*\u0000$).*$",
|
||||
"^@/lib/?(?!.*\u0000$).*$",
|
||||
"^@/server/?(?!.*\u0000$).*$",
|
||||
"^@/stores/?(?!.*\u0000$).*$",
|
||||
],
|
||||
["^@/(?!(types|.*\u0000$)).*$"],
|
||||
[
|
||||
"^\\.\\.(?!/?$)",
|
||||
"^\\.\\./?$",
|
||||
"^\\./(?=.*/)(?!/?$)",
|
||||
"^\\.(?!/?$)",
|
||||
"^\\./?$",
|
||||
],
|
||||
["^(?!\\u0000).+\\.s?css$"],
|
||||
["^node:.*\\u0000$", "^@?\\w.*\\u0000$"],
|
||||
[
|
||||
"^@scandichotels/.*\\u0000$",
|
||||
"^@/types/.*",
|
||||
"^@/.*\\u0000$",
|
||||
"^[^.].*\\u0000$",
|
||||
"^\\..*\\u0000$",
|
||||
],
|
||||
],
|
||||
},
|
||||
],
|
||||
|
||||
"simple-import-sort/exports": "error",
|
||||
|
||||
"@typescript-eslint/consistent-type-imports": "error",
|
||||
|
||||
"@typescript-eslint/no-unused-vars": [
|
||||
"error",
|
||||
{
|
||||
args: "all",
|
||||
argsIgnorePattern: "^_",
|
||||
caughtErrors: "all",
|
||||
caughtErrorsIgnorePattern: "^_",
|
||||
destructuredArrayIgnorePattern: "^_",
|
||||
varsIgnorePattern: "^_",
|
||||
ignoreRestSiblings: true,
|
||||
},
|
||||
],
|
||||
},
|
||||
},
|
||||
])
|
||||
5
packages/trpc/global.d.ts
vendored
Normal file
5
packages/trpc/global.d.ts
vendored
Normal file
@@ -0,0 +1,5 @@
|
||||
import type { DataCache } from "./dataCache/Cache"
|
||||
|
||||
declare global {
|
||||
var cacheClient: Promise<DataCache> | undefined
|
||||
}
|
||||
34
packages/trpc/lib/context.ts
Normal file
34
packages/trpc/lib/context.ts
Normal file
@@ -0,0 +1,34 @@
|
||||
import type { Lang } from "@scandic-hotels/common/constants/language"
|
||||
import type { User } from "next-auth"
|
||||
import type { JWT } from "next-auth/jwt"
|
||||
|
||||
type Session = {
|
||||
token: JWT
|
||||
expires: string
|
||||
user?: User
|
||||
error?: "RefreshAccessTokenError"
|
||||
}
|
||||
|
||||
type CreateContextOptions = {
|
||||
auth: () => Promise<Session | null>
|
||||
lang: Lang
|
||||
pathname: string
|
||||
uid?: string | null
|
||||
url: string
|
||||
webToken?: string
|
||||
contentType?: string
|
||||
}
|
||||
|
||||
export function createContext(opts: CreateContextOptions) {
|
||||
return {
|
||||
auth: opts.auth,
|
||||
lang: opts.lang,
|
||||
pathname: opts.pathname,
|
||||
uid: opts.uid,
|
||||
url: opts.url,
|
||||
webToken: opts.webToken,
|
||||
contentType: opts.contentType,
|
||||
}
|
||||
}
|
||||
|
||||
export type Context = Awaited<ReturnType<typeof createContext>>
|
||||
95
packages/trpc/lib/errors.ts
Normal file
95
packages/trpc/lib/errors.ts
Normal file
@@ -0,0 +1,95 @@
|
||||
import { TRPCError } from "@trpc/server"
|
||||
|
||||
export function unauthorizedError(cause?: unknown) {
|
||||
return new TRPCError({
|
||||
code: "UNAUTHORIZED",
|
||||
message: `Unauthorized`,
|
||||
cause,
|
||||
})
|
||||
}
|
||||
|
||||
export function forbiddenError(cause?: unknown) {
|
||||
return new TRPCError({
|
||||
code: "FORBIDDEN",
|
||||
message: `Forbidden`,
|
||||
cause,
|
||||
})
|
||||
}
|
||||
|
||||
export function conflictError(cause?: unknown) {
|
||||
return new TRPCError({
|
||||
code: "CONFLICT",
|
||||
message: `Conflict`,
|
||||
cause,
|
||||
})
|
||||
}
|
||||
|
||||
export function badRequestError(cause?: unknown) {
|
||||
return new TRPCError({
|
||||
code: "BAD_REQUEST",
|
||||
message: `Bad request`,
|
||||
cause,
|
||||
})
|
||||
}
|
||||
|
||||
export function notFound(cause?: unknown) {
|
||||
return new TRPCError({
|
||||
code: "NOT_FOUND",
|
||||
message: `Not found`,
|
||||
cause,
|
||||
})
|
||||
}
|
||||
|
||||
export function unprocessableContent(cause?: unknown) {
|
||||
return new TRPCError({
|
||||
code: "UNPROCESSABLE_CONTENT",
|
||||
message: "Unprocessable content",
|
||||
cause,
|
||||
})
|
||||
}
|
||||
|
||||
export function internalServerError(cause?: unknown) {
|
||||
return new TRPCError({
|
||||
code: "INTERNAL_SERVER_ERROR",
|
||||
message: `Internal Server Error`,
|
||||
cause,
|
||||
})
|
||||
}
|
||||
|
||||
export const SESSION_EXPIRED = "SESSION_EXPIRED"
|
||||
export class SessionExpiredError extends Error {}
|
||||
export function sessionExpiredError() {
|
||||
return new TRPCError({
|
||||
code: "UNAUTHORIZED",
|
||||
message: SESSION_EXPIRED,
|
||||
cause: new SessionExpiredError(SESSION_EXPIRED),
|
||||
})
|
||||
}
|
||||
|
||||
export const PUBLIC_UNAUTHORIZED = "PUBLIC_UNAUTHORIZED"
|
||||
export class PublicUnauthorizedError extends Error {}
|
||||
export function publicUnauthorizedError() {
|
||||
return new TRPCError({
|
||||
code: "UNAUTHORIZED",
|
||||
message: PUBLIC_UNAUTHORIZED,
|
||||
cause: new PublicUnauthorizedError(PUBLIC_UNAUTHORIZED),
|
||||
})
|
||||
}
|
||||
|
||||
export function serverErrorByStatus(status: number, cause?: unknown) {
|
||||
switch (status) {
|
||||
case 401:
|
||||
return unauthorizedError(cause)
|
||||
case 403:
|
||||
return forbiddenError(cause)
|
||||
case 404:
|
||||
return notFound(cause)
|
||||
case 409:
|
||||
return conflictError(cause)
|
||||
case 422:
|
||||
return unprocessableContent(cause)
|
||||
case 500:
|
||||
default:
|
||||
return internalServerError(cause)
|
||||
}
|
||||
}
|
||||
39
packages/trpc/lib/index.ts
Normal file
39
packages/trpc/lib/index.ts
Normal file
@@ -0,0 +1,39 @@
|
||||
import { initTRPC } from "@trpc/server"
|
||||
import { ZodError } from "zod"
|
||||
|
||||
import { transformer } from "./transformer"
|
||||
|
||||
import type { Context } from "./context"
|
||||
|
||||
export type Meta = {
|
||||
authRequired?: boolean
|
||||
}
|
||||
|
||||
const t = initTRPC
|
||||
.context<Context>()
|
||||
.meta<Meta>()
|
||||
.create({
|
||||
transformer,
|
||||
errorFormatter({ shape, error }) {
|
||||
return {
|
||||
...shape,
|
||||
data: {
|
||||
...shape.data,
|
||||
cause:
|
||||
error.cause instanceof ZodError
|
||||
? undefined
|
||||
: JSON.parse(JSON.stringify(error.cause)),
|
||||
zodError:
|
||||
error.cause instanceof ZodError ? error.cause.flatten() : null,
|
||||
},
|
||||
}
|
||||
},
|
||||
})
|
||||
|
||||
export const {
|
||||
createCallerFactory,
|
||||
mergeRouters,
|
||||
router,
|
||||
procedure,
|
||||
middleware,
|
||||
} = t
|
||||
164
packages/trpc/lib/procedures.ts
Normal file
164
packages/trpc/lib/procedures.ts
Normal file
@@ -0,0 +1,164 @@
|
||||
import * as Sentry from "@sentry/nextjs"
|
||||
|
||||
import { getServiceToken } from "@scandic-hotels/common/tokenManager"
|
||||
|
||||
import { env } from "../env/server"
|
||||
import {
|
||||
badRequestError,
|
||||
internalServerError,
|
||||
sessionExpiredError,
|
||||
unauthorizedError,
|
||||
} from "./errors"
|
||||
import { langInput } from "./utils"
|
||||
import { middleware, procedure } from "."
|
||||
|
||||
const sentryMiddleware = middleware(
|
||||
Sentry.trpcMiddleware({
|
||||
attachRpcInput: true,
|
||||
})
|
||||
)
|
||||
|
||||
export const baseProcedure = procedure.use(sentryMiddleware)
|
||||
|
||||
export const publicProcedure = baseProcedure
|
||||
|
||||
export const languageProcedure = baseProcedure.use(async function (opts) {
|
||||
if (!opts.ctx.lang) {
|
||||
// When fetching data client side with TRPC we don't pass through middlewares and therefore do not get the lang through headers
|
||||
// We can then pass lang as an input in the request and set it to the context in the procedure
|
||||
|
||||
const input = await opts.getRawInput()
|
||||
const parsedInput = langInput.safeParse(input)
|
||||
if (!parsedInput.success) {
|
||||
throw badRequestError("Missing Lang in tRPC context")
|
||||
}
|
||||
|
||||
return opts.next({
|
||||
ctx: {
|
||||
lang: parsedInput.data.lang,
|
||||
},
|
||||
})
|
||||
}
|
||||
|
||||
return opts.next({
|
||||
ctx: {
|
||||
lang: opts.ctx.lang,
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
export const contentstackBaseProcedure = languageProcedure
|
||||
|
||||
export const contentstackExtendedProcedureUID = contentstackBaseProcedure.use(
|
||||
async function (opts) {
|
||||
if (!opts.ctx.uid) {
|
||||
throw badRequestError("Missing UID in tRPC context")
|
||||
}
|
||||
|
||||
return opts.next({
|
||||
ctx: {
|
||||
uid: opts.ctx.uid,
|
||||
},
|
||||
})
|
||||
}
|
||||
)
|
||||
|
||||
export const protectedProcedure = baseProcedure.use(async function (opts) {
|
||||
const authRequired = opts.meta?.authRequired ?? true
|
||||
const session = await opts.ctx.auth()
|
||||
|
||||
if (!authRequired && env.NODE_ENV === "development") {
|
||||
console.info(
|
||||
`❌❌❌❌ You are opting out of authorization, if its done on purpose maybe you should use the publicProcedure instead. ❌❌❌❌`
|
||||
)
|
||||
console.info(`path: ${opts.path} | type: ${opts.type}`)
|
||||
}
|
||||
|
||||
if (!session) {
|
||||
throw unauthorizedError()
|
||||
}
|
||||
|
||||
if (session?.error === "RefreshAccessTokenError") {
|
||||
throw sessionExpiredError()
|
||||
}
|
||||
|
||||
return opts.next({
|
||||
ctx: {
|
||||
session,
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
export const safeProtectedProcedure = baseProcedure.use(async function (opts) {
|
||||
const authRequired = opts.meta?.authRequired ?? true
|
||||
let session = await opts.ctx.auth()
|
||||
if (!authRequired && env.NODE_ENV === "development") {
|
||||
console.info(
|
||||
`❌❌❌❌ You are opting out of authorization, if its done on purpose maybe you should use the publicProcedure instead. ❌❌❌❌`
|
||||
)
|
||||
console.info(`path: ${opts.path} | type: ${opts.type}`)
|
||||
}
|
||||
|
||||
if (!session || session.error === "RefreshAccessTokenError") {
|
||||
session = null
|
||||
}
|
||||
|
||||
return opts.next({
|
||||
ctx: {
|
||||
session,
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
export const serviceProcedure = baseProcedure.use(async (opts) => {
|
||||
const token = await getServiceToken()
|
||||
const { access_token } = token
|
||||
if (!access_token) {
|
||||
throw internalServerError(`[serviceProcedure] No service token`)
|
||||
}
|
||||
return opts.next({
|
||||
ctx: {
|
||||
serviceToken: access_token,
|
||||
},
|
||||
})
|
||||
})
|
||||
|
||||
export const contentStackUidWithServiceProcedure =
|
||||
contentstackExtendedProcedureUID.concat(serviceProcedure)
|
||||
|
||||
export const contentStackBaseWithServiceProcedure =
|
||||
contentstackBaseProcedure.concat(serviceProcedure)
|
||||
|
||||
export const contentStackBaseWithProtectedProcedure =
|
||||
contentstackBaseProcedure.concat(protectedProcedure)
|
||||
|
||||
export const safeProtectedServiceProcedure =
|
||||
safeProtectedProcedure.concat(serviceProcedure)
|
||||
|
||||
export const languageProtectedProcedure =
|
||||
protectedProcedure.concat(languageProcedure)
|
||||
|
||||
type ExperimentalProcedureCaller = ReturnType<
|
||||
typeof baseProcedure.experimental_caller
|
||||
>
|
||||
export function getProtectedServerActionProcedure(
|
||||
serverActionProcedure: ExperimentalProcedureCaller
|
||||
) {
|
||||
return serverActionProcedure.use(async (opts) => {
|
||||
const session = await opts.ctx.auth()
|
||||
if (!session) {
|
||||
throw unauthorizedError()
|
||||
}
|
||||
|
||||
if (session && session.error === "RefreshAccessTokenError") {
|
||||
throw sessionExpiredError()
|
||||
}
|
||||
|
||||
return opts.next({
|
||||
ctx: {
|
||||
...opts.ctx,
|
||||
session,
|
||||
},
|
||||
})
|
||||
})
|
||||
}
|
||||
3
packages/trpc/lib/transformer.ts
Normal file
3
packages/trpc/lib/transformer.ts
Normal file
@@ -0,0 +1,3 @@
|
||||
import superjson from "superjson"
|
||||
|
||||
export const transformer = superjson
|
||||
7
packages/trpc/lib/utils.ts
Normal file
7
packages/trpc/lib/utils.ts
Normal file
@@ -0,0 +1,7 @@
|
||||
import { z } from "zod"
|
||||
|
||||
import { Lang } from "@scandic-hotels/common/constants/language"
|
||||
|
||||
export const langInput = z.object({
|
||||
lang: z.nativeEnum(Lang),
|
||||
})
|
||||
6
packages/trpc/lint-staged.config.mjs
Normal file
6
packages/trpc/lint-staged.config.mjs
Normal file
@@ -0,0 +1,6 @@
|
||||
const config = {
|
||||
"*.{ts,tsx}": [() => "tsc -p tsconfig.json --noEmit", "prettier --write"],
|
||||
"*.{js,cjs,mjs}": "prettier --write",
|
||||
}
|
||||
|
||||
export default config
|
||||
38
packages/trpc/package.json
Normal file
38
packages/trpc/package.json
Normal file
@@ -0,0 +1,38 @@
|
||||
{
|
||||
"name": "@scandic-hotels/trpc",
|
||||
"version": "1.0.0",
|
||||
"main": "index.ts",
|
||||
"type": "module",
|
||||
"scripts": {
|
||||
"check-types": "tsc --noEmit",
|
||||
"lint": "eslint . --max-warnings 0 && tsc --noEmit"
|
||||
},
|
||||
"exports": {
|
||||
".": "./lib/index.ts",
|
||||
"./context": "./lib/context.ts",
|
||||
"./errors": "./lib/errors.ts",
|
||||
"./procedures": "./lib/procedures.ts",
|
||||
"./transformer": "./lib/transformer.ts"
|
||||
},
|
||||
"dependencies": {
|
||||
"@scandic-hotels/common": "workspace:*",
|
||||
"@sentry/nextjs": "^8.41.0",
|
||||
"@t3-oss/env-nextjs": "^0.13.4",
|
||||
"@trpc/server": "^11.1.2",
|
||||
"next-auth": "5.0.0-beta.27",
|
||||
"superjson": "^2.2.2",
|
||||
"zod": "^3.24.4"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@eslint/compat": "^1.2.9",
|
||||
"@eslint/eslintrc": "^3.3.1",
|
||||
"@eslint/js": "^9.26.0",
|
||||
"@types/lodash-es": "^4",
|
||||
"@typescript-eslint/eslint-plugin": "^8.32.0",
|
||||
"@typescript-eslint/parser": "^8.32.0",
|
||||
"eslint": "^9",
|
||||
"eslint-plugin-import": "^2.31.0",
|
||||
"eslint-plugin-simple-import-sort": "^12.1.1",
|
||||
"typescript": "5.8.3"
|
||||
}
|
||||
}
|
||||
8
packages/trpc/prettier.config.cjs
Normal file
8
packages/trpc/prettier.config.cjs
Normal file
@@ -0,0 +1,8 @@
|
||||
module.exports = {
|
||||
semi: false,
|
||||
trailingComma: "es5",
|
||||
singleQuote: false,
|
||||
printWidth: 80,
|
||||
tabWidth: 2,
|
||||
endOfLine: "lf",
|
||||
};
|
||||
10
packages/trpc/tsconfig.json
Normal file
10
packages/trpc/tsconfig.json
Normal file
@@ -0,0 +1,10 @@
|
||||
{
|
||||
"extends": "@scandic-hotels/typescript-config/base.json",
|
||||
"compilerOptions": {
|
||||
"paths": {
|
||||
"@/*": ["./*"]
|
||||
}
|
||||
},
|
||||
"include": ["**/*.ts"],
|
||||
"exclude": ["**/node_modules/**"]
|
||||
}
|
||||
Reference in New Issue
Block a user