Merge branch 'main' of https://github.com/microsoft/FluidFramework in…

…to type-validate-runtime-defs

.github/workflows/data/linkcheck-failure.md

@@ -1,5 +1,3 @@
-### Broken link report ⚠
-
 🔗 Found some broken links! 💔
 
 Run a link check locally to find them. See

.github/workflows/data/linkcheck-success.md

@@ -1,5 +1,3 @@
-### Broken link report 👍🏻
-
 🔗 No broken links found! ✅
 
 Your attention to detail is admirable.

.github/workflows/website-validation.yml

@@ -18,32 +18,38 @@ jobs:
     - uses: actions/checkout@v2
       with:
         submodules: false
-    - uses: actions/setup-node@v2-beta
+    - uses: actions/setup-node@v2
       with:
-        node-version: "12"
+        node-version: "14"
+        cache: "npm"
+        cache-dependency-path: docs/package-lock.json
     - name: Build site artifact
       run: |
         npm ci
-        npm run download
-        npm run build
+        npm run ci:build
     - name: Upload site artifact
       uses: actions/upload-artifact@v2
       with:
         name: fluidframework-site
         path: docs/public
         retention-days: 3
 
-  broken_link_check_internal:
+  broken_link_check:
     runs-on: ubuntu-latest
     name: 🔗 Broken Link Check
     needs: build_site
     steps:
     - uses: actions/checkout@v2
       with:
         submodules: false
-    - uses: actions/setup-node@v2-beta
+    - uses: actions/setup-node@v2
       with:
-        node-version: "12"
+        node-version: "14"
+        cache: "npm"
+        cache-dependency-path: docs/package-lock.json
+    - name: Create results folder
+      run: mkdir -p ./results
+
     - name: Download site artifact
       uses: actions/download-artifact@v2
       with:
@@ -55,22 +61,21 @@ jobs:
         npm ci
     - name: Start server in background
       run: pm2 start $GITHUB_WORKSPACE/docs/serve.js
-    - name: Check internal links
+    - name: Check for broken links
       id: linkcheck
       continue-on-error: true
-      run: npm run linkcheck
+      run: |
+        set -o pipefail
+        npm run linkcheck | tee ./results/linkcheck-output.txt
 
     - name: Save PR number
-      run: |
-        mkdir -p ./results
-        echo ${{ github.event.number }} > ./results/pr
+      run: echo ${{ github.event.number }} > ./results/pr
     - name: Save linkcheck report
-      # if: ${{ success() && steps.linkcheck.outcome == 'success' }}
       run: |
-        cat $GITHUB_WORKSPACE/.github/workflows/data/linkcheck-${{ steps.linkcheck.outcome }}.md > ./results/linkcheck
-    # - if: ${{ failure() || steps.linkcheck.outcome != 'success' }}
-    #   run: |
-    #     echo ${{ github.event.number }} > ./results/linkcheck
+        cat "$GITHUB_WORKSPACE/.github/workflows/data/linkcheck-${{ steps.linkcheck.outcome }}.md" | tee ./results/linkcheck
+        echo -e "\n#### linkcheck output\n\n\`\`\`" | tee -a ./results/linkcheck
+        cat ./results/linkcheck-output.txt | tee -a ./results/linkcheck
+        echo -e "\n\`\`\`" | tee -a ./results/linkcheck
     - name: Upload results artifact
       uses: actions/upload-artifact@v2
       with:

BREAKING.md

