Unify error throwing methods in Devtools

yorkie-team · Aug 15, 2024 · a289c05 · a289c05
1 parent ebd7a14
commit a289c05
Show file tree

Hide file tree

Showing 4 changed files with 18 additions and 5 deletions.
diff --git a/packages/devtools/src/devtools/contexts/SelectedNode.tsx b/packages/devtools/src/devtools/contexts/SelectedNode.tsx
@@ -17,6 +17,7 @@
 import type { ReactNode, Dispatch, SetStateAction } from 'react';
 import { createContext, useContext, useState } from 'react';
 import type { RootTreeNode } from '../components/Tree';
+import { Code, YorkieError } from '@yorkie-js-sdk/src/util/error';
 
 type SelectedNodeContext = [
   RootTreeNode,
@@ -40,7 +41,8 @@ export function SelectedNodeProvider({ children }: Props) {
 export function useSelectedNode() {
   const value = useContext(SelectedNodeContext);
   if (value === undefined) {
-    throw new Error(
+    throw new YorkieError(
+      Code.ErrContextNotProvided,
       'useSelectedNode should be used within SelectedNodeProvider',
     );
   }

diff --git a/packages/devtools/src/devtools/contexts/SelectedPresence.tsx b/packages/devtools/src/devtools/contexts/SelectedPresence.tsx
@@ -17,6 +17,7 @@
 import type { ReactNode, Dispatch, SetStateAction } from 'react';
 import { createContext, useContext, useState } from 'react';
 import type { PresenceJsonNode } from '../components/Tree';
+import { Code, YorkieError } from '@yorkie-js-sdk/src/util/error';
 
 type SelectedPresenceContext = [
   PresenceJsonNode,
@@ -42,7 +43,8 @@ export function SelectedPresenceProvider({ children }: Props) {
 export function useSelectedPresence() {
   const value = useContext(SelectedPresenceContext);
   if (value === undefined) {
-    throw new Error(
+    throw new YorkieError(
+      Code.ErrContextNotProvided,
       'useSelectedPresence should be used within SelectedPresenceProvider',
     );
   }

diff --git a/packages/devtools/src/devtools/contexts/YorkieSource.tsx b/packages/devtools/src/devtools/contexts/YorkieSource.tsx
@@ -30,6 +30,7 @@ import {
   type TransactionEvent,
 } from 'yorkie-js-sdk';
 import { connectPort, sendToSDK } from '../../port';
+import { Code, YorkieError } from '@yorkie-js-sdk/src/util/error';
 
 const DocKeyContext = createContext<string>(null);
 const YorkieDocContext = createContext(null);
@@ -125,7 +126,8 @@ export function YorkieSourceProvider({ children }: Props) {
 export function useCurrentDocKey() {
   const value = useContext(DocKeyContext);
   if (value === undefined) {
-    throw new Error(
+    throw new YorkieError(
+      Code.ErrContextNotProvided,
       'useCurrentDocKey should be used within YorkieSourceProvider',
     );
   }
@@ -135,7 +137,10 @@ export function useCurrentDocKey() {
 export function useYorkieDoc() {
   const value = useContext(YorkieDocContext);
   if (value === undefined) {
-    throw new Error('useYorkieDoc should be used within YorkieSourceProvider');
+    throw new YorkieError(
+      Code.ErrContextNotProvided,
+      'useYorkieDoc should be used within YorkieSourceProvider',
+    );
   }
   return value;
 }
@@ -168,7 +173,8 @@ export function useTransactionEvents() {
   );
 
   if (events === undefined) {
-    throw new Error(
+    throw new YorkieError(
+      Code.ErrContextNotProvided,
       'useTransactionEvents should be used within YorkieSourceProvider',
     );
   }

diff --git a/packages/sdk/src/util/error.ts b/packages/sdk/src/util/error.ts
@@ -56,6 +56,9 @@ export enum Code {
 
   // ErrRefused is returned when the execution is rejected.
   ErrRefused = 'ErrRefused',
+
+  // ErrContextNotProvided is returned when a required React context is missing
+  ErrContextNotProvided = 'ErrContextNotProvided',
 }
 
 /**