@ethlete/query 6.0.0-next.45 → 6.0.0-next.48

package/generators/migrate-query-opt-in-features/migration.js

@@ -8,6 +8,12 @@ const CLIENT_FEATURE = 'withEthleteApiErrors';
 const AUTH_FEATURE = 'withBearerAuthMultiTabSync';
 const isMigratableFile = (filePath) => /\.(ts|mts|cts)$/.test(filePath) && !filePath.endsWith('.d.ts');
 const propertyNamed = (config, sourceFile, name) => config.properties.find((property) => ts.isPropertyAssignment(property) && property.name.getText(sourceFile) === name);
+const hasFeature = (config, sourceFile, feature) => {
+    const features = propertyNamed(config, sourceFile, 'features')?.initializer;
+    return (!!features &&
+        ts.isArrayLiteralExpression(features) &&
+        features.elements.some((element) => ts.isCallExpression(element) && ts.isIdentifier(element.expression) && element.expression.text === feature));
+};
 /** `{ enabled: false, channelName: 'x' }` -> `withBearerAuthMultiTabSync({ channelName: 'x' })`, or `null` when off. */
 const authFeatureCallFor = (property, sourceFile) => {
     if (!property)
@@ -76,6 +82,9 @@ const collectEdits = (filePath, sourceFile, report) => {
                         dedupeKey: `spread-config:${callee}`,
                     });
                 }
