Add public StartClone() method #325

josephmyers · 2023-09-28T09:04:49Z

This is necessary so that flexbridge can supply required cloning information and start a repo download without direct/manual user input. This order will come from Fieldworks when launched from CMD or protocol handler with the proper arguments.

Original issue here.

This change is

This is necessary so that flexbridge can supply required cloning information and start a repo download without direct/manual user input. This order will come from Fieldworks when launched from CMD or protocol handler with the proper arguments.

github-actions · 2023-09-28T09:40:57Z

Test Results

      2 files ±0   202 suites ±0 43m 59s ⏱️ -48s
  875 tests ±0   853 ✔️ ±0 22 💤 ±0 0 ❌ ±0
1 996 runs ±0 1 931 ✔️ ±0 65 💤 ±0 0 ❌ ±0

Results for commit 473c798. ± Comparison against base commit 84e6de0.

♻️ This comment has been updated with latest results.

jasonleenaylor

Since this is an API change that we are interested in I think it deserves a version bump. Adding +semver:major in the commit comment will take care of that.

Reviewed 1 of 1 files at r1, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @josephmyers)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs

+semver:major

This gives us more flexibility (less security) for changing URI structure.

ermshiperete · 2023-09-29T08:10:00Z

This change deserves a line in CHANGELOG.md.

papeh · 2023-09-29T16:31:03Z

I'm a bit unclear. The commit comment on sillsdev/flexbridge#388 says that a dialog will be shown to confirm the download, and GetCloneFromInternetDialog seems to be the only dialog shown, but in this PR, it looks like StartClone() bypasses all user interaction.

Will there be user interaction? (I assume you wouldn't want the user to edit anything, except perhaps the local project name.)

papeh · 2023-09-29T16:22:20Z

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs

+		/// <param name="projectName">Name of the project to clone</param>
+		/// <param name="projectUri">URI where the project can be found</param>
+		/// </summary>
+		public void StartClone(string username, string password, string projectName, Uri projectUri)


I think the public method would make more sense as a static method to

create a GetCloneFromInternetModel from the arguments

create a GetCloneFromInternetDialog from the model

StartClone(); with no arguments

hahn-kev · 2023-10-02T03:09:20Z

@papeh there will be little to no user interaction. The idea is that a user clicks a button in Language Depot (in the browser) and FLEx opens and clones the project. There is a dialog that FLEx pops up (since it's what gets invoked by the protocol handler) which would prompt the user "Download Sena 3 from LanguageDepot.org?" as a security precaution (any website could invoke the protocol handler and we don't want FLEx to download stuff off the internet automatically without user permission). We could skip the dialog for authorized domains (such as LanguageDepot) but prompt for unexpected domains. I don't want to block unknown domains because it would be useful for testing, or if someone wanted to self host language depot.

papeh · 2023-10-05T15:01:38Z

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs

+		/// <param name="username">Username for Mercurial authentication</param>
+		/// <param name="password">Password for Mercurial authentication</param>
+		/// <param name="projectFolder">The parent directory to put the clone in</param>
+		/// <param name="projectName">Name of the project to clone</param>


How about: "Name for the project on the local machine"?

When I read, "Project to clone," I think of the name on the server.

papeh · 2023-10-05T15:40:31Z

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs

+		/// <param name="projectName">Name of the project to clone</param>
+		/// <param name="projectUri">URI where the project can be found</param>
+		/// </summary>
+		public static GetCloneFromInternetDialog StartClone(string username, string password, string projectFolder, string projectName, Uri projectUri)


CloneResult would be a better return type; the client shouldn't have to dig figure out what happened. Since that would make this method handle the whole process, it should be renamed to DoClone

I'm concerned about removing the Form return result, at first glance. FB needs to provide Application.Run() with something to keep from moving on immediately. Maybe it's just as simple as moving that call in here? I'll look into it. Edit: Everything hunky-dory!

papeh · 2023-10-05T16:08:16Z

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs

+		/// <param name="projectName">Name of the project to clone</param>
+		/// <param name="projectUri">URI where the project can be found</param>
+		/// </summary>
+		public static GetCloneFromInternetDialog StartClone(string username, string password, string projectFolder, string projectName, Uri projectUri)


Nitpicking: This dialog seems kind of a funny place for this method. I'd consider GetSharedProjectModel or even a new class.

If you'd like me to move it, let me know where. (It doesn't matter too much to me.) I put it here, because it needs the model and dialog, both of which are present here. But its being static now makes separation easier

