@common-stack/generate-plugin 7.0.3-alpha.2 → 7.0.4-alpha.1

package/src/generators/add-backend/files/README.md

@@ -0,0 +1,133 @@
+# webpack-apollo-server
+Starter kit for apollo server using webpack and typescript
+
+What does it include:
+----
+    1. exported schema as example for GraphQL Schema
+    2. Working Apollo Server (webpack + tslint + tsloader)
+    3. Typescript 2.0.0 => ES6
+    4. Dockerfile to make the apollo-server a container.
+    5. unit testing (mocha-webpack+chai) + coverage report (mocha-istanbul-spec+istanbul).
+    6. working with graphql-tools
+    7. standard-version for auto SemVer.
+
+Notes
+----
+Please note that you will need to rename the library name in some files:
+
+    1. package.json (ofcourse ;))
+
+Useful commands:
+----
+    yarn build       - build the library files (Required for start:watch)
+    yarn build:watch - build the library files in watchmode (Useful for development)
+    npm test            - run tests once
+    yarn test:watch  - run tests in watchmode (Useful for development)
+    yarn test:growl  - run tests in watchmode with growl notification (even more useful for development)
+
+How to run it:
+----
+```bash
+    npm start
+```
+
+Files explained:
+----
+    1. src                         - directory is used for typescript code that is part of the project
+        1a. main.ts                - Main server file. (Starting Apollo server)
+        1b. main.spec.ts           - Tests file for main
+        1c. schema                 - Module used to build schema
+            - index.ts             - simple logic to merge all modules into a schema using graphql-tools
+            - modules/             - directory for modules to be used with graphql-tools
+        1c. schema.spec.ts         - Basic test for schema.
+        1c. main.test.ts           - Main for tests runner.
+    3. package.json                - file is used to describe the library
+    4. tsconfig.json               - configuration file for the library compilation
+    6. tslint.json                 - configuration file for the linter
+    7. typings.json                - typings needed for the server
+    8. webpack.config.js           - configuration file of the compilation automation process for the library
+    9. webpack.config.test.js      - configuration file of the compilation when testing
+    10. Dockerfile                 - Dockerfile used to describe how to make a container out of apollo server
+    11. mocha-webpack.opts         - Options file for mocha-webpack
+
+Output files explained:
+----
+    1. node_modules - directory npm creates with all the dependencies of the module (result of yarn install)
+    2. dist         - directory contains the compiled server (javascript)
+    3. html-report  - output of npm test, code coverage html report.
+
+
+Database
+----
+Connects to memory database through Knex
+
+Database configuration is set in `db-config.json`
+
+Setup
+----
+Create a database and fill the data
+```
+yarn db:seed         
+```
+What files to be customized? 
+----
+Customizable files for a specific project would be the following
+```
+src/container
+src/middleware/graphql.ts
+```
+
+The Person type - dynamic/parametrized query and drill down:
+----
+The person type was added to demonstrate a database like access, parametrized queries, resolvers and drill down.
+The data is currently hard coded but simulates a storage. Each person has an id, name and sex. It also has a dynamic
+field called matches. For demonstration purposes, this field will retrieve all members of the other sex by using a
+resolver.
+
+Since this is a computed field the query can be infinitely nested, for example, try in the graphiql editor this query:
+
+    {
+       getPerson(id: "1") {
+         id,
+         name
+         sex
+         matches {
+           id
+           name
+           sex
+           matches {
+             id
+             name
+             sex
+             matches {
+               id
+               name
+               sex
+             }
+           }
+         }
+       }
+     }
+
+It will return a nested, alternating male/femal results.
+
+To list all persons, use the `persons` query:
+
+    {
+      persons {
+        id
+        name
+      }
+    }
+
+There is also an example of a mutation - `addPerson(name: String, sex: String)`, to use it:
+
+    mutation {
+        addPerson(name: "kuku", sex: "male"){
+            id
+            name
+        }
+    }
+
+Note that the query generates a random id and that the added persons are transient,
+i.e. not persisted and will be gone once you shut down the server.

