@recordreplay/protocol - npm Package Compare versions

Comparing version 0.10.2 to 0.10.4

js/client/build/client.d.ts

@@ -13,3 +13,3 @@ import { uploadedData, awaitingSourcemaps, sessionError, getDescriptionParameters, createSessionParameters, releaseSessionParameters, processRecordingParameters, addSourceMapParameters, addOriginalSourceParameters } from "../../protocol/Recording";
 import { convertLocationToFunctionOffsetParameters, convertFunctionOffsetToLocationParameters, getStepOffsetsParameters, getHTMLSourceParameters, getFunctionsInRangeParameters, getSourceMapURLParameters, getSheetSourceMapURLParameters, getCurrentMessageContentsParameters, countStackFramesParameters, getStackFunctionIDsParameters, currentGeneratorIdParameters, topFrameLocationParameters } from "../../protocol/Target";
-import { createRecordingParameters, setRecordingMetadataParameters, addRecordingDataParameters, addRecordingDescriptionParameters, beginRecordingResourceUploadParameters, endRecordingResourceUploadParameters, echoParameters, labelTestSessionParameters, reportCrashParameters } from "../../protocol/Internal";
+import { createRecordingParameters, setRecordingMetadataParameters, addRecordingDataParameters, addRecordingDescriptionParameters, finishRecordingParameters, beginRecordingResourceUploadParameters, endRecordingResourceUploadParameters, echoParameters, labelTestSessionParameters, reportCrashParameters } from "../../protocol/Internal";
 import { GenericProtocolClient } from "../generic";
