Azure-DevOps-TDD_VarshithaG_Submission2

devrev-snaps-typescript-template/README.md

@@ -0,0 +1,153 @@
+## DevRev Snaps TypeScript Template
+
+This repository contains a template for the functions that can be deployed as
+part of Snap-Ins.
+
+For reference on snap-ins, refer to the [documentation](https://github.com/devrev/snap-in-docs).
+
+### Getting started with the template
+
+1. Create a new repository using this template.
+2. In the new repository, you can add functions at the path `src/functions` where the folder name corresponds to the function name in your manifest file.
+3. Ensure to include each new function in the file named "src/function-factory.ts".
+
+### Testing locally
+
+To test your code locally, add test events under 'src/fixtures' following the example event provided. Additionally, you can include keyring values in the event payload to test API calls.```
+
+After adding the event, execute the following commands to test your code:
+
+```
+npm install
+npm run start -- --functionName=on_work_creation --fixturePath=on_work_created_event.json
+```
+
+### Adding external dependencies
+
+You can also add dependencies on external packages to package.json under the “dependencies” key. These dependencies will be made available to your function at runtime and during testing.
+
+### Linting
+
+To check for lint errors, run the following command:
+
+```bash
+npm run lint
+```
+
+To automatically fix fixable lint errors, run:
+
+```bash
+npm run lint:fix
+```
+
+### Deploying Snap-ins
+
+Once you are done with the testing, run the following commands to deploy your snap-in:
+
+1. Authenticate to devrev CLI, run the following command:
+
+```
+devrev profiles authenticate --org <devorg name> --usr <user email>
+```
+
+2. To create a snap_in_version, run the following command:
+
+```
+devrev snap_in_version create-one --path <template path> --create-package
+```
+
+3. Draft the snap_in, run the following command:
+
+```
+devrev snap_in draft
+```
+
+4. To update the snap-in, run the following command:
+
+```
+devrev snap_in update
+```
+
+5. Activate the snap_in
+
+```
+devrev snap_in activate
+```
+
+### Testing Snap-in changes locally
+
+### Setting up the server
+
+To test out changes in snap-in locally, developers can create a snap-in version in test mode.
+A snap-in version created in test mode enables developers to specify a public HTTP URL to receive events from DevRev. This makes for
+quick code changes on the local machine without needing to repeatedly deploy the snap-in again for testing the changes.
+
+To test out a snap-in version locally, follow the below steps:
+
+1. Run a server locally to ingest events from DevRev. The `port` parameter is optional. If not set, the server starts default on `8000`.
+
+```
+npm run test:server -- --port=<PORT>
+```
+
+2. Expose the local port as a publicly available URL. We recommend using [`ngrok`](https://ngrok.com/download) since it is free and easy to set up. The command for running ngrok tunnelling on port `8000`:
+
+```
+ngrok http 8000
+```
+
+This returns a public HTTP URL.
+
+3. Create a snap-in version with the `testing-url` flag set
+
+```
+devrev snap_in_version create-one --path <template path> --create-package --testing-url <HTTP_URL>
+```
+
+Here, `HTTP_URL` is the publicly available URL from Step 2. The URL should start with `http` or `https`
+
+4. Once the snap-in version is ready, create a snap-in, update and activate it.
+
+```
+devrev snap_in draft
+```
+
+Update the snap-in through UI or using the CLI:
+
+```
+devrev snap_in update
+```
+
+Activate the snap-in through UI or through the CLI command:
+
+```
+devrev snap_in activate
+```
+
+### Receiving events locally
+
+After the snap-in has been activated, it can receive events locally from DevRev as a
+snap-in would. If the snap-in was listening to `work_created` event type, then creating a
+new work-item would send the event to the local server.
+
+If utilizing ngrok, accessing the ngrok UI is possible by opening http://127.0.0.1:4040/ in the browser. This interface offers a neat way to review the list of requests and replay them if necessary.
+
+The service account token included with the request is valid for only 30 minutes. Therefore, attempting to call the DevRev API with that token for events older than this timeframe will result in a '401 Unauthorized' error.
+
+### Updating manifest or the URL
+
+The code can be changed without the need to create a snap-in version or redeploy the snap-in. On any change to the
+`src` folder, the server restarts with the updated changes. However, on [patch compatible](https://developer.devrev.ai/snap-in-development/upgrade-snap-ins#version-compatibility) updates to the manifest or the testing URL, we can `upgrade` the snap-in version.
+
+```
+devrev snap_in_version upgrade --manifest <PATH_TO_MANIFEST> --testing-url <UPDATED_URL>
+```
+
+In case of non-patch compatible updates, the `force` flag can be used to upgrade the version. However this will delete any
+existing snap-ins that have been created from this version.
+
+```
+devrev snap_in_version upgrade --force --manifest <PATH_TO_MANIFEST> --testing-url <UPDATED_URL>
+```
+
+Do note that manifest must always be provided when upgrading a snap-in version.

devrev-snaps-typescript-template/code/.eslintrc.js

@@ -0,0 +1,35 @@
+module.exports = {
+  extends: 'airbnb-typescript/base',
+  extends: [
+    'plugin:@typescript-eslint/recommended',
+    'plugin:prettier/recommended', // Makes ESLint and Prettier play nicely together
+    'plugin:import/recommended',
+    'plugin:import/typescript',
+  ],
+  ignorePatterns: ['**/dist/*'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    project: './tsconfig.eslint.json',
+  },
+  plugins: ['prettier', 'unused-imports', 'import', 'simple-import-sort', 'sort-keys-fix'],
+  root: true,
+  rules: {
+    'import/first': 'error', // Ensures all imports are at the top of the file
+    'import/newline-after-import': 'error', // Ensures there’s a newline after the imports
+    'import/no-duplicates': 'error', // Merges import statements from the same file
+    'import/order': 'off', // Not compatible with simple-import-sort
+    'no-unused-vars': 'off', // Handled by @typescript-eslint/no-unused-vars
+    'simple-import-sort/exports': 'error', // Auto-formats exports
+    'simple-import-sort/imports': 'error', // Auto-formats imports
+    'sort-imports': 'off', // Not compatible with simple-import-sort
+    'sort-keys-fix/sort-keys-fix': ['error', 'asc', { natural: true }], // Sorts long object key lists alphabetically
+    'unused-imports/no-unused-imports': 'error', // Removes unused imports automatically,
+    '@typescript-eslint/no-explicit-any': 'warn', // Allows any type with a warning
+  },
+  overrides:[{
+    "files": ["**/*.test.ts"],
+    "rules": {
+      'simple-import-sort/imports': 'off', // for test files we would want to load the mocked up modules later so on sorting the mocking mechanism will not work
+    }
+  }]
+};

devrev-snaps-typescript-template/code/.gitignore

@@ -0,0 +1,39 @@
+# See http://help.github.com/ignore-files/ for more about ignoring files.
+
+# compiled output
+/dist
+/tmp
+/out-tsc
+
+# Testing
+coverage/
+
+# dependencies
+/node_modules
+
+# IDEs and editors
+/.idea
+.project
+.classpath
+.c9/
+*.launch
+.settings/
+*.sublime-workspace
+
+# IDE - VSCode
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+
+# System Files
+.DS_Store
+Thumbs.db
+
+deps.json
+results.json
+before-run-data.json
+
+# packaged app
+*.tar.gz

devrev-snaps-typescript-template/code/.npmrc

@@ -0,0 +1 @@
+save-exact=true

devrev-snaps-typescript-template/code/.prettierignore

@@ -0,0 +1,4 @@
+# Add files here to ignore them from prettier formatting
+
+/dist
+

devrev-snaps-typescript-template/code/.prettierrc

@@ -0,0 +1,15 @@
+{
+  "printWidth": 120,
+  "tabWidth": 2,
+  "useTabs": false,
+  "semi": true,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "bracketSpacing": true,
+  "jsxSingleQuote": false,
+  "arrowParens": "always",
+  "proseWrap": "never",
+  "htmlWhitespaceSensitivity": "strict",
+  "endOfLine": "lf",
+  "organizeImportsSkipDestructiveCodeActions": true
+}

devrev-snaps-typescript-template/code/babel.config.js

@@ -0,0 +1,3 @@
+module.exports = {
+  presets: [['@babel/preset-env', { targets: { node: 'current' } }], '@babel/preset-typescript'],
+};

devrev-snaps-typescript-template/code/jest.config.js

@@ -0,0 +1,12 @@
+module.exports = {
+  collectCoverage: true,
+  coverageDirectory: 'coverage',
+  coverageThreshold: {
+    "**/*": {
+      branches: 60
+    }
+  },
+  coverageReporters: ['text'],
+  preset: 'ts-jest',
+  testEnvironment: 'node'
+};

devrev-snaps-typescript-template/code/nodemon.json

@@ -0,0 +1,5 @@
+{
+  "execMap": {
+    "ts": "ts-node"
+  }
+}