Make developer console support create/delete extensions mid-dev #5118

isaacroldan · 2024-12-17T08:46:49Z

WHY are these changes introduced?

Adds support for handling extension creation and deletion events in the developer console during consistent-dev.

Fixes https://github.com/Shopify/develop-app-outer-loop/issues/1198

WHAT is this pull request doing?

Implements handling for Created and Deleted extension events
Adds new methods to ExtensionsPayloadStore for adding and removing extensions
Updates the event handler to maintain the extensions list in the payload store options

KNOWN ISSUES:

When removing an extension, you need to manually refresh the dev-console.

How to test your changes?

Start dev for an app with UI extensions
Create a new UI extension and verify it appears in the dev console (and that the deeplink works)
Delete a UI extension and verify it's removed from the dev console (after refreshing)
Modify an existing extension and confirm updates are still working

Measuring impact

n/a - this doesn't need measurement, e.g. a linting rule or a bug-fix

Checklist

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

isaacroldan · 2024-12-17T08:47:08Z

Make developer console support create/delete extensions mid-dev #5118 👈 (View in Graphite)
main

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

github-actions · 2024-12-17T08:50:59Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	75.18% (-0.13% 🔻)	8841/11759
🟡	Branches	70.48% (-0.1% 🔻)	4290/6087
🟡	Functions	75.11% (-0.1% 🔻)	2315/3082
🟡	Lines	75.73% (-0.12% 🔻)	8358/11036

Show files with reduced coverage 🔻

St.^❔	File	Statements	Branches	Functions	Lines
🔴	`...` / extension.ts	54.55% (-31.17% 🔻)	0%	60% (-15% 🔻)	56.25% (-29.46% 🔻)
🟢	`...` / app-event-watcher.ts	93.83% (-1.23% 🔻)	86.49% (-2.7% 🔻)	90.48%	98.61%
🟢	`...` / store.ts	86.54% (-13.46% 🔻)	87.5% (-12.5% 🔻)	86.36% (-13.64% 🔻)	87.23% (-12.77% 🔻)
🟢	`...` / ConcurrentOutput.tsx	98.36% (-1.64% 🔻)	88% (-4% 🔻)	100%	98.33% (-1.67% 🔻)

Test suite run success

1994 tests passing in 902 suites.

Report generated by 🧪jest coverage report action from 147046b

isaacroldan · 2024-12-18T12:25:22Z

packages/app/src/cli/models/extensions/extension-instance.ts

    this.handle = this.buildHandle()
+    this.devUUID = `dev-${nonRandomUUID(this.handle)}`


With this we ensure that the devUUID is always the same for the same extension. Allowing us to reload it if we need it.

Noting that the handle can change (right?) so it's not 100% foolproof but it's close enough that it should be fine.

It shouldn't change during dev though, which solves the issue of "reloading" the app.

In any case, this is mostly for ui-extensions, and we need to rethink why ui-extensions need a devUUID in the first place. Will probably do it in early january.

amcaplan · 2024-12-18T13:32:12Z

packages/app/src/cli/models/extensions/extension-instance.ts

    this.handle = this.buildHandle()
+    this.devUUID = `dev-${nonRandomUUID(this.handle)}`


Noting that the handle can change (right?) so it's not 100% foolproof but it's close enough that it should be fine.

amcaplan · 2024-12-18T13:35:00Z

packages/app/src/cli/services/dev/extension.ts

+  // NOTE: Always use `payloadOptions`, never `options` directly. This way we can mutate `payloadOptions` without
+  // affecting the original `options` object and we only need to care about `payloadOptions` in this function.


Note that we could make options of type Readonly<ExtensionDevOptions> but there are also downsides as Readonly is a somewhat weak guarantee and might make us think code is safe when it really isn't. Not a mandatory change, but something to consider.

Actually, I just forced all other functions to expect a ExtensionsPayloadStoreOptions, that way i'm sure we are using payloadOptions

packages/app/src/cli/services/dev/extension.ts

We may have API key rather than ID

In fact it's just a second reference to the same thing after the code changes in the previous commit. So it would be better to avoid suggesting that changes are safe.

If this is the first time deploying and there is no UID, the autogenerated UID won't yet be found in `module.configuration`. All singleton shopify.app.toml-based extensions don't need assets, so even though they should technically use module.handle here, it basically doesn't matter. And for all other extension types, `module.uid` is the correct value to use here.

Just pass `SHOPIFY_APP_TEMPLATES_JSON_PATH=/path/to/your/file` and it will draw from there instead of pulling from the live URL.

…delete_extensions_mid-dev

Make developer console support create/delete extensions mid-dev

a4ee61d

Fix support for extension creation in dev-console

8b25260

isaacroldan commented Dec 18, 2024

View reviewed changes

