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

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

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

खास जानकारी

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

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.
  });
auth_svc_get_idtoken.js

Web

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

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

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

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

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

  • सेवा वर्कर के पास Firebase 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);
      }
    });
  });
};
auth_svc_subscribe.js

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);
      }
    });
  });
};
service-worker-sessions.js

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

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));
});
auth_svc_intercept.js

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));
});
service-worker-sessions.js

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

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

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

Web

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

Web

self.addEventListener('activate', (event) => {
  event.waitUntil(clients.claim());
});
service-worker-sessions.js

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

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

Web

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

Web

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

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

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.
  });
auth_svc_sign_in_email.js

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.
  });
service-worker-sessions.js

सर्वर साइड में हुए बदलाव

सर्वर साइड कोड, हर अनुरोध पर आईडी टोकन का पता लगा पाएगा. Node.js के लिए एडमिन SDK टूल या FirebaseServerApp का इस्तेमाल करने वाले वेब 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('/'));
service-worker-sessions.js

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

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');
    }

    // ...
}
firebaseserverapp.js

नतीजा

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

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

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

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