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.

Sign up for GitHub

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

[r11s] Fixing SummaryReader for wholeSummaryUpload: accessing map properties correctly #8864

Merged
merged 3 commits into from
Jan 27, 2022
Merged

[r11s] Fixing SummaryReader for wholeSummaryUpload: accessing map properties correctly #8864

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
ca7d60a
Fixing SummaryReader for wholeSummaryUpload: accessing map properties…
hedasilv Jan 25, 2022
cc35810
Improving error handling
hedasilv Jan 25, 2022
8930d40
Updating summaryReader to replace only missing parts of ILastSummaryS…
hedasilv Jan 25, 2022
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
2 changes: 1 addition & 1 deletion server/routerlicious/packages/lambdas/src/scribe/lambdaFactory.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ export class ScribeLambdaFactory extends EventEmitter implements IPartitionLambd
const tenant = await this.tenantManager.getTenant(tenantId, documentId);
gitManager = tenant.gitManager;

summaryReader = new SummaryReader(documentId, gitManager, this.enableWholeSummaryUpload);
summaryReader = new SummaryReader(tenantId, documentId, gitManager, this.enableWholeSummaryUpload);
[latestSummary, document] = await Promise.all([
summaryReader.readLastSummary(),
this.documentCollection.findOne({ documentId, tenantId }),
Expand Down
120 changes: 92 additions & 28 deletions server/routerlicious/packages/lambdas/src/scribe/summaryReader.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,18 +7,26 @@ import { bufferToString, toUtf8 } from "@fluidframework/common-utils";
import { IDocumentAttributes, ISequencedDocumentMessage } from "@fluidframework/protocol-definitions";
import { convertWholeFlatSummaryToSnapshotTreeAndBlobs, IGitManager } from "@fluidframework/server-services-client";
import { IDeliState } from "@fluidframework/server-services-core";
import { CommonProperties, LumberEventName, Lumberjack } from "@fluidframework/server-services-telemetry";
import {
CommonProperties,
getLumberBaseProperties,
LumberEventName,
Lumberjack,
} from "@fluidframework/server-services-telemetry";
import { ILatestSummaryState, ISummaryReader } from "./interfaces";

/**
* Git specific implementation of ISummaryReader
*/
export class SummaryReader implements ISummaryReader {
private readonly lumberProperties: Record<string, any>;
constructor(
private readonly tenantId: string,
private readonly documentId: string,
private readonly summaryStorage: IGitManager,
private readonly enableWholeSummaryUpload: boolean,
) {
this.lumberProperties = getLumberBaseProperties(this.documentId, this.tenantId);
}

/**
Expand All @@ -27,27 +35,37 @@ export class SummaryReader implements ISummaryReader {
*/
public async readLastSummary(): Promise<ILatestSummaryState> {
const summaryReaderMetric = Lumberjack.newLumberMetric(LumberEventName.SummaryReader);
summaryReaderMetric.setProperties(this.lumberProperties);

if (this.enableWholeSummaryUpload) {
try {
const existingRef = await this.summaryStorage.getRef(encodeURIComponent(this.documentId));
const wholeFlatSummary = await this.summaryStorage.getSummary(existingRef.object.sha);
const normalizedSummary = convertWholeFlatSummaryToSnapshotTreeAndBlobs(wholeFlatSummary);

// Obtain IDs of specific fields from the downloaded summary
const attributesBlobId = normalizedSummary.snapshotTree.trees[".protocol"]?.blobs?.attributes;
const scribeBlobId = normalizedSummary.snapshotTree.trees[".serviceProtocol"]?.blobs?.scribe;
const deliBlobId = normalizedSummary.snapshotTree.trees[".serviceProtocol"]?.blobs?.deli;
const opsBlobId = normalizedSummary.snapshotTree.trees[".logTail"]?.blobs?.logTail;

// Parse specific fields from the downloaded summary
const attributesBlobId = normalizedSummary.snapshotTree.trees[".protocol"].blobs.attributes;
const attributesContent = normalizedSummary.blobs[attributesBlobId];
const scribeBlobId = normalizedSummary.snapshotTree.trees[".serviceProtocol"].blobs.scribe;
const scribeContent = normalizedSummary.blobs[scribeBlobId];
const deliBlobId = normalizedSummary.snapshotTree.trees[".serviceProtocol"].blobs.deli;
const deliContent = normalizedSummary.blobs[deliBlobId];
const opsBlobId = normalizedSummary.snapshotTree.trees[".logTail"].blobs.logTail;
const opsContent = normalizedSummary.blobs[opsBlobId];

const attributes = JSON.parse(bufferToString(attributesContent, "utf8")) as IDocumentAttributes;
const scribe = bufferToString(scribeContent, "utf8");
const deli = JSON.parse(bufferToString(deliContent, "utf8")) as IDeliState;
const attributesContent = attributesBlobId ? normalizedSummary.blobs.get(attributesBlobId) : undefined;
const scribeContent = scribeBlobId ? normalizedSummary.blobs.get(scribeBlobId) : undefined;
const deliContent = deliBlobId ? normalizedSummary.blobs.get(deliBlobId) : undefined;
const opsContent = opsBlobId ? normalizedSummary.blobs.get(opsBlobId) : undefined;

const attributes = attributesContent ?
JSON.parse(bufferToString(attributesContent, "utf8")) as IDocumentAttributes :
this.getDefaultAttributes();
const scribe = scribeContent ? bufferToString(scribeContent, "utf8") : this.getDefaultScribe();
const deli = deliContent ?
JSON.parse(bufferToString(deliContent, "utf8")) as IDeliState :
this.getDefaultDeli();
const term = deli.term;
const messages = JSON.parse(bufferToString(opsContent, "utf8")) as ISequencedDocumentMessage[];
const messages = opsContent ?
JSON.parse(bufferToString(opsContent, "utf8")) as ISequencedDocumentMessage[] :
this.getDefaultMesages();

summaryReaderMetric.setProperties({
[CommonProperties.minLogtailSequenceNumber]: Math.min(...messages.map(
Expand All @@ -67,26 +85,37 @@ export class SummaryReader implements ISummaryReader {
messages,
fromSummary: true,
};
} catch {
summaryReaderMetric.success(`Returning default summary`);
} catch (error: any) {
summaryReaderMetric.error(`Returning default summary due to error when reading whole summary`, error);
return this.getDefaultSummaryState();
}
} else {
try {
const existingRef = await this.summaryStorage.getRef(encodeURIComponent(this.documentId));
const [attributesContent, scribeContent, deliContent, opsContent] = await Promise.all([
this.summaryStorage.getContent(existingRef.object.sha, ".protocol/attributes"),
this.summaryStorage.getContent(existingRef.object.sha, ".serviceProtocol/scribe"),
this.summaryStorage.getContent(existingRef.object.sha, ".serviceProtocol/deli"),
this.summaryStorage.getContent(existingRef.object.sha, ".logTail/logTail"),
this.summaryStorage.getContent(existingRef.object.sha, ".protocol/attributes")
.catch(() => undefined),
this.summaryStorage.getContent(existingRef.object.sha, ".serviceProtocol/scribe")
.catch(() => undefined),
this.summaryStorage.getContent(existingRef.object.sha, ".serviceProtocol/deli")
.catch(() => undefined),
this.summaryStorage.getContent(existingRef.object.sha, ".logTail/logTail")
.catch(() => undefined),
]);
const attributes = JSON.parse(
toUtf8(attributesContent.content, attributesContent.encoding)) as IDocumentAttributes;
const scribe = toUtf8(scribeContent.content, scribeContent.encoding);
const deli = JSON.parse(toUtf8(deliContent.content, deliContent.encoding)) as IDeliState;

const attributes = attributesContent ?
JSON.parse(toUtf8(attributesContent.content, attributesContent.encoding)) as IDocumentAttributes :
this.getDefaultAttributes();
const scribe = scribeContent ?
toUtf8(scribeContent.content, scribeContent.encoding) :
this.getDefaultScribe();
const deli = deliContent ?
JSON.parse(toUtf8(deliContent.content, deliContent.encoding)) as IDeliState :
this.getDefaultDeli();
const term = deli.term;
const messages = JSON.parse(
toUtf8(opsContent.content, opsContent.encoding)) as ISequencedDocumentMessage[];
const messages = opsContent ?
JSON.parse(toUtf8(opsContent.content, opsContent.encoding)) as ISequencedDocumentMessage[] :
this.getDefaultMesages();

summaryReaderMetric.setProperties({
[CommonProperties.minLogtailSequenceNumber]: Math.min(...messages.map(
Expand All @@ -106,8 +135,8 @@ export class SummaryReader implements ISummaryReader {
messages,
fromSummary: true,
};
} catch {
summaryReaderMetric.success(`Returning default summary`);
} catch (error: any) {
summaryReaderMetric.error(`Returning default summary due to error when reading summary`, error);
return this.getDefaultSummaryState();
}
}
Expand All @@ -122,4 +151,39 @@ export class SummaryReader implements ISummaryReader {
fromSummary: false,
};
}

private getDefaultAttributes(): IDocumentAttributes {
Lumberjack.info("Using default attributes when reading summary.", this.lumberProperties);
return {
sequenceNumber: 0,
minimumSequenceNumber: 0,
term: undefined,
};
}

private getDefaultScribe(): string {
Lumberjack.info("Using default scribe when reading summary.", this.lumberProperties);
return "";
}

private getDefaultDeli(): IDeliState {
Lumberjack.info("Using default deli state when reading summary.", this.lumberProperties);
return {
clients: undefined,
durableSequenceNumber: 0,
logOffset: 0,
sequenceNumber: 0,
expHash1: "",
epoch: 0,
term: 1,
lastSentMSN: undefined,
nackMessages: undefined,
successfullyStartedLambdas: [],
};
}

private getDefaultMesages(): ISequencedDocumentMessage[] {
Lumberjack.info("Using default messages when reading summary.", this.lumberProperties);
return [];
}
}
2 changes: 1 addition & 1 deletion server/routerlicious/packages/memory-orderer/src/localOrderer.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -339,7 +339,7 @@ export class LocalOrderer implements IOrderer {
this.gitManager,
scribeMessagesCollection,
false);
const summaryReader = new SummaryReader(this.documentId, this.gitManager, false);
const summaryReader = new SummaryReader(this.tenantId, this.documentId, this.gitManager, false);
const checkpointManager = new CheckpointManager(
context,
this.tenantId,
Expand Down