@@ -654,5 +654,6 @@ export declare class ProtocolClient {
          * Add data to a recording. The next message sent after this must be a binary
-         * message with the data described by this message. Uploaded recordings are not
-         * explicitly finished; replay sessions created for a recording will include
-         * all data which was successfully uploaded.
+         * message with the data described by this message. A response to this command
+         * indicates that the data has been successfully received by the server, but it
+         * could still be lost due to a server failure. Use `Internal.finishRecording`
+         * if you want to ensure that all data has been successfully stored.
          */
@@ -665,2 +666,9 @@ addRecordingData: (parameters: addRecordingDataParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").addRecordingDataResult>;
         /**
+         * Indicate that all data for the given recording has been sent and the recording
+         * can be marked ready and complete. If this is not sent, the recording will be
+         * finished as a sideeffect of the connection closing, but if backend issues
+         * were to fail to save all of the data, there will be no way to know.
+         */
+        finishRecording: (parameters: finishRecordingParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Internal").finishRecordingResult>;
+        /**
          * Lock a given recording so that sessions will not be created
@@ -667,0 +675,0 @@ * until the lock has been removed.

js/client/build/client.js

@@ -853,5 +853,6 @@ "use strict";
              * Add data to a recording. The next message sent after this must be a binary
-             * message with the data described by this message. Uploaded recordings are not
-             * explicitly finished; replay sessions created for a recording will include
-             * all data which was successfully uploaded.
+             * message with the data described by this message. A response to this command
+             * indicates that the data has been successfully received by the server, but it
+             * could still be lost due to a server failure. Use `Internal.finishRecording`
+             * if you want to ensure that all data has been successfully stored.
              */
@@ -868,2 +869,11 @@ addRecordingData: function (parameters, sessionId, pauseId) {
             /**
+             * Indicate that all data for the given recording has been sent and the recording
+             * can be marked ready and complete. If this is not sent, the recording will be
+             * finished as a sideeffect of the connection closing, but if backend issues
+             * were to fail to save all of the data, there will be no way to know.
+             */
+            finishRecording: function (parameters, sessionId, pauseId) {
+                return _this.genericClient.sendCommand("Internal.finishRecording", parameters, sessionId, pauseId);
+            },
+            /**
              * Lock a given recording so that sessions will not be created
@@ -870,0 +880,0 @@ * until the lock has been removed.

js/protocol/index.d.ts

@@ -26,3 +26,3 @@ export * from "./Recording";
 import { convertLocationToFunctionOffsetParameters, convertLocationToFunctionOffsetResult, convertFunctionOffsetToLocationParameters, convertFunctionOffsetToLocationResult, getStepOffsetsParameters, getStepOffsetsResult, getHTMLSourceParameters, getHTMLSourceResult, getFunctionsInRangeParameters, getFunctionsInRangeResult, getSourceMapURLParameters, getSourceMapURLResult, getSheetSourceMapURLParameters, getSheetSourceMapURLResult, getCurrentMessageContentsParameters, getCurrentMessageContentsResult, countStackFramesParameters, countStackFramesResult, getStackFunctionIDsParameters, getStackFunctionIDsResult, currentGeneratorIdParameters, currentGeneratorIdResult, topFrameLocationParameters, topFrameLocationResult } from "./Target";
-import { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, addRecordingDescriptionParameters, addRecordingDescriptionResult, beginRecordingResourceUploadParameters, beginRecordingResourceUploadResult, endRecordingResourceUploadParameters, endRecordingResourceUploadResult, echoParameters, echoResult, labelTestSessionParameters, labelTestSessionResult, reportCrashParameters, reportCrashResult } from "./Internal";
+import { createRecordingParameters, createRecordingResult, setRecordingMetadataParameters, setRecordingMetadataResult, addRecordingDataParameters, addRecordingDataResult, addRecordingDescriptionParameters, addRecordingDescriptionResult, finishRecordingParameters, finishRecordingResult, beginRecordingResourceUploadParameters, beginRecordingResourceUploadResult, endRecordingResourceUploadParameters, endRecordingResourceUploadResult, echoParameters, echoResult, labelTestSessionParameters, labelTestSessionResult, reportCrashParameters, reportCrashResult } from "./Internal";
 interface Events {
@@ -1124,5 +1124,6 @@ /**
      * Add data to a recording. The next message sent after this must be a binary
-     * message with the data described by this message. Uploaded recordings are not
-     * explicitly finished; replay sessions created for a recording will include
-     * all data which was successfully uploaded.
+     * message with the data described by this message. A response to this command
+     * indicates that the data has been successfully received by the server, but it
+     * could still be lost due to a server failure. Use `Internal.finishRecording`
+     * if you want to ensure that all data has been successfully stored.
      */
@@ -1147,2 +1148,15 @@ "Internal.addRecordingData": {
     /**
+     * Indicate that all data for the given recording has been sent and the recording
+     * can be marked ready and complete. If this is not sent, the recording will be
+     * finished as a sideeffect of the connection closing, but if backend issues
+     * were to fail to save all of the data, there will be no way to know.
+     */
+    "Internal.finishRecording": {
+        parameters: finishRecordingParameters;
+        result: finishRecordingResult;
+        sessionId: false;
+        pauseId: false;
+        binary: false;
+    };
+    /**
      * Lock a given recording so that sessions will not be created
@@ -1149,0 +1163,0 @@ * until the lock has been removed.

js/protocol/Internal.d.ts

@@ -19,2 +19,12 @@ import { RecordingId, BuildId, TimeStamp } from "./Recording";
     buildId: BuildId;
+    /**
+     * The backend will accept all recording data until it gets an
+     * `Internal.finishRecording` command or the connection closes. Partial
+     * recordings can be useful for debugging, but if data integrity
+     * is important, this option can be used to avoid ending up with a
+     * partially-created recording.
+     * With this flag enabled, a connection loss during upload will
+     * invalidate the recording rather than using the partially-complete data.
+     */
+    requireFinish?: boolean;
 }
@@ -29,3 +39,2 @@ export interface createRecordingResult {
     recordingData: RecordingData;
-    authId?: string;
 }
@@ -72,2 +81,10 @@ export interface setRecordingMetadataResult {
 }
+export interface finishRecordingParameters {
+    /**
+     * ID of the recording being finished.
+     */
+    recordingId: RecordingId;
+}
+export interface finishRecordingResult {
+}
 export interface beginRecordingResourceUploadParameters {
@@ -74,0 +91,0 @@ /**

js/protocol/Pause.d.ts

@@ -55,2 +55,6 @@ import { MappedLocation, PointDescription } from "./Debugger";
     /**
+     * String representation of a symbol.
+     */
+    symbol?: string;
+    /**
      * Set for values of variables which haven't been initialized yet.
@@ -254,2 +258,6 @@ */
     set?: ObjectId;
+    /**
+     * Set if this property's name is a symbol.
+     */
+    isSymbol?: boolean;
 }
@@ -256,0 +264,0 @@ /**

package.json

 {
   "name": "@recordreplay/protocol",
-  "version": "0.10.2",
+  "version": "0.10.4",
   "description": "Definition of the protocol used by the Record Replay web service",
@@ -17,8 +17,8 @@ "author": "",
     "build-json": "python2 inspector_protocol/convert_protocol_to_json.py pdl/protocol.pdl json/protocol.json",
-    "build-ts": "../../node_modules/.bin/ts-node build",
-    "build-js": "../../node_modules/.bin/tsc",
+    "build-ts": "node dobuildts",
+    "build-js": "node dobuildjs",
     "build": "npm run clean && npm run build-json && npm run build-ts && npm run build-js",
-    "clean": "../../node_modules/.bin/rimraf json/protocol.json ts/protocol ts/*/build js",
+    "clean": "node doclean",
     "prepare": "npm run build"
   }
 }

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

381095

increased by1.25%

Lines of code

9001

increased by0.95%

No dependency changes