Skip to content

Fix enum types in structs - #3309

Merged
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs
Jul 24, 2019
Merged

Fix enum types in structs#3309
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs

Conversation

@gferon

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the rust (e.g. php, ruby, python, etc) code generator or rust client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I already contributed proper enum supports a few weeks ago, but somehow missed actually using them when they're used as a property. This PR fixes that.

I also took the liberty of fixing a bunch of unused warnings.

cc: @frol@farcaller@bjgill

@bjgillbjgill 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.

Thanks for the fix!

Just found one minor bit where you conflict with another PR's changes. Happy for this to go in once that's sorted.

Not sure what the CI failure is - it looks unrelated.

let client = &configuration.client;

let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});
let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}::apis::urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});

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.

Looking at #3332, should this be crate::apis... instead for compatibility with Rust 2018?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yeah, so crate::apis:: will not work with Rust 2015. I started to switch import statements to the Rust 2018 format, but decided against it to avoid breaking changes. However, since it's already staged, I'll just wait for #3332 to be merged and rebase it.

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.

That sounds fine.

I thought crate::apis::was compatible with Rust 2015, though? If I apply the following diff, the sample continues to compile successfully.

diff --git a/samples/client/petstore/rust-reqwest/Cargo.toml b/samples/client/petstore/rust-reqwest/Cargo.toml
index 6d66b8f7c7..25b15f54fd 100644
--- a/samples/client/petstore/rust-reqwest/Cargo.toml+++ b/samples/client/petstore/rust-reqwest/Cargo.toml@@ -2,6 +2,7 @@
name = "petstore_client"
version = "1.0.0"
authors = ["OpenAPI Generator team and contributors"]
+edition = "2015"
[dependencies]
serde = "^1.0"
diff --git a/samples/client/petstore/rust-reqwest/src/apis/client.rs b/samples/client/petstore/rust-reqwest/src/apis/client.rs
index ea6b0eb635..5233b3cf5d 100644
--- a/samples/client/petstore/rust-reqwest/src/apis/client.rs+++ b/samples/client/petstore/rust-reqwest/src/apis/client.rs@@ -15,7 +15,7 @@ impl APIClient {
APIClient {
configuration: rc.clone(),
- pet_api: Box::new(::apis::PetApiClient::new(rc.clone())),+ pet_api: Box::new(crate::apis::PetApiClient::new(rc.clone())),
store_api: Box::new(::apis::StoreApiClient::new(rc.clone())),
user_api: Box::new(::apis::UserApiClient::new(rc.clone())),
}

I've not done much around the transition between editions, so would not be surprised if I was misunderstanding what was going on here...

@gferongferonJul 17, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, you're totally right, I didn't realize this. I just fixed it in a commit on top, and regenerated the 2 clients. I think you can merge both this one and #3332 independently.

EDIT: I also added a derive(PartialEq, Eq) to the generated structs and enum. I need it for the integration tests where you actually interact with the server and want to assert the results.

@bjgill

Copy link
Copy Markdown
Contributor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

@gferon

Copy link
Copy Markdown
ContributorAuthor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

Done!

@bjgillbjgill added this to the 4.1.0 milestone Jul 24, 2019
@bjgill

Copy link
Copy Markdown
Contributor

Great - thank you! This should go out in v4.1.0, which is due at the end of the month.

@bjgill
bjgill merged commit 2e81e61 into OpenAPITools:masterJul 24, 2019
@antonafMSFT

Copy link
Copy Markdown

This PR added Eq and PartialEq to generated structs, which produces source that won't build when a struct contains eg an f32 field.
Rust intentionally doesn't implement Eq for float types.

Removing the Eq derivations and leaving only the PartialEq works, however.

@bjgillbjgill mentioned this pull request Jul 25, 2019
4 tasks
@bjgill

Copy link
Copy Markdown
Contributor

Oh dear. Good catch - thanks!

I've just raised #3463 to fix

bjgill added a commit that referenced this pull request Jul 29, 2019
It fails if the model contains a float, which don't implement Eq.
Fix for bug introduced in #3309.
We really need to improve the testing of the rust generator to catch this sort of mistake in future. I don't have time to do this now, though.
@wing328

Copy link
Copy Markdown
Member

@gferon thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

Sign up for freeto 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.

4 participants

@gferon@bjgill@antonafMSFT@wing328
, '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" + '
Fix enum types in structs by gferon · Pull Request #3309 · OpenAPITools/openapi-generator · GitHub
Skip to content

Fix enum types in structs - #3309

Merged
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs
Jul 24, 2019
Merged

Fix enum types in structs#3309
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs

Conversation

@gferon

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the rust (e.g. php, ruby, python, etc) code generator or rust client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I already contributed proper enum supports a few weeks ago, but somehow missed actually using them when they're used as a property. This PR fixes that.

I also took the liberty of fixing a bunch of unused warnings.

cc: @frol@farcaller@bjgill

@bjgillbjgill 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.

Thanks for the fix!

Just found one minor bit where you conflict with another PR's changes. Happy for this to go in once that's sorted.

Not sure what the CI failure is - it looks unrelated.

let client = &configuration.client;

let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});
let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}::apis::urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});

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.

