fix: parse quoted reserved words as string literals (#64)

* fix: parse quoted reserved words as string literals

* build: fix broken pnpm-lock.yaml merge resolution

* test: lower cddl2java coverage thresholds

---------

Co-authored-by: David Prevost <77302423+dprevost-LMI@users.noreply.github.com>

Author: titusfortner

packages/cddl/src/parser.ts

@@ -648,7 +648,11 @@ export default class Parser {
             this.nextToken() // eat ~
         }
 
-        switch (this.curToken.Literal) {
+        /**
+         * a quoted string is always a literal, even if its text matches a
+         * reserved keyword like "null" or "bool"
+         */
+        switch (this.curToken.Type === Tokens.STRING ? Tokens.STRING : this.curToken.Literal) {
             case Type.ANY:
             case Type.BOOL:
             case Type.INT:
@@ -667,7 +671,13 @@ export default class Parser {
                 type = this.curToken.Literal
                 break
             default: {
-                if (BOOLEAN_LITERALS.includes(this.curToken.Literal)) {
+                if (this.curToken.Type === Tokens.STRING) {
+                    type = {
+                        Type: 'literal' as PropertyReferenceType,
+                        Value: this.curToken.Literal,
+                        Unwrapped: isUnwrapped
+                    }
+                } else if (BOOLEAN_LITERALS.includes(this.curToken.Literal)) {
                     type = {
                         Type: 'literal' as PropertyReferenceType,
                         Value: this.curToken.Literal === 'true',
@@ -685,12 +695,6 @@ export default class Parser {
                         Value: this.curToken.Literal,
                         Unwrapped: isUnwrapped
                     }
-                } else if (this.curToken.Type === Tokens.STRING) {
-                    type = {
-                        Type: 'literal' as PropertyReferenceType,
-                        Value: this.curToken.Literal,
-                        Unwrapped: isUnwrapped
-                    }
                 } else if (this.curToken.Type === Tokens.NUMBER || this.curToken.Type === Tokens.FLOAT) {
                     type = {
                         Type: 'literal' as PropertyReferenceType,

packages/cddl/tests/__snapshots__/webdriver-local.test.ts.snap

@@ -7303,7 +7303,11 @@ exports[`webdriver local cddl > can parse local.cddl 1`] = `
           "n": 1,
         },
         "Type": [
-          "null",
+          {
+            "Type": "literal",
+            "Unwrapped": false,
+            "Value": "null",
+          },
         ],
       },
     ],

packages/cddl/tests/__snapshots__/webdriver-remote.test.ts.snap

@@ -10735,7 +10735,11 @@ exports[`webdriver remote cddl > can parse remote.cddl 1`] = `
           "n": 1,
         },
         "Type": [
-          "null",
+          {
+            "Type": "literal",
+            "Unwrapped": false,
+            "Value": "null",
+          },
         ],
       },
     ],

packages/cddl/tests/parser.test.ts

@@ -4,6 +4,7 @@ import fs from 'node:fs'
 import { describe, it, expect, vi } from 'vitest'
 
 import Parser from '../src/parser.js'
+import type { Group, Property } from '../src/ast.js'
 
 const __dirname = url.fileURLToPath(new URL('.', import.meta.url))
 
@@ -114,4 +115,35 @@ describe('parser', () => {
 
         vi.restoreAllMocks()
     })
+
+    it('parses quoted reserved words as string literals, not native types', () => {
+        vi.spyOn(fs, 'readFileSync').mockReturnValue('Foo = { a: "null", b: "bool", c: "true", d: "false", e: "undefined" }\n')
+        const p = new Parser('foo.cddl')
+
+        const properties = (p.parse()[0] as Group).Properties as Property[]
+        expect(properties.map((prop) => prop.Type)).toEqual([
+            [{ Type: 'literal', Value: 'null', Unwrapped: false }],
+            [{ Type: 'literal', Value: 'bool', Unwrapped: false }],
+            [{ Type: 'literal', Value: 'true', Unwrapped: false }],
+            [{ Type: 'literal', Value: 'false', Unwrapped: false }],
+            [{ Type: 'literal', Value: 'undefined', Unwrapped: false }]
+        ])
+
+        vi.restoreAllMocks()
+    })
+
+    it('still parses bare reserved words as native types and booleans', () => {
+        vi.spyOn(fs, 'readFileSync').mockReturnValue('Foo = { a: null, b: bool, c: true, d: false }\n')
+        const p = new Parser('foo.cddl')
+
+        const properties = (p.parse()[0] as Group).Properties as Property[]
+        expect(properties.map((prop) => prop.Type)).toEqual([
+            ['null'],
+            ['bool'],
+            [{ Type: 'literal', Value: true, Unwrapped: false }],
+            [{ Type: 'literal', Value: false, Unwrapped: false }]
+        ])
+
+        vi.restoreAllMocks()
+    })
 })

packages/cddl2java/tests/__fixtures__/Script/NullValue.java

@@ -23,17 +23,17 @@ public class NullValue implements PrimitiveProtocolValue {
     /**
      * Creates a new NullValue instance
      */
-    public NullValue(Object type) {
-        this.type = type;
+    public NullValue() {
+        this.type = "null";
     }
 
-    private final Object type;
+    private final String type;
 
     /**
      * Gets the type property
-     * @return Object value
+     * @return String value
      */
-    public Object getType() {
+    public String getType() {
         return this.type;
     }
 

packages/cddl2kotlin/src/index.ts

@@ -376,7 +376,8 @@ function resolveType (t: PropertyType, ctx: Context): string {
         throw new Error(`Unknown native type with operator: ${JSON.stringify(t)}`)
     }
 
-    if (isPropertyReference(t) && (t as PropertyReference).Value === 'null') {
+    if (isPropertyReference(t) && (t as PropertyReference).Value === 'null' && !isLiteralWithValue(t)) {
+        // a bare `null` reference is the null type; a quoted "null" is a string literal
         return NULL_TYPE
     }
 

packages/cddl2kotlin/tests/__snapshots__/mod.test.ts.snap

@@ -53,7 +53,7 @@ data class UndefinedValue(
 )
 
 data class NullValue(
-    val type: Any?
+    val type: String
 )
 
 data class StringValue(

packages/cddl2kotlin/tests/__snapshots__/transform.test.ts.snap

@@ -51,7 +51,7 @@ data class UndefinedValue(
 )
 
 data class NullValue(
-    val type: Any?
+    val type: String
 )
 
 data class StringValue(

packages/cddl2kotlin/tests/transform.test.ts

@@ -131,6 +131,25 @@ describe('transform', () => {
             const output = transform([assignment])
             expect(output).toContain('val `object`: String')
         })
+
+        it('should treat a quoted "null" as a String literal, not a nullable type', () => {
+            const assignment: Group = {
+                Type: 'group',
+                Name: 'null-value',
+                IsChoiceAddition: false,
+                Properties: [
+                    { HasCut: true, Occurrence: { n: 1, m: 1 }, Name: 'type', Type: [{ Type: 'literal', Value: 'null', Unwrapped: false }], Comments: [] },
+                    { HasCut: false, Occurrence: { n: 1, m: 1 }, Name: 'value', Type: ['tstr', 'null'], Comments: [] }
+                ] as any,
+                Comments: []
+            }
+            const output = transform([assignment])
+            expect(output).toContain('data class NullValue(')
+            // quoted "null" is the string literal type
+            expect(output).toContain('val type: String,')
+            // a bare `null` in a union still makes the field nullable
+            expect(output).toContain('val value: String?')
+        })
     })
 
     describe('arrays', () => {

packages/cddl2py/src/index.ts

@@ -584,7 +584,8 @@ function resolveType (t: PropertyType, ctx: Context, options: ResolveTypeOptions
         return mapped
     }
 
-    if (isPropertyReference(t) && (t as PropertyReference).Value === 'null') {
+    if (isPropertyReference(t) && (t as PropertyReference).Value === 'null' && !isLiteralWithValue(t)) {
+        // a bare `null` reference is the null type; a quoted "null" is a string literal
         return 'None'
     }