@atlaskit/eslint-plugin-platform 2.6.0 → 2.7.1

package/src/rules/feature-gating/no-alias/index.tsx

@@ -1,80 +0,0 @@
-import type { Rule } from 'eslint';
-import {
-	FEATURE_API_IMPORT_SOURCES,
-	FEATURE_MOCKS_IMPORT_SOURCES,
-	FEATURE_UTILS_IMPORT_SOURCES,
-} from '../../constants';
-import { isIdentifierImportedFrom, type Node } from '../utils';
-
-const IMPORT_SOURCES = new Set([
-	...FEATURE_API_IMPORT_SOURCES,
-	...FEATURE_MOCKS_IMPORT_SOURCES,
-	...FEATURE_UTILS_IMPORT_SOURCES,
-]);
-
-const rule: Rule.RuleModule = {
-	meta: {
-		docs: {
-			url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/no-alias/README.md',
-			description:
-				'Disallow aliasing of feature flag utils to ensure feature flag usage is statically analyzable',
-		},
-		messages: {
-			noSpecifierAlias:
-				'Do not alias feature flag utils. Feature flag usage should be statically analyzable',
-			noNamespaceSpecifier:
-				'Destructure feature flag utils from import. Feature flag usage should be statically analyzable',
-			noReassignment:
-				'Do not reassign feature flag utils. Feature flag usage should be statically analyzable',
-		},
-	},
-	create(context) {
-		return {
-			ImportDeclaration: (node) => {
-				if (typeof node.source.value === 'string' && !IMPORT_SOURCES.has(node.source.value)) {
-					return;
-				}
-
-				node.specifiers?.forEach((specifier) => {
-					if (specifier.type === 'ImportSpecifier') {
-						const { imported, local } = specifier;
-
-						if (imported.name !== local.name) {
-							context.report({
-								messageId: 'noSpecifierAlias',
-								node: specifier,
-							});
-						}
-					} else if (specifier.type === 'ImportNamespaceSpecifier') {
-						context.report({
-							messageId: 'noNamespaceSpecifier',
-							node: specifier,
-						});
-					}
-				});
-			},
-			'VariableDeclaration[kind="const"] > VariableDeclarator[id.type="Identifier"][init.type="Identifier"]':
-				(node: Node<'VariableDeclarator'>) => {
-					if (!node.init || node.init.type !== 'Identifier') {
-						return;
-					}
-
-					const isReassignment = isIdentifierImportedFrom(
-						node.init.name,
-						IMPORT_SOURCES,
-						context,
-						node,
-					);
-
-					if (isReassignment) {
-						context.report({
-							messageId: 'noReassignment',
-							node,
-						});
-					}
-				},
-		};
-	},
-};
-
-export default rule;

package/src/rules/feature-gating/no-module-level-eval/README.md

@@ -1,53 +0,0 @@
-# Avoid using feature flags at module level (feature-flags/no-module-level-eval)
-
-Disallow usage of feature flags in global/module scope. Due to JFE using SSR, feature flags should
-not be called/initialised before components have mounted as it could cause errors.
-
-## Examples
-
-👎 Examples of **incorrect** code for this rule: ff is called in module scope
-
-```tsx
-import { ff } from '@atlassian/jira-feature-flagging';
-import { OldComponent } from './old';
-import { NewComponent } from './new';
-
-const isEnabled = ff('is_enabled');
-
-export const Component = ff('is_redesign') ? NewComponent : OldComponent;
-```
-
-👍 Examples of **correct** code to feature flag components: use ComponentWithFF
-
-```tsx
-import { ff } from '@atlassian/jira-feature-flagging';
-import { ComponentWithFF } from '@atlassian/jira-feature-flagging-utils';
-
-export const Container = () => {
-	const isEnabled = ff('is_enabled');
-};
-
-export const Component = ComponentWithFF('is_redesign', NewComponent, OldComponent);
-```
-
-👍 Examples of **correct** code to feature flag functions: use functionWithCondition
-
-```tsx
-import { ff } from '@atlassian/jira-feature-flagging';
-import { functionWithCondition } from '@atlassian/jira-feature-flagging-utils';
-
-const selectorOld = createSelector(
-	permissionsSelector,
-	(permissions: Permissions): boolean => permissions.canCreateChildren,
-);
-
-// Change the signature of the selector by adding new arguments
-const selectorNew = createSelector(
-	permissionsSelector,
-	supportedChildIssueTypesSelector,
-	(permissions: Permissions, supportedChildIssueTypes: IssueTypeForHierarchyLevel[]): boolean =>
-		permissions.canCreateChildren && !!supportedChildIssueTypes.length,
-);
-
-export const selector = functionWithCondition(() => ff('is_enabled'), selectorNew, selectorOld);
-```

