feat: improved user experience for detached instances with prefix matching and suggestions #4199

jeffsmale90 · 2023-02-01T03:01:05Z

Detached instances are pretty awesome, but they have long names that you have to type all the time!

With fuzzy matching (and some helpful suggestions), you can get by without typing so much:

$ ganache instances stop hot_lim_cheesecacke

hot_lim_cheesecacke found.

Did you mean:
 - hot_lime_cheesecake
 - hot_lemon_loaf

$ ganache instances stop hot_li
hot_lime_cheesecake stopped

note: now you only need to enter the unique prefix of the instance name. Ganache will use this prefix to identify the instance.

jeffsmale90 · 2023-02-01T03:10:07Z

This will have more thorough testing added after #3735 is merged

leeoniya · 2023-02-01T12:27:30Z

maybe a bit late for a pitch, but https://github.com/leeoniya/uFuzzy#a-biased-appraisal-of-similar-work

jeffsmale90 · 2023-02-02T01:47:46Z

https://github.com/leeoniya/uFuzzy#a-biased-appraisal-of-similar-work

Thanks for the suggestion! I intentionally didn't introduce a library for this feature, in an effort to limit the impact on the bundle size.

In addition, I'm not sure this is a good fit for your library, based on your comment "match a relatively short search phrase (needle) against a large list of short-to-medium phrases (haystack)" whereas this use case is a very short search phrase against a small list of very short phrases.

I'll keep it in mind for future work though.

src/packages/cli/src/detach.ts

…here's a single prefix match, or suggest close matches

…th L-diggity if we already have enough prefix matches. Refine distinction between 'match' and 'instance'.

cloudflare-pages · 2023-04-05T02:28:22Z

Deploying with Cloudflare Pages

Latest commit:	`4ce7169`
Status:	✅ Deploy successful!
Preview URL:	https://e4fca558.ganache.pages.dev
Branch Preview URL:	https://feat-detach-fuzzy-matching.ganache.pages.dev

View logs

jeffsmale90 · 2023-04-05T02:37:19Z

src/packages/cli/src/detach.ts

@@ -19,6 +19,8 @@ export type DetachedInstance = {
  version: string;
 };

+const MAX_SUGGESTIONS = 4;
+const MAX_LEVENSHTEIN_DISTANCE = 10;


This is a huge distance. I'm unsure about how to tune this.

I'd rather we give false positives, than false negatives - if I forget the name of the instance, and get something that's truly wrong, I'd still like a recommendation.

I'm open to suggestions on this. At the same time, it's something that we can tune later, and hopefully we'll get some user feedback on the experience.

agreed. we can tune it later.

davidmurdoch · 2023-04-05T21:20:57Z

src/packages/cli/src/detach.ts

@@ -19,6 +19,8 @@ export type DetachedInstance = {
  version: string;
 };

+const MAX_SUGGESTIONS = 4;
+const MAX_LEVENSHTEIN_DISTANCE = 10;


agreed. we can tune it later.

davidmurdoch · 2023-04-05T21:39:38Z

src/packages/cli/src/detach.ts