papeh · 2023-10-05T16:13:43Z

CHANGELOG.md

@@ -19,6 +19,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 ### Added

 - [SIL.Chorus.LibChorus] Add webm as additional audio file type
+- [SIL.Chorus] Add ability to clone project without direct user interaction


"without user interaction": there's no indirect interaction, either.

In my mind, the indirect user interaction is them using the wrapping software. They still have to do something to get the clone to happen.

josephmyers · 2023-10-06T00:44:08Z

@papeh @jasonleenaylor If there are things you'd like done to these PR's, especially comments that are minor or don't affect the code itself, feel free to do those. I'm not strongly opinionated on the vast majority of this. Doing so would avoid a not less than 24hr communication cycle time. But I also know you guys are super busy, so I'm more than happy to do them as soon as I can. Whatever I can do to help things along. (Sometimes it takes longer to make the comment than to make the change 😄)

josephmyers · 2023-10-06T04:03:22Z

@papeh I did your first two comments and will wait for more guidance on the second two. Let me know what you think. Thanks

papeh

Reviewed 1 of 2 files at r4, 1 of 1 files at r5, all commit messages.
Dismissed @hahn-kev and @papeh from 2 discussions.
Reviewable status: all files reviewed, 3 unresolved discussions (waiting on @hahn-kev, @jasonleenaylor, and @josephmyers)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 276 at r3 (raw file):

Previously, papeh wrote…

I think the public method would make more sense as a static method to

create a GetCloneFromInternetModel from the arguments

create a GetCloneFromInternetDialog from the model

StartClone(); with no arguments

Done

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 127 at r5 (raw file):

			Application.Run(dialog);

			var cloneStatus = res == DialogResult.OK ? CloneStatus.Created : CloneStatus.NotCreated;

see GetSharedProjectModel for more robust CloneStatus parsing

papeh

Reviewed 4 of 4 files at r6, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @hahn-kev and @jasonleenaylor)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 277 at r4 (raw file):

Previously, josephmyers wrote…

If you'd like me to move it, let me know where. (It doesn't matter too much to me.) I put it here, because it needs the model and dialog, both of which are present here. But its being static now makes separation easier

I considered moving it but didn't bother:

StartClone can stay private (instead of internal)
DoClone is clearly specific to Internet clones (although that would be apparent from the args, as neither CH nor USB take credentials)

josephmyers · 2023-10-09T14:38:15Z

Looking good to me. Always a fan of making things simpler!

papeh

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @hahn-kev, @jasonleenaylor, and @josephmyers)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 306 at r6 (raw file):

					return;
				UpdateDisplay(State.MakingClone);
				_model.SaveUserSettings();

Is it a problem that the passed bearer:token will overwrite the user's saved credentials, if any?

josephmyers · 2023-10-12T01:43:59Z

Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @hahn-kev, @jasonleenaylor, and @josephmyers)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 306 at r6 (raw file):
					return;
				UpdateDisplay(State.MakingClone);
				_model.SaveUserSettings();
Is it a problem that the passed bearer:token will overwrite the user's saved credentials, if any?

@hahn-kev

hahn-kev · 2023-10-12T02:53:27Z

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 306 at r6 (raw file):

Previously, josephmyers wrote…

@hahn-kev

