msi: guard duplicated instance (not adding a new option)

[daipom]

Abstraction

• Partially (msi) solves #611
• Inspired by #622
  • This is another version that does not add a new option and considers some options to skip checking duplicate launches.
• Both #622 and this can be a solution to #611
  • Let's consider how to solve it based on the information so far.

Spec change

Before:

We can launch Fluentd by fluentd.bat even though fluentdwinsvc is running. Launching multiple Fluentd with the same config may cause inconsistency of the buffers or the pos files.

After:

We can't launch Fluentd by fluent.bat with the default config path if fluentdwinsvc is running. If one of the following options is specified, we can execute fluentd.bat as before.

• --config (-c)
• --dry-run
• --reg-winsvc
• --reg-winsvc-fluentdopt

Output

When the fluentdwinsvc is running, the behavior of fluentd.bat is as follows:

> fluentd
Error: Can't start duplicate Fluentd instance with the default config.

To start Fluentd, please do one of the following:
  (Caution: Please be careful not to start multiple instances with the same config.)
  - Stop the Fluentd Windows service 'fluentdwinsvc'.
  - Specify the config path explicitly by '-c' ('--config').

> fluentd -v
Error: Can't start duplicate Fluentd instance with the default config.

To take the version, please use '--version', not '-v' ('--verbose').

To start Fluentd, please do one of the following:
  (Caution: Please be careful not to start multiple instances with the same config.)
  - Stop the Fluentd Windows service 'fluentdwinsvc'.
  - Specify the config path explicitly by '-c' ('--config')

[daipom]

The msi installer is broken. I'm checking the cause.

[daipom]

Why is fluentdwinsvc service running during the installation?? The installer may not be behaving correctly in the first place. => This is no problem. StartServices action looks unnecessary, but it is harmless because the service is not registered at that point.

However, #622 does not have this problem. I wander what the difference is. => delayed expansion: https://github.com/fluent/fluent-package-builder/pull/648#discussion_r1654227872

msi.log

...
Action start 15:02:23: WriteEnvironmentStrings.
WriteEnvironmentStrings: Name: Updating environment strings, Value: , Action 
Action ended 15:02:23: WriteEnvironmentStrings. Return value 1.
Action 15:02:23: StartServices. Starting services
Action start 15:02:23: StartServices.
Action ended 15:02:23: StartServices. Return value 1.
Action 15:02:23: RegisterUser. Registering user
Action start 15:02:23: RegisterUser.
Action ended 15:02:23: RegisterUser. Return value 1.
Action 15:02:23: RegisterProduct. Registering product
Action start 15:02:23: RegisterProduct.
RegisterProduct: Registering product
Action ended 15:02:23: RegisterProduct. Return value 1.
Action 15:02:23: PublishFeatures. Publishing Product Features
Action start 15:02:23: PublishFeatures.
PublishFeatures: Feature: Publishing Product Features
Action ended 15:02:23: PublishFeatures. Return value 1.
Action 15:02:23: PublishProduct. Publishing product information
Action start 15:02:23: PublishProduct.
PublishProduct: 
Action ended 15:02:23: PublishProduct. Return value 1.
Action 15:02:23: SetCreateCompatTdAgentBat. 
Action start 15:02:23: SetCreateCompatTdAgentBat.
Action ended 15:02:23: SetCreateCompatTdAgentBat. Return value 1.
Action 15:02:23: CreateCompatTdAgentBat. 
Action start 15:02:23: CreateCompatTdAgentBat.
CreateCompatTdAgentBat: 
Action ended 15:02:23: CreateCompatTdAgentBat. Return value 1.
Action 15:02:23: SetCreateCompatTdAgentGemBat. 
Action start 15:02:23: SetCreateCompatTdAgentGemBat.
Action ended 15:02:23: SetCreateCompatTdAgentGemBat. Return value 1.
Action 15:02:23: CreateCompatTdAgentGemBat. 
Action start 15:02:23: CreateCompatTdAgentGemBat.
CreateCompatTdAgentGemBat: 
Action ended 15:02:23: CreateCompatTdAgentGemBat. Return value 1.
Action 15:02:23: InstallFinalize. 
Action start 15:02:23: InstallFinalize.
Action 15:02:23: ProcessComponents. Updating component registration
Action 15:02:27: CreateFolders. Creating folders
CreateFolders: Folder: C:\opt\fluent\
Action 15:02:27: InstallFiles. Copying new files
Action 15:02:44: InstallFluentdWinSvc. 
WixQuietExec64:  Error: Can't start duplicate Fluentd instance with the default config.
WixQuietExec64:  
WixQuietExec64:  To start Fluentd, please do one of the following:
WixQuietExec64:    (Caution: Please be careful not to start multiple instances with the same config.)
WixQuietExec64:    - Stop the Fluentd Windows service 'fluentdwinsvc'.
WixQuietExec64:    - Specify the config path explicitly by '-c' ('--config').
WixQuietExec64:  Error 0x80070002: Command line returned an error.
WixQuietExec64:  Error 0x80070002: QuietExec64 Failed
WixQuietExec64:  Error 0x80070002: Failed in ExecCommon method
CustomAction InstallFluentdWinSvc returned actual error code 1603 (note this may not be 100% accurate if translation happened inside sandbox)
Action ended 15:02:44: InstallFinalize. Return value 3.
Action 15:02:44: Rollback. Rolling back action:
Rollback: InstallFluentdWinSvc
...

[daipom]

The msi installer is broken. I'm checking the cause.

This problem is resolved. However, some test problems remains. I'm fixing them. => Fixed.

[kenhys]

This approach may be better than #622.

[daipom]

Rebased to #647 as #647 got some changes.

[daipom]

This approach may be better than #622.

Thanks for considering. If we need a force execution option or a strict check whether the config path is the same in the future, let's revive #622!

[kenhys]

As #647 was merged into master, let's rebase with it.

[daipom]

As #647 was merged into master, let's rebase with it.

Done!

[kenhys]

Let's merge when all ci has passed.

[daipom]

Thanks for your review!

[daipom]

Can we put this in v5.0.4?

[kenhys]

Can we put this in v5.0.4?

This should be released in v5.0.4 IMHO.

[daipom]

Refactored the variable name NEED_DUPLICATE_LAUNCH_CHECK -> PREVENT_DUPLICATE_LAUNCH