@@ -35,79 +35,40 @@ import {
3535} from '@firebase/util' ;
3636
3737import { Token } from '../../api/credentials' ;
38- import { DatabaseId , DatabaseInfo } from '../../core/database_info' ;
39- import { SDK_VERSION } from '../../core/version' ;
40- import { Connection , Stream } from '../../remote/connection' ;
38+ import { DatabaseInfo } from '../../core/database_info' ;
39+ import { Stream } from '../../remote/connection' ;
4140import {
4241 mapCodeFromRpcStatus ,
4342 mapCodeFromHttpResponseErrorStatus
4443} from '../../remote/rpc_error' ;
4544import { StreamBridge } from '../../remote/stream_bridge' ;
46- import { debugAssert , fail , hardAssert } from '../../util/assert' ;
45+ import { fail , hardAssert } from '../../util/assert' ;
4746import { Code , FirestoreError } from '../../util/error' ;
4847import { logDebug , logWarn } from '../../util/log' ;
49- import { Indexable } from '../../util/misc' ;
5048import { Rejecter , Resolver } from '../../util/promise' ;
5149import { StringMap } from '../../util/types' ;
50+ import { RestConnection } from '../../remote/rest_connection' ;
5251
5352const LOG_TAG = 'Connection' ;
5453
5554const RPC_STREAM_SERVICE = 'google.firestore.v1.Firestore' ;
56- const RPC_URL_VERSION = 'v1' ;
57-
58- /**
59- * Maps RPC names to the corresponding REST endpoint name.
60- * Uses Object Literal notation to avoid renaming.
61- */
62- const RPC_NAME_REST_MAPPING : { [ key : string ] : string } = { } ;
63- RPC_NAME_REST_MAPPING [ 'BatchGetDocuments' ] = 'batchGet' ;
64- RPC_NAME_REST_MAPPING [ 'Commit' ] = 'commit' ;
65- RPC_NAME_REST_MAPPING [ 'RunQuery' ] = 'runQuery' ;
66-
67- // TODO(b/38203344): The SDK_VERSION is set independently from Firebase because
68- // we are doing out-of-band releases. Once we release as part of Firebase, we
69- // should use the Firebase version instead.
70- const X_GOOG_API_CLIENT_VALUE = 'gl-js/ fire/' + SDK_VERSION ;
7155
7256const XHR_TIMEOUT_SECS = 15 ;
7357
74- export class WebChannelConnection implements Connection {
75- private readonly databaseId : DatabaseId ;
76- private readonly baseUrl : string ;
58+ export class WebChannelConnection extends RestConnection {
7759 private readonly forceLongPolling : boolean ;
7860
7961 constructor ( info : DatabaseInfo ) {
80- this . databaseId = info . databaseId ;
81- const proto = info . ssl ? 'https' : 'http' ;
82- this . baseUrl = proto + '://' + info . host ;
62+ super ( info ) ;
8363 this . forceLongPolling = info . forceLongPolling ;
8464 }
8565
86- /**
87- * Modifies the headers for a request, adding any authorization token if
88- * present and any additional headers for the request.
89- */
90- private modifyHeadersForRequest (
91- headers : StringMap ,
92- token : Token | null
93- ) : void {
94- if ( token ) {
95- for ( const header in token . authHeaders ) {
96- if ( token . authHeaders . hasOwnProperty ( header ) ) {
97- headers [ header ] = token . authHeaders [ header ] ;
98- }
99- }
100- }
101- headers [ 'X-Goog-Api-Client' ] = X_GOOG_API_CLIENT_VALUE ;
102- }
103-
104- invokeRPC < Req , Resp > (
66+ protected performRPCRequest < Req , Resp > (
10567 rpcName : string ,
106- request : Req ,
107- token : Token | null
68+ url : string ,
69+ headers : StringMap ,
70+ body : Req
10871 ) : Promise < Resp > {
109- const url = this . makeUrl ( rpcName ) ;
110-
11172 return new Promise ( ( resolve : Resolver < Resp > , reject : Rejecter ) => {
11273 const xhr = new XhrIo ( ) ;
11374 xhr . listenOnce ( EventType . COMPLETE , ( ) => {
@@ -161,7 +122,6 @@ export class WebChannelConnection implements Connection {
161122 } else {
162123 // If we received an HTTP_ERROR but there's no status code,
163124 // it's most probably a connection issue
164- logDebug ( LOG_TAG , 'RPC "' + rpcName + '" failed' ) ;
165125 reject (
166126 new FirestoreError ( Code . UNAVAILABLE , 'Connection failed.' )
167127 ) ;
@@ -184,37 +144,11 @@ export class WebChannelConnection implements Connection {
184144 }
185145 } ) ;
186146
187- // The database field is already encoded in URL. Specifying it again in
188- // the body is not necessary in production, and will cause duplicate field
189- // errors in the Firestore Emulator. Let's remove it.
190- const jsonObj = ( { ...request } as unknown ) as Indexable ;
191- delete jsonObj . database ;
192-
193- const requestString = JSON . stringify ( jsonObj ) ;
194- logDebug ( LOG_TAG , 'XHR sending: ' , url + ' ' + requestString ) ;
195- // Content-Type: text/plain will avoid preflight requests which might
196- // mess with CORS and redirects by proxies. If we add custom headers
197- // we will need to change this code to potentially use the
198- // $httpOverwrite parameter supported by ESF to avoid
199- // triggering preflight requests.
200- const headers : StringMap = { 'Content-Type' : 'text/plain' } ;
201-
202- this . modifyHeadersForRequest ( headers , token ) ;
203-
147+ const requestString = JSON . stringify ( body ) ;
204148 xhr . send ( url , 'POST' , requestString , headers , XHR_TIMEOUT_SECS ) ;
205149 } ) ;
206150 }
207151
208- invokeStreamingRPC < Req , Resp > (
209- rpcName : string ,
210- request : Req ,
211- token : Token | null
212- ) : Promise < Resp [ ] > {
213- // The REST API automatically aggregates all of the streamed results, so we
214- // can just use the normal invoke() method.
215- return this . invokeRPC < Req , Resp [ ] > ( rpcName , request , token ) ;
216- }
217-
218152 openStream < Req , Resp > (
219153 rpcName : string ,
220154 token : Token | null
@@ -283,7 +217,7 @@ export class WebChannelConnection implements Connection {
283217 }
284218
285219 const url = urlParts . join ( '' ) ;
286- logDebug ( LOG_TAG , 'Creating WebChannel: ' + url + ' ' + request ) ;
220+ logDebug ( LOG_TAG , 'Creating WebChannel: ' + url , request ) ;
287221 const channel = webchannelTransport . createWebChannel ( url , request ) ;
288222
289223 // WebChannel supports sending the first message with the handshake - saving
@@ -420,24 +354,4 @@ export class WebChannelConnection implements Connection {
420354 } , 0 ) ;
421355 return streamBridge ;
422356 }
423-
424- // visible for testing
425- makeUrl ( rpcName : string ) : string {
426- const urlRpcName = RPC_NAME_REST_MAPPING [ rpcName ] ;
427- debugAssert (
428- urlRpcName !== undefined ,
429- 'Unknown REST mapping for: ' + rpcName
430- ) ;
431- return (
432- this . baseUrl +
433- '/' +
434- RPC_URL_VERSION +
435- '/projects/' +
436- this . databaseId . projectId +
437- '/databases/' +
438- this . databaseId . database +
439- '/documents:' +
440- urlRpcName
441- ) ;
442- }
443357}
0 commit comments