Looking at #3332, should this be crate::apis... instead for compatibility with Rust 2018?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yeah, so crate::apis:: will not work with Rust 2015. I started to switch import statements to the Rust 2018 format, but decided against it to avoid breaking changes. However, since it's already staged, I'll just wait for #3332 to be merged and rebase it.

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.

That sounds fine.

I thought crate::apis::was compatible with Rust 2015, though? If I apply the following diff, the sample continues to compile successfully.

diff --git a/samples/client/petstore/rust-reqwest/Cargo.toml b/samples/client/petstore/rust-reqwest/Cargo.toml
index 6d66b8f7c7..25b15f54fd 100644
--- a/samples/client/petstore/rust-reqwest/Cargo.toml+++ b/samples/client/petstore/rust-reqwest/Cargo.toml@@ -2,6 +2,7 @@
name = "petstore_client"
version = "1.0.0"
authors = ["OpenAPI Generator team and contributors"]
+edition = "2015"
[dependencies]
serde = "^1.0"
diff --git a/samples/client/petstore/rust-reqwest/src/apis/client.rs b/samples/client/petstore/rust-reqwest/src/apis/client.rs
index ea6b0eb635..5233b3cf5d 100644
--- a/samples/client/petstore/rust-reqwest/src/apis/client.rs+++ b/samples/client/petstore/rust-reqwest/src/apis/client.rs@@ -15,7 +15,7 @@ impl APIClient {
APIClient {
configuration: rc.clone(),
- pet_api: Box::new(::apis::PetApiClient::new(rc.clone())),+ pet_api: Box::new(crate::apis::PetApiClient::new(rc.clone())),
store_api: Box::new(::apis::StoreApiClient::new(rc.clone())),
user_api: Box::new(::apis::UserApiClient::new(rc.clone())),
}

I've not done much around the transition between editions, so would not be surprised if I was misunderstanding what was going on here...

@gferongferonJul 17, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, you're totally right, I didn't realize this. I just fixed it in a commit on top, and regenerated the 2 clients. I think you can merge both this one and #3332 independently.

EDIT: I also added a derive(PartialEq, Eq) to the generated structs and enum. I need it for the integration tests where you actually interact with the server and want to assert the results.

@bjgill

Copy link
Copy Markdown
Contributor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

@gferon

Copy link
Copy Markdown
ContributorAuthor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

Done!

@bjgillbjgill added this to the 4.1.0 milestone Jul 24, 2019
@bjgill

Copy link
Copy Markdown
Contributor

Great - thank you! This should go out in v4.1.0, which is due at the end of the month.

@bjgill
bjgill merged commit 2e81e61 into OpenAPITools:masterJul 24, 2019
@antonafMSFT

Copy link
Copy Markdown

This PR added Eq and PartialEq to generated structs, which produces source that won't build when a struct contains eg an f32 field.
Rust intentionally doesn't implement Eq for float types.

Removing the Eq derivations and leaving only the PartialEq works, however.

@bjgillbjgill mentioned this pull request Jul 25, 2019
4 tasks
@bjgill

Copy link
Copy Markdown
Contributor

Oh dear. Good catch - thanks!

I've just raised #3463 to fix

bjgill added a commit that referenced this pull request Jul 29, 2019
It fails if the model contains a float, which don't implement Eq.
Fix for bug introduced in #3309.
We really need to improve the testing of the rust generator to catch this sort of mistake in future. I don't have time to do this now, though.
@wing328

Copy link
Copy Markdown
Member

@gferon thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

Sign up for freeto 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.

4 participants

@gferon@bjgill@antonafMSFT@wing328
, '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('^' + ".*" + ' Fix enum types in structs by gferon · Pull Request #3309 · OpenAPITools/openapi-generator · GitHub
Skip to content

Fix enum types in structs - #3309

Merged
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs
Jul 24, 2019
Merged

Fix enum types in structs#3309
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs

Conversation

@gferon

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the rust (e.g. php, ruby, python, etc) code generator or rust client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I already contributed proper enum supports a few weeks ago, but somehow missed actually using them when they're used as a property. This PR fixes that.

I also took the liberty of fixing a bunch of unused warnings.

cc: @frol@farcaller@bjgill

@bjgillbjgill 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.

Thanks for the fix!

Just found one minor bit where you conflict with another PR's changes. Happy for this to go in once that's sorted.

Not sure what the CI failure is - it looks unrelated.

let client = &configuration.client;

let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});
let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}::apis::urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});

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.

