feat(compiler)!: Prohibit mutating options [LNG-277]

aqua-run/src/main/scala/aqua/run/CliFunc.scala

@@ -3,16 +3,16 @@ package aqua.run
 import aqua.parser.lexer.{CallArrowToken, CollectionToken, LiteralToken, VarToken}
 import aqua.parser.lift.Span
 import aqua.raw.value.{CollectionRaw, LiteralRaw, ValueRaw, VarRaw}
-import aqua.types.{ArrayType, BottomType}
+import aqua.types.*
 
-import cats.data.{NonEmptyChain, NonEmptyList, Validated, ValidatedNec}
 import cats.data.Validated.{invalid, invalidNec, validNec}
-import cats.{~>, Id}
-import cats.syntax.traverse.*
-import cats.syntax.validated.*
-import cats.syntax.either.*
+import cats.data.{NonEmptyChain, NonEmptyList, Validated, ValidatedNec}
 import cats.syntax.comonad.*
+import cats.syntax.either.*
 import cats.syntax.option.*
+import cats.syntax.traverse.*
+import cats.syntax.validated.*
+import cats.{Id, ~>}
 
 case class CliFunc(name: String, args: List[ValueRaw] = Nil)
 
@@ -52,7 +52,15 @@ object CliFunc {
               .map(
                 NonEmptyList
                   .fromList(_)
-                  .map(l => CollectionRaw(l, ArrayType(l.head.baseType)))
+                  .map(l =>
+                    CollectionRaw(
+                      l,
+                      ArrayType(
+                        // FIXME: Type of Literal should always be a DataType
+                        l.head.baseType.asInstanceOf[DataType]
+                      )
+                    )
+                  )
                   .getOrElse(ValueRaw.Nil)
               )
               .toValidatedNec

aqua-run/src/main/scala/aqua/run/TypeValidator.scala

@@ -2,6 +2,7 @@ package aqua.run
 
 import aqua.raw.value.{LiteralRaw, ValueRaw, VarRaw}
 import aqua.types.*
+
 import cats.data.Validated.{invalidNec, validNec}
 import cats.data.{Validated, ValidatedNec}
 import cats.effect.kernel.Async
@@ -10,14 +11,11 @@ import cats.syntax.flatMap.*
 import cats.syntax.partialOrder.*
 import cats.syntax.show.*
 import cats.syntax.traverse.*
-
 import scala.collection.immutable.SortedMap
 import scala.concurrent.ExecutionContext
 
 object TypeValidator {
 
-  import aqua.types.Type.typesPartialOrder
-
   /**
    * Compare and validate type from Aqua file and type generated from JSON.
    *    Also, the validation will succeed if the JSON type is missing an array or an optional field.
@@ -69,7 +67,7 @@ object TypeValidator {
           case (l: OptionType, r) =>
             // if we have ?[][]string and [][][]string it must throw an error
             validateTypes(name, l.element, Some(r), Some((l, r)))
-          case (l: BoxType, r: BoxType) =>
+          case (l: CollectionType, r: CollectionType) =>
             validateTypes(name, l.element, Some(r.element), fullOptionType.orElse(Some(l, r)))
 
           case (l, r) =>

backend/definitions/src/main/scala/aqua/definitions/Definitions.scala

@@ -1,12 +1,12 @@
 package aqua.definitions
 
+import aqua.definitions.*
 import aqua.res.FuncRes
 import aqua.types.*
-import aqua.definitions.*
+
 import io.circe.*
 import io.circe.parser.*
 import io.circe.syntax.*
-
 import scala.annotation.tailrec
 
 // Represents the Aqua types
@@ -16,7 +16,7 @@ sealed trait TypeDefinition {
 
 object TypeDefinition {
 
-  implicit val encodeProdDefType: Encoder[ProductTypeDef] = {
+  given Encoder[ProductTypeDef] = {
     case d @ LabeledProductTypeDef(fields) =>
       Json.obj(
         ("tag", Json.fromString(d.tag)),
@@ -33,7 +33,7 @@ object TypeDefinition {
       )
   }
 
-  implicit val encodeDefType: Encoder[TypeDefinition] = {
+  given Encoder[TypeDefinition] = {
     case d @ ScalarTypeDef(name) =>
       Json.obj(
         ("tag", Json.fromString(d.tag)),
@@ -68,14 +68,14 @@ object TypeDefinition {
       )
   }
 
-  implicit val encodeServiceDefType: Encoder[ServiceDef] = { case ServiceDef(sId, functions, name) =>
+  given Encoder[ServiceDef] = { case ServiceDef(sId, functions, name) =>
     Json.obj(
       ("defaultServiceId", sId.asJson),
-      ("functions", encodeProdDefType(functions))
+      ("functions", (functions: ProductTypeDef).asJson)
     )
   }
 
-  implicit val encodeNamesConfig: Encoder[NamesConfig] = { case n: NamesConfig =>
+  given Encoder[NamesConfig] = { case n: NamesConfig =>
     import n.*
     Json.obj(
       ("relay", Json.fromString(relay)),
@@ -88,13 +88,12 @@ object TypeDefinition {
     )
   }
 
-  implicit val encodeFunctionDefType: Encoder[FunctionDef] = {
-    case FunctionDef(fName, arrow, names) =>
-      Json.obj(
-        ("functionName", Json.fromString(fName)),
-        ("arrow", encodeDefType(arrow)),
-        ("names", names.asJson)
-      )
+  given Encoder[FunctionDef] = { case FunctionDef(fName, arrow, names) =>
+    Json.obj(
+      ("functionName", Json.fromString(fName)),
+      ("arrow", (arrow: TypeDefinition).asJson),
+      ("names", names.asJson)
+    )
   }
 
   def apply(t: Option[Type]): TypeDefinition = t.map(apply).getOrElse(NilTypeDef)
@@ -103,7 +102,7 @@ object TypeDefinition {
     t match {
       case OptionType(t) =>
         OptionTypeDef(TypeDefinition(t))
-      case t: BoxType => ArrayTypeDef(TypeDefinition(t.element))
+      case t: CollectionType => ArrayTypeDef(TypeDefinition(t.element))
       case StructType(name, fields) =>
         StructTypeDef(name, fields.toSortedMap.view.mapValues(TypeDefinition.apply).toMap)
       case AbilityType(name, fieldAndArrows) =>
@@ -198,7 +197,11 @@ case class NamesConfig(
 )
 
 // Describes service
-case class ServiceDef(defaultServiceId: Option[String], functions: LabeledProductTypeDef, name: String)
+case class ServiceDef(
+  defaultServiceId: Option[String],
+  functions: LabeledProductTypeDef,
+  name: String
+)
 
 // Describes top-level function
 case class FunctionDef(

backend/ts/src/main/scala/aqua/backend/OutputFunc.scala

@@ -3,8 +3,11 @@ package aqua.backend
 import aqua.backend.air.FuncAirGen
 import aqua.backend.ts.TypeScriptCommon.fixupArgName
 import aqua.backend.ts.{TSFuncTypes, TypeScriptCommon}
+import aqua.definitions.*
+import aqua.definitions.TypeDefinition.given
 import aqua.res.FuncRes
 import aqua.types.*
+
 import cats.syntax.show.*
 import io.circe.*
 import io.circe.parser.*
@@ -20,8 +23,6 @@ case class OutputFunc(func: FuncRes, types: Types) {
   val funcTypes = types.funcType(func)
 
   import funcTypes.*
-  import aqua.definitions.TypeDefinition.*
-  import aqua.definitions.*
 
   def generate: (AirFunction, String) = {
     val tsAir = FuncAirGen(func).generate

backend/ts/src/main/scala/aqua/backend/OutputService.scala

@@ -1,8 +1,11 @@
 package aqua.backend
 
 import aqua.backend.ts.TypeScriptCommon
+import aqua.definitions.*
+import aqua.definitions.TypeDefinition.given
 import aqua.res.ServiceRes
 import aqua.types.ArrowType
+
 import io.circe.*
 import io.circe.parser.*
 import io.circe.syntax.*
@@ -14,8 +17,6 @@ case class OutputService(srv: ServiceRes, types: Types) {
   private val serviceTypes = types.serviceType(srv)
 
   import serviceTypes.*
-  import aqua.definitions.TypeDefinition.*
-  import aqua.definitions.*
 
   def generate: String =
     val functions = LabeledProductTypeDef(

integration-tests/aqua/examples/errorClear.aqua

@@ -7,7 +7,7 @@ service FailService("fail-srv"):
 
 func errorClearTest(node: string, relay: string) -> string, i64:
     stream: *string
-    code: ?i64
+    code: *i64
 
     on node via relay:
         try:

integration-tests/aqua/examples/funcs.aqua

@@ -39,7 +39,7 @@ func ifCalc() -> u64:
   <- res!0
 
 func cmp(a: i32, b: i32, pred: i8 -> bool) -> bool:
-  result: ?bool
+  result: *bool
 
   if a < b:
     result <- pred(-1)

integration-tests/aqua/examples/handleResultError.aqua

@@ -4,7 +4,7 @@ export handleResultError
 
 -- t = true, f = false
 func handleResultError(t: bool, f: bool) -> string:
-    opt: ?[]string
+    opt: *[]string
 
     if t == f: -- false
         opt <<- ["unreachable"]

integration-tests/aqua/examples/options/option_gen.aqua

@@ -2,7 +2,7 @@ service OptionString("opt_str"):
   checkOption(str: ?string) -> string
 
 func emptyString() -> ?string:
-  valueEmpty: ?string
+  valueEmpty: *string
   <- valueEmpty
 
 func checkEmpty() -> string:
@@ -11,7 +11,7 @@ func checkEmpty() -> string:
   <- res
 
 func stringAsOption(str: string) -> ?string:
-  valueEmpty: ?string
+  valueEmpty: *string
   valueEmpty <<- str
   <- valueEmpty
 

integration-tests/aqua/examples/stream.aqua

@@ -36,7 +36,7 @@ func returnNilLength() -> u32:
     <- arr.length
 
 func stringNone() -> ?string:
-    valueNone: ?string
+    valueNone: *string
     <- valueNone
 
 func returnNone() -> ?string:

integration-tests/aqua/examples/streamArgs.aqua

@@ -1,3 +1,7 @@
+aqua StreamArgs
+
+export retrieve_records, modify_stream, TestService
+
 service TestService("test-service"):
     get_records(key: string) -> []string
 
@@ -7,4 +11,8 @@ func append_records(peer: string, srum: *[]string):
 func retrieve_records(peer: string) -> [][]string:
     records: *[]string
     append_records(peer, records)
-    <- records
+    <- records
+
+func modify_stream(stream: *string) -> []string:
+  stream <<- "appended value"
+  <- stream

integration-tests/aqua/examples/via.aqua

@@ -1,17 +1,20 @@
+aqua Via
+
+export viaArr, viaStream, viaOpt
+
 import "@fluencelabs/aqua-lib/builtin.aqua"
 
 func viaArr(node_id: string, viaAr: []string) -> Info:
     on node_id via viaAr:
         p <- Peer.identify()
     <- p
 
-
 func viaStream(node_id: string, viaStr: *string) -> Info:
     on node_id via viaStr:
         p <- Peer.identify()
     <- p
 
-func viaOpt(relay: string, node_id: string, viaOpt: ?string) -> Info:
+func viaOpt(node_id: string, viaOpt: ?string) -> Info:
     on node_id via viaOpt:
         p <- Peer.identify()
     <- p

integration-tests/src/__test__/examples.spec.ts

@@ -33,7 +33,11 @@ import {
 import {
   abilityCall,
   complexAbilityCall,
-  checkAbCallsCall, bugLNG258Call1, bugLNG258Call2, bugLNG258Call3, multipleAbilityWithClosureCall,
+  checkAbCallsCall,
+  bugLNG258Call1,
+  bugLNG258Call2,
+  bugLNG258Call3,
+  multipleAbilityWithClosureCall,
 } from "../examples/abilityCall.js";
 import {
   nilLengthCall,
@@ -78,7 +82,10 @@ import { tryCatchCall } from "../examples/tryCatchCall.js";
 import { tryOtherwiseCall } from "../examples/tryOtherwiseCall.js";
 import { coCall } from "../examples/coCall.js";
 import { bugLNG60Call, passArgsCall } from "../examples/passArgsCall.js";
-import { streamArgsCall } from "../examples/streamArgsCall.js";
+import {
+  streamArgsCall,
+  modifyStreamCall,
+} from "../examples/streamArgsCall.js";
 import { streamResultsCall } from "../examples/streamResultsCall.js";
 import { structuralTypingCall } from "../examples/structuralTypingCall";
 import {
@@ -104,7 +111,10 @@ import { multiReturnCall } from "../examples/multiReturnCall.js";
 import { declareCall } from "../examples/declareCall.js";
 import { genOptions, genOptionsEmptyString } from "../examples/optionsCall.js";
 import { lng193BugCall } from "../examples/closureReturnRename.js";
-import {closuresCall, multipleClosuresLNG262BugCall} from "../examples/closures.js";
+import {
+  closuresCall,
+  multipleClosuresLNG262BugCall,
+} from "../examples/closures.js";
 import { closureArrowCaptureCall } from "../examples/closureArrowCapture.js";
 import {
   bugLNG63_2Call,
@@ -589,6 +599,18 @@ describe("Testing examples", () => {
     expect(streamArgsResult).toEqual([["peer_id", "peer_id"]]);
   });
 
+  it("streamArgs.aqua modify stream", async () => {
+    let streamArgsResult = await modifyStreamCall([
+      "passed value 1",
+      "passed value 2",
+    ]);
+    expect(streamArgsResult).toEqual([
+      "passed value 1",
+      "passed value 2",
+      "appended value",
+    ]);
+  });
+
   it("streamResults.aqua", async () => {
     let streamResultsResult = await streamResultsCall();
     expect(streamResultsResult).toEqual(["new_name", "new_name", "new_name"]);
@@ -934,9 +956,10 @@ describe("Testing examples", () => {
 
   it("via.aqua", async () => {
     let res1 = await viaArrCall();
-    let res2 = await viaOptCall(relayPeerId1);
-    let res3 = await viaOptNullCall(relayPeerId1);
-    let res4 = await viaStreamCall(relayPeerId1);
+    let res2 = await viaOptCall();
+    let res3 = await viaOptNullCall();
+    let res4 = await viaStreamCall();
+    expect(res1).not.toHaveLength(0);
     expect(res1).toEqual(res2);
     expect(res2).toEqual(res3);
     expect(res3).toEqual(res4);

integration-tests/src/examples/streamArgsCall.ts

@@ -1,5 +1,6 @@
 import {
   retrieve_records,
+  modify_stream,
   registerTestService,
 } from "../compiled/examples/streamArgs.js";
 
@@ -12,3 +13,7 @@ export async function streamArgsCall() {
 
   return await retrieve_records("peer_id");
 }
+
+export async function modifyStreamCall(arg: string[]) {
+  return await modify_stream(arg);
+}