Muokkaa

Jaa

AppSourceCop Hidden AS0072

  • Artikkeli

The ObsoleteTag property and the Tag in the Obsolete attribute must be set to the next release version.

Description

The ObsoleteTag property and the Tag in the Obsolete attribute must be set to the next release version (Major.Minor). This rule is only relevant if the Major.Minor format is set.

Remarks

This rule verifies that the version specified as obsolete tag for objects whose obsolete state (not obsolete, obsolete pending, or obsolete removed) is updated with the current version is matching the version specified in the obsoleteTagVersion property of the AppSourceCop.json.

Obsolete objects which have the same obsolete state as in the baseline are not validated by this rule, but are validated by AS0074.

Note

This rule is only enabled when using the default obsoleteTagPattern in the AppSourceCop.json.

The version specified as obsoleteTagVersion can be the same as the current Major.Minor version specified in the version of your app.json, but it does not have to.

Setting up AppSourceCop to validate the Obsolete tag

Enabling the rule using a ruleset

The diagnostics for rule AS0072 are hidden by default, so you have to use a ruleset in order to surface them.

For example, the following ruleset turns the diagnostic for rule AS0072 into an error.

{
    "name": "My custom ruleset",
    "rules": [
        {
            "id": "AS0072",
            "action": "Error",
            "justification": "Validating that obsolete tags have the right version is important"
        }
    ]
}

{
    "al.ruleSetPath": "custom.ruleset.json"
}

Note

In order to fully validate obsolete properties and attributes, it is recommended to enable the rules AS0072, AS0073, AS0074, AS0075, and AS0076.

Setting up the AppSourceCop.json

In order to enable the validation, you must specify the obsoleteTagVersion in the AppSourceCop.json, without specifying the obsoleteTagPattern property so that the default pattern is used.

{
    "obsoleteTagVersion": "2.0"
}

How to fix this diagnostic?

In order to fix this diagnostic, make sure that all objects which are changing obsolete state in comparison to the baseline have an obsolete tag whose value is the one specified in the obsoleteTagVersion of the AppSourceCop.json.

Example of code triggering this rule

In the following example, the AppSourceCop is run against a baseline which has version 1.0 and expects the obsolete tag version for objects changing obsolete states to be 2.0.

{
    "version": "1.0",
    "obsoleteTagVersion": "2.0"
}

Newly obsoleted object specifying a version different than the obsolete tag version

Version of the extension used as baseline:

table 50100 MyTable
{
    fields
    {
        field(50100; MyField; Integer) { }
    }

    procedure MyProcedure()
    begin
    end;
}

Current version of the extension:

table 50100 MyTable
{
    ObsoleteState = Pending;
    ObsoleteReason = 'Use table X instead.';
    ObsoleteTag = '2.1';

    fields
    {
        field(50100; MyField; Integer) { }
    }

    [Obsolete('Use function Y instead', '3.0')]
    procedure MyProcedure()
    begin
    end;
}

In the current version of the extension, the table and the procedure are marked as obsolete pending. However, the obsolete tag values specified in the AL code are higher than the one specified in the AppSourceCop.json. The rule AS0072 will be triggered.

Preserving the obsolete tag for an object that changes obsolete state

Version of the extension used as baseline:

table 50100 MyTable
{
    ObsoleteState = Pending;
    ObsoleteReason = 'Use table X instead.';
    ObsoleteTag = '1.0';

    fields
    {
        field(50100; MyField; Integer) { }
    }
}

Current version of the extension:

table 50100 MyTable
{
    ObsoleteState = Removed;
    ObsoleteReason = 'Use table X instead.';
    ObsoleteTag = '1.0';

    fields
    {
        field(50100; MyField; Integer) { }
    }
}

In the current version of the extension, the table's obsolete state is changed from obsolete pending to obsolete removed, which means that only upgrade code is now able to reference it. However, the obsolete tag value specified in the AL code has not been updated and is now lower than the one specified in the AppSourceCop.json. The rule AS0072 will be triggered.

Example of code not triggering this rule

In the following example, the AppSourceCop is run against a baseline which has version 1.0 and expects the obsolete tag version for objects changing obsolete states to be 2.0.

{
    "version": "1.0",
    "obsoleteTagVersion": "2.0"
}

Specifying a version equal to the target obsolete tag version

Version of the extension used as baseline:

codeunit 50100 MyCodeunit
{
    procedure MyProcedure()
    begin
    end;
}

Current version of the extension:

codeunit 50100 MyCodeunit
{
    ObsoleteState = Pending;
    ObsoleteReason = 'Use codeunit X instead.';
    ObsoleteTag = '2.0';

    [Obsolete('Use function Y instead', '2.0')]
    procedure MyProcedure()
    begin
    end;
}

The codeunit MyCodeunit is marked as obsolete with the current version of the extension. As the specified obsolete tags are matching the obsoleteTagVersion, no diagnostics are reported.

Updating the obsolete tag for an obsolete object that does changes obsolete state

Version of the extension used as baseline:

table 50100 MyTable
{
    ObsoleteState = Pending;
    ObsoleteReason = 'Use table X instead.';
    ObsoleteTag = '1.0';

    fields
    {
        field(50100; MyField; Integer) { }
    }
}

Current version of the extension:

table 50100 MyTable
{
    ObsoleteState = Removed;
    ObsoleteReason = 'Use table X instead.';
    ObsoleteTag = '2.0';

    fields
    {
        field(50100; MyField; Integer) { }
    }
}

In the current version of the extension, the table's obsolete state is changed from obsolete pending to obsolete removed, which means that only upgrade code is now able to reference it. The obsolete tag value specified in the AL code has also been updated to the current obsoleteTagVersion in the AppSourceCop.json. The rule AS0072 will not be triggered.

Preserving the obsolete tag for an object that does not change obsolete state

Version 1.0 of the extension:

codeunit 50100 MyCodeunit
{
    ObsoleteState = Pending;
    ObsoleteReason = 'Use codeunit X instead.';
    ObsoleteTag = '1.0';

    [Obsolete('Use function Y instead', '1.0')]
    procedure MyProcedure()
    begin
    end;
}

Version 2.0 of the extension:

codeunit 50100 MyCodeunit
{
    ObsoleteState = Pending;
    ObsoleteReason = 'Use codeunit X instead.';
    ObsoleteTag = '1.0';

    [Obsolete('Use function Y instead', '1.0')]
    procedure MyProcedure()
    begin
    end;
}

The codeunit MyCodeunit is marked as obsolete pending in the baseline and remains obsolete in the current version. The obsolete tag is then not validated by rule AS0072, but is validated by AS0074. Note that this example does not trigger any diagnostics from the AppSourceCop for obsolete tags.

AppSourceCop Analyzer
Get Started with AL
Developing Extensions