Skip to content

Commit a8107db

Browse files
committed
chore: change name from fromEnvBearerToken to fromEnvSigningName
1 parent 387c0b3 commit a8107db

File tree

3 files changed

+10
-10
lines changed

3 files changed

+10
-10
lines changed

packages/token-providers/src/fromEnvBearerToken.spec.ts renamed to packages/token-providers/src/fromEnvSigningName.spec.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
import { getBearerTokenEnvKey } from "@aws-sdk/core";
22
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
33

4-
import { fromEnvBearerToken } from "./fromEnvBearerToken";
4+
import { fromEnvSigningName } from "./fromEnvSigningName";
55

66
vi.mock("@aws-sdk/core");
77

8-
describe("fromEnvBearerToken", () => {
8+
describe(fromEnvSigningName.name, () => {
99
const originalEnv = process.env;
1010
const mockInit = { signingName: "signing name" };
1111
const mockBearerTokenEnvKey = "AWS_BEARER_TOKEN_SIGNING_NAME";
@@ -22,14 +22,14 @@ describe("fromEnvBearerToken", () => {
2222

2323
describe("throws error", () => {
2424
it("when signingName is not passed", async () => {
25-
await expect(fromEnvBearerToken()()).rejects.toThrow(
25+
await expect(fromEnvSigningName()()).rejects.toThrow(
2626
"Please pass 'signingName' to compute environment variable key"
2727
);
2828
expect(getBearerTokenEnvKey).not.toHaveBeenCalled();
2929
});
3030

3131
it("when token is not present in environment variable", async () => {
32-
await expect(fromEnvBearerToken(mockInit)()).rejects.toThrow(
32+
await expect(fromEnvSigningName(mockInit)()).rejects.toThrow(
3333
`Token not present in '${mockBearerTokenEnvKey}' environment variable`
3434
);
3535
expect(getBearerTokenEnvKey).toHaveBeenCalledWith(mockInit.signingName);
@@ -39,7 +39,7 @@ describe("fromEnvBearerToken", () => {
3939
it("returns token from environment variable", async () => {
4040
const mockBearerToken = "mock-bearer-token";
4141
process.env[mockBearerTokenEnvKey] = mockBearerToken;
42-
const token = await fromEnvBearerToken(mockInit)();
42+
const token = await fromEnvSigningName(mockInit)();
4343
expect(token).toEqual({ token: mockBearerToken });
4444
expect(getBearerTokenEnvKey).toHaveBeenCalledWith(mockInit.signingName);
4545
});

packages/token-providers/src/fromEnvBearerToken.ts renamed to packages/token-providers/src/fromEnvSigningName.ts

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { TokenProviderError } from "@smithy/property-provider";
55
/**
66
* @public
77
*/
8-
export interface FromEnvBearerTokenInit extends CredentialProviderOptions {
8+
export interface FromEnvSigningNameInit extends CredentialProviderOptions {
99
signingName?: string;
1010
}
1111

@@ -19,10 +19,10 @@ export interface FromEnvBearerTokenInit extends CredentialProviderOptions {
1919
*
2020
* @public
2121
*/
22-
export const fromEnvBearerToken =
23-
({ logger, signingName }: FromEnvBearerTokenInit = {}): TokenIdentityProvider =>
22+
export const fromEnvSigningName =
23+
({ logger, signingName }: FromEnvSigningNameInit = {}): TokenIdentityProvider =>
2424
async () => {
25-
logger?.debug?.("@aws-sdk/token-providers - fromEnvBearerToken");
25+
logger?.debug?.("@aws-sdk/token-providers - fromEnvSigningName");
2626

2727
if (!signingName) {
2828
throw new TokenProviderError("Please pass 'signingName' to compute environment variable key", { logger });
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
export * from "./fromEnvBearerToken";
1+
export * from "./fromEnvSigningName";
22
export * from "./fromSso";
33
export * from "./fromStatic";
44
export * from "./nodeProvider";

0 commit comments

Comments
 (0)