Skip to content

[C#] Emit Default is true for required properties. - #11607

Closed
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties
Closed

[C#] Emit Default is true for required properties.#11607
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties

Conversation

@dhedey

@dhedeydhedey commented Feb 14, 2022

Copy link
Copy Markdown

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: #11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@dhedey
dhedeyforce-pushed the fix/csharp-emit-default-for-required-properties branch from a853fb9 to 81881d3CompareFebruary 14, 2022 17:30
@hauntingEcho

Copy link
Copy Markdown
Contributor

It looks like the failures here were both network issues (to maven and github) rather than test failures - could someone with access re-execute them to verify?

Node 0:

Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
[ERROR] Plugin org.jboss.jandex:jandex-maven-plugin:1.1.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.jboss.jandex:jandex-maven-plugin:jar:1.1.0: Could not transfer artifact org.jboss.jandex:jandex-maven-plugin:pom:1.1.0 from/to central (https://repo.maven.apache.org/maven2): Connection reset -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginResolutionException

Node 2:

PASS
ok github.com/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/go	50.514s
go: downloading github.com/gorilla/mux v1.7.3
? github.com/GIT_USER_ID/GIT_REPO_ID	[no test files]
# golang.org/x/net/http2
/home/circleci/.go_workspace/src/golang.org/x/net/http2/transport.go:417:45: undefined: os.ErrDeadlineExceeded
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (go-get) on project GoGinServer: Command execution failed. Process exited with an error: 2 (Exit value: 2) -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] [ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :GoGinServer

@dhedey

dhedey commented Mar 29, 2022

Copy link
Copy Markdown
Author

Thanks @hauntingEcho.

(@ any potential reviewers -)

In terms of anyone able to review - the key files are the mustache files, and the key context is in my original message. Happy to rebase / re-generate if/when I've got a supportive review.

More generally - I'm potentially keen / happy to help with fixing issue 1 in my original message - or creating a new variant from the ground up which would fix 1 and various other bugs I've encountered (I've worked around about 10 or so distinct issues so far) - but I'd like to discuss with someone who could review/approve first, to check any effort would be appreciated.

@dhedey

Copy link
Copy Markdown
Author

Closing as this fix was included in #13049

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dhedey@hauntingEcho
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[C#] Emit Default is true for required properties. by dhedey · Pull Request #11607 · OpenAPITools/openapi-generator · GitHub
Skip to content

[C#] Emit Default is true for required properties. - #11607

Closed
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties
Closed

[C#] Emit Default is true for required properties.#11607
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties

Conversation

@dhedey

@dhedeydhedey commented Feb 14, 2022

Copy link
Copy Markdown

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: #11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@dhedey
dhedeyforce-pushed the fix/csharp-emit-default-for-required-properties branch from a853fb9 to 81881d3CompareFebruary 14, 2022 17:30
@hauntingEcho

Copy link
Copy Markdown
Contributor

It looks like the failures here were both network issues (to maven and github) rather than test failures - could someone with access re-execute them to verify?

Node 0:

Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
[ERROR] Plugin org.jboss.jandex:jandex-maven-plugin:1.1.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.jboss.jandex:jandex-maven-plugin:jar:1.1.0: Could not transfer artifact org.jboss.jandex:jandex-maven-plugin:pom:1.1.0 from/to central (https://repo.maven.apache.org/maven2): Connection reset -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginResolutionException

Node 2:

PASS
ok github.com/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/go	50.514s
go: downloading github.com/gorilla/mux v1.7.3
? github.com/GIT_USER_ID/GIT_REPO_ID	[no test files]
# golang.org/x/net/http2
/home/circleci/.go_workspace/src/golang.org/x/net/http2/transport.go:417:45: undefined: os.ErrDeadlineExceeded
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (go-get) on project GoGinServer: Command execution failed. Process exited with an error: 2 (Exit value: 2) -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] [ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :GoGinServer

@dhedey

dhedey commented Mar 29, 2022

Copy link
Copy Markdown
Author

Thanks @hauntingEcho.

(@ any potential reviewers -)

In terms of anyone able to review - the key files are the mustache files, and the key context is in my original message. Happy to rebase / re-generate if/when I've got a supportive review.

More generally - I'm potentially keen / happy to help with fixing issue 1 in my original message - or creating a new variant from the ground up which would fix 1 and various other bugs I've encountered (I've worked around about 10 or so distinct issues so far) - but I'd like to discuss with someone who could review/approve first, to check any effort would be appreciated.

@dhedey

Copy link
Copy Markdown
Author

Closing as this fix was included in #13049

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dhedey@hauntingEcho
, 'i'); if (__m === '*' || __re.test(location.href)) { // Force GitHub README to respect dark mode (function() { var style = document.createElement('style'); style.textContent = ' .markdown-body { color-scheme: dark light; } .markdown-body pre { background: #161b22 !important; } .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; } .markdown-body table th, .markdown-body table td { border-color: #30363d !important; } .markdown-body img { background: #0d1117; } .markdown-body blockquote { border-left-color: #8b949e; } .markdown-body hr { border-color: #30363d; } '; document.head.appendChild(style); })(); } } catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [C#] Emit Default is true for required properties. by dhedey · Pull Request #11607 · OpenAPITools/openapi-generator · GitHub
Skip to content

[C#] Emit Default is true for required properties. - #11607

Closed
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties
Closed

[C#] Emit Default is true for required properties.#11607
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties

Conversation

@dhedey

@dhedeydhedey commented Feb 14, 2022

Copy link
Copy Markdown

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: #11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@dhedey
dhedeyforce-pushed the fix/csharp-emit-default-for-required-properties branch from a853fb9 to 81881d3CompareFebruary 14, 2022 17:30
@hauntingEcho

Copy link
Copy Markdown
Contributor

It looks like the failures here were both network issues (to maven and github) rather than test failures - could someone with access re-execute them to verify?

Node 0:

Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
[ERROR] Plugin org.jboss.jandex:jandex-maven-plugin:1.1.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.jboss.jandex:jandex-maven-plugin:jar:1.1.0: Could not transfer artifact org.jboss.jandex:jandex-maven-plugin:pom:1.1.0 from/to central (https://repo.maven.apache.org/maven2): Connection reset -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginResolutionException

Node 2:

PASS
ok github.com/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/go	50.514s
go: downloading github.com/gorilla/mux v1.7.3
? github.com/GIT_USER_ID/GIT_REPO_ID	[no test files]
# golang.org/x/net/http2
/home/circleci/.go_workspace/src/golang.org/x/net/http2/transport.go:417:45: undefined: os.ErrDeadlineExceeded
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (go-get) on project GoGinServer: Command execution failed. Process exited with an error: 2 (Exit value: 2) -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] [ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :GoGinServer

@dhedey

dhedey commented Mar 29, 2022

Copy link
Copy Markdown
Author

Thanks @hauntingEcho.

(@ any potential reviewers -)

In terms of anyone able to review - the key files are the mustache files, and the key context is in my original message. Happy to rebase / re-generate if/when I've got a supportive review.

More generally - I'm potentially keen / happy to help with fixing issue 1 in my original message - or creating a new variant from the ground up which would fix 1 and various other bugs I've encountered (I've worked around about 10 or so distinct issues so far) - but I'd like to discuss with someone who could review/approve first, to check any effort would be appreciated.

@dhedey

Copy link
Copy Markdown
Author

Closing as this fix was included in #13049

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dhedey@hauntingEcho
, 'i'); if (__m === '*' || __re.test(location.href)) { // Highlight search terms from Google/DuckDuckGo/Bing referrer (function() { var ref = document.referrer; var terms = []; if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) { var url = new URL(ref); var q = url.searchParams.get('q') || url.searchParams.get('p'); if (q) { terms = q.split(/\s+/).filter(function(t) { return t.length > 2; }); } } if (terms.length === 0) return; var style = document.createElement('style'); style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }'; document.head.appendChild(style); function highlight(node) { if (node.nodeType === 3) { // text node var text = node.textContent; var found = false; terms.forEach(function(term) { var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi'); if (regex.test(text)) { found = true; var frag = document.createDocumentFragment(); var parts = text.split(regex); parts.forEach(function(part, i) { if (i % 2 === 0) { frag.appendChild(document.createTextNode(part)); } else { var span = document.createElement('span'); span.className = 'userscript-highlight'; span.textContent = part; frag.appendChild(span); } }); node.parentNode.replaceChild(frag, node); } }); } else if (node.nodeType === 1 && node.childNodes) { // element var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT']; if (!skipTags.includes(node.tagName)) { Array.from(node.childNodes).forEach(highlight); } } } highlight(document.body); // Re-highlight on dynamic content var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1 || node.nodeType === 3) highlight(node); }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [C#] Emit Default is true for required properties. by dhedey · Pull Request #11607 · OpenAPITools/openapi-generator · GitHub
Skip to content

[C#] Emit Default is true for required properties. - #11607

Closed
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties
Closed

[C#] Emit Default is true for required properties.#11607
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties

Conversation

@dhedey

@dhedeydhedey commented Feb 14, 2022

Copy link
Copy Markdown

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: #11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@dhedey
dhedeyforce-pushed the fix/csharp-emit-default-for-required-properties branch from a853fb9 to 81881d3CompareFebruary 14, 2022 17:30
@hauntingEcho

Copy link
Copy Markdown
Contributor

It looks like the failures here were both network issues (to maven and github) rather than test failures - could someone with access re-execute them to verify?

Node 0:

Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
[ERROR] Plugin org.jboss.jandex:jandex-maven-plugin:1.1.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.jboss.jandex:jandex-maven-plugin:jar:1.1.0: Could not transfer artifact org.jboss.jandex:jandex-maven-plugin:pom:1.1.0 from/to central (https://repo.maven.apache.org/maven2): Connection reset -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginResolutionException

Node 2:

PASS
ok github.com/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/go	50.514s
go: downloading github.com/gorilla/mux v1.7.3
? github.com/GIT_USER_ID/GIT_REPO_ID	[no test files]
# golang.org/x/net/http2
/home/circleci/.go_workspace/src/golang.org/x/net/http2/transport.go:417:45: undefined: os.ErrDeadlineExceeded
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (go-get) on project GoGinServer: Command execution failed. Process exited with an error: 2 (Exit value: 2) -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] [ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :GoGinServer

@dhedey

dhedey commented Mar 29, 2022

Copy link
Copy Markdown
Author

Thanks @hauntingEcho.

(@ any potential reviewers -)

In terms of anyone able to review - the key files are the mustache files, and the key context is in my original message. Happy to rebase / re-generate if/when I've got a supportive review.

More generally - I'm potentially keen / happy to help with fixing issue 1 in my original message - or creating a new variant from the ground up which would fix 1 and various other bugs I've encountered (I've worked around about 10 or so distinct issues so far) - but I'd like to discuss with someone who could review/approve first, to check any effort would be appreciated.

@dhedey

Copy link
Copy Markdown
Author

Closing as this fix was included in #13049

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dhedey@hauntingEcho
, 'i'); if (__m === '*' || __re.test(location.href)) { // Strip utm_, fbclid, gclid, etc. from all links on page (function() { var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content', 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid', 'ref', 'ref_src', 'source', 'medium', 'campaign']; function cleanUrl(url) { try { var u = new URL(url, window.location.origin); var changed = false; trackingParams.forEach(function(p) { if (u.searchParams.has(p)) { u.searchParams.delete(p); changed = true; } }); return changed ? u.toString() : url; } catch (e) { return url; } } function cleanLinks() { document.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } cleanLinks(); var observer = new MutationObserver(function(mutations) { mutations.forEach(function(m) { m.addedNodes.forEach(function(node) { if (node.nodeType === 1) { if (node.tagName === 'A') cleanLinks(); node.querySelectorAll('a[href]').forEach(function(a) { var clean = cleanUrl(a.href); if (clean !== a.href) a.href = clean; }); } }); }); }); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); } })(); (function(){ try { var __m = "youtube.com"; var __re = new RegExp('^' + "youtube\\.com" + ' [C#] Emit Default is true for required properties. by dhedey · Pull Request #11607 · OpenAPITools/openapi-generator · GitHub
Skip to content

[C#] Emit Default is true for required properties. - #11607

Closed
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties
Closed

[C#] Emit Default is true for required properties.#11607
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties

Conversation

@dhedey

@dhedeydhedey commented Feb 14, 2022

Copy link
Copy Markdown

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: #11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@dhedey
dhedeyforce-pushed the fix/csharp-emit-default-for-required-properties branch from a853fb9 to 81881d3CompareFebruary 14, 2022 17:30
@hauntingEcho

Copy link
Copy Markdown
Contributor

It looks like the failures here were both network issues (to maven and github) rather than test failures - could someone with access re-execute them to verify?

Node 0:

Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
[ERROR] Plugin org.jboss.jandex:jandex-maven-plugin:1.1.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.jboss.jandex:jandex-maven-plugin:jar:1.1.0: Could not transfer artifact org.jboss.jandex:jandex-maven-plugin:pom:1.1.0 from/to central (https://repo.maven.apache.org/maven2): Connection reset -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginResolutionException

Node 2:

PASS
ok github.com/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/go	50.514s
go: downloading github.com/gorilla/mux v1.7.3
? github.com/GIT_USER_ID/GIT_REPO_ID	[no test files]
# golang.org/x/net/http2
/home/circleci/.go_workspace/src/golang.org/x/net/http2/transport.go:417:45: undefined: os.ErrDeadlineExceeded
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (go-get) on project GoGinServer: Command execution failed. Process exited with an error: 2 (Exit value: 2) -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] [ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :GoGinServer

@dhedey

dhedey commented Mar 29, 2022

Copy link
Copy Markdown
Author

Thanks @hauntingEcho.

(@ any potential reviewers -)

In terms of anyone able to review - the key files are the mustache files, and the key context is in my original message. Happy to rebase / re-generate if/when I've got a supportive review.

More generally - I'm potentially keen / happy to help with fixing issue 1 in my original message - or creating a new variant from the ground up which would fix 1 and various other bugs I've encountered (I've worked around about 10 or so distinct issues so far) - but I'd like to discuss with someone who could review/approve first, to check any effort would be appreciated.

@dhedey

Copy link
Copy Markdown
Author

Closing as this fix was included in #13049

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dhedey@hauntingEcho
, 'i'); if (__m === '*' || __re.test(location.href)) { // Auto-enable theater mode on YouTube (function() { function tryTheater() { var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]'); if (btn && !btn.classList.contains('activated')) { btn.click(); } } // Try immediately tryTheater(); // Try after navigation (SPA) var lastUrl = location.href; setInterval(function() { if (location.href !== lastUrl) { lastUrl = location.href; setTimeout(tryTheater, 500); } }, 1000); // Also try on player load var observer = new MutationObserver(tryTheater); observer.observe(document.body, { childList: true, subtree: true }); })(); } } catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [C#] Emit Default is true for required properties. by dhedey · Pull Request #11607 · OpenAPITools/openapi-generator · GitHub
Skip to content

[C#] Emit Default is true for required properties. - #11607

Closed
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties
Closed

[C#] Emit Default is true for required properties.#11607
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties

Conversation

@dhedey

@dhedeydhedey commented Feb 14, 2022

Copy link
Copy Markdown

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: #11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@dhedey
dhedeyforce-pushed the fix/csharp-emit-default-for-required-properties branch from a853fb9 to 81881d3CompareFebruary 14, 2022 17:30
@hauntingEcho

Copy link
Copy Markdown
Contributor

It looks like the failures here were both network issues (to maven and github) rather than test failures - could someone with access re-execute them to verify?

Node 0:

Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
[ERROR] Plugin org.jboss.jandex:jandex-maven-plugin:1.1.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.jboss.jandex:jandex-maven-plugin:jar:1.1.0: Could not transfer artifact org.jboss.jandex:jandex-maven-plugin:pom:1.1.0 from/to central (https://repo.maven.apache.org/maven2): Connection reset -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginResolutionException

Node 2:

PASS
ok github.com/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/go	50.514s
go: downloading github.com/gorilla/mux v1.7.3
? github.com/GIT_USER_ID/GIT_REPO_ID	[no test files]
# golang.org/x/net/http2
/home/circleci/.go_workspace/src/golang.org/x/net/http2/transport.go:417:45: undefined: os.ErrDeadlineExceeded
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (go-get) on project GoGinServer: Command execution failed. Process exited with an error: 2 (Exit value: 2) -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] [ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :GoGinServer

@dhedey

dhedey commented Mar 29, 2022

Copy link
Copy Markdown
Author

Thanks @hauntingEcho.

(@ any potential reviewers -)

In terms of anyone able to review - the key files are the mustache files, and the key context is in my original message. Happy to rebase / re-generate if/when I've got a supportive review.

More generally - I'm potentially keen / happy to help with fixing issue 1 in my original message - or creating a new variant from the ground up which would fix 1 and various other bugs I've encountered (I've worked around about 10 or so distinct issues so far) - but I'd like to discuss with someone who could review/approve first, to check any effort would be appreciated.

@dhedey

Copy link
Copy Markdown
Author

Closing as this fix was included in #13049

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dhedey@hauntingEcho
, 'i'); if (__m === '*' || __re.test(location.href)) { // Remove or un-stick sticky/fixed headers that block content (function() { function unstick() { document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) { if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') { el.style.position = 'static'; el.style.top = 'auto'; el.style.zIndex = 'auto'; } }); } unstick(); var observer = new MutationObserver(unstick); observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] }); })(); } } catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); } })(); (function(){ try { var __m = "*"; var __re = new RegExp('^' + ".*" + ' [C#] Emit Default is true for required properties. by dhedey · Pull Request #11607 · OpenAPITools/openapi-generator · GitHub
Skip to content

[C#] Emit Default is true for required properties. - #11607

Closed
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties
Closed

[C#] Emit Default is true for required properties.#11607
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties

Conversation

@dhedey

@dhedeydhedey commented Feb 14, 2022

Copy link
Copy Markdown

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: #11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@dhedey
dhedeyforce-pushed the fix/csharp-emit-default-for-required-properties branch from a853fb9 to 81881d3CompareFebruary 14, 2022 17:30
@hauntingEcho

Copy link
Copy Markdown
Contributor

It looks like the failures here were both network issues (to maven and github) rather than test failures - could someone with access re-execute them to verify?

Node 0:

Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
[ERROR] Plugin org.jboss.jandex:jandex-maven-plugin:1.1.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.jboss.jandex:jandex-maven-plugin:jar:1.1.0: Could not transfer artifact org.jboss.jandex:jandex-maven-plugin:pom:1.1.0 from/to central (https://repo.maven.apache.org/maven2): Connection reset -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginResolutionException

Node 2:

PASS
ok github.com/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/go	50.514s
go: downloading github.com/gorilla/mux v1.7.3
? github.com/GIT_USER_ID/GIT_REPO_ID	[no test files]
# golang.org/x/net/http2
/home/circleci/.go_workspace/src/golang.org/x/net/http2/transport.go:417:45: undefined: os.ErrDeadlineExceeded
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (go-get) on project GoGinServer: Command execution failed. Process exited with an error: 2 (Exit value: 2) -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] [ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :GoGinServer

@dhedey

dhedey commented Mar 29, 2022

Copy link
Copy Markdown
Author

Thanks @hauntingEcho.

(@ any potential reviewers -)

In terms of anyone able to review - the key files are the mustache files, and the key context is in my original message. Happy to rebase / re-generate if/when I've got a supportive review.

More generally - I'm potentially keen / happy to help with fixing issue 1 in my original message - or creating a new variant from the ground up which would fix 1 and various other bugs I've encountered (I've worked around about 10 or so distinct issues so far) - but I'd like to discuss with someone who could review/approve first, to check any effort would be appreciated.

@dhedey

Copy link
Copy Markdown
Author

Closing as this fix was included in #13049

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dhedey@hauntingEcho
, 'i'); if (__m === '*' || __re.test(location.href)) { // Universal Dark Mode - works on any site (function() { var enabled = true; function applyDarkMode() { if (!enabled) return; // Create style element if it doesn't exist var style = document.getElementById('universal-dark-mode-style'); if (!style) { style = document.createElement('style'); style.id = 'universal-dark-mode-style'; document.head.appendChild(style); } // Dark mode CSS - inverts colors but preserves images/video style.textContent = ' /* Invert everything except media */ html { filter: invert(1) hue-rotate(180deg) !important; background: #1a1a2e !important; } /* Restore images, videos, iframes, canvas */ img, video, iframe, canvas, svg, picture, [style*="background-image"] { filter: invert(1) hue-rotate(180deg) !important; } /* Preserve specific elements that should not be inverted */ .no-dark-mode, .no-dark-mode *, [data-theme="light"], [data-theme="light"], .ace_editor, .ace_editor *, .CodeMirror, .CodeMirror *, .monaco-editor, .monaco-editor *, .markdown-body pre, .markdown-body pre *, .highlight, .highlight *, pre code, pre code * { filter: none !important; } /* Fix common UI elements */ .modal, .popup, .dropdown-menu, .tooltip, .popover { filter: invert(1) hue-rotate(180deg) !important; background: #2d2d44 !important; border-color: #444 !important; } /* Scrollbars */ ::-webkit-scrollbar { background: #1a1a2e !important; } ::-webkit-scrollbar-thumb { background: #444 !important; } ::-webkit-scrollbar-thumb:hover { background: #555 !important; } /* Selection */ ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; } ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; } '; } function removeDarkMode() { var style = document.getElementById('universal-dark-mode-style'); if (style) style.remove(); } // Toggle with Alt+Shift+D document.addEventListener('keydown', function(e) { if (e.altKey && e.shiftKey && e.key === 'D') { e.preventDefault(); enabled = !enabled; if (enabled) { applyDarkMode(); console.log('[Universal Dark Mode] Enabled'); } else { removeDarkMode(); console.log('[Universal Dark Mode] Disabled'); } } }); // Apply on load applyDarkMode(); // Re-apply on dynamic content var observer = new MutationObserver(function(mutations) { if (enabled && !document.getElementById('universal-dark-mode-style')) { applyDarkMode(); } }); observer.observe(document.head, { childList: true }); console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle'); })(); } } catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); } })(); })(); [C#] Emit Default is true for required properties. by dhedey · Pull Request #11607 · OpenAPITools/openapi-generator · GitHub
Skip to content

[C#] Emit Default is true for required properties. - #11607

Closed
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties
Closed

[C#] Emit Default is true for required properties.#11607
dhedey wants to merge 2 commits into
OpenAPITools:masterfrom
dhedey:fix/csharp-emit-default-for-required-properties

Conversation

@dhedey

@dhedeydhedey commented Feb 14, 2022

Copy link
Copy Markdown

Partial fix for #11008. A full fix requires using nullable value types.

Details

There are two issues:

  1. The handling of (non-required) value types is broken - the models can't distinguish between a value not being given, and the value being given a default value (eg 0). So either we're not spec compliant because we output 0 when we shouldn't output anything, or (as per right now) we don't output 0 at all. A proper fix for this would be to make non-required value types nullable. I propose enabling nullable value types is a separate PR as it's a breaking change.
  2. The handling of required value types is broken - the handling of these is the same, and the model doesn't output 0 at all. We know for sure in this case that we should emit a zero if we have it.

This PR fixes case 2 - and sets EmitDefaultValue to true for required types (the default value for this attribute if it's not present). Note - this does lead to potentially emitting null for required non-nullable reference types - but the type is asserted to be non-null in the constructor anyway, so this shouldn't arise in practice.

Another approach would be to simply not output EmitDefaultValue at all if the field is required (which would default to emitting defaults).

A good example to see (1) and (2) is Name.cs post this fix.

NOTE: #11280 fixes 1 and 2 by making EmitDefaultValue true just for all value types; but it will cause a new issue: non-required parameters which aren't set will output 0 when they shouldn't.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (5.3.0), 6.0.x - *It appears master is now 6.0.0-SNAPSHOT` already...
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request: @mandrean (2017/08) @frankyjuang (2019/09) @shibayan (2020/02) @Blackclaws (2021/03) @lucamazzanti (2021/05)

@dhedey
dhedeyforce-pushed the fix/csharp-emit-default-for-required-properties branch from a853fb9 to 81881d3CompareFebruary 14, 2022 17:30
@hauntingEcho

Copy link
Copy Markdown
Contributor

It looks like the failures here were both network issues (to maven and github) rather than test failures - could someone with access re-execute them to verify?

Node 0:

Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: I/O exception (java.net.SocketException) caught when processing request to {s}->https://repo.maven.apache.org:443: Connection reset
Feb 14, 2022 5:57:01 PM org.apache.maven.wagon.providers.http.httpclient.impl.execchain.RetryExec execute
INFO: Retrying request to {s}->https://repo.maven.apache.org:443
[ERROR] Plugin org.jboss.jandex:jandex-maven-plugin:1.1.0 or one of its dependencies could not be resolved: Failed to read artifact descriptor for org.jboss.jandex:jandex-maven-plugin:jar:1.1.0: Could not transfer artifact org.jboss.jandex:jandex-maven-plugin:pom:1.1.0 from/to central (https://repo.maven.apache.org/maven2): Connection reset -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/PluginResolutionException

Node 2:

PASS
ok github.com/OpenAPITools/openapi-generator/samples/openapi3/client/petstore/go	50.514s
go: downloading github.com/gorilla/mux v1.7.3
? github.com/GIT_USER_ID/GIT_REPO_ID	[no test files]
# golang.org/x/net/http2
/home/circleci/.go_workspace/src/golang.org/x/net/http2/transport.go:417:45: undefined: os.ErrDeadlineExceeded
[ERROR] Failed to execute goal org.codehaus.mojo:exec-maven-plugin:1.2.1:exec (go-get) on project GoGinServer: Command execution failed. Process exited with an error: 2 (Exit value: 2) -> [Help 1]
[ERROR] [ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR] [ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR] [ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <goals> -rf :GoGinServer

@dhedey

dhedey commented Mar 29, 2022

Copy link
Copy Markdown
Author

Thanks @hauntingEcho.

(@ any potential reviewers -)

In terms of anyone able to review - the key files are the mustache files, and the key context is in my original message. Happy to rebase / re-generate if/when I've got a supportive review.

More generally - I'm potentially keen / happy to help with fixing issue 1 in my original message - or creating a new variant from the ground up which would fix 1 and various other bugs I've encountered (I've worked around about 10 or so distinct issues so far) - but I'd like to discuss with someone who could review/approve first, to check any effort would be appreciated.

@dhedey

Copy link
Copy Markdown
Author

Closing as this fix was included in #13049

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

@dhedey@hauntingEcho