Connector - Aspects created on deployment of a connector

[BrandonFeldhaus]

Is your feature request related to a problem? Please describe.
When you deploy anyone of Magda's connectors, they will create certain aspects necessary for the connector to operate but if there are existing aspects within the database they will be overwritten by the connector when deployed. This proved frustrating when I would modify the project open data aspect to reference a different schema standard but would be overwritten with the default schema standard upon deployment of the connector.

Describe the solution you'd like
I would like when deploying a connector, that it preforms a check for existing aspects and does not overwrite an aspect if it already exists within the database. Adding this to the connector-sdk would be helpful for future development of connectors.

Describe alternatives you've considered
N/A

Additional context
N/A

[t83714]

Thanks @BrandonFeldhaus That's a good idea.
We probably can add a new connector option overwriteAspectDefinition (with default value false) here:

magda/magda-typescript-common/src/JsonConnector.ts

Line 755 in 73434aa

export interface JsonConnectorConfig {

Then when required aspect definitions are created here:

magda/magda-typescript-common/src/JsonConnector.ts

Line 117 in 73434aa

async createAspectDefinitions(): Promise<ConnectionResult> {

We can test the existence of the aspect definitions when this option is false.
As it's part of connector options, it will be configurable via the connector helm chart.

[BrandonFeldhaus]

That sounds like a great idea. Would it be okay for me to work on this issue within the next couple of weeks?

[t83714]

That's excellent if you would like to help 👍 Thanks a lot, @BrandonFeldhaus
If you need anything when working on it, please let me know~

[BrandonFeldhaus]

Awesome! I will definitely reach out if I need help.

My plan is to begin work soon, just need to identify the next couple of internal goals for upcoming sprints.