package/src/generators/add-backend/files/__tests__/test.ts.template

@@ -0,0 +1,96 @@
+import { createServer } from "http";
+import express from "express";
+import { gql } from 'graphql';
+import { ApolloServer } from '@apollo/server';
+import { ApolloServerPluginDrainHttpServer, } from '@apollo/server/plugin/drainHttpServer';
+import { PubSub } from "graphql-subscriptions";
+import { makeExecutableSchema } from "@graphql-tools/schema";
+import { WebSocketServer } from "ws";
+import { useServer } from "graphql-ws/lib/use/ws";
+
+const PORT = 8080;
+const pubsub = new PubSub();
+
+// Schema definition
+const typeDefs = gql`
+  type Query {
+    currentNumber: Int
+  }
+
+  type Subscription {
+    numberIncremented: Int
+  }
+`;
+
+// Resolver map
+const resolvers = {
+  Query: {
+    currentNumber() {
+      return currentNumber;
+    },
+  },
+  Subscription: {
+    numberIncremented: {
+      subscribe: () => pubsub.asyncIterator(["NUMBER_INCREMENTED"]),
+    },
+  },
+};
+
+// Create schema, which will be used separately by ApolloServer and
+// the WebSocket server.
+const schema = makeExecutableSchema({ typeDefs, resolvers });
+console.log('--schema--', schema)
+// Create an Express app and HTTP server; we will attach the WebSocket
+// server and the ApolloServer to this HTTP server.
+const app = express();
+const httpServer = createServer(app);
+
+// Set up WebSocket server.
+const wsServer = new WebSocketServer({
+  server: httpServer,
+  path: "/graphql",
+});
+const serverCleanup = useServer({ schema }, wsServer);
+
+// Set up ApolloServer.
+const server = new ApolloServer({
+  schema,
+  plugins: [
+    // Proper shutdown for the HTTP server.
+    ApolloServerPluginDrainHttpServer({ httpServer }),
+
+    // Proper shutdown for the WebSocket server.
+    {
+      async serverWillStart() {
+        return {
+          async drainServer() {
+            await serverCleanup.dispose();
+          },
+        };
+      },
+    },
+  ],
+});
+await server.start();
+server.applyMiddleware({ app });
+
+// Now that our HTTP server is fully set up, actually listen.
+httpServer.listen(PORT, () => {
+  console.log(
+    `🚀 Query endpoint ready at http://localhost:${PORT}${server.graphqlPath}`
+  );
+  console.log(
+    `🚀 Subscription endpoint ready at ws://localhost:${PORT}${server.graphqlPath}`
+  );
+});
+
+// In the background, increment a number every second and notify subscribers when
+// it changes.
+let currentNumber = 0;
+function incrementNumber() {
+  currentNumber++;
+  pubsub.publish("NUMBER_INCREMENTED", { numberIncremented: currentNumber });
+  setTimeout(incrementNumber, 10000);
+}
+// Start incrementing
+incrementNumber();

package/src/generators/add-backend/files/_dockerignore

@@ -0,0 +1,9 @@
+*
+!dist/
+!*.js
+!.zenrc.json
+!package.json
+!knexfile.ts
+!.npmrc
+!.yarnrc
+!common/

package/src/generators/add-backend/files/_gitignore

@@ -0,0 +1,13 @@
+node_modules/
+coverage/
+dist/
+lib/
+.tmp/
+*.d.ts
+*.log
+*.tgz
+*.yaml
+yarn.lock
+.idea/
+./uploads/
+common/

package/src/generators/add-backend/files/_npmignore

