OpenSuse Tumbleweed - azure-cli-telemetry doesn't support python311-portalocker in version 3 and above

[martinspudich]

Describe the bug

When I'm trying to update my system via sudo zypper dup I'm getting an error with python311-portalocker version issue.

Please update azure-cli-telemetry to work with azure-cli-telemetry version 3 and above.

Related command

sudo zypper dup
Loading repository data...
Reading installed packages...
Warning: You are about to do a distribution upgrade with all enabled repositories. Make sure these repositories are compatible before you continue. See 'man zypper' for more information about this command.
Computing distribution upgrade...

Problem: 1: the installed azure-cli-telemetry-1.1.0-3.1.noarch requires 'python311-portalocker < 3.0', but this requirement cannot be provided
deleted providers: python311-portalocker-2.10.1-1.2.noarch

Solution 1: Following actions will be done:
deinstallation of azure-cli-telemetry-1.1.0-3.1.noarch
deinstallation of azure-cli-core-2.66.0-1.1.noarch
deinstallation of azure-cli-2.66.0-1.1.noarch
Solution 2: keep obsolete python311-portalocker-2.10.1-1.2.noarch
Solution 3: break azure-cli-telemetry-1.1.0-3.1.noarch by ignoring some of its dependencies

Errors

Problem: 1: the installed azure-cli-telemetry-1.1.0-3.1.noarch requires 'python311-portalocker < 3.0', but this requirement cannot be provided
deleted providers: python311-portalocker-2.10.1-1.2.noarch

Issue script & Debug output

sudo zypper dup
Loading repository data...
Reading installed packages...
Warning: You are about to do a distribution upgrade with all enabled repositories. Make sure these repositories are compatible before you continue. See 'man zypper' for more information about this command.
Computing distribution upgrade...

Problem: 1: the installed azure-cli-telemetry-1.1.0-3.1.noarch requires 'python311-portalocker < 3.0', but this requirement cannot be provided
deleted providers: python311-portalocker-2.10.1-1.2.noarch

Solution 1: Following actions will be done:
deinstallation of azure-cli-telemetry-1.1.0-3.1.noarch
deinstallation of azure-cli-core-2.66.0-1.1.noarch
deinstallation of azure-cli-2.66.0-1.1.noarch
Solution 2: keep obsolete python311-portalocker-2.10.1-1.2.noarch
Solution 3: break azure-cli-telemetry-1.1.0-3.1.noarch by ignoring some of its dependencies

Expected behavior

Resolving the package version conflict.

Environment Summary

az --version
azure-cli 2.66.0 *

core 2.66.0 *
telemetry 1.1.0

Dependencies:
msal 1.31.0
azure-mgmt-resource 23.2.0

Python location '/usr/bin/python3.11'
Extensions directory '/home/bliker/.azure/cliextensions'

Python (Linux) 3.11.10 (main, Sep 09 2024, 17:03:08) [GCC]

Legal docs and information: aka.ms/AzureCliLegal

Additional context

No response

[azure-client-tools-bot-prd]

Hi @martinspudich,

2.66.0 is not the latest Azure CLI(2.67.0).

If you haven't already attempted to do so, please upgrade to the latest Azure CLI version by following https://learn.microsoft.com/en-us/cli/azure/update-azure-cli.

[yonzhan]

Thank you for opening this issue, we will look into it.

[evelyn-ys]

cc @jiasl @rayluo for awareness. msal-extensions is also restricting portalocker<3: https://github.com/AzureAD/microsoft-authentication-extensions-for-python/blame/ba841e60dc2a8e23a1ce16bb87e8c3a75ee5b9a4/setup.py#L23

[rayluo]

cc @jiasl @rayluo for awareness. msal-extensions is also restricting portalocker<3

We set that upper bound because msal-extensions was developed in portalocker 1.x & 2.x era. We haven't looked into portalocker 3.x since then. Azure CLI may consider helping us test the without-portalocker approach.

[bebound]

I've used AzureAD/microsoft-authentication-extensions-for-python#117 in CLI on SAW 2.55.0 and it works.

[rayluo]

I've used AzureAD/microsoft-authentication-extensions-for-python#117 in CLI on SAW 2.55.0 and it works.

@bebound Thanks for the promising feedback! You also brought up a good point on SAW. I am not even sure whether the portalocker was allowed on SAW, and if not, how the previous versions of AzureCLI + MsalExtensions + Portalocker combination worked (or, did they?). Regardless, this becomes yet another good reason to trim down that dependency.

@jiasli , do we want this change to be in one of upcoming Azure CLI releases?

[bebound]

Portalocker is prohibited on SAW. I've used this PR's msal-extension without portalocker since the initial release of SAW version 2.40.0.

PS: I used to create my own msal-extension with a dummy lock, but we had a meeting, and you provide this official portalocker-free version. It works well.

[rayluo]

I've used this PR's msal-extension without portalocker since the initial release of SAW version 2.40.0.

@bebound, when was that Azure CLI 2.40.0 released? Was it in September 2022?

Sorry I don't quite remember our meeting. Did you mean you used/tested that portalocker-less msal-extension for 2+ years already?

[bebound]

CLI on SAW is an internal version. It's been released for two years, and we haven't received any bug report related to msal. At least it works for the SAW version.

I assume dropping portalocker causes issues in high concurrency environments?

[rayluo]

I assume dropping portalocker causes issues in high concurrency environments?

No. Because that PR does not simply drop portalocker. It also uses a replacement locking mechanism without external dependencies.

CLI on SAW is an internal version. It's been released for two years, and we haven't received any bug report related to msal. At least it works for the SAW version.

Thanks for the much-awaited confirmation! I'll merge that PR in, then.