Feat/#66 JS SDK api 명세에 맞게 수정 (#70)

* fix: app-ip -> appKey in SDK * fix: created_at -> timestamp * fix: Nginx CORS 허용 헤더 변경 - app-id -> appKey
woowa-techcamp-2024 · Aug 17, 2024 · ff1965a · ff1965a
1 parent 8ef2537
commit ff1965a
Show file tree

Hide file tree

Showing 4 changed files with 17 additions and 15 deletions.
diff --git a/nginx/sites-available/default b/nginx/sites-available/default
@@ -44,7 +44,7 @@ server {
         if ($request_method = 'OPTIONS') {
             add_header 'Access-Control-Allow-Origin' '*';
             add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
-            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,app-id' always;
+            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,appKey' always;
             add_header 'Access-Control-Max-Age' 1728000;
             add_header 'Content-Type' 'text/plain; charset=utf-8';
             add_header 'Content-Length' 0;
@@ -53,7 +53,7 @@ server {
         if ($request_method = 'POST') {
             add_header 'Access-Control-Allow-Origin' '*' always;
             add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS' always;
-            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,app-id' always;
+            add_header 'Access-Control-Allow-Headers' 'DNT,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type,Range,appKey' always;
             add_header 'Access-Control-Expose-Headers' 'Content-Length,Content-Range' always;
         }
     }

diff --git a/sdk/js/README.md b/sdk/js/README.md
@@ -24,9 +24,10 @@ CDN을 통해 직접 스크립트를 포함할 수 있습니다:
 LogBat SDK를 사용하기 전에 먼저 초기화해야 합니다:
 
 ```html
+
 <script src="https://sdk.logbat.info/sdk.js"></script>
 <script>
-LogBat.init({ appId: 'YOUR_APP_ID' });
+    LogBat.init({appKey: 'YOUR_APP_KEY'});
 </script>
 ```
 

diff --git a/sdk/js/src/__tests__/index.test.ts b/sdk/js/src/__tests__/index.test.ts
@@ -16,7 +16,8 @@ describe('LogBat SDK', () => {
         jest.clearAllMocks();
         consoleLogSpy = jest.spyOn(console, 'log').mockImplementation(() => {});
         consoleErrorSpy = jest.spyOn(console, 'error').mockImplementation(() => {});
-        LogBat.init({ appId: 'test-app' });
+        LogBat['isInitialized'] = false;
+        LogBat.init({ appKey: 'test-app' });
     });
 
     afterEach(() => {
@@ -25,7 +26,7 @@ describe('LogBat SDK', () => {
     });
 
     test('should initialize with appId', () => {
-        expect(LogBat['appId']).toBe('test-app');
+        expect(LogBat['appKey']).toBe('test-app');
     });
 
     test('should send log message', async () => {
@@ -34,12 +35,12 @@ describe('LogBat SDK', () => {
         expect(consoleLogSpy).toHaveBeenCalledWith('Test log message');
         expect(fetch).toHaveBeenCalledTimes(1);
         expect(fetch).toHaveBeenCalledWith(
-            'https://api.logbat.info/log',
+            'https://api.logbat.info/logs',
             expect.objectContaining({
                 method: 'POST',
                 headers: expect.objectContaining({
                     'Content-Type': 'application/json',
-                    'app_id': 'test-app'
+                    'appKey': 'test-app'
                 }),
                 body: expect.stringContaining('Test log message')
             })
@@ -52,12 +53,12 @@ describe('LogBat SDK', () => {
         expect(consoleErrorSpy).toHaveBeenCalledWith('Test error message');
         expect(fetch).toHaveBeenCalledTimes(1);
         expect(fetch).toHaveBeenCalledWith(
-            'https://api.logbat.info/log',
+            'https://api.logbat.info/logs',
             expect.objectContaining({
                 method: 'POST',
                 headers: expect.objectContaining({
                     'Content-Type': 'application/json',
-                    'app_id': 'test-app'
+                    'appKey': 'test-app'
                 }),
                 body: expect.stringContaining('Test error message')
             })

diff --git a/sdk/js/src/index.ts b/sdk/js/src/index.ts
@@ -1,16 +1,16 @@
 class LogBat {
-    private static appId: string = '';
+    private static appKey: string = '';
     private static apiEndpoint: string = 'https://api.logbat.info/logs';
     private static originalConsole: { log: typeof console.log; error: typeof console.error };
     private static isInitialized: boolean = false;
 
-    public static init(config: { appId: string }): void {
+    public static init(config: { appKey: string }): void {
         if (this.isInitialized) {
             console.warn('LogBat SDK is already initialized. Ignoring repeated initialization.');
             return;
         }
 
-        this.appId = config.appId;
+        this.appKey = config.appKey;
         this.overrideConsoleMethods();
         this.isInitialized = true;
     }
@@ -30,18 +30,18 @@ class LogBat {
     private static async sendLog(level: string, args: any[]): Promise<void> {
         const logData = {
             level: level,
-            created_at: new Date().toISOString(),
             data: args.map(arg =>
                 typeof arg === 'object' ? JSON.stringify(arg) : String(arg)
-            ).join(' ')
+            ).join(' '),
+            timestamp: new Date().toISOString()
         };
 
         try {
             const response = await fetch(this.apiEndpoint, {
                 method: 'POST',
                 headers: {
                     'Content-Type': 'application/json',
-                    'app-id': this.appId
+                    'appKey': this.appKey
                 },
                 body: JSON.stringify(logData),
             });