google-common[patch]: adding client-info #5103

tanyaasharma · 2024-04-15T18:34:37Z

Fixes # (issue)

vercel · 2024-04-15T18:34:42Z

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
langchainjs-api-refs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	May 1, 2024 0:08am
langchainjs-docs	✅ Ready (Inspect)	Visit Preview		May 1, 2024 0:08am

dosubot · 2024-04-15T18:34:55Z

libs/langchain-google-common/src/connection.ts

@@ -53,11 +53,28 @@ export abstract class GoogleConnection<



Hey team, just wanted to flag the recent change in the PR for your review. The added _getclientInfo function calls getRuntimeEnvironment, which is expected to access or read environment variables or configuration related to the runtime environment. Please take a look and ensure everything is handled correctly. Thanks!

libs/langchain-google-common/src/connection.ts

    return {
      "User-Agent": clientLibraryVersion,
+      "Client-Info": clientInfo.toString(),


libs/langchain-google-common/src/connection.ts

    };
  }

+  async _getclientInfo(): Promise<Record<string, string>> {


libs/langchain-google-common/src/connection.ts

+  async _getclientInfo(): Promise<Record<string, string>> {
+   const userAgent = await this._clientLibraryVersion();
+   const env = await getRuntimeEnvironment();
+      const langchainVersion = env?.libraryVersion ?? "0";


afirstenberg · 2024-04-15T18:52:27Z

libs/langchain-google-common/src/connection.ts

+  async _getclientInfo(): Promise<Record<string, string>> {
+   const userAgent = await this._clientLibraryVersion();
+   const env = await getRuntimeEnvironment();
+      const langchainVersion = env?.libraryVersion ?? "0";


Also, let's be aware that this is currently always "0" because getRuntimeEnvironment() doesn't currently set libraryVersion. (Because this is difficult to do in non-node environments.)

afirstenberg · 2024-04-15T18:59:19Z

I don't know what the format of Client-Info is supposed to be (is it a standard HTTP header? I can't find a reference if so), but it almost certainly isn't the output toString() provides.

See other inline notes.

Might also be good to have a test to make sure these are in the format expected. See the test in llms.test.ts called "user agent header"

jacoblee93 · 2024-04-15T20:30:02Z

libs/langchain-google-common/src/connection.ts

+   const env = await getRuntimeEnvironment();
+      const langchainVersion = env?.libraryVersion ?? "0";
+   const moduleName = await this._moduleName();
+   let clientLibraryVersion = `${langchainVersion}`;


I unfortunately don't think this does what you think it does :( we don't currently have a way to extract version at runtime.

afirstenberg · 2024-04-16T17:53:36Z

I think it looks better after these updates.

Remaining thoughts:

As @jacoblee93 and I observed - env?.libraryVersion is undefined at the moment. So this new header may not be giving you what you think. What are you expecting it to be?
Run the tests in "chat_models.test.ts", particularly the "user agent header" test to make sure it still passes.
Add another test to "chat_models.test.ts" to test the expected outcomes from the Client-Info header.

jacoblee93 · 2024-04-18T02:01:36Z

Agree with @afirstenberg's comments above - the libraryVersion check looks like an oversight in first place. Could you verify this is doing what you expect?

afirstenberg · 2024-04-18T11:36:27Z

libs/langchain-google-common/src/connection.ts

@@ -64,8 +64,9 @@ export abstract class GoogleConnection<
    clientLibraryVersion: string;
  }> {
    const env = await getRuntimeEnvironment();
+    const packageJson = require('../package.json');    


I've discussed this with @jacoblee93 before (who can correct me if I mis-state something).
Unfortunately, while this works in Node, it doesn't work in all environments. Otherwise it would have been done in getRuntimeEnvironment() (which would be the best place to fix it, so it is available to all packages).

require itself is node-specific, but it isn't the only problem here.

tanyaasharma · 2024-04-18T19:17:03Z

Hi @afirstenberg @jacoblee93 ,
I was researching through langchain documentations in order to understand how to get langchain version in the runtime. Unfortunately i am not able to find the same in the docs and in API reference portal here https://api.js.langchain.com/.

For now, i think we can make this hardcoded as we have mentioned in the package.json. Any thoughts?

jacoblee93 · 2024-04-18T19:39:38Z

The package.json file isn't accessible at runtime (to my knowledge) since it's not exported.

We would want to add some new file with a version string that is auto-updated during our release flow.

It's been on the roadmap for a while!

holtskinner · 2024-04-19T17:02:16Z

Hi, I did the original implementation for this tracking in the Python LangChain library. If it's not possible to get the version number for the LangChain JS library, then I think it's fine to just put zeroes in place. This was arbitrarily added by me just so we could track it if it's useful.

tanyaasharma · 2024-04-22T06:34:51Z

Sure, @holtskinner , I will put it as zero.Thanks a lot for your response.

afirstenberg · 2024-04-22T13:28:12Z

libs/langchain-google-common/src/tests/chat_models.test.ts

    expect(record.opts.headers["User-Agent"]).toMatch(
      /langchain-js\/[0-9.]+-ChatConnection/
    );
+    expect(record.opts.headers["Client-Info"]).toMatch(
+      /langchain-[a-zA-Z0-9.-]+\/[0-9.]+\/[a-zA-Z0-9.-]+/


This part of the test fails.

jacoblee93 · 2024-04-22T19:37:40Z

libs/langchain-google-common/src/connection.ts

    const langchain = env?.library ?? "langchain-js";
-    const langchainVersion = env?.libraryVersion ?? "0";
+    const langchainVersion = env?.libraryVersion ?? "0";; 


Please run yarn format

jacoblee93 · 2024-04-22T19:39:55Z

I'm just going to hardcode this to 0 rather than rely on a non-existent parameter.

afirstenberg · 2024-04-22T20:43:19Z

I'm just going to hardcode this to 0 rather than rely on a non-existent parameter.

I would have said to keep it as env?.libraryVersion ?? "0".
RuntimeEnvironment.libraryVersion is a valid parameter of that type as returned by getRuntimeEnvironment(), so it might be set some day. {:
And the test will catch it if so.

But I'm at the point where it clearly doesn't matter.
LGTM

tanyaasharma · 2024-04-23T16:13:01Z

@jacoblee93 , I have added formatting too, is there anything else I should add or its good to go?

bracesproul

lgtm, thanks for being patient with us. Will get this merged and included in the next @langchain/google-common release. Thank you!

adding client-info

eddce89

dosubot bot added the size:S This PR changes 10-29 lines, ignoring generated files. label Apr 15, 2024

dosubot bot added the auto:improvement Medium size change to existing code to handle new use-cases label Apr 15, 2024

dosubot bot reviewed Apr 15, 2024

View reviewed changes

vercel bot deployed to Preview – langchainjs-api-refs April 15, 2024 18:41 View deployment

vercel bot deployed to Preview – langchainjs-docs April 15, 2024 18:41 View deployment

afirstenberg reviewed Apr 15, 2024

View reviewed changes

libs/langchain-google-common/src/connection.ts Outdated

return {

"User-Agent": clientLibraryVersion,

"Client-Info": clientInfo.toString(),

This comment was marked as resolved.

Sign in to view

afirstenberg reviewed Apr 15, 2024

View reviewed changes

libs/langchain-google-common/src/connection.ts Outdated

};

}

async _getclientInfo(): Promise<Record<string, string>> {

This comment was marked as resolved.

Sign in to view

afirstenberg reviewed Apr 15, 2024

View reviewed changes

jacoblee93 reviewed Apr 15, 2024

View reviewed changes

changes based on comments

742f55b

vercel bot deployed to Preview – langchainjs-docs April 16, 2024 16:03 View deployment

vercel bot deployed to Preview – langchainjs-api-refs April 16, 2024 16:03 View deployment

Merge branch 'main' into tanya/client-info

5d4e5d9

vercel bot deployed to Preview – langchainjs-docs April 17, 2024 07:12 View deployment

vercel bot deployed to Preview – langchainjs-api-refs April 17, 2024 07:12 View deployment

jacoblee93 changed the title ~~adding client-info~~ google-common[patch]: adding client-info Apr 18, 2024

adding version

1101d43

vercel bot deployed to Preview – langchainjs-api-refs April 18, 2024 10:50 View deployment

vercel bot deployed to Preview – langchainjs-docs April 18, 2024 10:50 View deployment

adding test cases

5dfe107

vercel bot deployed to Preview – langchainjs-api-refs April 18, 2024 11:21 View deployment

vercel bot deployed to Preview – langchainjs-docs April 18, 2024 11:22 View deployment

afirstenberg reviewed Apr 18, 2024

View reviewed changes

jacoblee93 reopened this Apr 18, 2024

setting library version as zero

efe4389

vercel bot had a problem deploying to Preview – langchainjs-docs April 22, 2024 13:12 Failure

vercel bot deployed to Preview – langchainjs-api-refs April 22, 2024 13:14 View deployment

afirstenberg reviewed Apr 22, 2024

View reviewed changes

test updates

c3f1d16

vercel bot had a problem deploying to Preview – langchainjs-docs April 22, 2024 18:48 Failure

vercel bot deployed to Preview – langchainjs-api-refs April 22, 2024 18:51 View deployment

jacoblee93 reviewed Apr 22, 2024

View reviewed changes

Update connection.ts

d2e3ac0

Update connection.ts

1329717

vercel bot had a problem deploying to Preview – langchainjs-docs April 22, 2024 19:47 Failure

vercel bot deployed to Preview – langchainjs-api-refs April 22, 2024 19:51 View deployment

formatting

aba3b12

vercel bot had a problem deploying to Preview – langchainjs-docs April 23, 2024 16:16 Failure

vercel bot had a problem deploying to Preview – langchainjs-api-refs April 23, 2024 16:17 Failure

Merge branch 'main' into tanya/client-info

7204d9e

bracesproul approved these changes May 1, 2024

View reviewed changes

dosubot bot added the lgtm PRs that are ready to be merged as-is label May 1, 2024

vercel bot deployed to Preview – langchainjs-api-refs May 1, 2024 00:08 View deployment

vercel bot deployed to Preview – langchainjs-docs May 1, 2024 00:08 View deployment

bracesproul merged commit 3aa9aef into langchain-ai:main May 1, 2024
17 checks passed

aechegoyan17 mentioned this pull request Jun 6, 2024

[Snyk] Upgrade langchain from 0.0.214 to 0.1.37 aechegoyan17/LibreChat#1

Open

riderx mentioned this pull request Jun 9, 2024

[Snyk] Upgrade langchain from 0.1.37 to 0.2.0 Cap-go/website#218

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

google-common[patch]: adding client-info #5103

google-common[patch]: adding client-info #5103

tanyaasharma commented Apr 15, 2024

vercel bot commented Apr 15, 2024 •

edited

dosubot bot Apr 15, 2024

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

afirstenberg Apr 15, 2024

afirstenberg commented Apr 15, 2024 •

edited

jacoblee93 Apr 15, 2024

afirstenberg commented Apr 16, 2024

jacoblee93 commented Apr 18, 2024

afirstenberg Apr 18, 2024

tanyaasharma commented Apr 18, 2024

jacoblee93 commented Apr 18, 2024 •

edited

holtskinner commented Apr 19, 2024

tanyaasharma commented Apr 22, 2024 •

edited

afirstenberg Apr 22, 2024

jacoblee93 Apr 22, 2024

jacoblee93 commented Apr 22, 2024

afirstenberg commented Apr 22, 2024

tanyaasharma commented Apr 23, 2024

bracesproul left a comment

google-common[patch]: adding client-info #5103

google-common[patch]: adding client-info #5103

Conversation

tanyaasharma commented Apr 15, 2024

vercel bot commented Apr 15, 2024 • edited

dosubot bot Apr 15, 2024

Choose a reason for hiding this comment

This comment was marked as resolved.

This comment was marked as resolved.

This comment was marked as resolved.

afirstenberg Apr 15, 2024

Choose a reason for hiding this comment

afirstenberg commented Apr 15, 2024 • edited

jacoblee93 Apr 15, 2024

Choose a reason for hiding this comment

afirstenberg commented Apr 16, 2024

jacoblee93 commented Apr 18, 2024

afirstenberg Apr 18, 2024

Choose a reason for hiding this comment

tanyaasharma commented Apr 18, 2024

jacoblee93 commented Apr 18, 2024 • edited

holtskinner commented Apr 19, 2024

tanyaasharma commented Apr 22, 2024 • edited

afirstenberg Apr 22, 2024

Choose a reason for hiding this comment

jacoblee93 Apr 22, 2024

Choose a reason for hiding this comment

jacoblee93 commented Apr 22, 2024

afirstenberg commented Apr 22, 2024

tanyaasharma commented Apr 23, 2024

bracesproul left a comment

Choose a reason for hiding this comment

vercel bot commented Apr 15, 2024 •

edited

afirstenberg commented Apr 15, 2024 •

edited

jacoblee93 commented Apr 18, 2024 •

edited

tanyaasharma commented Apr 22, 2024 •

edited