@thzero/library_server_firebase 0.18.11 → 0.18.14

package/README.md

@@ -1,15 +1,15 @@
-![GitHub package.json version](https://img.shields.io/github/package-json/v/thzero/library_server_firebase)
-![David](https://img.shields.io/david/thzero/library_server_firebase)
-[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
-
-# library_server_firebase
-
-## Requirements
-
-### NodeJs
-
-[NodeJs](https://nodejs.org) version 18+
-
-### Installation
-
-[![NPM](https://nodei.co/npm/@thzero/library_server_firebase.png?compact=true)](https://npmjs.org/package/@thzero/library_server_firebase)
+![GitHub package.json version](https://img.shields.io/github/package-json/v/thzero/library_server_firebase)
+![David](https://img.shields.io/david/thzero/library_server_firebase)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# library_server_firebase
+
+## Requirements
+
+### NodeJs
+
+[NodeJs](https://nodejs.org) version 18+
+
+### Installation
+
+[![NPM](https://nodei.co/npm/@thzero/library_server_firebase.png?compact=true)](https://npmjs.org/package/@thzero/library_server_firebase)

package/auth/index.js

@@ -1,193 +1,225 @@
-import fs from 'fs';
-import path from 'path';
-
-import admin from 'firebase-admin';
-
-import LibraryServerConstants from '@thzero/library_server/constants.js';
-
-import NotImplementedError from '@thzero/library_common/errors/notImplemented.js';
-
-import Service from '@thzero/library_server/service/index.js';
-
-import TokenExpiredError from '@thzero/library_server/errors/tokenExpired.js';
-
-class FirebaseAuthAdminService extends Service {
-	constructor() {
-		super();
-
-		this._serviceUsers = null;
-	}
-
-	async init(injector) {
-		await super.init(injector);
-
-		let serviceAccount = process.env.SERVICE_ACCOUNT_KEY;
-		if (serviceAccount)
-			serviceAccount = JSON.parse(serviceAccount);
-		if (!serviceAccount)
-			serviceAccount = this._initConfig();
-		admin.initializeApp({
-			credential: admin.credential.cert(serviceAccount),
-			databaseURL: serviceAccount.database_url
-		});
-
-		this._serviceUsers  = this._injector.getService(LibraryServerConstants.InjectorKeys.SERVICE_USERS);
-	}
-
-	async deleteUser(correlationId, uid) {
-		try {
-			if (String.isNullOrEmpty(uid))
-				return null;
-
-			const user = await admin.auth().getUser(uid);
-			if (!user)
-				return null;
-
-			const results = await admin.auth().deleteUser(uid);
-			if (!results)
-				return this._error('FirebaseAuthAdminService', 'deleteUser', 'Unable to delete user.', null, null, null, correlationId);
-
-			return this._success(correlationId);
-		}
-		catch(err) {
-			if (err.code && err.code === 'auth/user-not-found') {
-				this._logger.warn('FirebaseAuthAdminService', 'deleteUser', 'user not found', err, correlationId);
-				return this._error('FirebaseAuthAdminService', 'deleteUser', 'user-not-found', err, correlationId);
-			}
-			this._logger.exception('FirebaseAuthAdminService', 'deleteUser', err, correlationId);
-		}
-
-		return this._error('FirebaseAuthAdminService', 'deleteUser', null, null, null, correlationId);
-	}
-
-	async getUser(correlationId, uid) {
-		try {
-			if (String.isNullOrEmpty(uid))
-				return null;
-
-			const user = await admin.auth().getUser(uid);
-			if (!user)
-				return null;
-
-			return this._convert(user);
-		}
-		catch(err) {
-			this._logger.exception('FirebaseAuthAdminService', 'getUser', err, correlationId);
-		}
-
-		return null
-	}
-
-	async setClaims(correlationId, uid, claims, replace) {
-		try {
-			this._enforceNotEmpty('FirebaseAuthAdminService', 'deleteUser', uid, 'uid', correlationId);
-
-			// Lookup the user associated with the specified uid.
-			const user = await admin.auth().getUser(uid);
-			if (!user)
-				return this._error('FirebaseAuthAdminService', 'deleteUser', 'Unable to get user', null, null, null, correlationId);
-
-			let updatedClaims = claims ? { ...claims } : null;
-			if (!replace) {
-				const customClaims = user.customClaims;
-				// merge new claims into existing
-				updatedClaims = { ...customClaims, ...claims };
-			}
-
-			// The new custom claims will propagate to the user's ID token the
-			// next time a new one is issued.
-			await admin.auth().setCustomUserClaims(uid, updatedClaims);
-
-			return this._success(correlationId);
-		}
-		catch(err) {
-			this._logger.exception('FirebaseAuthAdminService', 'setClaims', err, correlationId);
-			return this._error('FirebaseAuthAdminService', 'setClaims', err, null, null, null, correlationId);
-		}
-	}
-
-	async verifyToken(correlationId, token) {
-		try {
-			const results = {
-				user: null,
-				claims: null,
-				success: false
-			}
-
-			if (String.isNullOrEmpty(token))
-				return results;
-
-			const decodedToken = await admin.auth().verifyIdToken(token);
-			if (!decodedToken)
-				return results;
-
-			this._logger.debug('FirebaseAuthAdminService', 'verifyToken', 'decodedToken', decodedToken, correlationId);
-
-			const uid = decodedToken.uid;
-			if (!uid)
-				return results;
-
-			// Getting user from database, which has the claims already, plus plan, etc.
-			// Lookup the user associated with the specified uid.
-			// const user = await admin.auth().getUser(uid);
-			// const claims = user.customClaims;
-
-			const userResponse = await this._serviceUsers.fetchByExternalId(correlationId, uid);
-			if (this._hasFailed(userResponse) || (this._hasSucceeded(userResponse) && !userResponse.results)) {
-				const userUpdateResponse = this._serviceUsers.update(correlationId, {
-					id: uid
-				});
-				if (this._hasFailed(userUpdateResponse) || (this._hasSucceeded(userUpdateResponse) && !userUpdateResponse.results))
-					return results;
-			}
-
-			results.user = userResponse.results;
-
-			results.claims = userResponse.results.claims;
-			const configAuth = this._config.get('auth');
-			if (configAuth.claims && configAuth.claims.useDefault && !results.claims)
-				results.claims = [ this._defaultClaims() ];
-
-			results.success = true;
-			return results;
-		}
-		catch(err) {
-			this._logger.exception('FirebaseAuthAdminService', 'verifyToken', err, correlationId);
-			if (err.code === "auth/id-token-expired")
-				throw new TokenExpiredError();
-		}
-
-		return null;
-	}
-
-	_convert(requestedUser) {
-		if (!requestedUser)
-			return null;
-
-		const user = {};
-		user.id = requestedUser.uid;
-		user.name = requestedUser.displayName;
-		user.picture = requestedUser.photoURL;
-		user.email = requestedUser.email;
-		return user;
-	}
-
-	_defaultClaims() {
-		throw new NotImplementedError();
-	}
-
-	_initConfig() {
-		const filePath = path.join(process.cwd(), 'config', 'serviceAccountKey.json');
-		const file = fs.readFileSync(filePath, 'utf8');
-		if (String.isNullOrEmpty(file))
-			throw Error('Invalid serviceAccountKey.json configuration file for Firebase; expected in the <app root>/config folder.');
-
-		const config = JSON.parse(file);
-		if (!config)
-			throw Error('Invalid serviceAccountKey.json file for Firebase config.');
-
-		return config;
-	}
-}
-
-export default FirebaseAuthAdminService;
+import fs from 'fs';
+import path from 'path';
+
+import { Mutex as asyncMutex } from 'async-mutex';
+
+import admin from 'firebase-admin';
+
+import LibraryServerConstants from '@thzero/library_server/constants.js';
+
+import LibraryMomentUtility from '@thzero/library_common/utility/moment.js';
+
+import NotImplementedError from '@thzero/library_common/errors/notImplemented.js';
+
+import Service from '@thzero/library_server/service/index.js';
+
+import TokenExpiredError from '@thzero/library_server/errors/tokenExpired.js';
+
+class FirebaseAuthAdminService extends Service {
+	constructor() {
+		super();
+
+		this._cacheTokens = new Map();
+		this._cacheTokensTtlDefault = 5 * 60 * 1000;
+		this._mutexCache = new asyncMutex();
+
+		this._serviceUsers = null;
+	}
+
+	async init(injector) {
+		await super.init(injector);
+
+		let serviceAccount = process.env.SERVICE_ACCOUNT_KEY;
+		if (serviceAccount)
+			serviceAccount = JSON.parse(serviceAccount);
+		if (!serviceAccount)
+			serviceAccount = this._initConfig();
+		admin.initializeApp({
+			credential: admin.credential.cert(serviceAccount),
+			databaseURL: serviceAccount.database_url
+		});
+
+		this._serviceUsers  = this._injector.getService(LibraryServerConstants.InjectorKeys.SERVICE_USERS);
+	}
+
+	async deleteUser(correlationId, uid) {
+		try {
+			if (String.isNullOrEmpty(uid))
+				return null;
+
+			const user = await admin.auth().getUser(uid);
+			if (!user)
+				return null;
+
+			const results = await admin.auth().deleteUser(uid);
+			if (!results)
+				return this._error('FirebaseAuthAdminService', 'deleteUser', 'Unable to delete user.', null, null, null, correlationId);
+
+			return this._success(correlationId);
+		}
+		catch(err) {
+			if (err.code && err.code === 'auth/user-not-found') {
+				this._logger.warn('FirebaseAuthAdminService', 'deleteUser', 'user not found', err, correlationId);
+				return this._error('FirebaseAuthAdminService', 'deleteUser', 'user-not-found', err, correlationId);
+			}
+			this._logger.exception('FirebaseAuthAdminService', 'deleteUser', err, correlationId);
+		}
+
+		return this._error('FirebaseAuthAdminService', 'deleteUser', null, null, null, correlationId);
+	}
+
+	async getUser(correlationId, uid) {
+		try {
+			if (String.isNullOrEmpty(uid))
+				return null;
+
+			const user = await admin.auth().getUser(uid);
+			if (!user)
+				return null;
+
+			return this._convert(user);
+		}
+		catch(err) {
+			this._logger.exception('FirebaseAuthAdminService', 'getUser', err, correlationId);
+		}
+
+		return null
+	}
+
+	async setClaims(correlationId, uid, claims, replace) {
+		try {
+			this._enforceNotEmpty('FirebaseAuthAdminService', 'deleteUser', uid, 'uid', correlationId);
+
+			// Lookup the user associated with the specified uid.
+			const user = await admin.auth().getUser(uid);
+			if (!user)
+				return this._error('FirebaseAuthAdminService', 'deleteUser', 'Unable to get user', null, null, null, correlationId);
+
+			let updatedClaims = claims ? { ...claims } : null;
+			if (!replace) {
+				const customClaims = user.customClaims;
+				// merge new claims into existing
+				updatedClaims = { ...customClaims, ...claims };
+			}
+
+			// The new custom claims will propagate to the user's ID token the
+			// next time a new one is issued.
+			await admin.auth().setCustomUserClaims(uid, updatedClaims);
+
+			return this._success(correlationId);
+		}
+		catch(err) {
+			this._logger.exception('FirebaseAuthAdminService', 'setClaims', err, correlationId);
+			return this._error('FirebaseAuthAdminService', 'setClaims', err, null, null, null, correlationId);
+		}
+	}
+
+	async verifyToken(correlationId, token) {
+		try {
+			const results = {
+				user: null,
+				claims: null,
+				success: false
+			}
+
+			if (String.isNullOrEmpty(token))
+				return results;
+
+			if (this._cacheTokens.has(token)) {
+				// https://firebase.google.com/docs/auth/admin/manage-sessions
+				// firebase tokens are valid for an hour
+				// buffering...
+				const release = await this._mutexCache.acquire();
+				try {
+					if (this._cacheTokens.has(token)) {
+						const data = this._cacheTokens.get(token);
+						if (data) {
+							const now = LibraryMomentUtility.getTimestamp();
+							const delta = now - data.time;
+							if (delta <= this._cacheTokensTtlDefault)
+								return data.results;
+	
+							this._cacheTokens.delete(token);
+						}
+					}
+				}
+				finally {
+					release();
+				}
+			}
+
+			const decodedToken = await admin.auth().verifyIdToken(token);
+			if (!decodedToken)
+				return results;
+
+			this._logger.debug('FirebaseAuthAdminService', 'verifyToken', 'decodedToken', decodedToken, correlationId);
+
+			const uid = decodedToken.uid;
+			if (!uid)
+				return results;
+
+			// Getting user from database, which has the claims already, plus plan, etc.
+			// Lookup the user associated with the specified uid.
+			// const user = await admin.auth().getUser(uid);
+			// const claims = user.customClaims;
+
+			const userResponse = await this._serviceUsers.fetchByExternalId(correlationId, uid);
+			if (this._hasFailed(userResponse) || (this._hasSucceeded(userResponse) && !userResponse.results)) {
+				const userUpdateResponse = this._serviceUsers.update(correlationId, {
+					id: uid
+				});
+				if (this._hasFailed(userUpdateResponse) || (this._hasSucceeded(userUpdateResponse) && !userUpdateResponse.results))
+					return results;
+			}
+
+			results.user = userResponse.results;
+
+			results.claims = userResponse.results.claims;
+			const configAuth = this._config.get('auth');
+			if (configAuth.claims && configAuth.claims.useDefault && !results.claims)
+				results.claims = [ this._defaultClaims() ];
+
+			this._cacheTokens.set(token, { time: LibraryMomentUtility.getTimestamp(), results: results });
+			results.success = true;
+			return results;
+		}
+		catch(err) {
+			this._logger.exception('FirebaseAuthAdminService', 'verifyToken', err, correlationId);
+			if (err.code === "auth/id-token-expired")
+				throw new TokenExpiredError();
+		}
+
+		return null;
+	}
+
+	_convert(requestedUser) {
+		if (!requestedUser)
+			return null;
+
+		const user = {};
+		user.id = requestedUser.uid;
+		user.name = requestedUser.displayName;
+		user.picture = requestedUser.photoURL;
+		user.email = requestedUser.email;
+		return user;
+	}
+
+	_defaultClaims() {
+		throw new NotImplementedError();
+	}
+
+	_initConfig() {
+		const filePath = path.join(process.cwd(), 'config', 'serviceAccountKey.json');
+		const file = fs.readFileSync(filePath, 'utf8');
+		if (String.isNullOrEmpty(file))
+			throw Error('Invalid serviceAccountKey.json configuration file for Firebase; expected in the <app root>/config folder.');
+
+		const config = JSON.parse(file);
+		if (!config)
+			throw Error('Invalid serviceAccountKey.json file for Firebase config.');
+
+		return config;
+	}
+}
+
+export default FirebaseAuthAdminService;

package/license.md

@@ -1,9 +1,9 @@
-MIT License
-
-Copyright (c) 2020-2024 thZero.com
-
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
-
+MIT License
+
+Copyright (c) 2020-2024 thZero.com
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
 THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/messaging/index.js

@@ -1,31 +1,31 @@
-import admin from 'firebase-admin';
-
-import Service from '@thzero/library_server/service/index.js';
-
-class FirebaseMessagingService extends Service {
-	constructor() {
-		super();
-
-		this.registrationToken = null;
-	}
-
-	async setMessage(correlationId, data) {
-		try {
-			var message = {
-				data: data,
-				token: this.registrationToken
-			};
-
-			// Send a message to the device corresponding to the provided registration token.
-			const response = await admin.messaging().send(message);
-			this._logger.debug('FirebaseMessagingService', 'setMessage', 'Successfully sent message', response, correlationId);
-		}
-		catch (err) {
-			this._logger.exception('FirebaseMessagingService', 'setMessage', err, correlationId);
-		}
-
-		return null
-	}
-}
-
-export default FirebaseMessagingService;
+import admin from 'firebase-admin';
+
+import Service from '@thzero/library_server/service/index.js';
+
+class FirebaseMessagingService extends Service {
+	constructor() {
+		super();
+
+		this.registrationToken = null;
+	}
+
+	async setMessage(correlationId, data) {
+		try {
+			var message = {
+				data: data,
+				token: this.registrationToken
+			};
+
+			// Send a message to the device corresponding to the provided registration token.
+			const response = await admin.messaging().send(message);
+			this._logger.debug('FirebaseMessagingService', 'setMessage', 'Successfully sent message', response, correlationId);
+		}
+		catch (err) {
+			this._logger.exception('FirebaseMessagingService', 'setMessage', err, correlationId);
+		}
+
+		return null
+	}
+}
+
+export default FirebaseMessagingService;

package/openSource.js

@@ -1,32 +1,32 @@
-export default () => {
-    return [
-        {
-            category: 'server',
-            name: '@thzero/library_common',
-            url: 'https://github.com/thzero/library_common',
-            licenseName: 'MIT',
-            licenseUrl: 'https://github.com/thzero/library_common/blob/master/license.md'
-        },
-        {
-            category: 'server',
-            name: '@thzero/library_common_service',
-            url: 'https://github.com/thzero/library_common_service',
-            licenseName: 'MIT',
-            licenseUrl: 'https://github.com/thzero/library_common_service/blob/master/license.md'
-        },
-        {
-            category: 'server',
-            name: '@thzero/library_service',
-            url: 'https://github.com/thzero/library_service',
-            licenseName: 'MIT',
-            licenseUrl: 'https://github.com/thzero/library_service/blob/master/license.md'
-        },
-		{
-			category: 'server',
-			name: '@thzero/library_server_firebase',
-			url: 'https://github.com/thzero/library_server_firebase',
-			licenseName: 'MIT',
-			licenseUrl: 'https://github.com/thzero/library_server_firebase/blob/master/license.md'
-		}
-    ];
+export default () => {
+    return [
+        {
+            category: 'server',
+            name: '@thzero/library_common',
+            url: 'https://github.com/thzero/library_common',
+            licenseName: 'MIT',
+            licenseUrl: 'https://github.com/thzero/library_common/blob/master/license.md'
+        },
+        {
+            category: 'server',
+            name: '@thzero/library_common_service',
+            url: 'https://github.com/thzero/library_common_service',
+            licenseName: 'MIT',
+            licenseUrl: 'https://github.com/thzero/library_common_service/blob/master/license.md'
+        },
+        {
+            category: 'server',
+            name: '@thzero/library_service',
+            url: 'https://github.com/thzero/library_service',
+            licenseName: 'MIT',
+            licenseUrl: 'https://github.com/thzero/library_service/blob/master/license.md'
+        },
+		{
+			category: 'server',
+			name: '@thzero/library_server_firebase',
+			url: 'https://github.com/thzero/library_server_firebase',
+			licenseName: 'MIT',
+			licenseUrl: 'https://github.com/thzero/library_server_firebase/blob/master/license.md'
+		}
+    ];
 }

package/package.json

@@ -1,34 +1,34 @@
-{
-  "name": "@thzero/library_server_firebase",
-  "type": "module",
-  "version": "0.18.11",
-  "version_major": 0,
-  "version_minor": 18,
-  "version_patch": 11,
-  "version_date": "02/09/2025",
-  "author": "thZero",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/thzero/library_server_firebase.git"
-  },
-  "bugs": {
-    "url": "https://github.com/thzero/library_server_firebase/issues"
-  },
-  "homepage": "https://github.com/thzero/library_server_firebase#readme",
-  "engines": {
-    "node": ">=12.8.3"
-  },
-  "scripts": {
-    "cli-update": "library-cli --updateversion --pi",
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "dependencies": {
-    "firebase-admin": "^13.1.0"
-  },
-  "peerDependencies": {
-    "@thzero/library_common": "^0.18",
-    "@thzero/library_common_service": "^0.18",
-    "@thzero/library_server": "^0.18"
-  }
+{
+  "name": "@thzero/library_server_firebase",
+  "type": "module",
+  "version": "0.18.14",
+  "version_major": 0,
+  "version_minor": 18,
+  "version_patch": 14,
+  "version_date": "06/22/2025",
+  "author": "thZero",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/thzero/library_server_firebase.git"
+  },
+  "bugs": {
+    "url": "https://github.com/thzero/library_server_firebase/issues"
+  },
+  "homepage": "https://github.com/thzero/library_server_firebase#readme",
+  "engines": {
+    "node": ">=12.8.3"
+  },
+  "scripts": {
+    "cli-update": "library-cli --updateversion --pi",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "dependencies": {
+    "firebase-admin": "^13.4.0"
+  },
+  "peerDependencies": {
+    "@thzero/library_common": "^0.18",
+    "@thzero/library_common_service": "^0.18",
+    "@thzero/library_server": "^0.18"
+  }
 }