initial commit
This commit is contained in:
442
server/node_modules/firebase-admin/lib/messaging/messaging.js
generated
vendored
Normal file
442
server/node_modules/firebase-admin/lib/messaging/messaging.js
generated
vendored
Normal file
@@ -0,0 +1,442 @@
|
||||
/*! firebase-admin v13.5.0 */
|
||||
"use strict";
|
||||
/*!
|
||||
* @license
|
||||
* Copyright 2017 Google Inc.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
Object.defineProperty(exports, "__esModule", { value: true });
|
||||
exports.Messaging = void 0;
|
||||
const deep_copy_1 = require("../utils/deep-copy");
|
||||
const error_1 = require("../utils/error");
|
||||
const utils = require("../utils");
|
||||
const validator = require("../utils/validator");
|
||||
const messaging_internal_1 = require("./messaging-internal");
|
||||
const messaging_api_request_internal_1 = require("./messaging-api-request-internal");
|
||||
const api_request_1 = require("../utils/api-request");
|
||||
// FCM endpoints
|
||||
const FCM_SEND_HOST = 'fcm.googleapis.com';
|
||||
const FCM_TOPIC_MANAGEMENT_HOST = 'iid.googleapis.com';
|
||||
const FCM_TOPIC_MANAGEMENT_ADD_PATH = '/iid/v1:batchAdd';
|
||||
const FCM_TOPIC_MANAGEMENT_REMOVE_PATH = '/iid/v1:batchRemove';
|
||||
// Maximum messages that can be included in a batch request.
|
||||
const FCM_MAX_BATCH_SIZE = 500;
|
||||
/**
|
||||
* Maps a raw FCM server response to a `MessagingTopicManagementResponse` object.
|
||||
*
|
||||
* @param {object} response The raw FCM server response to map.
|
||||
*
|
||||
* @returns {MessagingTopicManagementResponse} The mapped `MessagingTopicManagementResponse` object.
|
||||
*/
|
||||
function mapRawResponseToTopicManagementResponse(response) {
|
||||
// Add the success and failure counts.
|
||||
const result = {
|
||||
successCount: 0,
|
||||
failureCount: 0,
|
||||
errors: [],
|
||||
};
|
||||
if ('results' in response) {
|
||||
response.results.forEach((tokenManagementResult, index) => {
|
||||
// Map the FCM server's error strings to actual error objects.
|
||||
if ('error' in tokenManagementResult) {
|
||||
result.failureCount += 1;
|
||||
const newError = error_1.FirebaseMessagingError.fromTopicManagementServerError(tokenManagementResult.error, /* message */ undefined, tokenManagementResult.error);
|
||||
result.errors.push({
|
||||
index,
|
||||
error: newError,
|
||||
});
|
||||
}
|
||||
else {
|
||||
result.successCount += 1;
|
||||
}
|
||||
});
|
||||
}
|
||||
return result;
|
||||
}
|
||||
/**
|
||||
* Messaging service bound to the provided app.
|
||||
*/
|
||||
class Messaging {
|
||||
/**
|
||||
* @internal
|
||||
*/
|
||||
constructor(app) {
|
||||
this.useLegacyTransport = false;
|
||||
if (!validator.isNonNullObject(app) || !('options' in app)) {
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, 'First argument passed to admin.messaging() must be a valid Firebase app instance.');
|
||||
}
|
||||
this.appInternal = app;
|
||||
this.messagingRequestHandler = new messaging_api_request_internal_1.FirebaseMessagingRequestHandler(app);
|
||||
}
|
||||
/**
|
||||
* The {@link firebase-admin.app#App} associated with the current `Messaging` service
|
||||
* instance.
|
||||
*
|
||||
* @example
|
||||
* ```javascript
|
||||
* var app = messaging.app;
|
||||
* ```
|
||||
*/
|
||||
get app() {
|
||||
return this.appInternal;
|
||||
}
|
||||
/**
|
||||
* Enables the use of legacy HTTP/1.1 transport for `sendEach()` and `sendEachForMulticast()`.
|
||||
*
|
||||
* @example
|
||||
* ```javascript
|
||||
* const messaging = getMessaging(app);
|
||||
* messaging.enableLegacyTransport();
|
||||
* messaging.sendEach(messages);
|
||||
* ```
|
||||
*
|
||||
* @deprecated This will be removed when the HTTP/2 transport implementation reaches the same
|
||||
* stability as the legacy HTTP/1.1 implementation.
|
||||
*/
|
||||
enableLegacyHttpTransport() {
|
||||
this.useLegacyTransport = true;
|
||||
}
|
||||
/**
|
||||
* Sends the given message via FCM.
|
||||
*
|
||||
* @param message - The message payload.
|
||||
* @param dryRun - Whether to send the message in the dry-run
|
||||
* (validation only) mode.
|
||||
* @returns A promise fulfilled with a unique message ID
|
||||
* string after the message has been successfully handed off to the FCM
|
||||
* service for delivery.
|
||||
*/
|
||||
send(message, dryRun) {
|
||||
const copy = (0, deep_copy_1.deepCopy)(message);
|
||||
(0, messaging_internal_1.validateMessage)(copy);
|
||||
if (typeof dryRun !== 'undefined' && !validator.isBoolean(dryRun)) {
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, 'dryRun must be a boolean');
|
||||
}
|
||||
return this.getUrlPath()
|
||||
.then((urlPath) => {
|
||||
const request = { message: copy };
|
||||
if (dryRun) {
|
||||
request.validate_only = true;
|
||||
}
|
||||
return this.messagingRequestHandler.invokeRequestHandler(FCM_SEND_HOST, urlPath, request);
|
||||
})
|
||||
.then((response) => {
|
||||
return response.name;
|
||||
});
|
||||
}
|
||||
/**
|
||||
* Sends each message in the given array via Firebase Cloud Messaging.
|
||||
*
|
||||
* This method makes a single RPC call for each message
|
||||
* in the given array.
|
||||
*
|
||||
* The responses list obtained from the return value corresponds to the order of `messages`.
|
||||
* An error from this method or a `BatchResponse` with all failures indicates a total failure,
|
||||
* meaning that none of the messages in the list could be sent. Partial failures or no
|
||||
* failures are only indicated by a `BatchResponse` return value.
|
||||
*
|
||||
* @param messages - A non-empty array
|
||||
* containing up to 500 messages.
|
||||
* @param dryRun - Whether to send the messages in the dry-run
|
||||
* (validation only) mode.
|
||||
* @returns A Promise fulfilled with an object representing the result of the
|
||||
* send operation.
|
||||
*/
|
||||
sendEach(messages, dryRun) {
|
||||
if (validator.isArray(messages) && messages.constructor !== Array) {
|
||||
// In more recent JS specs, an array-like object might have a constructor that is not of
|
||||
// Array type. Our deepCopy() method doesn't handle them properly. Convert such objects to
|
||||
// a regular array here before calling deepCopy(). See issue #566 for details.
|
||||
messages = Array.from(messages);
|
||||
}
|
||||
const copy = (0, deep_copy_1.deepCopy)(messages);
|
||||
if (!validator.isNonEmptyArray(copy)) {
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, 'messages must be a non-empty array');
|
||||
}
|
||||
if (copy.length > FCM_MAX_BATCH_SIZE) {
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, `messages list must not contain more than ${FCM_MAX_BATCH_SIZE} items`);
|
||||
}
|
||||
if (typeof dryRun !== 'undefined' && !validator.isBoolean(dryRun)) {
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, 'dryRun must be a boolean');
|
||||
}
|
||||
const http2SessionHandler = this.useLegacyTransport ? undefined : new api_request_1.Http2SessionHandler(`https://${FCM_SEND_HOST}`);
|
||||
return this.getUrlPath()
|
||||
.then((urlPath) => {
|
||||
if (http2SessionHandler) {
|
||||
let sendResponsePromise;
|
||||
return new Promise((resolve, reject) => {
|
||||
// Start session listeners
|
||||
http2SessionHandler.invoke().catch((error) => {
|
||||
const pendingBatchResponse = sendResponsePromise ? sendResponsePromise.then(this.parseSendResponses) : undefined;
|
||||
reject(new error_1.FirebaseMessagingSessionError(error, undefined, pendingBatchResponse));
|
||||
});
|
||||
// Start making requests
|
||||
const requests = copy.map(async (message) => {
|
||||
(0, messaging_internal_1.validateMessage)(message);
|
||||
const request = { message };
|
||||
if (dryRun) {
|
||||
request.validate_only = true;
|
||||
}
|
||||
return this.messagingRequestHandler.invokeHttp2RequestHandlerForSendResponse(FCM_SEND_HOST, urlPath, request, http2SessionHandler);
|
||||
});
|
||||
// Resolve once all requests have completed
|
||||
sendResponsePromise = Promise.allSettled(requests);
|
||||
sendResponsePromise.then(resolve);
|
||||
});
|
||||
}
|
||||
else {
|
||||
const requests = copy.map(async (message) => {
|
||||
(0, messaging_internal_1.validateMessage)(message);
|
||||
const request = { message };
|
||||
if (dryRun) {
|
||||
request.validate_only = true;
|
||||
}
|
||||
return this.messagingRequestHandler.invokeHttpRequestHandlerForSendResponse(FCM_SEND_HOST, urlPath, request);
|
||||
});
|
||||
return Promise.allSettled(requests);
|
||||
}
|
||||
})
|
||||
.then(this.parseSendResponses)
|
||||
.finally(() => {
|
||||
http2SessionHandler?.close();
|
||||
});
|
||||
}
|
||||
parseSendResponses(results) {
|
||||
const responses = [];
|
||||
results.forEach(result => {
|
||||
if (result.status === 'fulfilled') {
|
||||
responses.push(result.value);
|
||||
}
|
||||
else { // rejected
|
||||
responses.push({ success: false, error: result.reason });
|
||||
}
|
||||
});
|
||||
const successCount = responses.filter((resp) => resp.success).length;
|
||||
return {
|
||||
responses,
|
||||
successCount,
|
||||
failureCount: responses.length - successCount,
|
||||
};
|
||||
}
|
||||
/**
|
||||
* Sends the given multicast message to all the FCM registration tokens
|
||||
* specified in it.
|
||||
*
|
||||
* This method uses the {@link Messaging.sendEach} API under the hood to send the given
|
||||
* message to all the target recipients. The responses list obtained from the
|
||||
* return value corresponds to the order of tokens in the `MulticastMessage`.
|
||||
* An error from this method or a `BatchResponse` with all failures indicates a total
|
||||
* failure, meaning that the messages in the list could be sent. Partial failures or
|
||||
* failures are only indicated by a `BatchResponse` return value.
|
||||
*
|
||||
* @param message - A multicast message
|
||||
* containing up to 500 tokens.
|
||||
* @param dryRun - Whether to send the message in the dry-run
|
||||
* (validation only) mode.
|
||||
* @returns A Promise fulfilled with an object representing the result of the
|
||||
* send operation.
|
||||
*/
|
||||
sendEachForMulticast(message, dryRun) {
|
||||
const copy = (0, deep_copy_1.deepCopy)(message);
|
||||
if (!validator.isNonNullObject(copy)) {
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, 'MulticastMessage must be a non-null object');
|
||||
}
|
||||
if (!validator.isNonEmptyArray(copy.tokens)) {
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, 'tokens must be a non-empty array');
|
||||
}
|
||||
if (copy.tokens.length > FCM_MAX_BATCH_SIZE) {
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, `tokens list must not contain more than ${FCM_MAX_BATCH_SIZE} items`);
|
||||
}
|
||||
const messages = copy.tokens.map((token) => {
|
||||
return {
|
||||
token,
|
||||
android: copy.android,
|
||||
apns: copy.apns,
|
||||
data: copy.data,
|
||||
notification: copy.notification,
|
||||
webpush: copy.webpush,
|
||||
fcmOptions: copy.fcmOptions,
|
||||
};
|
||||
});
|
||||
return this.sendEach(messages, dryRun);
|
||||
}
|
||||
/**
|
||||
* Subscribes a device to an FCM topic.
|
||||
*
|
||||
* See {@link https://firebase.google.com/docs/cloud-messaging/manage-topics#suscribe_and_unsubscribe_using_the |
|
||||
* Subscribe to a topic}
|
||||
* for code samples and detailed documentation. Optionally, you can provide an
|
||||
* array of tokens to subscribe multiple devices.
|
||||
*
|
||||
* @param registrationTokens - A token or array of registration tokens
|
||||
* for the devices to subscribe to the topic.
|
||||
* @param topic - The topic to which to subscribe.
|
||||
*
|
||||
* @returns A promise fulfilled with the server's response after the device has been
|
||||
* subscribed to the topic.
|
||||
*/
|
||||
subscribeToTopic(registrationTokenOrTokens, topic) {
|
||||
return this.sendTopicManagementRequest(registrationTokenOrTokens, topic, 'subscribeToTopic', FCM_TOPIC_MANAGEMENT_ADD_PATH);
|
||||
}
|
||||
/**
|
||||
* Unsubscribes a device from an FCM topic.
|
||||
*
|
||||
* See {@link https://firebase.google.com/docs/cloud-messaging/admin/manage-topic-subscriptions#unsubscribe_from_a_topic |
|
||||
* Unsubscribe from a topic}
|
||||
* for code samples and detailed documentation. Optionally, you can provide an
|
||||
* array of tokens to unsubscribe multiple devices.
|
||||
*
|
||||
* @param registrationTokens - A device registration token or an array of
|
||||
* device registration tokens to unsubscribe from the topic.
|
||||
* @param topic - The topic from which to unsubscribe.
|
||||
*
|
||||
* @returns A promise fulfilled with the server's response after the device has been
|
||||
* unsubscribed from the topic.
|
||||
*/
|
||||
unsubscribeFromTopic(registrationTokenOrTokens, topic) {
|
||||
return this.sendTopicManagementRequest(registrationTokenOrTokens, topic, 'unsubscribeFromTopic', FCM_TOPIC_MANAGEMENT_REMOVE_PATH);
|
||||
}
|
||||
getUrlPath() {
|
||||
if (this.urlPath) {
|
||||
return Promise.resolve(this.urlPath);
|
||||
}
|
||||
return utils.findProjectId(this.app)
|
||||
.then((projectId) => {
|
||||
if (!validator.isNonEmptyString(projectId)) {
|
||||
// Assert for an explicit project ID (either via AppOptions or the cert itself).
|
||||
throw new error_1.FirebaseMessagingError(error_1.MessagingClientErrorCode.INVALID_ARGUMENT, 'Failed to determine project ID for Messaging. Initialize the '
|
||||
+ 'SDK with service account credentials or set project ID as an app option. '
|
||||
+ 'Alternatively set the GOOGLE_CLOUD_PROJECT environment variable.');
|
||||
}
|
||||
this.urlPath = `/v1/projects/${projectId}/messages:send`;
|
||||
return this.urlPath;
|
||||
});
|
||||
}
|
||||
/**
|
||||
* Helper method which sends and handles topic subscription management requests.
|
||||
*
|
||||
* @param registrationTokenOrTokens - The registration token or an array of
|
||||
* registration tokens to unsubscribe from the topic.
|
||||
* @param topic - The topic to which to subscribe.
|
||||
* @param methodName - The name of the original method called.
|
||||
* @param path - The endpoint path to use for the request.
|
||||
*
|
||||
* @returns A Promise fulfilled with the parsed server
|
||||
* response.
|
||||
*/
|
||||
sendTopicManagementRequest(registrationTokenOrTokens, topic, methodName, path) {
|
||||
this.validateRegistrationTokensType(registrationTokenOrTokens, methodName);
|
||||
this.validateTopicType(topic, methodName);
|
||||
// Prepend the topic with /topics/ if necessary.
|
||||
topic = this.normalizeTopic(topic);
|
||||
return Promise.resolve()
|
||||
.then(() => {
|
||||
// Validate the contents of the input arguments. Because we are now in a promise, any thrown
|
||||
// error will cause this method to return a rejected promise.
|
||||
this.validateRegistrationTokens(registrationTokenOrTokens, methodName);
|
||||
this.validateTopic(topic, methodName);
|
||||
// Ensure the registration token(s) input argument is an array.
|
||||
let registrationTokensArray = registrationTokenOrTokens;
|
||||
if (validator.isString(registrationTokenOrTokens)) {
|
||||
registrationTokensArray = [registrationTokenOrTokens];
|
||||
}
|
||||
const request = {
|
||||
to: topic,
|
||||
registration_tokens: registrationTokensArray,
|
||||
};
|
||||
return this.messagingRequestHandler.invokeRequestHandler(FCM_TOPIC_MANAGEMENT_HOST, path, request);
|
||||
})
|
||||
.then((response) => {
|
||||
return mapRawResponseToTopicManagementResponse(response);
|
||||
});
|
||||
}
|
||||
/**
|
||||
* Validates the type of the provided registration token(s). If invalid, an error will be thrown.
|
||||
*
|
||||
* @param registrationTokenOrTokens - The registration token(s) to validate.
|
||||
* @param method - The method name to use in error messages.
|
||||
* @param errorInfo - The error info to use if the registration tokens are invalid.
|
||||
*/
|
||||
validateRegistrationTokensType(registrationTokenOrTokens, methodName, errorInfo = error_1.MessagingClientErrorCode.INVALID_ARGUMENT) {
|
||||
if (!validator.isNonEmptyArray(registrationTokenOrTokens) &&
|
||||
!validator.isNonEmptyString(registrationTokenOrTokens)) {
|
||||
throw new error_1.FirebaseMessagingError(errorInfo, `Registration token(s) provided to ${methodName}() must be a non-empty string or a ` +
|
||||
'non-empty array.');
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Validates the provided registration tokens. If invalid, an error will be thrown.
|
||||
*
|
||||
* @param registrationTokenOrTokens - The registration token or an array of
|
||||
* registration tokens to validate.
|
||||
* @param method - The method name to use in error messages.
|
||||
* @param errorInfo - The error info to use if the registration tokens are invalid.
|
||||
*/
|
||||
validateRegistrationTokens(registrationTokenOrTokens, methodName, errorInfo = error_1.MessagingClientErrorCode.INVALID_ARGUMENT) {
|
||||
if (validator.isArray(registrationTokenOrTokens)) {
|
||||
// Validate the array contains no more than 1,000 registration tokens.
|
||||
if (registrationTokenOrTokens.length > 1000) {
|
||||
throw new error_1.FirebaseMessagingError(errorInfo, `Too many registration tokens provided in a single request to ${methodName}(). Batch ` +
|
||||
'your requests to contain no more than 1,000 registration tokens per request.');
|
||||
}
|
||||
// Validate the array contains registration tokens which are non-empty strings.
|
||||
registrationTokenOrTokens.forEach((registrationToken, index) => {
|
||||
if (!validator.isNonEmptyString(registrationToken)) {
|
||||
throw new error_1.FirebaseMessagingError(errorInfo, `Registration token provided to ${methodName}() at index ${index} must be a ` +
|
||||
'non-empty string.');
|
||||
}
|
||||
});
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Validates the type of the provided topic. If invalid, an error will be thrown.
|
||||
*
|
||||
* @param topic - The topic to validate.
|
||||
* @param method - The method name to use in error messages.
|
||||
* @param errorInfo - The error info to use if the topic is invalid.
|
||||
*/
|
||||
validateTopicType(topic, methodName, errorInfo = error_1.MessagingClientErrorCode.INVALID_ARGUMENT) {
|
||||
if (!validator.isNonEmptyString(topic)) {
|
||||
throw new error_1.FirebaseMessagingError(errorInfo, `Topic provided to ${methodName}() must be a string which matches the format ` +
|
||||
'"/topics/[a-zA-Z0-9-_.~%]+".');
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Validates the provided topic. If invalid, an error will be thrown.
|
||||
*
|
||||
* @param topic - The topic to validate.
|
||||
* @param method - The method name to use in error messages.
|
||||
* @param errorInfo - The error info to use if the topic is invalid.
|
||||
*/
|
||||
validateTopic(topic, methodName, errorInfo = error_1.MessagingClientErrorCode.INVALID_ARGUMENT) {
|
||||
if (!validator.isTopic(topic)) {
|
||||
throw new error_1.FirebaseMessagingError(errorInfo, `Topic provided to ${methodName}() must be a string which matches the format ` +
|
||||
'"/topics/[a-zA-Z0-9-_.~%]+".');
|
||||
}
|
||||
}
|
||||
/**
|
||||
* Normalizes the provided topic name by prepending it with '/topics/', if necessary.
|
||||
*
|
||||
* @param topic - The topic name to normalize.
|
||||
*
|
||||
* @returns The normalized topic name.
|
||||
*/
|
||||
normalizeTopic(topic) {
|
||||
if (!/^\/topics\//.test(topic)) {
|
||||
topic = `/topics/${topic}`;
|
||||
}
|
||||
return topic;
|
||||
}
|
||||
}
|
||||
exports.Messaging = Messaging;
|
||||
Reference in New Issue
Block a user