@@ -0,0 +1,2 @@
+*
+!lib/**

package/src/generators/add-backend/files/_yarnrc

@@ -0,0 +1 @@
+registry "https://registry.npmjs.org/"

package/src/generators/add-backend/files/babel.config.js

@@ -0,0 +1,45 @@
+process.env.ENV_FILE !== null && require('dotenv').config({ path: process.env.ENV_FILE });
+
+module.exports = (api) => {
+    const isBabelRegister = api.caller((caller) => caller && caller.name === '@babel/register');
+    const isTest = api.env('test');
+    api.cache(true);
+    if (isTest || isBabelRegister) {
+        return {
+            presets: [
+                '@babel/preset-typescript',
+                '@babel/preset-react',
+                ['@babel/preset-env', { targets: { node: true }, modules: 'commonjs' }],
+            ],
+            plugins: [
+                'babel-plugin-dynamic-import-node',
+                '@babel/plugin-proposal-class-properties',
+                '@babel/plugin-proposal-optional-chaining',
+                'babel-plugin-import-graphql',
+            ],
+        };
+    }
+    return {
+        compact: false,
+        presets: [
+            '@babel/preset-typescript',
+            '@babel/preset-react',
+            ['@babel/preset-env', { targets: { node: true }, modules: false }],
+        ],
+        plugins: [
+            'babel-plugin-dynamic-import-node',
+            '@loadable/babel-plugin',
+            '@babel/plugin-transform-destructuring',
+            '@babel/plugin-transform-runtime',
+            ['@babel/plugin-proposal-decorators', { legacy: true }],
+            '@babel/plugin-proposal-class-properties',
+            '@babel/plugin-proposal-object-rest-spread',
+            '@babel/plugin-proposal-optional-chaining',
+        ],
+        env: {
+            production: {
+                compact: true,
+            },
+        },
+    };
+};

package/src/generators/add-backend/files/build.config.js

@@ -0,0 +1,14 @@
+process.env.ENV_FILE !== null && require('dotenv').config({ path: process.env.ENV_FILE });
+const config = {
+    ...require('../../build.config'),
+    __CLIENT__: false,
+    __SERVER__: true,
+    __DEV__: process.env.NODE_ENV !== 'production',
+    __TEST__: false,
+    'process.env.NODE_ENV': process.env.NODE_ENV || 'development',
+    __GRAPHQL_URL__: process.env.GRAPHQL_URL || '/graphql',
+    __CDN_URL__: process.env.CDN_URL || '',
+    __FRONTEND_BUILD_DIR__: process.env.FRONTEND_BUILD_DIR || '../frontend-server/dist/web',
+};
+
+module.exports = config;

package/src/generators/add-backend/files/build.config.mjs

@@ -0,0 +1,27 @@
+if (process.env.ENV_FILE !== null) {
+    import('dotenv').then(({ config }) => 
+        config({ path: process.env.ENV_FILE })
+    );
+}
+
+const __API_SERVER_PORT__ = process.env.GRAPHQL_URL ? new URL(process.env.GRAPHQL_URL).port : 8080;
+const __SERVER_PROTOCOL__ = 'http';
+const __LOCAL_SERVER_HOST__ = 'localhost';
+const __GRAPHQL_ENDPOINT__ = process.env.GRAPHQL_URL ? new URL(process.env.GRAPHQL_URL).pathname : '/graphql';
+
+const config = {
+    __CLIENT__: false,
+    __SERVER__: true,
+    __DEV__: process.env.NODE_ENV !== 'production',
+    __TEST__: false,
+    'process.env.NODE_ENV': process.env.NODE_ENV || 'development',
+    __GRAPHQL_URL__: process.env.GRAPHQL_URL || '/graphql',
+    __CDN_URL__: process.env.CDN_URL || '',
+    __FRONTEND_BUILD_DIR__: process.env.FRONTEND_BUILD_DIR || '../frontend-server/dist/web',
+    __API_SERVER_PORT__,
+    __GRAPHQL_ENDPOINT__,
+    __LOCAL_SERVER_HOST__,
+    __API_URL__: process.env.API_URL || `${__SERVER_PROTOCOL__}://${__LOCAL_SERVER_HOST__}:${__API_SERVER_PORT__}${__GRAPHQL_ENDPOINT__}`,
+};
+
+export default config;

package/src/generators/add-backend/files/config.json

@@ -0,0 +1,10 @@
+{
+  "modules": [
+  ],
+  "devModules": [
+    "@container-stack/mailing-api-server"
+  ],
+  "externalModules": [
+    "@container-stack/territory"
+  ]
+}

package/src/generators/add-backend/files/jest.config.js

@@ -0,0 +1,27 @@
+module.exports = {
+    testMatch: [
+        '<rootDir>/modules/**/server-ts/**/*.test.[jt]s?(x)',
+        '<rootDir>/modules/**/common-react/**/*.test.[jt]s?(x)',
+    ],
+    globalSetup: '<rootDir>/packages/server/src/__tests__/jestSetup.js',
+    rootDir: '../..',
+    resolver: './packages/server/jest.resolver',
+    transform: {
+        '\\.(gql|graphql)$': 'jest-transform-graphql',
+        'locales[\\/]index.[jt]s': '<rootDir>/jest-transform-i18next',
+        '.*': 'babel-jest',
+    },
+    moduleNameMapper: {
+        '^.+\\.(css|less|scss)$': 'babel-jest',
+    },
+    globals: {
+        __CLIENT__: false,
+        __SERVER__: true,
+        __DEV__: true,
+        __TEST__: true,
+        __SSR__: false,
+        __FRONTEND_BUILD_DIR__: `${__dirname}/../client/build`,
+        __API_URL__: '/graphql',
+    },
+    testEnvironment: 'node',
+};

