Skip to content

Commit 30624ae

Browse files
ehsannasehsannas
committed
Add "Auth" to class names where applicable.
1 parent 098bdd4 commit 30624ae

File tree

12 files changed

+48
-48
lines changed

12 files changed

+48
-48
lines changed

‎packages/firestore-compat/src/index.console.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ import {
2121
_DatabaseId,
2222
Firestore as FirestoreExp,
2323
FirestoreError,
24-
_EmptyCredentialsProvider,
24+
_EmptyAuthCredentialsProvider,
2525
_EmptyAppCheckTokenProvider
2626
} from '@firebase/firestore';
2727

@@ -92,7 +92,7 @@ export class Firestore extends FirestoreCompat {
9292
databaseIdFromFirestoreDatabase(firestoreDatabase),
9393
new FirestoreExp(
9494
databaseIdFromFirestoreDatabase(firestoreDatabase),
95-
new _EmptyCredentialsProvider(),
95+
new _EmptyAuthCredentialsProvider(),
9696
new _EmptyAppCheckTokenProvider()
9797
),
9898
new MemoryPersistenceProvider()

‎packages/firestore/lite/register.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { Component, ComponentType } from '@firebase/component';
2525
import { version } from '../package.json';
2626
import {
2727
LiteAppCheckTokenProvider,
28-
LiteCredentialsProvider
28+
LiteAuthCredentialsProvider
2929
} from '../src/api/credentials';
3030
import { setSDKVersion } from '../src/core/version';
3131
import { Firestore } from '../src/lite-api/database';
@@ -46,7 +46,7 @@ export function registerFirestore(): void {
4646
const app = container.getProvider('app').getImmediate()!;
4747
const firestoreInstance = new Firestore(
4848
app,
49-
new LiteCredentialsProvider(container.getProvider('auth-internal')),
49+
new LiteAuthCredentialsProvider(container.getProvider('auth-internal')),
5050
new LiteAppCheckTokenProvider(
5151
container.getProvider('app-check-internal')
5252
)

‎packages/firestore/src/api.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -156,5 +156,5 @@ export { FieldPath as _FieldPath } from './model/path';
156156
export type { ResourcePath as _ResourcePath } from './model/path';
157157
export type { ByteString as _ByteString } from './util/byte_string';
158158
export { logWarn as _logWarn } from './util/log';
159-
export { EmptyCredentialsProvider as _EmptyCredentialsProvider } from './api/credentials';
159+
export { EmptyAuthCredentialsProvider as _EmptyAuthCredentialsProvider } from './api/credentials';
160160
export { EmptyAppCheckTokenProvider as _EmptyAppCheckTokenProvider } from './api/credentials';

‎packages/firestore/src/api/credentials.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ export interface CredentialsProvider<T> {
122122
* A CredentialsProvider that always yields an empty token.
123123
* @internal
124124
*/
125-
export class EmptyCredentialsProvider implements CredentialsProvider<User> {
125+
export class EmptyAuthCredentialsProvider implements CredentialsProvider<User> {
126126
getToken(): Promise<Token | null> {
127127
return Promise.resolve<Token | null>(null);
128128
}
@@ -144,7 +144,7 @@ export class EmptyCredentialsProvider implements CredentialsProvider<User> {
144144
* A CredentialsProvider that always returns a constant token. Used for
145145
* emulator token mocking.
146146
*/
147-
export class EmulatorCredentialsProvider implements CredentialsProvider<User> {
147+
export class EmulatorAuthCredentialsProvider implements CredentialsProvider<User> {
148148
constructor(private token: Token) {}
149149

150150
/**
@@ -179,7 +179,7 @@ export class EmulatorCredentialsProvider implements CredentialsProvider<User> {
179179
}
180180

181181
/** Credential provider for the Lite SDK. */
182-
export class LiteCredentialsProvider implements CredentialsProvider<User> {
182+
export class LiteAuthCredentialsProvider implements CredentialsProvider<User> {
183183
private auth: FirebaseAuthInternal | null = null;
184184

185185
constructor(authProvider: Provider<FirebaseAuthInternalName>) {
@@ -219,7 +219,7 @@ export class LiteCredentialsProvider implements CredentialsProvider<User> {
219219
shutdown(): void {}
220220
}
221221

222-
export class FirebaseCredentialsProvider implements CredentialsProvider<User> {
222+
export class FirebaseAuthCredentialsProvider implements CredentialsProvider<User> {
223223
/**
224224
* The auth token listener registered with FirebaseApp, retained here so we
225225
* can unregister it.
@@ -280,7 +280,7 @@ export class FirebaseCredentialsProvider implements CredentialsProvider<User> {
280280
};
281281

282282
const registerAuth = (auth: FirebaseAuthInternal): void => {
283-
logDebug('FirebaseCredentialsProvider', 'Auth detected');
283+
logDebug('FirebaseAuthCredentialsProvider', 'Auth detected');
284284
this.auth = auth;
285285
this.auth.addAuthTokenListener(this.tokenListener);
286286
awaitNextToken();
@@ -298,7 +298,7 @@ export class FirebaseCredentialsProvider implements CredentialsProvider<User> {
298298
registerAuth(auth);
299299
} else {
300300
// If auth is still not available, proceed with `null` user
301-
logDebug('FirebaseCredentialsProvider', 'Auth not yet detected');
301+
logDebug('FirebaseAuthCredentialsProvider', 'Auth not yet detected');
302302
nextToken.resolve();
303303
nextToken = new Deferred<void>();
304304
}
@@ -311,7 +311,7 @@ export class FirebaseCredentialsProvider implements CredentialsProvider<User> {
311311
getToken(): Promise<Token | null> {
312312
debugAssert(
313313
this.tokenListener != null,
314-
'FirebaseCredentialsProvider not started.'
314+
'FirebaseAuthCredentialsProvider not started.'
315315
);
316316

317317
// Take note of the current value of the tokenCounter so that this method
@@ -331,7 +331,7 @@ export class FirebaseCredentialsProvider implements CredentialsProvider<User> {
331331
// user, we can't be sure).
332332
if (this.tokenCounter !== initialTokenCounter) {
333333
logDebug(
334-
'FirebaseCredentialsProvider',
334+
'FirebaseAuthCredentialsProvider',
335335
'getToken aborted due to token change.'
336336
);
337337
return this.getToken();
@@ -420,7 +420,7 @@ export class FirstPartyToken implements Token {
420420
* to authenticate the user, using technique that is only available
421421
* to applications hosted by Google.
422422
*/
423-
export class FirstPartyCredentialsProvider
423+
export class FirstPartyAuthCredentialsProvider
424424
implements CredentialsProvider<User>
425425
{
426426
constructor(
@@ -627,7 +627,7 @@ export function makeAuthCredentialsProvider(
627627
credentials?: CredentialsSettings
628628
): CredentialsProvider<User> {
629629
if (!credentials) {
630-
return new EmptyCredentialsProvider();
630+
return new EmptyAuthCredentialsProvider();
631631
}
632632

633633
switch (credentials['type']) {
@@ -643,7 +643,7 @@ export function makeAuthCredentialsProvider(
643643
),
644644
'unexpected gapi interface'
645645
);
646-
return new FirstPartyCredentialsProvider(
646+
return new FirstPartyAuthCredentialsProvider(
647647
client,
648648
credentials['sessionIndex'] || '0',
649649
credentials['iamToken'] || null

‎packages/firestore/src/lite-api/database.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ import { createMockUserToken, EmulatorMockTokenOptions } from '@firebase/util';
2626

2727
import {
2828
CredentialsProvider,
29-
EmulatorCredentialsProvider,
29+
EmulatorAuthCredentialsProvider,
3030
makeAuthCredentialsProvider,
3131
OAuthToken
3232
} from '../api/credentials';
@@ -275,7 +275,7 @@ export function connectFirestoreEmulator(
275275
user = new User(uid);
276276
}
277277

278-
firestore._authCredentials = new EmulatorCredentialsProvider(
278+
firestore._authCredentials = new EmulatorAuthCredentialsProvider(
279279
new OAuthToken(token, user)
280280
);
281281
}

‎packages/firestore/src/register.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ import { Component, ComponentType } from '@firebase/component';
2525
import { name, version } from '../package.json';
2626
import {
2727
FirebaseAppCheckTokenProvider,
28-
FirebaseCredentialsProvider
28+
FirebaseAuthCredentialsProvider
2929
} from '../src/api/credentials';
3030
import { setSDKVersion } from '../src/core/version';
3131

@@ -44,7 +44,7 @@ export function registerFirestore(
4444
const app = container.getProvider('app').getImmediate()!;
4545
const firestoreInstance = new Firestore(
4646
app,
47-
new FirebaseCredentialsProvider(
47+
new FirebaseAuthCredentialsProvider(
4848
container.getProvider('auth-internal')
4949
),
5050
new FirebaseAppCheckTokenProvider(

‎packages/firestore/test/integration/remote/stream.test.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
import { expect } from 'chai';
1919

20-
import { EmptyCredentialsProvider, Token } from '../../../src/api/credentials';
20+
import { EmptyAuthCredentialsProvider, Token } from '../../../src/api/credentials';
2121
import { SnapshotVersion } from '../../../src/core/snapshot_version';
2222
import { MutationResult } from '../../../src/model/mutation';
2323
import {
@@ -147,7 +147,7 @@ describe('Watch Stream', () => {
147147
});
148148
});
149149

150-
class MockCredentialsProvider extends EmptyCredentialsProvider {
150+
class MockAuthCredentialsProvider extends EmptyAuthCredentialsProvider {
151151
private states: string[] = [];
152152

153153
get observedStates(): string[] {
@@ -240,7 +240,7 @@ describe('Write Stream', () => {
240240
});
241241

242242
it('force refreshes auth token on receiving unauthenticated error', () => {
243-
const credentials = new MockCredentialsProvider();
243+
const credentials = new MockAuthCredentialsProvider();
244244

245245
return withTestWriteStream(async (writeStream, streamListener) => {
246246
await streamListener.awaitCallback('open');
@@ -275,7 +275,7 @@ describe('Write Stream', () => {
275275
});
276276

277277
it('token is not invalidated once the stream is healthy', () => {
278-
const credentials = new MockCredentialsProvider();
278+
const credentials = new MockAuthCredentialsProvider();
279279

280280
return withTestWriteStream(async (writeStream, streamListener, queue) => {
281281
await streamListener.awaitCallback('open');
@@ -298,7 +298,7 @@ export async function withTestWriteStream(
298298
streamListener: StreamStatusListener,
299299
queue: AsyncQueueImpl
300300
) => Promise<void>,
301-
credentialsProvider = new EmptyCredentialsProvider()
301+
credentialsProvider = new EmptyAuthCredentialsProvider()
302302
): Promise<void> {
303303
await withTestDatastore(async datastore => {
304304
const queue = newAsyncQueue() as AsyncQueueImpl;

‎packages/firestore/test/integration/util/internal_helpers.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ import {
2222
CredentialChangeListener,
2323
CredentialsProvider,
2424
EmptyAppCheckTokenProvider,
25-
EmptyCredentialsProvider
25+
EmptyAuthCredentialsProvider
2626
} from '../../../src/api/credentials';
2727
import { User } from '../../../src/auth/user';
2828
import { DatabaseId, DatabaseInfo } from '../../../src/core/database_info';
@@ -57,7 +57,7 @@ export function getDefaultDatabaseInfo(): DatabaseInfo {
5757

5858
export function withTestDatastore(
5959
fn: (datastore: Datastore) => Promise<void>,
60-
authCredentialsProvider: CredentialsProvider<User> = new EmptyCredentialsProvider(),
60+
authCredentialsProvider: CredentialsProvider<User> = new EmptyAuthCredentialsProvider(),
6161
appCheckTokenProvider: CredentialsProvider<string> = new EmptyAppCheckTokenProvider()
6262
): Promise<void> {
6363
const databaseInfo = getDefaultDatabaseInfo();
@@ -72,7 +72,7 @@ export function withTestDatastore(
7272
return fn(datastore);
7373
}
7474

75-
export class MockCredentialsProvider extends EmptyCredentialsProvider {
75+
export class MockAuthCredentialsProvider extends EmptyAuthCredentialsProvider {
7676
private listener: CredentialChangeListener<User> | null = null;
7777
private asyncQueue: AsyncQueue | null = null;
7878

@@ -94,10 +94,10 @@ export function withMockCredentialProviderTestDb(
9494
persistence: boolean,
9595
fn: (
9696
db: firestore.FirebaseFirestore,
97-
mockCredential: MockCredentialsProvider
97+
mockCredential: MockAuthCredentialsProvider
9898
) => Promise<void>
9999
): Promise<void> {
100-
const mockCredentialsProvider = new MockCredentialsProvider();
100+
const mockCredentialsProvider = new MockAuthCredentialsProvider();
101101
const settings = {
102102
...DEFAULT_SETTINGS,
103103
credentials: { client: mockCredentialsProvider, type: 'provider' }

‎packages/firestore/test/unit/api/database.test.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@
1717

1818
import { expect } from 'chai';
1919

20-
import { EmulatorCredentialsProvider } from '../../../src/api/credentials';
20+
import { EmulatorAuthCredentialsProvider } from '../../../src/api/credentials';
2121
import { User } from '../../../src/auth/user';
2222
import {
2323
collectionReference,
@@ -260,7 +260,7 @@ describe('Settings', () => {
260260
db.useEmulator('localhost', 9000, { mockUserToken });
261261

262262
const credentials = db._delegate._authCredentials;
263-
expect(credentials).to.be.instanceOf(EmulatorCredentialsProvider);
263+
expect(credentials).to.be.instanceOf(EmulatorAuthCredentialsProvider);
264264
const token = await credentials.getToken();
265265
expect(token!.type).to.eql('OAuth');
266266
expect(token!.user!.uid).to.eql(mockUserToken.sub);
@@ -274,7 +274,7 @@ describe('Settings', () => {
274274
});
275275

276276
const credentials = db._delegate._authCredentials;
277-
expect(credentials).to.be.instanceOf(EmulatorCredentialsProvider);
277+
expect(credentials).to.be.instanceOf(EmulatorAuthCredentialsProvider);
278278
const token = await credentials.getToken();
279279
expect(token!.type).to.eql('OAuth');
280280
expect(token!.user).to.eql(User.MOCK_USER);

‎packages/firestore/test/unit/remote/datastore.test.ts

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import * as chaiAsPromised from 'chai-as-promised';
2020

2121
import {
2222
EmptyAppCheckTokenProvider,
23-
EmptyCredentialsProvider,
23+
EmptyAuthCredentialsProvider,
2424
Token
2525
} from '../../../src/api/credentials';
2626
import { DatabaseId } from '../../../src/core/database_info';
@@ -67,7 +67,7 @@ describe('Datastore', () => {
6767
}
6868
}
6969

70-
class MockCredentialsProvider extends EmptyCredentialsProvider {
70+
class MockAuthCredentialsProvider extends EmptyAuthCredentialsProvider {
7171
invalidateTokenInvoked = false;
7272
invalidateToken(): void {
7373
this.invalidateTokenInvoked = true;
@@ -105,7 +105,7 @@ describe('Datastore', () => {
105105

106106
it('newDatastore() returns an an instance of Datastore', () => {
107107
const datastore = newDatastore(
108-
new EmptyCredentialsProvider(),
108+
new EmptyAuthCredentialsProvider(),
109109
new EmptyAppCheckTokenProvider(),
110110
new MockConnection(),
111111
serializer
@@ -115,7 +115,7 @@ describe('Datastore', () => {
115115

116116
it('DatastoreImpl.invokeRPC() fails if terminated', async () => {
117117
const datastore = newDatastore(
118-
new EmptyCredentialsProvider(),
118+
new EmptyAuthCredentialsProvider(),
119119
new EmptyAppCheckTokenProvider(),
120120
new MockConnection(),
121121
serializer
@@ -133,7 +133,7 @@ describe('Datastore', () => {
133133
const connection = new MockConnection();
134134
connection.invokeRPC = () =>
135135
Promise.reject(new FirestoreError(Code.ABORTED, 'zzyzx'));
136-
const authCredentials = new MockCredentialsProvider();
136+
const authCredentials = new MockAuthCredentialsProvider();
137137
const appCheckCredentials = new MockAppCheckTokenProvider();
138138
const datastore = newDatastore(
139139
authCredentials,
@@ -154,7 +154,7 @@ describe('Datastore', () => {
154154
it('DatastoreImpl.invokeRPC() wraps unknown exceptions in a FirestoreError', async () => {
155155
const connection = new MockConnection();
156156
connection.invokeRPC = () => Promise.reject('zzyzx');
157-
const authCredentials = new MockCredentialsProvider();
157+
const authCredentials = new MockAuthCredentialsProvider();
158158
const appCheckCredentials = new MockAppCheckTokenProvider();
159159
const datastore = newDatastore(
160160
authCredentials,
@@ -176,7 +176,7 @@ describe('Datastore', () => {
176176
const connection = new MockConnection();
177177
connection.invokeRPC = () =>
178178
Promise.reject(new FirestoreError(Code.UNAUTHENTICATED, 'zzyzx'));
179-
const authCredentials = new MockCredentialsProvider();
179+
const authCredentials = new MockAuthCredentialsProvider();
180180
const appCheckCredentials = new MockAppCheckTokenProvider();
181181
const datastore = newDatastore(
182182
authCredentials,
@@ -196,7 +196,7 @@ describe('Datastore', () => {
196196

197197
it('DatastoreImpl.invokeStreamingRPC() fails if terminated', async () => {
198198
const datastore = newDatastore(
199-
new EmptyCredentialsProvider(),
199+
new EmptyAuthCredentialsProvider(),
200200
new EmptyAppCheckTokenProvider(),
201201
new MockConnection(),
202202
serializer
@@ -214,7 +214,7 @@ describe('Datastore', () => {
214214
const connection = new MockConnection();
215215
connection.invokeStreamingRPC = () =>
216216
Promise.reject(new FirestoreError(Code.ABORTED, 'zzyzx'));
217-
const authCredentials = new MockCredentialsProvider();
217+
const authCredentials = new MockAuthCredentialsProvider();
218218
const appCheckCredentials = new MockAppCheckTokenProvider();
219219
const datastore = newDatastore(
220220
authCredentials,
@@ -235,7 +235,7 @@ describe('Datastore', () => {
235235
it('DatastoreImpl.invokeStreamingRPC() wraps unknown exceptions in a FirestoreError', async () => {
236236
const connection = new MockConnection();
237237
connection.invokeStreamingRPC = () => Promise.reject('zzyzx');
238-
const authCredentials = new MockCredentialsProvider();
238+
const authCredentials = new MockAuthCredentialsProvider();
239239
const appCheckCredentials = new MockAppCheckTokenProvider();
240240
const datastore = newDatastore(
241241
authCredentials,
@@ -257,7 +257,7 @@ describe('Datastore', () => {
257257
const connection = new MockConnection();
258258
connection.invokeStreamingRPC = () =>
259259
Promise.reject(new FirestoreError(Code.UNAUTHENTICATED, 'zzyzx'));
260-
const authCredentials = new MockCredentialsProvider();
260+
const authCredentials = new MockAuthCredentialsProvider();
261261
const appCheckCredentials = new MockAppCheckTokenProvider();
262262
const datastore = newDatastore(
263263
authCredentials,

0 commit comments

Comments
 (0)