Skip to content
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

Record business_platform_id not partner_id in remaining cases #5138

Open
wants to merge 1 commit into
base: make-organization-source-required
Choose a base branch
from

Conversation

amcaplan
Copy link
Contributor

@amcaplan amcaplan commented Dec 22, 2024

WHY are these changes introduced?

Fixes https://github.com/Shopify/develop-app-inner-loop/issues/2025

Prerequisite here

WHAT is this pull request doing?

  • Introduces organization source tracking in CLI metadata and analytics
  • Updates environment and info commands to include organization source information
  • Adds organization source as a required property for developer platform clients, as sometimes that's all we have to go on (if we haven't yet fetched the org)
  • Ensures consistent organization source handling across Partners and Business Platform clients

How to test your changes?

  1. Run shopify app env pull with both Partners and Business Platform apps
  2. Run shopify app info with both Partners and Business Platform apps
  3. Verify metadata includes correct organization source in analytics

Measuring impact

  • Existing analytics will cater for this addition

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.

@amcaplan amcaplan marked this pull request as ready for review December 22, 2024 19:20
@amcaplan amcaplan requested a review from a team as a code owner December 22, 2024 19:20
Copy link
Contributor

github-actions bot commented Dec 22, 2024

Coverage report

St.
Category Percentage Covered / Total
🟡 Statements
75.35% (-0% 🔻)
8843/11736
🟡 Branches
70.58% (-0.03% 🔻)
4291/6080
🟡 Functions 75.2% 2314/3077
🟡 Lines
75.88% (-0% 🔻)
8360/11017
Show files with reduced coverage 🔻
St.
File Statements Branches Functions Lines
🟡
... / context.ts
71.3% (+0.54% 🔼)
61.67% (-0.4% 🔻)
73.91%
73.91% (+0.58% 🔼)
🟢
... / use.ts
100%
95% (-5% 🔻)
100% 100%
🟢
... / ConcurrentOutput.tsx
98.36% (-1.64% 🔻)
88% (-4% 🔻)
100%
98.33% (-1.67% 🔻)

Test suite run success

1994 tests passing in 900 suites.

Report generated by 🧪jest coverage report action from 4861084

Copy link
Contributor

We detected some changes at packages/*/src and there are no updates in the .changeset.
If the changes are user-facing, run "pnpm changeset add" to track your changes and include them in the next release CHANGELOG.

@amcaplan amcaplan force-pushed the make-organization-source-required branch from 9ebb294 to e746586 Compare December 22, 2024 19:24
@amcaplan amcaplan force-pushed the report-BP-id-to-analytics-in-all-cases branch from c2c710a to 4a65bd2 Compare December 22, 2024 19:27
@amcaplan amcaplan force-pushed the report-BP-id-to-analytics-in-all-cases branch from 4a65bd2 to 4861084 Compare December 22, 2024 19:31
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/monorail.d.ts
@@ -16,6 +16,7 @@ export interface Schemas {
             env_plugin_installed_all?: Optional<string>;
         };
         public: {
+            business_platform_id?: Optional<number>;
             partner_id?: Optional<number>;
             command: string;
             project_type?: Optional<string>;
packages/cli-kit/dist/public/node/plugins.d.ts
@@ -16,7 +16,7 @@ import { Config, Interfaces } from '@oclif/core';
  * @returns A dictionary of plug-in names to the response from the hook.
  */
 export declare function fanoutHooks<TPluginMap extends HookReturnsPerPlugin, TEvent extends string & keyof TPluginMap>(config: Interfaces.Config, event: TEvent, options: TPluginMap[typeof event]['options'], timeout?: number): Promise<Partial<TPluginMap[typeof event]['pluginReturns']>>;
-type AppSpecificMonorailFields = PickByPrefix<MonorailEventPublic, 'app_', 'project_type' | 'api_key' | 'partner_id'> & PickByPrefix<MonorailEventPublic, 'cmd_extensions_'> & PickByPrefix<MonorailEventPublic, 'cmd_scaffold_'>;
+type AppSpecificMonorailFields = PickByPrefix<MonorailEventPublic, 'app_', 'project_type' | 'api_key' | 'partner_id' | 'business_platform_id'> & PickByPrefix<MonorailEventPublic, 'cmd_extensions_'> & PickByPrefix<MonorailEventPublic, 'cmd_scaffold_'>;
 type AppSpecificSensitiveMonorailFields = PickByPrefix<MonorailEventSensitive, 'app_'>;
 export interface HookReturnsPerPlugin extends HookReturnPerTunnelPlugin {
     public_command_metadata: {

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