feat: Teams communication adapter

.gitignore

@@ -130,6 +130,7 @@ packages/web/app/environment-*.mjs
 packages/web/app/src/gql/*.ts
 packages/web/app/src/gql/*.json
 packages/web/app/src/graphql/*.ts
+packages/web/docs/public/feed.xml
 # Changelog
 packages/web/app/src/components/ui/changelog/generated-changelog.ts
 
@@ -142,6 +143,4 @@ deployment/utils/contour.types.ts
 schema.graphql
 resolvers.generated.ts
 
-# generated by tsup
-configs/tsup/dev.config.*.mjs
-packages/web/docs/public/feed.xml
+docker/docker-compose.override.yml

.nvmrc

@@ -0,0 +1 @@
+v22

README.md

@@ -1,3 +1,11 @@
+<!-- Graphql logo readme banner START -->
+<p style="float: right; margin: 0 0 10px 10px;">
+  <a href="https://the-guild.dev">
+    <img src="https://the-guild-org.github.io/press-kit/full-dark-logo.svg" alt="Created by The guild" style="width: 100px;"/>
+  </a>
+</p>
+<!-- Graphql logo readme banner END -->
+
 # GraphQL Hive
 
 GraphQL Hive provides all the tools the get visibility of your GraphQL architecture at all stages,
@@ -51,10 +59,11 @@ GraphQL Hive helps you get a global overview of the usage of your GraphQL API wi
 
 ### Integrations
 
-GraphQL Hive is well integrated with **Slack** and most **CI/CD** systems to get you up and running
-as smoothly as possible!
+GraphQL Hive is well integrated with **Slack**, **MS Teams** and most **CI/CD** systems to get you
+up and running as smoothly as possible!
 
-GraphQL Hive can notify your team when schema changes occur, either via Slack or a custom webhook.
+GraphQL Hive can notify your team when schema changes occur, either via Slack, MS Teams or a custom
+webhook.
 
 Also, the Hive CLI allows integration of the schema checks mechanism to all CI/CD systems (GitHub,
 BitBucket, Azure, and others). The same applies to schema publishing and operations checks.

codegen.mts

@@ -140,6 +140,7 @@ const config: CodegenConfig = {
           AlertChannel: '../modules/alerts/module.graphql.mappers#AlertChannelMapper',
           AlertSlackChannel: '../modules/alerts/module.graphql.mappers#AlertSlackChannelMapper',
           AlertWebhookChannel: '../modules/alerts/module.graphql.mappers#AlertWebhookChannelMapper',
+          TeamsWebhookChannel: '../modules/alerts/module.graphql.mappers#TeamsWebhookChannelMapper',
           Alert: '../modules/alerts/module.graphql.mappers#AlertMapper',
           AdminQuery: '../modules/admin/module.graphql.mappers#AdminQueryMapper',
           AdminStats: '../modules/admin/module.graphql.mappers#AdminStatsMapper',

docs/DEVELOPMENT.md

@@ -5,8 +5,9 @@
 Developing Hive locally requires you to have the following software installed locally:
 
 - Node.js 21 (or `nvm` or `fnm`)
-- pnpm v8
-- Docker
+- pnpm v9
+- Docker version 26.1.1 or later(previous versions will not work correctly on arm64)
+- make sure these ports are free: 5432, 6379, 9000, 9001, 8123, 9092, 8081, 8082, 9644, 3567, 7043
 
 ## Setup Instructions
 

package.json

@@ -25,6 +25,7 @@
     "build:web": "pnpm prebuild && pnpm turbo build --filter=./packages/web/* --color",
     "cargo:fix": "bash ./scripts/fix-symbolic-link.sh",
     "docker:build": "docker buildx bake -f docker/docker.hcl --load build",
+    "docker:override-up": "docker compose -f ./docker/docker-compose.override.yml up -d --remove-orphans",
     "env:sync": "tsx scripts/sync-env-files.ts",
     "generate": "pnpm --filter @hive/storage db:generate && pnpm graphql:generate",
     "graphql:generate": "graphql-codegen --config codegen.mts",
@@ -33,7 +34,7 @@
     "lint:env-template": "tsx scripts/check-env-template.ts",
     "lint:fix": "pnpm lint --fix",
     "lint:prettier": "prettier --cache --check .",
-    "local:setup": "docker-compose -f ./docker/docker-compose.dev.yml up -d --remove-orphans && pnpm --filter @hive/migrations db:init",
+    "local:setup": "docker compose -f ./docker/docker-compose.dev.yml up -d --remove-orphans && pnpm --filter @hive/migrations db:init",
     "postinstall": "node ./scripts/patch-manifests.js && pnpm env:sync && node ./scripts/turborepo-cleanup.js && pnpm cargo:fix",
     "pre-commit": "exit 0 && lint-staged",
     "prebuild": "rimraf deploy-tmp && rimraf packages/**/deploy-tmp",

packages/libraries/cli/examples/single.with.mutation.graphql

@@ -0,0 +1,19 @@
+type Query {
+  foo: Int!
+  bar: String
+  test: String
+  last: Boolean
+  fooTwo: Int!
+}
+
+type Mutation {
+  addFooAnother(foo: Int!): Int!
+  addBar(bar: String): String
+  addTest(test: String): String
+}
+
+schema {
+  query: Query
+  mutation: Mutation
+}
+# test 3

packages/migrations/src/actions/2024.06.11T10-10-00.ms-teams-webhook.ts

