सर्विस वर्कर के साथ सेशन मैनेजमेंट

Firebase Auth, सर्विस वर्कर का इस्तेमाल करने की सुविधा देता है. इससे सेशन मैनेजमेंट के लिए, Firebase आईडी टोकन का पता लगाया जा सकता है और उन्हें पास किया जा सकता है. इससे ये फ़ायदे मिलते हैं:

  • सर्वर से किए जाने वाले हर एचटीटीपी अनुरोध पर आईडी टोकन पास करने की सुविधा. इसके लिए, आपको कोई अतिरिक्त काम नहीं करना पड़ता.
  • किसी अन्य राउंड ट्रिप या देरी के बिना आईडी टोकन को रीफ़्रेश करने की सुविधा.
  • बैकएंड और फ़्रंटएंड के सिंक किए गए सेशन. इस समाधान का इस्तेमाल उन ऐप्लिकेशन के लिए किया जा सकता है जिन्हें Realtime Database, Firestore वगैरह जैसी Firebase सेवाओं और कुछ बाहरी सर्वर साइड रिसोर्स (SQL डेटाबेस वगैरह) को ऐक्सेस करना होता है. इसके अलावा, एक ही सेशन को सर्विस वर्कर, वेब वर्कर या शेयर किए गए वर्कर से भी ऐक्सेस किया जा सकता है.
  • इससे हर पेज पर Firebase Auth का सोर्स कोड शामिल करने की ज़रूरत नहीं पड़ती. साथ ही, इससे इंतज़ार का समय कम हो जाता है. सर्विस वर्कर को एक बार लोड और शुरू किया जाता है. यह बैकग्राउंड में सभी क्लाइंट के लिए सेशन मैनेजमेंट को हैंडल करता है.

खास जानकारी

Firebase Auth को क्लाइंट साइड पर चलाने के लिए ऑप्टिमाइज़ किया गया है. टोकन, वेब स्टोरेज में सेव किए जाते हैं. इससे, इसे Firebase की अन्य सेवाओं के साथ आसानी से इंटिग्रेट किया जा सकता है. जैसे, Realtime Database, Cloud Firestore, Cloud Storage वगैरह. सर्वर साइड से सेशन मैनेज करने के लिए, आईडी टोकन वापस पाने और उन्हें सर्वर को पास करने की ज़रूरत होती है.

Web

import { getAuth, getIdToken } from "firebase/auth";

const auth = getAuth();
getIdToken(auth.currentUser)
  .then((idToken) => {
    // idToken can be passed back to server.
  })
  .catch((error) => {
    // Error occurred.
  });

Web

firebase.auth().currentUser.getIdToken()
  .then((idToken) => {
    // idToken can be passed back to server.
  })
  .catch((error) => {
    // Error occurred.
  });

हालांकि, इसका मतलब है कि क्लाइंट को कुछ स्क्रिप्ट चलाने की ज़रूरत होगी, ताकि उसे नया आईडी टोकन मिल सके. इसके बाद, वह इसे अनुरोध हेडर, POST बॉडी वगैरह के ज़रिए सर्वर को भेज सके.

यह तरीका शायद काम न करे. इसके बजाय, सर्वर साइड सेशन कुकी का इस्तेमाल करना पड़ सकता है. आईडी टोकन को सेशन कुकी के तौर पर सेट किया जा सकता है. हालांकि, ये कम समय के लिए उपलब्ध होते हैं. इन्हें क्लाइंट से रीफ़्रेश करना होगा. इसके बाद, समयसीमा खत्म होने पर इन्हें नई कुकी के तौर पर सेट करना होगा. अगर उपयोगकर्ता ने कुछ समय से साइट पर विज़िट नहीं किया है, तो इसके लिए अतिरिक्त राउंड ट्रिप की ज़रूरत पड़ सकती है.

Firebase Auth, कुकी पर आधारित सेशन मैनेजमेंट का ज़्यादा पारंपरिक समाधान उपलब्ध कराता है. हालांकि, यह समाधान सर्वर साइड httpOnlyकुकी पर आधारित ऐप्लिकेशन के लिए सबसे अच्छा काम करता है. साथ ही, इसे मैनेज करना मुश्किल होता है, क्योंकि क्लाइंट टोकन और सर्वर साइड टोकन सिंक से बाहर हो सकते हैं. ऐसा तब होता है, जब आपको क्लाइंट पर आधारित Firebase की अन्य सेवाओं का भी इस्तेमाल करना हो.

