وراثت متغیرهای کانتکست ناهمزمان در جاوا اسکریپت: تسلط بر زنجیره انتشار کانتکست

برنامه‌نویسی ناهمزمان یکی از ارکان اصلی توسعه مدرن جاوا اسکریپت است، به ویژه در محیط‌های Node.js و مرورگر. با وجود اینکه مزایای قابل توجهی در عملکرد ارائه می‌دهد، پیچیدگی‌هایی را نیز به همراه دارد، به خصوص در مدیریت کانتکست در سراسر عملیات ناهمزمان. اطمینان از اینکه متغیرها و داده‌های مربوطه در طول زنجیره اجرا قابل دسترسی هستند، برای کارهایی مانند لاگ‌گیری، احراز هویت، ردیابی و مدیریت درخواست‌ها حیاتی است. اینجاست که درک و پیاده‌سازی صحیح وراثت متغیر کانتکست ناهمزمان ضروری می‌شود.

درک چالش‌های کانتکست ناهمزمان

در جاوا اسکریپت همزمان، دسترسی به متغیرها ساده است. متغیرهایی که در یک حوزه والد تعریف شده‌اند، به راحتی در حوزه‌های فرزند در دسترس هستند. با این حال، عملیات ناهمزمان این مدل ساده را مختل می‌کند. Callback‌ها، promise‌ها و async/await نقاطی را معرفی می‌کنند که در آن کانتکست اجرا می‌تواند تغییر کند و به طور بالقوه دسترسی به داده‌های مهم را از دست بدهد. مثال زیر را در نظر بگیرید:

            function processRequest(req, res) {
  const userId = req.headers['user-id'];

  setTimeout(() => {
    // Problem: How do we access userId here?
    console.log(`Processing request for user: ${userId}`); // userId might be undefined!
    res.send('Request processed');
  }, 1000);
}

            

              
                Copy
              
            
          

در این سناریوی ساده شده، `userId` که از هدرهای درخواست به دست آمده، ممکن است به طور قابل اعتمادی در داخل callback `setTimeout` قابل دسترسی نباشد. این به این دلیل است که callback در یک تکرار متفاوت از حلقه رویداد (event loop) اجرا می‌شود و به طور بالقوه کانتکست اصلی را از دست می‌دهد.

معرفی AsyncLocalStorage

AsyncLocalStorage که در Node.js 14 معرفی شد، مکانیزمی برای ذخیره و بازیابی داده‌ها فراهم می‌کند که در طول عملیات ناهمزمان پایدار باقی می‌ماند. این ابزار مانند یک حافظه محلی رشته (thread-local storage) در زبان‌های دیگر عمل می‌کند، اما به طور خاص برای محیط غیر مسدودکننده و رویداد محور جاوا اسکریپت طراحی شده است.

AsyncLocalStorage چگونه کار می‌کند

AsyncLocalStorage به شما امکان می‌دهد یک نمونه حافظه ذخیره‌سازی ایجاد کنید که داده‌های خود را در تمام طول عمر یک کانتکست اجرای ناهمزمان حفظ می‌کند. این کانتکست به طور خودکار در سراسر فراخوانی‌های `await`، promise‌ها و دیگر مرزهای ناهمزمان منتشر می‌شود و تضمین می‌کند که داده‌های ذخیره شده قابل دسترسی باقی بمانند.

استفاده اولیه از AsyncLocalStorage

            const { AsyncLocalStorage } = require('async_hooks');

const asyncLocalStorage = new AsyncLocalStorage();

function processRequest(req, res) {
  const userId = req.headers['user-id'];

  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('userId', userId);

    setTimeout(() => {
      const currentUserId = asyncLocalStorage.getStore().get('userId');
      console.log(`Processing request for user: ${currentUserId}`);
      res.send('Request processed');
    }, 1000);
  });
}

            

              
                Copy
              
            
          

