Merge pull request #50 from cipherstash/error-handling

feat: logging error

Author: calvinbrewer

.changeset/flat-carrots-speak.md

@@ -0,0 +1,6 @@
+---
+"@cipherstash/nextjs": minor
+"@cipherstash/jseql": minor
+---
+
+Fixed improper use of throwing errors, and log with jseql logger.

packages/jseql/src/eql/index.ts

@@ -6,7 +6,7 @@ import type {
   Column,
   Plaintext,
 } from '../cs_plaintext_v1'
-import { logger } from '../logger'
+import { logger } from '../../../utils/logger'
 
 export type CreateEqlPayload = {
   plaintext: Plaintext

packages/jseql/src/ffi/env-check.ts

@@ -1,4 +1,4 @@
-import { logger } from '../logger'
+import { logger } from '../../../utils/logger'
 
 let message = ''
 const errorMessage = (message: string) => `Initialization error: ${message}`
@@ -10,7 +10,7 @@ export const checkEnvironmentVariables = () => {
     )
 
     logger.error(message)
-    throw new Error(`[ Server ] jseql: ${message}`)
+    throw new Error(`[jseql]: ${message}`)
   }
 
   if (!process.env.CS_CLIENT_ID || !process.env.CS_CLIENT_KEY) {
@@ -19,7 +19,7 @@ export const checkEnvironmentVariables = () => {
     )
 
     logger.error(message)
-    throw new Error(`[ Server ] jseql: ${message}`)
+    throw new Error(`[jseql]: ${message}`)
   }
 
   if (!process.env.CS_CLIENT_ACCESS_KEY) {
@@ -28,6 +28,6 @@ export const checkEnvironmentVariables = () => {
     )
 
     logger.error(message)
-    throw new Error(`[ Server ] jseql: ${message}`)
+    throw new Error(`[jseql]: ${message}`)
   }
 }

packages/jseql/src/ffi/index.ts

@@ -4,10 +4,8 @@ import {
   encrypt,
   encryptBulk,
   decryptBulk,
-  type BulkEncryptPayload as InternalBulkEncryptPayload,
-  type BulkDecryptPayload as InternalBulkDecryptPayload,
 } from '@cipherstash/jseql-ffi'
-import { logger } from '../logger'
+import { logger } from '../../../utils/logger'
 import type { LockContext } from '../identify'
 import { checkEnvironmentVariables } from './env-check'
 import {

packages/jseql/src/identify/index.ts

@@ -1,4 +1,4 @@
-import { logger } from '../logger'
+import { logger } from '../../../utils/logger'
 
 export type CtsRegions = 'ap-southeast-2'
 
@@ -33,7 +33,7 @@ export class LockContext {
       const errorMessage =
         'CS_WORKSPACE_ID environment variable is not set, and is required to initialize a LockContext.'
       logger.error(errorMessage)
-      throw new Error(`[ Server ] jseql: ${errorMessage}`)
+      throw new Error(`[jseql]: ${errorMessage}`)
     }
 
     if (ctsToken) {
@@ -63,11 +63,9 @@ export class LockContext {
       }),
     })
 
-    console.log('[ Server ] jseql: CTS response', ctsResponse)
-
     if (!ctsResponse.ok) {
       throw new Error(
-        `[ Server ] jseql: Failed to fetch CTS token: ${ctsResponse.statusText}`,
+        `[jseql]: Failed to fetch CTS token: ${ctsResponse.statusText}`,
       )
     }
 

packages/nextjs/src/clerk/index.ts

@@ -2,7 +2,7 @@ import type { ClerkMiddlewareAuth } from '@clerk/nextjs/server'
 import type { NextRequest } from 'next/server'
 import { NextResponse } from 'next/server'
 import { CS_COOKIE_NAME, type CtsToken } from '../index'
-import { logger } from '../logger'
+import { logger } from '../../../utils/logger'
 
 export const jseqlClerkMiddleware = async (
   auth: ClerkMiddlewareAuth,
@@ -25,10 +25,11 @@ export const jseqlClerkMiddleware = async (
     const workspaceId = process.env.CS_WORKSPACE_ID
 
     if (!workspaceId) {
-      const errorMessage =
-        'CS_WORKSPACE_ID environment variable is not set, and is required by jseqlClerkMiddleware.'
-      logger.error(errorMessage)
-      throw new Error(`[ Server ] jseql: ${errorMessage}`)
+      logger.error(
+        'The "CS_WORKSPACE_ID" environment variable is not set, and is required by jseqlClerkMiddleware. No CipherStash session will be set.',
+      )
+
+      return NextResponse.next()
     }
 
     const ctsEndoint =
@@ -47,9 +48,13 @@ export const jseqlClerkMiddleware = async (
     })
 
     if (!ctsResponse.ok) {
-      throw new Error(
-        `[ Server ] jseql: Failed to fetch CTS token: ${ctsResponse.statusText}`,
+      logger.debug(`Failed to fetch CTS token: ${ctsResponse.statusText}`)
+
+      logger.error(
+        'There was an issue communicating with the CipherStash CTS API, the CipherStash session was not set. If the issue persists, please contact support.',
       )
+
+      return NextResponse.next()
     }
 
     const cts_token = (await ctsResponse.json()) as CtsToken

packages/nextjs/src/index.ts

@@ -1,5 +1,5 @@
 import { cookies } from 'next/headers'
-import { logger } from './logger'
+import { logger } from '../../utils/logger'
 
 export const CS_COOKIE_NAME = '__cipherstash_cts_session'
 

packages/nextjs/src/logger/index.ts

@@ -7,7 +7,7 @@ function getLevelValue(level: string): number {
     case 'error':
       return 30
     default:
-      return 20 // default to 'info'
+      return 30 // default to error level
   }
 }
 
@@ -16,19 +16,19 @@ const currentLevel = getLevelValue(envLogLevel)
 
 function debug(...args: unknown[]): void {
   if (currentLevel <= getLevelValue('debug')) {
-    console.debug('[DEBUG]', ...args)
+    console.debug('[jseql] DEBUG', ...args)
   }
 }
 
 function info(...args: unknown[]): void {
   if (currentLevel <= getLevelValue('info')) {
-    console.info('[INFO]', ...args)
+    console.info('[jseql] INFO', ...args)
   }
 }
 
 function error(...args: unknown[]): void {
   if (currentLevel <= getLevelValue('error')) {
-    console.error('[ERROR]', ...args)
+    console.error('[jseql] ERROR', ...args)
   }
 }