इसके बजाय, सर्वर साइड पर उपयोगकर्ता के सेशन मैनेज करने के लिए, सर्विस वर्कर का इस्तेमाल किया जा सकता है. यह इन वजहों से काम करता है:

  • सर्विस वर्कर के पास, Firebase Auth की मौजूदा स्थिति का ऐक्सेस होता है. मौजूदा उपयोगकर्ता के आईडी टोकन को सर्विस वर्कर से वापस पाया जा सकता है. अगर टोकन की समयसीमा खत्म हो गई है, तो क्लाइंट एसडीके उसे रीफ़्रेश करेगा और नया टोकन देगा.
  • सर्विस वर्कर, फ़ेच के अनुरोधों को इंटरसेप्ट कर सकते हैं और उनमें बदलाव कर सकते हैं.

सर्विस वर्कर में हुए बदलाव

अगर किसी उपयोगकर्ता ने साइन इन किया है, तो सर्विस वर्कर को Auth लाइब्रेरी और मौजूदा आईडी टोकन पाने की सुविधा शामिल करनी होगी.

Web

import { initializeApp } from "firebase/app";
import { getAuth, onAuthStateChanged, getIdToken } from "firebase/auth";

// Initialize the Firebase app in the service worker script.
initializeApp(config);

/**
 * Returns a promise that resolves with an ID token if available.
 * @return {!Promise<?string>} The promise that resolves with an ID token if
 *     available. Otherwise, the promise resolves with null.
 */
const auth = getAuth();
const getIdTokenPromise = () => {
  return new Promise((resolve, reject) => {
    const unsubscribe = onAuthStateChanged(auth, (user) => {
      unsubscribe();
      if (user) {
        getIdToken(user).then((idToken) => {
          resolve(idToken);
        }, (error) => {
          resolve(null);
        });
      } else {
        resolve(null);
      }
    });
  });
};

Web

// Initialize the Firebase app in the service worker script.
firebase.initializeApp(config);

/**
 * Returns a promise that resolves with an ID token if available.
 * @return {!Promise<?string>} The promise that resolves with an ID token if
 *     available. Otherwise, the promise resolves with null.
 */
const getIdToken = () => {
  return new Promise((resolve, reject) => {
    const unsubscribe = firebase.auth().onAuthStateChanged((user) => {
      unsubscribe();
      if (user) {
        user.getIdToken().then((idToken) => {
          resolve(idToken);
        }, (error) => {
          resolve(null);
        });
      } else {
        resolve(null);
      }
    });
  });
};

ऐप्लिकेशन के ऑरिजिन के सभी फ़ेच अनुरोधों को इंटरसेप्ट किया जाएगा. साथ ही, अगर कोई आईडी टोकन उपलब्ध है, तो उसे हेडर के ज़रिए अनुरोध में जोड़ दिया जाएगा. सर्वर साइड पर, आईडी टोकन के लिए अनुरोध हेडर की जांच की जाएगी. इसके बाद, इसकी पुष्टि की जाएगी और इसे प्रोसेस किया जाएगा. सर्विस वर्कर स्क्रिप्ट में, फ़ेच अनुरोध को इंटरसेप्ट किया जाएगा और उसमें बदलाव किया जाएगा.

Web

const getOriginFromUrl = (url) => {
  // https://stackoverflow.com/questions/1420881/how-to-extract-base-url-from-a-string-in-javascript
  const pathArray = url.split('/');
  const protocol = pathArray[0];
  const host = pathArray[2];
  return protocol + '//' + host;
};

// Get underlying body if available. Works for text and json bodies.
const getBodyContent = (req) => {
  return Promise.resolve().then(() => {
    if (req.method !== 'GET') {
      if (req.headers.get('Content-Type').indexOf('json') !== -1) {
        return req.json()
          .then((json) => {
            return JSON.stringify(json);
          });
      } else {
        return req.text();
      }
    }
  }).catch((error) => {
    // Ignore error.
  });
};

self.addEventListener('fetch', (event) => {
  /** @type {FetchEvent} */
  const evt = event;

  const requestProcessor = (idToken) => {
    let req = evt.request;
    let processRequestPromise = Promise.resolve();
    // For same origin https requests, append idToken to header.
    if (self.location.origin == getOriginFromUrl(evt.request.url) &&
        (self.location.protocol == 'https:' ||
         self.location.hostname == 'localhost') &&
        idToken) {
      // Clone headers as request headers are immutable.
      const headers = new Headers();
      req.headers.forEach((val, key) => {
        headers.append(key, val);
      });
      // Add ID token to header.
      headers.append('Authorization', 'Bearer ' + idToken);
      processRequestPromise = getBodyContent(req).then((body) => {
        try {
          req = new Request(req.url, {
            method: req.method,
            headers: headers,
            mode: 'same-origin',
            credentials: req.credentials,
            cache: req.cache,
            redirect: req.redirect,
            referrer: req.referrer,
            body,
            // bodyUsed: req.bodyUsed,
            // context: req.context
          });
        } catch (e) {
          // This will fail for CORS requests. We just continue with the
          // fetch caching logic below and do not pass the ID token.
        }
      });
    }
    return processRequestPromise.then(() => {
      return fetch(req);
    });
  };
  // Fetch the resource after checking for the ID token.
  // This can also be integrated with existing logic to serve cached files
  // in offline mode.
  evt.respondWith(getIdTokenPromise().then(requestProcessor, requestProcessor));
});