Looking at #3332, should this be crate::apis... instead for compatibility with Rust 2018?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yeah, so crate::apis:: will not work with Rust 2015. I started to switch import statements to the Rust 2018 format, but decided against it to avoid breaking changes. However, since it's already staged, I'll just wait for #3332 to be merged and rebase it.

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.

That sounds fine.

I thought crate::apis::was compatible with Rust 2015, though? If I apply the following diff, the sample continues to compile successfully.

diff --git a/samples/client/petstore/rust-reqwest/Cargo.toml b/samples/client/petstore/rust-reqwest/Cargo.toml
index 6d66b8f7c7..25b15f54fd 100644
--- a/samples/client/petstore/rust-reqwest/Cargo.toml+++ b/samples/client/petstore/rust-reqwest/Cargo.toml@@ -2,6 +2,7 @@
name = "petstore_client"
version = "1.0.0"
authors = ["OpenAPI Generator team and contributors"]
+edition = "2015"
[dependencies]
serde = "^1.0"
diff --git a/samples/client/petstore/rust-reqwest/src/apis/client.rs b/samples/client/petstore/rust-reqwest/src/apis/client.rs
index ea6b0eb635..5233b3cf5d 100644
--- a/samples/client/petstore/rust-reqwest/src/apis/client.rs+++ b/samples/client/petstore/rust-reqwest/src/apis/client.rs@@ -15,7 +15,7 @@ impl APIClient {
APIClient {
configuration: rc.clone(),
- pet_api: Box::new(::apis::PetApiClient::new(rc.clone())),+ pet_api: Box::new(crate::apis::PetApiClient::new(rc.clone())),
store_api: Box::new(::apis::StoreApiClient::new(rc.clone())),
user_api: Box::new(::apis::UserApiClient::new(rc.clone())),
}

I've not done much around the transition between editions, so would not be surprised if I was misunderstanding what was going on here...

@gferongferonJul 17, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, you're totally right, I didn't realize this. I just fixed it in a commit on top, and regenerated the 2 clients. I think you can merge both this one and #3332 independently.

EDIT: I also added a derive(PartialEq, Eq) to the generated structs and enum. I need it for the integration tests where you actually interact with the server and want to assert the results.

@bjgill

Copy link
Copy Markdown
Contributor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

@gferon

Copy link
Copy Markdown
ContributorAuthor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

Done!

@bjgillbjgill added this to the 4.1.0 milestone Jul 24, 2019
@bjgill

Copy link
Copy Markdown
Contributor

Great - thank you! This should go out in v4.1.0, which is due at the end of the month.

@bjgill
bjgill merged commit 2e81e61 into OpenAPITools:masterJul 24, 2019
@antonafMSFT

Copy link
Copy Markdown

This PR added Eq and PartialEq to generated structs, which produces source that won't build when a struct contains eg an f32 field.
Rust intentionally doesn't implement Eq for float types.

Removing the Eq derivations and leaving only the PartialEq works, however.

@bjgillbjgill mentioned this pull request Jul 25, 2019
4 tasks
@bjgill

Copy link
Copy Markdown
Contributor

Oh dear. Good catch - thanks!

I've just raised #3463 to fix

bjgill added a commit that referenced this pull request Jul 29, 2019
It fails if the model contains a float, which don't implement Eq.
Fix for bug introduced in #3309.
We really need to improve the testing of the rust generator to catch this sort of mistake in future. I don't have time to do this now, though.
@wing328

Copy link
Copy Markdown
Member

@gferon thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

Sign up for freeto 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.

4 participants

@gferon@bjgill@antonafMSFT@wing328
, '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('^' + ".*" + ' Fix enum types in structs by gferon · Pull Request #3309 · OpenAPITools/openapi-generator · GitHub
Skip to content

Fix enum types in structs - #3309

Merged
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs
Jul 24, 2019
Merged

Fix enum types in structs#3309
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs

Conversation

@gferon

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the rust (e.g. php, ruby, python, etc) code generator or rust client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I already contributed proper enum supports a few weeks ago, but somehow missed actually using them when they're used as a property. This PR fixes that.

I also took the liberty of fixing a bunch of unused warnings.

cc: @frol@farcaller@bjgill

@bjgillbjgill 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.

Thanks for the fix!

Just found one minor bit where you conflict with another PR's changes. Happy for this to go in once that's sorted.

Not sure what the CI failure is - it looks unrelated.

let client = &configuration.client;

let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});
let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}::apis::urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});

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.

