Implement WindowsFormsApplicationBase.IsSingleInstance #3200

cston · 2020-05-04T04:18:16Z

Fixes #2056
Fixes #3131

Proposed changes

Implement support for WindowsFormsApplicationBase single-instance behavior.

Customer Impact

Allows applications using the VisualBasic application model to opt-in to single-instance behavior.

Regression?

Not implemented when porting Microsoft.VisualBasic to .NET Core previously.

Risk

Medium risk when opted-in; low risk otherwise.

Test methodology

Unit tests.

Microsoft Reviewers: Open in CodeFlow

...sualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb

paul1956 · 2020-05-05T01:46:04Z

...sualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb

This is not the current Framework behavior. 2 files are considered the same if they only vary by last 2 version fields.

For projects coming from Framework the developer through VS creates the base value and VB runtime adds 2 additional version strings. If a project is still in Framework and runs on top of Core this behavior will change.

Using Entry.ManifestModule.ModuleVersionId.ToString() will make the Debug and Release version of the same source app different.

Logged #3296.

In reply to: 419828791 [](ancestors = 419828791)

paul1956 · 2020-05-05T01:48:02Z

...sualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb

It would be better if this were overridable so developers can select am appropriate algorithm with this being the default.

RussKie

Looks great 👍

...oft.VisualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/SingleInstanceHelpers.vb

...sualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb

...oft.VisualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/SingleInstanceHelpers.vb

cston · 2020-05-15T22:44:31Z

cc @KathleenDollard

...oft.VisualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/SingleInstanceHelpers.vb

jaredpar · 2020-05-15T23:32:13Z

...oft.VisualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/SingleInstanceHelpers.vb

+                    If nRead = 0 Then
+                        Exit While
+                    End If
+                    stream.Write(buffer, 0, nRead)


Consider WriteAsync here since this is already an Async method. #ByDesign

The stream here is a MemoryStream rather than the NamedPipeServerStream.

In reply to: 426088068 [](ancestors = 426088068)

codecov · 2020-05-16T00:39:18Z

Codecov Report

Merging #3200 into master will increase coverage by 29.77013%.
The diff coverage is n/a.

@@                 Coverage Diff                  @@
##              master       #3200          +/-   ##
====================================================
+ Coverage   33.28961%   63.05974%   +29.77012%     
====================================================
  Files            883        1310         +427     
  Lines         253893      466288      +212395     
  Branches       36741       39798        +3057     
====================================================
+ Hits           84520      294040      +209520     
- Misses        164586      166853        +2267     
- Partials        4787        5395         +608

Flag	Coverage Δ
#Debug	`63.05974% <ø> (+29.77012%)`	⬆️
#production	`33.31482% <ø> (+0.02520%)`	⬆️
#test	`98.61626% <ø> (?)`

...sualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb

jaredpar · 2020-05-26T19:40:54Z

...oft.VisualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/SingleInstanceHelpers.vb

+                    If bytesRead = 0 Then
+                        Exit While
+                    End If
+                    stream.Write(buffer, 0, bytesRead)


Suggested change

stream.Write(buffer, 0, bytesRead)

Await stream.WriteAsync(buffer, 0, bytesRead).ConfigureAwait(false)

``` #ByDesign

stream in this case is a MemoryStream so Write() should be equivalent to WriteAsync().

In reply to: 430663031 [](ancestors = 430663031)

RussKie · 2020-05-26T23:35:51Z

...VisualBasic/tests/UnitTests/Microsoft/VisualBasic/ApplicationServices/SingleInstanceTests.cs

+            }
+        }
+
+        // Should be able to test internal methods with [InternalsVisibleTo] rather than reflection.


We're actually moving in the opposite direction - prefer reduce "internal" API surface (if it is only used for tests) and use reflection instead.
#3225

RussKie · 2020-05-26T23:39:09Z

...tegrationTests/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBaseTests.cs

+            TestHelpers.EndProcess(process0, timeout: 1000);
+            TestHelpers.EndProcess(process1, timeout: 1000);
+            Assert.True(process0.HasExited);
+            Assert.True(process1.HasExited);


Should we test that process1 exited on his own accord before trying to close it?

RussKie · 2020-05-26T23:40:42Z

@msftbot merge if @jaredpar approves

RussKie · 2020-05-27T22:49:55Z

Thank you @cston @jaredpar

ghost assigned cston May 4, 2020

paul1956 reviewed May 5, 2020

View reviewed changes

...sualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb Outdated Show resolved Hide resolved

paul1956 reviewed May 5, 2020

View reviewed changes

RussKie reviewed May 13, 2020

View reviewed changes

cston force-pushed the SingleInstance branch from e6440a7 to fdd6101 Compare May 13, 2020 18:09

jaredpar reviewed May 15, 2020

View reviewed changes

cston added 3 commits May 15, 2020 11:46

Implement WindowsFormsApplicationBase.IsSingleInstance

f873dbe

More tests

a88008f

PR feedback

8d99319

cston force-pushed the SingleInstance branch from fdd6101 to 8d99319 Compare May 15, 2020 18:48

cston marked this pull request as ready for review May 15, 2020 22:33

cston requested a review from a team as a code owner May 15, 2020 22:33

jaredpar reviewed May 15, 2020

View reviewed changes

PR feedback

ad94d07

RussKie reviewed May 19, 2020

View reviewed changes

...sualBasic.Forms/src/Microsoft/VisualBasic/ApplicationServices/WindowsFormsApplicationBase.vb Outdated Show resolved Hide resolved

jaredpar previously approved these changes May 26, 2020

View reviewed changes

PR feedback

77ae8e6

cston dismissed jaredpar’s stale review via 77ae8e6 May 26, 2020 21:18

Fix build

213c285

RussKie reviewed May 26, 2020

View reviewed changes

RussKie approved these changes May 26, 2020

View reviewed changes

ghost added the automerge label May 26, 2020

dotnet deleted a comment May 26, 2020

jaredpar approved these changes May 27, 2020

View reviewed changes

ghost merged commit 7ccf509 into dotnet:master May 27, 2020

cston deleted the SingleInstance branch May 27, 2020 20:12

RussKie added this to the 5.0 Preview6 milestone May 27, 2020

cston mentioned this pull request Jun 12, 2020

Test WindowsFormsApplicationBase.GetApplicationInstanceID #3433

Merged

zanchey mentioned this pull request Aug 10, 2020

WindowsFormsApplicationBase.IsSingleInstance applications are global on a machine, not per user #3715

Open

ghost locked as resolved and limited conversation to collaborators Feb 1, 2022

This pull request was closed.

	stream.Write(buffer, 0, bytesRead)
	Await stream.WriteAsync(buffer, 0, bytesRead).ConfigureAwait(false)
	``` #ByDesign

Implement WindowsFormsApplicationBase.IsSingleInstance #3200

Implement WindowsFormsApplicationBase.IsSingleInstance #3200

Uh oh!

Conversation

cston commented May 4, 2020 • edited by RussKie Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Proposed changes

Customer Impact

Regression?

Risk

Test methodology

Microsoft Reviewers: Open in CodeFlow

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RussKie left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

cston commented May 15, 2020

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jaredpar May 15, 2020 • edited by cston Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

codecov bot commented May 16, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

Uh oh!

jaredpar May 26, 2020 • edited by cston Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

RussKie commented May 26, 2020

Uh oh!

RussKie commented May 27, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

cston commented May 4, 2020 •

edited by RussKie

Loading

jaredpar May 15, 2020 •

edited by cston

Loading

codecov bot commented May 16, 2020 •

edited

Loading

jaredpar May 26, 2020 •

edited by cston

Loading