the token can be used for any project the user has access to, so it should be ok. @jasonleenaylor we can talk about this next time we chat if you want.

You certainly don't want to leave it just like this, but it's a start for an idea. You could add a flag to the method, or potentially interpret automatically from the existing inputs. Or you could change the ServerSettingsModel.

josephmyers

Reviewable status: 4 of 5 files reviewed, 1 unresolved discussion (waiting on @hahn-kev, @jasonleenaylor, and @papeh)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 306 at r6 (raw file):

Previously, hahn-kev (Kevin Hahn) wrote…

the token can be used for any project the user has access to, so it should be ok. @jasonleenaylor we can talk about this next time we chat if you want.

Good catch, Hasso. I submitted a PoC hack to demonstrate reverting user/pass, though we'd want some sophistication if we went this route. Kevin also mentioned extending JWT lifecycles and various other tricks you can do with them.

josephmyers

Reviewable status: 4 of 5 files reviewed, 1 unresolved discussion (waiting on @hahn-kev, @jasonleenaylor, and @papeh)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 306 at r6 (raw file):

Previously, josephmyers wrote…

Good catch, Hasso. I submitted a PoC hack to demonstrate reverting user/pass, though we'd want some sophistication if we went this route. Kevin also mentioned extending JWT lifecycles and various other tricks you can do with them.

Kevin just mentioned that we would probably only want to revert, if at all, if we have something to revert back to.

papeh

Reviewed 1 of 1 files at r7, 1 of 1 files at r9, all commit messages.
Reviewable status: all files reviewed, 1 unresolved discussion (waiting on @hahn-kev and @jasonleenaylor)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 306 at r6 (raw file):

Previously, josephmyers wrote…

Kevin just mentioned that we would probably only want to revert, if at all, if we have something to revert back to.

Thanks for clarifying. Even if the token works, users would be confused if they see 'bearer' instead of their username in the Chorus settings dialog.

We want to give callers the option to revert, e.g. if they know the user/pass is JWT, but default it to saving them.

josephmyers

Reviewable status: 4 of 5 files reviewed, 1 unresolved discussion (waiting on @hahn-kev, @jasonleenaylor, and @papeh)

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs line 306 at r6 (raw file):

Previously, papeh wrote…

Thanks for clarifying. Even if the token works, users would be confused if they see 'bearer' instead of their username in the Chorus settings dialog.

True! So I'm fine reverting it all the time, to prevent that. I cleaned it up. Let me know what you think

papeh

Reviewed 1 of 1 files at r11, all commit messages.
Reviewable status: complete! all files reviewed, all discussions resolved (waiting on @hahn-kev and @jasonleenaylor)

Added public StartClone() option

f49d876

This is necessary so that flexbridge can supply required cloning information and start a repo download without direct/manual user input. This order will come from Fieldworks when launched from CMD or protocol handler with the proper arguments.

jasonleenaylor reviewed Sep 28, 2023

View reviewed changes

hahn-kev reviewed Sep 29, 2023

View reviewed changes

src/Chorus/UI/Clone/GetCloneFromInternetDialog.cs Outdated Show resolved Hide resolved

Split project name from URI to its own param

ad42833

+semver:major

josephmyers requested review from jasonleenaylor and hahn-kev September 29, 2023 02:43

Using full URI to pass to Mercurial

0f884e8

This gives us more flexibility (less security) for changing URI structure.

ermshiperete added the api change label Sep 29, 2023

papeh reviewed Sep 29, 2023

View reviewed changes

papeh changed the title ~~Added public StartClone() option~~ Add public StartClone() option Oct 4, 2023

papeh changed the title ~~Add public StartClone() option~~ Add public StartClone() method Oct 4, 2023

Made the method static

0baa937

josephmyers requested a review from papeh October 5, 2023 07:45

Updated changelog

31df94d

papeh requested changes Oct 5, 2023

View reviewed changes

Moved all caller operations into the method

6d98401