+                else if (isClient && hasFeature(config, sourceFile, CLIENT_FEATURE)) {
+                    return;
+                }
                 else if (isClient) {
                     const feature = `${CLIENT_FEATURE}()`;
                     report.addFollowUp({
@@ -95,6 +104,9 @@ const collectEdits = (filePath, sourceFile, report) => {
                 }
                 else {
                     const syncProperty = propertyNamed(config, sourceFile, 'multiTabSync');
+                    const alreadyAdded = hasFeature(config, sourceFile, AUTH_FEATURE);
+                    if (alreadyAdded && !syncProperty)
+                        return;
                     const value = syncProperty?.initializer;
                     if (value &&
                         value.kind !== ts.SyntaxKind.TrueKeyword &&
@@ -109,7 +121,7 @@ const collectEdits = (filePath, sourceFile, report) => {
                             dedupeKey: 'non-literal-multi-tab-sync',
                         });
                     }
-                    const feature = authFeatureCallFor(syncProperty, sourceFile);
+                    const feature = alreadyAdded ? null : authFeatureCallFor(syncProperty, sourceFile);
                     if (feature) {
                         report.addFollowUp({
                             title: 'Auth provider kept multi-tab sync',

package/generators/migrate-to-query-v3/auth-provider-scaffold.js

@@ -47,17 +47,19 @@ const readConfig = (configArgument, sourceFile, filePath, node) => {
         return config;
     }
     refreshConfig.initializer.properties.forEach((property) => {
-        if (!ts.isPropertyAssignment(property) || !ts.isIdentifier(property.name)) {
+        const isShorthand = ts.isShorthandPropertyAssignment(property);
+        if ((!ts.isPropertyAssignment(property) && !isShorthand) || !ts.isIdentifier(property.name)) {
             return;
         }
         const key = property.name.text;
         if (!REFRESH_CONFIG_KEYS.has(key)) {
             return;
         }
-        const text = property.initializer.getText(sourceFile);
+        const value = isShorthand ? property.name : property.initializer;
+        const text = value.getText(sourceFile);
         if (key === 'queryCreator') {
-            if (ts.isIdentifier(property.initializer)) {
-                config.refreshCreatorName = property.initializer.text;
+            if (ts.isIdentifier(value)) {
+                config.refreshCreatorName = value.text;
             }
             return;
         }

package/generators/migrate-to-query-v3/cleanup-migration.js

@@ -1,5 +1,5 @@
 import * as ts from 'typescript';
-import { createSourceFile, ensureImportFromQuery, ensureNamedImports, getLineNumberFromPosition } from './shared.js';
+import { createSourceFile, ensureImportFromQuery, ensureNamedImports } from './shared.js';
 /**
  * Points existing devtools usage at the v3 components instead of deleting it.
  *
@@ -10,7 +10,7 @@ import { createSourceFile, ensureImportFromQuery, ensureNamedImports, getLineNum
  */
 export const migrateDevtoolsUsage = (tree, scope, report) => {
     const updatedFiles = [];
-    const filesNeedingComponentsPackage = [];
+    const filesNeedingDevtoolsPackage = [];
     scope.visit(tree, (filePath) => {
         if (!filePath.endsWith('.ts')) {
             return;
@@ -27,7 +27,7 @@ export const migrateDevtoolsUsage = (tree, scope, report) => {
         tree.write(filePath, nextContent);
         updatedFiles.push(filePath);
         if (importsComponent) {
-            filesNeedingComponentsPackage.push(filePath);
+            filesNeedingDevtoolsPackage.push(filePath);
         }
     });
     if (updatedFiles.length === 0) {
@@ -35,16 +35,17 @@ export const migrateDevtoolsUsage = (tree, scope, report) => {
     }
     console.log('\n✅ Migrated query devtools usage to v3 in:');
     updatedFiles.forEach((filePath) => console.log(`   - ${filePath}`));
-    if (filesNeedingComponentsPackage.length > 0) {
+    if (filesNeedingDevtoolsPackage.length > 0) {
         // The component moved packages, which is the one part of this rewrite that can fail outside the
-        // file being edited: an app that only ever depended on `@ethlete/query` now needs `@ethlete/components`.
+        // file being edited: an app that only ever depended on `@ethlete/query` now needs
+        // `@ethlete/query-devtools`.
         report.addManualReview({
-            title: 'Add @ethlete/components for the query devtools',
-            summary: '`QueryDevtoolsComponent` now lives in `@ethlete/components`. The imports were rewritten, but the package may not be a dependency of these projects yet.',
-            action: 'Run `yarn add @ethlete/components` where needed, then `yarn install` and re-lint the affected libs so the `@nx/dependency-checks` rule sees the new dependency.',
-            locations: filesNeedingComponentsPackage.map((filePath) => ({ filePath })),
+            title: 'Add @ethlete/query-devtools for the query devtools',
+            summary: '`QueryDevtoolsComponent` now lives in `@ethlete/query-devtools`. The imports were rewritten, but the package may not be a dependency of these projects yet.',
+            action: 'Run `yarn add @ethlete/query-devtools` where needed, then `yarn install` and re-lint the affected libs so the `@nx/dependency-checks` rule sees the new dependency.',
+            locations: filesNeedingDevtoolsPackage.map((filePath) => ({ filePath })),
             source: 'cleanup-migration',
-            dedupeKey: 'devtools-components-dependency',
+            dedupeKey: 'devtools-package-dependency',
         });
     }
 };
@@ -100,7 +101,7 @@ const migrateDevtoolsInFile = (content) => {
         result = ensureNamedImports({
             content: result,
             importsNeeded: ['QueryDevtoolsComponent'],
-            moduleSpecifier: '@ethlete/components',
+            moduleSpecifier: '@ethlete/query-devtools',
         });
     }
     return { content: result, importsComponent };
@@ -221,43 +222,7 @@ const replaceAnyQueryInFile = (content) => {
     replacements.forEach(({ start, end, replacement }) => {
         result = result.slice(0, start) + replacement + result.slice(end);
     });
-    return removeAnyQueryFromImports(result);
-};
-const removeAnyQueryFromImports = (content) => {
-    const sourceFile = createSourceFile(content);
-    let importNode;
-    ts.forEachChild(sourceFile, (node) => {
-        if (ts.isImportDeclaration(node) &&
-            ts.isStringLiteral(node.moduleSpecifier) &&
-            node.moduleSpecifier.text === '@ethlete/query') {
-            importNode = node;
-        }
-    });
-    if (!importNode?.importClause?.namedBindings || !ts.isNamedImports(importNode.importClause.namedBindings)) {
-        return content;
-    }
-    const replaced = new Map([
-        ['AnyV2Query', 'AnyLegacyQuery'],
-        ['AnyV2QueryCreator', 'AnyLegacyQueryCreator'],
-    ]);
-    const names = new Set();
-    let changed = false;
-    importNode.importClause.namedBindings.elements.forEach((element) => {
-        const replacement = replaced.get(element.name.text);
-        if (!replacement) {
-            names.add(element.getText(sourceFile));
-            return;
-        }
-        // Only add the alias that was actually imported. Adding both unconditionally is what put
-        // `AnyLegacyQuery` / `AnyLegacyQueryCreator` into hundreds of files that never referenced them.
-        changed = true;
-        names.add(replacement);
-    });
-    if (!changed) {
-        return content;
-    }
-    const nextImport = `import { ${Array.from(names).sort().join(', ')} } from '@ethlete/query';`;
-    return content.slice(0, importNode.getStart(sourceFile)) + nextImport + content.slice(importNode.getEnd());
+    return result;
 };
 const transformEmptyPrepareCalls = (content) => {
     const sourceFile = createSourceFile(content);
@@ -286,8 +251,4 @@ const transformEmptyPrepareCalls = (content) => {
     });
     return result;
 };
-export const describeTemplateLine = (content, position, suffix) => {
-    const lineNumber = getLineNumberFromPosition(content, position);
-    return `${lineNumber} (${suffix})`;
-};
 //# sourceMappingURL=cleanup-migration.js.map

package/generators/migrate-to-query-v3/legacy-prepare-migration.js

@@ -1,5 +1,8 @@
 import * as ts from 'typescript';
 import { createSourceFile, ensureAngularCoreImports, getIndentation, getLineNumber, getLineNumberFromPosition, } from './shared.js';
+/** `default` can never be a class name, so it cannot collide with a named class of the same file. */
+const ANONYMOUS_DEFAULT_CLASS_KEY = 'default';
+const getClassKey = (node) => node.name?.text ?? ANONYMOUS_DEFAULT_CLASS_KEY;
 /** Contexts that already have an injector of their own, so the call site needs no rewrite. */
 const CONTEXTS_WITH_INJECTOR = [
     'queryComputed',
@@ -265,7 +268,7 @@ const findClassesNeedingInjector = (sourceFile, usages) => {
     const filePath = usages[0]?.filePath ?? sourceFile.fileName;
     const visit = (node) => {
         if (ts.isClassDeclaration(node)) {
-            const className = node.name?.text ?? 'UnnamedClass';
+            const className = getClassKey(node);
             const usagesInClass = usages.filter((usage) => {
                 return usage.position.start >= node.getStart(sourceFile) && usage.position.end <= node.getEnd();
             });
@@ -331,7 +334,7 @@ const addInjectorMemberToClass = (content, classInfo) => {
     const sourceFile = createSourceFile(content);
     let targetClass;
     const visit = (node) => {
-        if (ts.isClassDeclaration(node) && node.name?.text === classInfo.className) {
+        if (ts.isClassDeclaration(node) && getClassKey(node) === classInfo.className) {
             targetClass = node;
         }
         ts.forEachChild(node, visit);
@@ -342,7 +345,7 @@ const addInjectorMemberToClass = (content, classInfo) => {
     }
     const classBodyStart = targetClass.members.length > 0 ? targetClass.members[0].getStart(sourceFile) : targetClass.getEnd() - 1;
     const indentation = getIndentation(content, classBodyStart);
-    const injectorMember = `${indentation}private ${classInfo.injectorMemberName} = inject(Injector);\n\n`;
+    const injectorMember = `private ${classInfo.injectorMemberName} = inject(Injector);\n\n${indentation}`;
     return content.slice(0, classBodyStart) + injectorMember + content.slice(classBodyStart);
 };
 const transformLegacyCreatorPrepareCalls = (tree, classInjectors, pollingInfo, scope) => {
@@ -412,12 +415,7 @@ const transformPrepareCallsInFile = (content, classes, pollingInfo) => {
                 const containingClass = findContainingClass(node);
                 const containingFunction = findContainingStandaloneFunction(node);
                 if (containingClass) {
-                    const className = containingClass.name?.text;
-                    if (!className) {
-                        ts.forEachChild(node, visit);
-                        return;
-                    }
-                    const injectorMember = classNameToInjector.get(className);
+                    const injectorMember = classNameToInjector.get(getClassKey(containingClass));
                     if (!injectorMember) {
                         ts.forEachChild(node, visit);
                         return;
@@ -481,7 +479,7 @@ const transformPrepareCallsInFile = (content, classes, pollingInfo) => {
         }
         injectorDeclarations.push({
             position: bodyStart,
-            text: `${getIndentation(content, bodyStart)}const ${injectorName} = inject(Injector);\n`,
+            text: `const ${injectorName} = inject(Injector);\n${getIndentation(content, bodyStart)}`,
         });
     });
     injectorDeclarations.sort((left, right) => right.position - left.position);
@@ -779,8 +777,7 @@ const getQueryVariableName = (expression) => {
             return currentExpression.text;
         }
         if (ts.isPropertyAccessExpression(currentExpression)) {
-            currentExpression = currentExpression.expression;
-            continue;
+            return currentExpression.name.text;
         }
         if (ts.isCallExpression(currentExpression)) {
             currentExpression = currentExpression.expression;

package/generators/migrate-to-query-v3/legacy-query-creator-migration.js

@@ -10,6 +10,7 @@ const LEGACY_HTTP_METHOD = {
     PATCH: 'patch',
     DELETE: 'delete',
 };
+const HTTP_OPTION_NAMES = ['reportProgress', 'responseType', 'transferCache', 'withCredentials'];
 const isLegacyHttpMethod = (value) => {
     return Object.values(LEGACY_HTTP_METHOD).includes(value);
 };
@@ -85,6 +86,7 @@ export const updateLegacyCreatorImportsAndUsages = (tree, scope, report) => {
     }
     console.log(`\n✅ Found ${legacyCreators.size} legacy query creator wrappers`);
     const moduleGraph = createModuleGraph(tree);
+    const pendingWrites = new Map();
     scope.visit(tree, (filePath) => {
         if (!filePath.endsWith('.ts') || filePath.endsWith('.spec.ts')) {
             return;
@@ -101,10 +103,14 @@ export const updateLegacyCreatorImportsAndUsages = (tree, scope, report) => {
             report,
         });
         if (nextContent !== content) {
-            tree.write(filePath, nextContent);
-            updatedFiles.push(filePath);
+            pendingWrites.set(filePath, nextContent);
         }
     });
+    // Writing a barrel mid-pass would hide its original re-exports from consumers visited after it.
+    pendingWrites.forEach((nextContent, filePath) => {
+        tree.write(filePath, nextContent);
+        updatedFiles.push(filePath);
+    });
     if (updatedFiles.length > 0) {
         console.log('\n✅ Updated legacy creator imports and usages in:');
         updatedFiles.forEach((filePath) => console.log(`   - ${filePath}`));
@@ -226,17 +232,62 @@ const analyzeLegacyQueryCreators = (content, queryClientFiles, filePath, report)
                 secure: false,
                 httpOptions: new Map(),
             };
+            const warnUnreadableConfigValue = (property, passedAs) => {
+                const propertyName = property.name.getText(sourceFile);
+                report.addWarning({
+                    title: `Carry over \`${propertyName}\` of ${creatorName}`,
+                    summary: `${creatorName} passes \`${propertyName}\` ${passedAs} in its v2 config. The migration cannot read its value, so it was not carried over to the v3 creator.`,
+                    action: propertyName === 'secure'
+                        ? 'If the value is true, switch the generated creator to the matching *Secure creator of the client by hand.'
+                        : 'Move what it configures onto the generated creator by hand.',
+                    locations: [
+                        { filePath, line: sourceFile.getLineAndCharacterOfPosition(property.getStart(sourceFile)).line + 1 },
+                    ],
+                    source: 'legacy-query-creator-migration',
+                    dedupeKey: `unreadable-config:${filePath}:${creatorName}:${propertyName}`,
+                });
+            };
             const configObject = node.initializer.arguments[0];
             if (configObject && ts.isObjectLiteralExpression(configObject)) {
                 configObject.properties.forEach((property) => {
+                    if (ts.isSpreadAssignment(property)) {
+                        report.addWarning({
+                            title: `Restore the spread config of ${creatorName}`,
+                            summary: `${creatorName} spreads \`${property.expression.getText(sourceFile)}\` into its v2 config. The migration cannot see what it contains, so none of it was carried over to the v3 creator.`,
+                            action: 'Move the route, secure flag, types and http options it provides onto the generated creator by hand.',
+                            locations: [
+                                { filePath, line: sourceFile.getLineAndCharacterOfPosition(property.getStart(sourceFile)).line + 1 },
+                            ],
+                            source: 'legacy-query-creator-migration',
+                            dedupeKey: `spread-config:${filePath}:${creatorName}`,
+                        });
+                        return;
+                    }
+                    if (ts.isShorthandPropertyAssignment(property)) {
+                        if (property.name.text === 'route') {
+                            info.route = property.name.text;
+                        }
+                        if (HTTP_OPTION_NAMES.includes(property.name.text)) {
+                            info.httpOptions.set(property.name.text, property.name.text);
+                        }
+                        if (property.name.text !== 'route' && !HTTP_OPTION_NAMES.includes(property.name.text)) {
+                            warnUnreadableConfigValue(property, 'as a shorthand property');
+                        }
+                        return;
+                    }
                     if (!ts.isPropertyAssignment(property) || !ts.isIdentifier(property.name)) {
                         return;
                     }
                     if (property.name.text === 'route') {
                         info.route = property.initializer.getText(sourceFile);
                     }
-                    if (property.name.text === 'secure' && property.initializer.kind === ts.SyntaxKind.TrueKeyword) {
-                        info.secure = true;
+                    if (property.name.text === 'secure') {
+                        if (property.initializer.kind === ts.SyntaxKind.TrueKeyword) {
+                            info.secure = true;
+                        }
+                        else if (property.initializer.kind !== ts.SyntaxKind.FalseKeyword) {
+                            warnUnreadableConfigValue(property, 'with a value that is not a literal');
+                        }
                     }
                     if (property.name.text === 'types' && ts.isObjectLiteralExpression(property.initializer)) {
                         property.initializer.properties.forEach((typeProperty) => {
@@ -271,7 +322,7 @@ const analyzeLegacyQueryCreators = (content, queryClientFiles, filePath, report)
                             }
                         });
                     }
-                    if (['reportProgress', 'responseType', 'transferCache', 'withCredentials'].includes(property.name.text)) {
+                    if (HTTP_OPTION_NAMES.includes(property.name.text)) {
                         info.httpOptions.set(property.name.text, property.initializer.getText(sourceFile));
                     }
                 });
@@ -303,27 +354,42 @@ const transformLegacyQueryCreators = (content, legacyCreators) => {
         }
         creatorsByClient.get(creator.clientName).push(creator);
     });
+    const wrappersByStatement = new Map();
     legacyCreators.forEach((creator) => {
-        const nextCreator = generateNewQueryCreator(creator);
-        const legacyWrapper = generateLegacyWrapper(creator);
         let variableStatement;
+        let declaration;
         const visit = (node) => {
+            if (variableStatement)
+                return;
             if (ts.isVariableStatement(node)) {
-                const declaration = node.declarationList.declarations[0];
-                if (declaration && ts.isIdentifier(declaration.name) && declaration.name.text === creator.name) {
+                declaration = node.declarationList.declarations.find((candidate) => ts.isIdentifier(candidate.name) && candidate.name.text === creator.name);
+                if (declaration) {
                     variableStatement = node;
+                    return;
                 }
             }
             ts.forEachChild(node, visit);
         };
         visit(sourceFile);
-        if (variableStatement) {
+        if (!variableStatement || !declaration)
+            return;
+        const isTopLevel = ts.isSourceFile(variableStatement.parent);
+        const exportPrefix = isTopLevel ? 'export ' : '';
+        const nextCreator = `${creator.name} = ${generateNewQueryCreator(creator)}`;
+        const legacyWrapper = generateLegacyWrapper(creator, exportPrefix);
+        if (variableStatement.declarationList.declarations.length === 1) {
             replacements.push({
                 start: variableStatement.getStart(sourceFile),
                 end: variableStatement.getEnd(),
-                replacement: `${nextCreator}\n${legacyWrapper}`,
+                replacement: `${exportPrefix}const ${nextCreator};\n${legacyWrapper}`,
             });
+            return;
         }
+        replacements.push({ start: declaration.getStart(sourceFile), end: declaration.getEnd(), replacement: nextCreator });
+        wrappersByStatement.set(variableStatement, [...(wrappersByStatement.get(variableStatement) ?? []), legacyWrapper]);
+    });
+    wrappersByStatement.forEach((wrappers, statement) => {
+        replacements.push({ start: statement.getEnd(), end: statement.getEnd(), replacement: `\n${wrappers.join('\n')}` });
     });
     let result = content;
     replacements.sort((left, right) => right.start - left.start);
@@ -334,7 +400,7 @@ const transformLegacyQueryCreators = (content, legacyCreators) => {
     result = addCreatorImports(result, creatorsByClient);
     // The rewritten creators no longer go through `def<T>()` or the v2 client object, so whatever is
     // left over from those constructs would land as a lint error the moment `formatFiles` runs.
-    return pruneUnusedNamedImports(result, 'all');
+    return pruneUnusedNamedImports(result);
 };
 const addCreatorImports = (content, creatorsByClient) => {
     const sourceFile = createSourceFile(content);
@@ -412,7 +478,7 @@ const generateNewQueryCreator = (creator) => {
     const typeParameter = getTypeParameter(creator);
     const options = Array.from(creator.httpOptions.entries()).map(([key, value]) => `${key}: ${value}`);
     const optionsBlock = options.length > 0 ? `, {\n  ${options.join(',\n  ')}\n}` : '';
-    return `export const ${creator.name} = ${creatorFunction}${typeParameter}(${creator.route}${optionsBlock});`;
+    return `${creatorFunction}${typeParameter}(${creator.route}${optionsBlock})`;
 };
 const getTypeParameter = (creator) => {
     if (creator.typeArgs && (creator.typeBody || creator.typeResponse)) {
@@ -440,10 +506,10 @@ const getTypeParameter = (creator) => {
     }
     return '';
 };
-const generateLegacyWrapper = (creator) => {
+const generateLegacyWrapper = (creator, exportPrefix) => {
     // `name` is what lets a `prepare()` called outside an injection context name itself in the error
     // instead of surfacing as a bare NG0203.
-    return `/**\n * ${legacyQueryDeprecationTag(creator.name)}\n */\nexport const ${toLegacyName(creator.name)} = createLegacyQueryCreator({ name: '${toLegacyName(creator.name)}', creator: ${creator.name} });`;
+    return `/**\n * ${legacyQueryDeprecationTag(creator.name)}\n */\n${exportPrefix}const ${toLegacyName(creator.name)} = createLegacyQueryCreator({ name: '${toLegacyName(creator.name)}', creator: ${creator.name} });`;
 };
 const createAuthProviders = ({ tree, authProvidersNeeded, report, v2Configs, creatorToClient, }) => {
     const createdProviders = [];

package/generators/migrate-to-query-v3/migration-scope.js

@@ -23,18 +23,15 @@ export const createMigrationScope = (tree, options) => {
     if (roots.length === 0) {
         return {
             visit: (targetTree, callback) => visitNotIgnoredFiles(targetTree, '', callback),
-            includes: () => true,
             describe: () => 'the whole workspace',
         };
     }
-    const includes = (filePath) => roots.some((root) => filePath === root || filePath.startsWith(`${root}/`));
     return {
         visit: (targetTree, callback) => {
             for (const root of roots) {
                 visitNotIgnoredFiles(targetTree, root, callback);
             }
         },
-        includes,
         describe: () => roots.join(', '),
     };
 };