-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
🪟 🔧 Add ConnectorIds utility (#19826)
* Add ConnectorIds utility * Fix typo * Update airbyte-webapp/packages/eslint-plugin/no-hardcoded-connector-ids.js Co-authored-by: Lake Mossman <lake@airbyte.io> * Change variable name * Use in tests * Remove unnecessary comment * Adjust linting errors Co-authored-by: Lake Mossman <lake@airbyte.io>
- Loading branch information
Showing
21 changed files
with
445 additions
and
46 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| This folder should only contain other folders that are treated like local npm packages, | ||
| e.g. because we want to provide plugins or configuration for build tools. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,12 @@ | ||
| module.exports = { | ||
| rules: { | ||
| "no-hardcoded-connector-ids": require("./no-hardcoded-connector-ids"), | ||
| }, | ||
| configs: { | ||
| recommended: { | ||
| rules: { | ||
| "@airbyte/no-hardcoded-connector-ids": "error", | ||
| }, | ||
| }, | ||
| }, | ||
| }; |
38 changes: 38 additions & 0 deletions
38
airbyte-webapp/packages/eslint-plugin/no-hardcoded-connector-ids.js
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,38 @@ | ||
| const destinations = require("../../src/utils/connectors/destinations.json"); | ||
| const sources = require("../../src/utils/connectors/sources.json"); | ||
|
|
||
| // Create a map for connector id to variable name (i.e. flip the direction of the map) | ||
| const sourceIdToName = Object.fromEntries(Object.entries(sources).map((entry) => [entry[1], entry[0]])); | ||
| const destinationIdToName = Object.fromEntries(Object.entries(destinations).map((entry) => [entry[1], entry[0]])); | ||
|
|
||
| const validateStringContent = (context, node, nodeContent) => { | ||
| if (nodeContent in destinationIdToName) { | ||
| context.report({ node, messageId: "destinationId", data: { id: nodeContent, name: destinationIdToName[nodeContent] } }); | ||
| } else if (nodeContent in sourceIdToName) { | ||
| context.report({ node, messageId: "sourceId", data: { id: nodeContent, name: sourceIdToName[nodeContent] } }); | ||
| } | ||
| }; | ||
|
|
||
| module.exports = { | ||
| meta: { | ||
| type: "suggestion", | ||
| messages: { | ||
| sourceId: "Found hard-coded connector id, use `ConnectorIds.Sources.{{ name }}` from `utils/connectors` instead.", | ||
| destinationId: | ||
| "Found hard-coded connector id, use `ConnectorIds.Destinations.{{ name }}` from `utils/connectors` instead.", | ||
| }, | ||
| }, | ||
| create: (context) => ({ | ||
| Literal: (node) => { | ||
| if (typeof node.value === "string") { | ||
| validateStringContent(context, node, node.value); | ||
| } | ||
| }, | ||
| TemplateLiteral: (node) => { | ||
| // Only check template literals which are "static", i.e. don't contain ${} elements | ||
| if (!node.expressions.length && node.quasis.length === 1) { | ||
| validateStringContent(context, node, node.quasis[0].value.raw); | ||
| } | ||
| }, | ||
| }), | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 2 additions & 1 deletion
3
airbyte-webapp/src/test-utils/mock-data/mockDestinationDefinition.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
3 changes: 2 additions & 1 deletion
3
airbyte-webapp/src/test-utils/mock-data/mockSourceDefinition.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 3 additions & 1 deletion
4
airbyte-webapp/src/test-utils/mock-data/mockStartWithDestination.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| import destinationConnectorIds from "./destinations.json"; | ||
| import sourceConnectorIds from "./sources.json"; | ||
|
|
||
| export const ConnectorIds = { | ||
| Sources: sourceConnectorIds, | ||
| Destinations: destinationConnectorIds, | ||
| } as const; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,50 @@ | ||
| { | ||
| "AzureBlobStorage": "b4c5d105-31fd-4817-96b6-cb923bfc04cb", | ||
| "AmazonSqs": "0eeee7fb-518f-4045-bacc-9619e31c43ea", | ||
| "ApacheDoris": "05c161bf-ca73-4d48-b524-d392be417002", | ||
| "ApacheIceberg": "df65a8f3-9908-451b-aa9b-445462803560", | ||
| "AwsDatalake": "99878c90-0fbd-46d3-9d98-ffde879d17fc", | ||
| "BigQuery": "22f6c74f-5699-40ff-833c-4a879ea40133", | ||
| "BigQueryDenormalizedTypedStruct": "079d5540-f236-4294-ba7c-ade8fd918496", | ||
| "Cassandra": "707456df-6f4f-4ced-b5c6-03f73bcad1c5", | ||
| "ChargifyKeen": "81740ce8-d764-4ea7-94df-16bb41de36ae", | ||
| "Clickhouse": "ce0d828e-1dc4-496c-b122-2da42e637e48", | ||
| "CloudflareR2": "0fb07be9-7c3b-4336-850d-5efc006152ee", | ||
| "DatabricksLakehouse": "072d5540-f236-4294-ba7c-ade8fd918496", | ||
| "DynamoDb": "8ccd8909-4e99-4141-b48d-4984b70b2d89", | ||
| "E2ETesting": "2eb65e87-983a-4fd7-b3e3-9d9dc6eb8537", | ||
| "ElasticSearch": "68f351a7-2745-4bef-ad7f-996b8e51bb8c", | ||
| "Firebolt": "18081484-02a5-4662-8dba-b270b582f321", | ||
| "GoogleCloudStorageGcs": "ca8f6566-e555-4b40-943a-545bf123117a", | ||
| "GoogleFirestore": "27dc7500-6d1b-40b1-8b07-e2f2aea3c9f4", | ||
| "GooglePubSub": "356668e2-7e34-47f3-a3b0-67a8a481b692", | ||
| "Kafka": "9f760101-60ae-462f-9ee6-b7a9dafd454d", | ||
| "Kinesis": "6d1d66d4-26ab-4602-8d32-f85894b04955", | ||
| "LocalCsv": "8be1cf83-fde1-477f-a4ad-318d23c9f3c6", | ||
| "LocalJson": "a625d593-bba5-4a1c-a53d-2d246268a816", | ||
| "Mqtt": "f3802bc4-5406-4752-9e8d-01e504ca8194", | ||
| "MsSqlServer": "d4353156-9217-4cad-8dd7-c108fd4f74cf", | ||
| "MeiliSearch": "af7c921e-5892-4ff2-b6c1-4a5ab258fb7e", | ||
| "MongoDb": "8b746512-8c2e-6ac1-4adc-b59faafd473c", | ||
| "MySql": "ca81ee7c-3163-4246-af40-094cc31e5e42", | ||
| "Oracle": "3986776d-2319-4de9-8af8-db14c0996e72", | ||
| "Postgres": "25c5221d-dce2-4163-ade9-739ef790f503", | ||
| "Pulsar": "2340cbba-358e-11ec-8d3d-0242ac130203", | ||
| "RabbitMq": "e06ad785-ad6f-4647-b2e8-3027a5c59454", | ||
| "Redis": "d4d3fef9-e319-45c2-881a-bd02ce44cc9f", | ||
| "Redshift": "f7a7d195-377f-cf5b-70a5-be6b819019dc", | ||
| "Redpanda": "825c5ee3-ed9a-4dd1-a2b6-79ed722f7b13", | ||
| "Rockset": "2c9d93a7-9a17-4789-9de9-f46f0097eb70", | ||
| "S3": "4816b78f-1489-44c1-9060-4b19d5fa9362", | ||
| "S3Glue": "471e5cab-8ed1-49f3-ba11-79c687784737", | ||
| "SftpJson": "e9810f61-4bab-46d2-bb22-edfc902e0644", | ||
| "Snowflake": "424892c4-daac-4491-b35d-c6688ba547ba", | ||
| "MariaDbColumnStore": "294a4790-429b-40ae-9516-49826b9702e1", | ||
| "Streamr": "eebd85cf-60b2-4af6-9ba0-edeca01437b0", | ||
| "Scylla": "3dc6f384-cd6b-4be3-ad16-a41450899bf0", | ||
| "GoogleSheets": "a4cbd2d1-8dbe-4818-b8bc-b90ad782d12a", | ||
| "LocalSqLite": "b76be0a6-27dc-4560-95f6-2623da0bd7b6", | ||
| "TiDb": "06ec60c7-7468-45c0-91ac-174f6e1a788b", | ||
| "Typesense": "36be8dc6-9851-49af-b776-9d4c30e4ab6a", | ||
| "YugabyteDb": "2300fdcf-a532-419f-9f24-a014336e7966" | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| export { ConnectorIds } from "./constants"; |
Oops, something went wrong.