@@ -0,0 +1,8 @@
+import { type MigrationExecutor } from '../pg-migrator';
+
+export default {
+  name: '2024.06.11T10-10-00.ms-teams-webhook.ts',
+  run: ({ sql }) => sql`
+    ALTER TYPE alert_channel_type ADD VALUE 'MSTEAMS_WEBHOOK';
+  `,
+} satisfies MigrationExecutor;

packages/migrations/src/run-pg-migrations.ts

@@ -63,6 +63,7 @@ import migration_2024_01_12_01T00_00_00_contracts from './actions/2024.01.26T00.
 import migration_2024_01_12_01T00_00_00_schema_check_pagination_index_update from './actions/2024.01.26T00.00.01.schema-check-pagination-index-update';
 import migration_2024_02_19_01T00_00_00_schema_check_store_breaking_change_metadata from './actions/2024.02.19T00.00.01.schema-check-store-breaking-change-metadata';
 import migration_2024_04_09T10_10_00_check_approval_comment from './actions/2024.04.09T10-10-00.check-approval-comment';
+import migration_2024_06_11T10_10_00_ms_teams_webhook from './actions/2024.06.11T10-10-00.ms-teams-webhook';
 import { runMigrations } from './pg-migrator';
 
 export const runPGMigrations = (args: { slonik: DatabasePool; runTo?: string }) =>
@@ -134,5 +135,6 @@ export const runPGMigrations = (args: { slonik: DatabasePool; runTo?: string })
       migration_2024_01_12_01T00_00_00_schema_check_pagination_index_update,
       migration_2024_02_19_01T00_00_00_schema_check_store_breaking_change_metadata,
       migration_2024_04_09T10_10_00_check_approval_comment,
+      migration_2024_06_11T10_10_00_ms_teams_webhook,
     ],
   });

packages/services/api/package.json

@@ -62,6 +62,7 @@
     "slonik": "30.4.4",
     "supertokens-node": "15.2.1",
     "tslib": "2.6.3",
+    "vitest": "1.6.0",
     "zod": "3.23.8",
     "zod-validation-error": "3.3.0"
   }

packages/services/api/src/modules/alerts/index.ts

@@ -1,4 +1,5 @@
 import { createModule } from 'graphql-modules';
+import { TeamsCommunicationAdapter } from './providers/adapters/msteams';
 import { SlackCommunicationAdapter } from './providers/adapters/slack';
 import { WebhookCommunicationAdapter } from './providers/adapters/webhook';
 import { AlertsManager } from './providers/alerts-manager';
@@ -10,5 +11,10 @@ export const alertsModule = createModule({
   dirname: __dirname,
   typeDefs,
   resolvers,
-  providers: [AlertsManager, SlackCommunicationAdapter, WebhookCommunicationAdapter],
+  providers: [
+    AlertsManager,
+    SlackCommunicationAdapter,
+    WebhookCommunicationAdapter,
+    TeamsCommunicationAdapter,
+  ],
 });

packages/services/api/src/modules/alerts/module.graphql.mappers.ts

@@ -3,4 +3,5 @@ import type { Alert, AlertChannel } from '../../shared/entities';
 export type AlertChannelMapper = AlertChannel;
 export type AlertSlackChannelMapper = AlertChannel;
 export type AlertWebhookChannelMapper = AlertChannel;
+export type TeamsWebhookChannelMapper = AlertChannel;
 export type AlertMapper = Alert;

packages/services/api/src/modules/alerts/module.graphql.ts

@@ -16,6 +16,7 @@ export default gql`
   enum AlertChannelType {
     SLACK
     WEBHOOK
+    MSTEAMS_WEBHOOK
   }
 
   enum AlertType {
@@ -140,6 +141,13 @@ export default gql`
     endpoint: String!
   }
 
+  type TeamsWebhookChannel implements AlertChannel {
+    id: ID!
+    name: String!
+    type: AlertChannelType!
+    endpoint: String!
+  }
+
   type Alert {
     id: ID!
     type: AlertType!

packages/services/api/src/modules/alerts/providers/adapters/common.ts

@@ -8,6 +8,12 @@ import type {
   Target,
 } from '../../../../shared/entities';
 
+interface NotificationIntegrations {
+  slack: {
+    token: string | null | undefined;
+  };
+}
+
 export interface SchemaChangeNotificationInput {
   event: {
     organization: Pick<Organization, 'id' | 'cleanId' | 'name'>;
@@ -25,11 +31,7 @@ export interface SchemaChangeNotificationInput {
   };
   alert: Alert;
   channel: AlertChannel;
-  integrations: {
-    slack: {
-      token: string;
-    };
-  };
+  integrations: NotificationIntegrations;
 }
 
 export interface ChannelConfirmationInput {
@@ -39,11 +41,7 @@ export interface ChannelConfirmationInput {
     project: Pick<Project, 'id' | 'cleanId' | 'name'>;
   };
   channel: AlertChannel;
-  integrations: {
-    slack: {
-      token: string;
-    };
-  };
+  integrations: NotificationIntegrations;
 }
 
 export interface CommunicationAdapter {
@@ -59,9 +57,13 @@ export function quotesTransformer(msg: string, symbols = '**') {
   const findSingleQuotes = /'([^']+)'/gim;
   const findDoubleQuotes = /"([^"]+)"/gim;
 
-  function transformm(_: string, value: string) {
+  function transform(_: string, value: string) {
     return `${symbols}${value}${symbols}`;
   }
 
-  return msg.replace(findSingleQuotes, transformm).replace(findDoubleQuotes, transformm);
+  return msg.replace(findSingleQuotes, transform).replace(findDoubleQuotes, transform);
 }
+
+export const createMDLink = ({ text, url }: { text: string; url: string }) => {
+  return `[${text}](${url})`;
+};