Looking at #3332, should this be crate::apis... instead for compatibility with Rust 2018?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yeah, so crate::apis:: will not work with Rust 2015. I started to switch import statements to the Rust 2018 format, but decided against it to avoid breaking changes. However, since it's already staged, I'll just wait for #3332 to be merged and rebase it.

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.

That sounds fine.

I thought crate::apis::was compatible with Rust 2015, though? If I apply the following diff, the sample continues to compile successfully.

diff --git a/samples/client/petstore/rust-reqwest/Cargo.toml b/samples/client/petstore/rust-reqwest/Cargo.toml
index 6d66b8f7c7..25b15f54fd 100644
--- a/samples/client/petstore/rust-reqwest/Cargo.toml+++ b/samples/client/petstore/rust-reqwest/Cargo.toml@@ -2,6 +2,7 @@
name = "petstore_client"
version = "1.0.0"
authors = ["OpenAPI Generator team and contributors"]
+edition = "2015"
[dependencies]
serde = "^1.0"
diff --git a/samples/client/petstore/rust-reqwest/src/apis/client.rs b/samples/client/petstore/rust-reqwest/src/apis/client.rs
index ea6b0eb635..5233b3cf5d 100644
--- a/samples/client/petstore/rust-reqwest/src/apis/client.rs+++ b/samples/client/petstore/rust-reqwest/src/apis/client.rs@@ -15,7 +15,7 @@ impl APIClient {
APIClient {
configuration: rc.clone(),
- pet_api: Box::new(::apis::PetApiClient::new(rc.clone())),+ pet_api: Box::new(crate::apis::PetApiClient::new(rc.clone())),
store_api: Box::new(::apis::StoreApiClient::new(rc.clone())),
user_api: Box::new(::apis::UserApiClient::new(rc.clone())),
}

I've not done much around the transition between editions, so would not be surprised if I was misunderstanding what was going on here...

@gferongferonJul 17, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, you're totally right, I didn't realize this. I just fixed it in a commit on top, and regenerated the 2 clients. I think you can merge both this one and #3332 independently.

EDIT: I also added a derive(PartialEq, Eq) to the generated structs and enum. I need it for the integration tests where you actually interact with the server and want to assert the results.

@bjgill

Copy link
Copy Markdown
Contributor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

@gferon

Copy link
Copy Markdown
ContributorAuthor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

Done!

@bjgillbjgill added this to the 4.1.0 milestone Jul 24, 2019
@bjgill

Copy link
Copy Markdown
Contributor

Great - thank you! This should go out in v4.1.0, which is due at the end of the month.

@bjgill
bjgill merged commit 2e81e61 into OpenAPITools:masterJul 24, 2019
@antonafMSFT

Copy link
Copy Markdown

This PR added Eq and PartialEq to generated structs, which produces source that won't build when a struct contains eg an f32 field.
Rust intentionally doesn't implement Eq for float types.

Removing the Eq derivations and leaving only the PartialEq works, however.

@bjgillbjgill mentioned this pull request Jul 25, 2019
4 tasks
@bjgill

Copy link
Copy Markdown
Contributor

Oh dear. Good catch - thanks!

I've just raised #3463 to fix

bjgill added a commit that referenced this pull request Jul 29, 2019
It fails if the model contains a float, which don't implement Eq.
Fix for bug introduced in #3309.
We really need to improve the testing of the rust generator to catch this sort of mistake in future. I don't have time to do this now, though.
@wing328

Copy link
Copy Markdown
Member

@gferon thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

Sign up for freeto 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.

4 participants

@gferon@bjgill@antonafMSFT@wing328
, '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" + ' Fix enum types in structs by gferon · Pull Request #3309 · OpenAPITools/openapi-generator · GitHub
Skip to content

Fix enum types in structs - #3309

Merged
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs
Jul 24, 2019
Merged

Fix enum types in structs#3309
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs

Conversation

@gferon

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the rust (e.g. php, ruby, python, etc) code generator or rust client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I already contributed proper enum supports a few weeks ago, but somehow missed actually using them when they're used as a property. This PR fixes that.

I also took the liberty of fixing a bunch of unused warnings.

cc: @frol@farcaller@bjgill

@bjgillbjgill 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.

Thanks for the fix!

Just found one minor bit where you conflict with another PR's changes. Happy for this to go in once that's sorted.

Not sure what the CI failure is - it looks unrelated.

let client = &configuration.client;

let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});
let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}::apis::urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});

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.

