| yuja |
| hg-reviewers |
It took me several minutes to figure out how the "unbundle"
protocol worked. It turns out that the SSH protocol handler
sends an empty reply that is interpreted as "OK to send" and
only then does the client send the bundle payload.
On top of that, the response is different depending on whether
the operation was successful or not. I nearly pulled out my hair
deciphering this.
| Automatic diff as part of commit; lint not applicable. |
| Automatic diff as part of commit; unit tests not applicable. |
| args = pycompat.byteskwargs(args) | args = pycompat.byteskwargs(args) | ||||
| return self._sendrequest(cmd, args, framed=cmd in self._FRAMED_COMMANDS) | return self._sendrequest(cmd, args, framed=cmd in self._FRAMED_COMMANDS) | ||||
| def _call(self, cmd, **args): | def _call(self, cmd, **args): | ||||
| args = pycompat.byteskwargs(args) | args = pycompat.byteskwargs(args) | ||||
| return self._sendrequest(cmd, args, framed=True).read() | return self._sendrequest(cmd, args, framed=True).read() | ||||
| def _callpush(self, cmd, fp, **args): | def _callpush(self, cmd, fp, **args): | ||||
| # The server responds with an empty frame if the client should | |||||
| # continue submitting the payload. | |||||
| r = self._call(cmd, **args) | r = self._call(cmd, **args) | ||||
| if r: | if r: | ||||
| return '', r | return '', r | ||||
| # The payload consists of frames with content followed by an empty | |||||
| # frame. | |||||
| for d in iter(lambda: fp.read(4096), ''): | for d in iter(lambda: fp.read(4096), ''): | ||||
| self._writeframed(d) | self._writeframed(d) | ||||
| self._writeframed("", flush=True) | self._writeframed("", flush=True) | ||||
| # In case of success, there is an empty frame and a frame containing | |||||
| # the integer result (as a string). | |||||
| # In case of error, there is a non-empty frame containing the error. | |||||
| r = self._readframed() | r = self._readframed() | ||||
| if r: | if r: | ||||
| return '', r | return '', r | ||||
| return self._readframed(), '' | return self._readframed(), '' | ||||
| def _calltwowaystream(self, cmd, fp, **args): | def _calltwowaystream(self, cmd, fp, **args): | ||||
| # The server responds with an empty frame if the client should | |||||
| # continue submitting the payload. | |||||
| r = self._call(cmd, **args) | r = self._call(cmd, **args) | ||||
| if r: | if r: | ||||
| # XXX needs to be made better | # XXX needs to be made better | ||||
| raise error.Abort(_('unexpected remote reply: %s') % r) | raise error.Abort(_('unexpected remote reply: %s') % r) | ||||
| # The payload consists of frames with content followed by an empty | |||||
| # frame. | |||||
| for d in iter(lambda: fp.read(4096), ''): | for d in iter(lambda: fp.read(4096), ''): | ||||
| self._writeframed(d) | self._writeframed(d) | ||||
| self._writeframed("", flush=True) | self._writeframed("", flush=True) | ||||
| return self._pipei | return self._pipei | ||||
| def _getamount(self): | def _getamount(self): | ||||
| l = self._pipei.readline() | l = self._pipei.readline() | ||||
| if l == '\n': | if l == '\n': | ||||
| self._readerr() | self._readerr() | ||||
| msg = _('check previous remote output') | msg = _('check previous remote output') | ||||
| self._abort(error.OutOfBandError(hint=msg)) | self._abort(error.OutOfBandError(hint=msg)) | ||||
| star[arg] = val | star[arg] = val | ||||
| data['*'] = star | data['*'] = star | ||||
| else: | else: | ||||
| val = self._fin.read(int(l)) | val = self._fin.read(int(l)) | ||||
| data[arg] = val | data[arg] = val | ||||
| return [data[k] for k in keys] | return [data[k] for k in keys] | ||||
| def forwardpayload(self, fpout): | def forwardpayload(self, fpout): | ||||
| # We initially send an empty response. This tells the client it is | |||||
| # OK to start sending data. If a client sees any other response, it | |||||
| # interprets it as an error. | |||||
| _sshv1respondbytes(self._fout, b'') | |||||
| # The file is in the form: | # The file is in the form: | ||||
| # | # | ||||
| # <chunk size>\n<chunk> | # <chunk size>\n<chunk> | ||||
| # ... | # ... | ||||
| # 0\n | # 0\n | ||||
| _sshv1respondbytes(self._fout, b'') | |||||
| count = int(self._fin.readline()) | count = int(self._fin.readline()) | ||||
| while count: | while count: | ||||
| fpout.write(self._fin.read(count)) | fpout.write(self._fin.read(count)) | ||||
| count = int(self._fin.readline()) | count = int(self._fin.readline()) | ||||
| @contextlib.contextmanager | @contextlib.contextmanager | ||||
| def mayberedirectstdio(self): | def mayberedirectstdio(self): | ||||
| yield None | yield None | ||||