@fluidframework/shared-object-base 2.0.2 → 2.1.0-276326

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fluidframework/shared-object-base",
-  "version": "2.0.2",
+  "version": "2.1.0-276326",
   "description": "Fluid base class for shared distributed data structures",
   "homepage": "https://fluidframework.com",
   "repository": {
@@ -67,30 +67,30 @@
     "temp-directory": "nyc/.nyc_output"
   },
   "dependencies": {
-    "@fluid-internal/client-utils": "~2.0.2",
-    "@fluidframework/container-definitions": "~2.0.2",
-    "@fluidframework/container-runtime": "~2.0.2",
-    "@fluidframework/core-interfaces": "~2.0.2",
-    "@fluidframework/core-utils": "~2.0.2",
-    "@fluidframework/datastore": "~2.0.2",
-    "@fluidframework/datastore-definitions": "~2.0.2",
-    "@fluidframework/driver-definitions": "~2.0.2",
-    "@fluidframework/runtime-definitions": "~2.0.2",
-    "@fluidframework/runtime-utils": "~2.0.2",
-    "@fluidframework/telemetry-utils": "~2.0.2",
+    "@fluid-internal/client-utils": "2.1.0-276326",
+    "@fluidframework/container-definitions": "2.1.0-276326",
+    "@fluidframework/container-runtime": "2.1.0-276326",
+    "@fluidframework/core-interfaces": "2.1.0-276326",
+    "@fluidframework/core-utils": "2.1.0-276326",
+    "@fluidframework/datastore": "2.1.0-276326",
+    "@fluidframework/datastore-definitions": "2.1.0-276326",
+    "@fluidframework/driver-definitions": "2.1.0-276326",
+    "@fluidframework/runtime-definitions": "2.1.0-276326",
+    "@fluidframework/runtime-utils": "2.1.0-276326",
+    "@fluidframework/telemetry-utils": "2.1.0-276326",
     "uuid": "^9.0.0"
   },
   "devDependencies": {
     "@arethetypeswrong/cli": "^0.15.2",
     "@biomejs/biome": "^1.7.3",
-    "@fluid-internal/mocha-test-setup": "~2.0.2",
-    "@fluid-private/test-pairwise-generator": "~2.0.2",
+    "@fluid-internal/mocha-test-setup": "2.1.0-276326",
+    "@fluid-private/test-pairwise-generator": "2.1.0-276326",
     "@fluid-tools/build-cli": "^0.39.0",
     "@fluidframework/build-common": "^2.0.3",
     "@fluidframework/build-tools": "^0.39.0",
     "@fluidframework/eslint-config-fluid": "^5.3.0",
-    "@fluidframework/shared-object-base-previous": "npm:@fluidframework/shared-object-base@2.0.0-rc.4.0.0",
-    "@fluidframework/test-runtime-utils": "~2.0.2",
+    "@fluidframework/shared-object-base-previous": "npm:@fluidframework/shared-object-base@2.0.0-rc.5.0.0",
+    "@fluidframework/test-runtime-utils": "2.1.0-276326",
     "@microsoft/api-extractor": "^7.45.1",
     "@types/benchmark": "^2.1.0",
     "@types/mocha": "^9.1.1",
@@ -117,13 +117,15 @@
   },
   "scripts": {
     "api": "fluid-build . --task api",
-    "api-extractor:commonjs": "flub generate entrypoints --outFileAlpha legacy --outDir ./dist",
-    "api-extractor:esnext": "flub generate entrypoints --outFileAlpha legacy --outDir ./lib --node10TypeCompat",
+    "api-extractor:commonjs": "flub generate entrypoints --outDir ./dist",
+    "api-extractor:esnext": "flub generate entrypoints --outDir ./lib --node10TypeCompat",
     "bench": "ts-node bench/src/index.ts",
     "build": "fluid-build . --task build",
     "build:commonjs": "fluid-build . --task commonjs",
     "build:compile": "fluid-build . --task compile",
-    "build:docs": "api-extractor run --local",
+    "build:docs": "concurrently \"npm:build:docs:*\"",
+    "build:docs:current": "api-extractor run --local",
+    "build:docs:legacy": "api-extractor run --local --config api-extractor/api-extractor.legacy.json",
     "build:esnext": "tsc --project ./tsconfig.json",
     "build:genver": "gen-version",
     "build:test": "npm run build:test:esm && npm run build:test:cjs",
@@ -139,7 +141,9 @@
     "check:exports:esm:public": "api-extractor run --config api-extractor/api-extractor-lint-public.esm.json",
     "check:format": "npm run check:biome",
     "check:prettier": "prettier --check . --cache --ignore-path ../../../.prettierignore",
-    "ci:build:docs": "api-extractor run",
+    "ci:build:docs": "concurrently \"npm:ci:build:docs:*\"",
+    "ci:build:docs:current": "api-extractor run",
+    "ci:build:docs:legacy": "api-extractor run --config api-extractor/api-extractor.legacy.json",
     "clean": "rimraf --glob dist lib \"*.d.ts\" \"**/*.tsbuildinfo\" \"**/*.build.log\" _api-extractor-temp nyc",
     "eslint": "eslint --format stylish src",
     "eslint:fix": "eslint --format stylish src --fix --fix-type problem,suggestion,layout",
@@ -155,7 +159,7 @@
     "test:mocha:esm": "mocha --recursive \"lib/test/**/*.spec.*js\" --exit",
     "test:mocha:verbose": "cross-env FLUID_TEST_VERBOSE=1 npm run test:mocha",
     "tsc": "fluid-tsc commonjs --project ./tsconfig.cjs.json && copyfiles -f ../../../common/build/build-common/src/cjs/package.json ./dist",
-    "typetests:gen": "flub generate typetests --dir . -v --publicFallback",
+    "typetests:gen": "flub generate typetests --dir . -v",
     "typetests:prepare": "flub typetests --dir . --reset --previous --normalize"
   }
 }