Looking at #3332, should this be crate::apis... instead for compatibility with Rust 2018?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yeah, so crate::apis:: will not work with Rust 2015. I started to switch import statements to the Rust 2018 format, but decided against it to avoid breaking changes. However, since it's already staged, I'll just wait for #3332 to be merged and rebase it.

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.

That sounds fine.

I thought crate::apis::was compatible with Rust 2015, though? If I apply the following diff, the sample continues to compile successfully.

diff --git a/samples/client/petstore/rust-reqwest/Cargo.toml b/samples/client/petstore/rust-reqwest/Cargo.toml
index 6d66b8f7c7..25b15f54fd 100644
--- a/samples/client/petstore/rust-reqwest/Cargo.toml+++ b/samples/client/petstore/rust-reqwest/Cargo.toml@@ -2,6 +2,7 @@
name = "petstore_client"
version = "1.0.0"
authors = ["OpenAPI Generator team and contributors"]
+edition = "2015"
[dependencies]
serde = "^1.0"
diff --git a/samples/client/petstore/rust-reqwest/src/apis/client.rs b/samples/client/petstore/rust-reqwest/src/apis/client.rs
index ea6b0eb635..5233b3cf5d 100644
--- a/samples/client/petstore/rust-reqwest/src/apis/client.rs+++ b/samples/client/petstore/rust-reqwest/src/apis/client.rs@@ -15,7 +15,7 @@ impl APIClient {
APIClient {
configuration: rc.clone(),
- pet_api: Box::new(::apis::PetApiClient::new(rc.clone())),+ pet_api: Box::new(crate::apis::PetApiClient::new(rc.clone())),
store_api: Box::new(::apis::StoreApiClient::new(rc.clone())),
user_api: Box::new(::apis::UserApiClient::new(rc.clone())),
}

I've not done much around the transition between editions, so would not be surprised if I was misunderstanding what was going on here...

@gferongferonJul 17, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, you're totally right, I didn't realize this. I just fixed it in a commit on top, and regenerated the 2 clients. I think you can merge both this one and #3332 independently.

EDIT: I also added a derive(PartialEq, Eq) to the generated structs and enum. I need it for the integration tests where you actually interact with the server and want to assert the results.

@bjgill

Copy link
Copy Markdown
Contributor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

@gferon

Copy link
Copy Markdown
ContributorAuthor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

Done!

@bjgillbjgill added this to the 4.1.0 milestone Jul 24, 2019
@bjgill

Copy link
Copy Markdown
Contributor

Great - thank you! This should go out in v4.1.0, which is due at the end of the month.

@bjgill
bjgill merged commit 2e81e61 into OpenAPITools:masterJul 24, 2019
@antonafMSFT

Copy link
Copy Markdown

This PR added Eq and PartialEq to generated structs, which produces source that won't build when a struct contains eg an f32 field.
Rust intentionally doesn't implement Eq for float types.

Removing the Eq derivations and leaving only the PartialEq works, however.

@bjgillbjgill mentioned this pull request Jul 25, 2019
4 tasks
@bjgill

Copy link
Copy Markdown
Contributor

Oh dear. Good catch - thanks!

I've just raised #3463 to fix

bjgill added a commit that referenced this pull request Jul 29, 2019
It fails if the model contains a float, which don't implement Eq.
Fix for bug introduced in #3309.
We really need to improve the testing of the rust generator to catch this sort of mistake in future. I don't have time to do this now, though.
@wing328

Copy link
Copy Markdown
Member

@gferon thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

Sign up for freeto 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.

4 participants

@gferon@bjgill@antonafMSFT@wing328
, '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('^' + ".*" + ' Fix enum types in structs by gferon · Pull Request #3309 · OpenAPITools/openapi-generator · GitHub
Skip to content

Fix enum types in structs - #3309

Merged
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs
Jul 24, 2019
Merged

Fix enum types in structs#3309
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs

Conversation

@gferon

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the rust (e.g. php, ruby, python, etc) code generator or rust client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I already contributed proper enum supports a few weeks ago, but somehow missed actually using them when they're used as a property. This PR fixes that.

I also took the liberty of fixing a bunch of unused warnings.

cc: @frol@farcaller@bjgill

@bjgillbjgill 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.

Thanks for the fix!

Just found one minor bit where you conflict with another PR's changes. Happy for this to go in once that's sorted.

Not sure what the CI failure is - it looks unrelated.

let client = &configuration.client;

let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});
let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}::apis::urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});

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.