Web

const getOriginFromUrl = (url) => {
  // https://stackoverflow.com/questions/1420881/how-to-extract-base-url-from-a-string-in-javascript
  const pathArray = url.split('/');
  const protocol = pathArray[0];
  const host = pathArray[2];
  return protocol + '//' + host;
};

// Get underlying body if available. Works for text and json bodies.
const getBodyContent = (req) => {
  return Promise.resolve().then(() => {
    if (req.method !== 'GET') {
      if (req.headers.get('Content-Type').indexOf('json') !== -1) {
        return req.json()
          .then((json) => {
            return JSON.stringify(json);
          });
      } else {
        return req.text();
      }
    }
  }).catch((error) => {
    // Ignore error.
  });
};

self.addEventListener('fetch', (event) => {
  /** @type {FetchEvent} */
  const evt = event;

  const requestProcessor = (idToken) => {
    let req = evt.request;
    let processRequestPromise = Promise.resolve();
    // For same origin https requests, append idToken to header.
    if (self.location.origin == getOriginFromUrl(evt.request.url) &&
        (self.location.protocol == 'https:' ||
         self.location.hostname == 'localhost') &&
        idToken) {
      // Clone headers as request headers are immutable.
      const headers = new Headers();
      req.headers.forEach((val, key) => {
        headers.append(key, val);
      });
      // Add ID token to header.
      headers.append('Authorization', 'Bearer ' + idToken);
      processRequestPromise = getBodyContent(req).then((body) => {
        try {
          req = new Request(req.url, {
            method: req.method,
            headers: headers,
            mode: 'same-origin',
            credentials: req.credentials,
            cache: req.cache,
            redirect: req.redirect,
            referrer: req.referrer,
            body,
            // bodyUsed: req.bodyUsed,
            // context: req.context
          });
        } catch (e) {
          // This will fail for CORS requests. We just continue with the
          // fetch caching logic below and do not pass the ID token.
        }
      });
    }
    return processRequestPromise.then(() => {
      return fetch(req);
    });
  };
  // Fetch the resource after checking for the ID token.
  // This can also be integrated with existing logic to serve cached files
  // in offline mode.
  evt.respondWith(getIdToken().then(requestProcessor, requestProcessor));
});

इस वजह से, पुष्टि किए गए सभी अनुरोधों में, हेडर में हमेशा एक आईडी टोकन पास किया जाएगा. इसके लिए, किसी अतिरिक्त प्रोसेसिंग की ज़रूरत नहीं होगी.

सेवा देने वाले वर्कर को पुष्टि करने की स्थिति में हुए बदलावों का पता लगाने के लिए, उसे साइन-इन/साइन-अप पेज पर इंस्टॉल करना होगा. पक्का करें कि सर्विस वर्कर बंडल किया गया हो, ताकि ब्राउज़र बंद होने के बाद भी वह काम करता रहे.

इंस्टॉल करने के बाद, सेवा देने वाले व्यक्ति को clients.claim() पर कॉल करना होगा, ताकि इसे मौजूदा पेज के लिए कंट्रोलर के तौर पर सेट अप किया जा सके.

Web

self.addEventListener('activate', (event) => {
  event.waitUntil(clients.claim());
});

Web

self.addEventListener('activate', (event) => {
  event.waitUntil(clients.claim());
});

क्लाइंट साइड में बदलाव

अगर सर्विस वर्कर की सुविधा उपलब्ध है, तो उसे क्लाइंट साइड के साइन-इन/साइन-अप पेज पर इंस्टॉल करना होगा.

Web

// Install servicerWorker if supported on sign-in/sign-up page.
if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/service-worker.js', {scope: '/'});
}

Web

// Install servicerWorker if supported on sign-in/sign-up page.
if ('serviceWorker' in navigator) {
  navigator.serviceWorker.register('/service-worker.js', {scope: '/'});
}

जब उपयोगकर्ता साइन इन होता है और उसे किसी दूसरे पेज पर रीडायरेक्ट किया जाता है, तो सर्विस वर्कर, रीडायरेक्ट पूरा होने से पहले हेडर में आईडी टोकन डाल पाएगा.

