SDK ارسال پیامک Node.js

کد: client.test.js

const { Client, createClient } = require('../index');
const axios = require('axios');
const MockAdapter = require('axios-mock-adapter');

describe('ippanel SDK Client', () => {
  const API_KEY = 'test-api-key';
  const DEFAULT_BASE_URL = 'https://edge.ippanel.com/v1/api';
  let client;
  let mock;

  // قبل از هر تست، یک کلاینت جدید و MockAdapter را راه‌اندازی می‌کند
  beforeEach(() => {
    client = new Client(API_KEY);
    // MockAdapter برای شبیه‌سازی درخواست‌های HTTP
    mock = new MockAdapter(client.httpClient);
  });

  // بعد از هر تست، MockAdapter را ریست می‌کند تا تاثیر تست قبلی باقی نماند
  afterEach(() => {
    mock.reset();
  });

  // تست‌های مربوط به مقداردهی اولیه کلاینت
  describe('Client initialization', () => {
    test('should create client with API key', () => {
      expect(client).toBeInstanceOf(Client); // بررسی می‌کند که آیا نمونه ایجاد شده از نوع Client است
      expect(client.apiKey).toBe(API_KEY); // بررسی می‌کند که کلید API درست تنظیم شده است
      expect(client.baseUrl).toBe(DEFAULT_BASE_URL); // بررسی می‌کند که URL پایه پیش‌فرض درست است
    });

    test('should create client with custom base URL', () => {
      const customUrl = 'https://custom.api.example.com';
      const customClient = new Client(API_KEY, customUrl);
      expect(customClient.baseUrl).toBe(customUrl); // بررسی می‌کند که URL پایه سفارشی درست تنظیم شده است
    });

    test('should throw error when API key is missing', () => {
      // تست می‌کند که اگر کلید API ارسال نشود، خطا ایجاد شود
      expect(() => new Client()).toThrow('API key is required');
    });

    test('should create client using factory function', () => {
      const factoryClient = createClient(API_KEY);
      expect(factoryClient).toBeInstanceOf(Client); // بررسی می‌کند که تابع سازنده (factory) کلاینت را درست ایجاد می‌کند
      expect(factoryClient.apiKey).toBe(API_KEY);
    });
  });

  // تست‌های مربوط به پیکربندی کلاینت HTTP
  describe('HTTP client configuration', () => {
    test('should have default timeout set', () => {
      // بررسی می‌کند که زمان انتظار پیش‌فرض HTTP تنظیم شده است
      expect(client.httpClient.defaults.timeout).toBe(10000);
    });

    test('should have correct authorization header', () => {
      // بررسی می‌کند که هدر Authorization با کلید API به درستی تنظیم شده است
      expect(client.httpClient.defaults.headers.Authorization).toBe(API_KEY);
    });

    test('should allow setting custom HTTP client', () => {
      const customClient = axios.create({ timeout: 5000 }); // ایجاد یک کلاینت Axios سفارشی
      client.setHttpClient(customClient); // تنظیم کلاینت سفارشی برای SDK
      expect(client.httpClient).toBe(customClient); // اطمینان از اینکه کلاینت سفارشی استفاده می‌شود
    });
  });

  // تست‌های مربوط به مدیریت خطاها
  describe('Error handling', () => {
    test('should handle API errors', async () => {
      // شبیه‌سازی یک خطای 400 از API
      mock.onPost(/send/).reply(400, { error: 'Invalid request' });
      // انتظار می‌رود که تابع ارسال پیام، خطای API را پرتاب کند
      await expect(client.sendWebservice('Test message', '+983000505', ['+989123456789'])).rejects.toThrow('API Error: 400');
    });

    test('should handle network errors', async () => {
      // شبیه‌سازی خطای شبکه
      mock.onPost(/send/).networkError();
      // انتظار می‌رود که تابع ارسال پیام، خطای شبکه را پرتاب کند
      await expect(client.sendWebservice('Test message', '+983000505', ['+989123456789'])).rejects.toThrow();
    });
  });
});

توضیحات کد: client.test.js

• خط 1-3: وارد کردن ماژول‌های لازم: `Client` و `createClient` از SDK، `axios` برای درخواست‌های HTTP، و `MockAdapter` برای شبیه‌سازی پاسخ‌های سرور در تست‌ها.
• خط 5: شروع بلوک توصیفی (describe) برای تست‌های مربوط به کلاینت IPPanel.
• خط 7-9: تعریف ثابت‌ها: کلید API نمونه (test-api-key) و URL پایه پیش‌فرض API.
• خط 10-12: تعریف متغیرهایی که قبل و بعد از هر تست مقداردهی یا پاک‌سازی می‌شوند (کلاینت و Mock).
• خط 14-18: اجرای تابع `beforeEach`: قبل از اجرای هر تست، یک نمونه جدید از `Client` با کلید API ایجاد می‌شود و `MockAdapter` برای نمونه `httpClient` کلاینت پیکربندی می‌گردد.
• خط 20-22: اجرای تابع `afterEach`: پس از اتمام هر تست، تمامی شبیه‌سازی‌های `MockAdapter` ریست می‌شوند تا اطمینان حاصل شود تست‌ها مستقل از هم اجرا می‌شوند.
• خط 24: شروع بلوک توصیفی برای تست‌های مربوط به مقداردهی اولیه (Initialization) کلاینت.
• خط 26-29: تست `should create client with API key`: بررسی می‌کند که کلاینت به درستی با کلید API ساخته شده، نمونه `Client` باشد، کلید API و URL پایه درست تنظیم شده باشند.
• خط 31-34: تست `should create client with custom base URL`: اطمینان از اینکه کلاینت می‌تواند با یک URL پایه سفارشی نیز مقداردهی شود.
• خط 36-38: تست `should throw error when API key is missing`: بررسی می‌کند که اگر کلید API در هنگام ساخت کلاینت ارائه نشود، خطای لازم پرتاب شود.
• خط 40-43: تست `should create client using factory function`: اطمینان از صحت عملکرد تابع کمکی `createClient` برای ساخت نمونه کلاینت.
• خط 45: شروع بلوک توصیفی برای تست‌های پیکربندی کلاینت HTTP.
• خط 47-49: تست `should have default timeout set`: بررسی می‌کند که مقدار پیش‌فرض Timeout برای درخواست‌های HTTP به درستی تنظیم شده باشد (10 ثانیه).
• خط 51-53: تست `should have correct authorization header`: اطمینان از اینکه هدر `Authorization` با کلید API به صورت خودکار در درخواست‌ها قرار می‌گیرد.
• خط 55-59: تست `should allow setting custom HTTP client`: بررسی می‌کند که بتوان یک نمونه کلاینت HTTP سفارشی (مثلاً با تنظیمات Timeout متفاوت) را به SDK تزریق کرد.
• خط 61: شروع بلوک توصیفی برای تست‌های مدیریت خطا.
• خط 63-67: تست `should handle API errors`: با استفاده از `MockAdapter`، یک پاسخ خطای 400 از سرور شبیه‌سازی می‌شود و سپس بررسی می‌گردد که تابع `sendWebservice` خطای مربوطه را به درستی پرتاب کند.
• خط 69-73: تست `should handle network errors`: در این تست، یک خطای شبکه (Network Error) شبیه‌سازی می‌شود تا اطمینان حاصل شود SDK در مواجهه با مشکلات اتصال نیز به درستی عمل کرده و خطا را پرتاب می‌کند.