OPA v1.13.1 (#1850)

And use the new `array.flatten` to our benefit where we can!
Some of those locations turned out to not need flattening at all,
and could be rewritten to something even somple. Which is a win
too, of course :)

A minor but clearly measurable performance win, but more from the
changes here than from bumping OPA this time.

Signed-off-by: Anders Eknert <anders.eknert@apple.com>

Author: anderseknert

README.md

@@ -8,7 +8,7 @@
 <!-- markdownlint-disable MD041 -->
 
 [![Build Status](https://github.com/open-policy-agent/regal/workflows/Build/badge.svg)](https://github.com/open-policy-agent/regal/actions)
-![OPA v1.12.2](https://www.openpolicyagent.org/badge/v1.12.2)
+![OPA v1.13.1](https://www.openpolicyagent.org/badge/v1.13.1)
 [![codecov](https://codecov.io/github/open-policy-agent/regal/graph/badge.svg?token=EQK01YF3X3)](https://codecov.io/github/StyraInc/regal)
 [![Downloads](https://img.shields.io/github/downloads/open-policy-agent/regal/total.svg)](https://github.com/open-policy-agent/regal/releases)
 

build/capabilities.json

@@ -150,6 +150,31 @@
         "type": "function"
       }
     },
+    {
+      "name": "array.flatten",
+      "description": "Non-recursively unpacks array items in arr into the flattened array. Other types are appended as-is.",
+      "decl": {
+        "args": [
+          {
+            "description": "the array to be flattened",
+            "dynamic": {
+              "type": "any"
+            },
+            "name": "arr",
+            "type": "array"
+          }
+        ],
+        "result": {
+          "description": "array flattened one level",
+          "dynamic": {
+            "type": "any"
+          },
+          "name": "flattened",
+          "type": "array"
+        },
+        "type": "function"
+      }
+    },
     {
       "name": "array.reverse",
       "description": "Returns the reverse of a given array.",

bundle/regal/ast/ast.rego

@@ -237,13 +237,11 @@ ref_value_equal(v1, v2) if {
 # description: |
 #   returns a new ref value made by extending terms1 with terms2,
 #   where the first term of terms2 transformed to string
-extend_ref_terms(terms1, terms2) := array.concat(
+extend_ref_terms(terms1, terms2) := array.flatten([
 	terms1,
-	array.concat(
-		[object.union(terms2[0], {"type": "string"})],
-		array.slice(terms2, 1, 100),
-	),
-)
+	object.union(terms2[0], {"type": "string"}),
+	array.slice(terms2, 1, 100),
+])
 
 # METADATA
 # description: |

bundle/regal/ast/comments.rego

@@ -35,13 +35,6 @@ comments["annotation_match"](str) if regex.match(
 	str,
 )
 
-# METADATA
-# description: array containing all annotations from the module
-annotations := array.concat(
-	[annotation | some annotation in input.package.annotations],
-	[annotation | annotation := input.rules[_].annotations[_]],
-)
-
 # METADATA
 # description: |
 #   map of all ignore directive comments, like ("# regal ignore:line-length")
@@ -92,15 +85,15 @@ comment_blocks(comments) := blocks if {
 	]
 }
 
-_splits(xs) := array.concat(
-	array.concat(
-		# [-1] ++ [ all indices where there's a step larger than one ] ++ [length of xs]
-		# the -1 is because we're adding +1 in array.slice
-		[-1],
-		[i |
-			some i in numbers.range(0, count(xs) - 1)
-			xs[i + 1] != xs[i] + 1
-		],
-	),
-	[count(xs)],
-)
+_splits(xs) := array.flatten([
+	# -1 ++ [ all indices where there's a step larger than one ] ++ length of xs
+	# the -1 is because we're adding +1 in array.slice
+	-1,
+	[i |
+		some i in numbers.range(0, n - 1)
+		xs[i + 1] != xs[i] + 1
+	],
+	n,
+]) if {
+	n := count(xs)
+}

bundle/regal/ast/search.rego

@@ -51,16 +51,12 @@ find_ref_vars(value) := [var | # regal ignore:narrow-argument
 
 # one or two vars declared via `every`, i.e. `every x in y {}`
 # or `every`, i.e. `every x, y in z {}`
-_find_every_vars(value) := array.concat(key_var, val_var) if {
-	key_var := [value.key |
-		value.key.type == "var"
-		indexof(value.key.value, "$") == -1
-	]
-	val_var := [value.value |
-		value.value.type == "var"
-		indexof(value.value.value, "$") == -1
-	]
-}
+_find_every_vars(value) := [var |
+	some kind in ["key", "value"]
+	var := value[kind]
+	var.type == "var"
+	indexof(var.value, "$") == -1
+]
 
 # METADATA
 # description: |

bundle/regal/lsp/selectionrange/selectionrange.rego

@@ -19,8 +19,7 @@ default result["response"] := null
 # METADATA
 # entrypoint: true
 result["response"] := ranges if {
-	# we don't have a array.concat_n function, and of course, no reduce
-	ranges := array.concat(array.concat(package_ranges, import_ranges), rule_ranges)
+	ranges := array.flatten([package_ranges, import_ranges, rule_ranges])
 
 	count(ranges) > 0
 }
@@ -61,7 +60,7 @@ package_ranges := [item |
 	# package locations are even worse than imports, as there isn't even a location of
 	# the path itself, but only the `package` keyword and the indivdual path terms.. but OTOH,
 	# copy/pasting that line is probably not too common
-	item := _to_selection_range(array.concat(ranges, [path_range, line_range]))
+	item := _to_selection_range(array.flatten([ranges, path_range, line_range]))
 ]
 
 # METADATA
@@ -81,7 +80,7 @@ import_ranges := [item |
 
 	# import locations don't include the full text of the line, so we'll need to
 	# improvise here some, assuming properly formatted Rego
-	item := _to_selection_range(array.concat(ranges, [{"range": _estimated_import_range(imp)}]))
+	item := _to_selection_range(array.flatten([ranges, {"range": _estimated_import_range(imp)}]))
 ]
 
 # METADATA

bundle/regal/lsp/signaturehelp/signaturehelp.rego

@@ -60,10 +60,10 @@ _text_up_to_position(lines, _, position) := concat("\n", all_lines) if {
 	current_line := lines[position.line]
 	position.character < count(current_line)
 
-	complete_lines := [line | some i, line in lines; i < position.line]
-	partial_line := substring(current_line, 0, position.character)
-
-	all_lines := array.concat(complete_lines, [partial_line])
+	all_lines := array.flatten([
+		[line | some i, line in lines; i < position.line],
+		substring(current_line, 0, position.character),
+	])
 }
 
 _build_function_label(decl, func_name) := label if {

bundle/regal/result/result.rego

@@ -150,7 +150,7 @@ _fail_annotated_custom(metadata, details) := violation if {
 
 _resource_urls(related_resources, category) := [r |
 	some item in related_resources
-	r := object.union(object.remove(item, ["ref"]), {"ref": config.docs.resolve_url(item.ref, category)})
+	r := object.union(item, {"ref": config.docs.resolve_url(item.ref, category)})
 ]
 
 # Note that the `text` attribute always returns the entire line and *not*
@@ -189,7 +189,8 @@ ranged_from_ref(ref) := ranged_location_between(ref[0], regal.last(ref))
 # description: |
 #   creates a ranged location where the start location is the left hand side of an infix
 #   expression, like `"foo" == "bar"`, and the end location is the end of the infix operator
-infix_expr_location(terms) := location(sprintf("%s:%s:%s:%s", array.concat(
-	array.slice(split(terms[1].location, ":"), 0, 2),
-	array.slice(split(terms[0].location, ":"), 2, 4),
-)))
+infix_expr_location(terms) := location(regex.replace(
+	$"{terms[1].location}{terms[0].location}",
+	`^(\d+:\d+:).+:(\d+:\d+)$`,
+	`$1$2`,
+))

bundle/regal/rules/bugs/impossible-not/impossible_not.rego

@@ -73,7 +73,7 @@ report contains violation if {
 		# note that the "not" isn't present in the AST, so we'll add it manually to the text
 		# in the location to try and make it clear where the issue is (as opposed to just
 		# printing the ref)
-		"text": concat(" ", ["not", _to_string(negated.ref)]),
+		"text": $"not {_to_string(negated.ref)}",
 	}})
 
 	violation := result.fail(rego.metadata.chain(), loc)
@@ -102,7 +102,7 @@ aggregate_report contains violation if {
 		# note that the "not" isn't present in the AST, so we'll add it manually to the text
 		# in the location to try and make it clear where the issue is (as opposed to just
 		# printing the ref)
-		"text": concat(" ", ["not", _to_string(negated.ref)]),
+		"text": $"not {_to_string(negated.ref)}",
 	}})
 
 	violation := result.fail(rego.metadata.chain(), loc)

bundle/regal/rules/idiomatic/no-defined-entrypoint/no_defined_entrypoint.rego

@@ -2,18 +2,25 @@
 # description: Missing entrypoint annotation
 package regal.rules.idiomatic["no-defined-entrypoint"]
 
-import data.regal.ast
 import data.regal.result
 import data.regal.util
 
 # METADATA
 # description: |
 #   collects `entrypoint: true` annotations from any given module
+# scope: document
 aggregate contains entry if {
-	some annotation in ast.annotations
-	annotation.entrypoint == true
+	some i
+	input.package.annotations[i].entrypoint == true
 
-	entry := {"entrypoint": util.to_location_object(annotation.location)}
+	entry := {"entrypoint": util.to_location_object(input.package.annotations[i].location)}
+}
+
+aggregate contains entry if {
+	some i, j
+	input.rules[i].annotations[j].entrypoint == true
+
+	entry := {"entrypoint": util.to_location_object(input.rules[i].annotations[j].location)}
 }
 
 # METADATA