@salesforce/source-tracking
Version:
API for tracking local and remote Salesforce metadata changes
137 lines • 6.36 kB
JavaScript
;
var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
var desc = Object.getOwnPropertyDescriptor(m, k);
if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
desc = { enumerable: true, get: function() { return m[k]; } };
}
Object.defineProperty(o, k2, desc);
}) : (function(o, m, k, k2) {
if (k2 === undefined) k2 = k;
o[k2] = m[k];
}));
var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
Object.defineProperty(o, "default", { enumerable: true, value: v });
}) : function(o, v) {
o["default"] = v;
});
var __importStar = (this && this.__importStar) || (function () {
var ownKeys = function(o) {
ownKeys = Object.getOwnPropertyNames || function (o) {
var ar = [];
for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
return ar;
};
return ownKeys(o);
};
return function (mod) {
if (mod && mod.__esModule) return mod;
var result = {};
if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
__setModuleDefault(result, mod);
return result;
};
})();
var __importDefault = (this && this.__importDefault) || function (mod) {
return (mod && mod.__esModule) ? mod : { "default": mod };
};
Object.defineProperty(exports, "__esModule", { value: true });
exports.writeTrackingFile = exports.upgradeFileContents = exports.revisionToRemoteChangeElement = exports.readFileContents = exports.getFilePath = exports.FILENAME = void 0;
/*
* Copyright 2025, Salesforce, Inc.
*
* 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
*
* http://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.
*/
const node_path_1 = __importDefault(require("node:path"));
const fs = __importStar(require("graceful-fs"));
const kit_1 = require("@salesforce/kit");
const core_1 = require("@salesforce/core");
const functions_1 = require("../functions");
exports.FILENAME = 'maxRevision.json';
const getFilePath = (orgId) => node_path_1.default.join('.sf', 'orgs', orgId, exports.FILENAME);
exports.getFilePath = getFilePath;
const readFileContents = async (filePath) => {
try {
const contents = await fs.promises.readFile(filePath, 'utf8');
const parsedContents = (0, kit_1.parseJsonMap)(contents, filePath);
if (parsedContents.fileVersion === 1) {
return parsedContents;
}
core_1.Logger.childFromRoot('remoteSourceTrackingService:readFileContents').debug(`older tracking file version, found ${parsedContents.fileVersion ?? 'undefined'}. Upgrading file contents. Some expected data may be missing`);
return (0, exports.upgradeFileContents)(parsedContents);
}
catch (e) {
core_1.Logger.childFromRoot('remoteSourceTrackingService:readFileContents').debug(`Error reading or parsing file file at ${filePath}. Will treat as an empty file.`, e);
return {};
}
};
exports.readFileContents = readFileContents;
const revisionToRemoteChangeElement = (memberRevision) => ({
type: memberRevision.MemberType,
name: memberRevision.MemberName,
deleted: memberRevision.IsNameObsolete,
modified: memberRevision.IsNewMember === false,
revisionCounter: memberRevision.RevisionCounter,
changedBy: memberRevision.ChangedBy,
memberIdOrName: memberRevision.MemberIdOrName,
lastModifiedDate: memberRevision.LastModifiedDate,
});
exports.revisionToRemoteChangeElement = revisionToRemoteChangeElement;
const upgradeFileContents = (contents) => ({
fileVersion: 1,
serverMaxRevisionCounter: contents.serverMaxRevisionCounter,
// @ts-expect-error the old file didn't store the IsNewMember field or any indication of whether the member was add/modified
sourceMembers: Object.fromEntries(
// it's the old version
Object.entries(contents.sourceMembers).map(([key, value]) => [
(0, functions_1.getMetadataKey)((0, functions_1.getMetadataTypeFromLegacyKey)(key), (0, functions_1.getMetadataNameFromLegacyKey)(key)),
{
MemberName: (0, functions_1.getMetadataNameFromLegacyKey)(key),
MemberType: value.memberType,
IsNameObsolete: value.isNameObsolete,
RevisionCounter: value.serverRevisionCounter,
lastRetrievedFromServer: value.lastRetrievedFromServer ?? undefined,
ChangedBy: 'unknown',
MemberIdOrName: 'unknown',
LastModifiedDate: 'unknown',
},
])),
});
exports.upgradeFileContents = upgradeFileContents;
const writeTrackingFile = async ({ filePath, maxCounter, members, }) => {
const lockResult = await (0, core_1.lockInit)(filePath);
const CURRENT_FILE_VERSION_ENV = core_1.envVars.getNumber('SF_SOURCE_TRACKING_FILE_VERSION') ?? 0;
const contents = CURRENT_FILE_VERSION_ENV === 1
? {
fileVersion: 1,
serverMaxRevisionCounter: maxCounter,
sourceMembers: Object.fromEntries(members),
}
: {
fileVersion: 0,
serverMaxRevisionCounter: maxCounter,
sourceMembers: Object.fromEntries(Array.from(members.entries()).map(toLegacyMemberRevision)),
};
await lockResult.writeAndUnlock(JSON.stringify(contents, null, 4));
};
exports.writeTrackingFile = writeTrackingFile;
const toLegacyMemberRevision = ([, member]) => [
(0, functions_1.getLegacyMetadataKey)(member.MemberType, member.MemberName),
{
memberType: member.MemberType,
serverRevisionCounter: member.RevisionCounter,
lastRetrievedFromServer: member.lastRetrievedFromServer ?? null,
isNameObsolete: member.IsNameObsolete,
},
];
//# sourceMappingURL=fileOperations.js.map