Looking at #3332, should this be crate::apis... instead for compatibility with Rust 2018?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yeah, so crate::apis:: will not work with Rust 2015. I started to switch import statements to the Rust 2018 format, but decided against it to avoid breaking changes. However, since it's already staged, I'll just wait for #3332 to be merged and rebase it.

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.

That sounds fine.

I thought crate::apis::was compatible with Rust 2015, though? If I apply the following diff, the sample continues to compile successfully.

diff --git a/samples/client/petstore/rust-reqwest/Cargo.toml b/samples/client/petstore/rust-reqwest/Cargo.toml
index 6d66b8f7c7..25b15f54fd 100644
--- a/samples/client/petstore/rust-reqwest/Cargo.toml+++ b/samples/client/petstore/rust-reqwest/Cargo.toml@@ -2,6 +2,7 @@
name = "petstore_client"
version = "1.0.0"
authors = ["OpenAPI Generator team and contributors"]
+edition = "2015"
[dependencies]
serde = "^1.0"
diff --git a/samples/client/petstore/rust-reqwest/src/apis/client.rs b/samples/client/petstore/rust-reqwest/src/apis/client.rs
index ea6b0eb635..5233b3cf5d 100644
--- a/samples/client/petstore/rust-reqwest/src/apis/client.rs+++ b/samples/client/petstore/rust-reqwest/src/apis/client.rs@@ -15,7 +15,7 @@ impl APIClient {
APIClient {
configuration: rc.clone(),
- pet_api: Box::new(::apis::PetApiClient::new(rc.clone())),+ pet_api: Box::new(crate::apis::PetApiClient::new(rc.clone())),
store_api: Box::new(::apis::StoreApiClient::new(rc.clone())),
user_api: Box::new(::apis::UserApiClient::new(rc.clone())),
}

I've not done much around the transition between editions, so would not be surprised if I was misunderstanding what was going on here...

@gferongferonJul 17, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, you're totally right, I didn't realize this. I just fixed it in a commit on top, and regenerated the 2 clients. I think you can merge both this one and #3332 independently.

EDIT: I also added a derive(PartialEq, Eq) to the generated structs and enum. I need it for the integration tests where you actually interact with the server and want to assert the results.

@bjgill

Copy link
Copy Markdown
Contributor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

@gferon

Copy link
Copy Markdown
ContributorAuthor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

Done!

@bjgillbjgill added this to the 4.1.0 milestone Jul 24, 2019
@bjgill

Copy link
Copy Markdown
Contributor

Great - thank you! This should go out in v4.1.0, which is due at the end of the month.

@bjgill
bjgill merged commit 2e81e61 into OpenAPITools:masterJul 24, 2019
@antonafMSFT

Copy link
Copy Markdown

This PR added Eq and PartialEq to generated structs, which produces source that won't build when a struct contains eg an f32 field.
Rust intentionally doesn't implement Eq for float types.

Removing the Eq derivations and leaving only the PartialEq works, however.

@bjgillbjgill mentioned this pull request Jul 25, 2019
4 tasks
@bjgill

Copy link
Copy Markdown
Contributor

Oh dear. Good catch - thanks!

I've just raised #3463 to fix

bjgill added a commit that referenced this pull request Jul 29, 2019
It fails if the model contains a float, which don't implement Eq.
Fix for bug introduced in #3309.
We really need to improve the testing of the rust generator to catch this sort of mistake in future. I don't have time to do this now, though.
@wing328

Copy link
Copy Markdown
Member

@gferon thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

Sign up for freeto 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.

4 participants

@gferon@bjgill@antonafMSFT@wing328
, '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('^' + ".*" + ' Fix enum types in structs by gferon · Pull Request #3309 · OpenAPITools/openapi-generator · GitHub
Skip to content

Fix enum types in structs - #3309

Merged
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs
Jul 24, 2019
Merged

Fix enum types in structs#3309
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs

Conversation

@gferon

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the rust (e.g. php, ruby, python, etc) code generator or rust client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I already contributed proper enum supports a few weeks ago, but somehow missed actually using them when they're used as a property. This PR fixes that.

I also took the liberty of fixing a bunch of unused warnings.

cc: @frol@farcaller@bjgill

@bjgillbjgill 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.

Thanks for the fix!

Just found one minor bit where you conflict with another PR's changes. Happy for this to go in once that's sorted.

Not sure what the CI failure is - it looks unrelated.

let client = &configuration.client;

let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});
let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}::apis::urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});

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.