package/src/generators/add-backend/files/package.json

@@ -0,0 +1,82 @@
+{
+    "name": "sample-stack-backend-server",
+    "version": "0.0.1",
+    "private": true,
+    "description": "Starter kit for apollo server using webpack and typescript",
+    "keywords": [
+        "apollo",
+        "apollo-server",
+        "backend",
+        "express",
+        "graphiql",
+        "graphql",
+        "typescript",
+        "webpack"
+    ],
+    "homepage": "https://github.com/cdmbase/fullstack-pro#readme",
+    "bugs": {
+        "url": "https://github.com/cdmbase/fullstack-pro/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "git+https://github.com/cdmbase/fullstack-pro.git"
+    },
+    "license": "MIT",
+    "author": "CDMBase LLC",
+    "main": "dist/index.js",
+    "typings": "dist/main.d.ts",
+    "scripts": {
+        "build": "cross-env NODE_ENV=production webpack --config webpack.config.js",
+        "build:clean": "rimraf dist .awcache",
+        "build:dev": "cross-env NODE_ENV=development ENV_FILE=../../config/development/dev.env webpack --config webpack.config.js",
+        "copycommon": "cp -r ../../packages/common .",
+        "db:migrate": "knex -- migrate:latest --cwd . --knexfile ./knexfile.js",
+        "db:migrate:rollback": "knex -- migrate:rollback  --cwd . --knexfile ./knexfile.js",
+        "db:seed": "yarn db:migrate && knex -- seed:run  --cwd . --knexfile ./knexfile.js",
+        "docker:build": "yarn copycommon && yarn build && docker build . -t $npm_package_name:$npm_package_version",
+        "docker:build:debug": "yarn build:debug && docker build . -t $npm_package_name:$npm_package_version",
+        "docker:run": "docker run  --env-file ../../config/staging/docker-staging.env -p 8080:8080 -it $npm_package_name:$npm_package_version",
+        "docker:run:debug": "cross-env NODE_ENV=development docker run  --env-file ../../config/staging/docker-staging.env -p 8080:8080 -it $npm_package_name:$npm_package_version",
+        "proddb:migrate": "NODE_ENV=production yarn db:migrate",
+        "proddb:migrate:rollback": "NODE_ENV=production yarn db:migrate:rollback",
+        "proddb:seed": "NODE_ENV=production yarn db:seed",
+        "prepublish": "yarn build:clean",
+        "stagedb:migrate": "cross-env ENV_FILE=../../config/test/test.env NODE_ENV=test yarn db:migrate",
+        "stagedb:migrate:rollback": "cross-env ENV_FILE=../../config/test/test.env NODE_ENV=test yarn db:migrate:rollback",
+        "stagedb:seed": "cross-env ENV_FILE=../../config/test/test.env NODE_ENV=test yarn db:seed",
+        "start": "cross-env NODE_ENV=production tsx dist/index.js",
+        "start:dev": "cross-env NODE_ENV=development ENV_FILE=../../config/development/dev.env tsx watch dist/index.js",
+        "start:staging": "cross-env NODE_ENV=staging ENV_FILE=../../config/staging/staging.env tsx dist/index.js",
+        "start:test": "cross-env NODE_ENV=test ENV_FILE=../../config/test/test.env tsx dist/index.js",
+        "test": "jest",
+        "test:notify": "yarn test:watch -- --notify",
+        "test:watch": "npm test -- --watch",
+        "preupver": "npm test",
+        "upver": "standard-version",
+        "watch": "cross-env NODE_ENV=development ENV_FILE=../../config/development/dev.env yarn build:dev && yarn start:dev",
+        "watch:staging": "cross-env NODE_ENV=test ENV_FILE=../../config/staging/staging.env yarn build && yarn start:stage",
+        "watch:test": "cross-env NODE_ENV=test ENV_FILE=../../config/test/test.env yarn build:test && yarn start:test"
+    },
+    "resolutions": {
+        "common": "link:./common",
+        "html-to-text": "^8.0.0"
+    },
+    "dependencies": {
+        "@apollo/client": "^3.9.0",
+        "@babel/runtime": "^7.20.1",
+        "@common-stack/server-stack": "7.0.4-alpha.0",
+        "@remix-run/node": "~2.10.1",
+        "lodash": "^4.17.15",
+        "react": "18.2.0"
+    },
+    "devDependencies": {
+        "cross-env": "^7.0.3",
+        "esbuild-loader": "^4.2.2",
+        "pm2": "^5.2.2",
+        "rimraf": "^3.0.2",
+        "tsx": "^4.7.0"
+    },
+    "typescript": {
+        "definition": "dist/main.d.ts"
+    }
+}

