kiota-lock.json changes depending on OS

[bkoelman]

Depending on the operating system on which Kiota is run, the direction of slashes changes in kiota-lock.json. In mixed teams, this results in constant pending changes to this file.

On Windows:

"descriptionLocation": "..\\..\\JsonApiDotNetCoreExample\\GeneratedSwagger\\JsonApiDotNetCoreExample.json",

On Ubuntu:

"descriptionLocation": "../../JsonApiDotNetCoreExample/GeneratedSwagger/JsonApiDotNetCoreExample.json",

Our case is worse, because it breaks the build. We run a tool in cibuild that verifies code style on different platforms, and it never succeeds because of this. Where success is defined as: build the code, run an automated reformat, then fail the build if this resulted in uncommitted git changes.

[baywet]

Hi @bkoelman,
Thanks for reporting this.
The normalization of the path before it gets written down happens here.

kiota/src/Kiota.Builder/Lock/LockManagementService.cs

Line 78 in 0495a00

lockInfo.DescriptionLocation = GetRelativeDescriptionPath(lockInfo.DescriptionLocation, lockFilePath);

And you can add unit tests in this class.

kiota/tests/Kiota.Builder.Tests/Lock/LockManagementServiceTests.cs

Line 39 in 0495a00

public async Task UsesRelativePaths()

Do you think you'd be able to send a pull request to correct this issue?

[bkoelman]

Not anytime soon, I'm pretty occupied with other work at the moment.

[diegosasw]

I've experienced this problem.
In Windows, I generate code out of a local open api document located at a folder .openapi/openapi.json which is at the solution folder level.
Example:

dotnet kiota generate -l CSharp -o src/Foo/Api -c MyClient -n Foo.Api -d .openapi/openapi.json

This stores the following path in kiota-lock.json:

"descriptionLocation": "..\\..\\..\\.openapi\\openapi.json"

Notice it's Windows style path.

During CI/CD in Github Actions (ubuntu runner), this causes problems because I have a job step doing something like this:

- name: Update SDK
  run: dotnet kiota update -o src/Foo/Api

and this will complain about

crit: Kiota.Builder.KiotaBuilder[0]
      error updating the client: Could not open the file at /home/runner/work/my-repo/my-repo/src/Foo/Api/..\..\..\.openapi\openapi.json, reason: Could not find file '/home/runner/work/my-repo/my-repo/src/Foo/Api/..\..\..\.openapi\openapi.json'.

Workaround

My current workaround is to manually edit kiota-lock.json to set the relative path in Unix style

"descriptionLocation": "../../../.openapi\\openapi.json"

This fixes the problem in GitHub Actions and it seems to keep working locally on my Windows, at least when using dotnet CLI

dotnet kiota update -o src/Foo/Api

I'm not completely sure if using Unix style path always regardless of the OS would be the proper fix, as I don't know the risk with some other tooling.

But, just in case my scenario and workaround helps anyone.

[baywet]

@diegosasw Thanks for the additional information.
Windows has supported UNIX style paths for a while now and it'd probably be safe to normalize everything to forward slashes.