در این مثال بازبینی شده، `AsyncLocalStorage.run()` یک کانتکست اجرایی جدید با یک مخزن اولیه (در این مورد، یک `Map`) ایجاد می‌کند. سپس `userId` با استفاده از `asyncLocalStorage.getStore().set()` در این کانتکست ذخیره می‌شود. در داخل callback `setTimeout`، `asyncLocalStorage.getStore().get()` `userId` را از کانتکست بازیابی می‌کند و اطمینان می‌دهد که حتی پس از تأخیر ناهمزمان نیز در دسترس است.

مفاهیم کلیدی: Store و Run

• Store (مخزن): مخزن یک ظرف برای داده‌های کانتکست شماست. این می‌تواند هر شیء جاوا اسکریپت باشد، اما استفاده از `Map` یا یک شیء ساده رایج است. مخزن برای هر کانتکست اجرای ناهمزمان منحصر به فرد است.
• Run (اجرا): متد `run()` یک تابع را در کانتکست نمونه AsyncLocalStorage اجرا می‌کند. این متد یک مخزن و یک تابع callback را می‌پذیرد. همه چیز در داخل آن callback (و هر عملیات ناهمزمانی که فراخوانی می‌کند) به آن مخزن دسترسی خواهد داشت.

AsyncResource: پر کردن شکاف با عملیات ناهمزمان نیتیو

در حالی که AsyncLocalStorage یک مکانیزم قدرتمند برای انتشار کانتکست در کد جاوا اسکریپت فراهم می‌کند، به طور خودکار به عملیات ناهمزمان نیتیو مانند دسترسی به فایل سیستم یا درخواست‌های شبکه گسترش نمی‌یابد. AsyncResource این شکاف را با اجازه دادن به شما برای مرتبط کردن صریح این عملیات با کانتکست فعلی AsyncLocalStorage پر می‌کند.

درک AsyncResource

AsyncResource به شما اجازه می‌دهد تا نمایشی از یک عملیات ناهمزمان ایجاد کنید که می‌تواند توسط AsyncLocalStorage ردیابی شود. این اطمینان می‌دهد که کانتکست AsyncLocalStorage به درستی به callback‌ها یا promise‌های مرتبط با عملیات ناهمزمان نیتیو منتشر می‌شود.

استفاده از AsyncResource

            const { AsyncLocalStorage } = require('async_hooks');
const { AsyncResource } = require('async_hooks');
const fs = require('fs');

const asyncLocalStorage = new AsyncLocalStorage();

function processRequest(req, res) {
  const userId = req.headers['user-id'];

  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('userId', userId);

    const resource = new AsyncResource('file-read-operation');

    fs.readFile('data.txt', 'utf8', (err, data) => {
      resource.runInAsyncScope(() => {
        const currentUserId = asyncLocalStorage.getStore().get('userId');
        console.log(`Processing data for user ${currentUserId}: ${data.length} bytes read`);
        res.send('Request processed');
        resource.emitDestroy();
      });
    });
  });
}

            

              
                Copy
              
            
          

در این مثال، `AsyncResource` برای بسته‌بندی عملیات `fs.readFile` استفاده می‌شود. `resource.runInAsyncScope()` تضمین می‌کند که تابع callback برای `fs.readFile` در کانتکست AsyncLocalStorage اجرا شود و `userId` را قابل دسترس کند. فراخوانی `resource.emitDestroy()` برای آزادسازی منابع و جلوگیری از نشت حافظه پس از تکمیل عملیات ناهمزمان حیاتی است. توجه: عدم فراخوانی `emitDestroy()` می‌تواند منجر به نشت منابع و ناپایداری برنامه شود.

مفاهیم کلیدی: مدیریت منابع

• ایجاد منبع: یک نمونه `AsyncResource` را قبل از شروع عملیات ناهمزمان ایجاد کنید. سازنده آن یک نام (برای اشکال‌زدایی) و یک `triggerAsyncId` اختیاری می‌گیرد.
• انتشار کانتکست: از `runInAsyncScope()` برای اجرای تابع callback در کانتکست AsyncLocalStorage استفاده کنید.
• تخریب منبع: پس از اتمام عملیات ناهمزمان، `emitDestroy()` را برای آزادسازی منابع فراخوانی کنید.

