@ethlete/query 6.0.0-next.61 → 6.0.0-next.62

package/generators/migrate-from-ngrx-toolkit/consumers.js

@@ -365,7 +365,7 @@ export const rewriteConsumer = (tree, graph, filePath, content) => {
         tasks,
     };
 };
-const isInterceptor = (node, sourceFile) => {
+export const isInterceptor = (node, sourceFile) => {
     if (ts.isClassDeclaration(node)) {
         return !!node.heritageClauses?.some((clause) => clause.types.some((type) => type.expression.getText(sourceFile) === 'HttpInterceptor'));
     }

package/generators/migrate-to-query-v3/auth-consumers-migration.js

@@ -0,0 +1,64 @@
+import * as ts from 'typescript';
+import { isInterceptor } from '../migrate-from-ngrx-toolkit/consumers.js';
+import { createSourceFile } from './shared.js';
+const V2_AUTH_MEMBERS = new Set(['setAuthProvider', 'clearAuthProvider', 'authProvider$', 'isBearerAuthProvider']);
+const lineOf = (sourceFile, position) => sourceFile.getLineAndCharacterOfPosition(position).line + 1;
+/**
+ * Reports the code around a v2 auth setup that the migration does not rewrite: every use of the v2
+ * auth provider hooks, and every `HttpInterceptor` that sets an `Authorization` header.
+ *
+ * A v3 query already sends its bearer token, so an interceptor that adds one too sends it twice.
+ */
+export const reportAuthConsumers = (tree, scope, report) => {
+    scope.visit(tree, (filePath) => {
+        if (!filePath.endsWith('.ts') || filePath.endsWith('.spec.ts')) {
+            return;
+        }
+        const content = tree.read(filePath, 'utf-8');
+        if (!content) {
+            return;
+        }
+        const hasAuthMember = [...V2_AUTH_MEMBERS].some((name) => content.includes(name));
+        const hasInterceptor = /HttpInterceptor/.test(content) && /authorization|bearer/i.test(content);
+        if (!hasAuthMember && !hasInterceptor) {
+            return;
+        }
+        const sourceFile = createSourceFile(content, filePath);
+        const members = new Map();
+        const visit = (node) => {
+            if (isInterceptor(node, sourceFile) && /authorization|bearer/i.test(node.getText(sourceFile))) {
+                const name = node.name?.getText(sourceFile) ?? 'interceptor';
+                report.addManualReview({
+                    title: `Check the Authorization interceptor ${name}`,
+                    summary: `\`${name}\` adds an \`Authorization\` header. A v3 query sends its own bearer token, so a request from a migrated query that passes through this interceptor carries the header twice.`,
+                    action: 'Skip the requests of migrated clients in the interceptor, or remove the interceptor if the auth provider now covers every request.',
+                    locations: [{ filePath, line: lineOf(sourceFile, node.getStart(sourceFile)) }],
+                    source: 'auth-consumers-migration',
+                    dedupeKey: `auth-interceptor:${filePath}:${name}`,
+                });
+                return;
+            }
+            const memberName = ts.isPropertyAccessExpression(node) && ts.isIdentifier(node.name)
+                ? node.name.text
+                : ts.isIdentifier(node) && ts.isCallExpression(node.parent) && node.parent.expression === node
+                    ? node.text
+                    : undefined;
+            if (memberName && V2_AUTH_MEMBERS.has(memberName) && !members.has(memberName)) {
+                members.set(memberName, lineOf(sourceFile, node.getStart(sourceFile)));
+            }
+            ts.forEachChild(node, visit);
+        };
+        visit(sourceFile);
+        members.forEach((line, name) => {
+            report.addManualReview({
+                title: `Replace the v2 auth hook ${name}`,
+                summary: `\`${name}\` belongs to the v2 bearer auth setup. The migration leaves the call site as it is, and a v3 auth provider has no member of this name.`,
+                action: 'Use the v3 auth provider of the client instead: inject it with its inject function and call its methods (see the auth guide).',
+                locations: [{ filePath, line }],
+                source: 'auth-consumers-migration',
+                dedupeKey: `v2-auth-hook:${filePath}:${name}`,
+            });
+        });
+    });
+};
+//# sourceMappingURL=auth-consumers-migration.js.map

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

@@ -1,3 +1,4 @@
+import { dirname, join, relative } from 'node:path/posix';
 import * as ts from 'typescript';
 import { createSourceFile } from './shared.js';
 const REFRESH_CONFIG_KEYS = new Set([
@@ -43,7 +44,10 @@ const readConfig = (configArgument, sourceFile, filePath, node) => {
     const config = {
         filePath,
         line: sourceFile.getLineAndCharacterOfPosition(node.getStart(sourceFile)).line + 1,
+        copiedImports: [],
+        localNames: [],
     };
+    const copiedNodes = [];
     const refreshConfig = configArgument.properties.find((property) => ts.isPropertyAssignment(property) && ts.isIdentifier(property.name) && property.name.text === 'refreshConfig');
     if (!refreshConfig ||
         !ts.isPropertyAssignment(refreshConfig) ||
@@ -68,9 +72,88 @@ const readConfig = (configArgument, sourceFile, filePath, node) => {
             return;
         }
         config[key] = text;
+        copiedNodes.push(value);
     });
+    resolveCopiedNames(config, copiedNodes, sourceFile);
     return config;
 };
+const collectIdentifierNames = (node, names) => {
+    if (ts.isIdentifier(node)) {
+        const parent = node.parent;
+        const isMemberName = (ts.isPropertyAccessExpression(parent) && parent.name === node) ||
+            (ts.isPropertyAssignment(parent) && parent.name === node);
+        if (!isMemberName) {
+            names.add(node.text);
+        }
+    }
+    ts.forEachChild(node, (child) => collectIdentifierNames(child, names));
+};
+const resolveCopiedNames = (config, copiedNodes, sourceFile) => {
+    const used = new Set();
+    copiedNodes.forEach((node) => collectIdentifierNames(node, used));
+    const importedNames = new Set();
+    sourceFile.statements.forEach((statement) => {
+        if (!ts.isImportDeclaration(statement) || !ts.isStringLiteral(statement.moduleSpecifier)) {
+            return;
+        }
+        const clause = statement.importClause;
+        if (!clause || clause.isTypeOnly) {
+            return;
+        }
+        const names = [];
+        const defaultName = clause.name && used.has(clause.name.text) ? clause.name.text : undefined;
+        const namedBindings = clause.namedBindings;
+        let namedText;
+        if (defaultName)
+            names.push(defaultName);
+        if (namedBindings && ts.isNamespaceImport(namedBindings) && used.has(namedBindings.name.text)) {
+            names.push(namedBindings.name.text);
+            namedText = `* as ${namedBindings.name.text}`;
+        }
+        else if (namedBindings && ts.isNamedImports(namedBindings)) {
+            const elements = namedBindings.elements.filter((element) => !element.isTypeOnly && used.has(element.name.text));
+            elements.forEach((element) => names.push(element.name.text));
+            if (elements.length > 0) {
+                namedText = `{ ${elements.map((element) => element.getText(sourceFile)).join(', ')} }`;
+            }
+        }
+        if (names.length === 0) {
+            return;
+        }
+        names.forEach((name) => importedNames.add(name));
+        const bindings = [defaultName, namedText].filter(Boolean).join(', ');
+        config.copiedImports.push({
+            moduleSpecifier: statement.moduleSpecifier.text,
+            names,
+            statement: (moduleSpecifier) => `import ${bindings} from '${moduleSpecifier}';`,
+        });
+    });
+    sourceFile.statements.forEach((statement) => {
+        const declared = [];
+        if (ts.isVariableStatement(statement)) {
+            statement.declarationList.declarations.forEach((declaration) => {
+                if (ts.isIdentifier(declaration.name))
+                    declared.push(declaration.name.text);
+            });
+        }
+        else if ((ts.isFunctionDeclaration(statement) || ts.isClassDeclaration(statement)) && statement.name) {
+            declared.push(statement.name.text);
+        }
+        declared.forEach((name) => {
+            if (used.has(name) && !importedNames.has(name) && !config.localNames.includes(name)) {
+                config.localNames.push(name);
+            }
+        });
+    });
+};
+/** Re-points a relative specifier of the v2 file at the file that now holds the provider. */
+export const rebaseModuleSpecifier = (moduleSpecifier, fromFilePath, toFilePath) => {
+    if (!moduleSpecifier.startsWith('.')) {
+        return moduleSpecifier;
+    }
+    const rebased = relative(dirname(toFilePath), join(dirname(fromFilePath), moduleSpecifier));
+    return rebased.startsWith('.') ? rebased : `./${rebased}`;
+};
 const REFRESH_QUERY_KEY = 'tokenRefresh';
 /**
  * Renders the `queries` / `features` arguments of a v3 provider from a v2 config.
@@ -93,7 +176,7 @@ export const renderAuthProviderBody = (config) => {
     }
     const refreshEntries = [`      queryCreator: ${config.refreshCreatorName},`];
     if (config.responseAdapter) {
-        refreshEntries.push(`      // TODO(query-v3): v2 responseAdapter. It must return { accessToken, refreshToken } - v2 returned { token, refreshToken }.`, `      extractTokens: ${config.responseAdapter},`);
+        refreshEntries.push('      extractTokens: (response) => {', `        const { token, refreshToken } = (${config.responseAdapter})(response);`, '', '        return { accessToken: token, refreshToken };', '      },');
     }
     if (config.requestArgsAdapter) {
         refreshEntries.push(`      // TODO(query-v3): v2 requestArgsAdapter took { token, refreshToken }; buildArgs takes the refresh token alone.`, `      buildArgs: ${config.requestArgsAdapter},`);
@@ -111,6 +194,14 @@ export const renderAuthProviderBody = (config) => {
             action: 'If the cookie was only written after an opt-in (a "remember me" box), drive `setRememberMe()` from it. If it was never written, remove `withPersistentAuth` from the scaffold.',
         });
     }
+    refreshEntries.push('      retryConfig: { maxAttempts: 8 },');
+    if (config.cookieName && !config.cookieDomain) {
+        warnings.push({
+            title: 'Check the cookie host: v3 keeps the login cookie per host',
+            summary: 'The v2 provider set no `cookieDomain`. `withPersistentAuth` keys the cookie per origin, so a login does not reach a sibling host.',
+            action: 'If the app runs on more than one host, check that each host signs in on its own.',
+        });
+    }
     const queries = [
         '  queries: [',
         `    // Derived from the v2 BearerAuthProvider in ${config.filePath}:${config.line}. Verify before shipping.`,
@@ -139,6 +230,7 @@ export const renderAuthProviderBody = (config) => {
         '      cookie: {',
         ...cookieEntries,
         '      },',
+        '      defaultRememberMe: true,',
         '      autoLogin: {',
         `        queryKey: '${REFRESH_QUERY_KEY}',`,
         `        // TODO(query-v3): shape the auto-login request from the cookie value.`,

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

@@ -35,6 +35,15 @@ export const migrateDevtoolsUsage = (tree, scope, report) => {
     const updatedFiles = [];
     const filesNeedingDevtoolsPackage = [];
     scope.visit(tree, (filePath) => {
+        if (filePath.endsWith('.html')) {
+            const html = tree.read(filePath, 'utf-8');
+            const nextHtml = html && selectLazyDevtools(html);
+            if (nextHtml && nextHtml !== html) {
+                tree.write(filePath, nextHtml);
+                updatedFiles.push(filePath);
+            }
+            return;
+        }
         if (!filePath.endsWith('.ts')) {
             return;
         }
@@ -64,7 +73,7 @@ export const migrateDevtoolsUsage = (tree, scope, report) => {
         // `@ethlete/query-devtools`.
         report.addManualReview({
             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.',
+            summary: '`QueryDevtoolsComponent` is now `QueryDevtoolsLazyComponent` from `@ethlete/query-devtools/lazy`, and `<et-query-devtools>` is `<et-query-devtools-lazy>`. The imports and templates 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',
@@ -92,6 +101,27 @@ export const replaceAnyQueryWithLegacy = (tree, scope) => {
         console.log(`\n✅ Replaced legacy AnyV2Query aliases in ${updatedFiles.length} files`);
     }
 };
+export const reportLeftoverV2Clients = (tree, scope, report) => {
+    scope.visit(tree, (filePath) => {
+        if (!filePath.endsWith('.ts') || filePath.endsWith('.spec.ts')) {
+            return;
+        }
+        const content = tree.read(filePath, 'utf-8');
+        const index = content?.search(/new\s+V2QueryClient\s*[(<]/);
+        if (!content || index === undefined || index < 0) {
+            return;
+        }
+        const line = content.slice(0, index).split('\n').length;
+        report.addManualReview({
+            title: 'Migrator error: a V2QueryClient is left',
+            summary: 'The migration should leave no `V2QueryClient` behind, so it missed this client. Report this case as a migrator bug.',
+            action: 'Migrate the client by hand to `createQueryClient`, then report the shape the migration did not handle.',
+            locations: [{ filePath, line }],
+            source: 'cleanup-migration',
+            dedupeKey: `leftover-v2-client:${filePath}:${line}`,
+        });
+    });
+};
 export const migrateEmptyPrepareCalls = (tree, scope, report) => {
     const updatedFiles = [];
     const graph = createModuleGraph(tree);
@@ -123,6 +153,25 @@ export const migrateEmptyPrepareCalls = (tree, scope, report) => {
         console.log(`\n✅ Migrated empty .prepare() calls in ${updatedFiles.length} files`);
     }
 };
+const LAZY_DEVTOOLS_COMPONENT = 'QueryDevtoolsLazyComponent';
+const selectLazyDevtools = (content) => content.replace(/(<\/?)et-query-devtools(?![\w-])/g, '$1et-query-devtools-lazy');
+const renameIdentifiers = (content, names, replacement) => {
+    const sourceFile = createSourceFile(content);
+    const ranges = [];
+    const visit = (node) => {
+        if (ts.isImportDeclaration(node)) {
+            return;
+        }
+        if (ts.isIdentifier(node) && names.has(node.text)) {
+            ranges.push({ start: node.getStart(sourceFile), end: node.getEnd() });
+        }
+        ts.forEachChild(node, visit);
+    };
+    visit(sourceFile);
+    return ranges
+        .sort((left, right) => right.start - left.start)
+        .reduce((result, { start, end }) => result.slice(0, start) + replacement + result.slice(end), content);
+};
 const migrateDevtoolsInFile = (content) => {
     const componentNames = localNamesImportedFromQuery(content, 'QueryDevtoolsComponent');
     const providerNames = new Set([
@@ -136,10 +185,11 @@ const migrateDevtoolsInFile = (content) => {
         result = ensureImportFromQuery(result, ['provideQueryDevtools']);
     }
     if (componentNames.length > 0) {
+        result = selectLazyDevtools(renameIdentifiers(result, new Set(componentNames), LAZY_DEVTOOLS_COMPONENT));
         result = ensureNamedImports({
             content: result,
-            importsNeeded: componentNames.map((name) => name === 'QueryDevtoolsComponent' ? name : `QueryDevtoolsComponent as ${name}`),
-            moduleSpecifier: '@ethlete/query-devtools',
+            importsNeeded: [LAZY_DEVTOOLS_COMPONENT],
+            moduleSpecifier: '@ethlete/query-devtools/lazy',
         });
     }
     return { content: result, importsComponent: componentNames.length > 0 };
@@ -231,16 +281,25 @@ const dropLegacyDevtoolsImports = (content) => {
 const replaceAnyQueryInFile = (content) => {
     const sourceFile = createSourceFile(content);
     const replacements = [];
+    const names = new Set();
+    const collect = (node) => {
+        if (ts.isIdentifier(node))
+            names.add(node.text);
+        ts.forEachChild(node, collect);
+    };
+    collect(sourceFile);
+    const renamesQuery = !names.has('AnyLegacyQuery');
+    const renamesCreator = !names.has('AnyLegacyQueryCreator');
     const visit = (node) => {
         if (ts.isIdentifier(node)) {
-            if (node.text === 'AnyV2Query') {
+            if (renamesQuery && node.text === 'AnyV2Query') {
                 replacements.push({
                     start: node.getStart(sourceFile),
                     end: node.getEnd(),
                     replacement: 'AnyLegacyQuery',
                 });
             }
-            if (node.text === 'AnyV2QueryCreator') {
+            if (renamesCreator && node.text === 'AnyV2QueryCreator') {
                 replacements.push({
                     start: node.getStart(sourceFile),
                     end: node.getEnd(),