-
Notifications
You must be signed in to change notification settings - Fork 899
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’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix error caused by undefined "trackedQuery" in QueryManager #8570
Changes from 4 commits
387bf8c
59d2e4f
6187271
e0a32a1
9bc852c
ed76645
a0ecb6f
d4de37a
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
--- | ||
'@firebase/data-connect': patch | ||
--- | ||
|
||
- Add check for non-query refType in `executeQuery` that throws error on refType mismatch | ||
- Add unit test to check that error is thrown when `executeQuery` receives non-query refType, and not thrown otherwise | ||
Original file line number | Diff line number | Diff line change | ||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
@@ -0,0 +1,94 @@ | ||||||||||||||||||
/** | ||||||||||||||||||
* @license | ||||||||||||||||||
* Copyright 2024 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 { initializeApp } from '@firebase/app'; | ||||||||||||||||||
import { FirebaseAuthTokenData } from '@firebase/auth-interop-types'; | ||||||||||||||||||
import { expect } from 'chai'; | ||||||||||||||||||
import * as chai from 'chai'; | ||||||||||||||||||
import chaiAsPromised from 'chai-as-promised'; | ||||||||||||||||||
|
||||||||||||||||||
import { | ||||||||||||||||||
DataConnectOptions, | ||||||||||||||||||
getDataConnect, | ||||||||||||||||||
MUTATION_STR, | ||||||||||||||||||
QUERY_STR, | ||||||||||||||||||
QueryRef | ||||||||||||||||||
} from '../../src'; | ||||||||||||||||||
import { Code, DataConnectError } from '../../src/core/error'; | ||||||||||||||||||
import { | ||||||||||||||||||
AuthTokenListener, | ||||||||||||||||||
AuthTokenProvider | ||||||||||||||||||
} from '../../src/core/FirebaseAuthProvider'; | ||||||||||||||||||
import { QueryManager } from '../../src/core/QueryManager'; | ||||||||||||||||||
import { RESTTransport } from '../../src/network/transport/rest'; | ||||||||||||||||||
chai.use(chaiAsPromised); | ||||||||||||||||||
const options: DataConnectOptions = { | ||||||||||||||||||
connector: 'c', | ||||||||||||||||||
location: 'l', | ||||||||||||||||||
projectId: 'p', | ||||||||||||||||||
service: 's' | ||||||||||||||||||
}; | ||||||||||||||||||
const INITIAL_TOKEN = 'initial token'; | ||||||||||||||||||
class FakeAuthProvider implements AuthTokenProvider { | ||||||||||||||||||
private token: string | null = INITIAL_TOKEN; | ||||||||||||||||||
addTokenChangeListener(listener: AuthTokenListener): void {} | ||||||||||||||||||
getToken(forceRefresh: boolean): Promise<FirebaseAuthTokenData | null> { | ||||||||||||||||||
if (!forceRefresh) { | ||||||||||||||||||
return Promise.resolve({ accessToken: this.token! }); | ||||||||||||||||||
} | ||||||||||||||||||
return Promise.resolve({ accessToken: 'testToken' }); | ||||||||||||||||||
} | ||||||||||||||||||
setToken(_token: string | null): void { | ||||||||||||||||||
this.token = _token; | ||||||||||||||||||
} | ||||||||||||||||||
} | ||||||||||||||||||
|
||||||||||||||||||
describe('Query Manager Tests', () => { | ||||||||||||||||||
it('should refuse to make requests to execute non-query operations', async () => { | ||||||||||||||||||
const authProvider = new FakeAuthProvider(); | ||||||||||||||||||
const rt = new RESTTransport(options, undefined, undefined, authProvider); | ||||||||||||||||||
const qm = new QueryManager(rt); | ||||||||||||||||||
const app = initializeApp({ projectId: 'p' }); | ||||||||||||||||||
const dc = getDataConnect(app, { | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you clean these up in an firebase-js-sdk/packages/data-connect/test/unit/gmpid.test.ts Lines 43 to 50 in a214691
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Accepted in commit a0ecb6f |
||||||||||||||||||
connector: 'c', | ||||||||||||||||||
location: 'l', | ||||||||||||||||||
service: 's' | ||||||||||||||||||
}); | ||||||||||||||||||
|
||||||||||||||||||
const mutationRef: QueryRef<string, string> = { | ||||||||||||||||||
name: 'm', | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Call There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Accepted in commit a0ecb6f |
||||||||||||||||||
variables: 'v', | ||||||||||||||||||
dataConnect: dc, | ||||||||||||||||||
refType: MUTATION_STR as 'query' | ||||||||||||||||||
}; | ||||||||||||||||||
|
||||||||||||||||||
const queryRef: QueryRef<string, string> = { | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I'd recommend creating a There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Accepted in commit a0ecb6f |
||||||||||||||||||
name: 'm', | ||||||||||||||||||
variables: 'v', | ||||||||||||||||||
dataConnect: dc, | ||||||||||||||||||
refType: QUERY_STR | ||||||||||||||||||
}; | ||||||||||||||||||
|
||||||||||||||||||
const error = new DataConnectError( | ||||||||||||||||||
Code.INVALID_ARGUMENT, | ||||||||||||||||||
`ExecuteQuery can only execute query operation` | ||||||||||||||||||
); | ||||||||||||||||||
|
||||||||||||||||||
expect(() => qm.executeQuery(mutationRef)).to.throw(error.message); | ||||||||||||||||||
expect(() => qm.executeQuery(queryRef)).to.not.throw(error.message); | ||||||||||||||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. You should just be able to call There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Accepted in commit a0ecb6f |
||||||||||||||||||
}); | ||||||||||||||||||
}); |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changelogs get added to release notes, and the unit tests aren't really relevant. Can we say something like:
Throw error when calling
executeQuerywith mutations
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Accepted in commit d4de37a