[engine] Add support for source positions
These changes add support for passing source position information in
gRPC metadata and recording the source position that corresponds to a
resource registration in the statefile.
Enabling source position information in the resource model can provide
substantial benefits, including but not limited to:
- Better errors from the Pulumi CLI
- Go-to-defintion for resources in state
- Editor integration for errors, etc. from `pulumi preview`
Source positions are (file, line) or (file, line, column) tuples
represented as URIs. The line and column are stored in the fragment
portion of the URI as "line(,column)?". The scheme of the URI and the
form of its path component depends on the context in which it is
generated or used:
- During an active update, the URI's scheme is `file` and paths are
absolute filesystem paths. This allows consumers to easily access
arbitrary files that are available on the host.
- In a statefile, the URI's scheme is `project` and paths are relative
to the project root. This allows consumers to resolve source positions
relative to the project file in different contexts irrespective of the
location of the project itself (e.g. given a project-relative path and
the URL of the project's root on GitHub, one can build a GitHub URL for
the source position).
During an update, source position information may be attached to gRPC
calls as "source-position" metadata. This allows arbitrary calls to be
associated with source positions without changes to their protobuf
payloads. Modifying the protobuf payloads is also a viable approach, but
is somewhat more invasive than attaching metadata, and requires changes
to every call signature.
Source positions should reflect the position in user code that initiated
a resource model operation (e.g. the source position passed with
`RegisterResource` for `pet` in the example above should be the source
position in `index.ts`, _not_ the source position in the Pulumi SDK). In
general, the Pulumi SDK should be able to infer the source position of
the resource registration, as the relationship between a resource
registration and its corresponding user code should be static per SDK.
Source positions in state files will be stored as a new `registeredAt`
property on each resource. This property is optional.
2023-06-29 18:41:19 +00:00
|
|
|
// source: pulumi/source.proto
|
|
|
|
/**
|
|
|
|
* @fileoverview
|
|
|
|
* @enhanceable
|
|
|
|
* @suppress {missingRequire} reports error on implicit type usages.
|
|
|
|
* @suppress {messageConventions} JS Compiler reports an error if a variable or
|
|
|
|
* field starts with 'MSG_' and isn't a translatable message.
|
|
|
|
* @public
|
|
|
|
*/
|
|
|
|
// GENERATED CODE -- DO NOT EDIT!
|
|
|
|
/* eslint-disable */
|
|
|
|
// @ts-nocheck
|
|
|
|
|
|
|
|
var jspb = require('google-protobuf');
|
|
|
|
var goog = jspb;
|
2023-11-10 13:31:14 +00:00
|
|
|
var proto = { pulumirpc: { codegen: { }, testing: { } } }, global = proto;
|
[engine] Add support for source positions
These changes add support for passing source position information in
gRPC metadata and recording the source position that corresponds to a
resource registration in the statefile.
Enabling source position information in the resource model can provide
substantial benefits, including but not limited to:
- Better errors from the Pulumi CLI
- Go-to-defintion for resources in state
- Editor integration for errors, etc. from `pulumi preview`
Source positions are (file, line) or (file, line, column) tuples
represented as URIs. The line and column are stored in the fragment
portion of the URI as "line(,column)?". The scheme of the URI and the
form of its path component depends on the context in which it is
generated or used:
- During an active update, the URI's scheme is `file` and paths are
absolute filesystem paths. This allows consumers to easily access
arbitrary files that are available on the host.
- In a statefile, the URI's scheme is `project` and paths are relative
to the project root. This allows consumers to resolve source positions
relative to the project file in different contexts irrespective of the
location of the project itself (e.g. given a project-relative path and
the URL of the project's root on GitHub, one can build a GitHub URL for
the source position).
During an update, source position information may be attached to gRPC
calls as "source-position" metadata. This allows arbitrary calls to be
associated with source positions without changes to their protobuf
payloads. Modifying the protobuf payloads is also a viable approach, but
is somewhat more invasive than attaching metadata, and requires changes
to every call signature.
Source positions should reflect the position in user code that initiated
a resource model operation (e.g. the source position passed with
`RegisterResource` for `pet` in the example above should be the source
position in `index.ts`, _not_ the source position in the Pulumi SDK). In
general, the Pulumi SDK should be able to infer the source position of
the resource registration, as the relationship between a resource
registration and its corresponding user code should be static per SDK.
Source positions in state files will be stored as a new `registeredAt`
property on each resource. This property is optional.
2023-06-29 18:41:19 +00:00
|
|
|
|
|
|
|
goog.exportSymbol('proto.pulumirpc.SourcePosition', null, global);
|
|
|
|
/**
|
|
|
|
* Generated by JsPbCodeGenerator.
|
|
|
|
* @param {Array=} opt_data Optional initial data array, typically from a
|
|
|
|
* server response, or constructed directly in Javascript. The array is used
|
|
|
|
* in place and becomes part of the constructed object. It is not cloned.
|
|
|
|
* If no data is provided, the constructed object will be empty, but still
|
|
|
|
* valid.
|
|
|
|
* @extends {jspb.Message}
|
|
|
|
* @constructor
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition = function(opt_data) {
|
|
|
|
jspb.Message.initialize(this, opt_data, 0, -1, null, null);
|
|
|
|
};
|
|
|
|
goog.inherits(proto.pulumirpc.SourcePosition, jspb.Message);
|
|
|
|
if (goog.DEBUG && !COMPILED) {
|
|
|
|
/**
|
|
|
|
* @public
|
|
|
|
* @override
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.displayName = 'proto.pulumirpc.SourcePosition';
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
if (jspb.Message.GENERATE_TO_OBJECT) {
|
|
|
|
/**
|
|
|
|
* Creates an object representation of this proto.
|
|
|
|
* Field names that are reserved in JavaScript and will be renamed to pb_name.
|
|
|
|
* Optional fields that are not set will be set to undefined.
|
|
|
|
* To access a reserved field use, foo.pb_<name>, eg, foo.pb_default.
|
|
|
|
* For the list of reserved names please see:
|
|
|
|
* net/proto2/compiler/js/internal/generator.cc#kKeyword.
|
|
|
|
* @param {boolean=} opt_includeInstance Deprecated. whether to include the
|
|
|
|
* JSPB instance for transitional soy proto support:
|
|
|
|
* http://goto/soy-param-migration
|
|
|
|
* @return {!Object}
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.prototype.toObject = function(opt_includeInstance) {
|
|
|
|
return proto.pulumirpc.SourcePosition.toObject(opt_includeInstance, this);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Static version of the {@see toObject} method.
|
|
|
|
* @param {boolean|undefined} includeInstance Deprecated. Whether to include
|
|
|
|
* the JSPB instance for transitional soy proto support:
|
|
|
|
* http://goto/soy-param-migration
|
|
|
|
* @param {!proto.pulumirpc.SourcePosition} msg The msg instance to transform.
|
|
|
|
* @return {!Object}
|
|
|
|
* @suppress {unusedLocalVariables} f is only used for nested messages
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.toObject = function(includeInstance, msg) {
|
|
|
|
var f, obj = {
|
|
|
|
uri: jspb.Message.getFieldWithDefault(msg, 1, ""),
|
|
|
|
line: jspb.Message.getFieldWithDefault(msg, 2, 0),
|
|
|
|
column: jspb.Message.getFieldWithDefault(msg, 3, 0)
|
|
|
|
};
|
|
|
|
|
|
|
|
if (includeInstance) {
|
|
|
|
obj.$jspbMessageInstance = msg;
|
|
|
|
}
|
|
|
|
return obj;
|
|
|
|
};
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deserializes binary data (in protobuf wire format).
|
|
|
|
* @param {jspb.ByteSource} bytes The bytes to deserialize.
|
|
|
|
* @return {!proto.pulumirpc.SourcePosition}
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.deserializeBinary = function(bytes) {
|
|
|
|
var reader = new jspb.BinaryReader(bytes);
|
|
|
|
var msg = new proto.pulumirpc.SourcePosition;
|
|
|
|
return proto.pulumirpc.SourcePosition.deserializeBinaryFromReader(msg, reader);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Deserializes binary data (in protobuf wire format) from the
|
|
|
|
* given reader into the given message object.
|
|
|
|
* @param {!proto.pulumirpc.SourcePosition} msg The message object to deserialize into.
|
|
|
|
* @param {!jspb.BinaryReader} reader The BinaryReader to use.
|
|
|
|
* @return {!proto.pulumirpc.SourcePosition}
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.deserializeBinaryFromReader = function(msg, reader) {
|
|
|
|
while (reader.nextField()) {
|
|
|
|
if (reader.isEndGroup()) {
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
var field = reader.getFieldNumber();
|
|
|
|
switch (field) {
|
|
|
|
case 1:
|
|
|
|
var value = /** @type {string} */ (reader.readString());
|
|
|
|
msg.setUri(value);
|
|
|
|
break;
|
|
|
|
case 2:
|
|
|
|
var value = /** @type {number} */ (reader.readInt32());
|
|
|
|
msg.setLine(value);
|
|
|
|
break;
|
|
|
|
case 3:
|
|
|
|
var value = /** @type {number} */ (reader.readInt32());
|
|
|
|
msg.setColumn(value);
|
|
|
|
break;
|
|
|
|
default:
|
|
|
|
reader.skipField();
|
|
|
|
break;
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return msg;
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Serializes the message to binary data (in protobuf wire format).
|
|
|
|
* @return {!Uint8Array}
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.prototype.serializeBinary = function() {
|
|
|
|
var writer = new jspb.BinaryWriter();
|
|
|
|
proto.pulumirpc.SourcePosition.serializeBinaryToWriter(this, writer);
|
|
|
|
return writer.getResultBuffer();
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Serializes the given message to binary data (in protobuf wire
|
|
|
|
* format), writing to the given BinaryWriter.
|
|
|
|
* @param {!proto.pulumirpc.SourcePosition} message
|
|
|
|
* @param {!jspb.BinaryWriter} writer
|
|
|
|
* @suppress {unusedLocalVariables} f is only used for nested messages
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.serializeBinaryToWriter = function(message, writer) {
|
|
|
|
var f = undefined;
|
|
|
|
f = message.getUri();
|
|
|
|
if (f.length > 0) {
|
|
|
|
writer.writeString(
|
|
|
|
1,
|
|
|
|
f
|
|
|
|
);
|
|
|
|
}
|
|
|
|
f = message.getLine();
|
|
|
|
if (f !== 0) {
|
|
|
|
writer.writeInt32(
|
|
|
|
2,
|
|
|
|
f
|
|
|
|
);
|
|
|
|
}
|
|
|
|
f = message.getColumn();
|
|
|
|
if (f !== 0) {
|
|
|
|
writer.writeInt32(
|
|
|
|
3,
|
|
|
|
f
|
|
|
|
);
|
|
|
|
}
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* optional string uri = 1;
|
|
|
|
* @return {string}
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.prototype.getUri = function() {
|
|
|
|
return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {string} value
|
|
|
|
* @return {!proto.pulumirpc.SourcePosition} returns this
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.prototype.setUri = function(value) {
|
|
|
|
return jspb.Message.setProto3StringField(this, 1, value);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* optional int32 line = 2;
|
|
|
|
* @return {number}
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.prototype.getLine = function() {
|
|
|
|
return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 2, 0));
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {number} value
|
|
|
|
* @return {!proto.pulumirpc.SourcePosition} returns this
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.prototype.setLine = function(value) {
|
|
|
|
return jspb.Message.setProto3IntField(this, 2, value);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* optional int32 column = 3;
|
|
|
|
* @return {number}
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.prototype.getColumn = function() {
|
|
|
|
return /** @type {number} */ (jspb.Message.getFieldWithDefault(this, 3, 0));
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
/**
|
|
|
|
* @param {number} value
|
|
|
|
* @return {!proto.pulumirpc.SourcePosition} returns this
|
|
|
|
*/
|
|
|
|
proto.pulumirpc.SourcePosition.prototype.setColumn = function(value) {
|
|
|
|
return jspb.Message.setProto3IntField(this, 3, value);
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
|
|
goog.object.extend(exports, proto.pulumirpc);
|