-
Notifications
You must be signed in to change notification settings - Fork 390
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'develop' into epic/ssr-error-handling
- Loading branch information
Showing
23 changed files
with
396 additions
and
200 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| /** | ||
| * This script copies the feature-toggles.ts file from the Spartacus core project to schematics project. | ||
| */ | ||
|
|
||
| const fs = require('fs'); | ||
| const SOURCE = | ||
| '../../projects/core/src/features-config/feature-toggles/config/feature-toggles.ts'; | ||
| const DESTINATION = './src/feature-toggles.copied-from-core-lib.ts'; | ||
|
|
||
| fs.copyFileSync(SOURCE, DESTINATION); |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
113 changes: 113 additions & 0 deletions
113
projects/schematics/src/add-spartacus/spartacus-feature-toggles.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| /* | ||
| * SPDX-FileCopyrightText: 2024 SAP Spartacus team <[email protected]> | ||
| * | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| import { | ||
| Rule, | ||
| SchematicContext, | ||
| SchematicsException, | ||
| Tree, | ||
| } from '@angular-devkit/schematics'; | ||
| import { SourceFile } from 'ts-morph'; | ||
| import { | ||
| FEATURE_TOGGLES_COPIED_FROM_CORE_LIB_PATH, | ||
| PROVIDE_FEATURE_TOGGLES_FUNCTION, | ||
| SPARTACUS_CORE, | ||
| SPARTACUS_FEATURES_NG_MODULE, | ||
| addModuleProvider, | ||
| getProjectTsConfigPaths, | ||
| getSpartacusFeaturesModule, | ||
| saveAndFormat, | ||
| } from '../shared'; | ||
| import { Schema as SpartacusOptions } from './schema'; | ||
|
|
||
| export function addFeatureToggles(options: SpartacusOptions): Rule { | ||
| return (tree: Tree, context: SchematicContext): Tree => { | ||
| if (options.debug) { | ||
| context.logger.info(`⌛️ Adding Feature Toggles...`); | ||
| } | ||
|
|
||
| const { buildPaths } = getProjectTsConfigPaths(tree, options.project); | ||
|
|
||
| if (!buildPaths.length) { | ||
| throw new SchematicsException( | ||
| `Could not find any tsconfig file. Can't find ${SPARTACUS_FEATURES_NG_MODULE}.` | ||
| ); | ||
| } | ||
|
|
||
| const basePath = process.cwd(); | ||
| for (const tsconfigPath of buildPaths) { | ||
| const spartacusFeaturesModule = getSpartacusFeaturesModule( | ||
| tree, | ||
| basePath, | ||
| tsconfigPath | ||
| ); | ||
| if (spartacusFeaturesModule) { | ||
| _addFeatureToggles(spartacusFeaturesModule); | ||
| break; | ||
| } | ||
| } | ||
|
|
||
| if (options.debug) { | ||
| context.logger.info(`✅ Feature Toggles added.`); | ||
| } | ||
| return tree; | ||
| }; | ||
| } | ||
| /** | ||
| * Creates and adds a spartacus feature toggles with all of them enabled. | ||
| */ | ||
| function _addFeatureToggles(sourceFile: SourceFile): void { | ||
| const featureTogglesProvider = createFeatureTogglesProvider(); | ||
| addModuleProvider(sourceFile, { | ||
| import: [ | ||
| { | ||
| moduleSpecifier: SPARTACUS_CORE, | ||
| namedImports: [PROVIDE_FEATURE_TOGGLES_FUNCTION], | ||
| }, | ||
| ], | ||
| content: featureTogglesProvider, | ||
| }); | ||
|
|
||
| saveAndFormat(sourceFile); | ||
| } | ||
|
|
||
| /** | ||
| * Returns a provider for all existing feature toggles with value `true`. | ||
| */ | ||
| function createFeatureTogglesProvider(): string { | ||
| const defaultFeatureToggles = getDefaultFeatureToggles(); | ||
|
|
||
| //for each key in `defaultFeatureToggles` map it to a key with value true | ||
| const featureTogglesAllEnabled: Record<string, boolean> = Object.keys( | ||
| defaultFeatureToggles | ||
| ).reduce((acc, key) => ({ ...acc, [key]: true }), {}); | ||
| const featureTogglesString = JSON.stringify( | ||
| featureTogglesAllEnabled, | ||
| null, | ||
| 2 | ||
| ); | ||
| return `provideFeatureToggles(${featureTogglesString})`; | ||
| } | ||
|
|
||
| /** | ||
| * Retrieves Spartacus core library's default feature toggles. | ||
| * | ||
| * Note: A TypeScript file is copied to the schematics project in a pre-build step, | ||
| * from the core project, to prevent a runtime dependency on `@spartacus/core`. | ||
| * This file is then compiled into JavaScript and included with the schematics | ||
| * project's distribution, used at runtime. | ||
| * | ||
| * Due to the lazy nature of the NodeJS `require()` function, the TypeScript | ||
| * file may not appear in the schematics project's source code. | ||
| * | ||
| * For more, see the script `copy-feature-toggles` in the schematics's `package.json`. | ||
| */ | ||
| function getDefaultFeatureToggles(): Record<string, boolean> { | ||
| const { | ||
| defaultFeatureToggles, | ||
| } = require(FEATURE_TOGGLES_COPIED_FROM_CORE_LIB_PATH); | ||
| return defaultFeatureToggles; | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.