Skip to content

Make developerPlatformClient not optional in OrganizationApp #6144

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

Draft
wants to merge 1 commit into
base: 07-22-stop_loading_organization_id_from_toml_and_using_it_to_select_the_client
Choose a base branch
from

Conversation

isaacroldan
Copy link
Contributor

@isaacroldan isaacroldan commented Jul 22, 2025

WHY are these changes introduced?

Support the project to remove ORG_ID from app tomls.

WHAT is this pull request doing?

Changes the developerPlatformClient property on the OrganizationApp type from optional to required, and updates all relevant code to ensure this property is always provided. This eliminates the need for fallback logic when accessing the developer platform client.

How to test your changes?

  1. Just make sure the CLI works, creating an app, adding extensions, deploying...

Measuring impact

How do we know this change was effective? Please choose one:

  • n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix
  • Existing analytics will cater for this addition
  • PR includes analytics changes to measure impact

Checklist

  • I've considered possible cross-platform impacts (Mac, Linux, Windows)
  • I've considered possible documentation changes

Copy link
Contributor Author

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.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@isaacroldan isaacroldan force-pushed the 07-22-make_developerplatformclient_not_optional_in_organizationapp branch from 6d71985 to f263f9b Compare July 22, 2025 12:22
@isaacroldan isaacroldan force-pushed the 07-22-stop_loading_organization_id_from_toml_and_using_it_to_select_the_client branch from dd7eaf5 to ffd5cbb Compare July 22, 2025 12:22
@isaacroldan isaacroldan force-pushed the 07-22-make_developerplatformclient_not_optional_in_organizationapp branch from f263f9b to 1f69d09 Compare July 22, 2025 15:38
@isaacroldan isaacroldan force-pushed the 07-22-stop_loading_organization_id_from_toml_and_using_it_to_select_the_client branch from ffd5cbb to e4030c4 Compare July 22, 2025 15:38
@isaacroldan isaacroldan force-pushed the 07-22-make_developerplatformclient_not_optional_in_organizationapp branch from 1f69d09 to 7c43247 Compare July 22, 2025 15:59
@isaacroldan isaacroldan force-pushed the 07-22-stop_loading_organization_id_from_toml_and_using_it_to_select_the_client branch from e4030c4 to 7d025ec Compare July 22, 2025 15:59
Copy link
Contributor

Differences in type declarations

We 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:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/api/app-management.d.ts
@@ -22,7 +22,6 @@ export interface RequestOptions {
  * @param unauthorizedHandler - Optional handler for unauthorized requests.
  */
 export interface AppManagementRequestOptions<TResult, TVariables extends Variables> {
-    organizationId: string;
     query: TypedDocumentNode<TResult, TVariables>;
     token: string;
     variables?: TVariables;

@isaacroldan isaacroldan force-pushed the 07-22-make_developerplatformclient_not_optional_in_organizationapp branch from 7c43247 to b68ef39 Compare July 22, 2025 16:08
Copy link
Contributor

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
77.97% (-0% 🔻)
12993/16664
🟡 Branches
72.11% (+0.02% 🔼)
6332/8781
🟡 Functions 78.09% 3368/4313
🟡 Lines
78.37% (-0% 🔻)
12304/15699
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟢
... / app-context.ts
96.67% (-0.11% 🔻)
92.31% (+3.02% 🔼)
100%
96.55% (-0.11% 🔻)
🟢
... / context.ts
78.13% (-0.23% 🔻)
58.82% 77.27%
80.23% (-0.23% 🔻)
🟢
... / link.ts
96.51% (-0.04% 🔻)
94.12% (+2.45% 🔼)
100%
96.34% (-0.04% 🔻)

Test suite run success

3042 tests passing in 1314 suites.

Report generated by 🧪jest coverage report action from b68ef39

Copy link
Contributor

Differences in type declarations

We 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:

  • Some seemingly private modules might be re-exported through public modules.
  • If the branch is behind main you might see odd diffs, rebase main into this branch.

New type declarations

We found no new type declarations in this PR

Existing type declarations

packages/cli-kit/dist/public/node/api/app-management.d.ts
@@ -22,7 +22,6 @@ export interface RequestOptions {
  * @param unauthorizedHandler - Optional handler for unauthorized requests.
  */
 export interface AppManagementRequestOptions<TResult, TVariables extends Variables> {
-    organizationId: string;
     query: TypedDocumentNode<TResult, TVariables>;
     token: string;
     variables?: TVariables;

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant