Fix: fix telemetry headers, add support for external bot auth

packages/api/src/auth/credentials.ts

@@ -1,5 +1,24 @@
-export interface Credentials {
+/**
+ * credentials for app authentication
+ */
+export type Credentials = ClientCredentials | TokenCredentials;
+
+/**
+ * credentials for authentication
+ * of an app via `clientId` and `clientSecret`
+ */
+export interface ClientCredentials {
   readonly clientId: string;
   readonly clientSecret: string;
   readonly tenantId?: string;
 }
+
+/**
+ * credentials for authentication
+ * of an app via any external auth method
+ */
+export interface TokenCredentials {
+  readonly clientId: string;
+  readonly tenantId?: string;
+  readonly token: (scope: string | string[], tenantId?: string) => string | Promise<string>;
+}

packages/api/src/auth/json-web-token.ts

@@ -67,7 +67,7 @@ export class JsonWebToken implements Token {
 
   constructor(value: string) {
     this._value = value;
-    this._payload = jwtDecode(value);
+    this._payload = jwtDecode(value, { header: true });
   }
 
   toString() {

packages/api/src/clients/bot/token.ts

@@ -3,8 +3,6 @@ import { Client, ClientOptions } from '@microsoft/spark.common/http';
 
 import { Credentials } from '../../auth';
 
-export type GetBotTokenParams = Credentials;
-
 export interface GetBotTokenResponse {
   readonly token_type: 'Bearer';
   readonly expires_in: number;
@@ -31,14 +29,25 @@ export class BotTokenClient {
     }
   }
 
-  async get(params: GetBotTokenParams) {
-    const tenantId = params.tenantId || 'botframework.com';
+  async get(credentials: Credentials) {
+    if ('token' in credentials) {
+      return {
+        token_type: 'Bearer',
+        expires_in: -1,
+        access_token: await credentials.token(
+          'https://api.botframework.com/.default',
+          credentials.tenantId
+        ),
+      };
+    }
+
+    const tenantId = credentials.tenantId || 'botframework.com';
     const res = await this.http.post<GetBotTokenResponse>(
       `https://login.microsoftonline.com/${tenantId}/oauth2/v2.0/token`,
       qs.stringify({
         grant_type: 'client_credentials',
-        client_id: params.clientId,
-        client_secret: params.clientSecret,
+        client_id: credentials.clientId,
+        client_secret: credentials.clientSecret,
         scope: 'https://api.botframework.com/.default',
       }),
       {
@@ -49,14 +58,25 @@ export class BotTokenClient {
     return res.data;
   }
 
-  async getGraph(params: GetBotTokenParams) {
-    const tenantId = params.tenantId || 'botframework.com';
+  async getGraph(credentials: Credentials) {
+    if ('token' in credentials) {
+      return {
+        token_type: 'Bearer',
+        expires_in: -1,
+        access_token: await credentials.token(
+          'https://graph.microsoft.com/.default',
+          credentials.tenantId
+        ),
+      };
+    }
+
+    const tenantId = credentials.tenantId || 'botframework.com';
     const res = await this.http.post<GetBotTokenResponse>(
       `https://login.microsoftonline.com/${tenantId}/oauth2/v2.0/token`,
       qs.stringify({
         grant_type: 'client_credentials',
-        client_id: params.clientId,
-        client_secret: params.clientSecret,
+        client_id: credentials.clientId,
+        client_secret: credentials.clientSecret,
         scope: 'https://graph.microsoft.com/.default',
       }),
       {

packages/api/tsconfig.json

@@ -1,5 +1,5 @@
 {
-  "extends": "@microsoft/spark.config/tsconfig.node.json",
+  "extends": "@microsoft/spark.config/tsconfig.esm.json",
   "compilerOptions": {
     "outDir": "dist",
     "rootDir": "src"

packages/apps/src/app.ts

@@ -180,7 +180,7 @@ export class App {
   protected startedAt?: Date;
   protected port?: number;
 
-  private readonly _userAgent = `teams[apps]/${pkg.version}`;
+  private readonly _userAgent = `spark[apps]/${pkg.version}`;
   private readonly _manifest: Partial<manifest.Manifest>;
   private _tokens: AppTokens = {};
 
@@ -224,14 +224,19 @@ export class App {
     );
 
     const clientId = this.options.clientId || process.env.CLIENT_ID;
-    const clientSecret = this.options.clientSecret || process.env.CLIENT_SECRET;
-    const tenantId = this.options.tenantId || process.env.TENANT_ID;
+    const clientSecret =
+      ('clientSecret' in this.options ? this.options.clientSecret : undefined) ||
+      process.env.CLIENT_SECRET;
+    const tenantId =
+      ('tenantId' in this.options ? this.options.tenantId : undefined) || process.env.TENANT_ID;
+    const token = 'token' in this.options ? this.options.token : undefined;
 
     if (clientId && clientSecret) {
       this.credentials = {
         clientId,
         clientSecret,
         tenantId,
+        token,
       };
     }
 
@@ -256,7 +261,9 @@ export class App {
    * start the app
    * @param port port to listen on
    */
-  async start(port = 3000) {
+  async start(port?: number | string) {
+    this.port = +(port || process.env.PORT || 3000);
+
     try {
       if (this.credentials) {
         const botResponse = await this.api.bots.token.get(this.credentials);
@@ -269,12 +276,11 @@ export class App {
 
       for (const plugin of this.plugins) {
         if (plugin.onStart) {
-          await plugin.onStart(port);
+          await plugin.onStart(this.port);
         }
       }
 
       this.events.emit('start', this.log);
-      this.port = port;
       this.startedAt = new Date();
     } catch (err: any) {
       this.events.emit('error', { err, log: this.log });

packages/apps/src/middleware/with-client-auth.ts

@@ -13,8 +13,11 @@ export type ClientAuthRequest = express.Request & {
   context?: ClientContext;
 };
 
-export function withClientAuth({ logger, clientId, clientSecret, tenantId }: WithClientAuthParams) {
-  const log = logger;
+export function withClientAuth(params: WithClientAuthParams) {
+  const log = params.logger;
+  const clientId = params.clientId;
+  const clientSecret = 'clientSecret' in params ? params.clientSecret : undefined;
+  const tenantId = 'tenantId' in params ? params.tenantId : undefined;
 
   return (req: ClientAuthRequest, res: express.Response, next: express.NextFunction) => {
     const appClientId = req.header('X-Spark-App-Client-Id');

packages/botbuilder/src/plugin.ts

@@ -29,14 +29,22 @@ export class BotBuilderPlugin extends HttpPlugin {
     super.onInit(app);
 
     if (!this.adapter) {
+      const clientId = app.credentials?.clientId;
+      const clientSecret =
+        app.credentials && 'clientSecret' in app.credentials
+          ? app.credentials?.clientSecret
+          : undefined;
+      const tenantId =
+        app.credentials && 'tenantId' in app.credentials ? app.credentials?.tenantId : undefined;
+
       this.adapter = new CloudAdapter(
         new ConfigurationBotFrameworkAuthentication(
           {},
           new ConfigurationServiceClientCredentialFactory({
-            MicrosoftAppType: app.credentials?.tenantId ? 'SingleTenant' : 'MultiTenant',
-            MicrosoftAppId: app.credentials?.clientId,
-            MicrosoftAppPassword: app.credentials?.clientSecret,
-            MicrosoftAppTenantId: app.credentials?.tenantId,
+            MicrosoftAppType: tenantId ? 'SingleTenant' : 'MultiTenant',
+            MicrosoftAppId: clientId,
+            MicrosoftAppPassword: clientSecret,
+            MicrosoftAppTenantId: tenantId,
           })
         )
       );

packages/client/src/app.ts

@@ -139,8 +139,9 @@ export class App {
         'x-spark-app-id': this.context.app.id,
         'x-spark-app-session-id': this.context.app.sessionId,
         'x-spark-app-client-id': this.options.clientId,
-        'x-spark-app-client-secret': this.options.clientSecret,
-        'x-spark-app-tenant-id': this.options.tenantId,
+        'x-spark-app-client-secret':
+          'clientSecret' in this.options ? this.options.clientSecret : undefined,
+        'x-spark-app-tenant-id': 'tenantId' in this.options ? this.options.tenantId : undefined,
         'x-spark-tenant-id': this.context.user?.tenant?.id,
         'x-spark-user-id': this.context.user?.id,
         'x-spark-team-id': this.context.team?.internalId,

packages/graph/scripts/client.ts.template

@@ -61,15 +61,15 @@ export class {{capitalize name}}Client {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`
+          'User-Agent': `spark[graph]/${pkg.version}`
         }
       });
     } else if ('request' in options) {
       this.http = options.clone({
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         }
       });
     } else {
@@ -78,7 +78,7 @@ export class {{capitalize name}}Client {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
           ...options.headers
         }
       });

packages/graph/src/appCatalogs/index.ts

@@ -42,15 +42,15 @@ export class AppCatalogsClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else if ('request' in options) {
       this.http = options.clone({
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else {
@@ -59,7 +59,7 @@ export class AppCatalogsClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
           ...options.headers,
         },
       });

packages/graph/src/appCatalogs/teamsApps/appDefinitions/bot.ts

@@ -45,15 +45,15 @@ export class BotClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else if ('request' in options) {
       this.http = options.clone({
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else {
@@ -62,7 +62,7 @@ export class BotClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
           ...options.headers,
         },
       });

packages/graph/src/appCatalogs/teamsApps/appDefinitions/index.ts

@@ -45,15 +45,15 @@ export class AppDefinitionsClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else if ('request' in options) {
       this.http = options.clone({
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else {
@@ -62,7 +62,7 @@ export class AppDefinitionsClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
           ...options.headers,
         },
       });

packages/graph/src/appCatalogs/teamsApps/index.ts

@@ -42,15 +42,15 @@ export class TeamsAppsClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else if ('request' in options) {
       this.http = options.clone({
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else {
@@ -59,7 +59,7 @@ export class TeamsAppsClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
           ...options.headers,
         },
       });

packages/graph/src/appRoleAssignments/checkMemberGroups.ts

@@ -44,15 +44,15 @@ export class CheckMemberGroupsClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else if ('request' in options) {
       this.http = options.clone({
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
         },
       });
     } else {
@@ -61,7 +61,7 @@ export class CheckMemberGroupsClient {
         baseUrl: 'https://graph.microsoft.com/v1.0',
         headers: {
           'Content-Type': 'application/json',
-          'User-Agent': `teams[graph]/${pkg.version}`,
+          'User-Agent': `spark[graph]/${pkg.version}`,
           ...options.headers,
         },
       });