@pulumi/pulumi 3.142.0-alpha.x1837a70 → 3.142.1-alpha.x121eb89

package/proto/provider_grpc_pb.js

@@ -308,6 +308,28 @@ function deserialize_pulumirpc_PluginInfo(buffer_arg) {
   return pulumi_plugin_pb.PluginInfo.deserializeBinary(new Uint8Array(buffer_arg));
 }
 
+function serialize_pulumirpc_ProviderHandshakeRequest(arg) {
+  if (!(arg instanceof pulumi_provider_pb.ProviderHandshakeRequest)) {
+    throw new Error('Expected argument of type pulumirpc.ProviderHandshakeRequest');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_pulumirpc_ProviderHandshakeRequest(buffer_arg) {
+  return pulumi_provider_pb.ProviderHandshakeRequest.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
+function serialize_pulumirpc_ProviderHandshakeResponse(arg) {
+  if (!(arg instanceof pulumi_provider_pb.ProviderHandshakeResponse)) {
+    throw new Error('Expected argument of type pulumirpc.ProviderHandshakeResponse');
+  }
+  return Buffer.from(arg.serializeBinary());
+}
+
+function deserialize_pulumirpc_ProviderHandshakeResponse(buffer_arg) {
+  return pulumi_provider_pb.ProviderHandshakeResponse.deserializeBinary(new Uint8Array(buffer_arg));
+}
+
 function serialize_pulumirpc_ReadRequest(arg) {
   if (!(arg instanceof pulumi_provider_pb.ReadRequest)) {
     throw new Error('Expected argument of type pulumirpc.ReadRequest');
@@ -358,6 +380,22 @@ function deserialize_pulumirpc_UpdateResponse(buffer_arg) {
 // operations on resources and invocations of functions. Resource providers are primarily managed by the Pulumi engine
 // as part of a deployment in order to interact with the cloud providers underpinning a Pulumi application.
 var ResourceProviderService = exports.ResourceProviderService = {
+  // `Handshake` is the first call made by the engine to a provider. It is used to pass the engine's address to the
+// provider so that it may establish its own connections back, and to establish protocol configuration that will be
+// used to communicate between the two parties. Providers that support `Handshake` implicitly support the set of
+// feature flags previously handled by `Configure` prior to `Handshake`'s introduction, such as secrets and resource
+// references.
+handshake: {
+    path: '/pulumirpc.ResourceProvider/Handshake',
+    requestStream: false,
+    responseStream: false,
+    requestType: pulumi_provider_pb.ProviderHandshakeRequest,
+    responseType: pulumi_provider_pb.ProviderHandshakeResponse,
+    requestSerialize: serialize_pulumirpc_ProviderHandshakeRequest,
+    requestDeserialize: deserialize_pulumirpc_ProviderHandshakeRequest,
+    responseSerialize: serialize_pulumirpc_ProviderHandshakeResponse,
+    responseDeserialize: deserialize_pulumirpc_ProviderHandshakeResponse,
+  },
   // `Parameterize` is the primary means of supporting [parameterized providers](parameterized-providers), which allow
 // a caller to change a provider's behavior ahead of its [configuration](pulumirpc.ResourceProvider.Configure) and
 // subsequent use. Where a [](pulumirpc.ResourceProvider.Configure) call allows a caller to influence provider
@@ -458,7 +496,7 @@ diffConfig: {
     responseSerialize: serialize_pulumirpc_DiffResponse,
     responseDeserialize: deserialize_pulumirpc_DiffResponse,
   },
-  // `Configure` is the final stage in configuring a provider instance. Callers supply two sets of data:
+  // `Configure` is the final stage in configuring a provider instance. Callers may supply two sets of data:
 //
 // * Provider-specific configuration, which is the set of inputs that have been validated by a previous
 //   [](pulumirpc.ResourceProvider.CheckConfig) call.
@@ -470,6 +508,19 @@ diffConfig: {
 // Providers may expect a *single* call to `Configure`. If a call to `Configure` is missing required configuration,
 // the provider may return a set of error details containing [](pulumirpc.ConfigureErrorMissingKeys) values to
 // indicate which keys are missing.
+//
+// :::{important}
+// The use of `Configure` to configure protocol features is deprecated in favour of the
+// [](pulumirpc.ResourceProvider.Handshake) method, which should be implemented by newer providers. To enable
+// compatibility between older engines and providers:
+//
+// * Callers which call `Handshake` *must* call `Configure` with flags such as `acceptSecrets` and `acceptResources`
+//   set to `true`, since these features predate the introduction of `Handshake` and thus `Handshake`-aware callers
+//   must support them. See [](pulumirpc.ConfigureRequest) for more information.
+// * Providers which implement `Handshake` *must* support flags such as `acceptSecrets` and `acceptResources`, and
+//   indicate as such by always returning `true` for these fields in [](pulumirpc.ConfigureResponse). See
+//   [](pulumirpc.ConfigureResponse) for more information.
+// :::
 configure: {
     path: '/pulumirpc.ResourceProvider/Configure',
     requestStream: false,

package/proto/provider_pb.d.ts

@@ -9,6 +9,55 @@ import * as pulumi_plugin_pb from "./plugin_pb";
 import * as google_protobuf_empty_pb from "google-protobuf/google/protobuf/empty_pb";
 import * as google_protobuf_struct_pb from "google-protobuf/google/protobuf/struct_pb";
 
+export class ProviderHandshakeRequest extends jspb.Message { 
+    getEngineAddress(): string;
+    setEngineAddress(value: string): ProviderHandshakeRequest;
+
+    hasRootDirectory(): boolean;
+    clearRootDirectory(): void;
+    getRootDirectory(): string | undefined;
+    setRootDirectory(value: string): ProviderHandshakeRequest;
+
+    hasProgramDirectory(): boolean;
+    clearProgramDirectory(): void;
+    getProgramDirectory(): string | undefined;
+    setProgramDirectory(value: string): ProviderHandshakeRequest;
+
+    serializeBinary(): Uint8Array;
+    toObject(includeInstance?: boolean): ProviderHandshakeRequest.AsObject;
+    static toObject(includeInstance: boolean, msg: ProviderHandshakeRequest): ProviderHandshakeRequest.AsObject;
+    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+    static serializeBinaryToWriter(message: ProviderHandshakeRequest, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): ProviderHandshakeRequest;
+    static deserializeBinaryFromReader(message: ProviderHandshakeRequest, reader: jspb.BinaryReader): ProviderHandshakeRequest;
+}
+
+export namespace ProviderHandshakeRequest {
+    export type AsObject = {
+        engineAddress: string,
+        rootDirectory?: string,
+        programDirectory?: string,
+    }
+}
+
+export class ProviderHandshakeResponse extends jspb.Message { 
+
+    serializeBinary(): Uint8Array;
+    toObject(includeInstance?: boolean): ProviderHandshakeResponse.AsObject;
+    static toObject(includeInstance: boolean, msg: ProviderHandshakeResponse): ProviderHandshakeResponse.AsObject;
+    static extensions: {[key: number]: jspb.ExtensionFieldInfo<jspb.Message>};
+    static extensionsBinary: {[key: number]: jspb.ExtensionFieldBinaryInfo<jspb.Message>};
+    static serializeBinaryToWriter(message: ProviderHandshakeResponse, writer: jspb.BinaryWriter): void;
+    static deserializeBinary(bytes: Uint8Array): ProviderHandshakeResponse;
+    static deserializeBinaryFromReader(message: ProviderHandshakeResponse, reader: jspb.BinaryReader): ProviderHandshakeResponse;
+}
+
+export namespace ProviderHandshakeResponse {
+    export type AsObject = {
+    }
+}
+
 export class ParameterizeRequest extends jspb.Message { 
 
     hasArgs(): boolean;

package/proto/provider_pb.js

@@ -61,10 +61,54 @@ goog.exportSymbol('proto.pulumirpc.ParameterizeRequest.ParametersValue', null, g
 goog.exportSymbol('proto.pulumirpc.ParameterizeResponse', null, global);
 goog.exportSymbol('proto.pulumirpc.PropertyDiff', null, global);
 goog.exportSymbol('proto.pulumirpc.PropertyDiff.Kind', null, global);
+goog.exportSymbol('proto.pulumirpc.ProviderHandshakeRequest', null, global);
+goog.exportSymbol('proto.pulumirpc.ProviderHandshakeResponse', null, global);
 goog.exportSymbol('proto.pulumirpc.ReadRequest', null, global);
 goog.exportSymbol('proto.pulumirpc.ReadResponse', null, global);
 goog.exportSymbol('proto.pulumirpc.UpdateRequest', null, global);
 goog.exportSymbol('proto.pulumirpc.UpdateResponse', 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.ProviderHandshakeRequest = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
+};
+goog.inherits(proto.pulumirpc.ProviderHandshakeRequest, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.pulumirpc.ProviderHandshakeRequest.displayName = 'proto.pulumirpc.ProviderHandshakeRequest';
+}
+/**
+ * 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.ProviderHandshakeResponse = function(opt_data) {
+  jspb.Message.initialize(this, opt_data, 0, -1, null, null);
+};
+goog.inherits(proto.pulumirpc.ProviderHandshakeResponse, jspb.Message);
+if (goog.DEBUG && !COMPILED) {
+  /**
+   * @public
+   * @override
+   */
+  proto.pulumirpc.ProviderHandshakeResponse.displayName = 'proto.pulumirpc.ProviderHandshakeResponse';
+}
 /**
  * Generated by JsPbCodeGenerator.
  * @param {Array=} opt_data Optional initial data array, typically from a
@@ -906,6 +950,333 @@ if (goog.DEBUG && !COMPILED) {
   proto.pulumirpc.GetMappingsResponse.displayName = 'proto.pulumirpc.GetMappingsResponse';
 }
 
+
+
+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.ProviderHandshakeRequest.prototype.toObject = function(opt_includeInstance) {
+  return proto.pulumirpc.ProviderHandshakeRequest.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.ProviderHandshakeRequest} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.pulumirpc.ProviderHandshakeRequest.toObject = function(includeInstance, msg) {
+  var f, obj = {
+    engineAddress: jspb.Message.getFieldWithDefault(msg, 1, ""),
+    rootDirectory: jspb.Message.getFieldWithDefault(msg, 2, ""),
+    programDirectory: jspb.Message.getFieldWithDefault(msg, 3, "")
+  };
+
+  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.ProviderHandshakeRequest}
+ */
+proto.pulumirpc.ProviderHandshakeRequest.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.pulumirpc.ProviderHandshakeRequest;
+  return proto.pulumirpc.ProviderHandshakeRequest.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.pulumirpc.ProviderHandshakeRequest} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.pulumirpc.ProviderHandshakeRequest}
+ */
+proto.pulumirpc.ProviderHandshakeRequest.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.setEngineAddress(value);
+      break;
+    case 2:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setRootDirectory(value);
+      break;
+    case 3:
+      var value = /** @type {string} */ (reader.readString());
+      msg.setProgramDirectory(value);
+      break;
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.pulumirpc.ProviderHandshakeRequest.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.ProviderHandshakeRequest} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.pulumirpc.ProviderHandshakeRequest.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+  f = message.getEngineAddress();
+  if (f.length > 0) {
+    writer.writeString(
+      1,
+      f
+    );
+  }
+  f = /** @type {string} */ (jspb.Message.getField(message, 2));
+  if (f != null) {
+    writer.writeString(
+      2,
+      f
+    );
+  }
+  f = /** @type {string} */ (jspb.Message.getField(message, 3));
+  if (f != null) {
+    writer.writeString(
+      3,
+      f
+    );
+  }
+};
+
+
+/**
+ * optional string engine_address = 1;
+ * @return {string}
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.getEngineAddress = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 1, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.pulumirpc.ProviderHandshakeRequest} returns this
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.setEngineAddress = function(value) {
+  return jspb.Message.setProto3StringField(this, 1, value);
+};
+
+
+/**
+ * optional string root_directory = 2;
+ * @return {string}
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.getRootDirectory = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 2, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.pulumirpc.ProviderHandshakeRequest} returns this
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.setRootDirectory = function(value) {
+  return jspb.Message.setField(this, 2, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.pulumirpc.ProviderHandshakeRequest} returns this
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.clearRootDirectory = function() {
+  return jspb.Message.setField(this, 2, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.hasRootDirectory = function() {
+  return jspb.Message.getField(this, 2) != null;
+};
+
+
+/**
+ * optional string program_directory = 3;
+ * @return {string}
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.getProgramDirectory = function() {
+  return /** @type {string} */ (jspb.Message.getFieldWithDefault(this, 3, ""));
+};
+
+
+/**
+ * @param {string} value
+ * @return {!proto.pulumirpc.ProviderHandshakeRequest} returns this
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.setProgramDirectory = function(value) {
+  return jspb.Message.setField(this, 3, value);
+};
+
+
+/**
+ * Clears the field making it undefined.
+ * @return {!proto.pulumirpc.ProviderHandshakeRequest} returns this
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.clearProgramDirectory = function() {
+  return jspb.Message.setField(this, 3, undefined);
+};
+
+
+/**
+ * Returns whether this field is set.
+ * @return {boolean}
+ */
+proto.pulumirpc.ProviderHandshakeRequest.prototype.hasProgramDirectory = function() {
+  return jspb.Message.getField(this, 3) != null;
+};
+
+
+
+
+
+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.ProviderHandshakeResponse.prototype.toObject = function(opt_includeInstance) {
+  return proto.pulumirpc.ProviderHandshakeResponse.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.ProviderHandshakeResponse} msg The msg instance to transform.
+ * @return {!Object}
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.pulumirpc.ProviderHandshakeResponse.toObject = function(includeInstance, msg) {
+  var f, obj = {
+
+  };
+
+  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.ProviderHandshakeResponse}
+ */
+proto.pulumirpc.ProviderHandshakeResponse.deserializeBinary = function(bytes) {
+  var reader = new jspb.BinaryReader(bytes);
+  var msg = new proto.pulumirpc.ProviderHandshakeResponse;
+  return proto.pulumirpc.ProviderHandshakeResponse.deserializeBinaryFromReader(msg, reader);
+};
+
+
+/**
+ * Deserializes binary data (in protobuf wire format) from the
+ * given reader into the given message object.
+ * @param {!proto.pulumirpc.ProviderHandshakeResponse} msg The message object to deserialize into.
+ * @param {!jspb.BinaryReader} reader The BinaryReader to use.
+ * @return {!proto.pulumirpc.ProviderHandshakeResponse}
+ */
+proto.pulumirpc.ProviderHandshakeResponse.deserializeBinaryFromReader = function(msg, reader) {
+  while (reader.nextField()) {
+    if (reader.isEndGroup()) {
+      break;
+    }
+    var field = reader.getFieldNumber();
+    switch (field) {
+    default:
+      reader.skipField();
+      break;
+    }
+  }
+  return msg;
+};
+
+
+/**
+ * Serializes the message to binary data (in protobuf wire format).
+ * @return {!Uint8Array}
+ */
+proto.pulumirpc.ProviderHandshakeResponse.prototype.serializeBinary = function() {
+  var writer = new jspb.BinaryWriter();
+  proto.pulumirpc.ProviderHandshakeResponse.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.ProviderHandshakeResponse} message
+ * @param {!jspb.BinaryWriter} writer
+ * @suppress {unusedLocalVariables} f is only used for nested messages
+ */
+proto.pulumirpc.ProviderHandshakeResponse.serializeBinaryToWriter = function(message, writer) {
+  var f = undefined;
+};
+
+
+
 /**
  * Oneof group definitions for this message. Each group defines the field
  * numbers belonging to that group. When of these fields' value is set, all

package/provider/provider.d.ts

@@ -151,6 +151,13 @@ export interface Provider {
      * The JSON-encoded schema for this provider's package.
      */
     schema?: string;
+    /**
+     * Gets the JSON-encoded schema for this provider's package.
+     * Implementations can lazily load or generate the schema when needed.
+     *
+     * @returns A promise that resolves to the JSON-encoded schema string.
+     */
+    getSchema?: () => Promise<string>;
     /**
      * Validates that the given property bag is valid for a resource of the
      * given type.

package/provider/server.js

@@ -86,10 +86,26 @@ class Server {
         const req = call.request;
         if (req.getVersion() !== 0) {
             callback(new Error(`unsupported schema version ${req.getVersion()}`), undefined);
+            return;
         }
         const resp = new provproto.GetSchemaResponse();
-        resp.setSchema(this.provider.schema || "{}");
-        callback(undefined, resp);
+        if (this.provider.schema) {
+            resp.setSchema(this.provider.schema);
+            callback(undefined, resp);
+        }
+        else if (this.provider.getSchema) {
+            this.provider
+                .getSchema()
+                .then((schema) => {
+                resp.setSchema(schema);
+                callback(undefined, resp);
+            })
+                .catch((err) => callback(err, undefined));
+        }
+        else {
+            resp.setSchema("{}");
+            callback(undefined, resp);
+        }
     }
     // Config methods
     checkConfig(call, callback) {