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

[core] Fix platform specific data with tests #30011

Merged
merged 3 commits into from
Jun 12, 2024
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
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
4 changes: 4 additions & 0 deletions sdk/core/abort-controller/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,18 +18,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-amqp/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-auth/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,18 +8,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-client-rest/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-client/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-http-compat/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-lro/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-paging/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,18 +12,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-rest-pipeline/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
mpodwysocki marked this conversation as resolved.
Show resolved Hide resolved
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
16 changes: 9 additions & 7 deletions sdk/core/core-rest-pipeline/src/util/userAgentPlatform.ts
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,15 @@ export function getHeaderName(): string {
* @internal
*/
export function setPlatformSpecificData(map: Map<string, string>): void {
const versions = process.versions as ExtendedPlatformVersions;
if (versions.bun) {
map.set("Bun", versions.bun);
} else if (versions.deno) {
map.set("Deno", versions.deno);
} else if (versions.node) {
map.set("Node", versions.node);
if (process && process.versions) {
const versions = process.versions as ExtendedPlatformVersions;
if (versions.bun) {
map.set("Bun", versions.bun);
} else if (versions.deno) {
map.set("Deno", versions.deno);
} else if (versions.node) {
map.set("Node", versions.node);
}
}

map.set("OS", `(${os.arch()}-${os.type()}-${os.release()})`);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

import { describe, it, assert } from "vitest";
import { setPlatformSpecificData } from "../../src/util/userAgentPlatform.js";

describe("userAgentPlatform", () => {

it("should set OS", () => {
const map = new Map<string, string>();

setPlatformSpecificData(map);

assert.ok(map.has("OS"));
});
});
70 changes: 70 additions & 0 deletions sdk/core/core-rest-pipeline/test/node/userAgentPlatform.spec.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,70 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.

import { describe, it, assert, vi, afterEach } from "vitest";
import { setPlatformSpecificData } from "../../src/util/userAgentPlatform.js";
import * as process from "process";

describe("userAgentPlatform", () => {
vi.mock("process", async () => {
const actual = await vi.importActual("process");
return {
...actual,
versions: {},
};
});

afterEach(() => {
vi.clearAllMocks();
});

it("should handle an empty process.versions", () => {
mpodwysocki marked this conversation as resolved.
Show resolved Hide resolved
vi.mocked(process).versions = {};
const map = new Map<string, string>();

setPlatformSpecificData(map);
assert.ok(map.has("OS"));
Copy link
Member

Choose a reason for hiding this comment

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

nit: I wonder if isNotEmpty or exists would read better as assertions here?

isNotEmpty(map.get("OS")) or exists(map.get("OS"))?

assert.notOk(map.has("Node"));
assert.notOk(map.has("Deno"));
assert.notOk(map.has("Bun"));
});

it("should handle a Node.js process.versions with Bun", () => {
vi.mocked(process).versions = { bun: "1.0.0" };
const map = new Map<string, string>();

setPlatformSpecificData(map);

assert.ok(map.has("OS"));
assert.ok(map.has("Bun"));
assert.equal(map.get("Bun"), "1.0.0");
assert.notOk(map.has("Node"));
assert.notOk(map.has("Deno"));
});

it("should handle a Node.js process.versions with Deno", () => {
vi.mocked(process).versions = { deno: "2.0.0" };
const map = new Map<string, string>();

setPlatformSpecificData(map);

assert.ok(map.has("OS"));
assert.ok(map.has("Deno"));
assert.equal(map.get("Deno"), "2.0.0");
assert.notOk(map.has("Node"));
assert.notOk(map.has("Bun"));
});

it("should handle a Node.js process.versions", () => {
vi.mocked(process).versions = { node: "20.0.0" };
const map = new Map<string, string>();

setPlatformSpecificData(map);

assert.ok(map.has("OS"));
assert.ok(map.has("Node"));
assert.equal(map.get("Node"), "20.0.0");
assert.notOk(map.has("Deno"));
assert.notOk(map.has("Bun"));
});
});
4 changes: 4 additions & 0 deletions sdk/core/core-sse/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-tracing/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
4 changes: 4 additions & 0 deletions sdk/core/core-util/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,18 +11,22 @@
"./package.json": "./package.json",
".": {
"browser": {
"source": "./src/index.ts",
"types": "./dist/browser/index.d.ts",
"default": "./dist/browser/index.js"
},
"react-native": {
"source": "./src/index.ts",
"types": "./dist/react-native/index.d.ts",
"default": "./dist/react-native/index.js"
},
"import": {
"source": "./src/index.ts",
"types": "./dist/esm/index.d.ts",
"default": "./dist/esm/index.js"
},
"require": {
"source": "./src/index.ts",
"types": "./dist/commonjs/index.d.ts",
"default": "./dist/commonjs/index.js"
}
Expand Down
Loading
Loading