gitlab query

Author: sunlei

server/node-service/package.json

@@ -47,13 +47,15 @@
     "express-async-errors": "^3.1.1",
     "firebase-admin": "^11.5.0",
     "formdata-node": "4",
+    "graphql": "^16.6.0",
+    "graphql-request": "^5.1.0",
     "jsonpath": "^1.1.1",
     "lodash": "^4.17.21",
     "loglevel": "^1.8.1",
     "morgan": "^1.10.0",
     "openapi-types": "^12.1.0",
     "openblocks-core": "^0.0.7",
-    "openblocks-sdk": "^0.0.35",
+    "openblocks-sdk": "0.0.38",
     "pino": "^8.11.0",
     "stylis": "^4.1.3",
     "swagger-client": "^3.18.5",

server/node-service/src/common/util.ts

@@ -1,6 +1,20 @@
 import yaml from "yaml";
 import fs from "fs";
 
+export function kvToRecord(
+  kvs: { key: string; value: string }[],
+  trimEmpty: boolean = true
+): Record<string, string> {
+  const ret: Record<string, string> = {};
+  (kvs || []).forEach(({ key, value }) => {
+    if (trimEmpty && !value) {
+      return;
+    }
+    ret[key] = value;
+  });
+  return ret;
+}
+
 export function toString(value: any): string {
   if (value === undefined || value === null) {
     return "";

server/node-service/src/plugins/gitlab/index.ts

@@ -0,0 +1,54 @@
+import { kvToRecord } from "../../common/util";
+import { ConfigToType, DataSourcePlugin, PluginContext } from "openblocks-sdk/dataSource";
+import { graphQLQueryConfig } from "../graphql/queryConfig";
+import { runGraphQL } from "../graphql/run";
+
+export const dataSourceConfig = {
+  type: "dataSource",
+  params: [
+    {
+      type: "textInput",
+      label: "Endpoint",
+      key: "endpoint",
+      rules: [{ required: true }],
+      placeholder: "https://gitlab.mycompany.com/api/graphql",
+    },
+    {
+      type: "password",
+      label: "Access Token",
+      key: "token",
+      rules: [{ required: true }],
+    },
+    {
+      type: "keyValueInput",
+      label: "Headers",
+      key: "headers",
+      valueType: "string",
+    },
+  ],
+} as const;
+
+const gitlabPlugin: DataSourcePlugin<
+  ConfigToType<typeof graphQLQueryConfig>,
+  ConfigToType<typeof dataSourceConfig>
+> = {
+  id: "gitlab",
+  name: "Gitlab",
+  category: "api",
+  icon: "gitlab.svg",
+  dataSourceConfig,
+  queryConfig: graphQLQueryConfig,
+  run: function (actionData, dataSourceConfig, context: PluginContext): Promise<any> {
+    const { endpoint, token, headers: defaultHeaders } = dataSourceConfig;
+    const { query, variables: variableKvs, headers: queryHeaders } = actionData;
+    const headers = {
+      ...kvToRecord(defaultHeaders),
+      ...kvToRecord(queryHeaders),
+      "PRIVATE-TOKEN": token,
+    };
+    const variables = kvToRecord(variableKvs);
+    return runGraphQL(endpoint, query, variables, headers);
+  },
+};
+
+export default gitlabPlugin;

server/node-service/src/plugins/graphql/queryConfig.ts

@@ -0,0 +1,29 @@
+export const graphQLQueryConfig = {
+  type: "query",
+  label: "Action",
+  actions: [
+    {
+      label: "Query",
+      actionName: "query",
+      params: [
+        {
+          type: "graphqlInput",
+          label: "Query",
+          key: "query",
+        },
+        {
+          type: "keyValueInput",
+          label: "Variables",
+          key: "variables",
+          valueType: "json",
+        },
+        {
+          type: "keyValueInput",
+          label: "Headers",
+          key: "headers",
+          valueType: "string",
+        },
+      ],
+    },
+  ],
+} as const;

server/node-service/src/plugins/graphql/run.ts

@@ -0,0 +1,20 @@
+import { badRequest } from "../../common/error";
+import { request, Variables, ClientError } from "graphql-request";
+
+export async function runGraphQL(
+  endpoint: string,
+  query: string,
+  variables: Variables,
+  headers: Record<string, string>
+) {
+  try {
+    const ret = await request(endpoint, query, variables, headers);
+    return ret;
+  } catch (e) {
+    console.info(e);
+    if (e instanceof ClientError) {
+      throw badRequest(e.message);
+    }
+    throw e;
+  }
+}

server/node-service/src/plugins/index.ts

@@ -27,6 +27,7 @@ import cloudinaryPlugin from "./cloudinary";
 import notionPlugin from "./notion";
 import datadogPlugin from "./datadog";
 import twilioPlugin from "./twilio";
+import gitlabPlugin from "./gitlab";
 
 let plugins: (DataSourcePlugin | DataSourcePluginFactory)[] = [
   s3Plugin,
@@ -58,6 +59,7 @@ let plugins: (DataSourcePlugin | DataSourcePluginFactory)[] = [
   notionPlugin,
   datadogPlugin,
   twilioPlugin,
+  gitlabPlugin,
 ];
 
 try {

server/node-service/src/services/plugin.ts

@@ -92,7 +92,8 @@ export async function evalToValue<T extends Config>(
     config.type === "textInput" ||
     config.type === "select" ||
     config.type === "password" ||
-    config.type === "sqlInput"
+    config.type === "sqlInput" ||
+    config.type === "graphqlInput"
   ) {
     return toString(evalCodeToValue(dsl, context));
   }
@@ -109,6 +110,18 @@ export async function evalToValue<T extends Config>(
     return evalCodeToValue(dsl, context, true);
   }
 
+  if (config.type === "keyValueInput") {
+    if (!Array.isArray(dsl)) {
+      return [];
+    }
+    return dsl.map(({ key, value }) => {
+      return {
+        key: evalCodeToValue(key, context),
+        value: evalCodeToValue(value, context, config.valueType === "json"),
+      };
+    });
+  }
+
   throw new ServiceError(`invalid plugin definition, unknown config type: ${(config as any).type}`);
 }
 

server/node-service/yarn.lock

@@ -4051,6 +4051,15 @@ __metadata:
   languageName: node
   linkType: hard
 
+"@graphql-typed-document-node/core@npm:^3.1.1":
+  version: 3.1.2
+  resolution: "@graphql-typed-document-node/core@npm:3.1.2"
+  peerDependencies:
+    graphql: ^0.8.0 || ^0.9.0 || ^0.10.0 || ^0.11.0 || ^0.12.0 || ^0.13.0 || ^14.0.0 || ^15.0.0 || ^16.0.0 || ^17.0.0
+  checksum: a61afa025acdabd7833e4f654a5802fc1a526171f81e0c435c8e651050a5a0682499a2c7a51304ceb61fde36cd69fc7975ce5e1b16b9ba7ea474c649f33eea8b
+  languageName: node
+  linkType: hard
+
 "@grpc/grpc-js@npm:~1.8.0":
   version: 1.8.8
   resolution: "@grpc/grpc-js@npm:1.8.8::__archiveUrl=https%3A%2F%2Fregistry.npmjs.org%2F%40grpc%2Fgrpc-js%2F-%2Fgrpc-js-1.8.8.tgz"
@@ -6397,6 +6406,13 @@ __metadata:
   languageName: node
   linkType: hard
 
+"extract-files@npm:^9.0.0":
+  version: 9.0.0
+  resolution: "extract-files@npm:9.0.0"
+  checksum: c31781d090f8d8f62cc541f1023b39ea863f24bd6fb3d4011922d71cbded70cef8191f2b70b43ec6cb5c5907cdad1dc5e9f29f78228936c10adc239091d8ab64
+  languageName: node
+  linkType: hard
+
 "fast-deep-equal@npm:^3.1.1":
   version: 3.1.3
   resolution: "fast-deep-equal@npm:3.1.3::__archiveUrl=https%3A%2F%2Fregistry.npmjs.org%2Ffast-deep-equal%2F-%2Ffast-deep-equal-3.1.3.tgz"
@@ -6542,6 +6558,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"form-data@npm:^3.0.0":
+  version: 3.0.1
+  resolution: "form-data@npm:3.0.1"
+  dependencies:
+    asynckit: ^0.4.0
+    combined-stream: ^1.0.8
+    mime-types: ^2.1.12
+  checksum: b019e8d35c8afc14a2bd8a7a92fa4f525a4726b6d5a9740e8d2623c30e308fbb58dc8469f90415a856698933c8479b01646a9dff33c87cc4e76d72aedbbf860d
+  languageName: node
+  linkType: hard
+
 "form-data@npm:^4.0.0":
   version: 4.0.0
   resolution: "form-data@npm:4.0.0::__archiveUrl=https%3A%2F%2Fregistry.npmjs.org%2Fform-data%2F-%2Fform-data-4.0.0.tgz"
@@ -6834,6 +6861,27 @@ __metadata:
   languageName: node
   linkType: hard
 
+"graphql-request@npm:^5.1.0":
+  version: 5.1.0
+  resolution: "graphql-request@npm:5.1.0"
+  dependencies:
+    "@graphql-typed-document-node/core": ^3.1.1
+    cross-fetch: ^3.1.5
+    extract-files: ^9.0.0
+    form-data: ^3.0.0
+  peerDependencies:
+    graphql: 14 - 16
+  checksum: 8b65d5c1b0cad8996a843b52305b2712ffbf842c700487d4cee1ed719f22baacaacfddafb65572bcddd67d57fd1d2d389dee2430ffba4b34c3ab542d079446c7
+  languageName: node
+  linkType: hard
+
+"graphql@npm:^16.6.0":
+  version: 16.6.0
+  resolution: "graphql@npm:16.6.0"
+  checksum: bf1d9e3c1938ce3c1a81e909bd3ead1ae4707c577f91cff1ca2eca474bfbc7873d5d7b942e1e9777ff5a8304421dba57a4b76d7a29eb19de8711cb70e3c2415e
+  languageName: node
+  linkType: hard
+
 "gtoken@npm:^6.1.0":
   version: 6.1.2
   resolution: "gtoken@npm:6.1.2::__archiveUrl=https%3A%2F%2Fregistry.npmjs.org%2Fgtoken%2F-%2Fgtoken-6.1.2.tgz"
@@ -8719,13 +8767,13 @@ __metadata:
   languageName: node
   linkType: hard
 
-"openblocks-sdk@npm:^0.0.35":
-  version: 0.0.35
-  resolution: "openblocks-sdk@npm:0.0.35"
+"openblocks-sdk@npm:0.0.38":
+  version: 0.0.38
+  resolution: "openblocks-sdk@npm:0.0.38"
   peerDependencies:
     react: ">=17"
     react-dom: ">=17"
-  checksum: 1e91bc8153d2db85fbf5ec870a678948a6bc2a719aca01a6d1ae5ef758c5ef01a943719db12639b181dc51144a43fcc3edd9ffae4ed712a6a18b5f6f6e784529
+  checksum: 11bc829871c8037378f35e37d97ca8702a7adbd0c228ea9125befb8a63c8cf883cd9a8ce1818dc70a4865186118da313ae5b7660cd038a6fd0e9dab669e871a9
   languageName: node
   linkType: hard
 
@@ -9812,6 +9860,8 @@ __metadata:
     express-async-errors: ^3.1.1
     firebase-admin: ^11.5.0
     formdata-node: 4
+    graphql: ^16.6.0
+    graphql-request: ^5.1.0
     jest: ^29.3.1
     jsonpath: ^1.1.1
     lodash: ^4.17.21
@@ -9821,7 +9871,7 @@ __metadata:
     nodemon: ^2.0.20
     openapi-types: ^12.1.0
     openblocks-core: ^0.0.7
-    openblocks-sdk: ^0.0.35
+    openblocks-sdk: 0.0.38
     pino: ^8.11.0
     postman-to-openapi: ^3.0.1
     stylis: ^4.1.3