Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

use of path.join causes test failures on Windows #226

Closed
jeffmcaffer opened this issue Oct 8, 2020 · 1 comment
Closed

use of path.join causes test failures on Windows #226

jeffmcaffer opened this issue Oct 8, 2020 · 1 comment
Labels
bug An error or flaw that causes unintended or unexpected results engineering Will involve Docs Engineering triage Do not begin working on this issue until triaged by the team

Comments

@jeffmcaffer
Copy link
Contributor

What is the current behavior?

there are several places in the code where path.join is used in the creation of a URL. Unfortunately, on windows the path separator is ``` and that produces invalid URLs. While we may not intend the service to actually run on Windows, community members seeking to contribute and working on Windows will want to run the tests which expect valid URLs.

See the following for specific examples. There may well be more.

Unfortunately there are lots of legit uses of path.join so a simple search for that pattern is pretty noisy. I don't have a good enough handle on the codebase to easily identify which parts are likely to construct URLs.

Would be super interesting to have a CodeQL query that detects the use of path.join to create value that's eventually returned in a header or some such.

What changes are you suggesting?

cc: @github/docs-engineering

@jeffmcaffer jeffmcaffer added bug An error or flaw that causes unintended or unexpected results engineering Will involve Docs Engineering labels Oct 8, 2020
@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Oct 8, 2020
@chiedo
Copy link
Contributor

chiedo commented Oct 8, 2020

Connected with @jeffmcaffer. He's going to run point on this and I'm going to pair with him as needed to provide some additional engineering support!

@zeke zeke added the windows label Oct 8, 2020
@chiedo chiedo closed this as completed Oct 12, 2020
jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this issue Oct 6, 2022
* Setup and edit index page

* Edit existing content and move security content to security page

* Small edits and remove unused links

* Apply suggestions from code review

Co-authored-by: Ryan Booz <[email protected]>

* Update timescale-cloud/page-index/page-index.js

Co-authored-by: Ryan Booz <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug An error or flaw that causes unintended or unexpected results engineering Will involve Docs Engineering triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

No branches or pull requests

4 participants
@zeke @chiedo @jeffmcaffer and others