feat: store icons next to the component definition

[jvallesm]

Because

• Several frontend clients will consume the connector definitions via the ListConnectorDefinitions endpoint.
• The component source code should be the source of truth for the icon, not one of the frontends.

This commit

• Copies the icons into the repo and updates the icon path in the connector definitions.

Notes

⚠️ Frontend should pull these icons in order to include a local version in the service build. Until this task is done, the frontend won't be able to find the icons and will break the component UX.

🪶 The icons aren't used in the backend code so we could exclude them from the image build to have lighter images.

👯 Copy was automated with the following script:

#!/usr/bin/env bash

set -eo pipefail

# This script copies the icon of a component, located in the `console`
# repository, into each component package.
#
# Usage: sh copyicon.sh ~/Code/go/src/github.com/instill-ai/console

CONSOLE_PATH=$1
ICONS_PATH=$CONSOLE_PATH/apps/console/public/icons

function defID() {
  jq -r '.[0].id' $1/config/definitions.json
}

function sourceIcon() {
  jq -r "(\"$ICONS_PATH/\" + .[0].icon)" $1/config/definitions.json
}

for p in $(fd definitions.json | cut -d '/' -f1-2 | sort | uniq); do
  compID=$(defID $p)
  iconPath=$(sourceIcon $p)

  # copy icon
  mkdir -p $p/assets
  cp "$iconPath" "./$p/assets/$compID.svg" || continue # continue if file doesn't exist. This occurs for start and end operators.

  # replace path in definition
  sed -i '' "s/\(\"icon\": \"\).*\(\",*\)/\1assets\/$compID.svg\2/g" $p/config/definitions.json
done;

[linear]

INS-3621 Move component icons from `console` to their component package

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (81af1d5) 62.18% compared to head (95a4e38) 62.18%.

Additional details and impacted files

@@           Coverage Diff           @@
##             main     #122   +/-   ##
=======================================
  Coverage   62.18%   62.18%           
=======================================
  Files          18       18           
  Lines        1489     1489           
=======================================
  Hits          926      926           
  Misses        440      440           
  Partials      123      123           

Flag	Coverage Δ
unittests	62.18% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

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

[donch1989]

Hi @jvallesm @EiffelFly
Is this PR and instill-ai/operator#58 ready to be merged?

[jvallesm]

Hi @jvallesm @EiffelFly Is this PR and instill-ai/operator#58 ready to be merged?

👋 I QAd this with the main version of the console and the icons break in the component display, so it requires frontend changes to include the icons from this repo in the console image build

[EiffelFly]

@jvallesm I will try to support this in this sprint, please merge this PR when you are ready.