Update ODC's Devfile Library version

[maysunfaisal]

Which area/kind this issue is related to?

/area library

Issue Description

Update to a newer version of devfile/library on ODC.

This issue should also

• look at if switching to the latest version of the library, affects ODC because of the proxy support that is required on git cli, that was put in devfile/library.
• Update to the devfile/library version that has the new devfile validation for same port numbers in devfile components

Target Date: Mar 31, 2024

[kim-tsao]

@maysunfaisal we can also consider introducing a new parser arg to disable downloading from parent devfiles, especially if ODC is not relying on these artifacts right now (download by default so it doesn't change existing behaviour).

[github-actions]

This issue is stale because it has been open for 90 days with no activity. Remove stale label or comment or this will be closed in 60 days.

[thepetk]

I think this issue is still work in progress and the PR is under review

[thepetk]

@maysunfaisal I've tested locally your branch of console and I was able to create an application for each one of our samples:

• nodejs-basic
• code-with-quarkus
• java-springboot-basic
• python-basic
• go-basic

[thepetk]

@maysunfaisal my main concern is when I'm trying to parse a new sample:

• I have created a new version of go-basic here: https://github.com/thepetk/devfile-sample-go-basic.git
• This version uses consistent ports and the latest go parent.
• I've included this version in a locally running image of the registry which I connected with my locally running ODC instance.
• When I'm trying to create an application for this sample I have the following error:

Failed to parse devfile: failed to convert kubernetes uri to inlined for component 'deploy':
error getting kubernetes resources definition information, unable to resolve the file uri: deploy.yaml

This error comes from here: https://github.com/openshift/console/blob/master/pkg/devfile/handler.go#L55.

From what I can understand this error comes from the library and we are not able to locate the deploy.yaml file.

As a result, I'm not able to test your update against a new version of a sample that will have multiple components using the same port.

[thepetk]

Adding a blocker label due to #1112 (comment)

[thepetk]

@maysunfaisal update for comment #1136 (comment):

TL:DR
When a devfile sample includes components inside the parent sections (parentOverrides) we are not able to use this sample to create an application in console.

Steps to reproduce

• I've created locally a new image of the registry and used my go-basic fork as the golang sample. This devfile overrides the parent components like this:

parent:
  id: go
  registryUrl: 'https://registry.devfile.io'
  version: 2.1.0
  components:
    - name: deploy
      attributes:
        deployment/replicas: 1
        deployment/cpuRequest: 10m
        deployment/memoryRequest: 10Mi
        deployment/container-port: 8080
      kubernetes:
        uri: kubernetes/deploy.yaml
        endpoints:
        - name: http-8080
          targetPort: 8080
          path: /

• I've started a local registry using minikube.
• I've started an instance of console locally using CRC.
• When I'm trying to create an application using the go-basic sample I have the error:

Failed to parse devfile: failed to convert kubernetes uri to inlined for component 'deploy':
error getting kubernetes resources definition information, unable to resolve the file
uri: kubernetes/deploy.yaml

Why this is happening?

1. The console frontend is inlining all components that a devfile sample is using here.

2. As a result when a devfile defines a component inside the parent block the frontend doesn't detect the component and as a result it doesn't inline it.

3. Then it calls the ParseDevfileAndValidate function of the library.

4. The ParseDevfileAndValidate leads to getKubernetesDefinitionFromUri which tries to inline the parent components that are now part of the flattened Devfile.

5. As the DevfileCtx passed to the getKubernetesDefinitionFromUri by the frontend has no abspath or absoluteUrl the function returns the error shown above.

Workarounds

• Frontend should inline the flattened devfile.: This requires frontend work from the ODC side, as they should add a feature to flatten the devfile before inlining it.

• Convert sample uris to URLs: En example of the converted parent section is here:

parent:
  id: go
  registryUrl: 'https://registry.devfile.io'
  version: 2.1.0
  components:
    - name: build
      image:
        imageName: go-image:latest
        dockerfile:
          uri: https://github.com/thepetk/devfile-sample-go-basic/blob/main/docker/Dockerfile
          buildContext: .
          rootRequired: false
    - name: deploy
      attributes:
        deployment/replicas: 1
        deployment/cpuRequest: 10m
        deployment/memoryRequest: 10Mi
        deployment/container-port: 8080
      kubernetes:
        uri: https://github.com/thepetk/devfile-sample-go-basic/blob/main/kubernetes/deploy.yaml
        endpoints:
        - name: http-8080
          targetPort: 8080
          path: /

I've tried locally the second workaround and now with the update version of library, we are able to build applications with consistent ports.

[thepetk]

This is not a blocker anymore as the scope of the blocked item has changed.

[thepetk]

@maysunfaisal closing as the related PR was merged

[maysunfaisal]

Back ported to Openshift 4.15 openshift/console#13762

Did not proceed with back port to Openshift 4.14 because the updates for non-devfiles related go modules were a bit more significant than my liking for a "back port".