@pnp/cli-microsoft365 7.5.0-beta.940b241 → 7.5.0-beta.c0c1edf

package/dist/m365/spo/commands/spo-search.js

@@ -38,16 +38,15 @@ class SpoSearchCommand extends SpoCommand {
             if (this.verbose) {
                 await logger.logToStderr(`Executing search query '${args.options.queryText}' on site at ${webUrl}...`);
             }
-            const startRow = args.options.startRow ? args.options.startRow : 0;
-            const results = await this.executeSearchQuery(logger, args, webUrl, [], startRow);
+            const results = await this.executeSearchQuery(logger, args, webUrl, []);
             this.printResults(logger, args, results);
         }
         catch (err) {
             this.handleRejectedODataJsonPromise(err);
         }
     }
-    async executeSearchQuery(logger, args, webUrl, resultSet, startRow) {
-        const requestUrl = await this.getRequestUrl(webUrl, logger, args, startRow);
+    async executeSearchQuery(logger, args, webUrl, resultSet, lastDocId = '0') {
+        const requestUrl = await this.getRequestUrl(webUrl, logger, args, lastDocId);
         const requestOptions = {
             url: requestUrl,
             headers: {
@@ -57,26 +56,36 @@ class SpoSearchCommand extends SpoCommand {
         };
         const searchResult = await request.get(requestOptions);
         resultSet.push(searchResult);
-        if (args.options.allResults && startRow + searchResult.PrimaryQueryResult.RelevantResults.RowCount < searchResult.PrimaryQueryResult.RelevantResults.TotalRows) {
-            const nextStartRow = startRow + searchResult.PrimaryQueryResult.RelevantResults.RowCount;
-            return this.executeSearchQuery(logger, args, webUrl, resultSet, nextStartRow);
+        const rowLimit = args.options.rowLimit ? args.options.rowLimit : 500;
+        if (args.options.allResults && searchResult.PrimaryQueryResult.RelevantResults.RowCount === rowLimit) {
+            if (this.verbose) {
+                await logger.logToStderr(`Processing search query, retrieved ${resultSet.length * searchResult.PrimaryQueryResult.RelevantResults.RowCount} of ${resultSet[0].PrimaryQueryResult.RelevantResults.TotalRows} items...`);
+            }
+            // When running in allResults mode, paging is done using the DocId property
+            // This is a more stable way than using the StartRow property.
+            // Explanation: https://learn.microsoft.com/sharepoint/dev/general-development/pagination-for-large-result-sets
+            const lastRow = searchResult.PrimaryQueryResult.RelevantResults.Table.Rows[searchResult.PrimaryQueryResult.RelevantResults.RowCount - 1];
+            const newLastDocId = lastRow.Cells.filter(cell => cell.Key === 'DocId')[0].Value;
+            return this.executeSearchQuery(logger, args, webUrl, resultSet, newLastDocId);
         }
         return resultSet;
     }
-    async getRequestUrl(webUrl, logger, args, startRow) {
+    async getRequestUrl(webUrl, logger, args, lastDocId) {
         // get the list of selected properties
         const selectPropertiesArray = this.getSelectPropertiesArray(args);
+        // get the sort list
+        const sortList = this.getSortList(args);
         // transform arg data to query string parameters
-        const propertySelectRequestString = `&selectproperties='${formatting.encodeQueryParameter(selectPropertiesArray.join(","))}'`;
-        const startRowRequestString = `&startrow=${startRow ? startRow : 0}`;
-        const rowLimitRequestString = args.options.rowLimit ? `&rowlimit=${args.options.rowLimit}` : ``;
+        const propertySelectRequestString = `&selectproperties='${formatting.encodeQueryParameter(selectPropertiesArray.join(','))}'`;
+        const startRowRequestString = `&startrow=${args.options.startRow ? args.options.startRow : 0}`;
+        const rowLimitRequestString = args.options.rowLimit ? `&rowlimit=${args.options.rowLimit}` : (args.options.allResults ? `&rowlimit=500` : '');
         const sourceIdRequestString = args.options.sourceId ? `&sourceid='${args.options.sourceId}'` : ``;
-        const trimDuplicatesRequestString = `&trimduplicates=${args.options.trimDuplicates ? args.options.trimDuplicates : "false"}`;
-        const enableStemmingRequestString = `&enablestemming=${typeof (args.options.enableStemming) === 'undefined' ? "true" : args.options.enableStemming}`;
+        const trimDuplicatesRequestString = `&trimduplicates=${args.options.trimDuplicates ? args.options.trimDuplicates : 'false'}`;
+        const enableStemmingRequestString = `&enablestemming=${typeof (args.options.enableStemming) === 'undefined' ? 'true' : args.options.enableStemming}`;
         const cultureRequestString = args.options.culture ? `&culture=${args.options.culture}` : ``;
         const refinementFiltersRequestString = args.options.refinementFilters ? `&refinementfilters='${args.options.refinementFilters}'` : ``;
         const queryTemplateRequestString = args.options.queryTemplate ? `&querytemplate='${args.options.queryTemplate}'` : ``;
-        const sortListRequestString = args.options.sortList ? `&sortList='${formatting.encodeQueryParameter(args.options.sortList)}'` : ``;
+        const sortListRequestString = sortList ? `&sortList='${sortList}'` : ``;
         const rankingModelIdRequestString = args.options.rankingModelId ? `&rankingmodelid='${args.options.rankingModelId}'` : ``;
         const propertiesRequestString = this.getPropertiesRequestString(args);
         const refinersRequestString = args.options.refiners ? `&refiners='${args.options.refiners}'` : ``;
@@ -86,8 +95,9 @@ class SpoSearchCommand extends SpoCommand {
         const processBestBetsRequestString = typeof (args.options.processBestBets) === 'undefined' ? `` : `&processbestbets=${args.options.processBestBets}`;
         const enableQueryRulesRequestString = typeof (args.options.enableQueryRules) === 'undefined' ? `` : `&enablequeryrules=${args.options.enableQueryRules}`;
         const processPersonalFavoritesRequestString = typeof (args.options.processPersonalFavorites) === 'undefined' ? `` : `&processpersonalfavorites=${args.options.processPersonalFavorites}`;
+        const indexDocIdQueryText = args.options.allResults ? ` IndexDocId>${lastDocId}` : '';
         // construct single requestUrl
-        const requestUrl = `${webUrl}/_api/search/query?querytext='${args.options.queryText}'`.concat(propertySelectRequestString, startRowRequestString, rowLimitRequestString, sourceIdRequestString, trimDuplicatesRequestString, enableStemmingRequestString, cultureRequestString, refinementFiltersRequestString, queryTemplateRequestString, sortListRequestString, rankingModelIdRequestString, propertiesRequestString, refinersRequestString, hiddenConstraintsRequestString, clientTypeRequestString, enablePhoneticRequestString, processBestBetsRequestString, enableQueryRulesRequestString, processPersonalFavoritesRequestString);
+        const requestUrl = `${webUrl}/_api/search/query?querytext='${args.options.queryText}${indexDocIdQueryText}'`.concat(propertySelectRequestString, startRowRequestString, rowLimitRequestString, sourceIdRequestString, trimDuplicatesRequestString, enableStemmingRequestString, cultureRequestString, refinementFiltersRequestString, queryTemplateRequestString, sortListRequestString, rankingModelIdRequestString, propertiesRequestString, refinersRequestString, hiddenConstraintsRequestString, clientTypeRequestString, enablePhoneticRequestString, processBestBetsRequestString, enableQueryRulesRequestString, processPersonalFavoritesRequestString);
         if (this.debug) {
             await logger.logToStderr(`RequestURL: ${requestUrl}`);
         }
@@ -96,7 +106,7 @@ class SpoSearchCommand extends SpoCommand {
     getPropertiesRequestString(args) {
         let properties = args.options.properties ? args.options.properties : '';
         if (args.options.sourceName) {
-            if (properties && !properties.endsWith(",")) {
+            if (properties && !properties.endsWith(',')) {
                 properties += `,`;
             }
             properties += `SourceName:${args.options.sourceName},SourceLevel:SPSite`;
@@ -104,9 +114,26 @@ class SpoSearchCommand extends SpoCommand {
         return properties ? `&properties='${properties}'` : ``;
     }
     getSelectPropertiesArray(args) {
-        return args.options.selectProperties
-            ? args.options.selectProperties.split(",")
-            : ["Title", "OriginalPath"];
+        const selectProperties = args.options.selectProperties
+            ? args.options.selectProperties.split(',')
+            : ['Title', 'OriginalPath'];
+        if (args.options.allResults) {
+            selectProperties.filter(p => p.toLowerCase() !== 'docid').push('DocId');
+        }
+        return selectProperties;
+    }
+    getSortList(args) {
+        const sortList = [];
+        if (args.options.allResults) {
+            sortList.push(formatting.encodeQueryParameter('[DocId]:ascending'));
+        }
+        if (args.options.sortList) {
+            const sortListArray = args.options.sortList.split(',');
+            sortListArray.forEach(sortItem => {
+                sortList.push(formatting.encodeQueryParameter(sortItem));
+            });
+        }
+        return sortList.join(',');
     }
     async printResults(logger, args, results) {
         if (args.options.rawOutput) {
@@ -116,9 +143,9 @@ class SpoSearchCommand extends SpoCommand {
             await logger.log(this.getParsedOutput(args, results));
         }
         if (!args.options.output || cli.shouldTrimOutput(args.options.output)) {
-            await logger.log("# Rows: " + results[results.length - 1].PrimaryQueryResult.RelevantResults.TotalRows);
-            await logger.log("# Rows (Including duplicates): " + results[results.length - 1].PrimaryQueryResult.RelevantResults.TotalRowsIncludingDuplicates);
-            await logger.log("Elapsed Time: " + this.getElapsedTime(results));
+            await logger.log('# Rows: ' + results[results.length - 1].PrimaryQueryResult.RelevantResults.TotalRows);
+            await logger.log('# Rows (Including duplicates): ' + results[results.length - 1].PrimaryQueryResult.RelevantResults.TotalRowsIncludingDuplicates);
+            await logger.log('Elapsed Time: ' + this.getElapsedTime(results));
         }
     }
     getElapsedTime(results) {
@@ -245,6 +272,9 @@ _SpoSearchCommand_instances = new WeakSet(), _SpoSearchCommand_initTelemetry = f
         if (args.options.startRow && !isNumber(args.options.startRow)) {
             return `${args.options.startRow} is not a valid number`;
         }
+        if (args.options.startRow && args.options.allResults) {
+            return 'You cannot specify startRow when allResults is set';
+        }
         if (args.options.culture && !isNumber(args.options.culture)) {
             return `${args.options.culture} is not a valid number`;
         }

package/docs/docs/cmd/spo/spo-search.mdx

@@ -25,7 +25,7 @@ m365 spo search [options]
 : The web against which we want to execute the query. If the parameter is not defined, the query is executed against the web that's used when logging in to the SPO environment.
 
 `--allResults`
-: Set, to get all results of the search query, instead of the number specified by the `rowlimit` (default: 10)
+: Set, to get all results of the search query in batches of 500.
 
 `--rowLimit [rowLimit]`
 : The number of rows to be returned. When the `allResults` option is used, the specified value will define the size of retrieved batches
@@ -55,7 +55,7 @@ m365 spo search [options]
 : The ID of the ranking model to use for the query.
 
 `--startRow [startRow]`
-: The first row that is included in the search results that are returned. You use this parameter when you want to implement paging for search results.
+: The first row that is included in the search results that are returned. You use this parameter when you want to implement manual paging for search results.
 
 `--properties [properties]`
 : Additional properties for the query.
@@ -90,6 +90,10 @@ m365 spo search [options]
 
 <Global />
 
+## Remarks
+
+When using the `--allResults` option, you cannot use the `--startRow` option. Only use `--startRow` for manual paging purposes.
+
 ## Examples
 
 Execute search query to retrieve all Document Sets (ContentTypeId = _0x0120D520_) for the English locale

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pnp/cli-microsoft365",
-  "version": "7.5.0-beta.940b241",
+  "version": "7.5.0-beta.c0c1edf",
   "description": "Manage Microsoft 365 and SharePoint Framework projects on any platform",
   "license": "MIT",
   "main": "./dist/api.js",