ساخت یک زنجیره انتشار کانتکست

قدرت واقعی AsyncLocalStorage و AsyncResource در توانایی آنها برای ایجاد یک زنجیره انتشار کانتکست است که چندین عملیات ناهمزمان و فراخوانی تابع را در بر می‌گیرد. این به شما امکان می‌دهد تا یک کانتکست ثابت و قابل اعتماد را در سراسر برنامه خود حفظ کنید.

مثال: یک جریان ناهمزمان چند لایه

            const { AsyncLocalStorage } = require('async_hooks');
const { AsyncResource } = require('async_hooks');
const fs = require('fs');

const asyncLocalStorage = new AsyncLocalStorage();

async function fetchData() {
  return new Promise((resolve) => {
    const resource = new AsyncResource('data-fetch');
    fs.readFile('data.txt', 'utf8', (err, data) => {
      resource.runInAsyncScope(() => {
        resolve(data);
        resource.emitDestroy();
      });
    });
  });
}

async function processData(data) {
  const currentUserId = asyncLocalStorage.getStore().get('userId');
  console.log(`Processing data for user ${currentUserId}: ${data.length} bytes`);
  return `Processed by user ${currentUserId}: ${data.substring(0, 20)}...`;
}

async function sendResponse(processedData, res) {
  res.send(processedData);
}

function processRequest(req, res) {
  const userId = req.headers['user-id'];

  asyncLocalStorage.run(new Map(), async () => {
    asyncLocalStorage.getStore().set('userId', userId);

    const data = await fetchData();
    const processedData = await processData(data);
    await sendResponse(processedData, res);
  });
}

            

              
                Copy
              
            
          

در این مثال، `processRequest` جریان را آغاز می‌کند. از `AsyncLocalStorage.run()` برای ایجاد کانتکست اولیه با `userId` استفاده می‌کند. `fetchData` داده‌ها را به صورت ناهمزمان با استفاده از `AsyncResource` از یک فایل می‌خواند. سپس `processData` به `userId` از AsyncLocalStorage برای پردازش داده‌ها دسترسی پیدا می‌کند. در نهایت، `sendResponse` داده‌های پردازش شده را به کلاینت باز می‌گرداند. نکته کلیدی این است که `userId` در تمام این زنجیره ناهمزمان به دلیل انتشار کانتکست توسط AsyncLocalStorage در دسترس است.

مزایای زنجیره انتشار کانتکست

• لاگ‌گیری ساده‌شده: به اطلاعات خاص درخواست (مانند شناسه کاربر، شناسه درخواست) در منطق لاگ‌گیری خود دسترسی پیدا کنید بدون اینکه آن را به صراحت از طریق چندین فراخوانی تابع منتقل کنید. این امر اشکال‌زدایی و حسابرسی را آسان‌تر می‌کند.
• پیکربندی متمرکز: تنظیمات پیکربندی مربوط به یک درخواست یا عملیات خاص را در کانتکست AsyncLocalStorage ذخیره کنید. این به شما امکان می‌دهد رفتار برنامه را به صورت پویا بر اساس کانتکست تنظیم کنید.
• افزایش قابلیت مشاهده (Observability): با سیستم‌های ردیابی برای پیگیری جریان اجرای عملیات ناهمزمان و شناسایی گلوگاه‌های عملکرد ادغام شوید.
• امنیت بهبود یافته: اطلاعات مربوط به امنیت (مانند توکن‌های احراز هویت، نقش‌های مجوز) را در کانتکست مدیریت کنید و از کنترل دسترسی ثابت و ایمن اطمینان حاصل کنید.

بهترین شیوه‌ها برای استفاده از AsyncLocalStorage و AsyncResource

در حالی که AsyncLocalStorage و AsyncResource ابزارهای قدرتمندی هستند، باید با احتیاط استفاده شوند تا از سربار عملکرد و مشکلات احتمالی جلوگیری شود.