josephmyers requested a review from papeh October 6, 2023 04:02

papeh requested changes Oct 6, 2023

View reviewed changes

papeh added 2 commits October 6, 2023 17:07

Centralise CloneResult generation and simplify DoClone

45ba1ef

Simplify GetSharedProjectModel.GetResult

57ce434

papeh reviewed Oct 6, 2023

View reviewed changes

papeh requested changes Oct 9, 2023

View reviewed changes

Add public GCFInternetDlg.ConfirmAndDoClone

448125f

Pass URI as a string to match other ServerSettingsModel

dd31a7e

Revert user/pass after clone

2f15202

You certainly don't want to leave it just like this, but it's a start for an idea. You could add a flag to the method, or potentially interpret automatically from the existing inputs. Or you could change the ServerSettingsModel.

josephmyers commented Oct 12, 2023

View reviewed changes

papeh requested changes Oct 12, 2023

View reviewed changes

Revert in finally block and behind optional flag

6e7c775

We want to give callers the option to revert, e.g. if they know the user/pass is JWT, but default it to saving them.

josephmyers commented Oct 13, 2023

View reviewed changes

Added flag for the other method, as well

473c798

papeh approved these changes Oct 13, 2023

View reviewed changes

papeh merged commit c1b1e6c into master Oct 13, 2023
5 checks passed

papeh deleted the StartClone branch October 13, 2023 14:33

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add public StartClone() method #325

Add public StartClone() method #325

josephmyers commented Sep 28, 2023 •

edited by jasonleenaylor

Loading

github-actions bot commented Sep 28, 2023 •

edited

Loading

jasonleenaylor left a comment

ermshiperete commented Sep 29, 2023

papeh commented Sep 29, 2023

papeh Sep 29, 2023

hahn-kev commented Oct 2, 2023

papeh Oct 5, 2023

josephmyers Oct 6, 2023

papeh Oct 5, 2023

josephmyers Oct 6, 2023 •

edited

Loading

papeh Oct 5, 2023

josephmyers Oct 6, 2023

papeh Oct 5, 2023

josephmyers Oct 6, 2023

josephmyers commented Oct 6, 2023

josephmyers commented Oct 6, 2023

papeh left a comment

papeh left a comment

josephmyers commented Oct 9, 2023

papeh left a comment

josephmyers commented Oct 12, 2023

hahn-kev commented Oct 12, 2023

josephmyers left a comment

josephmyers left a comment

papeh left a comment

josephmyers left a comment

papeh left a comment

Add public StartClone() method #325

Add public StartClone() method #325

Conversation

josephmyers commented Sep 28, 2023 • edited by jasonleenaylor Loading

github-actions bot commented Sep 28, 2023 • edited Loading

Test Results

jasonleenaylor left a comment

Choose a reason for hiding this comment

ermshiperete commented Sep 29, 2023

papeh commented Sep 29, 2023

Choose a reason for hiding this comment

hahn-kev commented Oct 2, 2023

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

josephmyers Oct 6, 2023 • edited Loading

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

josephmyers commented Oct 6, 2023

josephmyers commented Oct 6, 2023

papeh left a comment

Choose a reason for hiding this comment

papeh left a comment

Choose a reason for hiding this comment

josephmyers commented Oct 9, 2023

papeh left a comment

Choose a reason for hiding this comment

josephmyers commented Oct 12, 2023

hahn-kev commented Oct 12, 2023

josephmyers left a comment

Choose a reason for hiding this comment

josephmyers left a comment

Choose a reason for hiding this comment

papeh left a comment

Choose a reason for hiding this comment

josephmyers left a comment

Choose a reason for hiding this comment

papeh left a comment

Choose a reason for hiding this comment

josephmyers commented Sep 28, 2023 •

edited by jasonleenaylor

Loading

github-actions bot commented Sep 28, 2023 •

edited

Loading

josephmyers Oct 6, 2023 •

edited

Loading