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

Add webpage translation functionality #25

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

SleeplessOne1917
Copy link

@SleeplessOne1917 SleeplessOne1917 commented May 12, 2023

This is implementing the enhancement from #21. Closes #21.

README.md Show resolved Hide resolved
Copy link
Member

@JanEbbing JanEbbing left a comment

Choose a reason for hiding this comment

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

Thanks so much, this looks great! Just some small nitpicks.
There is also a CHANGELOG.md file where you should mention this.

I can add a test for this later.
I also think there's a slightly cleaner way to enable the HTTPClient to make external HTTP requests, I will think a bit about it.

src/client.ts Outdated Show resolved Hide resolved
src/client.ts Outdated Show resolved Hide resolved
src/client.ts Outdated Show resolved Hide resolved
src/index.ts Outdated Show resolved Hide resolved
@@ -1003,6 +1056,18 @@ export class Translator {
return libraryInfoString;
}

private async getContentFromWebpage(webpageUrl: string | URL): Promise<string> {
const { statusCode, content, contentType } =
await this.httpClient.sendRequestWithBackoff<string>('GET', webpageUrl.toString());
Copy link
Member

Choose a reason for hiding this comment

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

Actually, using this method will leak the DeepL API key to this website (as it's in the headers).
I think a simple way to solve this is to add a method like sendExternalWebRequest to the httpClient, that just reimplements sending an HTTP request, using e.g. the proxy config from the client and any options added in the request, and use that for the downloadWebpage functionality.

Copy link
Author

@SleeplessOne1917 SleeplessOne1917 May 29, 2023

Choose a reason for hiding this comment

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

I ended up stripping the Authorization header from the request before it gets sent if the request is a webpage request. It seemed more straightforward than making a whole new function. See my other comment.

options,
);

if (!isDeepLUrl && axiosRequestConfig.headers) {
delete axiosRequestConfig.headers.Authorization;
Copy link
Author

Choose a reason for hiding this comment

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

This is where I strip the API key if the request is going to an external domain.

@SleeplessOne1917
Copy link
Author

@JanEbbing I made the requested changes awhile ago. Pinging you in case you didn't see.

Copy link
Member

@JanEbbing JanEbbing left a comment

Choose a reason for hiding this comment

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

Manually deleting the API key from the headers seems fine to me. Requesting 2 small changes, then this should be good to go, thanks so much for your work!

src/client.ts Show resolved Hide resolved
src/client.ts Outdated Show resolved Hide resolved
@JanEbbing
Copy link
Member

Awesome, thanks - as this is a bigger feature we are going through an internal review at the moment. To be consistent with the project standards, could you please squash all commits into a single one and use conventional commit naming (feat: Add webpage translation functionality)

@SleeplessOne1917
Copy link
Author

I can do that, although isn't commit squashing done at merge time?

@SleeplessOne1917
Copy link
Author

SleeplessOne1917 commented Sep 21, 2023

@JanEbbing Does github give you an option to squash commits before merging PR's? It's probably more straightforward to do it that way if available. I figured it out.

@jhwheeler
Copy link

When will this be merged? It's a great feature!

@SleeplessOne1917
Copy link
Author

@JanEbbing Do you plan on merging this at any point?

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

Feature Idea: Translate webpage from url
3 participants