Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: Resolving issues with multi-DB support #1864

Merged
merged 2 commits into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
16 changes: 16 additions & 0 deletions dev/src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,7 @@ import {
RECURSIVE_DELETE_MIN_PENDING_OPS,
RecursiveDelete,
} from './recursive-delete';
import {stringify} from 'querystring';

export {
CollectionReference,
Expand Down Expand Up @@ -590,6 +591,21 @@ export class Firestore implements firestore.Firestore {
}
}

// TODO (multi-db) Revert this override of gax.routingHeader.fromParams
// after a permanent fix is applied. See b/292075646
// This override of the routingHeader.fromParams does not
// encode forward slash characters. This is a temporary fix for b/291780066
gax.routingHeader.fromParams = params => {
return stringify(params, undefined, undefined, {
encodeURIComponent: (val: string) => {
return val
.split('/')
.map(component => encodeURIComponent(component))
.join('/');
},
});
};

if (this._settings.ssl === false) {
const grpcModule = this._settings.grpc ?? require('google-gax').grpc;
const sslCreds = grpcModule.credentials.createInsecure();
Expand Down
15 changes: 6 additions & 9 deletions dev/src/path.ts
Original file line number Diff line number Diff line change
Expand Up @@ -308,17 +308,14 @@ export class ResourcePath extends Path<ResourcePath> {
*
* @private
* @internal
* @param projectIdIfMissing The project ID of the current Firestore project.
* The project ID is only used if it's not provided as part of this
* ResourcePath.
* @param projectId The project ID of the current Firestore project.
* @return A fully-qualified resource path pointing to the same element.
*/
toQualifiedResourcePath(projectIdIfMissing: string): QualifiedResourcePath {
return new QualifiedResourcePath(
projectIdIfMissing,
DEFAULT_DATABASE_ID,
...this.segments
);
toQualifiedResourcePath(
projectId: string,
databaseId: string
): QualifiedResourcePath {
return new QualifiedResourcePath(projectId, databaseId, ...this.segments);
}
}

Expand Down
21 changes: 15 additions & 6 deletions dev/src/reference.ts
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,9 @@ export class DocumentReference<T = firestore.DocumentData>
*/
get formattedName(): string {
const projectId = this.firestore.projectId;
return this._path.toQualifiedResourcePath(projectId).formattedName;
const databaseId = this.firestore.databaseId;
return this._path.toQualifiedResourcePath(projectId, databaseId)
.formattedName;
}

/**
Expand Down Expand Up @@ -2328,8 +2330,11 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
transactionIdOrReadTime?: Uint8Array | Timestamp
): api.IRunQueryRequest {
const projectId = this.firestore.projectId;
const parentPath =
this._queryOptions.parentPath.toQualifiedResourcePath(projectId);
const databaseId = this.firestore.databaseId;
const parentPath = this._queryOptions.parentPath.toQualifiedResourcePath(
projectId,
databaseId
);

const structuredQuery = this.toStructuredQuery();

Expand Down Expand Up @@ -2387,8 +2392,11 @@ export class Query<T = firestore.DocumentData> implements firestore.Query<T> {
*/
_toBundledQuery(): protos.firestore.IBundledQuery {
const projectId = this.firestore.projectId;
const parentPath =
this._queryOptions.parentPath.toQualifiedResourcePath(projectId);
const databaseId = this.firestore.databaseId;
const parentPath = this._queryOptions.parentPath.toQualifiedResourcePath(
projectId,
databaseId
);
const structuredQuery = this.toStructuredQuery();

const bundledQuery: protos.firestore.IBundledQuery = {
Expand Down Expand Up @@ -2858,7 +2866,8 @@ export class CollectionReference<T = firestore.DocumentData>
const tag = requestTag();
return this.firestore.initializeIfNeeded(tag).then(() => {
const parentPath = this._queryOptions.parentPath.toQualifiedResourcePath(
this.firestore.projectId
this.firestore.projectId,
this.firestore.databaseId
);

const request: api.IListDocumentsRequest = {
Expand Down
8 changes: 7 additions & 1 deletion dev/system-test/firestore.ts
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,14 @@ if (process.env.NODE_ENV === 'DEBUG') {
}

function getTestRoot(settings: Settings = {}) {
const internalSettings: Settings = {};
if (process.env.FIRESTORE_NAMED_DATABASE) {
internalSettings.databaseId = process.env.FIRESTORE_NAMED_DATABASE;
}

const firestore = new Firestore({
...settings,
...internalSettings,
...settings, // caller settings take precedent over internal settings
});
return firestore.collection(`node_${version}_${autoId()}`);
}
Expand Down