Automatic GraphQL code generation #4048
Merged
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
Loads from partners and business platform destination APIs
Examples are provided for: - a partners query and mutation - a BP query
|
We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** and there are no updates in the .changeset. |
Coverage report
Show new covered files 🐣
Show files with reduced coverage 🔻
Test suite run success1695 tests passing in 793 suites. Report generated by 🧪jest coverage report action from 7c627c2 |
isaacroldan
reviewed
Jun 17, 2024
isaacroldan
reviewed
Jun 17, 2024
| export default { | ||
| projects: { | ||
| partners: projectFactory('partners', 'cli_schema.graphql'), | ||
| businessPlatform: projectFactory('business-platform', 'destinations_schema.graphql'), |
There was a problem hiding this comment.
Do you need to include also the new app-management API? that's different than business-platform right?
isaacroldan
approved these changes
Jun 17, 2024
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@@ -1,4 +1,6 @@
import { GraphQLVariables } from './graphql.js';
+import { TypedDocumentNode } from '@graphql-typed-document-node/core';
+import { Variables } from 'graphql-request';
/**
* Executes a GraphQL query against the Business Platform Destinations API.
*
@@ -7,4 +9,13 @@ import { GraphQLVariables } from './graphql.js';
* @param variables - GraphQL variables to pass to the query.
* @returns The response of the query of generic type <T>.
*/
-export declare function businessPlatformRequest<T>(query: string, token: string, variables?: GraphQLVariables): Promise<T>;
\ No newline at end of file
+export declare function businessPlatformRequest<T>(query: string, token: string, variables?: GraphQLVariables): Promise<T>;
+/**
+ * Executes a GraphQL query against the Business Platform Destinations API. Uses typed documents.
+ *
+ * @param query - GraphQL query to execute.
+ * @param token - Business Platform token.
+ * @param variables - GraphQL variables to pass to the query.
+ * @returns The response of the query of generic type <TResult>.
+ */
+export declare function businessPlatformRequestDoc<TResult, TVariables extends Variables>(query: TypedDocumentNode<TResult, TVariables>, token: string, variables?: TVariables): Promise<TResult>;
\ No newline at end of file
packages/cli-kit/dist/public/node/api/graphql.d.ts@@ -1,19 +1,26 @@
import { rawRequest, RequestDocument, Variables } from 'graphql-request';
+import { TypedDocumentNode } from '@graphql-typed-document-node/core';
export interface GraphQLVariables {
[key: string]: any;
}
export type GraphQLResponse<T> = Awaited<ReturnType<typeof rawRequest<T>>>;
-export interface GraphQLRequestOptions<T> {
- query: RequestDocument;
+interface GraphQLRequestBaseOptions<TResult> {
api: string;
url: string;
token?: string;
addedHeaders?: {
[header: string]: string;
};
- variables?: Variables;
- responseOptions?: GraphQLResponseOptions<T>;
+ responseOptions?: GraphQLResponseOptions<TResult>;
}
+export type GraphQLRequestOptions<T> = GraphQLRequestBaseOptions<T> & {
+ query: RequestDocument;
+ variables?: Variables;
+};
+export type GraphQLRequestDocOptions<TResult, TVariables> = GraphQLRequestBaseOptions<TResult> & {
+ query: TypedDocumentNode<TResult, TVariables>;
+ variables?: TVariables;
+};
export interface GraphQLResponseOptions<T> {
handleErrors?: boolean;
onResponse?: (response: GraphQLResponse<T>) => void;
@@ -24,4 +31,12 @@ export interface GraphQLResponseOptions<T> {
* @param options - GraphQL request options.
* @returns The response of the query of generic type <T>.
*/
-export declare function graphqlRequest<T>(options: GraphQLRequestOptions<T>): Promise<T>;
\ No newline at end of file
+export declare function graphqlRequest<T>(options: GraphQLRequestOptions<T>): Promise<T>;
+/**
+ * Executes a GraphQL query to an endpoint. Uses typed documents.
+ *
+ * @param options - GraphQL request options.
+ * @returns The response of the query of generic type <TResult>.
+ */
+export declare function graphqlRequestDoc<TResult, TVariables extends Variables>(options: GraphQLRequestDocOptions<TResult, TVariables>): Promise<TResult>;
+export {};
\ No newline at end of file
packages/cli-kit/dist/public/node/api/partners.d.ts@@ -1,4 +1,6 @@
import { GraphQLVariables, GraphQLResponse } from './graphql.js';
+import { TypedDocumentNode } from '@graphql-typed-document-node/core';
+import { Variables } from 'graphql-request';
/**
* Executes a GraphQL query against the Partners API.
*
@@ -8,6 +10,15 @@ import { GraphQLVariables, GraphQLResponse } from './graphql.js';
* @returns The response of the query of generic type <T>.
*/
export declare function partnersRequest<T>(query: string, token: string, variables?: GraphQLVariables): Promise<T>;
+/**
+ * Executes a GraphQL query against the Partners API. Uses typed documents.
+ *
+ * @param query - GraphQL query to execute.
+ * @param token - Partners token.
+ * @param variables - GraphQL variables to pass to the query.
+ * @returns The response of the query of generic type <TResult>.
+ */
+export declare function partnersRequestDoc<TResult, TVariables extends Variables>(query: TypedDocumentNode<TResult, TVariables>, token: string, variables?: TVariables): Promise<TResult>;
export interface FunctionUploadUrlGenerateResponse {
functionUploadUrlGenerate: {
generatedUrlDetails: {
|
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?
Fixes a long-standing issue: the types for GraphQL results and variables, as well as the content of the queries/mutations themselves, were manually specified and not automatically tested.
WHAT is this pull request doing?
🆕 The main addition here is
p graphql-codegen. This takes.graphqldocuments (containing a query/mutation that we use) and:✨ It also provides auto-complete and in-editor validation & documentation when writing queries in VS Code.
🚨 generated types are accurate vs. the schema, which means they can and will find snags the hand-crafted types didn't. improved quality is a good thing! but as more queries switch to this method, more fixes will be needed.
💁♂️ Some implementation notes:
dev upinternallygraphql-codegenhas been run prior to commits that do change queries.❓ I've converted a few queries in the scope of this PR. Should the rest be converted now? Or can we do that in a follow up?
How to test your changes?
CI does most of the testing here. Perhaps the thing to try is to migrate a query/mutation to this format: see how easy/ergonomic it is, what errors it finds, etc.
Measuring impact
How do we know this change was effective? Please choose one:
Checklist
devordeployhave been reflected in the internal flowchart.