Skip to content

Commit b89e986

Browse files
authored
chore: Add e2e apps for python plugin and node plugin. (#134)
## Summary Adds a couple example apps. Likely these will need re-worked if we use them to run e2e tests, but they do demonstrate how to use their respective plugins. ## How did you test this change? <!-- Frontend - Leave a screencast or a screenshot to visually describe the changes. --> ## Are there any deployment considerations? <!-- Backend - Do we need to consider migrations or backfilling data? -->
1 parent f523fbf commit b89e986

File tree

12 files changed

+4276
-221
lines changed

12 files changed

+4276
-221
lines changed

e2e/node-plugin-express/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Express App
2+
3+
A basic Express.js app using LaunchDarkly and the LaunchDarkly Observability Plugin.
4+
5+
The `@launchdarkly/observability-node` package must be built before this project can be ran.
6+
7+
# Quick Start
8+
9+
Set a LaunchDarkly SDK key:
10+
```bash
11+
export LAUNCHDARKLY_SDK_KEY=<your-sdk-key>
12+
```
13+
14+
Install dependencies:
15+
```bash
16+
yarn
17+
```
18+
19+
Run the application:
20+
```bash
21+
yarn start
22+
```
Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
{
2+
"name": "node-express-plugin",
3+
"version": "1.0.0",
4+
"main": "index.js",
5+
"scripts": {
6+
"build": "npx tsc",
7+
"start": "npm run build && node dist/server.js"
8+
},
9+
"keywords": [],
10+
"author": "",
11+
"license": "ISC",
12+
"description": "",
13+
"devDependencies": {
14+
"@types/express": "^5.0.2",
15+
"@types/node": "^22.15.29",
16+
"cross-env": "^7.0.3",
17+
"dotenv": "^16.5.0",
18+
"eslint": "^9.28.0",
19+
"express": "^5.1.0",
20+
"install": "^0.13.0",
21+
"nodemon": "^3.1.10",
22+
"npm": "^11.4.1",
23+
"prettier": "^3.5.3",
24+
"ts-node": "^10.9.2",
25+
"typescript": "^5.8.3"
26+
},
27+
"dependencies": {
28+
"@launchdarkly/node-server-sdk": "^9.10.0",
29+
"@launchdarkly/observability-node": "workspace:*",
30+
"express-request-id": "^3.0.0",
31+
"winston": "^3.17.0"
32+
}
33+
}
Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
import { init, LDMultiKindContext } from '@launchdarkly/node-server-sdk'
2+
import { Observability, LDObserve } from '@launchdarkly/observability-node'
3+
import express, { Express, NextFunction, Request, Response } from 'express'
4+
5+
const client = init(process.env.LAUNCHDARKLY_SDK_KEY ?? '', {
6+
plugins: [
7+
new Observability({
8+
serviceName: 'ryan-test-2',
9+
}),
10+
],
11+
})
12+
13+
const app: Express = express()
14+
const port = 3000
15+
16+
interface User {}
17+
18+
const userRepository = {
19+
findAll: async (): Promise<User[]> => {
20+
return []
21+
},
22+
}
23+
24+
app.get('/start-span-example', (req: Request, res: Response) => {
25+
const { span } = LDObserve.startWithHeaders('example-span-a', req.headers)
26+
27+
LDObserve.setAttributes({
28+
'example-attribute': 'example-value',
29+
})
30+
31+
res.send('Hello World')
32+
span.end()
33+
})
34+
35+
app.get('/run-span-example', async (req: Request, res: Response) => {
36+
await LDObserve.runWithHeaders('example-span-b', req.headers, (span) => {
37+
LDObserve.setAttributes({
38+
'example-attribute': 'example-value',
39+
})
40+
41+
res.send('Hello World')
42+
})
43+
})
44+
45+
app.get('/users', async (req: Request, res: Response) => {
46+
const users = await userRepository.findAll()
47+
res.json(users)
48+
})
49+
50+
app.get('/error', async (req: Request, res: Response) => {
51+
LDObserve.recordError(new Error('test error'), undefined, undefined)
52+
res.status(500)
53+
res.send()
54+
})
55+
56+
app.get('/user', async (req: Request, res: Response, next: NextFunction) => {
57+
// Evaluate something just to get the span event.
58+
const useMongo = await client.boolVariation(
59+
'useMongo',
60+
{ kind: 'request', key: 'test' },
61+
false,
62+
)
63+
64+
console.log('test')
65+
66+
if (useMongo) {
67+
throw new Error('Mongo is not supported')
68+
}
69+
70+
res.status(200)
71+
res.json({})
72+
})
73+
74+
app.get('/multi', async (req: Request, res: Response) => {
75+
const flag = await client.boolVariation(
76+
'my-boolean-flag',
77+
{ kind: 'router', key: 'service-name' },
78+
false,
79+
)
80+
const flag2 = await client.stringVariationDetail(
81+
'string-variation',
82+
{
83+
kind: 'multi',
84+
user: { key: 'sally' },
85+
org: {
86+
key: 'martmart',
87+
},
88+
},
89+
'default',
90+
)
91+
92+
res.status(500)
93+
if (flag) {
94+
res.send('Flag enabled')
95+
} else {
96+
res.send('Flag disabled')
97+
}
98+
})
99+
100+
async function asyncSleep(msTime: number) {
101+
return new Promise<void>((resolve) => {
102+
setTimeout(() => {
103+
resolve()
104+
}, msTime)
105+
})
106+
}
107+
108+
app.get('/sleep', async (req: Request, res: Response) => {
109+
const userKey = req.query['key'] ?? 'bob'
110+
111+
const context: LDMultiKindContext = {
112+
kind: 'multi',
113+
user: { key: userKey as string },
114+
service: { key: 'router' },
115+
}
116+
const msTime = await client.numberVariation('variable-sleep', context, 0)
117+
await asyncSleep(msTime)
118+
res.send('operation complete')
119+
})
120+
121+
app.use((err: Error, req: Request, res: Response, next: NextFunction) => {
122+
res.status(500)
123+
res.send()
124+
})
125+
126+
app.listen(port, () => {
127+
console.log(`[Server]: I am running at https://localhost:${port}`)
128+
})
Lines changed: 113 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
{
2+
"compilerOptions": {
3+
/* Visit https://aka.ms/tsconfig to read more about this file */
4+
5+
/* Projects */
6+
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
7+
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
8+
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
9+
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
10+
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
11+
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
12+
13+
/* Language and Environment */
14+
"target": "es2016", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
15+
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
16+
// "jsx": "preserve", /* Specify what JSX code is generated. */
17+
// "libReplacement": true, /* Enable lib replacement. */
18+
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
19+
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
20+
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
21+
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
22+
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
23+
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
24+
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
25+
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
26+
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
27+
28+
/* Modules */
29+
"module": "commonjs", /* Specify what module code is generated. */
30+
// "rootDir": "./", /* Specify the root folder within your source files. */
31+
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
32+
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
33+
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
34+
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
35+
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
36+
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
37+
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
38+
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
39+
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
40+
// "rewriteRelativeImportExtensions": true, /* Rewrite '.ts', '.tsx', '.mts', and '.cts' file extensions in relative import paths to their JavaScript equivalent in output files. */
41+
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
42+
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
43+
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
44+
// "noUncheckedSideEffectImports": true, /* Check side effect imports. */
45+
// "resolveJsonModule": true, /* Enable importing .json files. */
46+
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
47+
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
48+
49+
/* JavaScript Support */
50+
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
51+
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
52+
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
53+
54+
/* Emit */
55+
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
56+
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
57+
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
58+
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
59+
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
60+
// "noEmit": true, /* Disable emitting files from a compilation. */
61+
// "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. */
62+
"outDir": "./dist", /* Specify an output folder for all emitted files. */
63+
// "removeComments": true, /* Disable emitting comments. */
64+
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
65+
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
66+
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
67+
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
68+
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
69+
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
70+
// "newLine": "crlf", /* Set the newline character for emitting files. */
71+
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
72+
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
73+
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
74+
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
75+
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
76+
77+
/* Interop Constraints */
78+
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
79+
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
80+
// "isolatedDeclarations": true, /* Require sufficient annotation on exports so other tools can trivially generate declaration files. */
81+
// "erasableSyntaxOnly": true, /* Do not allow runtime constructs that are not part of ECMAScript. */
82+
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
83+
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
84+
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
85+
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
86+
87+
/* Type Checking */
88+
"strict": true, /* Enable all strict type-checking options. */
89+
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
90+
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
91+
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
92+
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
93+
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
94+
// "strictBuiltinIteratorReturn": true, /* Built-in iterators are instantiated with a 'TReturn' type of 'undefined' instead of 'any'. */
95+
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
96+
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
97+
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
98+
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
99+
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
100+
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
101+
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
102+
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
103+
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
104+
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
105+
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
106+
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
107+
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
108+
109+
/* Completeness */
110+
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
111+
"skipLibCheck": true /* Skip type checking all .d.ts files. */
112+
}
113+
}

e2e/python-plugin-flask/.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
.venv/

e2e/python-plugin-flask/Makefile

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
.PHONY: help install lint test build clean format
2+
3+
# Default target
4+
help:
5+
@echo "Available targets:"
6+
@echo " install - Clean installs using poetry"
7+
@echo " run - Run using poetry"
8+
9+
# This is a pretty aggressive install that removes all the site packages.
10+
# This ensures that we get the latest version when working on changes to the plugin.
11+
install:
12+
find $(poetry env info --path) -type d -name site-packages -exec rm -rf {} \; ; poetry lock && poetry install
13+
14+
run:
15+
poetry run flask run

e2e/python-plugin-flask/README.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Flask App
2+
3+
A basic flask app using LaunchDarkly and the LaunchDarkly Observability Plugin.
4+
5+
# Quick Start
6+
7+
The `@launchdarkly/observability-python` package must be built before this project can be ran.
8+
9+
Set a LaunchDarkly SDK key:
10+
```bash
11+
export LAUNCHDARKLY_SDK_KEY=<your-sdk-key>
12+
```
13+
14+
Install dependencies:
15+
```bash
16+
make install
17+
```
18+
19+
Run the application:
20+
```bash
21+
make run
22+
```

e2e/python-plugin-flask/app.py

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
from flask_app import app

0 commit comments

Comments
 (0)