Method writeFile

packages/insomnia/src/sync/git/ne-db-client.ts:117–161

* Writes file data to the NeDB database as if it were a regular file * Converts YAML data back to database records during Git operations * * @param filePath - The file path to write to * @param data - The file contents as Buffer or string

(filePath: string, data: Buffer | string)

   * @param data - The file contents as Buffer or string
   */
  async writeFile(filePath: string, data: Buffer | string) {
    filePath = path.normalize(filePath);
    const { root, id, type } = parseGitPath(filePath);

    // Only process files within the .insomnia directory
    if (root !== GIT_INSOMNIA_DIR_NAME) {
      console.log(`[git] Ignoring external file ${filePath}`);
      return;
    }

    const dataStr = data.toString();

    // Skip the file if there is a conflict marker (Git merge conflict)
    if (dataStr.split('\n').includes('=======')) {
      return;
    }

    // Parse the YAML data back to a database document
    const doc: BaseModel = YAML.parse(dataStr);

    // Validate that the document ID matches the file path
    if (id !== doc._id) {
      throw new Error(`Doc _id does not match file path [${doc._id} != ${id || 'null'}]`);
    }

    // Validate that the document type matches the file path
    if (type !== doc.type) {
      throw new Error(`Doc type does not match file path [${doc.type} != ${type || 'null'}]`);
    }

    // Special handling for workspaces: ensure they stay in the correct project
    if (models.workspace.isWorkspace(doc)) {
      console.log('[git] setting workspace parent to be that of the active project', {
        original: doc.parentId,
        new: this._projectId,
      });
      // Whenever we write a workspace into nedb we should set the parentId to be that of the current project
      // This is because the parentId (or a project) is not synced into git, so it will be cleared whenever git writes the workspace into the db, thereby removing it from the project on the client
      // In order to reproduce this bug, comment out the following line, then clone a repository into a local project, then open the workspace, you'll notice it will have moved into the default project
      doc.parentId = this._projectId;
    }

    // Update the document in the database
    await db.update(doc);
  }

  async unlink(filePath: string) {
    filePath = path.normalize(filePath);