Added util function

Author: maneesht

common/api-review/util.api.md

@@ -417,6 +417,11 @@ export interface Subscribe<T> {
     (observer: PartialObserver<T>): Unsubscribe;
 }
 
+// Warning: (ae-missing-release-tag) "timeoutResolve" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
+//
+// @public
+export function timeoutResolve<T>(promise: Promise<T>, timeInMS?: number): Promise<T>;
+
 // Warning: (ae-missing-release-tag) "Unsubscribe" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
 //
 // @public (undocumented)

packages/database-compat/test/query.test.ts

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+import { timeoutResolve } from '@firebase/util';
 import { expect, use } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 import * as _ from 'lodash';
@@ -29,7 +30,7 @@ import {
 } from '../../database/test/helpers/EventAccumulator';
 import { DataSnapshot, Query, Reference } from '../src/api/Reference';
 
-import { getFreshRepo, getPath, getRandomNode, pause, timeoutResolve } from './helpers/util';
+import { getFreshRepo, getPath, getRandomNode, pause } from './helpers/util';
 
 use(chaiAsPromised);
 

packages/database/test/exp/integration.test.ts

@@ -17,7 +17,7 @@
 
 // eslint-disable-next-line import/no-extraneous-dependencies
 import { initializeApp, deleteApp } from '@firebase/app';
-import { Deferred } from '@firebase/util';
+import { Deferred, timeoutResolve } from '@firebase/util';
 import { expect, use } from 'chai';
 import chaiAsPromised from 'chai-as-promised';
 
@@ -33,7 +33,7 @@ import {
   runTransaction
 } from '../../src/index';
 import { EventAccumulatorFactory } from '../helpers/EventAccumulator';
-import { DATABASE_ADDRESS, DATABASE_URL, timeoutResolve } from '../helpers/util';
+import { DATABASE_ADDRESS, DATABASE_URL } from '../helpers/util';
 
 use(chaiAsPromised);
 

packages/database/test/helpers/util.ts

@@ -15,8 +15,6 @@
  * limitations under the License.
  */
 
-import { Deferred } from '@firebase/util';
-
 import { ConnectionTarget } from '../../src/api/test_access';
 
 // eslint-disable-next-line @typescript-eslint/no-require-imports
@@ -72,11 +70,3 @@ export function shuffle(arr, randFn = Math.random) {
     arr[j] = tmp;
   }
 }
-
-export function timeoutResolve<T>(promise: Promise<T>, timeInMS = 2000) {
-  const deferredPromise = new Deferred<T>();
-  setTimeout(() => deferredPromise.reject('timeout!'), timeInMS);
-  promise.then(deferredPromise.resolve, deferredPromise.reject);
-  return deferredPromise.promise;
-}
-

packages/util/index.node.ts

@@ -31,6 +31,7 @@ export * from './src/errors';
 export * from './src/json';
 export * from './src/jwt';
 export * from './src/obj';
+export * from './src/promise';
 export * from './src/query';
 export * from './src/sha1';
 export * from './src/subscribe';

packages/util/index.ts

@@ -26,6 +26,7 @@ export * from './src/errors';
 export * from './src/json';
 export * from './src/jwt';
 export * from './src/obj';
+export * from './src/promise';
 export * from './src/query';
 export * from './src/sha1';
 export * from './src/subscribe';

packages/util/src/promise.ts

@@ -0,0 +1,29 @@
+/**
+ * @license
+ * Copyright 2022 Google LLC
+ *
+ * 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.
+ */
+
+import { Deferred } from "./deferred";
+
+/*
+    Rejects if the given promise doesn't resolve in timeInMS milliseconds.
+    @internal
+*/
+export function timeoutResolve<T>(promise: Promise<T>, timeInMS = 2000) {
+  const deferredPromise = new Deferred<T>();
+  setTimeout(() => deferredPromise.reject('timeout!'), timeInMS);
+  promise.then(deferredPromise.resolve, deferredPromise.reject);
+  return deferredPromise.promise;
+}