-
Notifications
You must be signed in to change notification settings - Fork 553
fix: support YAML 1.1 parsing in Kubernetes manifests by replacing js-yaml with yaml #2548
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
Changes from 1 commit
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
import yaml from 'js-yaml'; | ||
import YAML from 'yaml'; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you leave this name as it was please. |
||
import { getSerializationType } from './util.js'; | ||
import { KubernetesObject } from './types.js'; | ||
import { ObjectSerializer } from './serializer.js'; | ||
|
@@ -9,13 +9,12 @@ import { ObjectSerializer } from './serializer.js'; | |
* @param opts - Optional YAML load options. | ||
* @returns The deserialized Kubernetes object. | ||
*/ | ||
export function loadYaml<T>(data: string, opts?: yaml.LoadOptions): T { | ||
const yml = yaml.load(data, opts) as any as KubernetesObject; | ||
export function loadYaml<T>(data: string): T { | ||
const yml = YAML.parse(data, { version: '1.1' }) as any as KubernetesObject; | ||
if (!yml) { | ||
throw new Error('Failed to load YAML'); | ||
} | ||
const type = getSerializationType(yml.apiVersion, yml.kind); | ||
|
||
return ObjectSerializer.deserialize(yml, type) as T; | ||
} | ||
|
||
|
@@ -25,12 +24,12 @@ export function loadYaml<T>(data: string, opts?: yaml.LoadOptions): T { | |
* @param opts - Optional YAML load options. | ||
* @returns An array of deserialized Kubernetes objects. | ||
*/ | ||
export function loadAllYaml(data: string, opts?: yaml.LoadOptions): any[] { | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think users may still want to pass options to the parser There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think we may need to define our own types for the options passed to |
||
const ymls = yaml.loadAll(data, undefined, opts); | ||
return ymls.map((yml) => { | ||
const obj = yml as KubernetesObject; | ||
export function loadAllYaml(data: string): any[] { | ||
const ymls = YAML.parseAllDocuments(data, { version: '1.1' }); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think this value There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Yes sir @feloy, you're absolutely right I've updated the function so that yaml.parseAllDocuments(data, { version: '1.1', ...opts }); , |
||
return ymls.map((doc) => { | ||
const obj = doc.toJS() as KubernetesObject; | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Can you keep the name as |
||
const type = getSerializationType(obj.apiVersion, obj.kind); | ||
return ObjectSerializer.deserialize(yml, type); | ||
return ObjectSerializer.deserialize(obj, type); | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. If you don't rename things and make unrelated changes, the diff stays smaller and easier to review. It also makes |
||
}); | ||
} | ||
|
||
|
@@ -40,9 +39,9 @@ export function loadAllYaml(data: string, opts?: yaml.LoadOptions): any[] { | |
* @param opts - Optional YAML dump options. | ||
* @returns The YAML string representation of the serialized Kubernetes object. | ||
*/ | ||
export function dumpYaml(object: any, opts?: yaml.DumpOptions): string { | ||
export function dumpYaml(object: any): string { | ||
const kubeObject = object as KubernetesObject; | ||
const type = getSerializationType(kubeObject.apiVersion, kubeObject.kind); | ||
const serialized = ObjectSerializer.serialize(kubeObject, type); | ||
return yaml.dump(serialized, opts); | ||
return YAML.stringify(serialized); | ||
} |
Uh oh!
There was an error while loading. Please reload this page.