Rename helpers.js to googleDriveAdapterHelper.js

Rationale:
- More descriptive name indicates purpose (Google Drive adapter utilities)
- Distinguishes from generic 'helpers' (could apply to anything)
- Clearer intent when reading code and logs
- Follows convention of naming modules by their domain

Changes:
1. File renamed:
   - src/globalVariables/helpers.js → src/globalVariables/googleDriveAdapterHelper.js

2. Updated all references in proxy.js (6 occurrences):
   - helpers.generateRequestId() → googleDriveAdapterHelper.generateRequestId()
   - helpers.parseRoute() → googleDriveAdapterHelper.parseRoute()
   - helpers.DocumentCountExceededError → googleDriveAdapterHelper.DocumentCountExceededError()
   - helpers.generateSitemap() → googleDriveAdapterHelper.generateSitemap()
   - helpers.mapDriveErrorToHttp() → googleDriveAdapterHelper.mapDriveErrorToHttp()
   - Header comment updated

3. Updated constitution.md documentation:
   - All references to helpers.js → googleDriveAdapterHelper.js
   - globalVariableContext.helpers → globalVariableContext.googleDriveAdapterHelper
   - Function call examples updated throughout

Benefits:
 Self-documenting name (clear it's for Google Drive adapter)
 Better intellisense/autocomplete (shows domain)
 Clearer logs (googleDriveAdapterHelper vs generic helpers)
 Future-proof (can add other helper modules without confusion)

Generic Loading Pattern:
- server.js automatically loads all .js files from globalVariables/
- Filename determines key: googleDriveAdapterHelper.js → globalVariableContext.googleDriveAdapterHelper
- No server.js changes needed (generic loader handles it)

Testing:
✓ Syntax validated
✓ Server starts successfully
✓ Module loads: 'Loaded global functions: googleDriveAdapterHelper'
✓ All function calls work correctly

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
2026-03-07 11:46:06 -06:00
parent dd19104b70
commit 470f760b9b
3 changed files with 46 additions and 46 deletions

View File

@@ -16,7 +16,7 @@
* - uuidv4: UUID generator
* - jwt: JSON Web Token library
* - xmlBuilder: XML document builder
* - helpers: Helper functions module (loaded from globalVariables/helpers.js)
* - googleDriveAdapterHelper: Helper functions module (loaded from globalVariables/googleDriveAdapterHelper.js)
* - google_drive_settings: Consolidated settings (from global/google_drive_settings.json)
* - serviceAccount: Service account credentials
* - scopes: OAuth2 scopes array
@@ -147,7 +147,7 @@ async function queryDocuments(options = {}) {
// Check if we've exceeded the limit BEFORE fetching more
if (allFiles.length > maxDocuments) {
throw new helpers.DocumentCountExceededError(allFiles.length, maxDocuments);
throw new googleDriveAdapterHelper.DocumentCountExceededError(allFiles.length, maxDocuments);
}
pageToken = response.data.nextPageToken;
@@ -175,7 +175,7 @@ async function handleSitemapRequest(res, requestId) {
const query = settings.driveQuery || "trashed = false";
const documents = await queryDocuments({ query, maxDocuments: maxUrls });
const xml = helpers.generateSitemap(documents, settings.proxyScriptEndPoint);
const xml = googleDriveAdapterHelper.generateSitemap(documents, settings.proxyScriptEndPoint);
res.statusCode = 200;
res.setHeader("Content-Type", "application/xml; charset=utf-8");
@@ -185,7 +185,7 @@ async function handleSitemapRequest(res, requestId) {
console.info("Sitemap generated", { requestId, documentCount: documents.length });
} catch (error) {
const errorResponse = helpers.mapDriveErrorToHttp(error);
const errorResponse = googleDriveAdapterHelper.mapDriveErrorToHttp(error);
res.statusCode = errorResponse.statusCode;
if (errorResponse.retryAfter) {
res.setHeader("Retry-After", errorResponse.retryAfter.toString());
@@ -204,7 +204,7 @@ async function handleSitemapRequest(res, requestId) {
* Main HTTP request handler
*/
(async () => {
const requestId = helpers.generateRequestId();
const requestId = googleDriveAdapterHelper.generateRequestId();
const startTime = Date.now();
console.info("Request received", {
@@ -214,7 +214,7 @@ async function handleSitemapRequest(res, requestId) {
});
try {
const routeResult = helpers.parseRoute(req.method, req.url);
const routeResult = googleDriveAdapterHelper.parseRoute(req.method, req.url);
if (!routeResult.route) {
res.statusCode = routeResult.statusCode;