Looking at #3332, should this be crate::apis... instead for compatibility with Rust 2018?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yeah, so crate::apis:: will not work with Rust 2015. I started to switch import statements to the Rust 2018 format, but decided against it to avoid breaking changes. However, since it's already staged, I'll just wait for #3332 to be merged and rebase it.

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.

That sounds fine.

I thought crate::apis::was compatible with Rust 2015, though? If I apply the following diff, the sample continues to compile successfully.

diff --git a/samples/client/petstore/rust-reqwest/Cargo.toml b/samples/client/petstore/rust-reqwest/Cargo.toml
index 6d66b8f7c7..25b15f54fd 100644
--- a/samples/client/petstore/rust-reqwest/Cargo.toml+++ b/samples/client/petstore/rust-reqwest/Cargo.toml@@ -2,6 +2,7 @@
name = "petstore_client"
version = "1.0.0"
authors = ["OpenAPI Generator team and contributors"]
+edition = "2015"
[dependencies]
serde = "^1.0"
diff --git a/samples/client/petstore/rust-reqwest/src/apis/client.rs b/samples/client/petstore/rust-reqwest/src/apis/client.rs
index ea6b0eb635..5233b3cf5d 100644
--- a/samples/client/petstore/rust-reqwest/src/apis/client.rs+++ b/samples/client/petstore/rust-reqwest/src/apis/client.rs@@ -15,7 +15,7 @@ impl APIClient {
APIClient {
configuration: rc.clone(),
- pet_api: Box::new(::apis::PetApiClient::new(rc.clone())),+ pet_api: Box::new(crate::apis::PetApiClient::new(rc.clone())),
store_api: Box::new(::apis::StoreApiClient::new(rc.clone())),
user_api: Box::new(::apis::UserApiClient::new(rc.clone())),
}

I've not done much around the transition between editions, so would not be surprised if I was misunderstanding what was going on here...

@gferongferonJul 17, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, you're totally right, I didn't realize this. I just fixed it in a commit on top, and regenerated the 2 clients. I think you can merge both this one and #3332 independently.

EDIT: I also added a derive(PartialEq, Eq) to the generated structs and enum. I need it for the integration tests where you actually interact with the server and want to assert the results.

@bjgill

Copy link
Copy Markdown
Contributor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

@gferon

Copy link
Copy Markdown
ContributorAuthor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

Done!

@bjgillbjgill added this to the 4.1.0 milestone Jul 24, 2019
@bjgill

Copy link
Copy Markdown
Contributor

Great - thank you! This should go out in v4.1.0, which is due at the end of the month.

@bjgill
bjgill merged commit 2e81e61 into OpenAPITools:masterJul 24, 2019
@antonafMSFT

Copy link
Copy Markdown

This PR added Eq and PartialEq to generated structs, which produces source that won't build when a struct contains eg an f32 field.
Rust intentionally doesn't implement Eq for float types.

Removing the Eq derivations and leaving only the PartialEq works, however.

@bjgillbjgill mentioned this pull request Jul 25, 2019
4 tasks
@bjgill

Copy link
Copy Markdown
Contributor

Oh dear. Good catch - thanks!

I've just raised #3463 to fix

bjgill added a commit that referenced this pull request Jul 29, 2019
It fails if the model contains a float, which don't implement Eq.
Fix for bug introduced in #3309.
We really need to improve the testing of the rust generator to catch this sort of mistake in future. I don't have time to do this now, though.
@wing328

Copy link
Copy Markdown
Member

@gferon thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

Sign up for freeto 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.

4 participants

@gferon@bjgill@antonafMSFT@wing328
, '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); } })(); })(); Fix enum types in structs by gferon · Pull Request #3309 · OpenAPITools/openapi-generator · GitHub
Skip to content

Fix enum types in structs - #3309

Merged
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs
Jul 24, 2019
Merged

Fix enum types in structs#3309
bjgill merged 5 commits into
OpenAPITools:masterfrom
gferon:fix-enum-types-in-structs

Conversation

@gferon

Copy link
Copy Markdown
Contributor

PR checklist

  • Read the contribution guidelines.
  • Ran the shell script under ./bin/ to update Petstore sample so that CIs can verify the change. (For instance, only need to run ./bin/{LANG}-petstore.sh, ./bin/openapi3/{LANG}-petstore.sh if updating the rust (e.g. php, ruby, python, etc) code generator or rust client's mustache templates). Windows batch files can be found in .\bin\windows\. If contributing template-only or documentation-only changes which will change sample output, be sure to build the project first.
  • Filed the PR against the correct branch: master, 4.1.x, 5.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

Description of the PR

I already contributed proper enum supports a few weeks ago, but somehow missed actually using them when they're used as a property. This PR fixes that.

I also took the liberty of fixing a bunch of unused warnings.

cc: @frol@farcaller@bjgill

@bjgillbjgill 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.

Thanks for the fix!

Just found one minor bit where you conflict with another PR's changes. Happy for this to go in once that's sorted.

Not sure what the CI failure is - it looks unrelated.

let client = &configuration.client;

let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});
let uri_str = format!("{}{{{path}}}", configuration.base_path{{#pathParams}}, {{{baseName}}}={{#isString}}::apis::urlencode({{/isString}}{{{paramName}}}{{#isListContainer}}.join(",").as_ref(){{/isListContainer}}{{#isString}}){{/isString}}{{/pathParams}});

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.

Looking at #3332, should this be crate::apis... instead for compatibility with Rust 2018?

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

yeah, so crate::apis:: will not work with Rust 2015. I started to switch import statements to the Rust 2018 format, but decided against it to avoid breaking changes. However, since it's already staged, I'll just wait for #3332 to be merged and rebase it.

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.

That sounds fine.

I thought crate::apis::was compatible with Rust 2015, though? If I apply the following diff, the sample continues to compile successfully.

diff --git a/samples/client/petstore/rust-reqwest/Cargo.toml b/samples/client/petstore/rust-reqwest/Cargo.toml
index 6d66b8f7c7..25b15f54fd 100644
--- a/samples/client/petstore/rust-reqwest/Cargo.toml+++ b/samples/client/petstore/rust-reqwest/Cargo.toml@@ -2,6 +2,7 @@
name = "petstore_client"
version = "1.0.0"
authors = ["OpenAPI Generator team and contributors"]
+edition = "2015"
[dependencies]
serde = "^1.0"
diff --git a/samples/client/petstore/rust-reqwest/src/apis/client.rs b/samples/client/petstore/rust-reqwest/src/apis/client.rs
index ea6b0eb635..5233b3cf5d 100644
--- a/samples/client/petstore/rust-reqwest/src/apis/client.rs+++ b/samples/client/petstore/rust-reqwest/src/apis/client.rs@@ -15,7 +15,7 @@ impl APIClient {
APIClient {
configuration: rc.clone(),
- pet_api: Box::new(::apis::PetApiClient::new(rc.clone())),+ pet_api: Box::new(crate::apis::PetApiClient::new(rc.clone())),
store_api: Box::new(::apis::StoreApiClient::new(rc.clone())),
user_api: Box::new(::apis::UserApiClient::new(rc.clone())),
}

I've not done much around the transition between editions, so would not be surprised if I was misunderstanding what was going on here...

@gferongferonJul 17, 2019

Copy link
Copy Markdown
ContributorAuthor

Choose a reason for hiding this comment

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

Actually, you're totally right, I didn't realize this. I just fixed it in a commit on top, and regenerated the 2 clients. I think you can merge both this one and #3332 independently.

EDIT: I also added a derive(PartialEq, Eq) to the generated structs and enum. I need it for the integration tests where you actually interact with the server and want to assert the results.

@bjgill

Copy link
Copy Markdown
Contributor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

@gferon

Copy link
Copy Markdown
ContributorAuthor

The other PR's gone in. I'm happy to merge this once the conflicts have been fixed.

Done!

@bjgillbjgill added this to the 4.1.0 milestone Jul 24, 2019
@bjgill

Copy link
Copy Markdown
Contributor

Great - thank you! This should go out in v4.1.0, which is due at the end of the month.

@bjgill
bjgill merged commit 2e81e61 into OpenAPITools:masterJul 24, 2019
@antonafMSFT

Copy link
Copy Markdown

This PR added Eq and PartialEq to generated structs, which produces source that won't build when a struct contains eg an f32 field.
Rust intentionally doesn't implement Eq for float types.

Removing the Eq derivations and leaving only the PartialEq works, however.

@bjgillbjgill mentioned this pull request Jul 25, 2019
4 tasks
@bjgill

Copy link
Copy Markdown
Contributor

Oh dear. Good catch - thanks!

I've just raised #3463 to fix

bjgill added a commit that referenced this pull request Jul 29, 2019
It fails if the model contains a float, which don't implement Eq.
Fix for bug introduced in #3309.
We really need to improve the testing of the rust generator to catch this sort of mistake in future. I don't have time to do this now, though.
@wing328

Copy link
Copy Markdown
Member

@gferon thanks for the PR, which has been included in the 4.1.0 release: https://twitter.com/oas_generator/status/1160000504455319553

Sign up for freeto 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.

4 participants

@gferon@bjgill@antonafMSFT@wing328