@@ -12,10 +12,11 @@ There are a few steps you can take to write a good change note and avoid needing
 
 ## 0.52 Breaking changes
 - [chaincodePackage removed from Container](#chaincodePackage-removed-from-Container)
-- [OdspDocumentInfo type replaced with OdspFluidDataStoreLocator interface](#OdspDocumentInfo-type-replaced-with-OdspFluidDataStoreLocator-interface)
+- [`OdspDocumentInfo` type replaced with `OdspFluidDataStoreLocator` interface](#OdspDocumentInfo-type-replaced-with-OdspFluidDataStoreLocator-interface)
 - [close() removed from IDocumentDeltaConnection](#close-removed-from-IDocumentDeltaConnection)
 - [Removed bindToContext from IFluidDataStoreChannel](#Removed-bindToContext-from-IFluidDataStoreChannel)
 - [Remove `IOdspResolvedUrl.sharingLinkToRedeem` and use `IOdspResolvedUrl.shareLinkInfo` instead](#Remove-IOdspResolvedUrl.sharingLinkToRedeem-and-use-IOdspResolvedUrl.shareLinkInfo-instead)
+- [Replace `createCreateNewRequest` function with `createOdspCreateContainerRequest` function](#Replace-createCreateNewRequest-function-with-createOdspCreateContainerRequest-function)
 
 ### `chaincodePackage` removed from `Container`
 The `chaincodePackage` property on `Container` was deprecated in 0.28, and has now been removed.  Two new APIs have been added to replace its functionality, `getSpecifiedCodeDetails()` and `getLoadedCodeDetails()`.  Use `getSpecifiedCodeDetails()` to get the code details currently specified for the `Container`, or `getLoadedCodeDetails()` to get the code details that were used to load the `Container`.
@@ -29,6 +30,9 @@ bindToContext in IFluidDataStoreChannel was deprecated in [0.50](#Deprecated-bin
 ### Remove `IOdspResolvedUrl.sharingLinkToRedeem` and use `IOdspResolvedUrl.shareLinkInfo` instead
 The `sharingLinkToRedeem` property is removed from the `IOdspResolvedUrl` interface. The property can be accesed from `IOdspResolvedUrl.shareLinkInfo` instead.
 
+### Replace `createCreateNewRequest` function with `createOdspCreateContainerRequest` function
+The `createCreateNewRequest()` is removed and replaced with `createOdspCreateContainerRequest()` in the `odsp-driver` package. If any instances of `createCreateNewRequest()` are used, replace them with `createOdspCreateContainerRequest()` by importing it from `@fluidframework/odsp-driver` package.
+
 ## 0.51 Breaking changes
 - [`maxMessageSize` property has been deprecated from IConnectionDetails and IDocumentDeltaConnection](#maxmessagesize-property-has-been-deprecated-from-iconnectiondetails-and-idocumentdeltaconnection)
 - [_createDataStoreWithProps and IFluidDataStoreChannel](#createdatastorewithprops-and-ifluiddatastorechannel)

api-report/container-runtime.api.md

@@ -181,6 +181,8 @@ export class ContainerRuntime extends TypedEventEmitter<IContainerRuntimeEvents>
     submitDataStoreSignal(address: string, type: string, content: any): void;
     submitSignal(type: string, content: any): void;
     submitSummary(options: ISubmitSummaryOptions): Promise<SubmitSummaryResult>;
+    // (undocumented)
+    summariesDisabled(): boolean;
     summarize(options: {
         summaryLogger: ITelemetryLogger;
         fullTree?: boolean;
@@ -590,6 +592,8 @@ export interface ISummaryOpMessage extends ISequencedDocumentMessage {
 export interface ISummaryRuntimeOptions {
     // (undocumented)
     disableIsolatedChannels?: boolean;
+    disableSummaries?: boolean;
+    // @deprecated (undocumented)
     generateSummaries?: boolean;
     // (undocumented)
     initialSummarizerDelayMs?: number;

api-report/odsp-driver.api.md

@@ -97,8 +97,6 @@ export class OdspDocumentServiceFactoryWithCodeSplit extends OdspDocumentService
 // @public
 export class OdspDriverUrlResolver implements IUrlResolver {
     constructor();
-    // @deprecated (undocumented)
-    createCreateNewRequest(siteUrl: string, driveId: string, filePath: string, fileName: string): IRequest;
     // (undocumented)
     getAbsoluteUrl(resolvedUrl: IResolvedUrl, relativeUrl: string, codeDetails?: IFluidCodeDetails): Promise<string>;
     // (undocumented)
@@ -109,8 +107,6 @@ export class OdspDriverUrlResolver implements IUrlResolver {
 export class OdspDriverUrlResolverForShareLink implements IUrlResolver {
     constructor(shareLinkFetcherProps?: ShareLinkFetcherProps | undefined, logger?: ITelemetryBaseLogger, appName?: string | undefined);
     appendDataStorePath(requestUrl: URL, pathToAppend: string): string | undefined;
-    // @deprecated (undocumented)
-    createCreateNewRequest(siteUrl: string, driveId: string, filePath: string, fileName: string): IRequest;
     static createDocumentUrl(baseUrl: string, driverInfo: OdspFluidDataStoreLocator): string;
     static createNavParam(locator: OdspFluidDataStoreLocator): string;
     getAbsoluteUrl(resolvedUrl: IResolvedUrl, dataStorePath: string, codeDetails?: IFluidCodeDetails): Promise<string>;

docs/README.md

@@ -211,6 +211,7 @@ The site theme/template lives in `themes/thxvscode`.
 | `build:diagrams` | Generate the diagram images using ditaa. |
 | `build:fast` | Builds the site in a fast, but incomplete way. Useful for testing and iteration. |
 | `build:md-magic` | Updates generated content in Markdown files. |
+| `ci:build` | `npm run download && npm run build` |
 | `clean` | Remove all generated files. |
 | `ditaa` | Run the local copy of ditaa. |
 | `ditaa:default` | --- |
@@ -223,12 +224,9 @@ The site theme/template lives in `themes/thxvscode`.
 | `install:ditaa:force` | Install ditaa to generate diagrams. |
 | `install:ditaa:win32` | --- |
 | `linkcheck` | `npm run linkcheck:site` |
-| `linkcheck:api` | Runs a broken link check against <http://localhost:1313>, including the /apis path. |
-| `linkcheck:site` | Runs a broken link check against <http://localhost:1313>. Does not scan the /apis path. |
+| `linkcheck:fast` | `linkcheck http://localhost:1313 --skip-file skipped-urls.txt` |
 | `lint` | `markdownlint-cli2` |
 | `lint:fix` | `markdownlint-cli2-fix` |
 | `postinstall` | --- |
 | `start` | Start a local webserver to preview the built site on <http://localhost:1313> |
-| `start:default` | --- |
-| `start:win32` | --- |
 <!-- AUTO-GENERATED-CONTENT:END -->

docs/content/docs/build/dds.md

@@ -75,7 +75,7 @@ These behavioral guarantees cannot be implemented in an optimistic way. The cost
 part of what makes Fluid so fast, so using optimistic DDSes is almost always preferred, but you can trade performance
 for behavioral guarantees.
 
-An example of a consensus-based DDS in Fluid Framework is the [TaskManager]][].
+An example of a consensus-based DDS in Fluid Framework is the **TaskManager**.
 
 #### Why consensus-based DDSes are useful
 
@@ -106,7 +106,8 @@ see [Using handles to store and retrieve shared objects][handles-example].
 
 That's all you need to know about handles in order to use DDSes effectively. If you want to learn more about handles,
 see [Fluid handles]({{< relref "handles.md" >}}).
-[handles-example]: {{< relref "data-modeling.md#using-handles-to-store-and-retrieve-fluid-objects" >}}
+
+[handles-example]: {{< relref "data-modeling.md#using-handles-to-store-and-retrieve-shared-objects" >}}
 
 ## Events
 

docs/content/docs/build/packages.md

@@ -25,9 +25,9 @@ contained within itself, as well as to inspect the state of the collaboration se
 You'll use one or more shared objects in your container to model your collaborative data.  The `fluid-framework` package includes
 three data structures that cover a broad range of scenarios:
 
-1. [SharedMap][], a map-like data structure for storing key/value pair data.
-2. [SharedDirectory][], a map-like data structure with ability to organize keys into subdirectories.
-3. [SharedString][], a data structure for string data.
+1. [SharedMap]({{< relref "/docs/data-structures/map.md" >}}), a map-like data structure for storing key/value pair data.
+2. [SharedDirectory]({{< relref "shareddirectory.md" >}}), a map-like data structure with ability to organize keys into subdirectories.
+3. [SharedString]({{< relref "string.md" >}}), a data structure for string data.
 
 ## Package scopes
 

docs/content/docs/concepts/handles.md

@@ -7,10 +7,10 @@ aliases:
   - "/docs/deep/handles/"
 ---
 
-A Fluid handle is an object that holds a reference to a collaborative object, such as a [DataObject][] or a distributed
+A Fluid handle is an object that holds a reference to a collaborative object, such as a [DataObject]({{< relref "glossary.md#data-object" >}}) or a distributed
 data structure (DDS).
 
-The primary use case for handles in the Fluid Framework is for storing a [DataObject][], or a DDS, into another DDS.
+The primary use case for handles in the Fluid Framework is for storing a DDS or DataObject into another DDS.
 This section covers how to consume and use Fluid handles.
 
 ## Why use Fluid handles?

docs/content/docs/data-structures/overview.md

@@ -110,7 +110,7 @@ Consensus data structures have one or both of these characteristics:
 These DDSes are **not** optimistic. Before a change to a consensus data structure is confirmed, the connected clients
 must acknowledge the change.
 
-- [TaskManager][] -- Tracks queues of clients that want to exclusively run a task.
+- [TaskManager]({{< relref "task-manager.md" >}}) -- Tracks queues of clients that want to exclusively run a task.
 
 ### Consensus scenarios
 

docs/content/docs/updates/v0.50.md

@@ -24,4 +24,4 @@ summary: |
   the container has outstanding operations that have not been acknowledged by the Fluid service. Using this property
   correctly can help prevent data loss due to service connectivity issues ({{< issue 7891 >}}).
 
-  See [isDirty in the Fluid container documentation]({{< relref "containers.md#isDirty" >}}) for more information.
+  See [isDirty in the Fluid container documentation]({{< relref "containers.md#isdirty" >}}) for more information.