package/src/generators/add-backend/files/src/api/root-schema.graphqls

@@ -0,0 +1,109 @@
+scalar AnyObject
+scalar Date
+scalar Time
+scalar DateTime
+scalar Timestamp
+scalar URI
+scalar URIInput
+scalar Observable
+
+scalar JSON
+scalar JSONObject
+
+"""
+ An object with an ID.
+"""
+interface Node {
+    """
+    The ID of the node.
+    """
+    id: ID!
+}
+
+# Pagination information. See https://facebook.github.io/relay/graphql/connections.htm#sec-undefined.PageInfo.
+type PageInfo {
+    # Whether there is a next page of nodes in the connection.
+    hasNextPage: Boolean!
+}
+
+"""
+ Represents a null return value.
+"""
+type EmptyResponse {
+    # A dummy null value.
+    alwaysNil: String
+}
+
+type FieldError {
+  field: String!
+  message: String!
+}
+
+input Sort{
+    key: String!,
+    value: SortEnum!,
+}
+
+enum SortEnum{
+    ASC,
+    DESC
+}
+
+type Query {
+    """
+     Looks up a node by ID.
+    """
+    node(id: ID!): Node
+}
+
+type Mutation {
+    dummy: Int
+}
+
+type Subscription {
+    dummy: Int
+}
+
+type AdminIdeSettings {
+    dummy: Int
+}
+
+""" All Moleculer Topic names are extended from this."""
+enum MoleculerServiceName {
+    dummy
+}
+
+interface IResourceUtilizationSettings {
+    subTopic: String
+    adminApiNamespace: String
+}
+
+"""
+ Input geometry of the location.
+ List the `longitude` first and then `latitude`
+  - Validate longitude values are between `-180` and `180`
+  - Validate latitude values are between `-90` and `90`
+"""
+input GeoLocation_Input {
+    type: String  = "Point"
+    coordinates: [Float]
+}
+
+type GeoLocation {
+    coordinates: [Float]
+}
+
+enum MailTemplateId {
+    dummy
+}
+
+enum MoleculerCronServiceName {
+    dummy
+}
+
+schema {
+    query: Query
+    mutation: Mutation
+    subscription: Subscription
+}
+