isaacroldan added 2 commits December 18, 2024 13:31

Some cleanup

d8cc553

Fix tests

8c00b5e

amcaplan reviewed Dec 18, 2024

View reviewed changes

isaacroldan added 2 commits December 18, 2024 17:41

use ExtensionsPayloadStoreOptions instead of ExtensionsDevOptinos

1198cae

Fix some types

303d315

isaacroldan marked this pull request as ready for review December 18, 2024 17:00

isaacroldan requested a review from a team as a code owner December 18, 2024 17:00

This comment has been minimized.

Sign in to view

jeffcharles and others added 17 commits January 3, 2025 16:52

Use Shopify Functions Javy plugin instead of default Javy plugin

922b500

Update Shopify Functions to version with plugin

b9da69e

Use version constant in plugin name and path

507f3ec

Fall back to GitHub when repo is not on spin

faabedf

Fetch slowly to avoid undiagnosable rate limiting issues

23cbd7e

Reraise exception

47baf4c

Allow identifying apps by API key, not ID

8dba217

Remove unnecessary handling of app_id in TOML

72c7621

Rename for consistency

b80f341

Rename for accuracy

fc0a0de

We may have API key rather than ID

Remove copying mechanism which falsely suggests immutability

d14639b

In fact it's just a second reference to the same thing after the code changes in the previous commit. So it would be better to avoid suggesting that changes are safe.

Only search for apps by API key, not ID

fa267f9

Handle not having app ID available for function schema operations

4a1ebe3

Add try/catch to currentProcessIsGlobal function

91e8272

Update is-global.ts

97cc48f

Reduce theme upload batch size to prevent timeout

fde07bc

Send a list of request ids to monorail

15604dc

isaacroldan and others added 17 commits January 3, 2025 16:53

Add tests for requestIdCollection

628d206

Add tests for Graphql.ts

b47e62e

Update request-ids.test.ts

ea153b8

Fix import

75c1169

Update monorail version

21441fd

Update tests

8c7e475

Fix changeset type

8d8fbb5

bump function-runner version to v7.0.0

346a17b

Port fetchTheme / fetchThemes to graphQL

ece0ca5

Make it possible to tophat changes to the extension templates JSON

637801e

Just pass `SHOPIFY_APP_TEMPLATES_JSON_PATH=/path/to/your/file` and it will draw from there instead of pulling from the live URL.

Remove irrelevant link to GitHub

c135cec

Move constant to constants file

95de9b6

Execute addUidToToml in app-context for all commands

95caf8f

Extract logic to a new file

c9a374c

Fix import

bfccc1b

End session if we can create a deeplink to checkout extension

2cb0df6

isaacroldan requested a review from a team as a code owner January 3, 2025 15:54

Merge branch 'main' into 12-17-make_developer_console_support_create_…

147046b

…delete_extensions_mid-dev

isaacroldan requested a review from amcaplan January 3, 2025 15:57

amcaplan approved these changes Jan 5, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Make developer console support create/delete extensions mid-dev #5118

Make developer console support create/delete extensions mid-dev #5118

isaacroldan commented Dec 17, 2024 •

edited

Loading

isaacroldan commented Dec 17, 2024

github-actions bot commented Dec 17, 2024 •

edited

Loading

isaacroldan Dec 18, 2024

amcaplan Dec 18, 2024

isaacroldan Dec 18, 2024

amcaplan Dec 18, 2024

amcaplan Dec 18, 2024

isaacroldan Dec 18, 2024

This comment has been minimized.

		this.handle = this.buildHandle()
		this.devUUID = `dev-${nonRandomUUID(this.handle)}`

		// NOTE: Always use `payloadOptions`, never `options` directly. This way we can mutate `payloadOptions` without
		// affecting the original `options` object and we only need to care about `payloadOptions` in this function.

Make developer console support create/delete extensions mid-dev #5118

Are you sure you want to change the base?

Make developer console support create/delete extensions mid-dev #5118

Conversation

isaacroldan commented Dec 17, 2024 • edited Loading

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Measuring impact

Checklist

isaacroldan commented Dec 17, 2024

github-actions bot commented Dec 17, 2024 • edited Loading

Coverage report

Test suite run success

isaacroldan Dec 18, 2024

Choose a reason for hiding this comment

amcaplan Dec 18, 2024

Choose a reason for hiding this comment

isaacroldan Dec 18, 2024

Choose a reason for hiding this comment

amcaplan Dec 18, 2024

Choose a reason for hiding this comment

amcaplan Dec 18, 2024

Choose a reason for hiding this comment

isaacroldan Dec 18, 2024

Choose a reason for hiding this comment

This comment has been minimized.

isaacroldan commented Dec 17, 2024 •

edited

Loading

github-actions bot commented Dec 17, 2024 •

edited

Loading