Headless mode when calling VIPM through the API

[Joerg Hampel]

When using VIPM via its API on our build servers, we're running into problems every now and then with popups VIPM displays for any updates available. The popups will block the process and finally lead to a failing pipeline (timeout).

While this can be worked around or avoided by disabling update checks in VIPM's options...

...it would be so much nicer if there was a true headless mode. That way, forgetting to configure VIPM as above would not result in timeout errors. Also, there might be other popups which can not be avoided through the current configuration options.

Maybe this headless mode could be automatically invoked when starting VIPM from the API, or be made accessible through an API endpoint (turn on/off).

 

[Jim Kring]

@Joerg Hampel great ideas!

One question that came to mind is about which API a method is being called and whether it’s being called with the quiet/silent argument was set to TRUE.

The intended behavior is that the quiet/silent argument will suppress all dialogs. However, it’s totally possible that some of these dialogs may have slipped through the cracks — that would be a bug.

Thanks,

Jim

[Joerg Hampel]

I was not aware of the silent argument! Here is the part of our code that starts VIPM if it's not running already:

How or where would we invoke the silent argument? Or is it built into the Open VIPM API call?

And as I'm looking at this, I imagine it could happen that a user opens VIPM manually, which would probably result in VIPM running without said argument. Would it be possible to switch the "silent mode" on via API while VIPM is already running?

[Jim Kring]

The "quiet?" argument is only exposed on some of the VIPM API calls -- it probably needs to be exposed on more/all of them.

Let me know if you need help solving your specific use case.  We're working on improvements to the API and CLI...

[Joerg Hampel]

Now that you point it out, I see those "quiet?" inputs. Thanks for pointing that out!

I can see the "quiet" input for the "Apply VIPC File" endpoint, but not for "Build Package" (and others, like you said).  

Seeing as it takes quite some time to start up VIPM, we implemented our tools to check if it's running (and start it if not), but not to exit it after finishing. That way, the next pipeline run should be faster as it doesn't need to start VIPM again. The problem here is: If a user starts VIPM on the build server manually, and it's not configured to not check for updates, there's probably not much we can do from our tools after the fact (ie after VIPM has been started).

Unless there was an API endpoint for enabling the "quiet" mode globally for all of VIPM. Or would it be possible to add an API endpoint for disabling the check for package and VIPM updates? I think that would be best for our specific use case.

Edited June 28, 2022 by Joerg Hampel

[Jim Kring]

I'm wondering if it would make sense for your build tools to check and set the appropriate keys in VIPM's settings file?

C:\ProgramData\JKI\VIPM\Settings.ini

[General]
check for updates on startup?="FALSE"
Check new ver. of App. on startup?="FALSE"

You could check these and set them, prior to launching VIPM (when you detect that VIPM is not already running).

Something like this:

[Joerg Hampel]

Jim, that will be good enough for us   Thank you!

I've created an issue. Once we get around to implement and test this, I'll update this thread with our findings (if any).