Web

import { getAuth, signInWithEmailAndPassword } from "firebase/auth";

// Sign in screen.
const auth = getAuth();
signInWithEmailAndPassword(auth, email, password)
  .then((result) => {
    // Redirect to profile page after sign-in. The service worker will detect
    // this and append the ID token to the header.
    window.location.assign('/profile');
  })
  .catch((error) => {
    // Error occurred.
  });

Web

// Sign in screen.
firebase.auth().signInWithEmailAndPassword(email, password)
  .then((result) => {
    // Redirect to profile page after sign-in. The service worker will detect
    // this and append the ID token to the header.
    window.location.assign('/profile');
  })
  .catch((error) => {
    // Error occurred.
  });

सर्वर साइड में किए गए बदलाव

सर्वर साइड कोड, हर अनुरोध पर आईडी टोकन का पता लगा सकेगा. इस सुविधा का इस्तेमाल, Node.js के लिए Admin SDK या FirebaseServerApp का इस्तेमाल करके Web SDK के साथ किया जा सकता है.

Node.js

  // Server side code.
  const admin = require('firebase-admin');

  // The Firebase Admin SDK is used here to verify the ID token.
  admin.initializeApp();

  function getIdToken(req) {
    // Parse the injected ID token from the request header.
    const authorizationHeader = req.headers.authorization || '';
    const components = authorizationHeader.split(' ');
    return components.length > 1 ? components[1] : '';
  }

  function checkIfSignedIn(url) {
    return (req, res, next) => {
      if (req.url == url) {
        const idToken = getIdToken(req);
        // Verify the ID token using the Firebase Admin SDK.
        // User already logged in. Redirect to profile page.
        admin.auth().verifyIdToken(idToken).then((decodedClaims) => {
          // User is authenticated, user claims can be retrieved from
          // decodedClaims.
          // In this sample code, authenticated users are always redirected to
          // the profile page.
          res.redirect('/profile');
        }).catch((error) => {
          next();
        });
      } else {
        next();
      }
    };
  }

  // If a user is signed in, redirect to profile page.
  app.use(checkIfSignedIn('/'));

वेब मॉड्यूलर एपीआई

import { initializeServerApp } from 'firebase/app';
import { getAuth } from 'firebase/auth';
import { headers } from 'next/headers';
import { redirect } from 'next/navigation';

export default function MyServerComponent() {

    // Get relevant request headers (in Next.JS)
    const authIdToken = headers().get('Authorization')?.split('Bearer ')[1];

    // Initialize the FirebaseServerApp instance.
    const serverApp = initializeServerApp(firebaseConfig, { authIdToken });

    // Initialize Firebase Authentication using the FirebaseServerApp instance.
    const auth = getAuth(serverApp);

    if (auth.currentUser) {
        redirect('/profile');
    }

    // ...
}

नतीजा

इसके अलावा, आईडी टोकन को सर्विस वर्कर के ज़रिए सेट किया जाएगा. साथ ही, सर्विस वर्कर को एक ही ऑरिजिन से चलाने की अनुमति होती है. इसलिए, सीएसआरएफ़ का कोई जोखिम नहीं है. ऐसा इसलिए, क्योंकि अलग ऑरिजिन की कोई वेबसाइट आपके एंडपॉइंट को कॉल करने की कोशिश करेगी, तो वह सर्विस वर्कर को शुरू नहीं कर पाएगी. इससे सर्वर के हिसाब से अनुरोध, बिना पुष्टि किया हुआ दिखेगा.

सर्विस वर्कर अब सभी मॉडर्न ब्राउज़र के साथ काम करते हैं. हालांकि, कुछ पुराने ब्राउज़र के साथ ये काम नहीं करते. इस वजह से, जब सर्विस वर्कर उपलब्ध नहीं होते हैं, तब आईडी टोकन को आपके सर्वर पर भेजने के लिए, कुछ फ़ॉलबैक की ज़रूरत पड़ सकती है. इसके अलावा, किसी ऐप्लिकेशन को सिर्फ़ उन ब्राउज़र पर चलाने के लिए प्रतिबंधित किया जा सकता है जो सर्विस वर्कर के साथ काम करते हैं.

ध्यान दें कि सर्विस वर्कर सिर्फ़ एक ऑरिजिन के लिए होते हैं. इन्हें सिर्फ़ उन वेबसाइटों पर इंस्टॉल किया जाएगा जो https कनेक्शन या लोकलहोस्ट के ज़रिए दिखाई जाती हैं.

सर्विस वर्कर के साथ काम करने वाले ब्राउज़र के बारे में ज़्यादा जानने के लिए, caniuse.com पर जाएं.