Skip to content

Remove code that relies on node's path module #598

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.

Sign up for GitHub

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

Merged
jasonpaulos merged 5 commits into from
Jul 1, 2022
Merged

Remove code that relies on node's path module #598

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
0e4f217
Remove code that relies on node's path module
bmdelacruz Jun 26, 2022
87f8ceb
Replace url-parse with built in WHATWG URL API
bmdelacruz Jun 26, 2022
4d4fcd4
Removed path-browserify fallback from webpack config
bmdelacruz Jun 26, 2022
cdf14a5
Removed path-browserify and url-parse from npm dependencies
bmdelacruz Jun 26, 2022
9ae7db3
Removed references to `path-browserify` in FAQ.md
bmdelacruz Jul 1, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
54 changes: 1 addition & 53 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 1 addition & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@
"js-sha512": "^0.8.0",
"json-bigint": "^1.0.0",
"superagent": "^6.1.0",
"tweetnacl": "^1.0.3",
"url-parse": "^1.5.1"
"tweetnacl": "^1.0.3"
},
"devDependencies": {
"@types/json-bigint": "^1.0.0",
Expand All @@ -53,7 +52,6 @@
"mocha": "^9.0.0",
"mocha-lcov-reporter": "^1.3.0",
"mock-http-server": "^1.4.3",
"path-browserify": "^1.0.1",
"prettier": "2.2.1",
"selenium-webdriver": "^4.2.0",
"source-map-loader": "^2.0.2",
Expand Down
27 changes: 18 additions & 9 deletions src/client/urlTokenBaseHTTPClient.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,3 @@
import Url from 'url-parse';
import path from 'path';
import * as request from 'superagent';
import {
BaseHTTPClient,
Expand Down Expand Up @@ -35,7 +33,7 @@ export type TokenHeader =
* This is the default implementation of BaseHTTPClient.
*/
export class URLTokenBaseHTTPClient implements BaseHTTPClient {
private readonly baseURL: Url;
private readonly baseURL: URL;
private readonly tokenHeader: TokenHeader;

constructor(
Expand All @@ -44,9 +42,15 @@ export class URLTokenBaseHTTPClient implements BaseHTTPClient {
port?: string | number,
private defaultHeaders: Record<string, any> = {}
) {
const baseServerURL = new Url(baseServer, {});
// Append a trailing slash so we can use relative paths. Without the trailing
// slash, the last path segment will be replaced by the relative path. See
// usage in `addressWithPath`.
const fixedBaseServer = baseServer.endsWith('/')
? baseServer
: `${baseServer}/`;
const baseServerURL = new URL(fixedBaseServer);
if (typeof port !== 'undefined') {
baseServerURL.set('port', port.toString());
baseServerURL.port = port.toString();
}

if (baseServerURL.protocol.length === 0) {
Expand All @@ -63,10 +67,15 @@ export class URLTokenBaseHTTPClient implements BaseHTTPClient {
* @returns A URL string
*/
private addressWithPath(relativePath: string) {
const address = new Url(
path.posix.join(this.baseURL.pathname, relativePath),
this.baseURL
);
let fixedRelativePath: string;
if (relativePath.startsWith('./')) {
fixedRelativePath = relativePath;
} else if (relativePath.startsWith('/')) {
fixedRelativePath = `.${relativePath}`;
} else {
fixedRelativePath = `./${relativePath}`;
}
const address = new URL(fixedRelativePath, this.baseURL);
return address.toString();
}

Expand Down
5 changes: 0 additions & 5 deletions webpack.config.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,6 @@ module.exports = {
resolve: {
// Add '.ts' as resolvable extensions
extensions: ['.ts', '.js'],

// Support `path` in the browser
fallback: {
path: require.resolve('path-browserify'),
},
},
plugins: [
new webpack.ProvidePlugin({
Expand Down