objectscriptQuality Release Notes

• Improvements in Class not found rule to avoid false positives:
  • Avoid checking csp classes
• Improvements in Method not found rule to avoid false positives:
  • Avoid checking csp classes
  • Take in consideration autogenerated methods when there is a parent of the class that extends %Persistent

Class example.class1 Extends %Persistent
{ ... }

Class example.class2 Extends example.class1
{
Property propertyExample As %String(MAXLEN = 1000);
...
}

s foo =##class(example.class2).propertyExampleGetStored(rs.Data("ID"))

• Parse correctly scaped quotes when using a foreign language

• Improvements in Incompatible argument type in a method rule to avoid false positives:
  • Recognize $lb and &listbuild return types as %List
  • Recognize $j and &job return types as %String
  • Recognize type of $this as the current class
• Improvements in SQL Delimited Identifiers with double quotes rule to avoid false positives:
  • Allow usage of method calls as parameters in query strings.

    &sql(SELECT ServerType, MasterServerId Into :%USER("ServerId") FROM System WHERE ID = :%USER("ID"))

• Improvements in Local variable declared but not used rule to avoid false positives:
  • Avoid checking global variables in the method context
• Improvements in ZPM compatibility
• Improvements in Method lack return type rule to avoid false positives:
  • On a method call using Job, there is no return expected

• When a license is invalid, an exception was thrown and no project could be analyzed

• Fixes on ZPM support
• Fixes for Sonarlint compatibility
• Allow usage of dots in tagnames in a XData block
• Improvements on No quit (or return) found rule to avoid false positives:
  • Rule must not be evaluated on abstract methods
  • Manage properly when all return paths are contained in a try-catch clause

• $LU is a short for $LISTUPDATE
• Fixes on parsing index definition
• Fix type recognition on Incompatible argument type in a method rule
• Fix on Class not declared abstract rule when class uses autogenerated methods
• CompileAfter modifier assignment can be empty
• Correct parsing of pattern match operator (?)
• Solves type recognition on variable declaration when assignment is done using a function
• Avoid checks when using an implementation language different than ObjectScript
• Recognize parameters in labels
• Recognize multiline expressions with comments
• Recognize <?xml version="1.0"?> in XData
• Recognize argument for Job command:

  job @command

• Recognize the position parameter expressions using * (asterisk) and *-n (an asterisk followed by a negative integer) on $LISTGET
• Allow usage of quotation marks on INDEX name
• On extent index, the "On property_expression_list" is optional
• Keywords ELEMENTS and KEYS must be parsed case insensitive on arrays
• Review of SqlFieldName modifier for Relationship
• Review on rule Quit whitout arguments to avoid false positive when using labels in methods

• Event attributes on &html were not accepting ";" as valid javascript
• Method not found rule was not considering parent class in some cases
• Incompatible argument type in a method was not considering a {type} equivalent to LIBRARY.{type}
• Variable not found was analyzing JSON strings
• Error on read type of property on self class
• Property not found was not recognizing properties in self class in some cases
• Review on rule Quit whitout arguments to avoid false positive in some cases
• Class not found was resolving wrong namespace in some cases
• DependsOn modifier assignment can be empty

  Class Example [ DependsOn = , ProcedureBlock ]

• System roles were not allowed as class Owner

  Class MyApp.Person Extends %Persistent [ Owner = {%Developer} ]  { //class members }

• Allow usage of ellipsis for undetermined number of arguments in a label

  ZPM(pArgs...) Do ##class(%ZPM.PackageManager).Shell(pArgs...) Quit

• Quote marks are optionals for %%INSERT and %%UPDATE on SqlComputeOnChange
• Accept Deprecated as class modifier
• Accept Language class modifier with value "objectscript"

  Method name(formal_spec) As returnclass [ Language = objectscript ] 
  {    //implementation }

• Parameters starting with % on parameter list of Property definition where not allowed

  Property Payload As Patient(%JSONFIELDNAME = "package");

• Accept the (ELEMENTS) or (KEYS) optional expression on INDEX
• Minor review on parsing parameter list on Property definition

  Property Manifest As %Stream.GlobalCharacterSearchable(%SIMILARITYINDEX = "ManifestSearchIndex");

• Manage optional spacing properly for macros

• Method not found rule now distinguishes between a property and a method in a class call like ..call(x), where 'call' can be a method or an array property
• Empty method rule ignores foreign method to avoid false positives
• Improvement on Method never invoked rule to detect inheritance in more cases
• Incompatible argument type in a method was generating a null pointer parsing when type was not defined
• SoapAction method modifier was not accepting a String

• Fixed inheritance recognition on Method not found evaluation

• Methods failing to return a result on all code paths must not be evaluated on abstract class
• No quit (or return) found must not be evaluted on absctract class
• Solved bug on string recognition on Incompatible argument type in a method rule

• Resolved null pointer parsing in Class not found rule
• Method not found rule now excludes checks for %Classes, %Methods and %ShortPackageNames
• Incompatible argument type in a method rule was requiring initialization for variables passed by reference
• Incompatible argument type in a method rule now considers %String as the default type for the parameters with no type
• Method with unexpected arguments rule was not treating arguments with default value as arguments
• Property not found rule now skips validation for properties of instancies of %Classes
• Improvements on Variable not found rule to avoid false positives:
  • Now does not require to define a variable when calling $I(variable), as it is initiated automatically
  • Now does not require to define a variable when passed by reference
  • Now an argument used in a macro is considered to be initialized by the macro if not done before
  • Now does not require to initialize a variable used as argument in a macro
  • Was not recognizing #dim directive properly
  • Now recognizes variable declaration and initialization in a FOR

• Control division by zero on RFC Average metric
• Avoid type check of indirection in SET command  for rule Property not found
• Avoid type check of indirection in SET command  for rule Incompatible argument type in a method

• Query As class with parameters

• Adoption of Complexity/Class and Complexity/Functions for newer versions of SonarQube
• SqlFieldName modifier for Relationship
• Sql in Query can contain braces {}
• Indirection can be with almost everything which can return a string
• Routines may even not have header
• $[zobj][class]method().prop
• {Property*N} or {Property*n} ignore case
• $MVV on left side of SET command
• PatternMatching also can be used with indirections
• NEW command can be used with indirection
• ZKill fixed parsing different types of arguments
• Fixed parsing XData

• Allow a postcondition in Job command
• Allow a postcondition in Throw command
• Minimal macrodefinition arguments count set to zero
• Accept a counter reference property as argument for KILL command

  k ..Context.Data

• Accept a local variable as argument for ZKILL command
• Accept Language=cache in a Trigger definition

  Trigger Tr1 [ Event = INSERT, Language=cache ]

• Accept row/object in a Foreach Trigger definition

  Trigger Tr2 [ Event = INSERT, Foreach = row/object ]

• Allow spaces around expression in &html
• Indirection with direct self property

  @i%Global@(\"subscript\")

• Add field at hash reference class

  ##class({%%CLASSNAME}).%ClassName(1)

• Allow self pointer grammar in $ZOBJ* functions

  $ZOBJPROPERTY(obj,name).%Id()

• Recognize #dim as valid between a try and catch statement
• Review allowed DO command arguments
• The first argument to $PROPERTY is optional

• Review of rules help and messages:
  • Class has too many parameters
  • Class has too many properties
  • Usage of legacy flow control statements

• Spelling mistake