@atlaskit/teams-client 4.32.0 → 4.32.1

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @atlaskit/teams-client
 
+## 4.32.1
+
+### Patch Changes
+
+- [`a45dd5a6666e8`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/a45dd5a6666e8) -
+  Fix invalid ARI being sent in X-Query-Context header when cloudId is unavailable. Previously, an
+  uninitialised cloudId defaulted to the string 'None', causing requests to include a malformed
+  header value of `ari:cloud:platform::site/None`. The client now defaults to an empty string so no
+  header is sent until a valid cloudId is set.
+
 ## 4.32.0
 
 ### Minor Changes

package/dist/cjs/services/base-client/index.js

@@ -8,6 +8,7 @@ exports.BaseClient = void 0;
 var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime/helpers/classCallCheck"));
 var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/createClass"));
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _sentry = require("../sentry");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -22,14 +23,14 @@ var BaseClient = exports.BaseClient = /*#__PURE__*/function () {
     });
     this.config = config;
     this.context = {
-      cloudId: 'None'
+      cloudId: (0, _platformFeatureFlags.fg)('teams-app_client_fix-invalid-ari') ? '' : 'None'
     };
   }
   return (0, _createClass2.default)(BaseClient, [{
     key: "setContext",
     value: function setContext(context) {
       this.context = _objectSpread(_objectSpread({}, context), {}, {
-        cloudId: context.cloudId || 'None'
+        cloudId: (0, _platformFeatureFlags.fg)('teams-app_client_fix-invalid-ari') ? context.cloudId || '' : context.cloudId || 'None'
       });
     }
   }, {

package/dist/cjs/services/graphql-client/main.js

@@ -13,6 +13,7 @@ var _createClass2 = _interopRequireDefault(require("@babel/runtime/helpers/creat
 var _possibleConstructorReturn2 = _interopRequireDefault(require("@babel/runtime/helpers/possibleConstructorReturn"));
 var _getPrototypeOf2 = _interopRequireDefault(require("@babel/runtime/helpers/getPrototypeOf"));
 var _inherits2 = _interopRequireDefault(require("@babel/runtime/helpers/inherits"));
+var _platformFeatureFlags = require("@atlaskit/platform-feature-flags");
 var _error = require("../../common/utils/error");
 var _baseClient = require("../base-client");
 var _utils = require("./utils");
@@ -20,6 +21,24 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = (0, _getPrototypeOf2.default)(o), (0, _possibleConstructorReturn2.default)(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], (0, _getPrototypeOf2.default)(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+/**
+ * Validates that a siteId (cloudId) conforms to the format expected by
+ * PlatformSiteAri from `@atlassian/ari/platform`.
+ *
+ * We inline this instead of importing `@atlassian/ari` because that package
+ * is private and `teams-client` is a public package - public packages cannot
+ * depend on private packages.
+ *
+ * The regex matches the `resourceIdSegmentFormats.siteId` rule from the
+ * PlatformSiteAri manifest: `/[a-zA-Z0-9_\-.]{1,255}/`
+ */
+var SITE_ID_PATTERN = /^[a-zA-Z0-9_\-.]{1,255}$/;
+function createPlatformSiteAri(siteId) {
+  if (!SITE_ID_PATTERN.test(siteId)) {
+    throw new Error("Invalid siteId: ".concat(siteId));
+  }
+  return "ari:cloud:platform::site/".concat(siteId);
+}
 var BaseGraphQlClient = exports.BaseGraphQlClient = /*#__PURE__*/function (_BaseClient) {
   function BaseGraphQlClient(serviceUrl, config) {
     var _this;
@@ -36,7 +55,10 @@ var BaseGraphQlClient = exports.BaseGraphQlClient = /*#__PURE__*/function (_Base
     }
 
     /**
-     * Creates query context headers if cloudId is available.
+     * Creates query context headers if cloudId is available and valid.
+     * When the fix-invalid-ari flag is enabled, validates the cloudId before
+     * constructing the ARI, preventing invalid ARIs like
+     * `ari:cloud:platform::site/None` from being sent.
      */
   }, {
     key: "createQueryContextHeaders",
@@ -44,6 +66,16 @@ var BaseGraphQlClient = exports.BaseGraphQlClient = /*#__PURE__*/function (_Base
       if (!cloudId) {
         return undefined;
       }
+      if ((0, _platformFeatureFlags.fg)('teams-app_client_fix-invalid-ari')) {
+        try {
+          var ari = createPlatformSiteAri(cloudId);
+          return {
+            'X-Query-Context': ari
+          };
+        } catch (_unused) {
+          return undefined;
+        }
+      }
       return {
         'X-Query-Context': "ari:cloud:platform::site/".concat(cloudId)
       };

package/dist/es2019/services/base-client/index.js

@@ -1,4 +1,5 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
+import { fg } from '@atlaskit/platform-feature-flags';
 import { logException } from '../sentry';
 export class BaseClient {
   constructor(config) {
@@ -9,13 +10,13 @@ export class BaseClient {
     });
     this.config = config;
     this.context = {
-      cloudId: 'None'
+      cloudId: fg('teams-app_client_fix-invalid-ari') ? '' : 'None'
     };
   }
   setContext(context) {
     this.context = {
       ...context,
-      cloudId: context.cloudId || 'None'
+      cloudId: fg('teams-app_client_fix-invalid-ari') ? context.cloudId || '' : context.cloudId || 'None'
     };
   }
   getContext() {

package/dist/es2019/services/graphql-client/main.js

@@ -1,6 +1,26 @@
+import { fg } from '@atlaskit/platform-feature-flags';
 import { DefaultError, GraphQLError } from '../../common/utils/error';
 import { BaseClient } from '../base-client';
 import { handleGraphQLRequest } from './utils';
+
+/**
+ * Validates that a siteId (cloudId) conforms to the format expected by
+ * PlatformSiteAri from `@atlassian/ari/platform`.
+ *
+ * We inline this instead of importing `@atlassian/ari` because that package
+ * is private and `teams-client` is a public package - public packages cannot
+ * depend on private packages.
+ *
+ * The regex matches the `resourceIdSegmentFormats.siteId` rule from the
+ * PlatformSiteAri manifest: `/[a-zA-Z0-9_\-.]{1,255}/`
+ */
+const SITE_ID_PATTERN = /^[a-zA-Z0-9_\-.]{1,255}$/;
+function createPlatformSiteAri(siteId) {
+  if (!SITE_ID_PATTERN.test(siteId)) {
+    throw new Error(`Invalid siteId: ${siteId}`);
+  }
+  return `ari:cloud:platform::site/${siteId}`;
+}
 export class BaseGraphQlClient extends BaseClient {
   constructor(serviceUrl, config) {
     super(config);
@@ -11,12 +31,25 @@ export class BaseGraphQlClient extends BaseClient {
   }
 
   /**
-   * Creates query context headers if cloudId is available.
+   * Creates query context headers if cloudId is available and valid.
+   * When the fix-invalid-ari flag is enabled, validates the cloudId before
+   * constructing the ARI, preventing invalid ARIs like
+   * `ari:cloud:platform::site/None` from being sent.
    */
   createQueryContextHeaders(cloudId) {
     if (!cloudId) {
       return undefined;
     }
+    if (fg('teams-app_client_fix-invalid-ari')) {
+      try {
+        const ari = createPlatformSiteAri(cloudId);
+        return {
+          'X-Query-Context': ari
+        };
+      } catch {
+        return undefined;
+      }
+    }
     return {
       'X-Query-Context': `ari:cloud:platform::site/${cloudId}`
     };

package/dist/esm/services/base-client/index.js

@@ -3,6 +3,7 @@ import _createClass from "@babel/runtime/helpers/createClass";
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { fg } from '@atlaskit/platform-feature-flags';
 import { logException } from '../sentry';
 export var BaseClient = /*#__PURE__*/function () {
   function BaseClient(config) {
@@ -15,14 +16,14 @@ export var BaseClient = /*#__PURE__*/function () {
     });
     this.config = config;
     this.context = {
-      cloudId: 'None'
+      cloudId: fg('teams-app_client_fix-invalid-ari') ? '' : 'None'
     };
   }
   return _createClass(BaseClient, [{
     key: "setContext",
     value: function setContext(context) {
       this.context = _objectSpread(_objectSpread({}, context), {}, {
-        cloudId: context.cloudId || 'None'
+        cloudId: fg('teams-app_client_fix-invalid-ari') ? context.cloudId || '' : context.cloudId || 'None'
       });
     }
   }, {

package/dist/esm/services/graphql-client/main.js

@@ -10,9 +10,29 @@ function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbol
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 function _callSuper(t, o, e) { return o = _getPrototypeOf(o), _possibleConstructorReturn(t, _isNativeReflectConstruct() ? Reflect.construct(o, e || [], _getPrototypeOf(t).constructor) : o.apply(t, e)); }
 function _isNativeReflectConstruct() { try { var t = !Boolean.prototype.valueOf.call(Reflect.construct(Boolean, [], function () {})); } catch (t) {} return (_isNativeReflectConstruct = function _isNativeReflectConstruct() { return !!t; })(); }
+import { fg } from '@atlaskit/platform-feature-flags';
 import { DefaultError, GraphQLError } from '../../common/utils/error';
 import { BaseClient } from '../base-client';
 import { handleGraphQLRequest } from './utils';
+
+/**
+ * Validates that a siteId (cloudId) conforms to the format expected by
+ * PlatformSiteAri from `@atlassian/ari/platform`.
+ *
+ * We inline this instead of importing `@atlassian/ari` because that package
+ * is private and `teams-client` is a public package - public packages cannot
+ * depend on private packages.
+ *
+ * The regex matches the `resourceIdSegmentFormats.siteId` rule from the
+ * PlatformSiteAri manifest: `/[a-zA-Z0-9_\-.]{1,255}/`
+ */
+var SITE_ID_PATTERN = /^[a-zA-Z0-9_\-.]{1,255}$/;
+function createPlatformSiteAri(siteId) {
+  if (!SITE_ID_PATTERN.test(siteId)) {
+    throw new Error("Invalid siteId: ".concat(siteId));
+  }
+  return "ari:cloud:platform::site/".concat(siteId);
+}
 export var BaseGraphQlClient = /*#__PURE__*/function (_BaseClient) {
   function BaseGraphQlClient(serviceUrl, config) {
     var _this;
@@ -29,7 +49,10 @@ export var BaseGraphQlClient = /*#__PURE__*/function (_BaseClient) {
     }
 
     /**
-     * Creates query context headers if cloudId is available.
+     * Creates query context headers if cloudId is available and valid.
+     * When the fix-invalid-ari flag is enabled, validates the cloudId before
+     * constructing the ARI, preventing invalid ARIs like
+     * `ari:cloud:platform::site/None` from being sent.
      */
   }, {
     key: "createQueryContextHeaders",
@@ -37,6 +60,16 @@ export var BaseGraphQlClient = /*#__PURE__*/function (_BaseClient) {
       if (!cloudId) {
         return undefined;
       }
+      if (fg('teams-app_client_fix-invalid-ari')) {
+        try {
+          var ari = createPlatformSiteAri(cloudId);
+          return {
+            'X-Query-Context': ari
+          };
+        } catch (_unused) {
+          return undefined;
+        }
+      }
       return {
         'X-Query-Context': "ari:cloud:platform::site/".concat(cloudId)
       };

package/dist/types/services/graphql-client/main.d.ts

@@ -5,7 +5,10 @@ export declare class BaseGraphQlClient extends BaseClient {
     constructor(serviceUrl: string, config: ClientConfig);
     setServiceUrl(serviceUrl: string): void;
     /**
-     * Creates query context headers if cloudId is available.
+     * Creates query context headers if cloudId is available and valid.
+     * When the fix-invalid-ari flag is enabled, validates the cloudId before
+     * constructing the ARI, preventing invalid ARIs like
+     * `ari:cloud:platform::site/None` from being sent.
      */
     private createQueryContextHeaders;
     makeGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(body: Body<Variables>, options?: Options): Promise<ResultResponse<Key, Data>>;

package/dist/types-ts4.5/services/graphql-client/main.d.ts

@@ -5,7 +5,10 @@ export declare class BaseGraphQlClient extends BaseClient {
     constructor(serviceUrl: string, config: ClientConfig);
     setServiceUrl(serviceUrl: string): void;
     /**
-     * Creates query context headers if cloudId is available.
+     * Creates query context headers if cloudId is available and valid.
+     * When the fix-invalid-ari flag is enabled, validates the cloudId before
+     * constructing the ARI, preventing invalid ARIs like
+     * `ari:cloud:platform::site/None` from being sent.
      */
     private createQueryContextHeaders;
     makeGraphQLRequest<Key extends string, Data = unknown, Variables = unknown>(body: Body<Variables>, options?: Options): Promise<ResultResponse<Key, Data>>;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/teams-client",
-	"version": "4.32.0",
+	"version": "4.32.1",
 	"description": "A client to retrieve team related data",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -93,6 +93,9 @@
 	"platform-feature-flags": {
 		"enable_edit_team_name_external_type_teams": {
 			"type": "boolean"
+		},
+		"teams-app_client_fix-invalid-ari": {
+			"type": "boolean"
 		}
 	}
 }