Skip to content

EdmLib Vocabulary Annotation Default Values - #2173

Closed
lisicase wants to merge 5 commits into
OData:masterfrom
lisicase:master
Closed

lisicase wants to merge 5 commits into
OData:masterfrom
lisicase:master

Conversation

@lisicase

@lisicase lisicase commented Aug 30, 2021 •

Copy link
Copy Markdown
Contributor

Description

This pull request adds support for using default values in vocabulary annotations in EdmLib.

Checklist

  • Add default values
  • Serialization
  • Deserialization
  • Reserialization
  • Add test cases

Additional work necessary

  • Currently only supports default values of primitive types -> Support all kinds of value types
  • Test the following constructor from EdmTermExtensions: BuildEdmExpression(CsdlSemanticsVocabularyAnnotation annotation)

Comment thread src/Microsoft.OData.Edm/EdmModelVisitor.cs Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/Parsing/CsdlDocumentParserBase.cs Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/Parsing/Ast/CsdlAnnotation.cs
Comment thread src/Microsoft.OData.Edm/Csdl/Semantics/CsdlSemanticsVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/Serialization/EdmModelCsdlSchemaXmlWriter.cs Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/Serialization/EdmModelCsdlSerializationVisitor.cs Outdated
Comment thread src/Microsoft.OData.Edm/Validation/ValidationRules.cs
Comment thread src/Microsoft.OData.Edm/Validation/ValidationRules.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/IEdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Microsoft.OData.Edm.csproj Outdated
Comment thread src/Microsoft.OData.Edm/Validation/ValidationRules.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/CsdlReader.cs Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/Serialization/EdmModelCsdlSchemaXmlWriter.cs Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/Serialization/EdmModelCsdlSchemaXmlWriter.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmTermExtensions.cs Outdated
Comment thread src/Microsoft.OData.Edm/Validation/ValidationRules.cs Outdated
Comment thread src/Microsoft.OData.Edm/Microsoft.OData.Edm.csproj Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/Semantics/CsdlSemanticsVocabularyAnnotation.cs Outdated
Assert.Equal("{\"state\":[\"wa\",\"ca\"]}", resultsArray[1]);
Assert.Equal("\"test\"", resultsArray[2]);

// TODO: add additional cases - empty array, empty string, null, whitespace, special chars, etc.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should add test case to test the mail methods in this class.
For example:

BuildDefaultEdmExpression

@lisicase lisicase Sep 10, 2021 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I finished testing the first constructor in the class.
TODO: Test BuildEdmExpression(CsdlSemanticsVocabularyAnnotation annotation)

Comment thread src/Microsoft.OData.Edm/Vocabularies/Annotations/EdmVocabularyAnnotation.cs Outdated
Comment thread src/Microsoft.OData.Edm/Csdl/Semantics/CsdlSemanticsVocabularyAnnotation.cs Outdated
@lisicase
lisicase marked this pull request as ready for review September 10, 2021 19:49
private readonly IEdmTerm term;
private readonly string qualifier;
private readonly IEdmExpression value;
private readonly bool usesDefault;

@corranrogue9 corranrogue9 Oct 13, 2021 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

private readonly bool usesDefault;


I don't think we need a field here since it is readonly and UsesDefault only has a getter #Resolved

"" +
"";
// Parse into CSDL
var model = CsdlReader.Parse(XElement.Parse(csdl).CreateReader());

@corranrogue9 corranrogue9 Oct 13, 2021 •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

var model = CsdlReader.Parse(XElement.Parse(csdl).CreateReader());


CreateReader returns an object that implements IDisposable. It should be wrapped in a using block #Resolved

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Other tests also have this issue

@pull-request-quantifier-deprecated

pull-request-quantifier-deprecated Bot commented Oct 21, 2021 •

Copy link
Copy Markdown

This PR has 713 quantified lines of changes. In general, a change size of upto 200 lines is ideal for the best PR experience!


Quantification details

Label      : Extra Large
Size       : +694 -19
Percentile : 90.43%

Total files changed: 14

Change summary by file extension:
.cs : +688 -15
.txt : +5 -3
.xml : +1 -1

Change counts above are quantified counts, based on the PullRequestQuantifier customizations.

Why proper sizing of changes matters

Optimal pull request sizes drive a better predictable PR flow as they strike a
balance between between PR complexity and PR review overhead. PRs within the
optimal size (typical small, or medium sized PRs) mean:

  • Fast and predictable releases to production:
    • Optimal size changes are more likely to be reviewed faster with fewer
      iterations.
    • Similarity in low PR complexity drives similar review times.
  • Review quality is likely higher as complexity is lower:
    • Bugs are more likely to be detected.
    • Code inconsistencies are more likely to be detetcted.
  • Knowledge sharing is improved within the participants:
    • Small portions can be assimilated better.
  • Better engineering practices are exercised:
    • Solving big problems by dividing them in well contained, smaller problems.
    • Exercising separation of concerns within the code changes.

What can I do to optimize my changes

  • Use the PullRequestQuantifier to quantify your PR accurately
    • Create a context profile for your repo using the context generator
    • Exclude files that are not necessary to be reviewed or do not increase the review complexity. Example: Autogenerated code, docs, project IDE setting files, binaries, etc. Check out the Excluded section from your prquantifier.yaml context profile.
    • Understand your typical change complexity, drive towards the desired complexity by adjusting the label mapping in your prquantifier.yaml context profile.
    • Only use the labels that matter to you, see context specification to customize your prquantifier.yaml context profile.
  • Change your engineering behaviors
    • For PRs that fall outside of the desired spectrum, review the details and check if:
      • Your PR could be split in smaller, self-contained PRs instead
      • Your PR only solves one particular issue. (For example, don't refactor and code new features in the same PR).

How to interpret the change counts in git diff output

  • One line was added: +1 -0
  • One line was deleted: +0 -1
  • One line was modified: +1 -1 (git diff doesn't know about modified, it will
    interpret that line like one addition plus one deletion)
  • Change percentiles: Change characteristics (addition, deletion, modification)
    of this PR in relation to all other PRs within the repository.


Was this comment helpful? 👍  :ok_hand:  :thumbsdown: (Email)
Customize PullRequestQuantifier for this repository.


In reply to: 948997785


In reply to: 948997785

@mikepizzo mikepizzo left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

:shipit:

@xuzhg

xuzhg commented Oct 21, 2021

Copy link
Copy Markdown
Contributor

Merged at 0fc80da

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

EdmLib should support default values for annotations.

4 participants