podman-desktop icon indicating copy to clipboard operation
podman-desktop copied to clipboard

fix(patch): patched kubernetes/client-node package

Open gastoner opened this issue 5 months ago • 5 comments

What does this PR do?

Patches kubernetes/client-node package with revert of https://github.com/kubernetes-client/javascript/pull/2400/files

Screenshot / video of UI

What issues does this PR fix or reference?

Closes #12747

How to test this PR?

Try to create kind cluster and assert that you should no longer see error messages

  • [x] Tests are covering the bug fix or the new feature

gastoner avatar Jun 20 '25 08:06 gastoner

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

:loudspeaker: Thoughts on this report? Let us know!

codecov[bot] avatar Jun 20 '25 08:06 codecov[bot]

basde on this comment https://github.com/kubernetes-client/javascript/issues/2483#issuecomment-2990436313 It may be interesting to test patching the Objectserialier.ts file with:

- instance[attributeType.baseName] = ObjectSerializer.serialize(data[attributeType.name], attributeType.type, attributeType.format);
+ instance[attributeType.baseName] = ObjectSerializer.serialize(data[attributeType.baseName], attributeType.type, attributeType.format);

feloy avatar Jun 20 '25 09:06 feloy

📝 Walkthrough

"""

Walkthrough

The changes introduce a patch to the @kubernetes/client-node dependency, centralizing and refactoring the logic for determining Kubernetes object serialization types. The patch moves and enhances YAML serialization/deserialization utilities, ensuring that YAML manifests are parsed and loaded with accurate typing. In the kind extension, the dependency on @kubernetes/client-node is added along with the patch. The create-cluster.ts script is updated to use the new loadAllYaml utility for parsing ingress controller manifests, removing custom YAML tag handling and streamlining resource creation.

Assessment against linked issues

Objective Addressed Explanation
Fix validation error when creating kind cluster with Contour ingress controller (#12747)
Ensure correct YAML parsing and resource creation for ingress manifests (#12747)
Remove or update custom YAML tag handling to prevent incorrect parsing (#12747)

Assessment against linked issues: Out-of-scope changes

No out-of-scope changes were found. All modifications directly relate to the objectives in the linked issue, focusing on YAML parsing, serialization, and resource creation in the context of kind cluster setup with ingress controllers. """

[!WARNING] There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

extensions/kind/src/create-cluster.ts

Oops! Something went wrong! :(

ESLint: 9.29.0

Error [ERR_MODULE_NOT_FOUND]: Cannot find package 'svelte-eslint-parser' imported from /eslint.config.mjs at Object.getPackageJSONURL (node:internal/modules/package_json_reader:255:9) at packageResolve (node:internal/modules/esm/resolve:767:81) at moduleResolve (node:internal/modules/esm/resolve:853:18) at defaultResolve (node:internal/modules/esm/resolve:983:11) at ModuleLoader.defaultResolve (node:internal/modules/esm/loader:801:12) at #cachedDefaultResolve (node:internal/modules/esm/loader:725:25) at ModuleLoader.resolve (node:internal/modules/esm/loader:708:38) at ModuleLoader.getModuleJobForImport (node:internal/modules/esm/loader:309:38) at #link (node:internal/modules/esm/module_job:202:49)


📜 Recent review details

Configuration used: CodeRabbit UI Review profile: CHILL Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 5ea59e7668e7848d2f9b9dc098cb2ec9b089eebb and 70f1069d98419901de959fcaf058c3bbfbe9d915.

📒 Files selected for processing (1)
  • extensions/kind/src/create-cluster.ts (3 hunks)
🚧 Files skipped from review as they are similar to previous changes (1)
  • extensions/kind/src/create-cluster.ts
⏰ Context from checks skipped due to timeout of 90000ms (14)
  • GitHub Check: win update e2e tests
  • GitHub Check: mac update e2e tests
  • GitHub Check: smoke e2e tests (development)
  • GitHub Check: typecheck
  • GitHub Check: smoke e2e tests (production)
  • GitHub Check: unit tests / macos-15
  • GitHub Check: linter, formatters
  • GitHub Check: unit tests / ubuntu-24.04
  • GitHub Check: macOS
  • GitHub Check: Windows
  • GitHub Check: unit tests / windows-2022
  • GitHub Check: build website
  • GitHub Check: Linux
  • GitHub Check: take screenshots
✨ Finishing Touches
  • [ ] 📝 Generate Docstrings

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Jun 25 '25 08:06 coderabbitai[bot]

@feloy updated

gastoner avatar Jun 25 '25 08:06 gastoner

@gastoner , finally it was not the good direction. I just pushed a PR on the library's repo (https://github.com/kubernetes-client/javascript/pull/2520). If merged, we will need to replace calls to yaml.parseAllDocuments with calls to kubernetesClient.loadAllYaml

feloy avatar Jun 25 '25 09:06 feloy

@gastoner , finally it was not the good direction. I just pushed a PR on the library's repo (kubernetes-client/javascript#2520). If merged, we will need to replace calls to yaml.parseAllDocuments with calls to kubernetesClient.loadAllYaml

We need to have this fixed for 1.20 so we should continue work based on this PR as the library may not be updated by next week

jeffmaury avatar Jun 27 '25 09:06 jeffmaury

@jeffmaury this is the correct output based on the discussion with @feloy

gastoner avatar Jun 27 '25 09:06 gastoner

@jeffmaury this is the correct output based on the discussion with @feloy

At least the first problem is resolved.

For this problem of invalid value 0644, the problem is because we cannot handle specific cases like we were doing before with customTags: getTags (or we need to find a way to do it).

As a first workaround, I suppose we can change the value 0644 in the manifest with the corresponding decimal value 420

feloy avatar Jun 27 '25 11:06 feloy

@jeffmaury If I remember correctly, this commit will fix it without any error https://github.com/podman-desktop/podman-desktop/commit/01fad95df419823356d4387b8b0dad588c7c6f61

gastoner avatar Jun 30 '25 05:06 gastoner

@jeffmaury If I remember correctly, this commit will fix it without any error 01fad95

Still getting an error when I try to create a Kind cluster

jeffmaury avatar Jun 30 '25 06:06 jeffmaury

see https://github.com/podman-desktop/podman-desktop/pull/12919#issuecomment-3012735736 on how to fix this problem of invalid value 644

feloy avatar Jun 30 '25 07:06 feloy

@feloy @jeffmaury PR Updated!

gastoner avatar Jun 30 '25 14:06 gastoner

Context: https://github.com/kubernetes-client/javascript/issues/2539 (0644 used in the contour manifest is a notation compatible with YAML 1.1 only, not 1.2, and the kubernetes library is using a parser compatible with YAML 1.2 only)

As we discussed, the best solution I can think of is to suppose the YAML manifest in entry is in version 1.1 (the one supported by Kubernetes), and convert it in a format compatible with 1.2 (at least), for example:

// Add 
// %YAML 1.1 
// ---
// at the beginning of the manifest to parse

const yaml1 = yaml.parse(manifest);
const yml = k8s.loadYaml<k8s.KubernetesObject>(yaml.stringify(yaml1));

feloy avatar Jul 01 '25 08:07 feloy

@jeffmaury fixed

gastoner avatar Jul 01 '25 09:07 gastoner