Performance sprint preparations

extensions/README.md

@@ -1,5 +1,11 @@
-# Extension System Development Guide
-TODO: Move extensions docs into here?
-For now see [here](../doc/contributors/extensions/README.md)
+# Extension System Development Guide]
 
-## Specific Extension Logs
+## Where to find documentation
+
+### Here
+Documentation for extensions is [here](src/backend/doc/extensions/README.md).
+
+### Not Here
+
+Outdated documentation for extensions is [here](../doc/contributors/extensions/README.md).
+This documentation may include some topics that are missing from the current documentation. Eventually those topics should be updated and transferred to the current documentation so that this documentation may be removed.

extensions/hellodriver/hellodriver.js

@@ -1,5 +1,8 @@
 const { kv } = extension.import('data');
 
+const spanify = extension.import('core').spanify;
+const svc_trace = extension.import('service:traceService');
+
 /**
  * Here we create an interface called 'hello-world'. This interface
  * specifies that any implementation of 'hello-world' should implement
@@ -64,6 +67,15 @@ extension.on('create.drivers', event => {
     });
 });
 
+extension.on('create.drivers', event => {
+    event.createDriver('hello-world', 'slow-hello', {
+        greet: spanify('slow-hello:greet', async ({ subject }) => {
+            await new Promise(rslv => setTimeout(rslv, 1000));
+            return `Hello, ${subject ?? 'World'}!`;
+        }),
+    });
+});
+
 extension.on('create.drivers', event => {
     event.createDriver('hello-world', 'extension-examples', {
         greet ({ subject }) {
@@ -113,5 +125,6 @@ extension.on('create.drivers', event => {
  */
 extension.on('create.permissions', event => {
     event.grant_to_everyone('service:no-frills:ii:hello-world');
+    event.grant_to_everyone('service:slow-hello:ii:hello-world');
     event.grant_to_everyone('service:extension-examples:ii:hello-world');
 });

src/backend/src/CoreModule.js

@@ -78,6 +78,10 @@ const install = async ({ context, services, app, useapi, modapi }) => {
 
         def('core.database', require('./services/database/consts.js'));
 
+        // Add otelutil functions to `core.`
+        def('core.spanify', require('./util/otelutil').spanify);
+        def('core.abtest', require('./util/otelutil').abtest);
+
         // Extension compatibility
         const runtimeModule = new RuntimeModule({ name: 'core' });
         context.get('runtime-modules').register(runtimeModule);

src/backend/src/services/TraceService.js

@@ -52,7 +52,7 @@ class TraceService extends BaseService {
      * @param {opentelemetry.SpanOptions} [options] - The opentelemetry options object
      * @returns {Promise} - A promise that resolves to the return value of `fn`.
      */
-    async spanify (name, fn, options) {
+    async span (name, fn, options) {
         const args = [name];
         if ( options !== null && typeof options === 'object' ) {
             args.push(options);
@@ -72,6 +72,14 @@ class TraceService extends BaseService {
         });
         return await this.tracer.startActiveSpan(...args);
     }
+
+    /**
+     * @deprecated use `span` instead to avoid confusion with the spanify
+     * function from otelutil.
+     */
+    async spanify (name, fn, options) {
+        return await this.span(name, fn, options);
+    }
 }
 
 module.exports = {