حجم مخزن را به حداقل برسانید

فقط داده‌هایی را که واقعاً برای کانتکست ناهمزمان ضروری هستند ذخیره کنید. از ذخیره اشیاء بزرگ یا داده‌های غیر ضروری خودداری کنید، زیرا این می‌تواند بر عملکرد تأثیر بگذارد. استفاده از ساختارهای داده سبک مانند Map یا اشیاء ساده جاوا اسکریپت را در نظر بگیرید.

از تعویض بیش از حد کانتکست خودداری کنید

فراخوانی‌های مکرر `AsyncLocalStorage.run()` می‌تواند سربار عملکردی ایجاد کند. عملیات ناهمزمان مرتبط را تا حد امکان در یک کانتکست واحد گروه‌بندی کنید. از تودرتو کردن بیهوده کانتکست‌های AsyncLocalStorage خودداری کنید.

خطاها را به درستی مدیریت کنید

اطمینان حاصل کنید که خطاها در کانتکست AsyncLocalStorage به درستی مدیریت می‌شوند. از بلوک‌های try-catch یا میان‌افزارهای مدیریت خطا برای جلوگیری از ایجاد اختلال در زنجیره انتشار کانتکست توسط استثناهای مدیریت نشده استفاده کنید. برای اشکال‌زدایی آسان‌تر، ثبت خطاها را با اطلاعات خاص کانتکست که از مخزن AsyncLocalStorage بازیابی شده‌اند، در نظر بگیرید.

از AsyncResource با مسئولیت‌پذیری استفاده کنید

همیشه پس از اتمام عملیات ناهمزمان، `resource.emitDestroy()` را برای آزادسازی منابع فراخوانی کنید. عدم انجام این کار می‌تواند منجر به نشت حافظه و ناپایداری برنامه شود. از AsyncResource فقط در مواقع ضروری برای پر کردن شکاف بین کد جاوا اسکریپت و عملیات ناهمزمان نیتیو استفاده کنید. برای عملیات ناهمزمان کاملاً جاوا اسکریپتی، اغلب AsyncLocalStorage به تنهایی کافی است.

پیامدهای عملکردی را در نظر بگیرید

AsyncLocalStorage و AsyncResource مقداری سربار عملکردی دارند. در حالی که برای اکثر برنامه‌ها به طور کلی قابل قبول است، آگاهی از تأثیر بالقوه آن، به ویژه در سناریوهای حساس به عملکرد، ضروری است. کد خود را پروفایل کنید و تأثیر عملکردی استفاده از AsyncLocalStorage و AsyncResource را اندازه‌گیری کنید تا اطمینان حاصل کنید که نیازهای برنامه شما را برآورده می‌کند.

مثال: پیاده‌سازی یک لاگر سفارشی با AsyncLocalStorage

            const { AsyncLocalStorage } = require('async_hooks');

const asyncLocalStorage = new AsyncLocalStorage();

const logger = {
  log: (message) => {
    const requestId = asyncLocalStorage.getStore()?.get('requestId') || 'N/A';
    console.log(`[${requestId}] ${message}`);
  },
  error: (message) => {
    const requestId = asyncLocalStorage.getStore()?.get('requestId') || 'N/A';
    console.error(`[${requestId}] ERROR: ${message}`);
  },
};

function processRequest(req, res, next) {
  const requestId = Math.random().toString(36).substring(7); // Generate a unique request ID

  asyncLocalStorage.run(new Map(), () => {
    asyncLocalStorage.getStore().set('requestId', requestId);
    logger.log('Request received');
    next(); // Pass control to the next middleware
  });
}

// Example Usage (in an Express.js application)
// app.use(processRequest);
// app.get('/data', (req, res) => {
//   logger.log('Fetching data...');
//   res.send('Data retrieved successfully');
// });

// In case of errors:
// try {
//   // some code that may throw an error
// } catch (error) {
//   logger.error(`An error occurred: ${error.message}`);
//   // ...
// }

            

              
                Copy
              
            
          

