Filter app results by title #4630

amcaplan · 2024-10-10T12:11:06Z

WHY are these changes introduced?

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

Pairs with https://github.com/Shopify/shopify/pull/539421 to enable filtering by app title in the new API.

Note this should NOT be merged until that PR is merged.

WHAT is this pull request doing?

Updates the format of the request to work with the new paginated field, and passes in the search term as a query for app title.

Note that each token is considered an independent search term, so we're searching for an app title that includes all mentioned tokens.

How to test your changes?

Point the new API to the filter-using-pagination-system branch (update as of 2024-11-14: this works on main or dd as well)
Create several apps with different names so you can see the search working (not necessary if pointing to production)
Run USE_APP_MANAGEMENT_API=1 bin/spin pnpm shopify app config link --path /PATH/TO/YOUR/APP
Select the option to connect to an existing app, and search for different app titles.

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

github-actions · 2024-10-10T12:11:21Z

We detected some changes at either packages/*/src or packages/cli-kit/assets/cli-ruby/** 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.

github-actions · 2024-10-10T12:15:27Z

Coverage report

St.^❔	Category	Percentage	Covered / Total
🟡	Statements	75.44% (+0.07% 🔼)	8663/11484
🟡	Branches	70.79% (+0.05% 🔼)	4215/5954
🟡	Functions	74.98% (+0.08% 🔼)	2272/3030
🟡	Lines	75.99% (+0.08% 🔼)	8192/10781

Test suite run success

1961 tests passing in 890 suites.

Report generated by 🧪jest coverage report action from c55df5d

MitchDickinson · 2024-10-18T10:50:59Z

CC @amcaplan

Note that as part of https://github.com/Shopify/shopify/pull/539421, I introduced the connection API but I also preserved the old apps field on the GraphQL schema. So now we have two ways to access apps:

appsConnection
apps
I did not want to have time pressure to ship this CLI PR while the CLI was in a broken state, so I took the safe path.

This PR is probably broken if it's using apps and assuming it's getting back a connection. I think the work outstanding here is going to be (in order to never break the latest CLI):

Ship this PR targeting appsConnection
If you want to rename appsConnection

Update apps to also be a connection type
Update CLI to use apps
Remove appsConnection from server

Or if you feel comfortable moving fast and breaking things, go ahead. I'm not opposed to that with good comms around it in our project channel. I just didn't want to take that on myself :)

MitchDickinson · 2024-11-11T12:27:55Z

@amcaplan should we aim to get this shipped?

github-actions · 2024-11-14T15:43:27Z

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 · 2024-11-14T20:48:37Z

I think this is ready to go. Currently it points to appsConnection. We can choose to leave it as is, or update apps to be a connection as well and then port this over.

shauns · 2024-11-22T10:18:00Z

pnpm-lock.yaml

@@ -279,7 +279,7 @@ importers:
        version: link:../app
      '@shopify/cli-hydrogen':
        specifier: 9.0.2
-        version: 9.0.2(react-dom@18.2.0)(react@18.2.0)


I don't think this file should have changed?

I honestly have no idea sometimes why these things change... maybe my local version of pnpm is slightly off? But I'm on 8.15.7 so 🤷‍♂️

It seems like a rebase eliminated this change. Looks like this snuck in inside someone else's PR...

shauns · 2024-11-22T10:20:46Z

packages/app/src/cli/api/graphql/app-management/queries/apps.graphql

-        appModules {
-          ...ReleasedAppModule
+query listApps($query: String) {
+  appsConnection(query: $query, first: 50) {


Check -- we're going from all (presumably -- ignore if not) to 50. How does that match up to partners? Do we have sane ordering for these (e.g. most recent first)?

first is required, so we need to pass some kind of value here.

50 seems reasonable, I don't think we should have users scrolling manually beyond that.

I thought I recalled Partners using 50 as the max, but I can't seem to find it at the moment... That said, client-side we limit it to 25 here. So it's the same order of magnitude. Maybe worth checking, but it's easily changed and not a reason to hold up the PR at the moment IMO.

Order is the default dictated by the server, currently the most recently updated. It will match what they see in the dashboard; it feels like consistency is good.

shauns · 2024-11-22T10:23:04Z

packages/app/src/cli/utilities/developer-platform-client/app-management-client.test.ts

+    })
+  }
+
+  test('passes in a blank search if none is provided', async () => {


This is a case where a parameterised test would be best - https://vitest.dev/api/#test-each

Oh, neat! I wasn't aware of how to do this.

shauns · 2024-11-22T10:24:55Z

packages/app/src/cli/utilities/developer-platform-client/app-management-client.test.ts

+  }
+
+  test('passes in a blank search if none is provided', async () => {
+    await appSearchTest({query: undefined, queryVariable: ''})


Given that the default behaviour is term = '' can we get a test asserting that query stays empty in that case.

shauns · 2024-11-22T10:26:20Z

packages/app/src/cli/utilities/developer-platform-client/app-management-client.ts

+    }
+    const result = await appManagementRequestDoc(organizationId, query, await this.token(), variables)
+    if (!result.appsConnection) {
+      throw new AbortError('Server failed to retrieve apps')


I think this is a BugError. Things are pretty broken if this happens

amcaplan requested a review from a team as a code owner October 10, 2024 12:11

amcaplan requested review from gordonhirsch and alexanderMontague and removed request for a team October 10, 2024 12:11

amcaplan force-pushed the filter-app-results-on-app-title branch from 378d9d0 to 33a3c20 Compare November 14, 2024 15:43

amcaplan force-pushed the filter-app-results-on-app-title branch from 33a3c20 to 4de2e9f Compare November 14, 2024 15:46

amcaplan requested a review from MitchDickinson November 14, 2024 20:46

shauns approved these changes Nov 22, 2024

View reviewed changes

amcaplan added 3 commits November 24, 2024 14:32

Update apps query to search using appsConnection

92ef39d

Use search term to query by app title

b09181d

Use test.each for more semantic vitest tests

db183b7

amcaplan force-pushed the filter-app-results-on-app-title branch from 4de2e9f to 08bd462 Compare November 24, 2024 12:51

Throw BugError if response is improperly formatted

c55df5d

amcaplan force-pushed the filter-app-results-on-app-title branch from 08bd462 to c55df5d Compare November 24, 2024 12:53

amcaplan added this pull request to the merge queue Nov 24, 2024

Merged via the queue into main with commit e56fad4 Nov 24, 2024
27 checks passed

amcaplan deleted the filter-app-results-on-app-title branch November 24, 2024 13:09

shopify-shipit bot temporarily deployed to nightly November 24, 2024 14:36 Inactive

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Filter app results by title #4630

Filter app results by title #4630

amcaplan commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024

github-actions bot commented Oct 10, 2024 •

edited

Loading

MitchDickinson commented Oct 18, 2024

MitchDickinson commented Nov 11, 2024

github-actions bot commented Nov 14, 2024

amcaplan commented Nov 14, 2024

shauns Nov 22, 2024

amcaplan Nov 24, 2024

amcaplan Nov 24, 2024

shauns Nov 22, 2024

amcaplan Nov 24, 2024

shauns Nov 22, 2024

amcaplan Nov 24, 2024

shauns Nov 22, 2024

shauns Nov 22, 2024

Filter app results by title #4630

Filter app results by title #4630

Conversation

amcaplan commented Oct 10, 2024 • edited Loading

WHY are these changes introduced?

WHAT is this pull request doing?

How to test your changes?

Measuring impact

Checklist

github-actions bot commented Oct 10, 2024

github-actions bot commented Oct 10, 2024 • edited Loading

Coverage report

Test suite run success

MitchDickinson commented Oct 18, 2024

MitchDickinson commented Nov 11, 2024

github-actions bot commented Nov 14, 2024

amcaplan commented Nov 14, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

amcaplan commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading