isomorphic-jj 1.0.0

package/src/drivers/built-in-drivers.js

@@ -0,0 +1,296 @@
+/**
+ * Built-in merge drivers for common file types
+ *
+ * These drivers extend JJ's merge algorithm with domain-specific logic.
+ */
+
+/**
+ * Deep merge for JSON objects
+ * Recursively merges objects, with theirs taking precedence on conflicts
+ *
+ * @param {Object} base - Base object
+ * @param {Object} ours - Our changes
+ * @param {Object} theirs - Their changes
+ * @returns {Object} Merged object
+ */
+function deepMergeJSON(base, ours, theirs) {
+  // If all are identical, return any
+  if (JSON.stringify(ours) === JSON.stringify(theirs)) {
+    return ours;
+  }
+
+  // If ours is same as base, take theirs
+  if (JSON.stringify(ours) === JSON.stringify(base)) {
+    return theirs;
+  }
+
+  // If theirs is same as base, take ours
+  if (JSON.stringify(theirs) === JSON.stringify(base)) {
+    return ours;
+  }
+
+  // Both sides changed - need smart merge
+  if (typeof ours !== 'object' || typeof theirs !== 'object' || Array.isArray(ours) || Array.isArray(theirs)) {
+    // Primitives or arrays - conflict
+    return null;
+  }
+
+  // Merge objects
+  const result = { ...base };
+
+  // Get all keys
+  const allKeys = new Set([
+    ...Object.keys(base || {}),
+    ...Object.keys(ours || {}),
+    ...Object.keys(theirs || {}),
+  ]);
+
+  for (const key of allKeys) {
+    const baseVal = base?.[key];
+    const oursVal = ours?.[key];
+    const theirsVal = theirs?.[key];
+
+    if (JSON.stringify(oursVal) === JSON.stringify(theirsVal)) {
+      // Both sides agree
+      result[key] = oursVal;
+    } else if (JSON.stringify(oursVal) === JSON.stringify(baseVal)) {
+      // We didn't change it, take theirs
+      result[key] = theirsVal;
+    } else if (JSON.stringify(theirsVal) === JSON.stringify(baseVal)) {
+      // They didn't change it, take ours
+      result[key] = oursVal;
+    } else {
+      // Both changed differently
+      if (typeof oursVal === 'object' && typeof theirsVal === 'object' && !Array.isArray(oursVal) && !Array.isArray(theirsVal)) {
+        // Recurse for nested objects
+        const merged = deepMergeJSON(baseVal || {}, oursVal, theirsVal);
+        if (merged === null) {
+          return null; // Conflict in nested object
+        }
+        result[key] = merged;
+      } else {
+        // Can't merge - conflict
+        return null;
+      }
+    }
+  }
+
+  return result;
+}
+
+/**
+ * Generic JSON merge driver
+ *
+ * Attempts to merge JSON files intelligently by merging objects.
+ * Falls back to conflict markers if merge isn't possible.
+ */
+export async function jsonDriver({ path, content }) {
+  const { base, ours, theirs } = content;
+
+  try {
+    const baseObj = base ? JSON.parse(base) : {};
+    const oursObj = ours ? JSON.parse(ours) : {};
+    const theirsObj = theirs ? JSON.parse(theirs) : {};
+
+    const merged = deepMergeJSON(baseObj, oursObj, theirsObj);
+
+    if (merged !== null) {
+      // Successful merge
+      return {
+        content: JSON.stringify(merged, null, 2) + '\n',
+        hasConflict: false,
+      };
+    } else {
+      // Conflict - return with markers
+      const conflictContent = `<<<<<<< ours\n${ours || ''}\n=======\n${theirs || ''}\n>>>>>>> theirs`;
+      return {
+        content: conflictContent,
+        hasConflict: true,
+        conflicts: [{
+          type: 'json-merge-conflict',
+          message: 'Both sides modified the same field with different values',
+        }],
+      };
+    }
+  } catch (error) {
+    // JSON parsing failed - fall back to text conflict
+    const conflictContent = `<<<<<<< ours\n${ours || ''}\n=======\n${theirs || ''}\n>>>>>>> theirs`;
+    return {
+      content: conflictContent,
+      hasConflict: true,
+      conflicts: [{
+        type: 'json-parse-error',
+        message: `JSON parsing failed: ${error.message}`,
+      }],
+    };
+  }
+}
+
+/**
+ * package.json merge driver
+ *
+ * Smart merging for Node.js package.json files:
+ * - Union merge for dependencies/devDependencies
+ * - Take theirs for version (semver conflicts are hard)
+ * - Merge other fields intelligently
+ */
+export async function packageJsonDriver({ path, content }) {
+  const { base, ours, theirs } = content;
+
+  try {
+    const baseObj = base ? JSON.parse(base) : {};
+    const oursObj = ours ? JSON.parse(ours) : {};
+    const theirsObj = theirs ? JSON.parse(theirs) : {};
+
+    // Start with base
+    const merged = { ...baseObj };
+
+    // Merge top-level fields
+    for (const key of Object.keys({ ...oursObj, ...theirsObj })) {
+      if (key === 'dependencies' || key === 'devDependencies' || key === 'peerDependencies' || key === 'optionalDependencies') {
+        // Union merge dependencies
+        merged[key] = {
+          ...baseObj[key],
+          ...oursObj[key],
+          ...theirsObj[key],  // theirs wins on conflicts
+        };
+      } else if (key === 'version') {
+        // Version conflicts are tricky - take theirs
+        merged[key] = theirsObj[key] || oursObj[key] || baseObj[key];
+      } else if (key === 'scripts') {
+        // Merge scripts
+        merged[key] = {
+          ...baseObj[key],
+          ...oursObj[key],
+          ...theirsObj[key],  // theirs wins
+        };
+      } else {
+        // Other fields - use standard logic
+        const oursVal = oursObj[key];
+        const theirsVal = theirsObj[key];
+        const baseVal = baseObj[key];
+
+        if (JSON.stringify(oursVal) === JSON.stringify(theirsVal)) {
+          merged[key] = oursVal;
+        } else if (JSON.stringify(oursVal) === JSON.stringify(baseVal)) {
+          merged[key] = theirsVal;
+        } else if (JSON.stringify(theirsVal) === JSON.stringify(baseVal)) {
+          merged[key] = oursVal;
+        } else {
+          // Conflict - take theirs
+          merged[key] = theirsVal;
+        }
+      }
+    }
+
+    return {
+      content: JSON.stringify(merged, null, 2) + '\n',
+      hasConflict: false,
+      metadata: {
+        driver: 'package.json',
+        mergedDependencies: Object.keys(merged.dependencies || {}).length,
+        mergedDevDependencies: Object.keys(merged.devDependencies || {}).length,
+      },
+    };
+  } catch (error) {
+    // Parsing failed - fall back to conflict
+    const conflictContent = `<<<<<<< ours\n${ours || ''}\n=======\n${theirs || ''}\n>>>>>>> theirs`;
+    return {
+      content: conflictContent,
+      hasConflict: true,
+      conflicts: [{
+        type: 'parse-error',
+        message: `package.json parsing failed: ${error.message}`,
+      }],
+    };
+  }
+}
+
+/**
+ * YAML merge driver (basic)
+ *
+ * Note: This is a simple implementation. For production use, consider
+ * using a proper YAML library like 'js-yaml'.
+ */
+export async function yamlDriver({ path, content }) {
+  const { base, ours, theirs } = content;
+
+  // Simple YAML merge - just do text-based for now
+  // A full implementation would parse YAML and do object merging
+
+  if (ours === theirs) {
+    return { content: ours, hasConflict: false };
+  }
+
+  if (ours === base) {
+    return { content: theirs, hasConflict: false };
+  }
+
+  if (theirs === base) {
+    return { content: ours, hasConflict: false };
+  }
+
+  // Conflict
+  const conflictContent = `<<<<<<< ours\n${ours || ''}\n=======\n${theirs || ''}\n>>>>>>> theirs`;
+  return {
+    content: conflictContent,
+    hasConflict: true,
+    conflicts: [{
+      type: 'yaml-conflict',
+      message: 'YAML files modified on both sides',
+    }],
+  };
+}
+
+/**
+ * Markdown merge driver (section-based)
+ *
+ * Attempts to merge markdown files by sections (headers).
+ * Falls back to conflict markers for complex cases.
+ */
+export async function markdownDriver({ path, content }) {
+  const { base, ours, theirs } = content;
+
+  // Simple markdown merge - just text-based for now
+  // A full implementation would parse sections and merge by header
+
+  if (ours === theirs) {
+    return { content: ours, hasConflict: false };
+  }
+
+  if (ours === base) {
+    return { content: theirs, hasConflict: false };
+  }
+
+  if (theirs === base) {
+    return { content: ours, hasConflict: false };
+  }
+
+  // For now, fall back to conflict markers
+  // TODO: Implement section-based merging
+  const conflictContent = `<<<<<<< ours\n${ours || ''}\n=======\n${theirs || ''}\n>>>>>>> theirs`;
+  return {
+    content: conflictContent,
+    hasConflict: true,
+    conflicts: [{
+      type: 'markdown-conflict',
+      message: 'Markdown files modified on both sides',
+    }],
+  };
+}
+
+/**
+ * Get all built-in drivers as a map
+ *
+ * @returns {Object} Map of pattern -> driver function
+ */
+export function getBuiltInDrivers() {
+  return {
+    'package.json': packageJsonDriver,
+    '*.json': jsonDriver,
+    '*.yaml': yamlDriver,
+    '*.yml': yamlDriver,
+    '*.md': markdownDriver,
+    '*.markdown': markdownDriver,
+  };
+}

package/src/index.js

@@ -0,0 +1,15 @@
+/**
+ * isomorphic-jj - Main entry point
+ */
+
+export { createJJ } from './api/repository.js';
+export { JJError } from './utils/errors.js';
+
+// v0.5: Built-in merge drivers
+export {
+  jsonDriver,
+  packageJsonDriver,
+  yamlDriver,
+  markdownDriver,
+  getBuiltInDrivers,
+} from './drivers/built-in-drivers.js';

package/src/protos/local_working_copy.proto

@@ -0,0 +1,76 @@
+// Copyright 2020 The Jujutsu Authors
+//
+// 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.
+
+syntax = "proto3";
+
+package local_working_copy;
+
+enum FileType {
+  Normal = 0;
+  Symlink = 1;
+  Executable = 2;
+  Conflict = 3 [deprecated = true];
+  GitSubmodule = 4;
+}
+
+message MaterializedConflictData {
+  // TODO: maybe we should store num_sides here as well
+  uint32 conflict_marker_len = 1;
+}
+
+message FileState {
+  int64 mtime_millis_since_epoch = 1;
+  uint64 size = 2;
+  FileType file_type = 3;
+  MaterializedConflictData materialized_conflict_data = 5;
+  reserved 4;
+}
+
+message FileStateEntry {
+  string path = 1;
+  FileState state = 2;
+}
+
+message SparsePatterns {
+  repeated string prefixes = 1;
+}
+
+message TreeState {
+  bytes legacy_tree_id = 1 [deprecated = true];
+  // Alternating positive and negative terms if there's a conflict, otherwise a
+  // single (positive) value
+  repeated bytes tree_ids = 5;
+  repeated FileStateEntry file_states = 2;
+  bool is_file_states_sorted = 6;
+  SparsePatterns sparse_patterns = 3;
+  WatchmanClock watchman_clock = 4;
+}
+
+message WatchmanClock {
+  oneof watchman_clock {
+    string string_clock = 1;
+    int64 unix_timestamp = 2;
+  }
+}
+
+message Checkout {
+  // The operation at which the working copy was updated.
+  bytes operation_id = 2;
+  // An identifier for this workspace. It is used for looking up the current
+  // working-copy commit in the repo view. Currently a human-readable name.
+  // TODO: Is it better to make this a UUID and a have map that to a name in
+  // config? That way users can rename a workspace.
+  string workspace_name = 3;
+  reserved 1;
+}

