Skip to content

Commit

Permalink
chore: Utility to generate responses for development environment (#2790)
Browse files Browse the repository at this point in the history
  • Loading branch information
bryan-robitaille authored Oct 19, 2023
1 parent 534bb6e commit f5044f6
Show file tree
Hide file tree
Showing 8 changed files with 1,275 additions and 176 deletions.
1 change: 1 addition & 0 deletions next-env.d.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
/// <reference types="next" />
/// <reference types="next/image-types/global" />
/// <reference types="next/navigation-types/compat/navigation" />

// NOTE: This file should not be edited
// see https://nextjs.org/docs/basic-features/typescript for more information.
94 changes: 6 additions & 88 deletions utils/cognitoBackup/tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,102 +2,20 @@
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */

/* Language and Environment */
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for TC39 stage 2 draft decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,

/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */

/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */

/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
"module": "commonjs" /* Specify what module code is generated. */,

/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
"strict": true /* Enable all strict type-checking options. */,

/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}
9 changes: 9 additions & 0 deletions utils/responseGenerator/.env_example
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# Copy to .env

LOCAL_LAMBDA_ENDPOINT=http://127.0.0.1:3001
LOCAL_AWS_ENDPOINT=http://localhost:4566
RELIABILITY_FILE_STORAGE=forms-local-reliability-file-storage

AWS_ACCESS_KEY_ID=test
AWS_SECRET_ACCESS_KEY=test
AWS_REGION=ca-central-1
161 changes: 161 additions & 0 deletions utils/responseGenerator/generate_responses.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,161 @@
/* eslint-disable no-console */
import readline from "readline";
import {
SQSClient,
GetQueueUrlCommand,
ReceiveMessageCommand,
DeleteMessageCommand,
} from "@aws-sdk/client-sqs";
import { LambdaClient, InvokeCommand } from "@aws-sdk/client-lambda";
import { config } from "dotenv";

const decoder = new TextDecoder();

function getValue(query: string) {
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout,
});

return new Promise<string>((resolve) =>
rl.question(query, (ans) => {
rl.close();
resolve(ans);
})
);
}

const twirlTimer = () => {
var P = ["\\", "|", "/", "-"];
var x = 0;
return setInterval(function () {
process.stdout.write("\r" + P[x++]);
x &= 3;
}, 250);
};

function writeWaitingPercent(current: number, total: number) {
readline.cursorTo(process.stdout, 0);
process.stdout.write(`waiting ... ${Math.round((current / total) * 100)}%`);
}

const getQueueURL = async (client: SQSClient) => {
const data = await client.send(
new GetQueueUrlCommand({
QueueName: "submission_processing.fifo",
})
);
return data.QueueUrl;
};

const main = async () => {
try {
const formID = await getValue("Form ID to generate responses for:");
const numberOfResponses = parseInt(await getValue("Number of responses to generate:"), 10);

const encoder = new TextEncoder();

// Setup all required services

const sqsClient = new SQSClient({
region: process.env.AWS_REGION ?? "ca-central-1",
endpoint: process.env.LOCAL_AWS_ENDPOINT,
});

const sqsQueueUrl = await getQueueURL(sqsClient);

const lambdaClient = new LambdaClient({
region: "ca-central-1",
retryMode: "standard",
endpoint: process.env.LOCAL_LAMBDA_ENDPOINT,
});

// Generate and submit responses
console.log("Generating responses for form.");

for (let response = 0; response < numberOfResponses; response++) {
const command = new InvokeCommand({
FunctionName: "Submission",
Payload: encoder.encode(
JSON.stringify({
formID,
responses: {},
language: "en",
securityAttribute: "Protected A",
})
),
});
try {
const response = await lambdaClient.send(command);

const payload = decoder.decode(response.Payload);
if (response.FunctionError || !JSON.parse(payload).status) {
throw new Error("Submission API could not process form response");
}
} catch (err) {
console.error(err as Error);
throw new Error("Could not process request with Lambda Submission function");
}
writeWaitingPercent(response + 1, numberOfResponses);
}

// Retrieve and process responses from Reliabilty Queue
let messagesWaiting = true;

console.log("\nProcessing responses in Reliability Queue");

const workingOnProcessing = twirlTimer();
while (messagesWaiting) {
try {
const receiveCommand = new ReceiveMessageCommand({
QueueUrl: sqsQueueUrl,
MaxNumberOfMessages: 1,
VisibilityTimeout: 30,
WaitTimeSeconds: 5,
});
const { Messages } = await sqsClient.send(receiveCommand);
// If there are no messages to process stop the loop
if (!Messages) {
messagesWaiting = false;
break;
}
const { Body: formResponse, ReceiptHandle } = Messages[0];

const reliabilityCommand = new InvokeCommand({
FunctionName: "Reliability",
Payload: encoder.encode(
JSON.stringify({
Records: [
{
body: formResponse,
},
],
})
),
});
const response = await lambdaClient.send(reliabilityCommand);

if (response.FunctionError) {
throw new Error("Submission API could not process form response");
}

const deleteCommand = new DeleteMessageCommand({
QueueUrl: sqsQueueUrl,
ReceiptHandle,
});
sqsClient.send(deleteCommand);
} catch (err) {
console.error(err as Error);
throw new Error("Could not process request with Lambda Submission function");
}
}
clearInterval(workingOnProcessing);
console.log(`\nData generation completed for ${numberOfResponses} responses.`);
} catch (e) {
console.log(e);
}
};
// config() adds the .env variables to process.env
config();

main();
20 changes: 20 additions & 0 deletions utils/responseGenerator/package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"name": "generate_responses",
"version": "0.1.0",
"description": "Generate responses to the Vault",
"main": "generate_responses.ts",
"scripts": {
"generate": "ts-node generate_responses.ts"
},
"keywords": [],
"author": "Bryan Robitaille",
"dependencies": {
"@aws-sdk/client-lambda": "^3.429.0",
"@aws-sdk/client-sqs": "^3.429.0",
"@aws-sdk/types": "^3.428.0",
"@types/node": "^20.8.6",
"dotenv": "^16.3.1",
"ts-node": "^10.9.1",
"typescript": "^5.2.2"
}
}
21 changes: 21 additions & 0 deletions utils/responseGenerator/tsconfig.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */

/* Language and Environment */
"target": "es2016" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,

/* Modules */
"module": "commonjs" /* Specify what module code is generated. */,

/* Interop Constraints */
"esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
"forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,

/* Type Checking */
"strict": true /* Enable all strict type-checking options. */,

/* Completeness */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}
Loading

0 comments on commit f5044f6

Please sign in to comment.