feat: create YLS context for using baseURL (#14)

* config: allow any type in YLS - 예외 허용 * fix: noExternal packages - sha256 외에 사용하는 부분이 있어서 수정 * feat: modify AxiosInstance to receive the baseURL as a parameter * feat: create YLSWrapper, YLSProvider * feat: create useYLSContext for using context * feat: apply useYLSContext * fix: modify YLS demo * docs: update README.md
yourssu · Jun 2, 2024 · cebdcc4 · cebdcc4
1 parent 965392b
commit cebdcc4
Show file tree

Hide file tree

Showing 24 changed files with 467 additions and 44 deletions.
diff --git a/apps/demo/.gitignore b/apps/demo/.gitignore
@@ -0,0 +1 @@
+.env
diff --git a/apps/demo/index.html b/apps/demo/index.html
@@ -8,6 +8,6 @@
   </head>
   <body>
     <div id="root"></div>
-    <script type="module" src="./main.tsx"></script>
+    <script type="module" src="./src/main.tsx"></script>
   </body>
 </html>
diff --git a/apps/demo/main.tsx b/apps/demo/main.tsx
diff --git a/apps/demo/package.json b/apps/demo/package.json
@@ -6,6 +6,7 @@
     "dev": "vite"
   },
   "devDependencies": {
+    "@vitejs/plugin-react": "^4.3.0",
     "@yourssu/logging-system-react": "workspace:*",
     "react-router-dom": "^6.21.3",
     "vite": "^4.4.5",

diff --git a/apps/demo/App.tsx → apps/demo/src/App.tsx b/apps/demo/App.tsx → apps/demo/src/App.tsx
diff --git a/apps/demo/Drawer.tsx → apps/demo/src/Drawer.tsx b/apps/demo/Drawer.tsx → apps/demo/src/Drawer.tsx
diff --git a/apps/demo/Home.tsx → apps/demo/src/Home.tsx b/apps/demo/Home.tsx → apps/demo/src/Home.tsx
diff --git a/apps/demo/src/main.tsx b/apps/demo/src/main.tsx
@@ -0,0 +1,12 @@
+import { YLSWrapper } from '@yourssu/logging-system-react';
+import ReactDOM from 'react-dom/client';
+
+import { App } from './App';
+
+const baseURL = import.meta.env.VITE_API_YLS_URL;
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <YLSWrapper baseURL={baseURL}>
+    <App />
+  </YLSWrapper>
+);
diff --git a/apps/demo/src/vite-env.d.ts b/apps/demo/src/vite-env.d.ts
@@ -0,0 +1 @@
+/// <reference types="vite/client" />
diff --git a/apps/demo/tsconfig.json b/apps/demo/tsconfig.json
@@ -1,3 +1,6 @@
 {
-  "extends": "../../tsconfig.json"
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "types": ["vite/client"]
+  }
 }
diff --git a/apps/demo/vite.config.ts b/apps/demo/vite.config.ts
@@ -0,0 +1,7 @@
+import react from '@vitejs/plugin-react';
+import { defineConfig } from 'vite';
+
+// https://vitejs.dev/config/
+export default defineConfig({
+  plugins: [react()],
+});
diff --git a/packages/logging-system/.eslintrc.cjs b/packages/logging-system/.eslintrc.cjs
@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ['../../.eslintrc.cjs'],
+  rules: {
+    '@typescript-eslint/no-explicit-any': 'off',
+  },
+};
diff --git a/packages/logging-system/README.md b/packages/logging-system/README.md
@@ -8,6 +8,8 @@ YLS는 숭실대학교 동아리 유어슈에서 사용하는 로깅 시스템
 
 ## Installation
 
+1. YLS를 설치합니다.
+
 ```
 npm install @yourssu/logging-system-react
 
@@ -16,6 +18,19 @@ yarn add @yourssu/logging-system-react
 pnpm install @yourssu/logging-system-react
 ```
 
+2. Root Component에 YLSWrapper를 감싸고 baseURL을 설정합니다.
+
+```jsx
+// vite 사용 시
+const baseURL = import.meta.env.VITE_API_YLS_URL;
+
+ReactDOM.createRoot(document.getElementById('root')!).render(
+  <YLSWrapper baseURL={baseURL}>
+    <App />
+  </YLSWrapper>
+);
+```
+
 ## Usage
 
 YLS 내부에서는 timestamp와 platform을 처리합니다.

