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

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

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

खास जानकारी

Firebase पुष्टि करने की सुविधा को क्लाइंट साइड पर चलाने के लिए ऑप्टिमाइज़ किया गया है. टोकन, वेब स्टोरेज में सेव किए जाते हैं. इससे रीयलटाइम डेटाबेस, 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 पुष्टि, कुकी के आधार पर सेशन मैनेज करने का ज़्यादा पारंपरिक समाधान उपलब्ध कराती है. हालांकि, यह समाधान सर्वर साइड httpOnly कुकी पर आधारित ऐप्लिकेशन के लिए सबसे अच्छी तरह काम करता है. इसे मैनेज करना भी मुश्किल है, क्योंकि क्लाइंट टोकन और सर्वर साइड टोकन सिंक से बाहर हो सकते हैं. खास तौर पर तब, जब आपको क्लाइंट पर आधारित अन्य Firebase सेवाओं का इस्तेमाल करना हो.

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

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

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

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

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

नतीजा

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

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

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

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