package/src/generators/add-backend/files/src/config/env-config.ts.template

@@ -0,0 +1,12 @@
+/// <reference path='../../../../typings/index.d.ts' />
+import { str, cleanEnv } from 'envalid';
+
+export const config = cleanEnv(process.env, {
+    NODE_ENV: str({ default: 'production', choices: ['production', 'staging', 'development', 'test'] }),
+    CONNECTION_ID: str({ devDefault: 'CONNECTION_ID' }),
+    NAMESPACE: str({ default: 'default' }),
+    ACTIVITY_NAMESPACE: str({ devDefault: 'default' }),
+    API_NAMESPACE: str({ devDefault: 'default' }),
+    ADMIN_API_NAMESPACE: str({ devDefault: 'default' }),
+    BACKEND_URL: str({ devDefault: __BACKEND_URL__ }),
+});

package/src/generators/add-backend/files/src/config/index.ts.template

@@ -0,0 +1 @@
+export * from './env-config';

package/src/generators/add-backend/files/src/env.ts.template

@@ -0,0 +1,5 @@
+/* eslint-disable jest/require-hook */
+import * as dotenv from 'dotenv';
+if (process.env.ENV_FILE) {
+    dotenv.config({ path: process.env.ENV_FILE });
+}

package/src/generators/add-backend/files/src/index.ts.template

@@ -0,0 +1,56 @@
+/// <reference types="webpack-env" />
+import './env';
+import 'reflect-metadata';
+import { logger } from '@cdm-logger/server';
+import { Service } from './service';
+
+declare let module: __WebpackModuleApi.Module;
+
+process.on('uncaughtException', (ex) => {
+    logger.error(ex);
+    process.exit(1);
+});
+
+process.on('unhandledRejection', (reason) => {
+    logger.error(reason);
+});
+const service = new Service();
+
+async function start() {
+    try {
+        await service.initialize();
+        await service.start();
+    } catch(err) {
+        console.error('START FAILED', err)
+    }
+
+}
+// if (module.hot) {
+//     module.hot.status((event) => {
+//         if (event === 'abort' || event === 'fail') {
+//             logger.error(`HMR error status: ${event}`);
+//             // Signal webpack.run.js to do full-reload of the back-end
+//             service.gracefulShutdown(event);
+//         }
+//         // adddintionally when event is idle due to external modules
+//         if (event === 'idle') {
+//             service.gracefulShutdown(event);
+//         }
+//     });
+//     module.hot.accept();
+// }
+if (module.hot) {
+    module.hot.dispose((data) => {
+        // Shutdown server if changes to this module code are made
+        // So that it was started afresh
+        console.log('--data---', data);
+        try {
+            // if (service) {
+            //     service.gracefulShutdown(null);
+            // }
+        } catch (error) {
+            logger.error(error.stack);
+        }
+    });
+}
+start();

package/src/generators/add-backend/files/src/modules/index.ts.template

@@ -0,0 +1,17 @@
+import modules, { settings } from './module';
+
+export default modules;
+export { settings };
+
+// export const updateContainers = (options) => {
+//     if (process.env.NODE_ENV !== 'development') {
+//         options.forEach(el => {
+//             hemera.act({
+//                 topic: `UPDATE_CONTAINER_${el.toUpperCase()}`,
+//                 cmd: `UPDATE_CONTAINER_${el.toUpperCase()}`,
+//             });
+//         });'
+//     } else {
+//         modules.createServiceContext(settings, options);
+//     }
+// };