Skip to content

Commit 26bb1e1

Browse files
authored
docs: Update many references to "FRS" with "AFR" (#23231)
The repo has many lingering references to the old "FRS" terminology. This PR replaces some trivial (mostly documentation) usages with "AFR". We still have a number of usages of "FRS" terminology in code, which I am not tackling here. Those should be done separately.
1 parent f3ab899 commit 26bb1e1

File tree

24 files changed

+55
-47
lines changed

24 files changed

+55
-47
lines changed

azure/packages/test/scenario-runner/README.md

+7-7
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
## Azure Scenario Runner
44

5-
This package provides a reference application that executes pre-set scenarios with the intent of measuring the Fluid Framework's performance and reliability. We primarily use this package as part of a pipeline scheduled to run periodically to measure, log, and report various performance and reliability metrics. These metrics can then be used to gauge an undrestanding of the expected behavior/performance of the Fluid Framework in these various scenarios, which can help define the SLA.
5+
This package provides a reference application that executes pre-set scenarios with the intent of measuring the Fluid Framework's performance and reliability. We primarily use this package as part of a pipeline scheduled to run periodically to measure, log, and report various performance and reliability metrics. These metrics can then be used to gauge an understanding of the expected behavior/performance of the Fluid Framework in these various scenarios, which can help define the SLA.
66

77
<!-- AUTO-GENERATED-CONTENT:START (LIBRARY_README_HEADER) -->
88

@@ -66,11 +66,11 @@ This scenario creates/loads a document and attempts to add many nested `SharedMa
6666

6767
## Running the perf tests locally
6868

69-
1. Set the `azure__fluid__relay__service__tenantId` environment variable to equal your FRS TenantID
70-
2. Set the `azure__fluid__relay__service__tenantKey` environment variable to equal your FRS Tenant's Primary Key
71-
3. Set the `azure__fluid__relay__service__function__url` environment variable to equal your FRS Service Function URL
72-
4. Set the `azure__fluid__relay__service__endpoint` environment variable to equal the Alfred endpoint of your FRS tenant
73-
5. (Optional) Set the `azure__fluid__relay__service__region` environment variable to equal the region of your FRS tenant (eg. `westus2`, `westus3`, `eastus`, `westeurope`)
69+
1. Set the `azure__fluid__relay__service__tenantId` environment variable to equal your Azure Fluid Relay (AFR) TenantID
70+
2. Set the `azure__fluid__relay__service__tenantKey` environment variable to equal your AFR Tenant's Primary Key
71+
3. Set the `azure__fluid__relay__service__function__url` environment variable to equal your AFR Service Function URL
72+
4. Set the `azure__fluid__relay__service__endpoint` environment variable to equal the Alfred endpoint of your AFR tenant
73+
5. (Optional) Set the `azure__fluid__relay__service__region` environment variable to equal the region of your AFR tenant (eg. `westus2`, `westus3`, `eastus`, `westeurope`)
7474
6. Run the test with `npm run start`
7575

7676
## Configuring the test configuration
@@ -81,7 +81,7 @@ The test configuration file `testConfig_v1.yml` can be configured to modify the
8181

8282
[TBD]
8383

84-
Scenario runnner for FRS and Azure Local Service. This package can be used to create and execute various scenarios involving azure-client, IFluidContainer and a range of distributed data structures (DDSes), while collecting telemetry and validating state in the process. Scenarios are sourced via yaml config files.
84+
Scenario runner for AFR and Azure Local Service. This package can be used to create and execute various scenarios involving azure-client, IFluidContainer and a range of distributed data structures (DDSes), while collecting telemetry and validating state in the process. Scenarios are sourced via yaml config files.
8585

8686
You can add new scenarios by following existing patterns (see `MapTrafficRunner` or `DocLoaderRunner` for examples) and adding additional test configs to the `configs` directory. Then, run your scenario with the command: `npm run start:scenario ./configs/<config-name>.yml`.
8787

azure/packages/test/scenario-runner/src/utils.ts

+4-4
Original file line numberDiff line numberDiff line change
@@ -116,21 +116,21 @@ export async function createAzureClient(config: AzureClientConfig): Promise<Azur
116116
const useAzure = connectionConfig.type === "remote";
117117

118118
if (!connectionConfig.endpoint) {
119-
throw new Error("Missing FRS configuration: Relay Service Endpoint URL.");
119+
throw new Error("Missing AFR configuration: Relay Service Endpoint URL.");
120120
}
121121

122122
let connectionProps: AzureRemoteConnectionConfig | AzureLocalConnectionConfig;
123123

124124
if (useAzure) {
125125
if (!connectionConfig.tenantId) {
126-
throw new Error("Missing FRS configuration: Tenant ID.");
126+
throw new Error("Missing AFR configuration: Tenant ID.");
127127
}
128128

129129
let tokenProvider: ITokenProvider;
130130
/* Insecure Token Provider */
131131
if (!connectionConfig.useSecureTokenProvider) {
132132
if (!connectionConfig.key) {
133-
throw new Error("Missing FRS configuration: Tenant Primary Key.");
133+
throw new Error("Missing AFR configuration: Tenant Primary Key.");
134134
}
135135
tokenProvider = createInsecureTokenProvider(
136136
connectionConfig.key,
@@ -140,7 +140,7 @@ export async function createAzureClient(config: AzureClientConfig): Promise<Azur
140140
} else {
141141
/* Secure Token Provider (Azure Function) */
142142
if (!connectionConfig.functionUrl) {
143-
throw new Error("Missing FRS configuration: Function URL.");
143+
throw new Error("Missing AFR configuration: Function URL.");
144144
}
145145
tokenProvider = createAzureTokenProvider(
146146
connectionConfig.functionUrl,

docs/api/fallback/routes.js

+7
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,13 @@ const routes = [
3232
// Counter DDS document was removed in v2.
3333
// Redirect legacy URL to v1 document.
3434
{ from: "/docs/data-structures/counter", to: "/docs/v1/data-structures/counter" },
35+
36+
// Legacy file name
37+
{ from: "/docs/deployment/azure-frs", to: "/docs/deployment/azure-fluid-relay" },
38+
{
39+
from: "/versioned_docs/v1/deployment/azure-frs",
40+
to: "/versioned_docs/v1/deployment/azure-fluid-relay",
41+
},
3542
];
3643

3744
module.exports = routes;

docs/docs/api/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To get started with the Fluid Framework, you'll want to take a dependency on our
1111
You'll then want to pair that with the appropriate service client implementation based on your service.
1212
These include:
1313

14-
- [@fluidframework/azure-client](./azure-client.md) (for use with [Azure Fluid Relay](../deployment/azure-frs))
14+
- [@fluidframework/azure-client](./azure-client.md) (for use with [Azure Fluid Relay](../deployment/azure-fluid-relay))
1515
- [@fluidframework/odsp-client](./odsp-client.md) (for use with [SharePoint Embedded](../deployment/sharepoint-embedded))
1616
- [@fluidframework/tinylicious-client](./tinylicious-client) (for testing with [Tinylicious](../testing/tinylicious))
1717

docs/docs/build/overview.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ See [Service-specific client libraries](#service-specific-client-libraries) for
2525

2626
#### Azure Fluid Relay
2727

28-
[Azure Fluid Relay](../deployment/azure-frs) is a cloud service that enables real-time collaboration on shared data models. It is a fully managed service that provides a secure, scalable, and reliable way to connect clients to each other and to the data models they share.
28+
[Azure Fluid Relay](../deployment/azure-fluid-relay) is a cloud service that enables real-time collaboration on shared data models. It is a fully managed service that provides a secure, scalable, and reliable way to connect clients to each other and to the data models they share.
2929

3030
#### SharePoint Embedded
3131

@@ -72,6 +72,6 @@ Fluid works with multiple service implementations. Each service has a correspond
7272
For specifics about each service-specific client implementation see their corresponding documentation.
7373

7474
- The client library for the [Tinylicious](/docs/testing/tinylicious) service is in the package [@fluidframework/tinylicious-client](https://www.npmjs.com/package/@fluidframework/tinylicious-client).
75-
- The client library for the [Azure Fluid Relay](../deployment/azure-frs) is in the package [@fluidframework/azure-client](https://www.npmjs.com/package/@fluidframework/azure-client).
75+
- The client library for the [Azure Fluid Relay](../deployment/azure-fluid-relay) is in the package [@fluidframework/azure-client](https://www.npmjs.com/package/@fluidframework/azure-client).
7676

7777
For more information see [Packages](./packages).

docs/docs/start/tutorial.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ const root = document.getElementById("content");
4949

5050
:::note
5151

52-
To create a Fluid application that can be deployed to Azure, check out the [Azure Fluid Relay](../deployment/azure-frs).
52+
To create a Fluid application that can be deployed to Azure, check out the [Azure Fluid Relay](../deployment/azure-fluid-relay).
5353

5454
:::
5555

docs/docs/testing/testing.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /testing/testing
88

99
## Overview
1010

11-
Testing and automation are crucial to maintaining the quality and longevity of your code. Internally, Fluid has a range of unit and integration tests powered by [Mocha](https://mochajs.org/), [Jest](https://jestjs.io/), [Puppeteer](https://github.com/puppeteer/puppeteer), and [webpack](https://webpack.js.org/). Tests that need to run against a service are backed by [Tinylicious](./tinylicious) or a test tenant of a [live service](../deployment/service-options) such as [Azure Fluid Relay](../deployment/azure-frs).
11+
Testing and automation are crucial to maintaining the quality and longevity of your code. Internally, Fluid has a range of unit and integration tests powered by [Mocha](https://mochajs.org/), [Jest](https://jestjs.io/), [Puppeteer](https://github.com/puppeteer/puppeteer), and [webpack](https://webpack.js.org/). Tests that need to run against a service are backed by [Tinylicious](./tinylicious) or a test tenant of a [live service](../deployment/service-options) such as [Azure Fluid Relay](../deployment/azure-fluid-relay).
1212

1313
This document will explain how to use these tools to get started with writing automation for Fluid applications against a service. It will focus on interactions with the service rather than automation in general, and will not cover the automation tools themselves or scenarios that do not require a service.
1414

@@ -38,7 +38,7 @@ The `test:tinylicious` script will start Tinylicious, wait until port 7070 respo
3838

3939
## Automation against Azure Fluid Relay
4040

41-
Your automation can connect to a test tenant for Azure Fluid Relay in the same way as your production tenant and only needs the appropriate connection configuration. See [Connect to Azure Fluid Relay](../deployment/azure-frs) for more details.
41+
Your automation can connect to a test tenant for Azure Fluid Relay in the same way as your production tenant and only needs the appropriate connection configuration. See [Connect to Azure Fluid Relay](../deployment/azure-fluid-relay) for more details.
4242

4343
### Azure Fluid Relay as an abstraction for Tinylicious
4444

docs/versioned_docs/version-1/api/fluid-framework.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ sidebar_label: fluid-framework
55

66
# fluid-framework Package
77

8-
The fluid-framework package bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client package (for example, [@fluidframework/azure-client](/docs/deployment/azure-frs) or [@fluidframework/tinylicious-client](/docs/testing/tinylicious)).
8+
The fluid-framework package bundles a collection of Fluid Framework client libraries for easy use when paired with a corresponding service client package (for example, [@fluidframework/azure-client](/docs/deployment/azure-fluid-relay) or [@fluidframework/tinylicious-client](/docs/testing/tinylicious)).
99

1010
The `fluid-framework` packages surfaces APIs from the following sub-packages.
1111
The following APIs can be referenced independently, but they can all be imported directly from the `fluid-framework` package:

docs/versioned_docs/version-1/api/index.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ To get started with the Fluid Framework, you'll want to take a dependency on our
1111
You'll then want to pair that with the appropriate service client implementation based on your service.
1212
These include:
1313

14-
- [@fluidframework/azure-client](./azure-client) (for use with [Azure Fluid Relay](../deployment/azure-frs))
14+
- [@fluidframework/azure-client](./azure-client) (for use with [Azure Fluid Relay](../deployment/azure-fluid-relay))
1515
- [@fluidframework/tinylicious-client](./tinylicious-client) (for testing with [Tinylicious](../testing/tinylicious))
1616

1717
For more information on our service client implementations, see [Fluid Services](../deployment/service-options).

docs/versioned_docs/version-1/build/overview.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ See [Service-specific client libraries](#service-specific-client-libraries) for
2525

2626
#### Azure Fluid Relay
2727

28-
[Azure Fluid Relay](../deployment/azure-frs) is a cloud service that enables real-time collaboration on shared data models. It is a fully managed service that provides a secure, scalable, and reliable way to connect clients to each other and to the data models they share.
28+
[Azure Fluid Relay](../deployment/azure-fluid-relay) is a cloud service that enables real-time collaboration on shared data models. It is a fully managed service that provides a secure, scalable, and reliable way to connect clients to each other and to the data models they share.
2929

3030
#### Tinylicious
3131

@@ -68,6 +68,6 @@ Fluid works with multiple service implementations. Each service has a correspond
6868
For specifics about each service-specific client implementation see their corresponding documentation.
6969

7070
- The client library for the [Tinylicious](/docs/testing/tinylicious) service is in the package [@fluidframework/tinylicious-client](https://www.npmjs.com/package/@fluidframework/tinylicious-client).
71-
- The client library for the [Azure Fluid Relay](../deployment/azure-frs) is in the package [@fluidframework/azure-client](https://www.npmjs.com/package/@fluidframework/azure-client).
71+
- The client library for the [Azure Fluid Relay](../deployment/azure-fluid-relay) is in the package [@fluidframework/azure-client](https://www.npmjs.com/package/@fluidframework/azure-client).
7272

7373
For more information see [Packages](./packages).

docs/versioned_docs/version-1/start/tutorial.mdx

+1-1
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,7 @@ const root = document.getElementById("content");
4747

4848
:::note
4949

50-
To create a Fluid application that can be deployed to Azure, check out the [Azure Fluid Relay](../deployment/azure-frs).
50+
To create a Fluid application that can be deployed to Azure, check out the [Azure Fluid Relay](../deployment/azure-fluid-relay).
5151

5252
:::
5353

docs/versioned_docs/version-1/testing/testing.mdx

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ slug: /testing/testing
88

99
## Overview
1010

11-
Testing and automation are crucial to maintaining the quality and longevity of your code. Internally, Fluid has a range of unit and integration tests powered by [Mocha](https://mochajs.org/), [Jest](https://jestjs.io/), [Puppeteer](https://github.com/puppeteer/puppeteer), and [webpack](https://webpack.js.org/). Tests that need to run against a service are backed by [Tinylicious](./tinylicious) or a test tenant of a [live service](../deployment/service-options) such as [Azure Fluid Relay](../deployment/azure-frs).
11+
Testing and automation are crucial to maintaining the quality and longevity of your code. Internally, Fluid has a range of unit and integration tests powered by [Mocha](https://mochajs.org/), [Jest](https://jestjs.io/), [Puppeteer](https://github.com/puppeteer/puppeteer), and [webpack](https://webpack.js.org/). Tests that need to run against a service are backed by [Tinylicious](./tinylicious) or a test tenant of a [live service](../deployment/service-options) such as [Azure Fluid Relay](../deployment/azure-fluid-relay).
1212

1313
This document will explain how to use these tools to get started with writing automation for Fluid applications against a service. It will focus on interactions with the service rather than automation in general, and will not cover the automation tools themselves or scenarios that do not require a service.
1414

@@ -38,7 +38,7 @@ The `test:tinylicious` script will start Tinylicious, wait until port 7070 respo
3838

3939
## Automation against Azure Fluid Relay
4040

41-
Your automation can connect to a test tenant for Azure Fluid Relay in the same way as your production tenant and only needs the appropriate connection configuration. See [Connect to Azure Fluid Relay](../deployment/azure-frs) for more details.
41+
Your automation can connect to a test tenant for Azure Fluid Relay in the same way as your production tenant and only needs the appropriate connection configuration. See [Connect to Azure Fluid Relay](../deployment/azure-fluid-relay) for more details.
4242

4343
### Azure Fluid Relay as an abstraction for Tinylicious
4444

packages/service-clients/end-to-end-tests/azure-client/README.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
# @fluidframework/azure-end-to-end-tests
22

3-
Functional end-to-end tests for FRS and Azure Local Service. Here we evaluate various scenarios that involving azure-client, IFluidContainer and a range of distributed data structures (DDSes).
3+
Functional end-to-end tests for Azure Fluid Relay (AFR) and Azure Local Service.
4+
Here we evaluate various scenarios involving `azure-client`, `IFluidContainer` and a range of distributed data structures (DDSes).
45

5-
To run FRS e2e tests: `test:realsvc:azure`.
6+
To run AFR end-to-end tests: `test:realsvc:azure`.
67

7-
To run Azure Local Service e2e tests: `test:realsvc`.
8+
To run Azure Local Service end-to-end tests: `test:realsvc`.
89

910
<!-- AUTO-GENERATED-CONTENT:START (README_FOOTER) -->
1011

packages/service-clients/end-to-end-tests/azure-client/src/test/AzureClientFactory.ts

+3-3
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ export function createAzureClient(
5959
};
6060
const endPoint = process.env.azure__fluid__relay__service__endpoint as string;
6161
if (useAzure && endPoint === undefined) {
62-
throw new Error("Azure FRS endpoint is missing");
62+
throw new Error("Azure Fluid Relay service endpoint is missing");
6363
}
6464

6565
// use AzureClient remote mode will run against live Azure Fluid Relay.
@@ -122,7 +122,7 @@ export function createAzureClientLegacy(
122122
};
123123
const endPoint = process.env.azure__fluid__relay__service__endpoint as string;
124124
if (useAzure && endPoint === undefined) {
125-
throw new Error("Azure FRS endpoint is missing");
125+
throw new Error("Azure Azure Fluid Relay service endpoint is missing");
126126
}
127127

128128
// use AzureClient remote mode will run against live Azure Fluid Relay.
@@ -189,7 +189,7 @@ export async function createContainerFromPayload(
189189
? (process.env.azure__fluid__relay__service__endpoint as string)
190190
: "http://localhost:7071";
191191
if (useAzure && endPoint === undefined) {
192-
throw new Error("Azure FRS endpoint is missing");
192+
throw new Error("Azure Fluid Relay service endpoint is missing");
193193
}
194194

195195
const tokenProvider = useAzure

packages/test/test-end-to-end-tests/src/test/blobs.spec.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ describeCompat("blobs", "FullCompat", (getTestObjectProvider, apis) => {
9999
let provider: ITestObjectProvider;
100100
beforeEach("getTestObjectProvider", async function () {
101101
provider = getTestObjectProvider();
102-
// Currently FRS does not support blob API.
102+
// Currently, AFR does not support blob API.
103103
if (provider.driver.type === "routerlicious" && provider.driver.endpointName === "frs") {
104104
this.skip();
105105
}
@@ -295,7 +295,7 @@ describeCompat("blobs", "NoCompat", (getTestObjectProvider, apis) => {
295295
beforeEach("getTestObjectProvider", async function () {
296296
testPersistedCache = new TestPersistedCache();
297297
provider = getTestObjectProvider({ persistedCache: testPersistedCache });
298-
// Currently FRS does not support blob API.
298+
// Currently AFR does not support blob API.
299299
if (provider.driver.type === "routerlicious" && provider.driver.endpointName === "frs") {
300300
this.skip();
301301
}

packages/test/test-end-to-end-tests/src/test/idCompressor.spec.ts

+1-1
Original file line numberDiff line numberDiff line change
@@ -902,7 +902,7 @@ describeCompat("IdCompressor Summaries", "NoCompat", (getTestObjectProvider, com
902902
});
903903

904904
it("Newly connected container synchronizes from summary", async function () {
905-
// TODO: This test is consistently failing when ran against FRS. See ADO:7931
905+
// TODO: This test is consistently failing when ran against AFR. See ADO:7931
906906
if (provider.driver.type === "routerlicious" && provider.driver.endpointName === "frs") {
907907
this.skip();
908908
}

packages/test/test-end-to-end-tests/src/test/refreshSerializedStateManager.spec.ts

+2-2
Original file line numberDiff line numberDiff line change
@@ -75,7 +75,7 @@ describeCompat("Snapshot refresh at loading", "NoCompat", (getTestObjectProvider
7575

7676
it("snapshot was refreshed", async function () {
7777
const provider = getTestObjectProvider();
78-
// TODO: This test is consistently failing when ran against FRS. See ADO:7893
78+
// TODO: This test is consistently failing when ran against AFR. See ADO:7893
7979
if (provider.driver.type === "routerlicious" && provider.driver.endpointName === "frs") {
8080
this.skip();
8181
}
@@ -141,7 +141,7 @@ describeCompat("Snapshot refresh at loading", "NoCompat", (getTestObjectProvider
141141

142142
it("snapshot was refreshed after some time", async function () {
143143
const provider = getTestObjectProvider();
144-
// TODO: This test is consistently failing when ran against FRS. See ADO:7893
144+
// TODO: This test is consistently failing when ran against AFR. See ADO:7893
145145
if (provider.driver.type === "routerlicious" && provider.driver.endpointName === "frs") {
146146
this.skip();
147147
}

0 commit comments

Comments
 (0)