package/src/packageVersion.ts

@@ -6,4 +6,4 @@
  */
 
 export const pkgName = "@fluidframework/shared-object-base";
-export const pkgVersion = "2.0.2";
+export const pkgVersion = "2.1.0-276326";

package/src/serializer.ts

@@ -21,6 +21,7 @@ import {
 import { RemoteFluidObjectHandle } from "./remoteObjectHandle.js";
 
 /**
+ * @legacy
  * @alpha
  */
 export interface IFluidSerializer {

package/src/sharedObject.ts

@@ -43,6 +43,7 @@ import {
 	createChildLogger,
 	loggerToMonitoringContext,
 	tagCodeArtifacts,
+	type ICustomData,
 } from "@fluidframework/telemetry-utils/internal";
 import { v4 as uuid } from "uuid";
 
@@ -52,8 +53,18 @@ import { SummarySerializer } from "./summarySerializer.js";
 import { ISharedObject, ISharedObjectEvents } from "./types.js";
 import { makeHandlesSerializable, parseHandles } from "./utils.js";
 
+/**
+ * Custom telemetry properties used in {@link SharedObjectCore} to instantiate {@link TelemetryEventBatcher} class.
+ * This interface is used to define the properties that will be passed to the {@link TelemetryEventBatcher.measure} function
+ * which is called in the {@link SharedObjectCore.process} method.
+ */
+interface ProcessTelemetryProperties {
+	sequenceDifference: number;
+}
+
 /**
  * Base class from which all shared objects derive.
+ * @legacy
  * @alpha
  */
 export abstract class SharedObjectCore<
@@ -66,8 +77,11 @@ export abstract class SharedObjectCore<
 		return this;
 	}
 
-	private readonly opProcessingHelper: SampledTelemetryHelper;
-	private readonly callbacksHelper: SampledTelemetryHelper;
+	private readonly opProcessingHelper: SampledTelemetryHelper<
+		void,
+		ProcessTelemetryProperties
+	>;
+	private readonly callbacksHelper: SampledTelemetryHelper<boolean>;
 
 	/**
 	 * The handle referring to this SharedObject
@@ -137,7 +151,9 @@ export abstract class SharedObjectCore<
 		});
 		this.mc = loggerToMonitoringContext(this.logger);
 
-		[this.opProcessingHelper, this.callbacksHelper] = this.setUpSampledTelemetryHelpers();
+		const { opProcessingHelper, callbacksHelper } = this.setUpSampledTelemetryHelpers();
+		this.opProcessingHelper = opProcessingHelper;
+		this.callbacksHelper = callbacksHelper;
 	}
 
 	/**
@@ -153,12 +169,15 @@ export abstract class SharedObjectCore<
 	 * @returns The telemetry sampling helpers, so the constructor can be the one to assign them
 	 * to variables to avoid complaints from TypeScript.
 	 */
-	private setUpSampledTelemetryHelpers(): SampledTelemetryHelper[] {
+	private setUpSampledTelemetryHelpers(): {
+		opProcessingHelper: SampledTelemetryHelper<void, ProcessTelemetryProperties>;
+		callbacksHelper: SampledTelemetryHelper<boolean>;
+	} {
 		assert(
 			this.mc !== undefined && this.logger !== undefined,
 			0x349 /* this.mc and/or this.logger has not been set */,
 		);
-		const opProcessingHelper = new SampledTelemetryHelper(
+		const opProcessingHelper = new SampledTelemetryHelper<void, ProcessTelemetryProperties>(
 			{
 				eventName: "ddsOpProcessing",
 				category: "performance",
@@ -171,7 +190,7 @@ export abstract class SharedObjectCore<
 				["remote", { localOp: false }],
 			]),
 		);
-		const callbacksHelper = new SampledTelemetryHelper(
+		const callbacksHelper = new SampledTelemetryHelper<boolean>(
 			{
 				eventName: "ddsEventCallbacks",
 				category: "performance",
@@ -186,7 +205,7 @@ export abstract class SharedObjectCore<
 			this.opProcessingHelper.dispose();
 		});
 
-		return [opProcessingHelper, callbacksHelper];
+		return { opProcessingHelper, callbacksHelper };
 	}
 
 	/**
@@ -536,8 +555,14 @@ export abstract class SharedObjectCore<
 		this.emitInternal("pre-op", message, local, this);
 
 		this.opProcessingHelper.measure(
-			() => {
+			(): ICustomData<ProcessTelemetryProperties> => {
 				this.processCore(message, local, localOpMetadata);
+				const telemetryProperties: ProcessTelemetryProperties = {
+					sequenceDifference: message.sequenceNumber - message.referenceSequenceNumber,
+				};
+				return {
+					customData: telemetryProperties,
+				};
 			},
 			local ? "local" : "remote",
 		);
@@ -612,6 +637,7 @@ export abstract class SharedObjectCore<
 /**
  * SharedObject with simplified, synchronous summarization and GC.
  * DDS implementations with async and incremental summarization should extend SharedObjectCore directly instead.
+ * @legacy
  * @alpha
  */
 export abstract class SharedObject<
@@ -791,6 +817,7 @@ export abstract class SharedObject<
  * This does not extend {@link SharedObjectKind} since doing so would prevent implementing this interface in type safe code.
  * Any implementation of this can safely be used as a {@link SharedObjectKind} with an explicit type conversion,
  * but doing so is typically not needed as {@link createSharedObjectKind} is used to produce values that are both types simultaneously.
+ * @legacy
  * @alpha
  */
 export interface ISharedObjectKind<TSharedObject> {

package/src/types.ts

@@ -14,6 +14,7 @@ import { IGarbageCollectionData } from "@fluidframework/runtime-definitions/inte
 
 /**
  * Events emitted by {@link ISharedObject}.
+ * @legacy
  * @alpha
  */
 export interface ISharedObjectEvents extends IErrorEvent {
@@ -54,6 +55,7 @@ export interface ISharedObjectEvents extends IErrorEvent {
 
 /**
  * Base interface for shared objects from which other interfaces derive. Implemented by SharedObject
+ * @legacy
  * @alpha
  */
 export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents>

package/src/utils.ts

@@ -39,6 +39,7 @@ export function serializeHandles(
  * @param context - The handle context for the container
  * @param bind - Bind any other handles we find in the object against this given handle.
  * @returns The fully-plain object
+ * @legacy
  * @alpha
  */
 export function makeHandlesSerializable(
@@ -58,6 +59,7 @@ export function makeHandlesSerializable(
  * @param serializer - The serializer that knows how to convert serializable-form handles into handle objects
  * @param context - The handle context for the container
  * @returns The mostly-plain object with handle objects within
+ * @legacy
  * @alpha
  */
 export function parseHandles(value: any, serializer: IFluidSerializer) {