') + ')', '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('^' + ".*" + ', '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" + ', '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('^' + ".*" + ', '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); } })(); })(); Clean up file output handling by jimschubert · Pull Request #1895 · OpenAPITools/openapi-generator · GitHub
Skip to content

Clean up file output handling - #1895

Merged
wing328 merged 6 commits into
masterfrom
fix-path-cleaning-on-write
Jan 14, 2019
Merged

Clean up file output handling#1895
wing328 merged 6 commits into
masterfrom
fix-path-cleaning-on-write

Conversation

@jimschubert

@jimschubertjimschubert commented Jan 12, 2019

Copy link
Copy Markdown
Member

This attempts to normalize all generators to use OS agnostic
File.separator.

It also fixes a bug in some areas in code where we replace "." in full file
output path with File.separator. We should only be modifying directory
names we own, and should avoid modifying anything that can be provided
by a user.

It would probably be better to use Paths.get(…).toString() in all cases.

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 and ./bin/security/{LANG}-petstore.sh if updating the {LANG} (e.g. php, ruby, python, etc) code generator or {LANG} client's mustache templates). Windows batch files can be found in .\bin\windows\.
  • Filed the PR against the correct branch: master, 3.4.x, 4.0.x. Default: master.
  • Copied the technical committee to review the pull request if your PR is targeting a particular programming language.

@jimschubert
Clean up file output handling
481ba34
This attempts to normalize all generators to use OS agnostic
File.separator.
It also cleans up some areas in code where we replace "." in full file
output path with File.separator. We should only be modifying directory
names we own, and should avoid modifying anything that can be provided
by a user.
It would probably be better to use Paths.get(…).toString() in all cases.
@jimschubert
Fix missed path separators in java codegen
e97527d
@jimschubert

jimschubert commented Jan 12, 2019

Copy link
Copy Markdown
MemberAuthor

This should fix #1834.

@wing328

wing328 commented Jan 12, 2019

Copy link
Copy Markdown
Member

@jimschubert thanks for the PR. I'll review later today.

Have a nice weekend.

@jimschubertjimschubert mentioned this pull request Jan 12, 2019
Closed
@jimschubert
Merge branch 'master' into fix-path-cleaning-on-write
50bfd06
* master:
Add links to Patreon account (#1887)
Python AIOHTTP server generator (#1470)
Fix a problem that points to a folder that doesn't exist (#1863)
Python: Update api_doc_example for multiple auth (#1870)
[gradle] Add 4 boolean properties supported by codegenConfigurator (#1881)
@jimschubert

jimschubert commented Jan 12, 2019

Copy link
Copy Markdown
MemberAuthor

@wing328 no problem. I've fixed merge conflicts.

To repro #1834, you can use -o some.dir on master and supporting files will write to some.dir while model/apis will write to some/dir. This was all in AbstractJavaCodegen.java. Other files were normalization of File.separator and usually moving parens so we didn't modify the user-specified outputFolder value.

@ackintosh

ackintosh commented Jan 12, 2019

Copy link
Copy Markdown
Contributor

https://travis-ci.org/OpenAPITools/openapi-generator/builds/478650968?utm_source=github_status&utm_medium=notification

It seems the issue that fixed in #1863 occurs again. 👀

@wing328

wing328 commented Jan 12, 2019

Copy link
Copy Markdown
Member

and here are the errors reported by Travis (and other CIs):

[ERROR] Tests run: 520, Failures: 4, Errors: 0, Skipped: 0, Time elapsed: 11.875 s <<< FAILURE! - in TestSuite
[ERROR] apiFileFolder(org.openapitools.codegen.java.AbstractJavaCodegenTest) Time elapsed: 0.009 s <<< FAILURE!
java.lang.AssertionError: expected [/User/open.api.tools/source.folder/org/openapitools/codegen/api] but found [/User/open.api.tools/source/folder/org/openapitools/codegen/api]
at org.openapitools.codegen.java.AbstractJavaCodegenTest.apiFileFolder(AbstractJavaCodegenTest.java:167)
[ERROR] apiTestFileFolder(org.openapitools.codegen.java.AbstractJavaCodegenTest) Time elapsed: 0 s <<< FAILURE!
java.lang.AssertionError: expected [/User/open.api.tools/test.folder/org/openapitools/codegen/api] but found [/User/open.api.tools/test/folder/org/openapitools/codegen/api]
at org.openapitools.codegen.java.AbstractJavaCodegenTest.apiTestFileFolder(AbstractJavaCodegenTest.java:176)
[ERROR] modelFileFolder(org.openapitools.codegen.java.AbstractJavaCodegenTest) Time elapsed: 0.001 s <<< FAILURE!
java.lang.AssertionError: expected [/User/open.api.tools/source.folder/org/openapitools/codegen/model] but found [/User/open.api.tools/source/folder/org/openapitools/codegen/model]
at org.openapitools.codegen.java.AbstractJavaCodegenTest.modelFileFolder(AbstractJavaCodegenTest.java:194)
[ERROR] modelTestFileFolder(org.openapitools.codegen.java.AbstractJavaCodegenTest) Time elapsed: 0 s <<< FAILURE!
java.lang.AssertionError: expected [/User/open.api.tools/test.folder/org/openapitools/codegen/model] but found [/User/open.api.tools/test/folder/org/openapitools/codegen/model]
at org.openapitools.codegen.java.AbstractJavaCodegenTest.modelTestFileFolder(AbstractJavaCodegenTest.java:185)

@jimschubert

jimschubert commented Jan 12, 2019

Copy link
Copy Markdown
MemberAuthor

Sorry about that. I merged in master to fix the file conflicts and it introduced another path replacement and groupings ended up shifting during merge.

I'm currently needing to push to remote in order to have tests run, because after evaluating the Guava issue with Android Gradle Plugin, the test suite locks up on my machine.

@jimschubert

jimschubert commented Jan 12, 2019

Copy link
Copy Markdown
MemberAuthor

Last commit should fix the shippable issue for Windows. I have concerns that a user on Windows would never provide a path like /Users/jim/path and require a / replacement to \. Considering / is an invalid path character in Windows I think this is fine from a testing perspective. However, most generators don't do this, so we may want to either update this universally across all generators or do it in DefaultGenerator before using these values.

@jimschubert

jimschubert commented Jan 12, 2019

Copy link
Copy Markdown
MemberAuthor

As mentioned above, and discussed in chat, I've used Paths.get at the point of writing files to cover
normalization of path for all generators.

This resolves an issue, for instance when you do Paths.get("C:/Users/jim/mypath") on Windows in any generator, we expect to write to C:\Users\jim\mypath. This should also handle normalizing filenames with spaces in all operating systems. Using Paths.get will also expose a better exception for invalid path characters, which should help us to track down issues with path characters a little better in the future.

ackintosh
ackintosh approved these changes Jan 14, 2019
View reviewed changes

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

Cool! LGTM ✨

wing328
wing328 approved these changes Jan 14, 2019
View reviewed changes

@wing328wing328 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@wing328
wing328 merged commit db9102a into masterJan 14, 2019
@wing328
wing328 deleted the fix-path-cleaning-on-write branch January 14, 2019 14:49
@wing328wing328 added this to the 4.0.0 milestone Jan 31, 2019
A-Joshi pushed a commit to ihsmarkitoss/openapi-generator that referenced this pull request Feb 27, 2019
@jimschubert@wing328
Clean up file output handling (OpenAPITools#1895)
2c4ab38
* Clean up file output handling
This attempts to normalize all generators to use OS agnostic
File.separator.
It also cleans up some areas in code where we replace "." in full file
output path with File.separator. We should only be modifying directory
names we own, and should avoid modifying anything that can be provided
by a user.
It would probably be better to use Paths.get(…).toString() in all cases.
* Fix missed path separators in java codegen
* Adjust Java codegen path replacements
* Convert / in full path replacements, as / is forbidden in Windows, and noop elsewhere
* Use Paths.get where files are written, to better handle Windows path constraints
j-fontaine added a commit to connexta/ion-ingest-api that referenced this pull request Jun 24, 2019
@j-fontaine
Update OpenAPITools openapi-generator from version 4.0.0-beta to 4.0.2
f79a64e
This should fix an issue where output path names containing . were not being interpretted properly
REFERENCE: OpenAPITools/openapi-generator#1895
@j-fontainej-fontaine mentioned this pull request Jun 24, 2019
Merged
3 tasks
j-fontaine added a commit to connexta/ion-ingest-api that referenced this pull request Jun 24, 2019
@j-fontaine
Update OpenAPITools openapi-generator from version 4.0.0-beta to 4.0.2
821bf05
This should fix an issue where output path names containing . were not being interpretted properly
REFERENCE: OpenAPITools/openapi-generator#1895
@j-fontainej-fontaine mentioned this pull request Jun 26, 2019
Open
3 tasks
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@wing328wing328wing328 approved these changes
+1 more reviewer
@ackintoshackintoshackintosh approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

Issue: Bug

Projects

None yet

Milestone

4.0.0

Development

Successfully merging this pull request may close these issues.

3 participants

@jimschubert@wing328@ackintosh