Add an example for OpenWhisk

Author: ardatan

examples/openwhisk-example/.gitignore

@@ -0,0 +1,3 @@
+.mesh
+node_modules
+dist

examples/openwhisk-example/.meshrc.yml

@@ -0,0 +1,8 @@
+sources:
+  - name: SWAPI
+    handler:
+      graphql:
+        endpoint: https://swapi-graphql.netlify.app/.netlify/functions/index
+
+serve:
+  endpoint: /api/v1/web/guest/mesh/swapi/graphql

examples/openwhisk-example/README.md

@@ -0,0 +1,37 @@
+# An Example Project for OpenWhisk
+
+## Files
+
+- `src/index.ts` is the handler function for the OpenWhisk action that uses GraphQL Mesh's platform agnostic HTTP Handler
+- `.meshrc.yml` is the configuration file for GraphQL Mesh
+- `package.json` is the package.json file that contains all the dependencies and scripts
+- `build.js` is the code file that runs `ESBuild` to create a bundle for OpenWhisk deployment
+
+## Configuring the project
+
+GraphQL Mesh needs to be aware of the path of the OpenWhisk action endpoint.
+So you need to configure `serve.endpoint` in `.meshrc.yml`;
+
+```yaml
+serve:
+  # This is the full path to your endpoint
+  # In the following endpoint, we assume you have created a package with `wsk package create mesh`
+  endpoint: /api/v1/web/guest/mesh/swapi/graphql
+```
+
+You also need to update the paths inside `index.ts` and `package.json` to match your OpenWhisk action name.
+
+## Building the project for deployment
+
+You can see an example script to bundle the project with `ESBuild` in `build.js`.
+`yarn build` will build the artifacts of GraphQL Mesh first then bundle all the code needed for the OpenWhisk action by taking `index.ts` as an endpoint.
+
+You can find the bundle in `dist/index.js` and deploy it either `yarn deploy` or manually with `wsk` like `wsk action update /guest/mesh/swapi --kind nodejs:16 dist/index.js`.
+
+## Running the project locally
+
+`start` command will start Mesh server to mimic your API endpoint locally without deployment;
+
+```bash
+yarn start
+```

examples/openwhisk-example/build.js

@@ -0,0 +1,14 @@
+const { build } = require('esbuild');
+
+build({
+  entryPoints: ['./src/index.ts'],
+  outfile: 'dist/index.js',
+  format: 'cjs',
+  minify: false,
+  bundle: true,
+  platform: 'node',
+  target: 'node16',
+}).catch(e => {
+  console.error(e);
+  process.exit(1);
+});

examples/openwhisk-example/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "openwhisk-example",
+  "version": "0.0.0",
+  "description": "OpenWhisk Example for GraphQL Mesh",
+  "author": "Arda TANRIKULU <[email protected]>",
+  "license": "MIT",
+  "main": "dist/index.js",
+  "scripts": {
+    "start": "mesh dev",
+    "build": "mesh build && node build.js",
+    "deploy": "wsk action update /guest/mesh/swapi dist/index.js  --docker openwhisk/action-nodejs-v16 --web raw"
+  },
+  "dependencies": {
+    "esbuild": "0.15.10",
+    "graphql": "16.6.0",
+    "@graphql-mesh/cli": "0.78.29",
+    "@graphql-mesh/graphql": "0.31.21",
+    "typescript": "4.8.4"
+  }
+}

examples/openwhisk-example/src/index.ts

@@ -0,0 +1,25 @@
+import { createBuiltMeshHTTPHandler } from '../.mesh';
+
+const httpHandler = createBuiltMeshHTTPHandler();
+
+export const main = async function (params) {
+  const response = await httpHandler.fetch(`http://localhost/api/v1/web/guest/mesh/swapi${params.__ow_path}`, {
+    method: params.__ow_method,
+    headers: params.__ow_headers,
+    body: params.__ow_body ? Buffer.from(params.__ow_body, 'base64') : undefined,
+  });
+
+  const headers = {};
+
+  response.headers.forEach((value, key) => {
+    headers[key] = value;
+  });
+
+  const body = await (headers['content-type'].includes('json') ? response.json() : response.text());
+
+  return {
+    statusCode: response.status,
+    body,
+    headers,
+  };
+};

examples/openwhisk-example/tsconfig.json

@@ -0,0 +1,14 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "target": "esnext",
+    "module": "commonjs",
+    "moduleResolution": "node" /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */,
+    "lib": ["esnext"],
+    "esModuleInterop": true,
+    "allowSyntheticDefaultImports": true,
+    "skipLibCheck": true
+  },
+  "files": ["src/index.ts"],
+  "exclude": ["node_modules"]
+}

website/src/pages/docs/getting-started/deploy-mesh-gateway.mdx

@@ -104,6 +104,11 @@ You can see the following examples for more details:
 
 Also you can see how to setup *KV* as a cache storage in GraphQL Mesh [here](/docs/cache/cfwKv).
 
+### Deploy Mesh on Apache OpenWhisk
+
+You can see our example that shows how to setup an OpenWhisk action for GraphQL Mesh.
+[OpenWhisk Example](https://github.com/Urigo/graphql-mesh/tree/master/examples/openwhisk-example)
+
 ## Deploy on Node.js
 
 ### Mesh as an Express route