diff --git a/packages/logging-system/src/Logger.ts b/packages/logging-system/src/Logger.ts
@@ -1,8 +1,8 @@
-import SHA256 from 'crypto-js/sha256';
+import CryptoJS from 'crypto-js';
 
 import { SetLocalStorage, SetLocalStorageClear } from './SetLocalStorage';
-import { postLog } from './apis/postLog';
-import { LogPayloadParams, LogRequestList, LogType } from './types/LogType';
+import { useYLSContext } from './hooks/useYLSContext';
+import { LogPayloadParams, LogRequestList, LogResponse, LogType } from './types/LogType';
 
 const createRandomId = () => {
   let randomId = '';
@@ -29,7 +29,7 @@ const createHashedID = (userId: string) => {
     userId = createRandomId();
   }
 
-  hashedId = SHA256(userId).toString(CryptoJS.enc.Base64);
+  hashedId = CryptoJS.SHA256(userId).toString(CryptoJS.enc.Base64);
 
   return localHashedId ? localHashedId : hashedId;
 };
@@ -40,7 +40,12 @@ const createTimestamp = () => {
   return now.toISOString();
 };
 
-const initialLog = (userId: string, version: number, event: LogPayloadParams['event']) => {
+const initialLog = (
+  userId: string,
+  version: number,
+  event: LogPayloadParams['event'],
+  postLog: (data: LogRequestList) => Promise<LogResponse>
+) => {
   const loggerType: LogPayloadParams = {
     userId: userId,
     version: version,
@@ -49,16 +54,18 @@ const initialLog = (userId: string, version: number, event: LogPayloadParams['ev
 
   const logger = Logger(loggerType);
 
-  SetLocalStorage(logger);
+  SetLocalStorage(logger, postLog);
 };
 
 export const useYLSLogger = () => {
+  const { postLog } = useYLSContext();
+
   const screen = ({ userId, version, event }: LogPayloadParams) => {
-    initialLog(userId, version, event);
+    initialLog(userId, version, event, postLog);
   };
 
   const click = ({ userId, version, event }: LogPayloadParams) => {
-    initialLog(userId, version, event);
+    initialLog(userId, version, event, postLog);
   };
 
   return {
@@ -82,12 +89,18 @@ export const Logger = ({ userId, version, event }: LogPayloadParams) => {
 window.addEventListener('unload', async (event) => {
   event.preventDefault();
 
+  const { postLog } = useYLSContext();
   const logList: LogType[] = JSON.parse(localStorage.getItem('yls-web') as string) || [];
   const req: LogRequestList = {
     logRequestList: logList,
   };
-  const res = await postLog(req);
-  if (res.success) {
-    SetLocalStorageClear();
+
+  try {
+    const res = await postLog(req);
+    if (res.success) {
+      SetLocalStorageClear();
+    }
+  } catch (e) {
+    console.error('Failed to post log');
   }
 });
diff --git a/packages/logging-system/src/SetLocalStorage.ts b/packages/logging-system/src/SetLocalStorage.ts
@@ -1,12 +1,14 @@
-import { postLog } from './apis/postLog';
-import { LogRequestList, LogType } from './types/LogType';
+import { LogRequestList, LogResponse, LogType } from './types/LogType';
 
 export const SetLocalStorageClear = () => {
   const list: any[] = [];
   localStorage.setItem('yls-web', JSON.stringify(list));
 };
 
-export const SetLocalStorage = async (logger: LogType) => {
+export const SetLocalStorage = async (
+  logger: LogType,
+  postLog: (data: LogRequestList) => Promise<LogResponse>
+) => {
   if (window.localStorage.getItem('yls-web') == undefined) {
     const list: any[] = [];
     list.push(logger);
@@ -20,10 +22,14 @@ export const SetLocalStorage = async (logger: LogType) => {
       const req: LogRequestList = {
         logRequestList: remainList,
       };
-      const res = await postLog(req);
 
-      if (res.success) {
-        SetLocalStorageClear();
+      try {
+        const res = await postLog(req);
+        if (res.success) {
+          SetLocalStorageClear();
+        }
+      } catch (e) {
+        console.error('Failed to post log');
       }
     }
   }

diff --git a/packages/logging-system/src/apis/createAxiosInstance.ts b/packages/logging-system/src/apis/createAxiosInstance.ts
@@ -0,0 +1,11 @@
+import axios from 'axios';
+
+export const createAxiosInstance = (baseURL: string) => {
+  return axios.create({
+    baseURL,
+    headers: {
+      'Content-Type': 'application/json',
+      withCredentials: true,
+    },
+  });
+};
diff --git a/packages/logging-system/src/apis/customedAxios.ts b/packages/logging-system/src/apis/customedAxios.ts
diff --git a/packages/logging-system/src/apis/postLog.ts b/packages/logging-system/src/apis/postLog.ts
diff --git a/packages/logging-system/src/components/YLSWrapper.tsx b/packages/logging-system/src/components/YLSWrapper.tsx
@@ -0,0 +1,14 @@
+import { YLSProvider } from '@/contexts/YLSProvider';
+
+interface YLSWrapperProps {
+  children: React.ReactNode;
+  baseURL: string;
+}
+
+/**
+ * YLS에 사용되는 Context를 위한 컴포넌트입니다.
+ * YLS를 사용하는 프로젝트의 최상위 컴포넌트로 사용해야 합니다.
+ */
+export const YLSWrapper = ({ children, baseURL }: YLSWrapperProps) => {
+  return <YLSProvider baseURL={baseURL}>{children}</YLSProvider>;
+};
diff --git a/packages/logging-system/src/contexts/YLSProvider.tsx b/packages/logging-system/src/contexts/YLSProvider.tsx
@@ -0,0 +1,44 @@
+import { createContext } from 'react';
+
+import { createAxiosInstance } from '@/apis/createAxiosInstance';
+import { LogRequestList, LogResponse } from '@/types/LogType';
+
+interface YLSProviderProps {
+  children: React.ReactNode;
+  baseURL: string;
+}
+
+export interface YLSContextType {
+  postLog: (data: LogRequestList) => Promise<LogResponse>;
+}
+
+export const YLSContext = createContext<YLSContextType | undefined>(undefined);
+
+/**
+ * YLS에 사용되는 Context Provider를 위한 컴포넌트입니다.
+ * 일반적으로 YLSWrapper 컴포넌트를 사용하시면 됩니다.
+ * @param param0
+ * @returns
+ */
+export const YLSProvider = ({ children, baseURL }: YLSProviderProps) => {
+  const axiosInstance = createAxiosInstance(baseURL);
+
+  const postLog = async (data: LogRequestList): Promise<LogResponse> => {
+    try {
+      const res = await axiosInstance.put('/log/list', data);
+      return res.data;
+    } catch (e) {
+      throw new Error('Failed to post log');
+    }
+  };
+
+  return (
+    <YLSContext.Provider
+      value={{
+        postLog,
+      }}
+    >
+      {children}
+    </YLSContext.Provider>
+  );
+};
diff --git a/packages/logging-system/src/hooks/useYLSContext.tsx b/packages/logging-system/src/hooks/useYLSContext.tsx
@@ -0,0 +1,11 @@
+import { useContext } from 'react';
+
+import { YLSContext } from '@/contexts/YLSProvider';
+
+export const useYLSContext = () => {
+  const context = useContext(YLSContext);
+  if (!context) {
+    throw new Error('useYLSContext must be used within a YLSProvider');
+  }
+  return context;
+};
diff --git a/packages/logging-system/src/index.ts b/packages/logging-system/src/index.ts
@@ -1,3 +1,4 @@
+export { YLSWrapper } from './components/YLSWrapper';
 export { useYLSLogger } from './Logger';
 export { LogClick } from './components/LogClick';
 export { LogScreen } from './components/LogScreen';
diff --git a/packages/logging-system/tsup.config.ts b/packages/logging-system/tsup.config.ts
@@ -8,7 +8,7 @@ export default defineConfig({
     resolve: true,
   },
   external: ['react', 'react-dom'],
-  noExternal: ['crypto-js/sha256'],
+  noExternal: ['crypto-js'],
   splitting: false,
   clean: true,
   sourcemap: true,