Troubleshoot local shell plugin hanging

[rh0dy]

Hey, I'm after a bit of help please? I use a local dev CLI tool called fooctl, it simplifies my interactions with cloud resources. To use fooctl, I must provide a credentials file at ~/.fooctl/credentials. The credentials file expects a UUID and Token (I guess in the ini format, e.g. UUID = "4191234b-foo5-4bar-af3f-3d8266111d8b").

I followed the tutorial, but I'm getting stuck - literally.

My plugin validates & builds fine. It's also successfully looking for & importing the UUID and Token in 1Password when a credentials file already exists.

However, it hangs when using any fooctl commands with an arg.

I'm running this on macOS 14.4.1 (23E224) from ~/dev/shell-plugins.

This is what happens when I run footctl without any args, works as expected:

% fooctl                                        
################################################################################
# WARNING: 'fooctl' is not from the official registry.                         #
# Only proceed if you are the developer of 'fooctl'.                           #
# Otherwise, delete the file at /Users/me/.config/op/plugins/local/fooctl.     #
################################################################################
Fooctl is a tool to ease working with applications, projects and infrastructure

Usage:
  fooctl [command]

... omitted help text

Now to use fooctl, I need to use the daemoncommand (which requires the credentials file):

% fooctl daemon                                                         
################################################################################
# WARNING: 'fooctl' is not from the official registry.                         #
# Only proceed if you are the developer of 'fooctl'.                           #
# Otherwise, delete the file at /Users/me/.config/op/plugins/local/fooctl.     #
################################################################################

... the command hangs
... ~/.fooctl/credentials is created but trying to open that also hangs

Interestingly, if I run fooctl configure (I thought I could avoid doing this as this is what the shell plugin creates), it gets a bit further. It creates the credentials file which I can open & see correct contents... but then hangs:

% fooctl configure
################################################################################
# WARNING: 'fooctl' is not from the official registry.                         #
# Only proceed if you are the developer of 'fooctl'.                           #
# Otherwise, delete the file at /Users/me/.config/op/plugins/local/fooctl.     #
################################################################################
To proceed with configuration you will need to either generate new credentials
or re-use an existing one that is still valid i.e. hasn't expired or hasn't been
revoked). To manage or view your credentials, visit:
https://localhost/fooctl-cli

Detected existing credentials, they are available as defaults.

What is your UUID?
Enter a value (Default is 5eae7028-1698-4045-9521-21580b4cddf1): 

What is your Token?
Enter a value (Default is sL+****): 

... the command hangs
... ~/.fooctl/credentials is created, can be opened & contains the correct credentials

Can you spot anything wrong in the code, or suggest ways to troubleshoot this?

[AndyTitu]

This is a know limitation of the shell plugins API: the app you are trying to provision must only read once from the provisioning file. If it reads 2 times, or attempts to write to the file then the provisioning will hang forever.

Background: We're using FIFO as a file abstraction to write secrets in order to provision to apps. FIFOs can only be read when they are open for write and when are only writing once to the FIFO in op . So when the app we provision reads a second time, or attempts to write to the FIFO then it will wait for the counterpart operation that comes from op , Just that op never responds.Ideally we could determine in advance what operations the app executes so op could respond appropriately for each. Unfortunately this is not possible unless we expose something in the Shell Plugins api to allow each app to define what the app reads and writes from the provisioning file.

[rh0dy]

Thanks for the heads up about this @AndyTitu, will take a look at what our app is doing!