feat: allow to upsert a subgraph on publish

.run/router.run.xml

@@ -0,0 +1,12 @@
+<component name="ProjectRunConfigurationManager">
+  <configuration default="false" name="router" type="GoApplicationRunConfiguration" factoryName="Go Application">
+    <module name="cosmo" />
+    <working_directory value="$PROJECT_DIR$/router" />
+    <go_parameters value="-race" />
+    <kind value="FILE" />
+    <package value="github.com/wundergraph/cosmo/router" />
+    <directory value="$PROJECT_DIR$" />
+    <filePath value="$PROJECT_DIR$/router/cmd/router/main.go" />
+    <method v="2" />
+  </configuration>
+</component>

cli/package.json

@@ -55,10 +55,10 @@
     "@types/js-yaml": "^4.0.5",
     "@types/node": "^20.3.1",
     "del-cli": "^5.0.0",
-    "eslint": "^8.44.0",
+    "eslint": "^8.52.0",
     "eslint-config-unjs": "^0.2.1",
     "prettier": "^2.8.8",
-    "tsx": "^3.12.7",
+    "tsx": "^3.14.0",
     "typescript": "^5.2.2",
     "vitest": "^0.34.1"
   },

cli/src/commands/federated-graph/commands/delete.ts

@@ -2,8 +2,8 @@ import { Command } from 'commander';
 import pc from 'picocolors';
 import { EnumStatusCode } from '@wundergraph/cosmo-connect/dist/common/common_pb';
 import inquirer from 'inquirer';
-import { BaseCommandOptions } from '../../../core/types/types.js';
 import { baseHeaders } from '../../../core/config.js';