package/src/rules/feature-gating/no-module-level-eval/__tests__/test.tsx

@@ -1,133 +0,0 @@
-import outdent from 'outdent';
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../index';
-
-tester.run('feature-flags/no-module-level-eval', rule, {
-	valid: [
-		{
-			name: 'Variable declaration within arrow function',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                const Component = () => {
-                    const ff1 = ff('flag');
-                }
-            `,
-		},
-		{
-			name: 'Boolean within arrow function',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                const someFunction = () => {
-                    if(ff('flag')) {
-                        return true;
-                    }
-                }
-            `,
-		},
-		{
-			name: 'Immediate call within a function',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                function someFunction() {
-                    return ff('flag');
-                }
-            `,
-		},
-
-		{
-			name: 'Does not affect other function calls in global scope',
-			code: outdent`
-                import { foo } from 'foo-lib'
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                foo();
-            `,
-		},
-		{
-			name: 'Variable declaration within an arrow function with different import source',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging-using-meta';
-
-                const Component = () => {
-                    const ff1 = ff('flag');
-                }
-            `,
-		},
-		{
-			name: 'Class field',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                export class Component {
-                    value = ff('flag') ? 'newValue' : 'oldValue';
-                }
-            `,
-		},
-	],
-	invalid: [
-		{
-			name: 'Immediate call',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                ff('flag');
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Module level storage into a variable',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                const flag = ff('flag');
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Module level collection',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                const collection = [ff('flag') ? 0 : 1];
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Module level object',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-
-                const object = {
-                    isEnabled: ff('flag')
-                }
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Module level with boolean',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging';
-                import { NewComp } from 'new';
-                import { OldComp } from 'old';
-
-                export const Component = ff('flag') ? NewComp : OldComp;
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		// This test fails unsure what the environment difference is between Jira + Platform.
-		// {
-		// 	name: 'Static class field',
-		// 	code: outdent`
-		//             import { ff } from '@atlassian/jira-feature-flagging';
-
-		//             export class Component {
-		//                 static value = ff('flag') ? 'newValue' : 'oldValue';
-		//             }
-		//         `,
-		// 	errors: [{ messageId: 'noModuleLevelEval' }],
-		// },
-	],
-});

package/src/rules/feature-gating/no-module-level-eval/index.tsx

@@ -1,54 +0,0 @@
-import type { Rule } from 'eslint';
-import type { Node } from 'estree';
-import { isAPIimport } from '../utils';
-import { getScope } from '../../util/context-compat';
-
-const isInFunctionLevel = (context: Rule.RuleContext, node: Node) => {
-	let scope: any = getScope(context, node);
-
-	while (scope?.type !== 'module' && scope?.type !== 'global') {
-		if (scope.type === 'function') {
-			return true;
-		}
-
-		if (scope.type === 'class-field-initializer') {
-			return !scope.block.parent.static;
-		}
-
-		scope = scope.upper;
-	}
-
-	return false;
-};
-
-const rule: Rule.RuleModule = {
-	meta: {
-		docs: {
-			description: 'Disallow feature flag usage at module level',
-			url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/no-module-level-eval/README.md',
-		},
-		messages: {
-			noModuleLevelEval:
-				'Do not evaluate feature flags in the module level, it will always resolve to false when server side rendered or when flags are loaded async.',
-		},
-	},
-	create(context) {
-		return {
-			'CallExpression[callee.type="Identifier"]': (node: Node) => {
-				if (
-					node.type === 'CallExpression' &&
-					node.callee.type === 'Identifier' &&
-					isAPIimport(node.callee.name, context, node) &&
-					!isInFunctionLevel(context, node)
-				) {
-					context.report({
-						messageId: 'noModuleLevelEval',
-						node,
-					});
-				}
-			},
-		};
-	},
-};
-
-export default rule;

package/src/rules/feature-gating/no-module-level-eval-nav4/README.md

@@ -1,8 +0,0 @@
-# Avoid using navigation/visual refresh feature flag functions at module level (feature-flags/no-module-level-eval-nav4)
-
-Disallow usage of navigation/visual refresh feature flag functions in global/module scope. Due to
-JFE using SSR, feature flags should not be called/initialised before components have mounted as it
-could cause errors.
-
-This is a temporary lint rule cloned from no-module-level-nav4 while we explore pulling these
-evaluations inline https://atlassian.slack.com/archives/CFGLH1ZS8/p1726449739284819

package/src/rules/feature-gating/no-module-level-eval-nav4/__tests__/test.tsx

@@ -1,130 +0,0 @@
-import outdent from 'outdent';
-import { tester } from '../../../../__tests__/utils/_tester';
-import rule from '../index';
-
-tester.run('feature-flags/no-module-level-eval', rule, {
-	valid: [
-		{
-			name: 'Variable declaration within arrow function',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                const Component = () => {
-                    const ff1 = getWillShowNav4();
-                }
-            `,
-		},
-		{
-			name: 'Boolean within arrow function',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                const someFunction = () => {
-                    if(getWillShowNav4()) {
-                        return true;
-                    }
-                }
-            `,
-		},
-		{
-			name: 'Immediate call within a function',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                function someFunction() {
-                    return getWillShowNav4();
-                }
-            `,
-		},
-
-		{
-			name: 'Does not affect other function calls in global scope',
-			code: outdent`
-                import { foo } from 'foo-lib'
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                foo();
-            `,
-		},
-		{
-			name: 'Variable declaration within an arrow function with different import source',
-			code: outdent`
-                import { ff } from '@atlassian/jira-feature-flagging-using-meta';
-
-                const Component = () => {
-                    const ff1 = getWillShowNav4();
-                }
-            `,
-		},
-		{
-			name: 'Class field',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                export class Component {
-                    value = getWillShowNav4() ? 'newValue' : 'oldValue';
-                }
-            `,
-		},
-	],
-	invalid: [
-		{
-			name: 'Immediate call',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                getWillShowNav4();
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Immediate call isVisualRefreshEnabled',
-			code: outdent`
-				import { isVisualRefreshEnabled } from '@atlassian/jira-visual-refresh-rollout/src/feature-switch';
-
-                isVisualRefreshEnabled();
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Module level storage into a variable',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                const flag = getWillShowNav4();
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Module level collection',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                const collection = [getWillShowNav4() ? 0 : 1];
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Module level object',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-
-                const object = {
-                    isEnabled: getWillShowNav4()
-                }
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-		{
-			name: 'Module level with boolean',
-			code: outdent`
-                import { getWillShowNav4 } from '@atlassian/jira-navigation-apps-sidebar-nav4-rollout';
-                import { NewComp } from 'new';
-                import { OldComp } from 'old';
-
-                export const Component = getWillShowNav4() ? NewComp : OldComp;
-            `,
-			errors: [{ messageId: 'noModuleLevelEval' }],
-		},
-	],
-});

package/src/rules/feature-gating/no-module-level-eval-nav4/index.tsx

@@ -1,73 +0,0 @@
-import type { Rule } from 'eslint';
-import type { Node } from 'estree';
-import { getScope } from '../../util/context-compat';
-
-const featureLibraryFunctions = new Set([
-	/*
-	 * STOP!
-	 *
-	 * Your code should call the API functions directly!
-	 * But, we are temporarily adding these methods to prevent SSR builds from breaking
-	 * while we work out a solution for the features to be evaluated inline.
-	 * Do not add anything here without the permission of #help-jfp-squads
-	 *
-	 * Slack thread: https://atlassian.slack.com/archives/CFGLH1ZS8/p1726449739284819
-	 */
-	'isVisualRefreshEnabled',
-	'getMetaBoolean',
-	'getNav4Rollout',
-	'getWillShowNav3',
-	'getWillShowNav4',
-	'getWillShowNav4UserOptIn',
-	'getWillShowNav4UserOptOut',
-]);
-
-const isInFunctionLevel = (context: Rule.RuleContext, node: Node) => {
-	let scope: any = getScope(context, node);
-
-	while (scope?.type !== 'module' && scope?.type !== 'global') {
-		if (scope.type === 'function') {
-			return true;
-		}
-
-		if (scope.type === 'class-field-initializer') {
-			return !scope.block.parent.static;
-		}
-
-		scope = scope.upper;
-	}
-
-	return false;
-};
-
-const rule: Rule.RuleModule = {
-	meta: {
-		docs: {
-			description: 'Disallow getWillShowNav4 or isVisualRefreshEnabled usage at module level',
-			url: 'https://stash.atlassian.com/projects/ATLASSIAN/repos/atlassian-frontend-monorepo/browse/platform/packages/platform/eslint-plugin/src/rules/no-module-level-eval-nav4/README.md',
-		},
-		messages: {
-			noModuleLevelEval:
-				'Do not evaluate getWillShowNav4 or isVisualRefreshEnabled at module level. This causes complications with SSR. If feature flagging components in `jira` use `componentWithCondition` from `@atlassian/jira-feature-flagging-utils`.',
-		},
-	},
-	create(context) {
-		return {
-			'CallExpression[callee.type="Identifier"]': (node: Node) => {
-				if (
-					node.type === 'CallExpression' &&
-					node.callee.type === 'Identifier' &&
-					featureLibraryFunctions.has(node.callee.name) &&
-					!isInFunctionLevel(context, node)
-				) {
-					context.report({
-						messageId: 'noModuleLevelEval',
-						node,
-					});
-				}
-			},
-		};
-	},
-};
-
-export default rule;

package/src/rules/feature-gating/no-preconditioning/README.md

@@ -1,69 +0,0 @@
-# Enforce feature gate not used as a precondition in logical expressions (feature-flags/no-preconditioning)
-
-Using a feature gate as a precondition in logical expressions can cause:
-
-- Exposure to be tracked incorrectly
-- Unnecessary code
-
-## Examples
-
-Instead of adding prerequisite gating in code, configure this in Statsig UI by adding rules to gates
-and targeting for experiments. This will reduce unnecessary complexity in code and simplify cleanup.
-
-```tsx
-import { fg } from '@atlassian/jira-feature-gating';
-import { expVal } from '@atlassian/jira-feature-experiments';
-
-// Setup rule in `feature_milestone2` to fail if `feature_milestone1` fails
-if (fg('feature_milestone1') && fg('feature_milestone2')) {
-	doSomething();
-}
-
-// Setup targeting in `my_exp` to only enroll participants passing `my_gate`
-if (fg('my_gate') && expVal('my_exp')) {
-	doSomething();
-}
-```
-
-Gating experiment values from same or different experiments is valid.
-
-```tsx
-import { expVal } from '@atlassian/jira-feature-experiments';
-
-if (expVal('my_exp', 'delayRetries', false) && expVal('my_exp', 'numRetries', 0) > 3) {
-	doSomething();
-}
-```
-
-👎 Examples of **incorrect** exposure tracking
-
-If `isAdmin` is false exposure will be fired even though feature was not intended for audience.
-
-```tsx
-import { fg } from '@atlassian/jira-feature-gating';
-
-if (fg('my_gate') && isAdmin) {
-	doSomething();
-}
-```
-
-If `hasSelectedProject` is false and experiment returns true. Expsoure will be tracked as true even
-though feature was not exposed to the user.
-
-```tsx
-import { fg } from '@atlassian/jira-feature-gating';
-
-if (expVal('my_experiment', 'is_enabled', false) && hasSelectedProject) {
-	doSomething();
-}
-```
-
-👍 Examples of **correct** exposure tracking
-
-```tsx
-import { fg } from '@atlassian/jira-feature-gating';
-
-if (isAdmin && fg('my_gate')) {
-	doSomething();
-}
-```