feat(sdk): add print function to create console output without a trialing newline #5379

mortax · 2024-01-01T01:38:25Z

This PR implements the real solution to the issue raised in discussion #1772:

Add print() to generate console output without a trailing newline

Note that I have not included println() since it would be the same as log().

By submitting this pull request, I confirm that my contribution is made under the terms of the Wing Cloud Contribution License.

monadabot · 2024-01-01T01:38:37Z

Thanks for opening this pull request! 🎉
Please consult the contributing guidelines for details on how to contribute to this project.
If you need any assistence, don't hesitate to ping the relevant owner over Slack.

Topic	Owner
Wing SDK and utility APIs	`@chriscbr`
Wing Console	`@ainvoner`, `@skyrpex`, `@polamoros`
JSON, structs, primitives and collections	`@hasanaburayyan`
Platforms and plugins	`@hasanaburayyan`
Frontend resources (website, react, etc)	`@tsuf239`
Language design	`@eladb`
VSCode extension and language server	`@markmcculloh`
Compiler architecture, inflights, lifting	`@yoav-steinberg`
Wing Testing Framework	`@tsuf239`
Wing CLI	`@markmcculloh`
Build system, dev environment, releases	`@markmcculloh`
Library Ecosystem	`@chriscbr`
Documentation	`@hasanaburayyan`
SDK test suite	`@tsuf239`
Examples	`@skorfmann`
Wing Playground	`@eladcon`

monadabot · 2024-01-01T01:44:28Z

Console preview environment is available at https://wing-console-pr-5379.fly.dev 🚀

Last Updated (UTC) 2024-01-01 07:28

monadabot · 2024-01-01T01:52:55Z

Benchmarks

Comparison to Baseline 🟥⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜⬜

Benchmark	Before	After	Change
version	75ms±0.6	78ms±0.9	+3ms (+3.88%)🟥
jsii_big.test.w -t sim	3519ms±23.16	3531ms±18.61	+12ms (+0.34%)⬜
jsii_big.test.w -t tf-aws	3640ms±14.1	3644ms±16.02	+4ms (+0.11%)⬜
functions_1.test.w -t sim	653ms±5.13	656ms±6.32	+3ms (+0.47%)⬜
functions_1.test.w -t tf-aws	1827ms±50.25	1794ms±34.82	-33ms (-1.82%)⬜
hello_world.test.w -t sim	656ms±6.72	653ms±5.69	-4ms (-0.58%)⬜
hello_world.test.w -t tf-aws	5140ms±44.32	5132ms±38.53	-8ms (-0.16%)⬜
functions_10.test.w -t sim	722ms±4.53	724ms±5.14	+2ms (+0.21%)⬜
functions_10.test.w -t tf-aws	3790ms±32.69	3846ms±14.36	+56ms (+1.48%)⬜
jsii_small.test.w -t sim	607ms±7.26	613ms±6.45	+6ms (+0.95%)⬜
jsii_small.test.w -t tf-aws	729ms±5.21	738ms±2.54	+9ms (+1.27%)⬜
empty.test.w -t sim	613ms±4.2	615ms±5.42	+2ms (+0.33%)⬜
empty.test.w -t tf-aws	737ms±6.39	732ms±5.3	-5ms (-0.7%)⬜

⬜ Within 1.5 standard deviations
🟩 Faster, Above 1.5 standard deviations
🟥 Slower, Above 1.5 standard deviations

Benchmarks may vary outside of normal expectations, especially when running in GitHub Actions CI.

Results

name	mean	min	max	moe	sd
version	78ms	76ms	80ms	1ms	1ms
jsii_big.test.w -t sim	3531ms	3491ms	3579ms	19ms	26ms
jsii_big.test.w -t tf-aws	3644ms	3601ms	3677ms	16ms	22ms
functions_1.test.w -t sim	656ms	638ms	668ms	6ms	9ms
functions_1.test.w -t tf-aws	1794ms	1746ms	1893ms	35ms	49ms
hello_world.test.w -t sim	653ms	639ms	664ms	6ms	8ms
hello_world.test.w -t tf-aws	5132ms	5010ms	5194ms	39ms	54ms
functions_10.test.w -t sim	724ms	714ms	737ms	5ms	7ms
functions_10.test.w -t tf-aws	3846ms	3824ms	3888ms	14ms	20ms
jsii_small.test.w -t sim	613ms	600ms	626ms	6ms	9ms
jsii_small.test.w -t tf-aws	738ms	731ms	745ms	3ms	4ms
empty.test.w -t sim	615ms	603ms	626ms	5ms	8ms
empty.test.w -t tf-aws	732ms	724ms	745ms	5ms	7ms

Last Updated (UTC) 2024-01-01 07:36

eladb

I am not convinced that this use case entitles a whole new built in function. We are trying to minimize those as much as possible.

Maybe something like fs.stdout.write("text") work?

eladb · 2024-01-01T06:43:05Z

examples/tests/valid/log.test.w

+bring cloud;
+
+
+log("preflight log");


Can you move this to test under sdk_tests?

sure. interestingly, this was already in valid but you're right, sdk_tests makes much more sense.

Maybe something like fs.stdout.write("text") work?

