@google/clasp
Version:
Develop Apps Script Projects locally
71 lines (70 loc) • 3.17 kB
JavaScript
// Copyright 2025 Google LLC
//
// Licensed under the Apache License, Version 2.0 (the "License");
// you may not use this file except in compliance with the License.
// You may obtain a copy of the License at
//
// https://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
// See the License for the specific language governing permissions and
// limitations under the License.
// This file defines the `Logs` class, responsible for fetching log entries
// from Google Cloud Logging for the associated Apps Script project.
import Debug from 'debug';
import { google } from 'googleapis';
import { fetchWithPages } from './utils.js';
import { assertAuthenticated, assertGcpProjectConfigured, handleApiError } from './utils.js';
const debug = Debug('clasp:core');
/**
* Facilitates the retrieval of log entries from Google Cloud Logging
* for the Apps Script project associated with the current clasp project.
*/
export class Logs {
constructor(options) {
this.options = options;
}
/**
* Retrieves log entries from Google Cloud Logging for the configured GCP project.
* Logs are fetched in descending order of timestamp.
* @param {Date} [since] - Optional date to filter logs. Only entries with a timestamp
* greater than or equal to this date will be returned.
* @returns {Promise<{results: logging_v2.Schema$LogEntry[], partialResults: boolean} | undefined>}
* A promise that resolves to an object containing the log entries and a flag indicating
* if results are partial (due to pagination limits), or undefined if an error occurs.
* @throws {Error} If there's an API error or authentication/configuration issues.
*/
async getLogEntries(since) {
debug('Fetching logs');
assertAuthenticated(this.options);
assertGcpProjectConfigured(this.options);
const credentials = this.options.credentials;
const projectId = this.options.project.projectId;
const logger = google.logging({ version: 'v2', auth: credentials });
// Create a time filter (timestamp >= "2016-11-29T23:00:00Z")
// https://cloud.google.com/logging/docs/view/advanced-filters#search-by-time
const filter = since ? `timestamp >= "${since.toISOString()}"` : '';
try {
return fetchWithPages(async (pageSize, pageToken) => {
const res = await logger.entries.list({
requestBody: {
resourceNames: [`projects/${projectId}`],
filter,
orderBy: 'timestamp desc',
pageSize,
pageToken,
},
});
return {
results: res.data.entries || [],
nextPageToken: res.data.nextPageToken,
};
});
}
catch (error) {
handleApiError(error);
}
}
}