این مثال نشان می‌دهد که چگونه می‌توان از AsyncLocalStorage برای پیاده‌سازی یک لاگر سفارشی استفاده کرد که به طور خودکار شناسه درخواست را در هر پیام لاگ অন্তর্ভুক্ত می‌کند. این کار نیاز به ارسال صریح شناسه درخواست به توابع لاگ‌گیری را از بین می‌برد و کد را تمیزتر و نگهداری آن را آسان‌تر می‌کند.

جایگزین‌های AsyncLocalStorage

در حالی که AsyncLocalStorage یک راه حل قوی برای انتشار کانتکست ارائه می‌دهد، رویکردهای دیگری نیز وجود دارد. بسته به نیازهای خاص برنامه شما، این جایگزین‌ها ممکن است مناسب‌تر باشند.

انتقال صریح کانتکست

ساده‌ترین رویکرد، انتقال صریح داده‌های کانتکست به عنوان آرگومان به فراخوانی‌های توابع است. با اینکه این روش مستقیم است، اما می‌تواند دست و پا گیر و مستعد خطا باشد، به خصوص در جریان‌های ناهمزمان پیچیده. همچنین توابع را به داده‌های کانتکست به شدت وابسته می‌کند و کد را کمتر ماژولار و قابل استفاده مجدد می‌سازد.

cls-hooked (ماژول جامعه کاربری)

`cls-hooked` یک ماژول محبوب جامعه کاربری است که عملکردی مشابه AsyncLocalStorage را فراهم می‌کند، اما بر روی دستکاری (monkey-patching) API Node.js تکیه دارد. در حالی که ممکن است در برخی موارد استفاده از آن آسان‌تر باشد، به طور کلی توصیه می‌شود تا حد امکان از AsyncLocalStorage نیتیو استفاده شود، زیرا عملکرد بهتری دارد و احتمال کمتری دارد که مشکلات سازگاری ایجاد کند.

کتابخانه‌های انتشار کانتکست

چندین کتابخانه، انتزاعات سطح بالاتری برای انتشار کانتکست ارائه می‌دهند. این کتابخانه‌ها اغلب ویژگی‌هایی مانند ردیابی خودکار، ادغام با لاگ‌گیری و پشتیبانی از انواع مختلف کانتکست را ارائه می‌دهند. نمونه‌ها شامل کتابخانه‌هایی هستند که برای فریم‌ورک‌های خاص یا پلتفرم‌های observability طراحی شده‌اند.

نتیجه‌گیری

AsyncLocalStorage و AsyncResource در جاوا اسکریپت مکانیزم‌های قدرتمندی برای مدیریت کانتکست در سراسر عملیات ناهمزمان فراهم می‌کنند. با درک مفاهیم مخزن‌ها، اجراها و مدیریت منابع، می‌توانید برنامه‌های ناهمزمان قوی، قابل نگهداری و قابل مشاهده بسازید. در حالی که جایگزین‌هایی وجود دارد، AsyncLocalStorage یک راه حل نیتیو و با عملکرد بالا برای اکثر موارد استفاده ارائه می‌دهد. با پیروی از بهترین شیوه‌ها و در نظر گرفتن دقیق پیامدهای عملکردی، می‌توانید از AsyncLocalStorage برای ساده‌سازی کد خود و بهبود کیفیت کلی برنامه‌های ناهمزمان خود بهره ببرید. این منجر به کدی می‌شود که نه تنها اشکال‌زدایی آن آسان‌تر است، بلکه در محیط‌های ناهمزمان پیچیده امروزی امن‌تر، قابل اعتمادتر و مقیاس‌پذیرتر است. گام حیاتی `resource.emitDestroy()` را هنگام استفاده از `AsyncResource` برای جلوگیری از نشت احتمالی حافظه فراموش نکنید. این ابزارها را بپذیرید تا بر پیچیدگی‌های کانتکست ناهمزمان غلبه کنید و برنامه‌های جاوا اسکریپت واقعاً استثنایی بسازید.