naming of operation parameters mismatch

[jsnoble]

We have a naming style used in operation that is globally recognized by the teraslice system that usually starts with an _, for example we have _op, _encoding, and _dead_letter_action. However we have two other configurations that don't follow this naming style, its connection and api_name. These are important settings that have meaning in our configurations if set and it can be confusing if some require an _ while others don't.

I would recommend making them all consistent, though this would require a lot of changes so I wanted to write this ticket for your thoughts

[godber]

It's suggestions like this that make me think we can take some time and think through how we change _op and be open to more drastic changes that would not be backwards compatible if they make sense to do. That's why I keep saying things like "we can make this a 3.0 thing".

Trying to understand what you're saying, the OpConfig type:

teraslice/packages/types/src/teraslice.ts

Lines 228 to 251 in 7806a1a

	export interface OpConfig {
	/** The name of the operation */
	_op: string;
	/**
	* Used for specifying the data encoding type when using `DataEntity.fromBuffer`.
	*
	* @default `json`.
	*/
	_encoding?: DataEncoding;
	/**
	* This action will specify what to do when failing to parse or transform a record.
	* The following builtin actions are supported:
	* - "throw": throw the original error
	* - "log": log the error and the data
	* - "none": (default) skip the error entirely
	*
	* If none of the actions are specified it will try and
	* use a registered Dead Letter Queue API under that name.
	* The API must be already be created by a operation before it can used.
	*/
	_dead_letter_action?: DeadLetterAction;
	[prop: string]: any;
	}

is:

export interface OpConfig {
    _op: string;
    _encoding?: DataEncoding;
    _dead_letter_action?: DeadLetterAction;
    [prop: string]: any;
}

I hadn't really ever realized what the _ meant but I guess it means "this property is present in ALL Operations"? I'll go dig up connection and api_name ... I guess ... what does it mean that those two aren't in THAT type?

[jsnoble]

Thats kinda my point that connection and api_name are not in there, it was missed, as for your comment about but I guess it means "this property is present in ALL Operations"? , it not that its necessarily in all operations (though for the most part it is), but that its a configuration meant for teraslice itself and is a recognized setting that can be on every op or api instead of it being a unique parameter for only a specific op or api.

For example, connection is a parameter used by teraslice apis to determine how to make a client from the connectors and api_name is another parameter that is used by teraslice apis to determine and tag which api to use for a given operation. Its all teraslice specific behaviour and don't really have anything to do with the unique parameters of an operation or api