Error when using null or undefined in array literal (#1223)

Perryvw · web-flow · commit 5d66aa40d406 · 2022-03-10T22:52:09.000+01:00
* Error when using null or undefined in array literal

* Fix prettier
diff --git a/src/transformation/utils/diagnostics.ts b/src/transformation/utils/diagnostics.ts
@@ -155,3 +155,7 @@ export const unsupportedBuiltinOptionalCall = createErrorDiagnosticFactory(
 export const unsupportedOptionalCompileMembersOnly = createErrorDiagnosticFactory(
     "Optional calls are not supported on enums marked with @compileMembersOnly."
 );
+
+export const undefinedInArrayLiteral = createErrorDiagnosticFactory(
+    "Array literals may not contain undefined or null."
+);
diff --git a/src/transformation/visitors/literal.ts b/src/transformation/visitors/literal.ts
@@ -2,7 +2,11 @@ import * as ts from "typescript";
 import * as lua from "../../LuaAST";
 import { assertNever } from "../../utils";
 import { FunctionVisitor, TransformationContext, Visitors } from "../context";
-import { invalidMultiFunctionUse, unsupportedAccessorInObjectLiteral } from "../utils/diagnostics";
+import {
+    invalidMultiFunctionUse,
+    undefinedInArrayLiteral,
+    unsupportedAccessorInObjectLiteral,
+} from "../utils/diagnostics";
 import { createExportedIdentifier, getSymbolExportScope } from "../utils/export";
 import { LuaLibFeature, transformLuaLibFunction } from "../utils/lualib";
 import { createSafeName, hasUnsafeIdentifierName, hasUnsafeSymbolName } from "../utils/safe-names";
@@ -196,6 +200,9 @@ const transformObjectLiteralExpression: FunctionVisitor<ts.ObjectLiteralExpressi
 };
 
 const transformArrayLiteralExpression: FunctionVisitor<ts.ArrayLiteralExpression> = (expression, context) => {
+    // Disallow using undefined/null in array literals
+    checkForUndefinedOrNullInArrayLiteral(expression, context);
+
     const filteredElements = expression.elements.map(e =>
         ts.isOmittedExpression(e) ? ts.factory.createIdentifier("undefined") : e
     );
@@ -204,6 +211,31 @@ const transformArrayLiteralExpression: FunctionVisitor<ts.ArrayLiteralExpression
     return lua.createTableExpression(values, expression);
 };
 
+function checkForUndefinedOrNullInArrayLiteral(array: ts.ArrayLiteralExpression, context: TransformationContext) {
+    // Look for last non-nil element in literal
+    let lastNonUndefinedIndex = array.elements.length - 1;
+    for (; lastNonUndefinedIndex >= 0; lastNonUndefinedIndex--) {
+        if (!isUndefinedOrNull(array.elements[lastNonUndefinedIndex])) {
+            break;
+        }
+    }
+
+    // Add diagnostics for non-trailing nil elements in array literal
+    for (let i = 0; i < array.elements.length; i++) {
+        if (i < lastNonUndefinedIndex && isUndefinedOrNull(array.elements[i])) {
+            context.diagnostics.push(undefinedInArrayLiteral(array.elements[i]));
+        }
+    }
+}
+
+function isUndefinedOrNull(node: ts.Node) {
+    return (
+        node.kind === ts.SyntaxKind.UndefinedKeyword ||
+        node.kind === ts.SyntaxKind.NullKeyword ||
+        (ts.isIdentifier(node) && node.text === "undefined")
+    );
+}
+
 export const literalVisitors: Visitors = {
     [ts.SyntaxKind.NullKeyword]: node => lua.createNilLiteral(node),
     [ts.SyntaxKind.TrueKeyword]: node => lua.createBooleanLiteral(true, node),
diff --git a/test/unit/builtins/array.spec.ts b/test/unit/builtins/array.spec.ts
@@ -1,3 +1,4 @@
+import { undefinedInArrayLiteral } from "../../../src/transformation/utils/diagnostics";
 import * as util from "../../util";
 
 test("omitted expression", () => {
@@ -674,3 +675,28 @@ test("Array.isArray returns true for empty objects", () => {
 test("array.prototype.concat issue #738", () => {
     util.testExpression`([] as any[]).concat(13, 323, {x: 3}, [2, 3])`.expectToMatchJsResult();
 });
+
+test.each(["[1, undefined, 3]", "[1, null, 3]", "[1, undefined, 2, null]"])(
+    "not allowed to use null or undefined in array literals (%p)",
+    literal => {
+        util.testExpression(literal).expectToHaveDiagnostics([undefinedInArrayLiteral.code]);
+    }
+);
+
+test("not allowed to use null or undefined in array literals ([undefined, null, 1])", () => {
+    util.testExpression`[undefined, null, 1]`.expectToHaveDiagnostics([
+        undefinedInArrayLiteral.code,
+        undefinedInArrayLiteral.code,
+    ]);
+});
+
+test.each([
+    "[]",
+    "[1, 2, undefined]",
+    "[1, 2, null]",
+    "[1, undefined, undefined, null]",
+    "[undefined]",
+    "[undefined, null]",
+])("trailing undefined or null are allowed in array literal (%p)", literal => {
+    util.testExpression(literal).expectToHaveNoDiagnostics();
+});
