fix: ensure YAML 1.1 compatibility by migrating parser to yaml library

Author: tanmaishi

package-lock.json

@@ -62,15 +62,15 @@
         "form-data": "^4.0.0",
         "hpagent": "^1.2.0",
         "isomorphic-ws": "^5.0.0",
-        "js-yaml": "^4.1.0",
         "jsonpath-plus": "^10.3.0",
         "node-fetch": "^2.7.0",
         "openid-client": "^6.1.3",
         "rfc4648": "^1.3.0",
         "socks-proxy-agent": "^8.0.4",
         "stream-buffers": "^3.0.2",
         "tar-fs": "^3.0.9",
-        "ws": "^8.18.2"
+        "ws": "^8.18.2",
+        "yaml": "^2.8.1"
     },
     "devDependencies": {
         "@eslint/js": "^9.18.0",

package.json

@@ -1,4 +1,5 @@
 import { V1ListMeta, V1ObjectMeta } from './api.js';
+import { Schema } from 'yaml';
 
 export interface KubernetesObject {
     apiVersion?: string;
@@ -13,6 +14,15 @@ export interface KubernetesListObject<T extends KubernetesObject> {
     items: T[];
 }
 
+export type YamlParseOptions = {
+    version?: '1.1' | '1.2';
+    maxAliasCount?: number;
+    prettyErrors?: boolean;
+    keepCstNodes?: boolean;
+    keepNodeTypes?: boolean;
+    logLevel?: 'silent' | 'error' | 'warn';
+};
+
 export type IntOrString = number | string;
 
 export class V1MicroTime extends Date {

src/types.ts

@@ -1,6 +1,6 @@
-import yaml from 'js-yaml';
+import yaml from 'yaml';
 import { getSerializationType } from './util.js';
-import { KubernetesObject } from './types.js';
+import { KubernetesObject, YamlParseOptions } from './types.js';
 import { ObjectSerializer } from './serializer.js';
 
 /**
@@ -9,8 +9,8 @@ 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, opts?: YamlParseOptions): T {
+    const yml = yaml.parse(data, { version: '1.1', ...opts }) as any as KubernetesObject;
     if (!yml) {
         throw new Error('Failed to load YAML');
     }
@@ -25,12 +25,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[] {
-    const ymls = yaml.loadAll(data, undefined, opts);
+export function loadAllYaml(data: string, opts?: YamlParseOptions): any[] {
+    const ymls = yaml.parseAllDocuments(data, { version: '1.1', ...opts });
     return ymls.map((yml) => {
-        const obj = yml as KubernetesObject;
+        const obj = yml.toJS() as KubernetesObject;
         const type = getSerializationType(obj.apiVersion, obj.kind);
-        return ObjectSerializer.deserialize(yml, type);
+        return ObjectSerializer.deserialize(obj, type);
     });
 }
 
@@ -40,9 +40,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, opts?: YamlParseOptions): 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, { version: '1.1', ...opts });
 }

src/yaml.ts

@@ -154,4 +154,55 @@ spec:
         // not using strict equality as types are not matching
         deepEqual(actual, expected);
     });
+
+    it('should parse octal values correctly using default YAML 1.1', () => {
+        const yamlStr = `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  mode: 0644
+`;
+        const obj = loadYaml<{
+            data: { mode: number };
+            metadata: { name: string };
+            apiVersion: string;
+            kind: string;
+        }>(yamlStr);
+        strictEqual(obj.data.mode, 420);
+    });
+
+    it('should treat octal as string if version 1.2 is provided', () => {
+        const yamlStr = `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: test
+data:
+  mode: '0644'
+`;
+
+        const objs = loadAllYaml(yamlStr, { version: '1.2', maxAliasCount: 100, prettyErrors: true });
+
+        strictEqual(objs[0].data.mode, '0644');
+    });
+
+    it('should load multiple documents with default YAML 1.1', () => {
+        const yamlStr = `
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm1
+---
+apiVersion: v1
+kind: ConfigMap
+metadata:
+  name: cm2
+`;
+        const objs = loadAllYaml(yamlStr) as Array<{ metadata: { name: string } }>;
+        strictEqual(objs.length, 2);
+        strictEqual(objs[0].metadata.name, 'cm1');
+        strictEqual(objs[1].metadata.name, 'cm2');
+    });
 });