yes, that would certainly work (i have been doing the equivalent). thought i completely understand the goal to minimize, i think any language that supports basic output (as Wing does with log()) should do the same without a newline (just MHO).

How about?

log("foo", newline: false);

Just a bit of context: logging in wing doesn't have the same semantic meaning as printing to standard error, standard output in traditional programming, languages.

There's also a big difference between preflight and inflight.

In preflight logs are basically part of the compilation output while in inflight logs are emitted from the runtime code, executed on the cloud in various computation platforms, such as lambda containers, etc.

i gave it a try (spending most of today messing with it) but didn't have any real success.

@mortax really appreciate the efforts!

@Chriscbr or @yoav-steinberg will be able to help.

alternatively - if you are comfortable with implementing this as a standard library function in the meantime, so that you are unblocked, then go ahead and we can discuss the built-in support in log() separately.

thanks @eladb. i can wait until it can be done properly. i have my own workaround for now so it's not worth expending effort for something temporary.

i'm ready to do the bulk of the work -- i just need a gentle shove in the right direction.

It looks like you're on the right track @mortax. To get the newline parameter working, I think you'll need to add a new struct type. The reason's that in Wing, named parameters are implemented by providing a struct as the last parameter in any function or constructor. So it will be as if we defined the log function like

let log = (message: str, opts: LogOptions) => { ... }

but callers can use it any of these ways:

log("foo"); // or log("foo", newline: false); // or log("foo", LogOptions { newline: false });

I'd suggest maybe going about this by adding a struct through the Wing SDK, which is implemented as a TypeScript interface. Here's an example of another one:

wing/libs/wingsdk/src/std/json.ts

Lines 3 to 9 in 2ca491b

/**

* Options for stringify() method.

*/

export interface JsonStringifyOptions {

/** Indentation spaces number */

readonly indent: number;

}

std would be a good place for this. Once the interface is added there, you can update the code where builtins are added. (It was in lib.rs but it was recently moved to type_check.rs - look for the add_builtins function).

Let me know that helps or if you run into any issues!

thanks. i'll try to give this a try tomorrow.

Signed-off-by: monada-bot[bot] <monabot@monada.co>

github-actions · 2024-01-25T06:05:15Z

Hi,

This PR has not seen activity in 20 days. Therefore, we are marking the PR as stale for now. It will be closed after 7 days.
If you need help with the PR, do not hesitate to reach out in the winglang community slack at winglang.slack.com.
Feel free to re-open this PR when it is still relevant and ready to be worked on again.
Thanks!

feat(sdk): add print function

7b36c81

mortax requested a review from a team as a code owner January 1, 2024 01:38

monadabot added the ⚠️ pr/review-mutation PR has been mutated and will not auto-merge. Clear this label if the changes look good! label Jan 1, 2024

mortax requested a review from garysassano January 1, 2024 06:23

eladb requested changes Jan 1, 2024

View reviewed changes

mortax force-pushed the print branch from 9667599 to 7b36c81 Compare January 1, 2024 07:11

mortax requested a review from eladb January 1, 2024 07:12

garysassano removed their request for review January 1, 2024 07:13

monadabot and others added 3 commits January 1, 2024 09:23

Merge branch 'main' into print

9b7bfd2

chore: self mutation (build.diff)

f09f60f

Signed-off-by: monada-bot[bot] <monabot@monada.co>

chore: self mutation (e2e-1of2.diff)

c71ea99

Signed-off-by: monada-bot[bot] <monabot@monada.co>

mortax marked this pull request as draft January 1, 2024 16:45

github-actions bot added the Stale label Jan 25, 2024

github-actions bot closed this Feb 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(sdk): add print function to create console output without a trialing newline #5379

feat(sdk): add print function to create console output without a trialing newline #5379

mortax commented Jan 1, 2024

monadabot commented Jan 1, 2024

monadabot commented Jan 1, 2024 •

edited

Loading

monadabot commented Jan 1, 2024 •

edited

Loading

eladb left a comment

eladb Jan 1, 2024

mortax Jan 1, 2024

mortax Jan 1, 2024

eladb Jan 1, 2024

eladb Jan 1, 2024

mortax Jan 2, 2024

eladb Jan 2, 2024

mortax Jan 3, 2024

Chriscbr Jan 3, 2024

mortax Jan 4, 2024

github-actions bot commented Jan 25, 2024

	/**
	* Options for stringify() method.
	*/
	export interface JsonStringifyOptions {
	/** Indentation spaces number */
	readonly indent: number;
	}

		bring cloud;


		log("preflight log");

feat(sdk): add print function to create console output without a trialing newline #5379

feat(sdk): add print function to create console output without a trialing newline #5379

Conversation

mortax commented Jan 1, 2024

monadabot commented Jan 1, 2024

monadabot commented Jan 1, 2024 • edited Loading

Last Updated (UTC) 2024-01-01 07:28

monadabot commented Jan 1, 2024 • edited Loading

Benchmarks

Last Updated (UTC) 2024-01-01 07:36

eladb left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

github-actions bot commented Jan 25, 2024

monadabot commented Jan 1, 2024 •

edited

Loading

monadabot commented Jan 1, 2024 •

edited

Loading