package/src/protos/simple_op_store.proto

@@ -0,0 +1,147 @@
+// Copyright 2020 The Jujutsu Authors
+//
+// 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.
+
+syntax = "proto3";
+
+package simple_op_store;
+
+message RefConflictLegacy {
+  repeated bytes removes = 1 [deprecated = true];
+  repeated bytes adds = 2 [deprecated = true];
+}
+
+// This is redundant with `RefTargetTerm`. It exists for historical reasons.
+// TODO: Consider deprecating it.
+message RefConflict {
+  message Term {
+    optional bytes value = 1;
+  }
+  repeated Term removes = 1;
+  repeated Term adds = 2;
+}
+
+// RefTarget that may be serialized in legacy form.
+message RefTarget {
+  // New `RefConflict` type represents both `commit_id` and `conflict_legacy`.
+  oneof value {
+    bytes commit_id = 1 [deprecated = true];
+    RefConflictLegacy conflict_legacy = 2 [deprecated = true];
+    RefConflict conflict = 3;
+  }
+}
+
+// RefTarget term that should be serialized in native form, in which positive
+// and negative terms alternate.
+message RefTargetTerm {
+  optional bytes value = 1;
+}
+
+enum RemoteRefState {
+  New = 0;
+  Tracked = 1;
+}
+
+message RemoteBookmark {
+  string remote_name = 1;
+  RefTarget target = 2;
+  // Introduced in jj 0.11.
+  optional RemoteRefState state = 3;
+}
+
+message Bookmark {
+  string name = 1;
+  // Unset if the bookmark has been deleted locally.
+  RefTarget local_target = 2;
+  // Deprecated since jj 0.34.
+  repeated RemoteBookmark remote_bookmarks = 3 [deprecated = true];
+}
+
+message GitRef {
+  string name = 1;
+  // This field is just for historical reasons (before we had the RefTarget
+  // type). New GitRefs have (only) the target field.
+  // TODO: Delete support for the old format.
+  bytes commit_id = 2 [deprecated = true];
+  RefTarget target = 3;
+}
+
+message RemoteRef {
+  string name = 1;
+  repeated RefTargetTerm target_terms = 2;
+  RemoteRefState state = 3;
+}
+
+message Tag {
+  string name = 1;
+  RefTarget target = 2;
+}
+
+message View {
+  repeated bytes head_ids = 1;
+  reserved 4;
+  bytes wc_commit_id = 2 [deprecated = true];
+  map<string, bytes> wc_commit_ids = 8;
+  // Local bookmarks and remote bookmarks in legacy form.
+  repeated Bookmark bookmarks = 5;
+  repeated Tag local_tags = 6;
+  // Introduced in jj 0.34.
+  repeated RemoteView remote_views = 11;
+  // Only a subset of the refs. For example, does not include refs/notes/.
+  repeated GitRef git_refs = 3;
+  // This field is just for historical reasons (before we had the RefTarget
+  // type). New Views have (only) the target field.
+  // TODO: Delete support for the old format.
+  bytes git_head_legacy = 7 [deprecated = true];
+  RefTarget git_head = 9;
+  // Whether "@git" tags have been migrated to remote_views.
+  bool has_git_refs_migrated_to_remote_tags = 12;
+  reserved 10;
+}
+
+message RemoteView {
+  string name = 1;
+  repeated RemoteRef bookmarks = 2;
+  repeated RemoteRef tags = 3;
+}
+
+message Operation {
+  bytes view_id = 1;
+  repeated bytes parents = 2;
+  OperationMetadata metadata = 3;
+  // Introduced in jj 0.30.
+  repeated CommitPredecessors commit_predecessors = 4;
+  // Whether or not `commit_predecessors` is recorded.
+  bool stores_commit_predecessors = 5;
+}
+
+// TODO: Share with store.proto? Do we even need the timezone here?
+message Timestamp {
+  int64 millis_since_epoch = 1;
+  int32 tz_offset = 2;
+}
+
+message OperationMetadata {
+  Timestamp start_time = 1;
+  Timestamp end_time = 2;
+  string description = 3;
+  string hostname = 4;
+  string username = 5;
+  bool is_snapshot = 7;
+  map<string, string> tags = 6;
+}
+
+message CommitPredecessors {
+  bytes commit_id = 1;
+  repeated bytes predecessor_ids = 2;
+}