feat(plugin-js-microlib): consistent read

Author: ohoareau

packages/plugin-js-lambda-microlib/src/MicroserviceType.ts

@@ -478,6 +478,7 @@ export default class MicroserviceType {
         const conditionCode = this.buildConditionCode(condition, conditionNot, requirements);
         let call: string|undefined = undefined;
         if ('@get' === type) return `    ${conditionCode || ''}Object.assign(query, await service.get(query.id, ${this.stringifyForHook(config['fields'] || [], options)}));`;
+        if ('@get-consistent' === type) return `    ${conditionCode || ''}Object.assign(query, await service.getConsistent(query.id, ${this.stringifyForHook(config['fields'] || [], options)}));`;
         const rawOpts = !!Object.keys(opts).length ? `, ${this.stringifyForHook(opts, options)}` : '';
         if ('@lambda/event' === type) {
             requirements['lambdaEvent'] = true;
@@ -776,4 +777,4 @@ export default class MicroserviceType {
         });
         return x ? authorizations[x] : undefined;
     }
-}
+}

packages/plugin-js-lambda-microlib/src/MicroserviceTypeOperation.ts

@@ -98,6 +98,12 @@ export default class MicroserviceTypeOperation {
                 this.hasHooks('dynamics', opType, microserviceType, name) && microserviceType.registerHook(name, 'postpopulate', {type: '@dynamics', config: {}});
                 this.hasHooks('requires', opType, microserviceType, name) && microserviceType.registerHook(name, 'init', {type: '@requires', config: {}});
                 break;
+            case 'getConsistent':
+                this.hasHooks('convert', opType, microserviceType, name) && microserviceType.registerHook(name, 'convert', {type: '@convert', config: {}});
+                this.hasHooks('prefetch-read', opType, microserviceType, name) && microserviceType.registerHook(name, 'init', {type: '@prefetch', config: {mode: 'requires-only'}});
+                this.hasHooks('dynamics', opType, microserviceType, name) && microserviceType.registerHook(name, 'postpopulate', {type: '@dynamics', config: {}});
+                this.hasHooks('requires', opType, microserviceType, name) && microserviceType.registerHook(name, 'init', {type: '@requires', config: {}});
+                break;
             case 'find':
                 this.hasHooks('convert', opType, microserviceType, name) && microserviceType.registerHook(name, 'convert', {type: '@convert', config: {mode: 'page'}});
                 this.hasHooks('dynamics', opType, microserviceType, name) && microserviceType.registerHook(name, 'postpopulate', {type: '@dynamics', config: {mode: 'page'}});
@@ -179,4 +185,4 @@ export default class MicroserviceTypeOperation {
     async generate(vars: any = {}): Promise<{[key: string]: Function}> {
         return this.handler ? this.handler.generate(vars) : Promise.resolve({});
     }
-}
+}

packages/plugin-js-lambda-microlib/src/SchemaGraphqlModel.ts

@@ -229,6 +229,14 @@ export class SchemaGraphqlModel {
                 ],
                 gqlType: op.gqlType,
             }; break;
+            case 'getConsistent': x = {
+                name,
+                type: 'getConsistent',
+                args: [
+                    {name: 'id', gqlType: 'ID', required: true}
+                ],
+                gqlType: op.gqlType,
+            }; break;
             default:
                 let z: any = {};
                 if (others[name]) z = this.parseHandlerValue(others[name], {parentType: {name: 'Query'}, parentField: name, handler: name});
@@ -414,6 +422,11 @@ export class SchemaGraphqlModel {
                 return {operationNature, operationType: pageType, operationGqlType: pageType, operationArgs: [
                         {name: cfg?.vars?.default || cfg?.vars?.field || 'value', type: 'string', gqlType: 'String', required: true},
                     ]};
+            case 'getConsistentBy':
+                pageType = this.camelCase(msType);
+                return {operationNature, operationType: pageType, operationGqlType: pageType, operationArgs: [
+                        {name: cfg?.vars?.default || cfg?.vars?.field || 'value', type: 'string', gqlType: 'String', required: true},
+                    ]};
             case 'findInIndexByHashKey':
                 pageType = `${this.camelCase(msType)}Page`;
                 return {operationNature, operationType: pageType, operationGqlType: pageType, operationArgs: [
@@ -527,6 +540,12 @@ export class SchemaGraphqlModel {
                             {name: cfg?.vars?.default || cfg?.vars?.field || 'value', type: 'string', gqlType: 'String', required: true},
                         ]};
                 }
+                if (/^getConsistentBy/.test(operationNature || '')) {
+                    pageType = this.camelCase(msType);
+                    return {operationNature, operationType: pageType, operationGqlType: pageType, operationArgs: [
+                            {name: cfg?.vars?.default || cfg?.vars?.field || 'value', type: 'string', gqlType: 'String', required: true},
+                        ]};
+                }
                 if (origOp?.rawOutputType) {
                     const ogt = origOp.rawOutputType.replace('{{gqlType}}', this.camelCase(msType));
                     return {...(origOp?.rawOutputType ? {operationGqlType: ogt, operationType: ogt} : {})};
@@ -702,4 +721,4 @@ export class SchemaGraphqlModel {
 }
 
 // noinspection JSUnusedGlobalSymbols
-export default SchemaGraphqlConfig
+export default SchemaGraphqlConfig

packages/plugin-registry-base/assets/code/microservice/type/function/getConsistentBy.yml

@@ -0,0 +1,20 @@
+async: true
+
+require:
+  - find
+
+inputs:
+  type:
+    main: true
+
+args:
+  - field
+  - value
+  - fields = []
+  - query
+
+code: |
+  if (undefined === value || null === value || '' === value) throw new (require('@ohoareau/errors/lib/DocumentNotFoundError').default)('<%- type %>', '*empty*', field);
+  const docs = await service.find({...query, consistent: true, index: field, hashKey: value, limit: 1, fields, selections: {items: {fields, selections: query.selections}}});
+  if (!docs || !docs.items || (1 > docs.items.length)) throw new (require('@ohoareau/errors/lib/DocumentNotFoundError').default)('<%- type %>', value, field);
+  return docs.items.shift();

packages/plugin-registry-base/assets/code/microservice/type/operation/getConsistentBy.yml

@@ -0,0 +1,13 @@
+require:
+  - getConsistentBy
+
+inputs:
+  field:
+    main: true
+
+wrap:
+  - getConsistentBy
+  - "'<%- field %>'"
+  - query.<%- field %>
+  - query.fields || []
+  - query