Refactor store fetch, remove dead code #5597
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Warning This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
This stack of pull requests is managed by Graphite. Learn more about stacking. |
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success2173 tests passing in 953 suites. Report generated by 🧪jest coverage report action from 4b88cc9 |
gordonhirsch
changed the title
|
We detected some changes at packages/*/src and there are no updates in the .changeset. |
gordonhirsch
requested review from
gracejychang,
grollest,
isaacroldan and
rmcnews
5 tasks
craigmichaelmartin
approved these changes
Apr 4, 2025
| @@ -1432,7 +1432,7 @@ export function testDeveloperPlatformClient(stubs: Partial<DeveloperPlatformClie | |||
| Promise.resolve({organization: testOrganization(), apps: [testOrganizationApp()], hasMorePages: false}), | |||
| createApp: (_organization: Organization, _options: CreateAppOptions) => Promise.resolve(testOrganizationApp()), | |||
| devStoresForOrg: (_organizationId: string) => Promise.resolve({stores: [], hasMorePages: false}), | |||
| storeByDomain: (_orgId: string, _shopDomain: string) => Promise.resolve({organizations: {nodes: []}}), | |||
| storeByDomain: (_orgId: string, _shopDomain: string) => Promise.resolve(undefined), | |||
There was a problem hiding this comment.
Any reason we are explicitly passing undefined?
Suggested change
| storeByDomain: (_orgId: string, _shopDomain: string) => Promise.resolve(undefined), | |
| storeByDomain: (_orgId: string, _shopDomain: string) => Promise.resolve(), |
There was a problem hiding this comment.
Nope, thanks for catching this.
There was a problem hiding this comment.
Apparently it needs to be undefined . The suggested change causes this error:
Type '(_orgId: string, _shopDomain: string) => Promise<void>' is not assignable to type '(orgId: string, shopDomain: string) => Promise<OrganizationStore | undefined>'.
Type 'Promise<void>' is not assignable to type 'Promise<OrganizationStore | undefined>'.
Type 'void' is not assignable to type 'OrganizationStore | undefined'.ts(2322)
shauns
approved these changes
Apr 4, 2025
gordonhirsch
force-pushed
the
ensure-dev-store-access
branch
from
4396abf to
fd5b2a9
Compare
gordonhirsch
force-pushed
the
refactor-store-fetch
branch
from
a2eab52 to
4b88cc9
Compare
Differences in type declarationsWe detected differences in the type declarations generated by Typescript for this branch compared to the baseline ('main' branch). Please, review them to ensure they are backward-compatible. Here are some important things to keep in mind:
New type declarationsWe found no new type declarations in this PR Existing type declarationspackages/cli-kit/dist/public/node/api/business-platform.d.ts@@ -40,6 +40,6 @@ export declare function businessPlatformOrganizationsRequest<T>(query: string, t
* @param variables - GraphQL variables to pass to the query.
* @returns The response of the query of generic type <T>.
*/
-export declare function businessPlatformOrganizationsRequestDoc<TResult>(query: TypedDocumentNode<TResult, GraphQLVariables> | TypedDocumentNode<TResult, Exact<{
+export declare function businessPlatformOrganizationsRequestDoc<TResult, TVariables extends Variables>(query: TypedDocumentNode<TResult, TVariables> | TypedDocumentNode<TResult, Exact<{
[key: string]: never;
-}>>, token: string, organizationId: string, variables?: GraphQLVariables): Promise<TResult>;
\ No newline at end of file
+}>>, token: string, organizationId: string, variables?: TVariables): Promise<TResult>;
\ No newline at end of file
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
WHY are these changes introduced?
Refactors store fetching code and removes dead code to simplify future changes.
WHAT is this pull request doing?
fetchStoreByDomainis no longer used and is removed in this PR.This also allows the developer platform client interface to be simplified. Its
storeByDomainmethod can then return anOrganizationStoreinstead of a GraphQL result.This change paves the way for changes to
OrganizationStorethat are not coupled to underlying GraphQL.How to test your changes?
Unit tests are sufficient here. The entire PR stack can be tophatted using the instructions here.
Post-release steps
Measuring impact
How do we know this change was effective? Please choose one:
Checklist