+import { BaseCommandOptions } from '../../../core/types/types.js';
 
 export default (opts: BaseCommandOptions) => {
   const deleteFederatedGraph = new Command('delete');

cli/src/commands/federated-graph/commands/list.ts

@@ -81,7 +81,7 @@ export default (opts: BaseCommandOptions) => {
     for (const graph of resp.graphs) {
       graphsTable.push([
         graph.name,
-        graph.labelMatchers.join(','),
+        graph.labelMatchers.map((l) => `(${l})`).join(','),
         graph.routingURL,
         graph.isComposable ? logSymbols.success : logSymbols.error,
         graph.lastUpdatedAt,

cli/src/commands/subgraph/commands/create.ts

@@ -32,17 +32,12 @@ export default (opts: BaseCommandOptions) => {
     '--subscription-protocol <protocol>',
     'The protocol to use when subscribing to the subgraph. The supported protocols are ws, sse, and sse-post.',
   );
+
   schemaPush.action(async (name, options) => {
     const resp = await opts.client.platform.createFederatedSubgraph(
       {
         name,
-        labels: options.label.map((label: string) => {
-          const { key, value } = splitLabel(label);
-          return {
-            key,
-            value,
-          };
-        }),
+        labels: options.label.map((label: string) => splitLabel(label)),
         routingUrl: options.routingUrl,
         headers: options.header,
         // If the argument is provided but the URL is not, clear it

cli/src/commands/subgraph/commands/delete.ts

@@ -2,6 +2,7 @@ import { Command } from 'commander';
 import pc from 'picocolors';
 import { EnumStatusCode } from '@wundergraph/cosmo-connect/dist/common/common_pb';
 import inquirer from 'inquirer';
+import Table from 'cli-table3';
 import { BaseCommandOptions } from '../../../core/types/types.js';
 import { baseHeaders } from '../../../core/config.js';
 
@@ -32,9 +33,28 @@ export default (opts: BaseCommandOptions) => {
     );
 
     if (resp.response?.code === EnumStatusCode.OK) {
-      console.log(pc.dim(pc.green(`A subgraph called '${name}' was deleted.`)));
+      console.log(pc.dim(pc.green(`Subgraph '${name}' was deleted.`)));
+    } else if (resp.response?.code === EnumStatusCode.ERR_SUBGRAPH_COMPOSITION_FAILED) {
+      const compositionErrorsTable = new Table({
+        head: [pc.bold(pc.white('FEDERATED_GRAPH_NAME')), pc.bold(pc.white('ERROR_MESSAGE'))],
+        colWidths: [30, 120],
+        wordWrap: true,
+      });
+
+      console.log(
+        pc.red(
+          `We found composition errors, while composing the federated graph.\nThe router will continue to work with the latest valid schema.\n${pc.bold(
+            'Please check the errors below:',
+          )}`,
+        ),
+      );
+      for (const compositionError of resp.compositionErrors) {
+        compositionErrorsTable.push([compositionError.federatedGraphName, compositionError.message]);
+      }
+      // Don't exit here with 1 because the change was still applied
+      console.log(compositionErrorsTable.toString());
     } else {
-      console.log(`Failed to delete subgraph ${pc.bold(name)}.`);
+      console.log(pc.red(`Failed to delete subgraph ${pc.bold(name)}.`));
       if (resp.response?.details) {
         console.log(pc.red(pc.bold(resp.response?.details)));
       }

cli/src/commands/subgraph/commands/publish.ts

@@ -5,17 +5,43 @@ import { Command } from 'commander';
 import { resolve } from 'pathe';
 import pc from 'picocolors';
 import { EnumStatusCode } from '@wundergraph/cosmo-connect/dist/common/common_pb';
+import { parseGraphQLSubscriptionProtocol, splitLabel } from '@wundergraph/cosmo-shared';
 import { BaseCommandOptions } from '../../../core/types/types.js';
 import { baseHeaders } from '../../../core/config.js';
 
 export default (opts: BaseCommandOptions) => {
   const schemaPush = new Command('publish');
-  schemaPush.description('Publishes a subgraph on the control plane.');
+  schemaPush.description(
+    "Publishes a subgraph on the control plane. If the subgraph doesn't exists, it will be created.\nIf the publication leads to composition errors, the errors will be visible in the Studio.\nThe router will continue to work with the latest valid schema.\nConsider using the 'wgc subgraph check' command to check for composition errors before publishing.",
+  );
   schemaPush.argument(
     '<name>',
     'The name of the subgraph to push the schema to. It is usually in the format of <org>.<service.name> and is used to uniquely identify your subgraph.',
   );
   schemaPush.requiredOption('--schema <path-to-schema>', 'The schema file to upload to the subgraph.');
+  schemaPush.option(
+    '-r, --routing-url <url>',
+    'The routing url of your subgraph. This is the url that the subgraph will be accessible at (Only required to create the subgraph).',
+  );
+  schemaPush.option(
+    '--label [labels...]',
+    'The labels to apply to the subgraph. The labels are passed in the format <key>=<value> <key>=<value>. Required to create the subgraph.',
+    [],
+  );
+  schemaPush.option(
+    '--header [headers...]',
+    'The headers to apply when the subgraph is introspected. This is used for authentication and authorization.',
+    [],
+  );
+  schemaPush.option(
+    '--subscription-url [url]',
+    'The url used for subscriptions. If empty, it defaults to same url used for routing.',
+  );
+  schemaPush.option(
+    '--subscription-protocol <protocol>',
+    'The protocol to use when subscribing to the subgraph. The supported protocols are ws, sse, and sse-post.',
+  );
+
   schemaPush.action(async (name, options) => {
     const schemaFile = resolve(process.cwd(), options.schema);
     if (!existsSync(schemaFile)) {
@@ -30,7 +56,16 @@ export default (opts: BaseCommandOptions) => {
     const resp = await opts.client.platform.publishFederatedSubgraph(
       {
         name,
+        // Publish schema only
         schema: await readFile(schemaFile),
+        // Optional when subgraph does not exist yet
+        routingUrl: options.routingUrl,
+        headers: options.header,
+        subscriptionUrl: options.subscriptionUrl,
+        subscriptionProtocol: options.subscriptionProtocol
+          ? parseGraphQLSubscriptionProtocol(options.subscriptionProtocol)
+          : undefined,
+        labels: options.label.map((label: string) => splitLabel(label)),
       },
       {
         headers: baseHeaders,
@@ -40,17 +75,17 @@ export default (opts: BaseCommandOptions) => {
     if (resp.response?.code === EnumStatusCode.OK) {
       console.log(pc.dim(pc.green(`Subgraph '${name}' was updated successfully.`)));
     } else if (resp.response?.code === EnumStatusCode.ERR_SUBGRAPH_COMPOSITION_FAILED) {
-      console.log(pc.dim(pc.green(`Subgraph '${name}' was updated successfully.`)));
-
       const compositionErrorsTable = new Table({
         head: [pc.bold(pc.white('FEDERATED_GRAPH_NAME')), pc.bold(pc.white('ERROR_MESSAGE'))],
         colWidths: [30, 120],
         wordWrap: true,
       });
 
       console.log(
-        pc.yellow(
-          'But we found composition errors, while composing the federated graph.\nThe graph will not be updated until the errors are fixed. Please check the errors below:',
+        pc.red(
+          `We found composition errors, while composing the federated graph.\nThe router will continue to work with the latest valid schema.\n${pc.bold(
+            'Please check the errors below:',
+          )}`,
         ),
       );
       for (const compositionError of resp.compositionErrors) {
@@ -59,7 +94,7 @@ export default (opts: BaseCommandOptions) => {
       // Don't exit here with 1 because the change was still applied
       console.log(compositionErrorsTable.toString());
     } else {
-      console.log(`Failed to update subgraph '${pc.bold(name)}'.`);
+      console.log(pc.red(`Failed to update subgraph ${pc.bold(name)}.`));
       if (resp.response?.details) {
         console.log(pc.red(pc.bold(resp.response?.details)));
       }

cli/src/commands/subgraph/commands/update.ts

@@ -67,8 +67,10 @@ export default (opts: BaseCommandOptions) => {
       });
 
       console.log(
-        pc.yellow(
-          'But we found composition errors, while composing the federated graph.\nThe graph will not be updated until the errors are fixed. Please check the errors below:',
+        pc.red(
+          `We found composition errors, while composing the federated graph.\nThe router will continue to work with the latest valid schema.\n${pc.bold(
+            'Please check the errors below:',
+          )}`,
         ),
       );
       for (const compositionError of resp.compositionErrors) {
@@ -77,7 +79,7 @@ export default (opts: BaseCommandOptions) => {
       // Don't exit here with 1 because the change was still applied
       console.log(compositionErrorsTable.toString());
     } else {
-      console.log(`Failed to update subgraph ${pc.bold(name)}.`);
+      console.log(pc.red(`Failed to update subgraph ${pc.bold(name)}.`));
       if (resp.response?.details) {
         console.log(pc.red(pc.bold(resp.response?.details)));
       }

connect/src/wg/cosmo/platform/v1/platform-PlatformService_connectquery.ts

@@ -296,7 +296,7 @@ export const getFederatedGraphByName = createQueryService({
 }).getFederatedGraphByName;
 
 /**
- * GetFederatedGraphSDLByName returns the SDL of the federated graph by name.
+ * GetFederatedGraphSDLByName returns the latest valid SDL of the federated graph by name.
  *
  * @generated from rpc wg.cosmo.platform.v1.PlatformService.GetFederatedGraphSDLByName
  */

connect/src/wg/cosmo/platform/v1/platform_connect.ts

@@ -179,7 +179,7 @@ export const PlatformService = {
       kind: MethodKind.Unary,
     },
     /**
-     * GetFederatedGraphSDLByName returns the SDL of the federated graph by name.
+     * GetFederatedGraphSDLByName returns the latest valid SDL of the federated graph by name.
      *
      * @generated from rpc wg.cosmo.platform.v1.PlatformService.GetFederatedGraphSDLByName
      */

connect/src/wg/cosmo/platform/v1/platform_pb.ts

@@ -379,6 +379,41 @@ export class PublishFederatedSubgraphRequest extends Message<PublishFederatedSub
    */
   schema = new Uint8Array(0);
 
+  /**
+   * routing_url is the URL of the service which will be used to route the requests to the subgraph.
+   *
+   * @generated from field: optional string routing_url = 3;
+   */
+  routingUrl?: string;
+
+  /**
+   * labels are the labels of the services which will form the federated graph. If the proposed is not valid, the service will be rejected.
+   *
+   * @generated from field: repeated wg.cosmo.platform.v1.Label labels = 4;
+   */
+  labels: Label[] = [];
+
+  /**
+   * headers are the headers which will be used to route the requests to the subgraph.
+   *
+   * @generated from field: repeated string headers = 5;
+   */
+  headers: string[] = [];
+
+  /**
+   * subscription protocol to use when subscribing to this subgraph
+   *
+   * @generated from field: optional wg.cosmo.common.GraphQLSubscriptionProtocol subscription_protocol = 6;
+   */
+  subscriptionProtocol?: GraphQLSubscriptionProtocol;
+
+  /**
+   * url used for subscriptions
+   *
+   * @generated from field: optional string subscription_url = 7;
+   */
+  subscriptionUrl?: string;
+
   constructor(data?: PartialMessage<PublishFederatedSubgraphRequest>) {
     super();
     proto3.util.initPartial(data, this);
@@ -389,6 +424,11 @@ export class PublishFederatedSubgraphRequest extends Message<PublishFederatedSub
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "name", kind: "scalar", T: 9 /* ScalarType.STRING */ },
     { no: 2, name: "schema", kind: "scalar", T: 12 /* ScalarType.BYTES */ },
+    { no: 3, name: "routing_url", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
+    { no: 4, name: "labels", kind: "message", T: Label, repeated: true },
+    { no: 5, name: "headers", kind: "scalar", T: 9 /* ScalarType.STRING */, repeated: true },
+    { no: 6, name: "subscription_protocol", kind: "enum", T: proto3.getEnumType(GraphQLSubscriptionProtocol), opt: true },
+    { no: 7, name: "subscription_url", kind: "scalar", T: 9 /* ScalarType.STRING */, opt: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): PublishFederatedSubgraphRequest {
@@ -1107,6 +1147,11 @@ export class DeleteFederatedSubgraphResponse extends Message<DeleteFederatedSubg
    */
   response?: Response;
 
+  /**
+   * @generated from field: repeated wg.cosmo.platform.v1.CompositionError compositionErrors = 2;
+   */
+  compositionErrors: CompositionError[] = [];
+
   constructor(data?: PartialMessage<DeleteFederatedSubgraphResponse>) {
     super();
     proto3.util.initPartial(data, this);
@@ -1116,6 +1161,7 @@ export class DeleteFederatedSubgraphResponse extends Message<DeleteFederatedSubg
   static readonly typeName = "wg.cosmo.platform.v1.DeleteFederatedSubgraphResponse";
   static readonly fields: FieldList = proto3.util.newFieldList(() => [
     { no: 1, name: "response", kind: "message", T: Response },
+    { no: 2, name: "compositionErrors", kind: "message", T: CompositionError, repeated: true },
   ]);
 
   static fromBinary(bytes: Uint8Array, options?: Partial<BinaryReadOptions>): DeleteFederatedSubgraphResponse {