+ * @returns {{ match: string } | { suggestions: string[] }} an object
+ * containiner either a single exact `match` or a number of `suggestions`
+ */
+async function getSimilarInstanceNames(


Oh man I really want to optimize this function! haha. But since the actual number of files is typically going to be on the order of 1 I'll hold back! haha

p.s., using our findInsertPosition util function is always a good time.

davidmurdoch · 2023-04-05T21:41:36Z

src/packages/cli/src/cli.ts

@@ -181,7 +192,8 @@ if (argv.action === "start") {
    })
    .catch(err => {
      // the child process would have output its error to stdout, so no need to
-      // output anything more
+      // do anything more other than set the exitCode
+      process.exitCode = 1;


davidmurdoch · 2023-04-05T21:44:10Z

src/packages/cli/src/cli.ts

+      console.log(`${porscheColor(instanceName)} not found.`);
+      if (instanceOrSuggestions.suggestions?.length > 0) {
+        console.log();
+        console.log("Did you mean:");


Since this isn't interactive (oh that'd be cool!), and the user can't actually answer the question. Should we use a different phrase here? git uses The most similar command is.

src/packages/cli/src/detach.ts

davidmurdoch · 2023-04-05T21:47:41Z

src/packages/cli/src/detach.ts

+ *
+ * @param {string} a - The first string to compare.
+ * @param {string} b - The second string to compare.
+ * @return {number} The Levenshtein distance between the two strings.


I think I've mentioned this before, but including the types in these definitions are kinda redundant. I don't think you need to remove them, but I don't think you need to add them in the first place either.

…nd message

jeffsmale90 commented Feb 2, 2023

View reviewed changes

src/packages/cli/src/detach.ts Outdated Show resolved Hide resolved

jeffsmale90 commented Feb 2, 2023

View reviewed changes

src/packages/cli/src/detach.ts Outdated Show resolved Hide resolved

jeffsmale90 force-pushed the feat/detach_fuzzy_matching branch from 640472d to 8b2c81d Compare February 2, 2023 02:24

jeffsmale90 marked this pull request as ready for review February 2, 2023 02:37

jeffsmale90 requested a review from davidmurdoch as a code owner February 2, 2023 02:37

jeffsmale90 marked this pull request as draft March 10, 2023 01:42

jeffsmale90 changed the title ~~feat: Fuzzy matching for detached instance names~~ feat: improved user experience for detached instances with prefix matching and suggestions Apr 4, 2023

jeffsmale90 added 6 commits April 5, 2023 10:49

When attempting to stop a detached instance, select the instance if t…

a3fe8a7

…here's a single prefix match, or suggest close matches

Add some tests for levenshteinDistance function

bb413f6

Return error code 1 when we fail to find an instance. Don't bother wi…

1fe3dd7

…th L-diggity if we already have enough prefix matches. Refine distinction between 'match' and 'instance'.

Include input name in not-found message

65381c0

Tidy up the place a little

18ab2c5

Add comments

e805106

jeffsmale90 force-pushed the feat/detach_fuzzy_matching branch from 8b2c81d to e805106 Compare April 5, 2023 02:28

jeffsmale90 commented Apr 5, 2023

View reviewed changes

jeffsmale90 marked this pull request as ready for review April 5, 2023 02:37

davidmurdoch reviewed Apr 5, 2023

View reviewed changes

Remove types from doc-comments, improve wordology in instance-not-fou…

4ce7169

…nd message

jeffsmale90 requested a review from davidmurdoch April 19, 2023 05:01

Merge branch 'develop' into feat/detach_fuzzy_matching

f8e29a8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: improved user experience for detached instances with prefix matching and suggestions #4199

feat: improved user experience for detached instances with prefix matching and suggestions #4199

jeffsmale90 commented Feb 1, 2023 •

edited

jeffsmale90 commented Feb 1, 2023

leeoniya commented Feb 1, 2023

jeffsmale90 commented Feb 2, 2023

cloudflare-pages bot commented Apr 5, 2023 •

edited

jeffsmale90 Apr 5, 2023

davidmurdoch Apr 5, 2023

davidmurdoch Apr 5, 2023

davidmurdoch Apr 5, 2023

davidmurdoch Apr 5, 2023

davidmurdoch Apr 5, 2023

davidmurdoch Apr 5, 2023

feat: improved user experience for detached instances with prefix matching and suggestions #4199

Are you sure you want to change the base?

feat: improved user experience for detached instances with prefix matching and suggestions #4199

Conversation

jeffsmale90 commented Feb 1, 2023 • edited

jeffsmale90 commented Feb 1, 2023

leeoniya commented Feb 1, 2023

jeffsmale90 commented Feb 2, 2023

cloudflare-pages bot commented Apr 5, 2023 • edited

Deploying with Cloudflare Pages

jeffsmale90 Apr 5, 2023

Choose a reason for hiding this comment

davidmurdoch Apr 5, 2023

Choose a reason for hiding this comment

davidmurdoch Apr 5, 2023

Choose a reason for hiding this comment

davidmurdoch Apr 5, 2023

Choose a reason for hiding this comment

davidmurdoch Apr 5, 2023

Choose a reason for hiding this comment

davidmurdoch Apr 5, 2023

Choose a reason for hiding this comment

davidmurdoch Apr 5, 2023

Choose a reason for hiding this comment

jeffsmale90 commented Feb 1, 2023 •

edited

cloudflare-pages bot commented Apr 5, 2023 •

edited