Add Flyin Config for VSCode Extension

[Future-Outlier]

Tracking issue

flyteorg/flyte#4284

Describe your changes

• I updated the documentation accordingly.
• All new and existing tests passed.
• All commits are signed-off.

Why

• First use case: provide users predefined configs with common extension set, so users don't have to specify url themselves.
• Second use case: For users want to append the default extension list, provide add_extension method in VscodeConfig dataclass to append the extension list. Directly changing extension_remote_path will overwrite the list and not convenient.

What

• Add Predefined Config, for example variables like : COPILOT_CONFIG, VIM_CONFIG, CODE_TOGETHER_CONFIG
• Add Extension Variables, for example variables like : COPILOT_EXTENSION, VIM_EXTENSION, CODE_TOGETHER_EXTENSION
• Add add_extensions function: a function to extend the list of extension_remote_path, you can use either str or List[str] as the input variable.

Tests

Written in the Setup Process.
You can refer to the flyin tests too, it will teach you how to setup your custom config.

Setup Process

FROM python:3.9-slim-buster
USER root
WORKDIR /root
ENV PYTHONPATH /root
RUN apt-get update && apt-get install build-essential -y
RUN apt-get install git -y

RUN pip install -U git+https://github.com/Future-Outlier/flytekit.git@f564bd5b3bc1ae813ef704cea8e28e4724591228#subdirectory=plugins/flytekit-flyin

docker build -t localhost:30000/flytekit:flyin-2023-1127-2215 -f DockerfileVscode .
docker push localhost:30000/flytekit:flyin-2023-1127-2215

from flytekit import ImageSpec, task, workflow
from flytekitplugins.flyin import (CODE_TOGETHER_EXTENSION, COPILOT_EXTENSION,
                                   VIM_EXTENSION, VscodeConfig, vscode, VIM_CONFIG, COPILOT_CONFIG, CODE_TOGETHER_CONFIG)

"""
vim_config = VIM_CONFIG
copilot_config = COPILOT_CONFIG
code_together_config = CODE_TOGETHER_CONFIG
"""


additional_extensions = [COPILOT_EXTENSION, VIM_EXTENSION, CODE_TOGETHER_EXTENSION]
config = VscodeConfig()
config.add_extensions(additional_extensions)


@task(
    container_image="localhost:30000/flytekit:flyin-2023-1127-2215",
)
@vscode(
    config=config,
)
def t(a: int, b: int) -> int:
    return a + b


@workflow
def wf(a: int = 5, b: int = 3) -> int:
    out = t(a=a, b=b)
    return out

Screenshots

[codecov]

Codecov Report

Attention: 1 lines in your changes are missing coverage. Please review.

Comparison is base (ff7aadc) 86.14% compared to head (b33e1ba) 86.15%.
Report is 1 commits behind head on master.

Files	Patch %	Lines
...lyin/flytekitplugins/flyin/vscode_lib/decorator.py	75.00%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #1989      +/-   ##
==========================================
+ Coverage   86.14%   86.15%   +0.01%     
==========================================
  Files         319      320       +1     
  Lines       23399    23439      +40     
  Branches     3457     3457              
==========================================
+ Hits        20157    20195      +38     
- Misses       2651     2652       +1     
- Partials      591      592       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[ByronHsu]

You misunderstand the purpose of this PR a bit. we should create predefined configs instead of adding extensions as constant.

The title of this PR should be changed to Add Predefined Flyin Config for easier use

The description can be changed to

Why?

We want to predefine flyin configs containing the most common extension set, so users don't have to provide the remote URL themselves. They can directly use our predefined configs. e.g.

from flytekitplugins.flyin import copilot_config

@vscode(
  config=conpilot_config
)

Users are also free to create the config themselves by appending extension

from flytekitplugins.flyin.predefined_config import VscodeConfig

c = VscodeConfig()
c.add_extension(...)

@vscode(
  config=c
)

What?

We have created three predefined configs

• copilot_config
• vim_config
• code_together_config

[ByronHsu]

Code looks good, but have to make pr description clearer. My suggestion:

Why

• First use case: provide users predefined configs with common extension set, so users don't have to specify url themselves.
• Second use case: For users want to append the default extension list, provide add_extension method in VscodeConfig dataclass to append the extension list. Directly changing extension_remote_path will overwrite the list and not convenient.

What

• Add Predefined Config, for example variables like : COPILOT_CONFIG, VIM_CONFIG, CODE_TOGETHER_CONFIG
• Add Extension Variables: ...
• Add add_extensions function: ...

[ByronHsu]

Suggested change

	# VSCode config with extensions
	# Predefined VSCode config with extensions

[Future-Outlier]

Fixed it, thank you really really much!

[ByronHsu]

LGTM

[troychiu]

LGTM. Thank you @Future-Outlier